The mgl-pax Reference Manual

This is the mgl-pax Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 05:53:59 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 mgl-pax

Exploratory programming tool and documentation generator.

Author

Gábor Melis

Contact

Home Page

http://melisgl.github.io/mgl-pax

Source Control

(GIT https://github.com/melisgl/mgl-pax.git)

Bug Tracker

https://github.com/melisgl/mgl-pax/issues

License

MIT, see COPYING.

Long Description

The set of dependencies of the MGL-PAX system is
kept light, and its heavier dependencies are autoloaded via ASDF when the relavant functionality is accessed. See the MGL-PAX/NAVIGATE, MGL-PAX/DOCUMENT, MGL-PAX/TRANSCRIBE and MGL-PAX/FULL systems. To keep deployed code small, client systems should declare an ASDF dependency on this system, never on the others, which are intended for autoloading and interactive use.

Version

0.1.0

Defsystem Dependency

mgl-pax.asdf (system).

Dependencies
  • named-readtables (system).
  • pythonic-string-reader (system).
Source

mgl-pax.asd.

Child Component

src/base/ (module).


2.2 mgl-pax.asdf

Source

mgl-pax.asdf.asd.

Child Component

asdf.lisp (file).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 mgl-pax/src/base/

Source

mgl-pax.asd.

Parent Component

mgl-pax (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 mgl-pax/mgl-pax.asd

Source

mgl-pax.asd.

Parent Component

mgl-pax (system).

ASDF Systems

mgl-pax.


4.1.2 mgl-pax.asdf/mgl-pax.asdf.asd

Source

mgl-pax.asdf.asd.

Parent Component

mgl-pax.asdf (system).

ASDF Systems

mgl-pax.asdf.


4.1.3 mgl-pax/src/base//package.lisp

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Packages

mgl-pax.


4.1.4 mgl-pax/src/base//autoload.lisp

Dependency

package.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Internals

4.1.5 mgl-pax/src/base//pax-early.lisp

Dependency

autoload.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface
Internals

4.1.6 mgl-pax/src/base//pax.lisp

Dependency

pax-early.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface
Internals

4.1.7 mgl-pax/src/base//extension-api.lisp

Dependency

pax.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface
Internals

4.1.8 mgl-pax/src/base//navigate-early.lisp

Dependency

extension-api.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface
Internals

locate-definitions-for-emacs (function).


4.1.9 mgl-pax/src/base//document-early.lisp

Dependency

navigate-early.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface
Internals

4.1.10 mgl-pax/src/base//transcribe-early.lisp

Dependency

document-early.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface
Internals

transcribe-for-emacs (function).


4.1.11 mgl-pax/src/base//locatives-early.lisp

Dependency

transcribe-early.lisp (file).

Source

mgl-pax.asd.

Parent Component

src/base/ (module).

Public Interface

define-restart (macro).

Internals

4.1.12 mgl-pax.asdf/asdf.lisp

Source

mgl-pax.asdf.asd.

Parent Component

mgl-pax.asdf (system).

Packages

mgl-pax.asdf.

Public Interface
Internals

compile-without-some-warnings (function).


5 Packages

Packages are listed by definition order.


5.1 mgl-pax.asdf

Source

asdf.lisp.

Use List

common-lisp.

Public Interface
Internals

compile-without-some-warnings (function).


5.2 mgl-pax

See MGL-PAX::@PAX-MANUAL.

Source

package.lisp.

Nickname

pax

Use List
  • common-lisp.
  • editor-hints.named-readtables.
  • pythonic-string-reader.
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Special variables

Special Variable: *discard-documentation-p*

The default value of DEFSECTION’s DISCARD-DOCUMENTATION-P argument. One may want to set *DISCARD-DOCUMENTATION-P* to true before building a binary application.

Package

mgl-pax.

Source

pax-early.lisp.

Special Variable: *document-fancy-html-navigation*
Package

mgl-pax.

Source

document-early.lisp.

Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-html-head*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-html-max-navigation-table-of-contents-level*
Package

mgl-pax.

Source

document-early.lisp.

Package

mgl-pax.

Source

document-early.lisp.

Package

mgl-pax.

Source

document-early.lisp.

Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-mark-up-signatures*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-max-numbering-level*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-max-table-of-contents-level*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-normalize-packages*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-text-navigation*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *document-uppercase-is-code*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *format*

Bound by DOCUMENT, this allows markdown output to depend on the output format.

Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *transcribe-check-consistency*
Package

mgl-pax.

Source

transcribe-early.lisp.

Special Variable: *transcribe-syntaxes*
Package

mgl-pax.

Source

transcribe-early.lisp.


6.1.2 Macros

Macro: define-definer-for-symbol-locative-type (name locative-type &body docstring)

Define a macro with NAME which can be used to attach documentation, a lambda-list and source location to a symbol in the context of LOCATIVE-TYPE. The defined macro’s arglist is (SYMBOL LAMBDA-LIST &OPTIONAL DOCSTRING). LOCATIVE-TYPE is assumed to have been defined with DEFINE-SYMBOL-LOCATIVE-TYPE.

Package

mgl-pax.

Source

extension-api.lisp.

Macro: define-glossary-term (name (&key title discard-documentation-p) docstring)

Define a global variable with NAME and set it to a [GLOSSARY-TERM][class] object. A glossary term is just a symbol to hang a docstring on. It is a bit like a SECTION in that, when linked to, its TITLE will be the link text instead of the name of the symbol. Also as with sections, both TITLE and DOCSTRING are markdown strings or NIL.

Unlike sections though, glossary terms are not rendered with headings, but in the more lightweight bullet + locative + name/title style. See the glossary entry @NAME for an example.

When DISCARD-DOCUMENTATION-P (defaults to *DISCARD-DOCUMENTATION-P*) is true, DOCSTRING will not be recorded to save memory.

GLOSSARY-TERM is not EXPORTABLE-LOCATIVE-TYPE-P.

Package

mgl-pax.

Source

pax-early.lisp.

Macro: define-locative-alias (alias locative-type)

Define ALIAS as a locative equivalent to LOCATIVE-TYPE (both SYMBOLs). The following example shows how to make docstrings read more naturally by defining an alias.

“‘
(defclass my-string ()
())

(defgeneric my-string (obj)
(:documentation "Convert OBJ to MY-STRING."))

;;; This version of FOO has a harder to read docstring because ;;; it needs to disambiguate the MY-STRING reference.
(defun foo (x)
"FOO takes and argument X, a [MY-STRING][class] object.")

;;; Define OBJECT as an alias for the CLASS locative. (define-locative-alias object class)

;;; Note how no explicit link is needed anymore.
(defun foo (x)
"FOO takes an argument X, a MY-CLASS object.")
“‘

Package

mgl-pax.

Source

extension-api.lisp.

Macro: define-locative-type (locative-type lambda-list &body docstring)

Declare LOCATIVE-TYPE as a [LOCATIVE][locative]. One gets two things in return: first, a place to document the format and semantics of LOCATIVE-TYPE (in LAMBDA-LIST and DOCSTRING); second, being able to reference ‘(LOCATIVE-TYPE LOCATIVE)‘. For example, if you have:

“‘
(define-locative-type variable (&optional initform)
"Dummy docstring.")
“‘

then ‘(VARIABLE LOCATIVE)‘ refers to this form.

Package

mgl-pax.

Source

extension-api.lisp.

Macro: define-package (package &rest options)

This is like CL:DEFPACKAGE but silences warnings and errors signaled when the redefined package is at variance with the current state of the package. Typically this situation occurs when symbols are exported by calling EXPORT (as is the case with DEFSECTION) as opposed to adding :EXPORT forms to the DEFPACKAGE form and the package definition is subsequently reevaluated. See the section on [package variance](http://www.sbcl.org/manual/#Package-Variance) in the SBCL manual.

The bottom line is that if you rely on DEFSECTION to do the exporting, then you’d better use DEFINE-PACKAGE.

Package

mgl-pax.

Source

pax.lisp.

Macro: define-restart (symbol lambda-list &body docstring)

A definer macro to hang the documentation of a restart on a
symbol.

“‘
(define-restart my-ignore-error ()
"Available when MY-ERROR is signalled, MY-IGNORE-ERROR unsafely continues.") “‘

Then ‘(MY-IGNORE-ERROR RESTART)‘ refers to the above definition.
Note that while there is a CL:RESTART type, there is no
corresponding source location or docstring like for [CONDITION][condition]s.

Package

mgl-pax.

Source

locatives-early.lisp.

Macro: define-symbol-locative-type (locative-type lambda-list &body docstring)

Similar to DEFINE-LOCATIVE-TYPE but it assumes that all things locatable with LOCATIVE-TYPE are going to be just symbols defined with a definer defined with DEFINE-DEFINER-FOR-SYMBOL-LOCATIVE-TYPE. It is useful to attach documentation and source location to symbols in a particular context. An example will make everything clear:

“‘
(define-symbol-locative-type direction ()
"A direction is a symbol. (After this ‘M-.‘ on ‘DIRECTION LOCATIVE‘ works and it can also be included in DEFSECTION forms.)")

(define-definer-for-symbol-locative-type define-direction direction "With DEFINE-DIRECTION one can document what a symbol means when interpreted as a direction.")

(define-direction up ()
"UP is equivalent to a coordinate delta of (0, -1).")
“‘

After all this, ‘(UP DIRECTION)‘ refers to the ‘DEFINE-DIRECTION‘ form above.

Package

mgl-pax.

Source

extension-api.lisp.

Macro: defsection (name (&key package readtable export title link-title-to discard-documentation-p) &body entries)

Define a documentation section and maybe export referenced symbols. A bit behind the scenes, a global variable with NAME is defined and is bound to a [SECTION][class] object. By convention, section names start with the character ‘@‘. See @TUTORIAL for an example.

##### Entries

ENTRIES consists of docstrings and references in any order. Docstrings are arbitrary strings in markdown format.

REFERENCES are given in the form ‘(OBJECT LOCATIVE)‘. For example, ‘(FOO FUNCTION)‘ refers to the function ‘FOO‘, ‘(@BAR SECTION)‘ says that ‘@BAR‘ is a subsection of this one. ‘(BAZ (METHOD () (T T T)))‘ refers to the default method of the three argument generic function ‘BAZ‘. ‘(FOO FUNCTION)‘ is equivalent to ‘(FOO (FUNCTION))‘. See @LOCATIVES-AND-REFERENCES for more.

The same object may occur in multiple references, typically with different locatives, but this is not required.

The references are not looked up (see RESOLVE in the @LOCATIVES-AND-REFERENCES-API) until documentation is generated, so it is allowed to refer to things yet to be defined.

##### Exporting

If EXPORT is true (the default), NAME and the @OBJECTs of references among ENTRIES which are SYMBOLs are candidates for exporting. A candidate symbol is exported if

- it is [accessible][find-symbol] in PACKAGE, and

- there is a reference to it in the section being defined which is approved by EXPORTABLE-REFERENCE-P.

See DEFINE-PACKAGE if you use the export feature. The idea with confounding documentation and exporting is to force documentation of all exported symbols.

##### Misc

TITLE is a string containing markdown or NIL. If non-NIL, it determines the text of the heading in the generated output. LINK-TITLE-TO is a reference given as an ‘(OBJECT LOCATIVE)‘ pair or NIL, to which the heading will link when generating HTML. If not specified, the heading will link to its own anchor.

When DISCARD-DOCUMENTATION-P (defaults to *DISCARD-DOCUMENTATION-P*) is true, ENTRIES will not be recorded to save memory.

Package

mgl-pax.

Source

pax-early.lisp.

Macro: documenting-reference ((stream &key reference arglist name) &body body)

Write REFERENCE to STREAM as described in *DOCUMENT-MARK-UP-SIGNATURES*, and establish REFERENCE as a [local reference][@LOCAL-REFERENCES]. Unless ARGLIST is NIL or :NOT-AVAILABLE, it is printed after the name of object of REFERENCE.

If ARGLIST is a list, then it is must be a [lambda list][clhs] and is printed without the outermost parens and with the package names removed from the argument names.

If ARGLIST is a string, then it is printed without ESCAPE-MARKDOWN.

Package

mgl-pax.

Source

document-early.lisp.

Macro: with-dislocated-objects (objects &body body)

For each object in OBJECTS, establish a [local reference][@local-references] with the DISLOCATED locative, which [prevents autolinking][@preventing-autolinking].

Package

mgl-pax.

Source

document-early.lisp.

Macro: with-heading ((stream object title &key link-title-to) &body body)

Write a markdown heading with TITLE to STREAM. Nested WITH-HEADINGs produce nested headings. If *DOCUMENT-LINK-SECTIONS*, generate anchors based on the CANONICAL-REFERENCE of OBJECT. LINK-TITLE-TO behaves like the LINK-TITLE-TO argument of DEFSECTION.

Package

mgl-pax.

Source

document-early.lisp.


6.1.3 Ordinary functions

Function: call-with-wrappers (wrappers fn)
Package

mgl-pax.asdf.

Source

asdf.lisp.

Function: compile-pax (continuation)
Package

mgl-pax.asdf.

Source

asdf.lisp.

Function: compile-per-file (continuation)
Package

mgl-pax.asdf.

Source

asdf.lisp.

Function: compile-with-source-info (continuation)
Package

mgl-pax.asdf.

Source

asdf.lisp.

Function: compose-wrappers (wrappers)
Package

mgl-pax.asdf.

Source

asdf.lisp.

Function: delete-comments (&rest args)
Package

mgl-pax.

Source

transcribe-early.lisp.

Function: delete-trailing-whitespace (&rest args)
Package

mgl-pax.

Source

transcribe-early.lisp.

Function: document (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: document-docstring (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: documentation* (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: ensure-navigate-loaded (&rest args)
Package

mgl-pax.

Source

pax.lisp.

Function: escape-markdown (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: find-definition (&rest args)
Package

mgl-pax.

Source

navigate-early.lisp.

Function: find-definition* (&rest args)
Package

mgl-pax.

Source

navigate-early.lisp.

Function: locate (object locative &key errorp)

Follow LOCATIVE from OBJECT and return the object it leads to or a
REFERENCE if there is no first-class object corresponding to the
location. Depending on ERRORP, a LOCATE-ERROR condition is signaled
or NIL is returned if the lookup fails.

“‘
(locate ’locate ’function)
==> #<FUNCTION LOCATE>

(locate ’no-such-function ’function)
.. debugger invoked on LOCATE-ERROR:
.. Could not locate NO-SUCH-FUNCTION FUNCTION.
.. NO-SUCH-FUNCTION does not name a function.

(locate ’locate-object ’method)
.. debugger invoked on LOCATE-ERROR:
.. Could not locate LOCATE-OBJECT METHOD.
.. The syntax of the METHOD locative is (METHOD <METHOD-QUALIFIERS> <METHOD-SPECIALIZERS>). “‘

Package

mgl-pax.

Source

pax.lisp.

Function: locate-error (&rest format-and-args)

Call this function to signal a LOCATE-ERROR condition from a LOCATE-OBJECT method. FORMAT-AND-ARGS contains a format string and args suitable for FORMAT from which the LOCATE-ERROR-MESSAGE is constructed. If FORMAT-AND-ARGS is NIL, then the message will be NIL too.

LOCATE-ERROR-OBJECT and LOCATE-ERROR-LOCATIVE are populated automatically.

Package

mgl-pax.

Source

extension-api.lisp.

Function: locative-args (locative)

The REST of LOCATIVE if it’s a list. If it’s a symbol then it’s NIL.

Package

mgl-pax.

Source

pax-early.lisp.

Function: locative-type (locative)

Return the first element of LOCATIVE if it’s a list. If it’s a symbol, then return that symbol itself.

Package

mgl-pax.

Source

pax-early.lisp.

Function: make-git-source-uri-fn (asdf-system git-forge-uri &key git-version uri-format-string)

Return a function suitable as :SOURCE-URI-FN of a page spec (see
the PAGES argument of DOCUMENT). The function looks at the source location of the REFERENCE passed to it, and if the location is
found, the path is made relative to the root directory of
ASDF-SYSTEM and finally an URI pointing to your git forge (such as github) is returned. A warning is signalled whenever the source location lookup fails or if the source location points to a
directory not below the directory of ASDF-SYSTEM.

If GIT-FORE-URI is ‘"https://github.com/melisgl/mgl-pax/"‘ and GIT-VERSION is ‘"master"‘, then the returned URI may look like this:

https://github.com/melisgl/mgl-pax/blob/master/src/pax-early.lisp#L12

If GIT-VERSION is NIL, then an attempt is made to determine to current commit id from the ‘.git‘ in the directory holding ASDF-SYSTEM. If no ‘.git‘ directory is found, then no links to
the git forge will be generated.

URI-FORMAT-STRING is a CL:FORMAT control string for four arguments:

- GIT-FORGE-URI,
- GIT-VERSION,
- the relative path to the file of the source location of the reference, - and the line number.

The default value of URI-FORMAT-STRING is for github. If using a non-standard git forge, such as Sourcehut or Gitlab, simply pass a suitable URI-FORMAT-STRING matching the URI scheme of your forge.

Package

mgl-pax.

Source

document-early.lisp.

Function: make-github-source-uri-fn (asdf-system github-uri &key git-version)

This function is a backward-compatibility wrapper around MAKE-GIT-SOURCE-URI-FN, which supersedes MAKE-GITHUB-SOURCE-URI-FN. All arguments are passed on to MAKE-GIT-SOURCE-URI-FN, leaving URI-FORMAT-STRING at its default, which is suitable for github.

Package

mgl-pax.

Source

document-early.lisp.

Function: make-reference (object locative)
Package

mgl-pax.

Source

pax-early.lisp.

Function: prin1-to-markdown (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: register-doc-in-pax-world (name sections page-specs)

Register SECTIONS and PAGE-SPECS under NAME in \PAX World. By default, UPDATE-PAX-WORLD generates documentation for all of these.

Package

mgl-pax.

Source

document-early.lisp.

Function: resolve (reference &key errorp)

A convenience function to LOCATE REFERENCE’s object with its locative.

Package

mgl-pax.

Source

pax.lisp.

Function: squeeze-whitespace (&rest args)
Package

mgl-pax.

Source

transcribe-early.lisp.

Function: transcribe (&rest args)
Package

mgl-pax.

Source

transcribe-early.lisp.

Function: update-asdf-system-html-docs (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: update-asdf-system-readmes (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: update-pax-world (&rest args)
Package

mgl-pax.

Source

document-early.lisp.


6.1.4 Generic functions

Generic Function: canonical-reference (object)

Return a REFERENCE that RESOLVEs to OBJECT, or
return NIL if this operation is not defined for OBJECT. Its @REFERENCE-DELEGATE is LOCATE-CANONICAL-REFERENCE.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: canonical-reference ((reference reference))
Method: canonical-reference :around (object)
Method: canonical-reference (object)
Generic Function: collect-reachable-objects (object)

Return a list of objects representing all things to
be documented in a ‘(DOCUMENT OBJECT)‘ call. For a SECTION this is simply the union of references reachable from references in its SECTION-ENTRIES. The returned objects can be anything provided that CANONICAL-REFERENCE works on them. The list need not include OBJECT itself.

One only has to specialize this for new container-like objects. Its @REFERENCE-DELEGATE is LOCATE-AND-COLLECT-REACHABLE-OBJECTS.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: collect-reachable-objects ((reference reference))
Method: collect-reachable-objects (object)
Method: collect-reachable-objects :around (object)
Generic Function: docstring (object)

Return the docstring from the definition of OBJECT
with [leading indentation stripped][@markdown-indentation]. This function serves a similar purpose as CL:DOCUMENTATION, but it works with first-class objects when there is one for the corresponding definition, and with REFERENCEs when there is not. Its @REFERENCE-DELEGATE is LOCATE-DOCSTRING.

DOCSTRING is used in the implementation of the DOCSTRING locative. Some things such as ASDF:SYSTEMS and DECLARATIONs have no docstrings. Notably SECTIONs don’t provide access to docstrings.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: docstring ((reference reference))
Method: docstring (object)
Method: docstring :around (object)
Generic Function: document-object (object stream)

Write OBJECT (and its references recursively) in
*FORMAT* to STREAM in markdown format. Add methods specializing on OBJECT to customize the output of DOCUMENT. Its @REFERENCE-DELEGATE is LOCATE-AND-DOCUMENT. This function is for extension, don’t call it directly.

Package

mgl-pax.

Source

extension-api.lisp.

Generic Function: exportable-locative-type-p (locative-type)

Return true iff symbols in references with
LOCATIVE-TYPE are to be exported by default when they occur in a DEFSECTION. The default method returns T, while the methods for SECTION, GLOSSARY-TERM, PACKAGE, ASDF:SYSTEM, METHOD and INCLUDE return NIL.

This function is called by the default method of EXPORTABLE-REFERENCE-P to decide what symbols DEFSECTION shall export when its EXPORT argument is true.

Package

mgl-pax.

Source

pax-early.lisp.

Methods
Method: exportable-locative-type-p ((locative-type (eql mgl-pax:include)))
Method: exportable-locative-type-p ((locative-type (eql method)))
Method: exportable-locative-type-p ((locative-type (eql package)))
Method: exportable-locative-type-p ((locative-type (eql asdf/system:system)))
Method: exportable-locative-type-p (locative-type)
Generic Function: exportable-reference-p (package symbol locative-type locative-args)

Return true iff SYMBOL is to be exported from
PACKAGE when it occurs in a DEFSECTION as a reference with LOCATIVE-TYPE and LOCATIVE-ARGS. SYMBOL is [accessible][find-symbol] in PACKAGE.

The default method calls EXPORTABLE-LOCATIVE-TYPE-P with
LOCATIVE-TYPE and ignores the other arguments.

For example, to prevent SECTIONs from being export from the MGL-PAX package, the following method is defined.

“‘
(defmethod exportable-reference-p ((package (eql (find-package ’mgl-pax))) symbol (locative-type (eql ’section)) locative-args)
nil)
“‘

Package

mgl-pax.

Source

pax-early.lisp.

Methods
Method: exportable-reference-p ((package (eql #<package "mgl-pax">)) symbol (locative-type (eql mgl-pax:glossary-term)) locative-args)
Method: exportable-reference-p ((package (eql #<package "mgl-pax">)) symbol (locative-type (eql mgl-pax:section)) locative-args)
Method: exportable-reference-p (package symbol locative-type locative-args)
Generic Function: find-source (object)

Return the Swank source location for OBJECT. It
is called by LOCATE-DEFINITIONS-FOR-EMACS, which lies behind the ‘\\M-.‘ extension (see @NAVIGATING-IN-EMACS). Its @REFERENCE-DELEGATE is LOCATE-AND-FIND-SOURCE.

If successful, the return value should look like one of these:

“‘
(:LOCATION
(:FILE "/home/melisgl/own/mgl-pax/src/pax.lisp")
(:POSITION 3303) NIL)
(:LOCATION
(:FILE "/home/melisgl/own/mgl-pax/src/pax.lisp")
(:OFFSET 1 3303) NIL)
(:LOCATION
(:FILE "/home/melisgl/own/mgl-pax/src/pax.lisp") (:FUNCTION-NAME "FOO") NIL)
“‘

The NIL above is the source snippet, which is optional. Note that position 1 is the first character in ‘:FILE‘. If unsuccessful, the return value is like:

“‘
(:error "Unknown source location for SOMETHING")
“‘

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: find-source ((reference reference))
Method: find-source (object)
Method: find-source :around (object)
Generic Reader: glossary-term-name (object)
Package

mgl-pax.

Methods
Reader Method: glossary-term-name ((glossary-term glossary-term))

The name of the global variable whose value is this GLOSSARY-TERM object.

Source

pax-early.lisp.

Target Slot

name.

Generic Reader: glossary-term-title (object)
Package

mgl-pax.

Methods
Reader Method: glossary-term-title ((glossary-term glossary-term))

A markdown string or NIL. Used in generated documentation.

Source

pax-early.lisp.

Target Slot

title.

Generic Function: locate-and-collect-reachable-objects (object locative-type locative-args)

This is the @REFERENCE-DELEGATE of COLLECT-REACHABLE-OBJECTS.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: locate-and-collect-reachable-objects (object locative-type locative-args)
Generic Function: locate-and-document (object locative-type locative-args stream)

This is the @REFERENCE-DELEGATE of DOCUMENT.

Package

mgl-pax.

Source

extension-api.lisp.

Generic Function: locate-and-find-source (object locative-type locative-args)

This is the @REFERENCE-DELEGATE of FIND-SOURCE.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: locate-and-find-source (object locative-type locative-args)
Generic Function: locate-canonical-reference (object locative-type locative-args)

This is the @REFERENCE-DELEGATE of
CANONICAL-REFERENCE. The default method calls LOCATE-OBJECT with the three arguments. If LOCATE-OBJECT returns a REFERENCE, then that’s taken to be the canonical reference and is returned, else CANONICAL-REFERENCE is invoked with the returned object.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: locate-canonical-reference (object locative-type locative-args)
Generic Function: locate-docstring (object locative-type locative-args)

This is the @REFERENCE-DELEGATE of [DOCSTRING][ generic-function].

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: locate-docstring (object locative-type locative-args)
Generic Reader: locate-error-locative (condition)
Package

mgl-pax.

Methods
Reader Method: locate-error-locative ((condition locate-error))
Source

pax.lisp.

Target Slot

locative.

Generic Reader: locate-error-message (condition)
Package

mgl-pax.

Methods
Reader Method: locate-error-message ((condition locate-error))
Source

pax.lisp.

Target Slot

message.

Generic Reader: locate-error-object (condition)
Package

mgl-pax.

Methods
Reader Method: locate-error-object ((condition locate-error))
Source

pax.lisp.

Target Slot

object.

Generic Function: locate-object (object locative-type locative-args)

Return the object to which OBJECT and the locative
refer. Signal a LOCATE-ERROR condition by calling the LOCATE-ERROR function if the lookup fails. If a REFERENCE is returned, then it must be canonical in the sense that calling CANONICAL-REFERENCE on it will return the same reference. Don’t call this function directly. It serves only to extend LOCATE.

Package

mgl-pax.

Source

extension-api.lisp.

Methods
Method: locate-object :around (object locative-type locative-args)
Method: locate-object (object locative-type locative-args)
Generic Reader: reference-locative (object)
Package

mgl-pax.

Methods
Reader Method: reference-locative ((reference reference))

automatically generated reader method

Source

pax-early.lisp.

Target Slot

locative.

Generic Reader: reference-object (object)
Package

mgl-pax.

Methods
Reader Method: reference-object ((reference reference))

automatically generated reader method

Source

pax-early.lisp.

Target Slot

object.

Generic Reader: section-entries (object)
Package

mgl-pax.

Methods
Reader Method: section-entries ((section section))

A list of markdown docstrings and REFERENCE objects in the order they occurred in DEFSECTION.

Source

pax-early.lisp.

Target Slot

entries.

Package

mgl-pax.

Methods

A REFERENCE or NIL. Used in generated documentation.

Source

pax-early.lisp.

Target Slot

link-title-to.

Generic Reader: section-name (object)
Package

mgl-pax.

Methods
Reader Method: section-name ((section section))

The name of the global variable whose value is this SECTION object.

Source

pax-early.lisp.

Target Slot

name.

Generic Reader: section-package (object)
Package

mgl-pax.

Methods
Reader Method: section-package ((section section))

*PACKAGE* will be bound to this package when generating documentation for this section if *DOCUMENT-NORMALIZE-PACKAGES*.

Source

pax-early.lisp.

Target Slot

package.

Generic Reader: section-readtable (object)
Package

mgl-pax.

Methods
Reader Method: section-readtable ((section section))

*READTABLE* will be bound to this when generating
documentation for this section if *DOCUMENT-NORMALIZE-PACKAGES*.

Source

pax-early.lisp.

Target Slot

readtable.

Generic Reader: section-title (object)
Package

mgl-pax.

Methods
Reader Method: section-title ((section section))

A markdown string or NIL. Used in generated documentation.

Source

pax-early.lisp.

Target Slot

title.


6.1.5 Standalone methods

Method: print-object ((section section) stream)
Source

pax-early.lisp.

Method: print-object ((object reference) stream)
Source

pax-early.lisp.


6.1.6 Conditions

Condition: locate-error

Signaled by LOCATE when the lookup fails and ERRORP is true.

Package

mgl-pax.

Source

pax.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: message
Initargs

:message

Readers

locate-error-message.

Writers

This slot is read-only.

Slot: object
Initargs

:object

Readers

locate-error-object.

Writers

This slot is read-only.

Slot: locative
Initargs

:locative

Readers

locate-error-locative.

Writers

This slot is read-only.


6.1.7 Classes

Class: glossary-term

DEFINE-GLOSSARY-TERM instantiates a GLOSSARY-TERM with its NAME and TITLE arguments.

Package

mgl-pax.

Source

pax-early.lisp.

Direct methods
Direct slots
Slot: name

The name of the global variable whose value is this GLOSSARY-TERM object.

Initargs

:name

Readers

glossary-term-name.

Writers

This slot is read-only.

Slot: title

A markdown string or NIL. Used in generated documentation.

Initargs

:title

Readers

glossary-term-title.

Writers

This slot is read-only.

Slot: docstring
Initargs

:docstring

Readers

glossary-term-docstring.

Writers

This slot is read-only.

Class: reference

A REFERENCE represents a path (REFERENCE-LOCATIVE) to take from an object (REFERENCE-OBJECT).

Package

mgl-pax.

Source

pax-early.lisp.

Direct methods
Direct slots
Slot: object
Initargs

:object

Readers

reference-object.

Writers

This slot is read-only.

Slot: locative
Initargs

:locative

Readers

reference-locative.

Writers

This slot is read-only.

Class: section

DEFSECTION stores its NAME, TITLE, [PACKAGE][type], [READTABLE][type] and ENTRIES arguments in [SECTION][class] objects.

Package

mgl-pax.

Source

pax-early.lisp.

Direct methods
Direct slots
Slot: name

The name of the global variable whose value is this SECTION object.

Initargs

:name

Readers

section-name.

Writers

This slot is read-only.

Slot: package

*PACKAGE* will be bound to this package when generating documentation for this section if *DOCUMENT-NORMALIZE-PACKAGES*.

Package

common-lisp.

Initargs

:package

Readers

section-package.

Writers

This slot is read-only.

Slot: readtable

*READTABLE* will be bound to this when generating
documentation for this section if *DOCUMENT-NORMALIZE-PACKAGES*.

Package

common-lisp.

Initargs

:readtable

Readers

section-readtable.

Writers

This slot is read-only.

Slot: title

A markdown string or NIL. Used in generated documentation.

Initargs

:title

Readers

section-title.

Writers

This slot is read-only.

A REFERENCE or NIL. Used in generated documentation.

Initargs

:link-title-to

Readers

section-link-title-to.

Writers

This slot is read-only.

Slot: entries

A list of markdown docstrings and REFERENCE objects in the order they occurred in DEFSECTION.

Initargs

:entries

Readers

section-entries.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: *find-source-cache*
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: *heading-level*
Package

mgl-pax.

Special Variable: *local-references*
Package

mgl-pax.

Special Variable: *locate-object-locative*
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: *locate-object-object*
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: *locative-source-search-list*
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: *objects-being-documented*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *reference-being-documented*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *registered-pax-world-docs*
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: *symbol-macro-docstrings*
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @background
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @basics
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @condition-system-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @extending-document
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: @extension-api
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: @external-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @functionlike-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @github-workflow
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: @glossary-terms
Package

mgl-pax.

Source

extension-api.lisp.

Package

mgl-pax.

Source

pax.lisp.

Special Variable: @locative
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @locatives-and-references
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @locatives-and-references-api
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @macrolike-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @new-object-types
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: @object
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @packagelike-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @pax-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @pax-manual
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @pax-world
Package

mgl-pax.

Source

document-early.lisp.

Special Variable: @reference
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @reference-based-extensions
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: @reference-delegate
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: @sections
Package

mgl-pax.

Source

extension-api.lisp.

Special Variable: @tutorial
Package

mgl-pax.

Source

pax.lisp.

Special Variable: @typelike-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: @variablelike-locatives
Package

mgl-pax.

Source

locatives-early.lisp.

Special Variable: end-of-register-doc-example
Package

mgl-pax.

Source

document-early.lisp.


6.2.2 Macros

Macro: autoload (name asdf-system-name &key export)
Package

mgl-pax.

Source

autoload.lisp.

Macro: defun/autoloaded (name lambda-list &body body)
Package

mgl-pax.

Source

autoload.lisp.

Macro: symbol-lambda-list-method (symbol locative-type)
Package

mgl-pax.

Source

extension-api.lisp.

Macro: with-local-references (refs &body body)
Package

mgl-pax.

Source

document-early.lisp.

Macro: without-redefinition-warnings (&body body)
Package

mgl-pax.

Source

autoload.lisp.


6.2.3 Ordinary functions

Function: add-locative-to-source-search-list (locative)

Some locatives are implemented in terms of Lisp defintions, for which [SLIME’s ‘\\M-.‘][slime-m-.] finds source code of the box. For example, DEFSECTIONs are global variables. To be able to list all definitions that belong to an @OBJECT, we register locatives to try with ADD-LOCATIVE-TO-SOURCE-SEARCH-LIST.

Package

mgl-pax.

Source

extension-api.lisp.

Function: asdf-system-git-version (system)
Package

mgl-pax.

Source

document-early.lisp.

Function: call-with-heading (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: check-body-docstring (docstring)
Package

mgl-pax.

Source

extension-api.lisp.

Function: compile-without-some-warnings (continuation)
Package

mgl-pax.asdf.

Source

asdf.lisp.

Function: convert-source-location (source-location system-dir reference line-file-position-cache)
Package

mgl-pax.

Source

document-early.lisp.

Function: delegate-reference (delegate reference &key delegator defaults)
Package

mgl-pax.

Source

extension-api.lisp.

Function: downcasingp (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: ensure-list (object)
Package

mgl-pax.

Source

document-early.lisp.

Function: entry-to-reference (entry section-name)
Package

mgl-pax.

Source

pax-early.lisp.

Function: expand-define-definer-for-symbol-as-locative-definer-body (symbol locative-type lambda-list docstring)
Package

mgl-pax.

Source

extension-api.lisp.

Function: export-some-symbols (name entries package)
Package

mgl-pax.

Source

pax-early.lisp.

Function: exportablep (package symbol locative)
Package

mgl-pax.

Source

pax-early.lisp.

Function: file-position-to-line-number (filename file-position cache)
Package

mgl-pax.

Source

document-early.lisp.

Function: find-hyperspec-id (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: git-version (git-dir)
Package

mgl-pax.

Source

document-early.lisp.

Function: line-file-positions (filename)
Package

mgl-pax.

Source

document-early.lisp.

Function: locate-definitions-for-emacs (&rest args)
Package

mgl-pax.

Source

navigate-early.lisp.

Function: normalize-locative (locative)
Package

mgl-pax.

Source

pax-early.lisp.

Function: pax-pages ()
Package

mgl-pax.

Source

document-early.lisp.

Function: pax-sections ()
Package

mgl-pax.

Source

document-early.lisp.

Function: prin1-to-string/fully-qualified (object)
Package

mgl-pax.

Source

pax-early.lisp.

Function: print-reference-bullet (&rest args)
Package

mgl-pax.

Source

document-early.lisp.

Function: reference-locative-args (reference)
Package

mgl-pax.

Source

pax-early.lisp.

Function: reference-locative-type (reference)
Package

mgl-pax.

Source

pax-early.lisp.

Function: reference-object= (object reference)
Package

mgl-pax.

Source

pax-early.lisp.

Function: reference= (reference-1 reference-2)
Package

mgl-pax.

Source

pax-early.lisp.

Function: symbol-accessible-in-package-p (symbol package)
Package

mgl-pax.

Source

pax-early.lisp.

Function: transcribe-for-emacs (&rest args)
Package

mgl-pax.

Source

transcribe-early.lisp.

Function: transform-entries (entries section-name)
Package

mgl-pax.

Source

pax-early.lisp.

Package

mgl-pax.

Source

pax-early.lisp.


6.2.4 Generic functions

Generic Reader: glossary-term-docstring (object)
Package

mgl-pax.

Methods
Reader Method: glossary-term-docstring ((glossary-term glossary-term))

automatically generated reader method

Source

pax-early.lisp.

Target Slot

docstring.

Generic Function: locative-lambda-list (symbol)
Package

mgl-pax.

Source

extension-api.lisp.

Generic Function: symbol-lambda-list (symbol locative-type)
Package

mgl-pax.

Source

extension-api.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   C   D   E   F   G   L   M   N   P   R   S   T   U   W  
Index Entry  Section

A
add-locative-to-source-search-list: Private ordinary functions
asdf-system-git-version: Private ordinary functions
autoload: Private macros

C
call-with-heading: Private ordinary functions
call-with-wrappers: Public ordinary functions
canonical-reference: Public generic functions
canonical-reference: Public generic functions
canonical-reference: Public generic functions
canonical-reference: Public generic functions
check-body-docstring: Private ordinary functions
collect-reachable-objects: Public generic functions
collect-reachable-objects: Public generic functions
collect-reachable-objects: Public generic functions
collect-reachable-objects: Public generic functions
compile-pax: Public ordinary functions
compile-per-file: Public ordinary functions
compile-with-source-info: Public ordinary functions
compile-without-some-warnings: Private ordinary functions
compose-wrappers: Public ordinary functions
convert-source-location: Private ordinary functions

D
define-definer-for-symbol-locative-type: Public macros
define-glossary-term: Public macros
define-locative-alias: Public macros
define-locative-type: Public macros
define-package: Public macros
define-restart: Public macros
define-symbol-locative-type: Public macros
defsection: Public macros
defun/autoloaded: Private macros
delegate-reference: Private ordinary functions
delete-comments: Public ordinary functions
delete-trailing-whitespace: Public ordinary functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
docstring: Public generic functions
document: Public ordinary functions
document-docstring: Public ordinary functions
document-object: Public generic functions
documentation*: Public ordinary functions
documenting-reference: Public macros
downcasingp: Private ordinary functions

E
ensure-list: Private ordinary functions
ensure-navigate-loaded: Public ordinary functions
entry-to-reference: Private ordinary functions
escape-markdown: Public ordinary functions
expand-define-definer-for-symbol-as-locative-definer-body: Private ordinary functions
export-some-symbols: Private ordinary functions
exportable-locative-type-p: Public generic functions
exportable-locative-type-p: Public generic functions
exportable-locative-type-p: Public generic functions
exportable-locative-type-p: Public generic functions
exportable-locative-type-p: Public generic functions
exportable-locative-type-p: Public generic functions
exportable-reference-p: Public generic functions
exportable-reference-p: Public generic functions
exportable-reference-p: Public generic functions
exportable-reference-p: Public generic functions
exportablep: Private ordinary functions

F
file-position-to-line-number: Private ordinary functions
find-definition: Public ordinary functions
find-definition*: Public ordinary functions
find-hyperspec-id: Private ordinary functions
find-source: Public generic functions
find-source: Public generic functions
find-source: Public generic functions
find-source: Public generic functions
Function, add-locative-to-source-search-list: Private ordinary functions
Function, asdf-system-git-version: Private ordinary functions
Function, call-with-heading: Private ordinary functions
Function, call-with-wrappers: Public ordinary functions
Function, check-body-docstring: Private ordinary functions
Function, compile-pax: Public ordinary functions
Function, compile-per-file: Public ordinary functions
Function, compile-with-source-info: Public ordinary functions
Function, compile-without-some-warnings: Private ordinary functions
Function, compose-wrappers: Public ordinary functions
Function, convert-source-location: Private ordinary functions
Function, delegate-reference: Private ordinary functions
Function, delete-comments: Public ordinary functions
Function, delete-trailing-whitespace: Public ordinary functions
Function, document: Public ordinary functions
Function, document-docstring: Public ordinary functions
Function, documentation*: Public ordinary functions
Function, downcasingp: Private ordinary functions
Function, ensure-list: Private ordinary functions
Function, ensure-navigate-loaded: Public ordinary functions
Function, entry-to-reference: Private ordinary functions
Function, escape-markdown: Public ordinary functions
Function, expand-define-definer-for-symbol-as-locative-definer-body: Private ordinary functions
Function, export-some-symbols: Private ordinary functions
Function, exportablep: Private ordinary functions
Function, file-position-to-line-number: Private ordinary functions
Function, find-definition: Public ordinary functions
Function, find-definition*: Public ordinary functions
Function, find-hyperspec-id: Private ordinary functions
Function, git-version: Private ordinary functions
Function, line-file-positions: Private ordinary functions
Function, locate: Public ordinary functions
Function, locate-definitions-for-emacs: Private ordinary functions
Function, locate-error: Public ordinary functions
Function, locative-args: Public ordinary functions
Function, locative-type: Public ordinary functions
Function, make-git-source-uri-fn: Public ordinary functions
Function, make-github-source-uri-fn: Public ordinary functions
Function, make-reference: Public ordinary functions
Function, normalize-locative: Private ordinary functions
Function, pax-pages: Private ordinary functions
Function, pax-sections: Private ordinary functions
Function, prin1-to-markdown: Public ordinary functions
Function, prin1-to-string/fully-qualified: Private ordinary functions
Function, print-reference-bullet: Private ordinary functions
Function, reference-locative-args: Private ordinary functions
Function, reference-locative-type: Private ordinary functions
Function, reference-object=: Private ordinary functions
Function, reference=: Private ordinary functions
Function, register-doc-in-pax-world: Public ordinary functions
Function, resolve: Public ordinary functions
Function, squeeze-whitespace: Public ordinary functions
Function, symbol-accessible-in-package-p: Private ordinary functions
Function, transcribe: Public ordinary functions
Function, transcribe-for-emacs: Private ordinary functions
Function, transform-entries: Private ordinary functions
Function, transform-link-title-to: Private ordinary functions
Function, update-asdf-system-html-docs: Public ordinary functions
Function, update-asdf-system-readmes: Public ordinary functions
Function, update-pax-world: Public ordinary functions

G
Generic Function, canonical-reference: Public generic functions
Generic Function, collect-reachable-objects: Public generic functions
Generic Function, docstring: Public generic functions
Generic Function, document-object: Public generic functions
Generic Function, exportable-locative-type-p: Public generic functions
Generic Function, exportable-reference-p: Public generic functions
Generic Function, find-source: Public generic functions
Generic Function, glossary-term-docstring: Private generic functions
Generic Function, glossary-term-name: Public generic functions
Generic Function, glossary-term-title: Public generic functions
Generic Function, locate-and-collect-reachable-objects: Public generic functions
Generic Function, locate-and-document: Public generic functions
Generic Function, locate-and-find-source: Public generic functions
Generic Function, locate-canonical-reference: Public generic functions
Generic Function, locate-docstring: Public generic functions
Generic Function, locate-error-locative: Public generic functions
Generic Function, locate-error-message: Public generic functions
Generic Function, locate-error-object: Public generic functions
Generic Function, locate-object: Public generic functions
Generic Function, locative-lambda-list: Private generic functions
Generic Function, reference-locative: Public generic functions
Generic Function, reference-object: Public generic functions
Generic Function, section-entries: Public generic functions
Generic Function, section-link-title-to: Public generic functions
Generic Function, section-name: Public generic functions
Generic Function, section-package: Public generic functions
Generic Function, section-readtable: Public generic functions
Generic Function, section-title: Public generic functions
Generic Function, symbol-lambda-list: Private generic functions
git-version: Private ordinary functions
glossary-term-docstring: Private generic functions
glossary-term-docstring: Private generic functions
glossary-term-name: Public generic functions
glossary-term-name: Public generic functions
glossary-term-title: Public generic functions
glossary-term-title: Public generic functions

L
line-file-positions: Private ordinary functions
locate: Public ordinary functions
locate-and-collect-reachable-objects: Public generic functions
locate-and-collect-reachable-objects: Public generic functions
locate-and-document: Public generic functions
locate-and-find-source: Public generic functions
locate-and-find-source: Public generic functions
locate-canonical-reference: Public generic functions
locate-canonical-reference: Public generic functions
locate-definitions-for-emacs: Private ordinary functions
locate-docstring: Public generic functions
locate-docstring: Public generic functions
locate-error: Public ordinary functions
locate-error-locative: Public generic functions
locate-error-locative: Public generic functions
locate-error-message: Public generic functions
locate-error-message: Public generic functions
locate-error-object: Public generic functions
locate-error-object: Public generic functions
locate-object: Public generic functions
locate-object: Public generic functions
locate-object: Public generic functions
locative-args: Public ordinary functions
locative-lambda-list: Private generic functions
locative-type: Public ordinary functions

M
Macro, autoload: Private macros
Macro, define-definer-for-symbol-locative-type: Public macros
Macro, define-glossary-term: Public macros
Macro, define-locative-alias: Public macros
Macro, define-locative-type: Public macros
Macro, define-package: Public macros
Macro, define-restart: Public macros
Macro, define-symbol-locative-type: Public macros
Macro, defsection: Public macros
Macro, defun/autoloaded: Private macros
Macro, documenting-reference: Public macros
Macro, symbol-lambda-list-method: Private macros
Macro, with-dislocated-objects: Public macros
Macro, with-heading: Public macros
Macro, with-local-references: Private macros
Macro, without-redefinition-warnings: Private macros
make-git-source-uri-fn: Public ordinary functions
make-github-source-uri-fn: Public ordinary functions
make-reference: Public ordinary functions
Method, canonical-reference: Public generic functions
Method, canonical-reference: Public generic functions
Method, canonical-reference: Public generic functions
Method, collect-reachable-objects: Public generic functions
Method, collect-reachable-objects: Public generic functions
Method, collect-reachable-objects: Public generic functions
Method, docstring: Public generic functions
Method, docstring: Public generic functions
Method, docstring: Public generic functions
Method, exportable-locative-type-p: Public generic functions
Method, exportable-locative-type-p: Public generic functions
Method, exportable-locative-type-p: Public generic functions
Method, exportable-locative-type-p: Public generic functions
Method, exportable-locative-type-p: Public generic functions
Method, exportable-reference-p: Public generic functions
Method, exportable-reference-p: Public generic functions
Method, exportable-reference-p: Public generic functions
Method, find-source: Public generic functions
Method, find-source: Public generic functions
Method, find-source: Public generic functions
Method, glossary-term-docstring: Private generic functions
Method, glossary-term-name: Public generic functions
Method, glossary-term-title: Public generic functions
Method, locate-and-collect-reachable-objects: Public generic functions
Method, locate-and-find-source: Public generic functions
Method, locate-canonical-reference: Public generic functions
Method, locate-docstring: Public generic functions
Method, locate-error-locative: Public generic functions
Method, locate-error-message: Public generic functions
Method, locate-error-object: Public generic functions
Method, locate-object: Public generic functions
Method, locate-object: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, reference-locative: Public generic functions
Method, reference-object: Public generic functions
Method, section-entries: Public generic functions
Method, section-link-title-to: Public generic functions
Method, section-name: Public generic functions
Method, section-package: Public generic functions
Method, section-readtable: Public generic functions
Method, section-title: Public generic functions

N
normalize-locative: Private ordinary functions

P
pax-pages: Private ordinary functions
pax-sections: Private ordinary functions
prin1-to-markdown: Public ordinary functions
prin1-to-string/fully-qualified: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods
print-reference-bullet: Private ordinary functions

R
reference-locative: Public generic functions
reference-locative: Public generic functions
reference-locative-args: Private ordinary functions
reference-locative-type: Private ordinary functions
reference-object: Public generic functions
reference-object: Public generic functions
reference-object=: Private ordinary functions
reference=: Private ordinary functions
register-doc-in-pax-world: Public ordinary functions
resolve: Public ordinary functions

S
section-entries: Public generic functions
section-entries: Public generic functions
section-link-title-to: Public generic functions
section-link-title-to: Public generic functions
section-name: Public generic functions
section-name: Public generic functions
section-package: Public generic functions
section-package: Public generic functions
section-readtable: Public generic functions
section-readtable: Public generic functions
section-title: Public generic functions
section-title: Public generic functions
squeeze-whitespace: Public ordinary functions
symbol-accessible-in-package-p: Private ordinary functions
symbol-lambda-list: Private generic functions
symbol-lambda-list-method: Private macros

T
transcribe: Public ordinary functions
transcribe-for-emacs: Private ordinary functions
transform-entries: Private ordinary functions
transform-link-title-to: Private ordinary functions

U
update-asdf-system-html-docs: Public ordinary functions
update-asdf-system-readmes: Public ordinary functions
update-pax-world: Public ordinary functions

W
with-dislocated-objects: Public macros
with-heading: Public macros
with-local-references: Private macros
without-redefinition-warnings: Private macros


A.3 Variables

Jump to:   *   @  
D   E   L   M   N   O   P   R   S   T  
Index Entry  Section

*
*discard-documentation-p*: Public special variables
*document-fancy-html-navigation*: Public special variables
*document-html-bottom-blocks-of-links*: Public special variables
*document-html-head*: Public special variables
*document-html-max-navigation-table-of-contents-level*: Public special variables
*document-html-top-blocks-of-links*: Public special variables
*document-link-code*: Public special variables
*document-link-sections*: Public special variables
*document-mark-up-signatures*: Public special variables
*document-max-numbering-level*: Public special variables
*document-max-table-of-contents-level*: Public special variables
*document-normalize-packages*: Public special variables
*document-text-navigation*: Public special variables
*document-uppercase-is-code*: Public special variables
*find-source-cache*: Private special variables
*format*: Public special variables
*heading-level*: Private special variables
*local-references*: Private special variables
*locate-object-locative*: Private special variables
*locate-object-object*: Private special variables
*locative-source-search-list*: Private special variables
*objects-being-documented*: Private special variables
*reference-being-documented*: Private special variables
*registered-pax-world-docs*: Private special variables
*symbol-macro-docstrings*: Private special variables
*transcribe-check-consistency*: Public special variables
*transcribe-syntaxes*: Public special variables

@
@background: Private special variables
@basics: Private special variables
@condition-system-locatives: Private special variables
@extending-document: Private special variables
@extension-api: Private special variables
@external-locatives: Private special variables
@functionlike-locatives: Private special variables
@github-workflow: Private special variables
@glossary-terms: Private special variables
@links: Private special variables
@locative: Private special variables
@locatives-and-references: Private special variables
@locatives-and-references-api: Private special variables
@macrolike-locatives: Private special variables
@new-object-types: Private special variables
@object: Private special variables
@packagelike-locatives: Private special variables
@pax-locatives: Private special variables
@pax-manual: Private special variables
@pax-world: Private special variables
@reference: Private special variables
@reference-based-extensions: Private special variables
@reference-delegate: Private special variables
@sections: Private special variables
@tutorial: Private special variables
@typelike-locatives: Private special variables
@variablelike-locatives: Private special variables

D
docstring: Public classes

E
end-of-register-doc-example: Private special variables
entries: Public classes

L
link-title-to: Public classes
locative: Public conditions
locative: Public classes

M
message: Public conditions

N
name: Public classes
name: Public classes

O
object: Public conditions
object: Public classes

P
package: Public classes

R
readtable: Public classes

S
Slot, docstring: Public classes
Slot, entries: Public classes
Slot, link-title-to: Public classes
Slot, locative: Public conditions
Slot, locative: Public classes
Slot, message: Public conditions
Slot, name: Public classes
Slot, name: Public classes
Slot, object: Public conditions
Slot, object: Public classes
Slot, package: Public classes
Slot, readtable: Public classes
Slot, title: Public classes
Slot, title: Public classes
Special Variable, *discard-documentation-p*: Public special variables
Special Variable, *document-fancy-html-navigation*: Public special variables
Special Variable, *document-html-bottom-blocks-of-links*: Public special variables
Special Variable, *document-html-head*: Public special variables
Special Variable, *document-html-max-navigation-table-of-contents-level*: Public special variables
Special Variable, *document-html-top-blocks-of-links*: Public special variables
Special Variable, *document-link-code*: Public special variables
Special Variable, *document-link-sections*: Public special variables
Special Variable, *document-mark-up-signatures*: Public special variables
Special Variable, *document-max-numbering-level*: Public special variables
Special Variable, *document-max-table-of-contents-level*: Public special variables
Special Variable, *document-normalize-packages*: Public special variables
Special Variable, *document-text-navigation*: Public special variables
Special Variable, *document-uppercase-is-code*: Public special variables
Special Variable, *find-source-cache*: Private special variables
Special Variable, *format*: Public special variables
Special Variable, *heading-level*: Private special variables
Special Variable, *local-references*: Private special variables
Special Variable, *locate-object-locative*: Private special variables
Special Variable, *locate-object-object*: Private special variables
Special Variable, *locative-source-search-list*: Private special variables
Special Variable, *objects-being-documented*: Private special variables
Special Variable, *reference-being-documented*: Private special variables
Special Variable, *registered-pax-world-docs*: Private special variables
Special Variable, *symbol-macro-docstrings*: Private special variables
Special Variable, *transcribe-check-consistency*: Public special variables
Special Variable, *transcribe-syntaxes*: Public special variables
Special Variable, @background: Private special variables
Special Variable, @basics: Private special variables
Special Variable, @condition-system-locatives: Private special variables
Special Variable, @extending-document: Private special variables
Special Variable, @extension-api: Private special variables
Special Variable, @external-locatives: Private special variables
Special Variable, @functionlike-locatives: Private special variables
Special Variable, @github-workflow: Private special variables
Special Variable, @glossary-terms: Private special variables
Special Variable, @links: Private special variables
Special Variable, @locative: Private special variables
Special Variable, @locatives-and-references: Private special variables
Special Variable, @locatives-and-references-api: Private special variables
Special Variable, @macrolike-locatives: Private special variables
Special Variable, @new-object-types: Private special variables
Special Variable, @object: Private special variables
Special Variable, @packagelike-locatives: Private special variables
Special Variable, @pax-locatives: Private special variables
Special Variable, @pax-manual: Private special variables
Special Variable, @pax-world: Private special variables
Special Variable, @reference: Private special variables
Special Variable, @reference-based-extensions: Private special variables
Special Variable, @reference-delegate: Private special variables
Special Variable, @sections: Private special variables
Special Variable, @tutorial: Private special variables
Special Variable, @typelike-locatives: Private special variables
Special Variable, @variablelike-locatives: Private special variables
Special Variable, end-of-register-doc-example: Private special variables

T
title: Public classes
title: Public classes


A.4 Data types

Jump to:   A   C   D   E   F   G   L   M   N   P   R   S   T  
Index Entry  Section

A
asdf.lisp: The mgl-pax․asdf/asdf․lisp file
autoload.lisp: The mgl-pax/src/base//autoload․lisp file

C
Class, glossary-term: Public classes
Class, reference: Public classes
Class, section: Public classes
Condition, locate-error: Public conditions

D
document-early.lisp: The mgl-pax/src/base//document-early․lisp file

E
extension-api.lisp: The mgl-pax/src/base//extension-api․lisp file

F
File, asdf.lisp: The mgl-pax․asdf/asdf․lisp file
File, autoload.lisp: The mgl-pax/src/base//autoload․lisp file
File, document-early.lisp: The mgl-pax/src/base//document-early․lisp file
File, extension-api.lisp: The mgl-pax/src/base//extension-api․lisp file
File, locatives-early.lisp: The mgl-pax/src/base//locatives-early․lisp file
File, mgl-pax.asd: The mgl-pax/mgl-pax․asd file
File, mgl-pax.asdf.asd: The mgl-pax․asdf/mgl-pax․asdf․asd file
File, navigate-early.lisp: The mgl-pax/src/base//navigate-early․lisp file
File, package.lisp: The mgl-pax/src/base//package․lisp file
File, pax-early.lisp: The mgl-pax/src/base//pax-early․lisp file
File, pax.lisp: The mgl-pax/src/base//pax․lisp file
File, transcribe-early.lisp: The mgl-pax/src/base//transcribe-early․lisp file

G
glossary-term: Public classes

L
locate-error: Public conditions
locatives-early.lisp: The mgl-pax/src/base//locatives-early․lisp file

M
mgl-pax: The mgl-pax system
mgl-pax: The mgl-pax package
mgl-pax.asd: The mgl-pax/mgl-pax․asd file
mgl-pax.asdf: The mgl-pax․asdf system
mgl-pax.asdf: The mgl-pax․asdf package
mgl-pax.asdf.asd: The mgl-pax․asdf/mgl-pax․asdf․asd file
Module, src/base/: The mgl-pax/src/base/ module

N
navigate-early.lisp: The mgl-pax/src/base//navigate-early․lisp file

P
Package, mgl-pax: The mgl-pax package
Package, mgl-pax.asdf: The mgl-pax․asdf package
package.lisp: The mgl-pax/src/base//package․lisp file
pax-early.lisp: The mgl-pax/src/base//pax-early․lisp file
pax.lisp: The mgl-pax/src/base//pax․lisp file

R
reference: Public classes

S
section: Public classes
src/base/: The mgl-pax/src/base/ module
System, mgl-pax: The mgl-pax system
System, mgl-pax.asdf: The mgl-pax․asdf system

T
transcribe-early.lisp: The mgl-pax/src/base//transcribe-early․lisp file