The staple Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The staple Reference Manual

This is the staple Reference Manual, version 2.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 13:01:16 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

About Staple

Staple is a documentation system. It provides you with a way to generate standalone documentation accumulated from various sources such as readmes, documentation files, and docstrings.

How To

The most trivial manner in which to use staple is to simply run it and let its inference mechanism figure out how to document your system. You can do that like so:

(staple:generate :my-system)

For best immediate results you should not load your system before you load Staple, so that Staple can record the packages the system defines as it is being loaded. If you later customise the documentation and set the packages explicitly, you don't have to watch out for that anymore, though. The documentation should land in a subdirectory called doc within the system's source directory. For ad-hoc usage you can change some of the behaviour through keyword arguments:

However, if you change any of these options, you will likely want to persist them somehow. The best way to do this is to use Staple's customisation mechanism. See the sections below for that.

You may also be interested in Staple's server system, which gives you a live documentation browser for all systems currently loaded in your Lisp image.

Concepts

Staple organises itself around projects and pages. Every mechanism in it is an extension of those two concepts.

Projects

Projects represent a, well, project. This is distinct from an ASDF system, as a project might encompass multiple systems. Similarly, an ASDF system fed to generate might generate documentation for multiple ASDF systems at once. While a project might represent multiple systems, it is always identified by at least one "primary" system.

In order to get the project for a primary system, you can use find-project. This will return NIL if no specific project is defined for a system. In that case you may also use infer-project to let Staple try and figure out a project for the system automatically.

Each project is composed of a number of pages. When a project is generated, each of its pages are generated as well, producing the actual output of the project.

Pages

A page represents an output that should be generated as part of a project. Typically this will be some kind of file, like an HTML document. A page has a specific language and a title. Pages with the same title should represent the same page, but in different languages. This allows you to write multilingual documentation. More on that later.

All you can do with a page, aside from inspecting its language, title, and output, is to generate it. For anything more advanced, you should have a look at its subclasses:

input-page

This is a primitive subclass of the page that denotes some kind of input that is being transformed when the page is generated. It should be used for anything that bases its output on some kind of input file or stream.

static-page

This page simply copies the input to the output verbatim, providing a way to define static files such as images and so forth. Since images and such resources are not really "pages" per se, this might be a strange fit, but by simply leaving the title NIL, you can use the same mechanisms regardless.

compiled-page

Compiled pages use Staple's compile-source mechanism, which translates source in some other format like Markdown into HTML. By default only text and HTML itself is supported, but you can trivially add other formats, or use the staple-markdown system to add Markdown support automatically.

templated-page

This kind of page uses the Clip system to perform a template expansion. If you want to use this kind of page, you should subclass it and add a method on template-data to supply the necessary data to the Clip template. See Clip for further information.

definitions-index-page

Often times you'll want to include a definitions index alongside the main documentation content. THis page adds additional support for this by including a list of packages to define, and several methods to aid in formatting the definitions, such as format-documentation, resolve-source-link, definition-wanted-p, and definitions. Note that this is a subclass of templated-page, meaning that if you want a definitions index, but don't want to use Clip, you'll need to do some work of your own.

system-page

This page adds some additional convenience when dealing with pages that document a specific ASDF system.

simple-page

Finally, the simple page is used for inferred projects and offers a base page for easy customisation. It provides sensible defaults for definition inclusion, template data, and so forth.

Customisation

Customising Staple should happen through a file called staple.ext.lisp within your primary system's root source directory. This file is automatically loaded by Staple when the system is generated, making it convenient to add extra functionality.

There's two ways in which to customise how Staple generates the documentation for your system. You can either define your own project manually for maximum control, or influence the inference mechanism for some quick and easy changes.

Custom Projects

Customising projects is easy to explain, as it simply involves adding a method to find-project specialising on your system's name that returns the readily made project instance.

