Cross-linked HTML documentation for systems known to use MGL-PAX.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
COPYING
README
README.md
cube-manual.html
gpr-manual.html
index.html
jquery.min.js
mat-manual.html
mgl-manual.html
mgl-pax-manual.html
mgl-pax-world-manual.html
mgl-pax-world.asd
micmac-manual.html
named-readtables-manual.html
style.css
toc.min.js

README.md

PAX World Manual

Table of Contents

[in package MGL-PAX-WORLD]

1 mgl-pax-world ASDF System Details

  • Version: 0.0.1
  • Description: Cross-linked HTML documentation for systems known to use MGL-PAX.
  • Licence: MIT, see COPYING.
  • Author: Gábor Melis
  • Mailto: mega@retes.hu
  • Homepage: http://quotenil.com

2 Basics

Not that there is room here to be non-basic in any way.

  • [function] UPDATE-PAX-WORLD &KEY (SECTIONS (DEFAULT-SECTIONS)) (PAGE-SPECS (DEFAULT-PAGE-SPECS))

    Generate HTML documentation for all SECTIONS. By default, files are created in *PAX-WORLD-DIR*. For projects with repositories on github, links to sources on github are added via the :SOURCE-URI-FN mechanism of DOCUMENT.

    In the absence of :HEADER-FN :FOOTER-FN, :OUTPUT every spec in PAGE-SPECS is augmented with HTML headers, footers and output location specifications (based on the name of the section).

    If necessary a default page spec is created for every section.

  • [variable] *PAX-WORLD-DIR* "- the root of the MGL-PAX-WORLD ASDF system -"

  • [function] DEFAULT-SECTIONS

    Returns the default list of sections for which UPDATE-PAX-WORLD generates documentation.

  • [function] DEFAULT-PAGE-SPECS

    Returns the default list of page specifications for UPDATE-PAX-WORLD. This must be suitable as the PAGES argument for DOCUMENT.


[generated by MGL-PAX]