(defmethod staple:find-project ((system (eql (asdf:find-system :my-system))) &key)
  #|.. create project ..|#)

See the documentation for the different kinds of pages to see what you can do with them. One thing you should always respect is the :output-directory keyword argument, which should provide the root directory in which the documentation is stored. You can find a good default using the output-directory function on your system.

You should still read the following sections, as they will show examples on how to customise pages and what kinds of functions there are to influence behaviour so that you don't necessarily need to write everything from scratch unless you want to.

Custom Inference

As mentioned in the How To section above, you can persist the different options you can pass to generate by changing the project inference. The following functions are called to determine the default values for the respective keyword arguments:

In order to override these, just write a method specialising on your system:

(defmethod staple:template ((system (eql (asdf:find-system :my-system))))
  (asdf:system-relative-pathname system #p"my-template.ctml"))

Some properties like the way documentation and docstrings are formatted require changing the way pages behave. For that, you can override the page-type similar to the above code snippet, and implement a custom page subclass as illustrated in the next section.

Custom Pages

By subclassing simple-page, you can customise all sorts of behaviours.

(defclass my-page (staple:simple-page) ())

Following are a few examples for things one might frequently want to change about the default behaviour of a page. If you are customising project inference, you can use page-type to use this page:

(defmethod staple:page-type ((system (eql (asdf:find-system :my-system))))
  'my-page)

Changing Which Definitions are Shown

(defmethod staple:definition-wanted-p ((_ definitions:method) (__ my-page)) T)
(defmethod staple:definition-wanted-p ((_ definitions:compiler-macro) (__ my-page)) T)
(defmethod staple:definition-wanted-p ((_ definitions:macro) (__ my-page)) NIL)

This will show methods and compiler-macros, but hide macros. By default all definitions for external symbols are shown except for methods, packages, compiler-macros, and declarations.

Including Additional Definitions

(defmethod staple:definitions ((page my-page) package)
  (append (definitions:find-definitions 'cl:if)
          (call-next-method)))

This forces the definitions for cl:if to be included with the rest of the definitions for the packages of the page.

Changing Source Links

(defmethod staple:resolve-source-link (source (page my-page))
  (format NIL "http://someplace/view-file/~a#line-~a" 
    (make-path-relative-somehow (getf source :file))
    (getf source :row)))

Note that by default, if you set the :homepage property in your ASDF system definition to a GitHub or GitLab project URL, it will try to automatically compute the URL to GitHub's or GitLab's file viewer.

Changing Docstring Formatting

(defmethod staple:format-documentation ((docstring string) (page my-page))
  (let ((*package* (first (staple:packages page))))
    (staple:markup-code-snippets-ignoring-errors
     (staple:compile-source docstring :markdown))))

This will parse the docstring as Markdown and cross-reference all code snippets. Make sure to also load the staple-markdown system in your extension file.

Changing Document Formatting

(defmethod staple:compile-source ((document pathname) (page my-page))
  (staple:compile-source document :text))

This will force the document to be parsed as raw text.

Changing the Filename

(defmethod staple:filename ((page my-page))
  (make-pathname :name "foo" :type "html"))

This will force the file name of all pages to be foo.html.

Changing or Adding Template Data

(defmethod staple:template-data append ((page my-page))
  (list :title "My Title"
        :generation-time (get-universal-time)))

Due to the append method-combination and the way getf works, this will override the :title value, and add the new :generation-time value which can now be referenced from the template.

Changing Generation Behaviour

(defmethod staple:generate :after ((page my-page) &key)
  (format *debug-io* "~& Generated ~a.~%" page))

This adds a method that is called once the generation has completed, and simply prints a status message saying as much. You can use all the usual tricks of the standard method combination to customise things to your heart's content.

Custom Templates

Writing a custom template is mostly a question of writing an HTML document that you want, and then filling in the necessary Clip attributes to add the data in the right spots. Figuring this out should be pretty trivial if you have a look at the existing default template and the Clip documentation

Fixing GitHub

By default Staple outputs the documentation into the source tree of your project. This will cause GitHub to index the HTML file and, depending on circumstances, think that your project is now primarily an HTML project. To fix this issue, you should mark the documentation as ignored for GitHub's indexer. You can do this by putting the following into a .gitattributes file at the repository root:

doc/ linguist-vendored

An Example Customisation File

This is a simple example customisation file that changes the inferred project to use a custom markup syntax and package list.

(asdf:load-system :staple-markdown)

(defclass my-page (staple:simple-page) ())

(defmethod staple:page-type ((system (eql (asdf:find-system :my-system))))
  'my-page)

(defmethod staple:packages ((system (eql (asdf:find-system :my-system))))
  (mapcar #'find-package '(:my-system :my-system-other)))

(defmethod staple:format-documentation ((docstring string) (page my-page))
  (let ((*package* (first (staple:packages page))))
    (staple:markup-code-snippets-ignoring-errors
     (staple:compile-source docstring :markdown))))

Custom Global Definitions

Staple has support for documenting arbitrary definition types aside from the standard top level definition types that Common Lisp exposes. This is done through the Definitions library. Please see its documentation on how to add custom definitions. You can write this extra glue code into your staple.ext.lisp file along with all the other Staple customisations. When a new definition type is defined, Staple will automatically try to find it and include it in your simple-pages. If you would like to be more selective, see definition-wanted-p above.

Also of interest are definition-id, definition-order, and definition-importance, which control the page anchors and order of appearance of definitions in an index.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Next: , Previous: , Up: Systems   [Contents][Index]

2.1 staple

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/staple/

Source Control

(:git "https://github.com/shinmera/staple.git")

Bug Tracker

https://github.com/Shinmera/staple/issues

License

zlib

Description

A tool to generate documentation about Lisp projects through an HTML template.

Version

2.0.0

Dependencies
Source

staple.asd (file)

Components

Next: , Previous: , Up: Systems   [Contents][Index]

2.2 staple-package-recording

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/staple/

Source Control

(:git "https://github.com/shinmera/staple.git")

Bug Tracker

https://github.com/Shinmera/staple/issues

License

zlib

Description

Collects information about packages being defined with an ASDF system.

Version

1.0.1

Source

staple-package-recording.asd (file)

Component

recording.lisp (file)


Previous: , Up: Systems   [Contents][Index]

2.3 staple-code-parser

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/staple/

Source Control

(:git "https://github.com/shinmera/staple.git")

Bug Tracker

https://github.com/Shinmera/staple/issues

License

zlib

Description

A code parser tool for documentation markup

Version

1.0.0

Dependencies
Source

staple-code-parser.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 staple.asd

Location

staple.asd

Systems

staple (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 staple-package-recording.asd

Location

staple-package-recording.asd

Systems

staple-package-recording (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 staple-code-parser.asd

Location

parser/staple-code-parser.asd

Systems

staple-code-parser (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 staple/package.lisp

Parent

staple (system)

Location

package.lisp

Packages

staple


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 staple/toolkit.lisp

Dependency

package.lisp (file)

Parent

staple (system)

Location

toolkit.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 staple/xref.lisp

Dependency

toolkit.lisp (file)

Parent

staple (system)

Location

xref.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.7 staple/transform.lisp

Dependency

xref.lisp (file)

Parent

staple (system)

Location

transform.lisp

Exported Definitions
Internal Definitions

*pathname-type-type-map* (special variable)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.8 staple/code-format.lisp

Dependency

transform.lisp (file)

Parent

staple (system)

Location

code-format.lisp

Exported Definitions
Internal Definitions

make-xref-link (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.9 staple/clip.lisp

Dependency

code-format.lisp (file)

Parent

staple (system)

Location

clip.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.10 staple/page.lisp

Dependency

clip.lisp (file)

Parent

staple (system)

Location

page.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.11 staple/project.lisp

Dependency

page.lisp (file)

Parent

staple (system)

Location

project.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.12 staple/inference.lisp

Dependency

project.lisp (file)

Parent

staple (system)

Location

inference.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.13 staple/documentation.lisp

Dependency

inference.lisp (file)

Parent

staple (system)

Location

documentation.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.14 staple-package-recording/recording.lisp

Parent

staple-package-recording (system)

Location

recording.lisp

Packages

staple-package-recording

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.15 staple-code-parser/package.lisp

Parent

staple-code-parser (system)

Location

parser/package.lisp

Packages

staple-code-parser


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.16 staple-code-parser/environment.lisp

Dependency

package.lisp (file)

Parent

staple-code-parser (system)

Location

parser/environment.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.17 staple-code-parser/walker.lisp

Dependency

environment.lisp (file)

Parent

staple-code-parser (system)

Location

parser/walker.lisp

Exported Definitions
Internal Definitions

client (class)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.18 staple-code-parser/special-forms.lisp

Dependency

walker.lisp (file)

Parent

staple-code-parser (system)

Location

parser/special-forms.lisp

Exported Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.19 staple-code-parser/standard-forms.lisp

Dependency

special-forms.lisp (file)

Parent

staple-code-parser (system)

Location

parser/standard-forms.lisp

Exported Definitions
Internal Definitions

perform-and-record-macro-expansion (function)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.20 staple-code-parser/to-definitions.lisp

Dependency

standard-forms.lisp (file)

Parent

staple-code-parser (system)

Location

parser/to-definitions.lisp

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.21 staple-code-parser/documentation.lisp

Dependency

to-definitions.lisp (file)

Parent

staple-code-parser (system)

Location

parser/documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 staple

Source

package.lisp (file)

Nickname

org.shirakumo.staple

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Packages   [Contents][Index]

4.2 staple-package-recording

Source

recording.lisp (file)

Nickname

org.shirakumo.staple.recording

Use List

common-lisp

Used By List

staple

Exported Definitions
Internal Definitions

Previous: , Up: Packages   [Contents][Index]

4.3 staple-code-parser

Source

package.lisp (file)

Nickname

org.shirakumo.staple.code-parser

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *default-template*

Pathname to the default Clip template used for simple pages.

See SIMPLE-PAGE

Package

staple

Source

inference.lisp (file)

Special Variable: *document-patterns*

A list of regular expression patterns that recognise document files.

An expression in this list should match the filename of a file that denotes a documentation body file.

Package

staple

Source

inference.lisp (file)

Special Variable: *image-patterns*

A list of regular expression patterns that recognise image files.

An expression in this list should match the filename of a file that denotes an image file.

Package

staple

Source

inference.lisp (file)

Special Variable: *load-prohibited-systems*

A list of ASDF:SYSTEM instances that should not be loaded for extensions.

This is a curated list of special systems that cause problems when being loaded as part of the LOAD-EXTENSION mechanism.

See LOAD-EXTENSION

Package

staple

Source

project.lisp (file)

Special Variable: *page*

Variable bound to the current page during generation.

See PAGE
See GENERATE

Package

staple

Source

page.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

Macro: define-definition-resolver TYPE (SOURCE &rest ARGS) &body BODY

Shorthand to define a find-definitions method and destructure the arguments of the parse result.

See FIND-DEFINITIONS

Package

staple-code-parser

Source

to-definitions.lisp (file)

Macro: define-source-compiler (TYPE &rest PATHNAME-TYPES) (INPUT) &body BODY

Defines a new source compiler variant.

This is a shorthand that sets the PATHNAME-TYPE->TYPE association and defines a new method on COMPILE-SOURCE to handle the conversion. Thus, the TYPE should be a keyword identifying the source type, and PATHNAME-TYPES should be an enumeration of known file types that are used for this kind of conversion. You may also leave this empty if you are defining a source type conversion that is not usually backed by explicit files.

See PATHNAME-TYPE->TYPE
See COMPILE-SOURCE

Package

staple

Source

transform.lisp (file)

Macro: define-sub-results TYPE ARGS &body BODY

Shorthand to define a sub-results method and destructure the arguments of the parse result.

See SUB-RESULTS

Package

staple-code-parser

Source

to-definitions.lisp (file)

Macro: define-walk-compound-form OPERATOR (CST-VAR &optional ENVIRONMENT-VAR) &body BODY

Shorthand to define a WALK-FORM method.

Adds local functions for WALK and WALK-IMPLICIT-PROGN that automatically pass the environment along so you don’t need to repeat it.

See WALK-FORM

Package

staple-code-parser

Source

walker.lisp (file)

Macro: define-walker-form FORM (CST-VAR &optional ENVIRONMENT-VAR SOURCE) &body BODY

Shorthand to define simple walker forms.

The FORM should be a destructuring description of the kind of form to walk. The return value of the BODY should be the list of additional arguments for the parse result. The type and source of the parse result are automatically added for you.

If you need control over the type or source, look at DEFINE-WALK-COMPOUND-FORM instead.

See DEFINE-WALK-COMPOUND-FORM

Package

staple-code-parser

Source

walker.lisp (file)

Macro: define-xref-resolver NAME ARGS &body BODY

Defines a new cross-reference resolver function.

The lambda-list should accept one required argument, the definition instance to find a cross-reference for.
The name can be either a name for the resolver, or a list of name and priority number.

See XREF-RESOLVER
See REMOVE-XREF-RESOLVER
See RESOLVE-XREF

Package

staple

Source

xref.lisp (file)

Macro: with-stream (STREAM DESIGNATOR &rest ARGS) &body BODY

Handles stream opening and closing, returning a useful value.

Essentially this calls ENSURE-STREAM on the designator and the args. Upon unwinding, CLOSE is called on the stream. On successful exit of the body, STREAM-VALUE is returned.

See ENSURE-STREAM
See STREAM-VALUE

Package

staple

Source

toolkit.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Functions

Function: absolute-source-location SOURCE-LOCATION

Translates the given Definitions source-location into an absolute one.

This will read the source file to determine the absolute row/line and col/char pointed at by the source-location. It returns another plist of the following keys:

:FILE — The same as in the input.
:OFFSET — The absolute file-position offset.
:ROW — The row/line of the offset.
:COL — The col/char of the offset.

Returns NIL if the file cannot be found, the source-location is NIL, or the file cannot be parsed.

See SKIP-TO-SOURCE-FORM

Package

staple

Source

toolkit.lisp (file)

Function: augment-environment! ENVIRONMENT NAMES VALUES

Augments the given environment with the new values for the given names.

Returns the modified environment.

See LOOKUP
See ENVIRONMENT

Package

staple-code-parser

Source

environment.lisp (file)

Function: augmented-environment PARENT NAMES VALUES &key CLASS

Returns a new environment with the changed values in place.

The old environment is a parent to the new one.

See AUGMENT-ENVIRONMENT!
See ENVIRONMENT

Package

staple-code-parser

Source

environment.lisp (file)

Function: ensure-package PACKAGE

Turns the given thing into a CL:PACKAGE.

If the thing cannot be coerced, an error is signalled.

Package

staple

Source

toolkit.lisp (file)

Function: ensure-package-definition PACKAGE

Turns the given thing into a DEFINITIONS:PACKAGE.

If the thing cannot be coerced, an error is signalled.

Package

staple

Source

toolkit.lisp (file)

Function: extract-language STRING

Attempts to find a valid two or three-letter language code in the string.

If a code can be found, two values are returned: the code itself and the list of names for the language the code points to.

See LANGUAGE-CODES:NAMES

Package

staple

Source

toolkit.lisp (file)

Function: find-definitions-for-identifier NAME &key PACKAGE TYPE

Attempts to find all definitions for the given symbol identifier.

The symbol is given in two parts – as its name, and package. The list of returned definitions may optionally be filtered by the given type argument.

If no package is given, the definitions are attempted to be found in the packages stored in *PAGE*, or the CL package.

See *PAGE*
See PACKAGES
See DEFINITIONS:FIND-DEFINITIONS

Package

staple

Source

xref.lisp (file)

Function: find-files DIRECTORY PATTERNS &key MAX-DEPTH

Find all files in the directory tree that match one of the patterns.

The patterns should be regular expressions suitable for CL-PPCRE. They are matched against the file-namestrings of the files in the directory tree.

See DO-DIRECTORY-TREE

Package

staple

Source

toolkit.lisp (file)

Function: load-extension SYSTEM

Loads the extension file of the system.

This ensures that all Staple extensions and customisations that the system might need are present and loaded when the documentation is generated.

It proceeds as follows:
1. The argument is coerced to an ASDF:SYSTEM
2. If the system was already involved in a LOAD-EXTENSION call within this call tree, NIL is returned immediately.
3. Otherwise the system is loaded via ASDF:LOAD-SYSTEM, with warnings and standard-output muffled.
4. For each dependency registered for the system, LOAD-EXTENSION is called again to ensure dependant extensions are loaded first. 5. The EXTENSION-FILE, if present, is LOADed.
6. The system is returned.

See ASDF:LOAD-SYSTEM
See CL:LOAD

Package

staple

Source

project.lisp (file)

Function: load-system-quietly SYSTEM

Loads the given ASDF:SYSTEM quietly.

This muffles warnings and suppresses *standard-output*.

See ASDF:LOAD-SYSTEM

Package

staple

Source

toolkit.lisp (file)

Function: markup-code-block NODE

Transforms the node’s content treating it as a code block.

Only the textual contents of the node are inspected, any other kinds of tag that may be a child to the block will be removed by this.

All definitions that are recognised in this that have a result for XREF will be marked up by an <a> tag with the class "xref".

Note that the value of *PACKAGE* matters for the parsing of the code blocks, as a full READ and walk is performed on it to find symbols and their usage in the code snippet.

Note also that if invalid code or non-lisp code is encountered an error may be signalled by the reader.

See XREF
See STAPLE-CODE-PARSER:PARSE
See STAPLE-CODE-PARSER:PARSE-RESULT->DEFINITION-LIST

Package

staple

Source

code-format.lisp (file)

Function: markup-code-reference NODE

Transforms the node’s content treating it as a definition reference.

Only the textual contents of the node are inspected, any other kinds of tag that may be a child to the block will be removed by this.

This simply uses XREF on the textual content and if a result is returned, inserts an <a> tag with the class "xref" to provide the link.

See XREF

Package

staple

Source

code-format.lisp (file)

Function: markup-code-snippets HTML

Attempts to mark up the code snippets in the given HTML text.

This looks for <code> tags within the given HTML and will try to automatically insert xref links. It performs transformations as follows: Each <code> tag that is direct child to a <pre> tag is transformed using MARKUP-CODE-BLOCK, with the intention that the <code> element contains full code snippets. <code> tags without a <pre> parent will be transformed using MARKUP-CODE-REFERENCE, with the idea that these will only contain single symbol names that represent direct references to definitions.

If an error occurs during the markup of a tag, a SKIP-TAG restart will be available to allow skipping that particular tag.

The return value of this function is a PLUMP:NODE if the argument is also a PLUMP:NODE, and a STRING if the argument is either a STRING or a PATHNAME.

See MARKUP-CODE-BLOCK
See MARKUP-CODE-REFERENCE

Package

staple

Source

code-format.lisp (file)

Function: markup-code-snippets-ignoring-errors HTML

Marks up the code snippets ignoring parts that fail during markup.

See MARKUP-CODE-SNIPPETS

Package

staple

Source

code-format.lisp (file)

Function: maybe-lang-docstring DEFINITION LANGUAGE

Attempts to find a docstring for the given definition in the given language.

If the multilang-documentation system is loaded, then this consults MULTILANG-DOCUMENTATION:DOCUMENTATION using the DEFINITIONS:OBJECT
and T as arguments, and alternatively the DEFINITIONS:DESIGNATOR and DEFINITIONS:TYPE. If either the system is not loaded, or it fails to return anything for both queries, it falls back to just returning the DEFINITIONS:DOCUMENTATION.

See MULTILANG-DOCUMENTATION:DOCUMENTATION
See DEFINITIONS:DOCUMENTATION

Package

staple

Source

toolkit.lisp (file)

Function: parse-result->definition-list RESULT

Turn the parse-result into a list of definitions and source locations.

For instance:
((:CALL (0 . 10) (:VARIABLE (1 . 5) NULL) (:LITERAL (6 . 9) NIL))) => ((#<DEFINITIONS:FUNCTION NULL> (1 . 5)))

This uses FIND-DEFINITIONS to find suitable definitions for a parse result, as well as SUB-RESULTS to traverse the parse result tree.

See FIND-DEFINITIONS
See SUB-RESULTS

Package

staple-code-parser

Source

to-definitions.lisp (file)

Function: pathname-type->type TYPE &optional ERRORP

Returns a keyword for the given pathname-type, if it is known.

If ERRORP is non-NIL and no type can be found, an error is signalled.

When used as a setf-place, the value should be a list of pathname-type strings that should be associated with the given type. Note that this is overriding, meaning that previous associations to the given type are removed.

See COMPILE-SOURCE
See DEFINE-SOURCE-COMPILER

Package

staple

Source

transform.lisp (file)

Writer

(setf pathname-type->type) (function)

Function: (setf pathname-type->type) TYPES TYPE
Package

staple

Source

transform.lisp (file)

Reader

pathname-type->type (function)

Function: preferred-definition DEFINITIONS

Returns the list sorted such that the most important, or preferred definitions, come first.

See DEFINITION-IMPORTANCE

Package

staple

Source

toolkit.lisp (file)

Function: purify-arglist ARGLIST

Purifies the given arguments list / lambda-list.

This function is useful for presenting the user-interface part of a lambda-list. Thus it trims all extraneous information that the user of a function or macro does not need to know about.

Specifically this does the following, depending on the current lambda-list-keyword in the arglist:

REQUIRED — The argument is purified recursively if it is a list, and retained verbatim otherwise. &OPTIONAL — Only the variable name is retained.
&KEY — Only the variable’s keyword-name is retained. &WHOLE — The argument is removed.
&ENVIRONMENT — The argument is removed.
&AUX — The argument is removed.

Package

staple

Source

toolkit.lisp (file)

Function: read-file PATH

Reads the given file to a string and returns it.

Package

staple

Source

toolkit.lisp (file)

Function: remove-xref-resolver NAME

Removes the cross-reference resolver of the given name.

See XREF-RESOLVER

Package

staple

Source

xref.lisp (file)

Function: resolve-xref DEFINITION

Calls each cross-reference resolver with the definition until one returns a valid reference.

See XREF-RESOLVER
See DEFINE-XREF-RESOLVER

Package

staple

Source

xref.lisp (file)

Function: sort-definitions DEFINITIONS

Sorts the list of definitions into a natural order.

Definitions of different type are sorted by DEFINITION-ORDER. Definitions of the same type are sorted by STRING< using DEFINITIONS:NAME as the key.

The sort is performed stably.

See DEFINITION-ORDER

Package

staple

Source

toolkit.lisp (file)

Function: tie-to-source SOURCE DEFS

Turns each def into a list of source and def.

Package

staple-code-parser

Source

to-definitions.lisp (file)

Function: url-encode THING &optional EXTERNAL-FORMAT

Performs percent, or url-encoding of the string.

Package

staple

Source

toolkit.lisp (file)

Function: walk-bindings BINDINGS ENVIRONMENT

Walk the set of LET bindings in the environment.

Returns a list of cons cells where the CAR is the variable definition of the binding and the cdr is the parse result of the value.

See WALK

Package

staple-code-parser

Source

walker.lisp (file)

Function: walk-body CST ENVIRONMENT

Same as WALK-IMPLICIT-PROGN, but filters out declarations from the cst.

See WALK-IMPLICIT-PROGN

Package

staple-code-parser

Source

walker.lisp (file)

Function: walk-implicit-progn CST ENVIRONMENT

Walks the CST as a list of forms and returns the list of parse-results for each form.

See WALK

Package

staple-code-parser

Source

walker.lisp (file)

Function: walk-lambda-like CST ENVIRONMENT &optional LAMBDA-LIST-PARSER

Walk a lambda-like structure.

Parses the lambda-list and body forms appropriately and returns a parse-result for a lambda. The given parser is used to process the lambda-list.

See WALK-IMPLICIT-PROGN

Package

staple-code-parser

Source

walker.lisp (file)

Function: xref-resolver NAME

Accessor to the cross-reference resolver of the given name.

The resolver should be a function of one argument, a definition instance. It should return either NIL, or a URL string.

Default xref-resolvers for the current page that’s being generated, and the common-lisp package, are defined.

It is useful to define addition resolvers if you have some kind of source of documentation that you would like to be able to link to.

Resolvers allow an optional priority number to control in which order they’re invoked. When reading the resolver, the priority is returned as the second value.

See REMOVE-XREF-RESOLVER
See DEFINE-XREF-RESOLVER
See RESOLVE-XREF

Package

staple

Source

xref.lisp (file)

Writer

(setf xref-resolver) (function)

Function: (setf xref-resolver) FUNCTION NAME &optional PRIORITY
Package

staple

Source

xref.lisp (file)

Reader

xref-resolver (function)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Generic functions

Generic Function: compile-source SOURCE TYPE

Compiles the source to a usable format, interpreting it as the given type.

The following argument combinations have specifically defined behaviour:

Source: Type: Explanation: ——————————————————————– PATHNAME (EQL T) — COMPILE-SOURCE is called again using the pathname’s pathname-type as type argument. PATHNAME T — COMPILE-SOURCE is called again using the contents of the file in string form as source argument.
T STRING — COMPILE-SOURCE is called again using the type returned by PATHNAME-TYPE->TYPE as the type argument.

You should add methods to this function specialising on a particular source type to handle the translation appropriately.

See PATHNAME-TYPE->TYPE
See DEFINE-SOURCE-COMPILER

Package

staple

Source

transform.lisp (file)

Methods
Method: compile-source (DOCUMENT pathname) (PAGE simple-page)
Source

inference.lisp (file)

Method: compile-source (INPUT string) (TYPE (eql text))
Method: compile-source (INPUT string) (TYPE (eql html))
Method: compile-source (SOURCE pathname) (TYPE (eql t))
Method: compile-source (SOURCE pathname) TYPE
Method: compile-source SOURCE (TYPE string)
Generic Function: definition-id DEFINITION

Returns a string representing a unique ID for the given definition.

This is useful for creating links and anchors for definitions in a document.

Package

staple

Source

toolkit.lisp (file)

Methods
Method: definition-id (DEFINITION global-definition)
Method: definition-id (DEFINITION package)
Generic Function: definition-importance DEFINITION

Returns a number for the given definition, used to determine if one definition should receive precedence over another.

By default, the following sorting is applied:

DEFINITIONS:CALLABLE 30
DEFINITIONS:TYPE 20
DEFINITIONS:VARIABLE 10
DEFINITIONS:DEFINITION 0
DEFINITIONS:METHOD -10

See PREFERRED-DEFINITION

Package

staple

Source

toolkit.lisp (file)

Methods
Method: definition-importance (_ callable)
Method: definition-importance (_ type)
Method: definition-importance (_ variable)
Method: definition-importance (_ definition)
Method: definition-importance (_ method)
Generic Function: definition-order DEFINITION

Returns a number for the given definition, used for sorting.

The higher the number, the earlier the definition should appear in the sorting.

By default, the following sorting is applied:

DEFINITIONS:PACKAGE 200
DEFINITIONS:CONSTANT 190
DEFINITIONS:SYMBOL-MACRO 180
DEFINITIONS:SPECIAL-VARIABLE 170
DEFINITIONS:VARIABLE 160
DEFINITIONS:CLASS 150
DEFINITIONS:CONDITION 140
DEFINITIONS:STRUCTURE 130
DEFINITIONS:TYPE-DEFINITION 120
DEFINITIONS:TYPE 110
DEFINITIONS:ACCESSOR 100
DEFINITIONS:FUNCTION 90
DEFINITIONS:GENERIC-FUNCTION 80
DEFINITIONS:METHOD 70
DEFINITIONS:COMPILER-MACRO 60
DEFINITIONS:MACRO 50
DEFINITIONS:SETF-EXPANDER 40
DEFINITIONS:CALLABLE 30 DEFINITIONS:METHOD-COMBINATION 20
DEFINITIONS:GLOBAL-DEFINITION 10
DEFINITIONS:DEFINITION 0

See SORT-DEFINITIONS

Package

staple

Source

toolkit.lisp (file)

Methods
Method: definition-order (_ package)
Method: definition-order (_ constant)
Method: definition-order (_ symbol-macro)
Method: definition-order (_ special-variable)
Method: definition-order (_ variable)
Method: definition-order (_ class)
Method: definition-order (_ condition)
Method: definition-order (_ structure)
Method: definition-order (_ type-definition)
Method: definition-order (_ type)
Method: definition-order (_ function)
Method: definition-order (_ generic-function)
Method: definition-order (_ method)
Method: definition-order (_ compiler-macro)
Method: definition-order (_ macro)
Method: definition-order (_ setf-expander)
Method: definition-order (_ callable)
Method: definition-order (_ method-combination)
Method: definition-order (_ global-definition)
Method: definition-order (_ definition)
Generic Function: definition-wanted-p DEFINITION PAGE

This function should return T if the definition should be included in the page’s definitions index.

See DEFINITIONS-INDEX-PAGE

Package

staple

Source

page.lisp (file)

Methods
Method: definition-wanted-p (DEFINITION declaration) (PROJECT simple-page)
Source

inference.lisp (file)

Method: definition-wanted-p (DEFINITION compiler-macro) (PROJECT simple-page)
Source

inference.lisp (file)

Method: definition-wanted-p (DEFINITION package) (PROJECT simple-page)
Source

inference.lisp (file)

Method: definition-wanted-p (DEFINITION method) (PROJECT simple-page)
Source

inference.lisp (file)

Method: definition-wanted-p (DEFINITION definition) (PROJECT simple-page)
Source

inference.lisp (file)

Method: definition-wanted-p (DEFINITION definition) (PAGE definitions-index-page)
Generic Function: definitions PAGE PACKAGE

This function should return a list of applicable definitions for the given page and package.

By default this will simply compute /all/ definitions in the package
and only keeping wanted ones by DEFINITION-WANTED-P.

The returned list of definitions is always sorted in the natural order
as described by SORT-DEFINITIONS.

See DEFINITION-WANTED-P
See SORT-DEFINITIONS

Package

staple

Source

page.lisp (file)

Methods
Method: definitions PAGE PACKAGE around
Method: definitions (PAGE definitions-index-page) PACKAGE
Generic Function: document OBJECT

Accessor for the document the simple-page will include in its body.

This should be a pathname to a file that can be parsed by COMPILE-SOURCE.

See SIMPLE-PAGE
See COMPILE-SOURCE

Package

staple

Writer

(setf document) (generic function)

Methods
Method: document (SIMPLE-PAGE simple-page)

automatically generated reader method

Source

inference.lisp (file)

Generic Function: (setf document) NEW-VALUE OBJECT
Package

staple

Reader

document (generic function)

Methods
Method: (setf document) NEW-VALUE (SIMPLE-PAGE simple-page)

automatically generated writer method

Source

inference.lisp (file)

Generic Function: document-package OBJECT
Generic Function: (setf document-package) NEW-VALUE OBJECT
Package

staple

Methods
Method: document-package (SIMPLE-PAGE simple-page)

automatically generated reader method

Source

inference.lisp (file)

Method: (setf document-package) NEW-VALUE (SIMPLE-PAGE simple-page)

automatically generated writer method

Source

inference.lisp (file)

Generic Function: documents SYSTEM

Returns a list of pathnames to documents relevant for the given system.

By default this will attempt a heuristic by searching for files that can be parsed by PATHNAME-TYPE->TYPE, and match one of the *DOCUMENT-PATTERNS* within the system’s source directory.

You may add a method specialising on a particular system to change which documents are used for an inferred project.

See PATHNAME-TYPE->TYPE
See *DOCUMENT-PATTERNS*
See INFER-PROJECT

Package

staple

Methods
Method: documents (SYSTEM system)
Source

inference.lisp (file)

Generic Function: extension-file SYSTEM

Returns the Staple extension source file for the ASDF:SYSTEM.

By default this is a file called "staple.ext.lisp" within the system’s source directory.

This function may return NIL to indicate that the system has no extension file.

See ASDF:SYSTEM-SOURCE-DIRECTORY

Package

staple

Source

project.lisp (file)

Methods
Method: extension-file SYSTEM
Generic Function: filename PAGE

Returns a suitable pathname making up the filename of the page.

By default for simple-pages this is the name "index" followed by the language code of the page, if the language is not :en or :eng, and the type "html".

See SIMPLE-PAGE

Package

staple

Methods
Method: filename (PAGE simple-page)
Source

inference.lisp (file)

Generic Function: find-definitions TYPE SOURCE ARGS

Returns any matching definitions for the given parse result.

All parse results have the structure of (TYPE SOURCE . ARGS). Thus you can simply destructure it and pass the arguments to this function to retrieve its definitions.

See DEFINE-DEFINITION-RESOLVER

Package

staple-code-parser

Methods
Method: find-definitions (TYPE1 (eql function)) SOURCE ARGS0
Source

to-definitions.lisp (file)

Method: find-definitions (TYPE1 (eql type)) SOURCE ARGS0
Source

to-definitions.lisp (file)

Method: find-definitions (TYPE1 (eql variable)) SOURCE ARGS0
Source

to-definitions.lisp (file)

Method: find-definitions (TYPE1 (eql macro)) SOURCE ARGS0
Source

to-definitions.lisp (file)

Method: find-definitions (TYPE1 (eql call)) SOURCE ARGS0
Source

to-definitions.lisp (file)

Method: find-definitions TYPE SOURCE ARGS
Source

to-definitions.lisp (file)

Generic Function: find-project PROJECT &key &allow-other-keys

Find and return the project for the given project designator.

Typically the project designator will be an ASDF:SYSTEM.

If you want to define a custom project for your system, you should add a method specialising on your system instance to this function and have it return the appropriately filled out project instance.

By default this will first call LOAD-EXTENSION on the system, and will then call itself again if it can now find new methods specialising either on the system’s instance or its name as a keyword. Otherwise it simply returns NIL.

See LOAD-EXTENSION

Package

staple

Source

project.lisp (file)

Methods
Method: find-project (SYSTEM system) &rest ARGS
Method: find-project NAME &rest ARGS
Generic Function: format-documentation DEFINITION PAGE

Formats the definition according to the page’s preferences.

This function should be called to retrieve fully formatted HTML to use as the documentation for a given definition on a page.

By default this will call MAYBE-LANG-DOCSTRING on the definition and the page’s language to retrieve the raw docstring, and then call FORMAT-DOCUMENTATION again with the docstring and the page.

If a string is passed, it will by default parse it in the "See" style wherein each Line beginning with "See" is treated as a line indicating a source cross-reference. The rest of the line is interpreted as a designator for another definition and is turned into an xref link if possible.

If you would prefer other documentation styles, you should add a method specialising on a custom page type, then use that page type in your project.

See DEFINITIONS-INDEX-PAGE
See MAYBE-LANG-DOCSTRING
See XREF

Package

staple

Source

page.lisp (file)

Methods
Method: format-documentation (DOCSTRING string) (PAGE definitions-index-page)
Method: format-documentation (NULL null) (PAGE definitions-index-page)
Method: format-documentation (DEFINITION definition) (PAGE definitions-index-page)
Generic Function: generate PAGE &key IF-EXISTS COMPACT &allow-other-keys

Generate the outputs of the given object.

The value returned by this function should be some kind of identifier of the outputs that were generated by the call to this function. In the case of a page, this will be the output file or result produced by the page. In the case of a project, this will typically be the project itself, and a list of the results from the pages it generated.

If this function is called with something that isn’t a project or page then the argument is treated as a potential ASDF:SYSTEM and is coerced to one by ASDF:FIND-SYSTEM. It will then try to find a project for the system by first consulting FIND-PROJECT, and then INFER-PROJECT. If both FIND-PROJECT and INFER-PROJECT fail, an error is signalled. Otherwise, GENERATE is called on the newly retrieved project.

See PAGE
See PROJECT
See *PAGE*
See FIND-PROJECT
See INFER-PROJECT

Package

staple

Source

page.lisp (file)

Methods
Method: generate PROJECT &rest ARGS
Source

project.lisp (file)

Method: generate (PROJECT project) &rest ARGS
Source

project.lisp (file)

Method: generate (PAGE templated-page) &key IF-EXISTS COMPACT
Method: generate (PAGE compiled-page) &key IF-EXISTS COMPACT
Method: generate (PAGE static-page) &key IF-EXISTS
Method: generate (PAGE input-page) &key before
Method: generate (PAGE page) &key before
Method: generate (PAGE page) &key around
Generic Function: images OBJECT

Returns a list of pathnames to images relevant for the given system.

By default this will attempt a heuristic by searching for files that match one of the *IMAGE-PATTERNS* within the system’s source directory.

You may add a method specialising on a particular system to change which images are used for an inferred project.

See *IMAGE-PATTERNS*
See INFER-PROJECT

Package

staple

Writer

(setf images) (generic function)

Methods
Method: images (SYSTEM system)
Source

inference.lisp (file)

Method: images (SIMPLE-PAGE simple-page)

automatically generated reader method

Source

inference.lisp (file)

Generic Function: (setf images) NEW-VALUE OBJECT
Package

staple

Reader

images (generic function)

Methods
Method: (setf images) NEW-VALUE (SIMPLE-PAGE simple-page)

automatically generated writer method

Source

inference.lisp (file)

Generic Function: infer-project PROJECT &key OUTPUT-DIRECTORY IMAGES DOCUMENTS PAGE-TYPE TEMPLATE PACKAGES SUBSYSTEMS &allow-other-keys

Attempts to infer a project suitable for the given ASDF:SYSTEM.

By default this consults a variety of functions and attempts to build a suitable SIMPLE-PROJECT instance that should document the system. If you want to control how the documentation is generated, you may either specialise the functions INFER-PROJECT uses, or construct your own project entirely by specialising on FIND-PROJECT instead.

INFER-PROJECT proceeds as follows:
1. If no :OUTPUT-DIRECTORY is given, it is found via OUTPUT-DIRECTORY. 2. If no :DOCUMENTS are given, they are found via DOCUMENTS.
3. If no :IMAGES are given, they are found via IMAGES.
4. If no :PAGE-TYPE is given, it is found via PAGE-TYPE.
5. If no :TEMPLATE is given, it is found via TEMPLATE.
6. If no :PACKAGES are given, they are found via PACKAGES.
7. If no :SUBSYSTEMS are given, they are found via SUBSYSTEMS.
8. If no output directory is known, a recoverable error of type NO-KNOWN-OUTPUT-DIRECTORY is signalled. You may use the USE-VALUE restart to provide a new output directory.
9. Each entry in the subsystems list may either be an ASDF system, or a list of an ASDF system and the same keyword arguments as above. The properties are inferred as follows:
9.1 If no :OUTPUT-DIRECTORY is given, a subdirectory by the name of the subsystem within the primary system’s output directory is used. 9.2 If no :DOCUMENTS are given, they are found via DOCUMENTS.
9.3 If no :IMAGES are given, they are found via IMAGES, or the primary system’s images are used.
9.4 If no :PAGE-TYPE is given, it is found via PAGE-TYPE, or the primary system’s page-type is used.
9.5 If no :TEMPLATE is given, it is found via TEMPLATE, or the primary system’s template is used.
9.6 If no :PACKAGES are given, they are found via PACKAGES.
9.7 If the subsystem’s source directory is the same as the primary system’s, and the list of documents are the same, the subsystem’s document list is emptied to avoid the subsystem using documents intended for the primary system.
9.8 All documents for the subsystem are removed from the documents list for the primary system.
9.9 For each document for the subsystem, a page of page-type is constructed, passing the template as :INPUT, the output directory as :OUTPUT, the system as :SYSTEM, the document as :DOCUMENT, the list of images as :IMAGES, and the list of packages as :PACKAGES. 9.10. If the documents list is empty, a single page of page-type is constructed with the same arguments as before, except the :DOCUMENT being NIL.
9.11. For each pathname in the images list a page of type STATIC-PAGE is constructed that will copy the image file into the OUTPUT-DIRECTORY while preserving pathname name and type.
10. For each pathname in the documents list a page of page-type is constructed, passing the template as :INPUT, the output directory as :OUTPUT, the system as :SYSTEM, the document’s pathname as :DOCUMENT, the list of images as :IMAGES, and the list of packages as :PACKAGES.
11. If the documents list is empty, a single page of page-type is constructed with the same arguments as before, except the :DOCUMENT being NIL.
12. For each pathname in the images list a page of type STATIC-PAGE is constructed that will copy the image file into the OUTPUT-DIRECTORY while preserving pathname name and type.
13. A SIMPLE-PROJECT instance is constructed and returned with those pages as the :PAGES argument.

See OUTPUT-DIRECTORY
See DOCUMENTS
See IMAGES
See PACKAGES
See PAGE-TYPE
See TEMPLATE
See SUBSYSTEMS
See *DEFAULT-TEMPLATE*
See NO-KNOWN-OUTPUT-DIRECTORY
See CL:USE-VALUE
See STATIC-PAGE
See SIMPLE-PROJECT

Package

staple

Source

project.lisp (file)

Methods
Method: infer-project (SYSTEM system) &key OUTPUT-DIRECTORY IMAGES DOCUMENTS PAGE-TYPE TEMPLATE PACKAGES SUBSYSTEMS
Source

inference.lisp (file)

Method: infer-project NAME &rest ARGS
Generic Function: input OBJECT

Accessor to the input of the page.

The input should be a STREAM-DESIGNATOR, meaning that it can be resolved to a stream via ENSURE-STREAM. Typically it will be a pathname pointing to the file from which the page’s input should be ready.

See INPUT-PAGE

Package

staple

Writer

(setf input) (generic function)

Methods
Method: input (INPUT-PAGE input-page)

automatically generated reader method

Source

page.lisp (file)

Generic Function: (setf input) NEW-VALUE OBJECT
Package

staple

Reader

input (generic function)

Methods
Method: (setf input) NEW-VALUE (INPUT-PAGE input-page)

automatically generated writer method

Source

page.lisp (file)

Generic Function: language OBJECT

Accessor to the language of a page.

The language should be a two or three-letter short-code that uniquely identifies the language as a keyword. See the ISO-639 language codes for all available options.

See PAGE

Package

staple

Writer

(setf language) (generic function)

Methods
Method: language (PAGE page)

automatically generated reader method

Source

page.lisp (file)

Generic Function: (setf language) NEW-VALUE OBJECT
Package

staple

Reader

language (generic function)

Methods
Method: (setf language) NEW-VALUE (PAGE page)

automatically generated writer method

Source

page.lisp (file)

Generic Function: lookup NAME NAMESPACE ENVIRONMENT

Looks up the name in the namespace of the environment.

This will traverse the environment chain upwards until no parent can be found anymore in case the current environment’s namespace does not contain the value.

When used as a setf place the value is always stored in the given environment’s namespace.

See NAMESPACE
See ENVIRONMENT

Package

staple-code-parser

Writer

(setf lookup) (generic function)

Methods
Method: lookup NAME NAMESPACE (ENVIRONMENT environment)
Source

environment.lisp (file)

Generic Function: (setf lookup) VALUE NAME NAMESPACE ENVIRONMENT
Package

staple-code-parser

Reader

lookup (generic function)

Methods
Method: (setf lookup) VALUE NAME NAMESPACE (ENVIRONMENT environment)
Source

environment.lisp (file)

Generic Function: output OBJECT

Accessor to the output of a page.

The output should be a STREAM-DESIGNATOR, meaning that it can be resolved to a stream via ENSURE-STREAM. Typically it will be a pathname pointing to the file into which the page’s contents should be stored.

See PAGE

Package

staple

Writer

(setf output) (generic function)

Methods
Method: output (PROJECT project)

automatically generated reader method

Source

project.lisp (file)

Method: output (PAGE page)

automatically generated reader method

Source

page.lisp (file)

Generic Function: (setf output) NEW-VALUE OBJECT
Package

staple

Reader

output (generic function)

Methods
Method: (setf output) NEW-VALUE (PROJECT project)

automatically generated writer method

Source

project.lisp (file)

Method: (setf output) NEW-VALUE (PAGE page)

automatically generated writer method

Source

page.lisp (file)

Generic Function: output-directory SYSTEM

Returns the output directory to which documentation for the given system should be output.

By default this returns the "doc/" subdirectory within the system’s
source directory.

You may add a method specialising on a particular system to change
where the resulting content is stored for an inferred project.

See ASDF:SYSTEM-SOURCE-DIRECTORY
See INFER-PROJECT

Package

staple

Methods
Method: output-directory (SYSTEM system)
Source

inference.lisp (file)

Generic Function: package-system PACKAGE

Returns the system associated with the package.

This is typically the system that defines the package, if the package was recorded through Staple’s package recording mechanism. If this automated detection is not smart enough, you may supply methods on this function to specify the correct system for a package.

See CL:PACKAGE

Package

staple-package-recording

Methods
Method: package-system THING
Source

recording.lisp (file)

Method: package-system (PACKAGE package)
Source

recording.lisp (file)

Generic Function: packages SYSTEM

Accessor to the list of packages associated with the instance.

This will always return a list of PACKAGE instances, not package designators. If passed an ASDF:SYSTEM instance, it will return the list of packages that were either recorded explicitly for the system during loading, or were either inferred or explicitly set for the system. If passed a DEFINITIONS-INDEX-PAGE instance, it will return the list of packages that should be put into the index. For anything else it will try to coerce the argument to an ASDF:SYSTEM via ASDF:FIND-SYSTEM.

See ASDF:SYSTEM
See DEFINITIONS-INDEX-PAGE

Package

staple-package-recording

Writer

(setf packages) (generic function)

Methods
Method: packages (DEFINITIONS-INDEX-PAGE definitions-index-page)

automatically generated reader method

Source

page.lisp (file)

Method: packages (SYSTEM symbol)
Source

recording.lisp (file)

Method: packages (SYSTEM system)
Source

recording.lisp (file)

Generic Function: (setf packages) PACKAGES SYSTEM
Package

staple-package-recording

Reader

packages (generic function)

Methods
Method: (setf packages) NEW-VALUE (DEFINITIONS-INDEX-PAGE definitions-index-page)

automatically generated writer method

Source

page.lisp (file)

Method: (setf packages) PACKAGES (SYSTEM system)
Source

recording.lisp (file)

Method: (setf packages) PACKAGES (PAGE definitions-index-page) around
Source

page.lisp (file)

Method: (setf packages) PACKAGES SYSTEM-ISH
Source

recording.lisp (file)

Generic Function: page-type SYSTEM

Returns the type of the page that should be used for the given system’s inferred project.

By default this returns ’SIMPLE-PAGE

You may add a method specialising on a particular system to change
which page-type is used for an inferred project.

See SIMPLE-PAGE
See INFER-PROJECT

Package

staple

Methods
Method: page-type (SYSTEM system)
Source

inference.lisp (file)

Generic Function: pages PROJECT

Returns the list of pages that the project generates.

See PAGE
See PROJECT

Package

staple

Source

project.lisp (file)

Writer

(setf pages) (generic function)

Methods
Method: pages (SIMPLE-PROJECT simple-project)

automatically generated reader method

Generic Function: (setf pages) NEW-VALUE OBJECT
Package

staple

Reader

pages (generic function)

Methods
Method: (setf pages) NEW-VALUE (SIMPLE-PROJECT simple-project)

automatically generated writer method

Source

project.lisp (file)

Generic Function: parse INPUT

Parses the input and returns a list of parse results, each for one toplevel.

First uses READ-TOPLEVEL to read all toplevel forms, then uses WALK
for each of the read CSTs to turn them into parse results.

See READ-TOPLEVEL
See WALK

Package

staple-code-parser

Methods
Method: parse INPUT
Source

walker.lisp (file)

Generic Function: placeholder-intern OBJECT

Returns whether the symbol being read is an internal or external symbol.

See PLACEHOLDER

Package

staple-code-parser

Methods
Method: placeholder-intern (PLACEHOLDER placeholder)

automatically generated reader method

Source

walker.lisp (file)

Generic Function: placeholder-name OBJECT

Returns the symbol-name of the symbol this is a placeholder for.

See PLACEHOLDER

Package

staple-code-parser

Methods
Method: placeholder-name (PLACEHOLDER placeholder)

automatically generated reader method

Source

walker.lisp (file)

Generic Function: placeholder-package OBJECT

Returns the symbol-package name of the symbol this is a placeholder for.

See PLACEHOLDER

Package

staple-code-parser

Methods
Method: placeholder-package (PLACEHOLDER placeholder)

automatically generated reader method

Source

walker.lisp (file)

Generic Function: project OBJECT

Accessor to the page’s project.

See PAGE

Package

staple

Writer

(setf project) (generic function)

Methods
Method: project (PAGE page)

automatically generated reader method

Source

page.lisp (file)

Generic Function: (setf project) NEW-VALUE OBJECT
Package

staple

Reader

project (generic function)

Methods
Method: (setf project) NEW-VALUE (PAGE page)

automatically generated writer method

Source

page.lisp (file)

Generic Function: read-toplevel INPUT

Reads the toplevel of an input.

The INPUT may be a string, pathname, or a stream (by default). Returns a list of CSTs representing all toplevel forms that were read.

Package

staple-code-parser

Methods
Method: read-toplevel (INPUT stream)
Source

walker.lisp (file)

Method: read-toplevel (INPUT pathname)
Source

walker.lisp (file)

Method: read-toplevel (INPUT string)
Source

walker.lisp (file)

Generic Function: relative-path TO FROM

Return the relative path from the second argument to the first.

By default the following cases are handled:

To: From: Explanation: ——————————————————————– PATHNAME PATHNAME — Computes the relative pathname.
PAGE T — Delegates using OUTPUT.
T PAGE — Delegates using OUTPUT.
PROJECT T — Delegates using OUTPUT.
T PROJECT — Delegates using OUTPUT.
PAGE (EQL T) — Delegates using PROJECT.

See PATHNAME-UTILS:RELATIVE-PATH
See OUTPUT
See PROJECT
See PAGE

Package

staple

Source

toolkit.lisp (file)

Methods
Method: relative-path TO (FROM project)
Source

project.lisp (file)

Method: relative-path (TO project) FROM
Source

project.lisp (file)

Method: relative-path TO (FROM page)
Source

page.lisp (file)

Method: relative-path (TO page) FROM
Source

page.lisp (file)

Method: relative-path (TO page) (PROJECT (eql t))
Source

page.lisp (file)

Method: relative-path (TO pathname) (FROM pathname)

Resolve the link to a source file to a URI.

The source should be either a definition or a source spec. In case of a definition, the function is called again with the source spec as computed by ABSOLUTE-SOURCE-LOCATION on DEFINITIONS:SOURCE-LOCATION. A source spec should be a plist of the following possible keys:

:FILE — An absolute pathname to the source file. Required. :ROW — An optional row/line to which to point within the file. :COL — An optional col/char to which to point within the line.

By default this will try a "best effort" resolution, meaning relative links if the file’s path is a subpath of the page’s output. Otherwise it will fall back to a "file://" link.

See DEFINITIONS:SOURCE-LOCATION
See ABSOLUTE-SOURCE-LOCATION

Package

staple

Source

page.lisp (file)

Methods
Generic Function: sub-results TYPE ARGS

Returns all parse results that are sub-results of this parse result.

All parse results have the structure of (TYPE SOURCE . ARGS). Thus you can simply destructure it and pass the arguments to this function to retrieve its definitions.

See DEFINE-SUB-RESULTS

Package

staple-code-parser

Methods
Method: sub-results (TYPE1 (eql call)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql macro)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql unwind-protect)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql throw)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql the)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql tagbody)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql symbol-macrolet)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql setq)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql return-from)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql progv)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql progn)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql multiple-value-prog1)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql multiple-value-call)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql macrolet)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql locally)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql load-time-value)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql let*)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql let)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql labels)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql if)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql go)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql named-lambda)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql lambda)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql flet)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql eval-when)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql catch)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results (TYPE1 (eql block)) ARGS0
Source

to-definitions.lisp (file)

Method: sub-results TYPE ARGS
Source

to-definitions.lisp (file)

Generic Function: subsystems SYSTEM

Returns a list of systems that are related to the given system.

By default this will find all ASDF systems whose name contains the given system’s name as a prefix.

You may add a method specialising on a particular system to change which subsystems are used for an inferred project.

See INFER-PROJECT

Package

staple

Methods
Method: subsystems (SYSTEM system)
Source

inference.lisp (file)

Generic Function: system OBJECT

Accessor to the system the object is associated with.

See SYSTEM-PAGE
See NO-KNOWN-OUTPUT-DIRECTORY

Package

staple

Writer

(setf system) (generic function)

Methods
Method: system (CONDITION no-known-output-directory)
Source

inference.lisp (file)

Method: system (SYSTEM-PAGE system-page)

automatically generated reader method

Source

page.lisp (file)

Generic Function: (setf system) NEW-VALUE OBJECT
Package

staple

Reader

system (generic function)

Methods
Method: (setf system) NEW-VALUE (SYSTEM-PAGE system-page)

automatically generated writer method

Source

page.lisp (file)

Method: (setf system) SYSTEM (PAGE system-page) around
Source

page.lisp (file)

Generic Function: template SYSTEM

Returns the pathname to a Clip template suitable for the given system.

You may add a method specialising on a particular system to change which template is used for an inferred project.

See INFER-PROJECT

Package

staple

Methods
Method: template (SYSTEM system)
Source

inference.lisp (file)

Generic Function: template-data PAGE

Returns the arguments to CLIP:PROCESS that should be used for the page.

This should be a plistt containing the necessary data to compile the template. Note that this generic function uses the APPEND method- combination, meaning that you may add new keys by simply adding a new method to this function. The method combination uses :MOST-SPECIFIC-FIRST, and since plists short-circuit, you may also use a method to override keys that less-specific methods may have set.

See TEMPLATED-PAGE

Package

staple

Source

page.lisp (file)

Method Combination

append (short method combination)

Options: :most-specific-first

Methods
Method: template-data (PAGE simple-page) append
Source

inference.lisp (file)

Method: template-data (PAGE system-page) append
Method: template-data (PAGE definitions-index-page) append
Method: template-data (PAGE templated-page) append
Generic Function: title OBJECT

Accessor to the title of a page.

The title should be a very short, unique identifier for the page within the project. Pages that represent the same content but in different languages should have the same titles. The title of a page may be used as the name for a link to that page.

See PAGE

Package

staple

Writer

(setf title) (generic function)

Methods
Method: title (PAGE page)

automatically generated reader method

Source

page.lisp (file)

Generic Function: (setf title) NEW-VALUE OBJECT
Package

staple

Reader

title (generic function)

Methods
Method: (setf title) NEW-VALUE (PAGE page)

automatically generated writer method

Source

page.lisp (file)

Generic Function: walk CST ENVIRONMENT

Walks the given CST in the environment.

Should return a parse result structure.
Parse results are lists of the following form:

PARSE-RESULT ::= (TYPE SOURCE . ARGS)
TYPE — The type of the form we’ve walked. Typically this is a symbol of the form itself, like LAMBDA, or a keyword if a generic variant is encountered like for :CALLs and :MACROs.
SOURCE ::= (START . END)
ARGS — Additional arguments for the parse result, including additional parse-results.

Generally see the overall concrete-syntax-tree system for explanations on how to use this.

Note that you probably want to define a method on WALK-FORM instead, as that is called automatically as appropriate for each CST:CONST-CST, and WALK-ATOM is called for each CST:ATOM-CST.

See ENVIRONMENT

Package

staple-code-parser

Methods
Method: walk (CST cons-cst) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST atom-cst) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST specialized-required-parameter) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST ordinary-key-parameter) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST ordinary-optional-parameter) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST simple-variable) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST specialized-lambda-list) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST macro-lambda-list) ENVIRONMENT
Source

walker.lisp (file)

Method: walk (CST ordinary-lambda-list) ENVIRONMENT
Source

walker.lisp (file)

Generic Function: walk-atom ATOM ENVIRONMENT

Walks an atom.

If the atom is a symbol, it returns a parse result of a literal for keywords and booleans, or a variable for symbols. For everything else it returns a parse result for a literal.

Package

staple-code-parser

Methods
Method: walk-atom ATOM ENVIRONMENT
Source

walker.lisp (file)

Method: walk-atom (ATOM symbol) ENVIRONMENT
Source

walker.lisp (file)

Generic Function: walk-form OPERATOR-VAR2 CST ENVIRONMENT

Walks a form.

The form is identified by the car of the cons. The entirety of the form as a CST, including the operator, are passed along as well.

Package

staple-code-parser

Methods
Method: walk-form (OPERATOR-VAR13 (eql apply)) (CST cons-cst) ENVIRONMENT
Source

standard-forms.lisp (file)

Method: walk-form (OPERATOR-VAR8 (eql funcall)) (CST cons-cst) ENVIRONMENT
Source

standard-forms.lisp (file)

Method: walk-form (OPERATOR-VAR0 (eql setf)) (CST cons-cst) ENVIRONMENT
Source

standard-forms.lisp (file)

Method: walk-form (OPERATOR-VAR0 (eql defmethod)) (CST cons-cst) ENVIRONMENT
Source

standard-forms.lisp (file)

Method: walk-form OPERATOR-VAR0 (CST cons-cst) ENVIRONMENT
Source

standard-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql unwind-protect)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql throw)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql the)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql tagbody)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql symbol-macrolet)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql setq)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql return-from)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR1 (eql quote)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql progv)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR1 (eql progn)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql multiple-value-prog1)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql multiple-value-call)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql macrolet)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql locally)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql load-time-value)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql let*)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql let)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql labels)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql if)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql go)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql named-lambda)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR0 (eql lambda)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR0 (eql function)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql flet)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql eval-when)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR3 (eql catch)) (CST cons-cst) ENVIRONMENT0
Source

special-forms.lisp (file)

Method: walk-form (OPERATOR-VAR2 (eql block)) (CST cons-cst) ENVIRONMENT
Source

special-forms.lisp (file)

Generic Function: xref THING &optional TYPE

Attempts to find a cross-reference URL for the given thing.

The following default cases are handled:

DEFINITIONS:DEFINITION — RESOLVE-XREF is called directly. STRING — The string is parsed by PARSE-SYMBOL, and if it represents a valid symbol, matching definitions are attempted to be found via FIND-DEFINITIONS-FOR-IDENTIFIER. The definitions are ranked according to PREFERRED-DEFINITION, and the first one cross-reference via RESOLVE-XREF that can be found is returned.

The optional TYPE argument constrains the cross references to be of the given type of definition.

See RESOLVE-XREF
See PARSE-SYMBOL
See FIND-DEFINITIONS-FOR-IDENTIFIER
See PREFERRED-DEFINITION

Package

staple

Source

xref.lisp (file)

Methods
Method: xref (IDENTIFIER string) &optional TYPE
Method: xref (DEFINITION definition) &optional TYPE

Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Conditions

Condition: no-known-output-directory ()

Error signalled when no known output directory is available for a system.

See SYSTEM
See INFER-PROJECT

Package

staple

Source

inference.lisp (file)

Direct superclasses

error (condition)

Direct methods

system (method)

Direct slots
Slot: system
Initargs

:system

Readers

system (generic function)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.6 Classes

Class: compiled-page ()

A compiled page that is created by translating some input file.

In order to handle the translation, COMPILE-SOURCE is used.
The output of COMPILE-SOURCE may be a PLUMP:NODE, a STRING, or an (unsigned-byte 8) vector. In the case of a PLUMP:NODE, the node is first compressed using COMPACT if the :COMPACT argument to GENERATE is non-NIL (default).

See INPUT-PAGE
See COMPILE-SOURCE

Package

staple

Source

page.lisp (file)

Direct superclasses

input-page (class)

Direct methods

generate (method)

Class: definitions-index-page ()

Superclass for pages that include a definitions index.

See PACKAGES
See FORMAT-DOCUMENTATION
See RESOLVE-SOURCE-LINK
See DEFINITION-WANTED-P
See DEFINITIONS

Package

staple

Source

page.lisp (file)

Direct superclasses

templated-page (class)

Direct subclasses

system-page (class)

Direct methods
Direct slots
Slot: packages
Readers

packages (generic function)

Writers

(setf packages) (generic function)

Class: environment ()

Container for environment information used during walking.

See PARENT
See NAMESPACES
See LOOKUP
See AUGMENT-ENVIRONMENT!
See AUGMENTED-ENVIRONMENT

Package

staple-code-parser

Source

environment.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: parent
Initargs

:parent

Readers

parent (generic function)

Slot: namespaces
Initform

(make-hash-table :test (quote eq))

Readers

namespaces (generic function)

Class: input-page ()

Superclass for pages that are generated using some kind of input.

See PAGE
See INPUT

Package

staple

Source

page.lisp (file)

Direct superclasses

page (class)

Direct subclasses
Direct methods
Direct slots
Slot: input
Initargs

:input

Readers

input (generic function)

Writers

(setf input) (generic function)

Direct Default Initargs
InitargValue
:inputnil
Class: page ()

Base class for all pages that can be generated as part of a project.

A page represents a single, well, page within the documentation for a particular project. It should only produce a single output, which is typically a file. A page should, if possible, only contain text in a single language. This primary language is indicated by the page’s LANGUAGE slot and defaults to "en" for English.

If the output is a pathname, the behaviour on existing output may be specified through the :IF-EXISTS argument to GENERATE, by default set to :ERROR.

See PROJECT
See TITLE
See LANGUAGE
See OUTPUT
See GENERATE

Package

staple

Source

page.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

input-page (class)

Direct methods
Direct slots
Slot: title
Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: language
Initargs

:language

Initform

:en

Readers

language (generic function)

Writers

(setf language) (generic function)

Slot: output
Initargs

:output

Readers

output (generic function)

Writers

(setf output) (generic function)

Slot: project
Initargs

:project

Readers

project (generic function)

Writers

(setf project) (generic function)

Direct Default Initargs
InitargValue
:outputnil
:titlenil
:project(error "project required.")
Class: placeholder ()

This class represents symbols that are not present in the host.

They are emitted in parsed code snippets in place of symbols that cannot be read properly.

See PLACEHOLDER-NAME
See PLACEHOLDER-PACKAGE
See PLACEHOLDER-INTERN

Package

staple-code-parser

Source

walker.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

placeholder-name (generic function)

Slot: package
Initargs

:package

Readers

placeholder-package (generic function)

Slot: intern
Initargs

:intern

Readers

placeholder-intern (generic function)

Direct Default Initargs
InitargValue
:name(error "name required")
:packagenil
:internnil
Class: project ()

Superclass for a documentation project.

A project encapsulates all documentation for a library or program. Typically this is expressed by a number of PAGEs that will create the expected documentation files when the project is GENERATEd.

The OUTPUT of a project represents the root directory of all output data. It is used to figure out relative paths between pages and resources.

See OUTPUT
See PAGE
See PAGES
See GENERATE

Package

staple

Source

project.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

simple-project (class)

Direct methods
Direct slots
Slot: output
Initargs

:output

Readers

output (generic function)

Writers

(setf output) (generic function)

Class: simple-page ()

A simple page to base documentation on.

Simple-pages are the preferred pages to use for inferred systems. They provide a convenient all-in-one package for a definitions index and a documentation body.

A single "document" makes up the main body of the page and should provide the primary documentation of the system or project. The document is transformed by COMPILE-SOURCE, which by default will automatically parse it from file and mark up code snippets within it.

If the OUTPUT pathname passed as initarg to this class is missing the name and type, then the pathname is augmented using FILENAME of the page.

See *DEFAULT-TEMPLATE*
See DOCUMENT
See IMAGES
See FILENAME
See SYSTEM-PAGE
See COMPILE-SOURCE

Package

staple

Source

inference.lisp (file)

Direct superclasses

system-page (class)

Direct methods
Direct slots
Slot: document-package
Initargs

:document-package

Readers

document-package (generic function)

Writers

(setf document-package) (generic function)

Slot: document
Initargs

:document

Readers

document (generic function)

Writers

(setf document) (generic function)

Slot: images
Initargs

:images

Readers

images (generic function)

Writers

(setf images) (generic function)

Direct Default Initargs
InitargValue
:documentnil
:imagesnil
:document-packagenil
:inputstaple:*default-template*
Class: simple-project ()

A simple project.

This class simply stores a list of page instances and generates them when GENERATE is called on the project instance.

See PROJECT
See PAGES

Package

staple

Source

project.lisp (file)

Direct superclasses

project (class)

Direct methods
Direct slots
Slot: pages
Initargs

:pages

Readers

pages (generic function)

Writers

(setf pages) (generic function)

Direct Default Initargs
InitargValue
:pagesnil
Class: static-page ()

A static page that simply copies its input to its output.

This is useful for static files such as images and other resources.

See INPUT-PAGE

Package

staple

Source

page.lisp (file)

Direct superclasses

input-page (class)

Direct methods

generate (method)

Class: system-page ()

Superclass for pages that represent and ASDF system.

This system will compute several properties automatically by using the ASDF metadata: if the :PACKAGES are not given, they are computed from calling PACKAGES on the system object. When a source link is resolved
and the project’s homepage resides on GitHub or GitLab, it will try to guess a link to the GitHub/GitLab repository’s viewer of the source file.

See SYSTEM
See DEFINITIONS-INDEX-PAGE

Package

staple

Source

page.lisp (file)

Direct superclasses

definitions-index-page (class)

Direct subclasses

simple-page (class)

Direct methods
Direct slots
Slot: system
Initargs

nil

Readers

system (generic function)

Writers

(setf system) (generic function)

Class: templated-page ()

Superclass for pages that are templated using Clip.

The template that Clip is run on is the INPUT of the page. The template arguments are computed using the TEMPLATE-DATA generic function.

The output of the page is compressed using COMPACT if the :COMPACT argument to GENERATE is non-NIL (default).

See INPUT-PAGE
See TEMPLATE-DATA

Package

staple

Source

page.lisp (file)

Direct superclasses

input-page (class)

Direct subclasses

definitions-index-page (class)

Direct methods

Previous: , Up: Exported definitions   [Contents][Index]

5.1.7 Types

Type: stream-designator ()

A type representing all possible values to be used with ENSURE-STREAM.

See ENSURE-STREAM

Package

staple

Source

toolkit.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *before-load-packages*
Package

staple-package-recording

Source

recording.lisp (file)

Special Variable: *loaded-extensions*
Package

staple

Source

project.lisp (file)

Special Variable: *pathname-type-type-map*
Package

staple

Source

transform.lisp (file)

Special Variable: *system-packages*
Package

staple-package-recording

Source

recording.lisp (file)

Special Variable: *xref-resolvers*
Package

staple

Source

xref.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: case* TEST VALUE &body CLAUSES

Like CL:CASE, but takes a test function.

TEST must be a function designator or a lambda expression.

See CL:CASE

Package

staple

Source

toolkit.lisp (file)

Macro: do-directory-tree (FILE DIRECTORY &optional RESULT MAX-DEPTH) &body BODY

Executes body for each file in the directory tree.

Evaluates RESULT last and returns its value.

See MAP-DIRECTORY-TREE

Package

staple

Source

toolkit.lisp (file)

Macro: with-value-restart PLACE &body BODY

Ensures PLACE has a valid value.

This establishes a STORE-VALUE restart around BODY. If the restart is called, the PLACE is set to the value the restart was called with and the BODY is executed again.

Typically the BODY will be some kind of check to ensure the validity of the value stored in PLACE. In combination with this macro, that will ensure that the code only ever continues with a valid value in PLACE.

Package

staple

Source

toolkit.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: compact NODE

Compacts the given PLUMP:NODE by removing extraneous whitespace.

This will take care not to trim whitespace from <pre> tags, but will replace any duplicate whitespace with a single space anywhere else. Note that this will leave a single space between nodes, as it cannot determine whether the effects of the whitespace in that case are intended or not.

Package

staple

Source

toolkit.lisp (file)

Function: efind-package NAME
Package

staple-package-recording

Source

recording.lisp (file)

Function: ensure-namespace NAMESPACE ENVIRONMENT

Makes sure the namespace of the given name exists in the environment.

See ENVIRONMENT
See NAMESPACES

Package

staple-code-parser

Source

environment.lisp (file)

Function: ensure-stream DESIGNATOR &key DIRECTION IF-EXISTS ELEMENT-TYPE

Attempts to coerce the given designator to a stream object.

The following are handled:

STREAM — The designator is returned verbatim. STRING/PATHNAME — OPEN is called on the designator using the given keyword arguments as appropriate. NULL — A string-output-stream is returned.
T — *STANDARD-OUTPUT* is returned.

See WITH-STREAM
See STREAM-DESIGNATOR

Package

staple

Source

toolkit.lisp (file)

Function: ensure-system SYSTEM-ISH

Ensures to return an ASDF:SYSTEM.

If the argument is not already an ASDF:SYSTEM, it is passed to ASDF:FIND-SYSTEM, and errors if no system can be found.

See ASDF:SYSTEM
See ASDF:FIND-SYSTEM

Package

staple

Source

toolkit.lisp (file)

Function: extract-author-email AUTHOR
Package

staple

Source

toolkit.lisp (file)

Function: extract-author-name AUTHOR
Package

staple

Source

toolkit.lisp (file)

Function: github-project-root GITHUB-URL
Package

staple

Source

page.lisp (file)

Function: gitlab-project-root GITLAB-URL
Package

staple

Source

page.lisp (file)

Function: make-extension-load-table ()
Package

staple

Source

project.lisp (file)

Package

staple

Source

code-format.lisp (file)

Function: map-directory-tree FUNCTION DIRECTORY &key MAX-DEPTH

Calls the given function for all files in the directory tree.

If MAX-DEPTH is given, it denotes the maximum number of directories into which it recurses. Specifically, if MAX-DEPTH is 0, only the files in the given directory are mapped to the function. Otherwise each directory is visited recursively with MAX-DEPTH reduced by one.

Package

staple

Source

toolkit.lisp (file)

Function: merge-plists PLIST DEFAULT
Package

staple

Source

toolkit.lisp (file)

Function: namespace NAMESPACE ENVIRONMENT

Accesses the namespace of the given name from the environment.

See NAMESPACES
See ENVIRONMENT
See LOOKUP

Package

staple-code-parser

Source

environment.lisp (file)

Function: parse-lisp-token STRING

Parses a lisp symbol token, meaning it will read from string by properly interpreting backslashes and vertical bar escapes.

Package

staple

Source

xref.lisp (file)

Function: parse-symbol IDENTIFIER

Parses a symbol from the given string identifier.

Explicit packages, keywords, and package-less symbols are handled.

Returns two values, the symbol’s name and its package as strings. If the symbol is a gensym, the returned package name is :GENSYM, rather than an actual package name string.

Package

staple

Source

xref.lisp (file)

Function: perform-and-record-macro-expansion EXPANDER CST
Package

staple-code-parser

Source

standard-forms.lisp (file)

Function: prefix-p PREFIX STRING

Returns T if PREFIX is a whole prefix of STRING.

Package

staple

Source

toolkit.lisp (file)

Function: read-value ()

Reads a value from *query-io*.

To be used with interactive restarts.

Package

staple

Source

toolkit.lisp (file)

Function: skip-to-source-form STREAM

Continues reading from the stream until a valid lisp source form is encountered.

This skips both whitespace and comments.

Package

staple

Source

toolkit.lisp (file)

Function: split SPLIT STRING

Splits the given string by the given splitting character.

Returns the list of non-empty substrings. The split strings are not shared with the original string.

Package

staple

Source

toolkit.lisp (file)

Function: stream-value STREAM
Package

staple

Source

toolkit.lisp (file)

Function: system-field FIELD SYSTEM
Package

staple

Source

toolkit.lisp (file)

Function: titleize THING

Attempts to turn the given string into one more suitable as a title.

Package

staple

Source

toolkit.lisp (file)

Function: unlist LISTISH
Package

staple

Source

toolkit.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: namespaces OBJECT

Returns the hash-table of namespaces in the environment.

See ENVIRONMENT
See NAMESPACE

Package

staple-code-parser

Methods
Method: namespaces (ENVIRONMENT environment)

automatically generated reader method

Source

environment.lisp (file)

Generic Function: parent OBJECT

Returns the parent of the environment, if any.

See ENVIRONMENT

Package

staple-code-parser

Methods
Method: parent (ENVIRONMENT environment)

automatically generated reader method

Source

environment.lisp (file)

Generic Function: system-name SYSTEM

Returns a canonical keyword for the name of the ASDF:SYSTEM.

Package

staple

Methods
Method: system-name NAME
Source

toolkit.lisp (file)

Method: system-name (SYSTEM system)
Source

toolkit.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

Class: client ()

Our subclass of the eclector cst-client.

Uses the host lisp’s EVAL.

See ECLECTOR.CONCRETE-SYNTAX-TREE::CST-CLIENT

Package

staple-code-parser

Source

walker.lisp (file)

Direct superclasses

cst-client (class)

Direct methods
  • evaluate-expression (method)
  • interpret-symbol (method)

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

F
File, Lisp, staple-code-parser.asd: The staple-code-parser․asd file
File, Lisp, staple-code-parser/documentation.lisp: The staple-code-parser/documentation․lisp file
File, Lisp, staple-code-parser/environment.lisp: The staple-code-parser/environment․lisp file
File, Lisp, staple-code-parser/package.lisp: The staple-code-parser/package․lisp file
File, Lisp, staple-code-parser/special-forms.lisp: The staple-code-parser/special-forms․lisp file
File, Lisp, staple-code-parser/standard-forms.lisp: The staple-code-parser/standard-forms․lisp file
File, Lisp, staple-code-parser/to-definitions.lisp: The staple-code-parser/to-definitions․lisp file
File, Lisp, staple-code-parser/walker.lisp: The staple-code-parser/walker․lisp file
File, Lisp, staple-package-recording.asd: The staple-package-recording․asd file
File, Lisp, staple-package-recording/recording.lisp: The staple-package-recording/recording․lisp file
File, Lisp, staple.asd: The staple․asd file
File, Lisp, staple/clip.lisp: The staple/clip․lisp file
File, Lisp, staple/code-format.lisp: The staple/code-format․lisp file
File, Lisp, staple/documentation.lisp: The staple/documentation․lisp file
File, Lisp, staple/inference.lisp: The staple/inference․lisp file
File, Lisp, staple/package.lisp: The staple/package․lisp file
File, Lisp, staple/page.lisp: The staple/page․lisp file
File, Lisp, staple/project.lisp: The staple/project․lisp file
File, Lisp, staple/toolkit.lisp: The staple/toolkit․lisp file
File, Lisp, staple/transform.lisp: The staple/transform․lisp file
File, Lisp, staple/xref.lisp: The staple/xref․lisp file

L
Lisp File, staple-code-parser.asd: The staple-code-parser․asd file
Lisp File, staple-code-parser/documentation.lisp: The staple-code-parser/documentation․lisp file
Lisp File, staple-code-parser/environment.lisp: The staple-code-parser/environment․lisp file
Lisp File, staple-code-parser/package.lisp: The staple-code-parser/package․lisp file
Lisp File, staple-code-parser/special-forms.lisp: The staple-code-parser/special-forms․lisp file
Lisp File, staple-code-parser/standard-forms.lisp: The staple-code-parser/standard-forms․lisp file
Lisp File, staple-code-parser/to-definitions.lisp: The staple-code-parser/to-definitions․lisp file
Lisp File, staple-code-parser/walker.lisp: The staple-code-parser/walker․lisp file
Lisp File, staple-package-recording.asd: The staple-package-recording․asd file
Lisp File, staple-package-recording/recording.lisp: The staple-package-recording/recording․lisp file
Lisp File, staple.asd: The staple․asd file
Lisp File, staple/clip.lisp: The staple/clip․lisp file
Lisp File, staple/code-format.lisp: The staple/code-format․lisp file
Lisp File, staple/documentation.lisp: The staple/documentation․lisp file
Lisp File, staple/inference.lisp: The staple/inference․lisp file
Lisp File, staple/package.lisp: The staple/package․lisp file
Lisp File, staple/page.lisp: The staple/page․lisp file
Lisp File, staple/project.lisp: The staple/project․lisp file
Lisp File, staple/toolkit.lisp: The staple/toolkit․lisp file
Lisp File, staple/transform.lisp: The staple/transform․lisp file
Lisp File, staple/xref.lisp: The staple/xref․lisp file

S
staple-code-parser.asd: The staple-code-parser․asd file
staple-code-parser/documentation.lisp: The staple-code-parser/documentation․lisp file
staple-code-parser/environment.lisp: The staple-code-parser/environment․lisp file
staple-code-parser/package.lisp: The staple-code-parser/package․lisp file
staple-code-parser/special-forms.lisp: The staple-code-parser/special-forms․lisp file
staple-code-parser/standard-forms.lisp: The staple-code-parser/standard-forms․lisp file
staple-code-parser/to-definitions.lisp: The staple-code-parser/to-definitions․lisp file
staple-code-parser/walker.lisp: The staple-code-parser/walker․lisp file
staple-package-recording.asd: The staple-package-recording․asd file
staple-package-recording/recording.lisp: The staple-package-recording/recording․lisp file
staple.asd: The staple․asd file
staple/clip.lisp: The staple/clip․lisp file
staple/code-format.lisp: The staple/code-format․lisp file
staple/documentation.lisp: The staple/documentation․lisp file
staple/inference.lisp: The staple/inference․lisp file
staple/package.lisp: The staple/package․lisp file
staple/page.lisp: The staple/page․lisp file
staple/project.lisp: The staple/project․lisp file
staple/toolkit.lisp: The staple/toolkit․lisp file
staple/transform.lisp: The staple/transform․lisp file
staple/xref.lisp: The staple/xref․lisp file

Jump to:   F   L   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

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

(
(setf document): Exported generic functions
(setf document): Exported generic functions
(setf document-package): Exported generic functions
(setf document-package): Exported generic functions
(setf images): Exported generic functions
(setf images): Exported generic functions
(setf input): Exported generic functions
(setf input): Exported generic functions
(setf language): Exported generic functions
(setf language): Exported generic functions
(setf lookup): Exported generic functions
(setf lookup): Exported generic functions
(setf output): Exported generic functions
(setf output): Exported generic functions
(setf output): Exported generic functions
(setf packages): Exported generic functions
(setf packages): Exported generic functions
(setf packages): Exported generic functions
(setf packages): Exported generic functions
(setf packages): Exported generic functions
(setf pages): Exported generic functions
(setf pages): Exported generic functions
(setf pathname-type->type): Exported functions
(setf project): Exported generic functions
(setf project): Exported generic functions
(setf system): Exported generic functions
(setf system): Exported generic functions
(setf system): Exported generic functions
(setf title): Exported generic functions
(setf title): Exported generic functions
(setf xref-resolver): Exported functions

A
absolute-source-location: Exported functions
augment-environment!: Exported functions
augmented-environment: Exported functions

C
case*: Internal macros
compact: Internal functions
compile-source: Exported generic functions
compile-source: Exported generic functions
compile-source: Exported generic functions
compile-source: Exported generic functions
compile-source: Exported generic functions
compile-source: Exported generic functions
compile-source: Exported generic functions

D
define-definition-resolver: Exported macros
define-source-compiler: Exported macros
define-sub-results: Exported macros
define-walk-compound-form: Exported macros
define-walker-form: Exported macros
define-xref-resolver: Exported macros
definition-id: Exported generic functions
definition-id: Exported generic functions
definition-id: Exported generic functions
definition-importance: Exported generic functions
definition-importance: Exported generic functions
definition-importance: Exported generic functions
definition-importance: Exported generic functions
definition-importance: Exported generic functions
definition-importance: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-order: Exported generic functions
definition-wanted-p: Exported generic functions
definition-wanted-p: Exported generic functions
definition-wanted-p: Exported generic functions
definition-wanted-p: Exported generic functions
definition-wanted-p: Exported generic functions
definition-wanted-p: Exported generic functions
definition-wanted-p: Exported generic functions
definitions: Exported generic functions
definitions: Exported generic functions
definitions: Exported generic functions
do-directory-tree: Internal macros
document: Exported generic functions
document: Exported generic functions
document-package: Exported generic functions
document-package: Exported generic functions
documents: Exported generic functions
documents: Exported generic functions

E
efind-package: Internal functions
ensure-namespace: Internal functions
ensure-package: Exported functions
ensure-package-definition: Exported functions
ensure-stream: Internal functions
ensure-system: Internal functions
extension-file: Exported generic functions
extension-file: Exported generic functions
extract-author-email: Internal functions
extract-author-name: Internal functions
extract-language: Exported functions

F
filename: Exported generic functions
filename: Exported generic functions
find-definitions: Exported generic functions
find-definitions: Exported generic functions
find-definitions: Exported generic functions
find-definitions: Exported generic functions
find-definitions: Exported generic functions
find-definitions: Exported generic functions
find-definitions: Exported generic functions
find-definitions-for-identifier: Exported functions
find-files: Exported functions
find-project: Exported generic functions
find-project: Exported generic functions
find-project: Exported generic functions
format-documentation: Exported generic functions
format-documentation: Exported generic functions
format-documentation: Exported generic functions
format-documentation: Exported generic functions
Function, (setf pathname-type->type): Exported functions
Function, (setf xref-resolver): Exported functions
Function, absolute-source-location: Exported functions
Function, augment-environment!: Exported functions
Function, augmented-environment: Exported functions
Function, compact: Internal functions
Function, efind-package: Internal functions
Function, ensure-namespace: Internal functions
Function, ensure-package: Exported functions
Function, ensure-package-definition: Exported functions
Function, ensure-stream: Internal functions
Function, ensure-system: Internal functions
Function, extract-author-email: Internal functions
Function, extract-author-name: Internal functions
Function, extract-language: Exported functions
Function, find-definitions-for-identifier: Exported functions
Function, find-files: Exported functions
Function, github-project-root: Internal functions
Function, gitlab-project-root: Internal functions
Function, load-extension: Exported functions
Function, load-system-quietly: Exported functions
Function, make-extension-load-table: Internal functions
Function, make-xref-link: Internal functions
Function, map-directory-tree: Internal functions
Function, markup-code-block: Exported functions
Function, markup-code-reference: Exported functions
Function, markup-code-snippets: Exported functions
Function, markup-code-snippets-ignoring-errors: Exported functions
Function, maybe-lang-docstring: Exported functions
Function, merge-plists: Internal functions
Function, namespace: Internal functions
Function, parse-lisp-token: Internal functions
Function, parse-result->definition-list: Exported functions
Function, parse-symbol: Internal functions
Function, pathname-type->type: Exported functions
Function, perform-and-record-macro-expansion: Internal functions
Function, preferred-definition: Exported functions
Function, prefix-p: Internal functions
Function, purify-arglist: Exported functions
Function, read-file: Exported functions
Function, read-value: Internal functions
Function, remove-xref-resolver: Exported functions
Function, resolve-xref: Exported functions
Function, skip-to-source-form: Internal functions
Function, sort-definitions: Exported functions
Function, split: Internal functions
Function, stream-value: Internal functions
Function, system-field: Internal functions
Function, tie-to-source: Exported functions
Function, titleize: Internal functions
Function, unlist: Internal functions
Function, url-encode: Exported functions
Function, walk-bindings: Exported functions
Function, walk-body: Exported functions
Function, walk-implicit-progn: Exported functions
Function, walk-lambda-like: Exported functions
Function, xref-resolver: Exported functions

G
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
generate: Exported generic functions
Generic Function, (setf document): Exported generic functions
Generic Function, (setf document-package): Exported generic functions
Generic Function, (setf images): Exported generic functions
Generic Function, (setf input): Exported generic functions
Generic Function, (setf language): Exported generic functions
Generic Function, (setf lookup): Exported generic functions
Generic Function, (setf output): Exported generic functions
Generic Function, (setf packages): Exported generic functions
Generic Function, (setf pages): Exported generic functions
Generic Function, (setf project): Exported generic functions
Generic Function, (setf system): Exported generic functions
Generic Function, (setf title): Exported generic functions
Generic Function, compile-source: Exported generic functions
Generic Function, definition-id: Exported generic functions
Generic Function, definition-importance: Exported generic functions
Generic Function, definition-order: Exported generic functions
Generic Function, definition-wanted-p: Exported generic functions
Generic Function, definitions: Exported generic functions
Generic Function, document: Exported generic functions
Generic Function, document-package: Exported generic functions
Generic Function, documents: Exported generic functions
Generic Function, extension-file: Exported generic functions
Generic Function, filename: Exported generic functions
Generic Function, find-definitions: Exported generic functions
Generic Function, find-project: Exported generic functions
Generic Function, format-documentation: Exported generic functions
Generic Function, generate: Exported generic functions
Generic Function, images: Exported generic functions
Generic Function, infer-project: Exported generic functions
Generic Function, input: Exported generic functions
Generic Function, language: Exported generic functions
Generic Function, lookup: Exported generic functions
Generic Function, namespaces: Internal generic functions
Generic Function, output: Exported generic functions
Generic Function, output-directory: Exported generic functions
Generic Function, package-system: Exported generic functions
Generic Function, packages: Exported generic functions
Generic Function, page-type: Exported generic functions
Generic Function, pages: Exported generic functions
Generic Function, parent: Internal generic functions
Generic Function, parse: Exported generic functions
Generic Function, placeholder-intern: Exported generic functions
Generic Function, placeholder-name: Exported generic functions
Generic Function, placeholder-package: Exported generic functions
Generic Function, project: Exported generic functions
Generic Function, read-toplevel: Exported generic functions
Generic Function, relative-path: Exported generic functions
Generic Function, resolve-source-link: Exported generic functions
Generic Function, sub-results: Exported generic functions
Generic Function, subsystems: Exported generic functions
Generic Function, system: Exported generic functions
Generic Function, system-name: Internal generic functions
Generic Function, template: Exported generic functions
Generic Function, template-data: Exported generic functions
Generic Function, title: Exported generic functions
Generic Function, walk: Exported generic functions
Generic Function, walk-atom: Exported generic functions
Generic Function, walk-form: Exported generic functions
Generic Function, xref: Exported generic functions
github-project-root: Internal functions
gitlab-project-root: Internal functions

I
images: Exported generic functions
images: Exported generic functions
images: Exported generic functions
infer-project: Exported generic functions
infer-project: Exported generic functions
infer-project: Exported generic functions
input: Exported generic functions
input: Exported generic functions

L
language: Exported generic functions
language: Exported generic functions
load-extension: Exported functions
load-system-quietly: Exported functions
lookup: Exported generic functions
lookup: Exported generic functions

M
Macro, case*: Internal macros
Macro, define-definition-resolver: Exported macros
Macro, define-source-compiler: Exported macros
Macro, define-sub-results: Exported macros
Macro, define-walk-compound-form: Exported macros
Macro, define-walker-form: Exported macros
Macro, define-xref-resolver: Exported macros
Macro, do-directory-tree: Internal macros
Macro, with-stream: Exported macros
Macro, with-value-restart: Internal macros
make-extension-load-table: Internal functions
make-xref-link: Internal functions
map-directory-tree: Internal functions
markup-code-block: Exported functions
markup-code-reference: Exported functions
markup-code-snippets: Exported functions
markup-code-snippets-ignoring-errors: Exported functions
maybe-lang-docstring: Exported functions
merge-plists: Internal functions
Method, (setf document): Exported generic functions
Method, (setf document-package): Exported generic functions
Method, (setf images): Exported generic functions
Method, (setf input): Exported generic functions
Method, (setf language): Exported generic functions
Method, (setf lookup): Exported generic functions
Method, (setf output): Exported generic functions
Method, (setf output): Exported generic functions
Method, (setf packages): Exported generic functions
Method, (setf packages): Exported generic functions
Method, (setf packages): Exported generic functions
Method, (setf packages): Exported generic functions
Method, (setf pages): Exported generic functions
Method, (setf project): Exported generic functions
Method, (setf system): Exported generic functions
Method, (setf system): Exported generic functions
Method, (setf title): Exported generic functions
Method, compile-source: Exported generic functions
Method, compile-source: Exported generic functions
Method, compile-source: Exported generic functions
Method, compile-source: Exported generic functions
Method, compile-source: Exported generic functions
Method, compile-source: Exported generic functions
Method, definition-id: Exported generic functions
Method, definition-id: Exported generic functions
Method, definition-importance: Exported generic functions
Method, definition-importance: Exported generic functions
Method, definition-importance: Exported generic functions
Method, definition-importance: Exported generic functions
Method, definition-importance: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-order: Exported generic functions
Method, definition-wanted-p: Exported generic functions
Method, definition-wanted-p: Exported generic functions
Method, definition-wanted-p: Exported generic functions
Method, definition-wanted-p: Exported generic functions
Method, definition-wanted-p: Exported generic functions
Method, definition-wanted-p: Exported generic functions
Method, definitions: Exported generic functions
Method, definitions: Exported generic functions
Method, document: Exported generic functions
Method, document-package: Exported generic functions
Method, documents: Exported generic functions
Method, extension-file: Exported generic functions
Method, filename: Exported generic functions
Method, find-definitions: Exported generic functions
Method, find-definitions: Exported generic functions
Method, find-definitions: Exported generic functions
Method, find-definitions: Exported generic functions
Method, find-definitions: Exported generic functions
Method, find-definitions: Exported generic functions
Method, find-project: Exported generic functions
Method, find-project: Exported generic functions
Method, format-documentation: Exported generic functions
Method, format-documentation: Exported generic functions
Method, format-documentation: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, generate: Exported generic functions
Method, images: Exported generic functions
Method, images: Exported generic functions
Method, infer-project: Exported generic functions
Method, infer-project: Exported generic functions
Method, input: Exported generic functions
Method, language: Exported generic functions
Method, lookup: Exported generic functions
Method, namespaces: Internal generic functions
Method, output: Exported generic functions
Method, output: Exported generic functions
Method, output-directory: Exported generic functions
Method, package-system: Exported generic functions
Method, package-system: Exported generic functions
Method, packages: Exported generic functions
Method, packages: Exported generic functions
Method, packages: Exported generic functions
Method, page-type: Exported generic functions
Method, pages: Exported generic functions
Method, parent: Internal generic functions
Method, parse: Exported generic functions
Method, placeholder-intern: Exported generic functions
Method, placeholder-name: Exported generic functions
Method, placeholder-package: Exported generic functions
Method, project: Exported generic functions
Method, read-toplevel: Exported generic functions
Method, read-toplevel: Exported generic functions
Method, read-toplevel: Exported generic functions
Method, relative-path: Exported generic functions
Method, relative-path: Exported generic functions
Method, relative-path: Exported generic functions
Method, relative-path: Exported generic functions
Method, relative-path: Exported generic functions
Method, relative-path: Exported generic functions
Method, resolve-source-link: Exported generic functions
Method, resolve-source-link: Exported generic functions
Method, resolve-source-link: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, sub-results: Exported generic functions
Method, subsystems: Exported generic functions
Method, system: Exported generic functions
Method, system: Exported generic functions
Method, system-name: Internal generic functions
Method, system-name: Internal generic functions
Method, template: Exported generic functions
Method, template-data: Exported generic functions
Method, template-data: Exported generic functions
Method, template-data: Exported generic functions
Method, template-data: Exported generic functions
Method, title: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk: Exported generic functions
Method, walk-atom: Exported generic functions
Method, walk-atom: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, walk-form: Exported generic functions
Method, xref: Exported generic functions
Method, xref: Exported generic functions

N
namespace: Internal functions
namespaces: Internal generic functions
namespaces: Internal generic functions

O
output: Exported generic functions
output: Exported generic functions
output: Exported generic functions
output-directory: Exported generic functions
output-directory: Exported generic functions

P
package-system: Exported generic functions
package-system: Exported generic functions
package-system: Exported generic functions
packages: Exported generic functions
packages: Exported generic functions
packages: Exported generic functions
packages: Exported generic functions
page-type: Exported generic functions
page-type: Exported generic functions
pages: Exported generic functions
pages: Exported generic functions
parent: Internal generic functions
parent: Internal generic functions
parse: Exported generic functions
parse: Exported generic functions
parse-lisp-token: Internal functions
parse-result->definition-list: Exported functions
parse-symbol: Internal functions
pathname-type->type: Exported functions
perform-and-record-macro-expansion: Internal functions
placeholder-intern: Exported generic functions
placeholder-intern: Exported generic functions
placeholder-name: Exported generic functions
placeholder-name: Exported generic functions
placeholder-package: Exported generic functions
placeholder-package: Exported generic functions
preferred-definition: Exported functions
prefix-p: Internal functions
project: Exported generic functions
project: Exported generic functions
purify-arglist: Exported functions

R
read-file: Exported functions
read-toplevel: Exported generic functions
read-toplevel: Exported generic functions
read-toplevel: Exported generic functions
read-toplevel: Exported generic functions
read-value: Internal functions
relative-path: Exported generic functions
relative-path: Exported generic functions
relative-path: Exported generic functions
relative-path: Exported generic functions
relative-path: Exported generic functions
relative-path: Exported generic functions
relative-path: Exported generic functions
remove-xref-resolver: Exported functions
resolve-source-link: Exported generic functions
resolve-source-link: Exported generic functions
resolve-source-link: Exported generic functions
resolve-source-link: Exported generic functions
resolve-xref: Exported functions

S
skip-to-source-form: Internal functions
sort-definitions: Exported functions
split: Internal functions
stream-value: Internal functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
sub-results: Exported generic functions
subsystems: Exported generic functions
subsystems: Exported generic functions
system: Exported generic functions
system: Exported generic functions
system: Exported generic functions
system-field: Internal functions
system-name: Internal generic functions
system-name: Internal generic functions
system-name: Internal generic functions

T
template: Exported generic functions
template: Exported generic functions
template-data: Exported generic functions
template-data: Exported generic functions
template-data: Exported generic functions
template-data: Exported generic functions
template-data: Exported generic functions
tie-to-source: Exported functions
title: Exported generic functions
title: Exported generic functions
titleize: Internal functions

U
unlist: Internal functions
url-encode: Exported functions

W
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk: Exported generic functions
walk-atom: Exported generic functions
walk-atom: Exported generic functions
walk-atom: Exported generic functions
walk-bindings: Exported functions
walk-body: Exported functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-form: Exported generic functions
walk-implicit-progn: Exported functions
walk-lambda-like: Exported functions
with-stream: Exported macros
with-value-restart: Internal macros

X
xref: Exported generic functions
xref: Exported generic functions
xref: Exported generic functions
xref-resolver: Exported functions

Jump to:   (  
A   C   D   E   F   G   I   L   M   N   O   P   R   S   T   U   W   X  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
D   I   L   N   O   P   S   T  
Index Entry  Section

*
*before-load-packages*: Internal special variables
*default-template*: Exported special variables
*document-patterns*: Exported special variables
*image-patterns*: Exported special variables
*load-prohibited-systems*: Exported special variables
*loaded-extensions*: Internal special variables
*page*: Exported special variables
*pathname-type-type-map*: Internal special variables
*system-packages*: Internal special variables
*xref-resolvers*: Internal special variables

D
document: Exported classes
document-package: Exported classes

I
images: Exported classes
input: Exported classes
intern: Exported classes

L
language: Exported classes

N
name: Exported classes
namespaces: Exported classes

O
output: Exported classes
output: Exported classes

P
package: Exported classes
packages: Exported classes
pages: Exported classes
parent: Exported classes
project: Exported classes

S
Slot, document: Exported classes
Slot, document-package: Exported classes
Slot, images: Exported classes
Slot, input: Exported classes
Slot, intern: Exported classes
Slot, language: Exported classes
Slot, name: Exported classes
Slot, namespaces: Exported classes
Slot, output: Exported classes
Slot, output: Exported classes
Slot, package: Exported classes
Slot, packages: Exported classes
Slot, pages: Exported classes
Slot, parent: Exported classes
Slot, project: Exported classes
Slot, system: Exported conditions
Slot, system: Exported classes
Slot, title: Exported classes
Special Variable, *before-load-packages*: Internal special variables
Special Variable, *default-template*: Exported special variables
Special Variable, *document-patterns*: Exported special variables
Special Variable, *image-patterns*: Exported special variables
Special Variable, *load-prohibited-systems*: Exported special variables
Special Variable, *loaded-extensions*: Internal special variables
Special Variable, *page*: Exported special variables
Special Variable, *pathname-type-type-map*: Internal special variables
Special Variable, *system-packages*: Internal special variables
Special Variable, *xref-resolvers*: Internal special variables
system: Exported conditions
system: Exported classes

T
title: Exported classes

Jump to:   *  
D   I   L   N   O   P   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   E   I   N   P   S   T  
Index Entry  Section

C
Class, client: Internal classes
Class, compiled-page: Exported classes
Class, definitions-index-page: Exported classes
Class, environment: Exported classes
Class, input-page: Exported classes
Class, page: Exported classes
Class, placeholder: Exported classes
Class, project: Exported classes
Class, simple-page: Exported classes
Class, simple-project: Exported classes
Class, static-page: Exported classes
Class, system-page: Exported classes
Class, templated-page: Exported classes
client: Internal classes
compiled-page: Exported classes
Condition, no-known-output-directory: Exported conditions

D
definitions-index-page: Exported classes

E
environment: Exported classes

I
input-page: Exported classes

N
no-known-output-directory: Exported conditions

P
Package, staple: The staple package
Package, staple-code-parser: The staple-code-parser package
Package, staple-package-recording: The staple-package-recording package
page: Exported classes
placeholder: Exported classes
project: Exported classes

S
simple-page: Exported classes
simple-project: Exported classes
staple: The staple system
staple: The staple package
staple-code-parser: The staple-code-parser system
staple-code-parser: The staple-code-parser package
staple-package-recording: The staple-package-recording system
staple-package-recording: The staple-package-recording package
static-page: Exported classes
stream-designator: Exported types
System, staple: The staple system
System, staple-code-parser: The staple-code-parser system
System, staple-package-recording: The staple-package-recording system
system-page: Exported classes

T
templated-page: Exported classes
Type, stream-designator: Exported types

Jump to:   C   D   E   I   N   P   S   T