The litterae Reference Manual

Table of Contents

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

The litterae Reference Manual

This is the litterae Reference Manual, version 0.3.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 14:22:08 2020 GMT+0.


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

1 Introduction

Litterae

Documentation generator

Work in progress


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

2 Systems

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


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

2.1 litterae

Author

Stefan Devai <stedevai@gmail.com>

License

MIT

Description

Beautiful documentation generation.

Version

0.3.0

Dependencies
Source

litterae.asd (file)

Component

source (module)


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

3 Modules

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


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

3.1 litterae/source

Parent

litterae (system)

Location

source/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 litterae.asd

Location

litterae.asd

Systems

litterae (system)


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

4.1.2 litterae/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

litterae


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

4.1.3 litterae/source/config.lisp

Dependency

package.lisp (file)

Parent

source (module)

Location

source/config.lisp

Internal Definitions

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

4.1.4 litterae/source/templates/index.lisp

Dependency

config.lisp (file)

Parent

source (module)

Location

source/templates/index.lisp

Internal Definitions

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

4.1.5 litterae/source/litterae.lisp

Dependency

templates/index.lisp (file)

Parent

source (module)

Location

source/litterae.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 litterae

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Functions

Function: g SYSTEM-NAME &key PATH CONFIG

Generates static HTML documentation for a ‘system-name’.

Package

litterae

Source

litterae.lisp (file)

Function: generate SYSTEM-NAME &key PATH CONFIG

Generates static HTML documentation for a **system-name**.

Package

litterae

Source

litterae.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *asdf-system*

Hold’s the system’s asdf information.

Package

litterae

Source

config.lisp (file)

Special Variable: *config-filename*

Holds the default config filename.

Package

litterae

Source

config.lisp (file)

Special Variable: *docstrings-as-markdown?*

If true, docstrings will be parsed as markdown, otherwise it uses the string as it is.

Package

litterae

Source

config.lisp (file)

Special Variable: *index*

Holds raw information about a system provided by docparser library.

Package

litterae

Source

config.lisp (file)

Special Variable: *symbols*

Structured information about the system’s symbols.

Package

litterae

Source

config.lisp (file)

Special Variable: *system-name*

Holds system’s name as symbol.

Package

litterae

Source

config.lisp (file)


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

6.2.2 Macros

Macro: do-node-lists (PKG-HASH) &body BODY

Iterates through lists of nodes in a ‘package-hash’ contained in ‘*index’.

Package

litterae

Source

litterae.lisp (file)

Macro: do-package-hashes (PKG PKG-HASH) &body BODY

Iterates through the package hashes in ‘*index*’

Package

litterae

Source

litterae.lisp (file)

Macro: set-single-config PARAMETER KEYWORD HASH-TABLE

Sets the value of **parameter** to the value of **keyword** in **hash-table** only if the keyword exists.

Package

litterae

Source

config.lisp (file)


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

6.2.3 Functions

Function: build-symbols-hash ()

Stores in ‘*symbols*’ a hash of hashes of lists: a hash of package names, which each value contains a hash of class names which, each value contains a list of node names.

Package

litterae

Source

litterae.lisp (file)

Function: format-lambda-list LST

Formats a lambda list ‘lst‘ and returns it as a string.

Package

litterae

Source

litterae.lisp (file)

Function: format-lambda-list-html LAMBDA-STRING

Returns a lambda list string with proper formated HTML.

Package

litterae

Source

litterae.lisp (file)

Function: gen-html-node-item NODE ID PKG

Returns each docparser node formated as HTML.

Package

litterae

Source

litterae.lisp (file)

Function: generate-html PATH

Generates HTML for the contents of a parsed system in ‘*symbols*’.

Package

litterae

Source

litterae.lisp (file)

Function: generate-html-index PATH

Generates index.html in ‘path’.

Package

litterae

Source

litterae.lisp (file)

Function: generate-html-index-body ()

Generates the body content for the index page.

Package

litterae

Source

litterae.lisp (file)

Function: generate-id ELEMENT

Generates an id string for html given an element in the format ‘(list :id 0 :name some-name)‘.

Package

litterae

Source

litterae.lisp (file)

Function: generate-list &key ELEMENTS CHILD-LIST? ELEMENT-FORMAT

Generates a list with ‘elements’. If ‘child-list?’ is true, it uses the first element
of ‘elements’ (car) as the title and the other elements as lines of a new list. If child-list? is false, then each element in ‘elements’ will be a list.
element-format allows to customize how the element will be printed.

Package

litterae

Source

litterae.lisp (file)

Function: get-lambda-list NODE PKG

If the node is of type operator-node, the function returns its lambda list. Otherwise it returns the node-name as a string.

Package

litterae

Source

litterae.lisp (file)

Function: get-node-type-string NODE-TYPE &key PLURAL?

Return a string of ‘node-type’ for headers. If ‘plural’ is non nil, it returns its plural version.

Package

litterae

Source

litterae.lisp (file)

Function: has-attr? ATTR

Return true if the attribute ‘attr’ holds a value, false otherwise.

Package

litterae

Source

templates/index.lisp (file)

Function: html-api-docs ()

Returns the main API documentation content as a lsx object.

Package

litterae

Source

litterae.lisp (file)

Function: html-hero ()

Generates the Hero HTML.

Package

litterae

Source

litterae.lisp (file)

Function: html-readme ()

Searches for a README file in the system’s directory and returns it as a HTML string.

Package

litterae

Source

litterae.lisp (file)

Function: html-sidebar ()

Returns the sidebar used to navigate through the API.

Package

litterae

Source

litterae.lisp (file)

Function: initialize-system-information SYSTEM-NAME
Package

litterae

Source

litterae.lisp (file)

Function: load-config &optional FILEPATH

Loads config contained in **filepath**. If it’s nil, searches for a default config file to load.

Package

litterae

Source

config.lisp (file)

Function: make-index-template ()

Creates a object instance for ‘index-template’.

Package

litterae

Source

litterae.lisp (file)

Function: parse-markdown-docstring DOCSTRING

Returns a **docstring** in markdown format as a HTML string.

Package

litterae

Source

litterae.lisp (file)

Function: read-markdown FILEPATH

Reads and parses a markdown file located in ‘filepath’.

Package

litterae

Source

litterae.lisp (file)

Function: search-and-load-config-file ()

If a default config file exists, return its contents. Otherwise returns nil.

Package

litterae

Source

config.lisp (file)

Function: set-config CONFIG

Sets configs parameters from **config**, a parsed yaml file. Always returns t to indicate that a new config was set.

Package

litterae

Source

config.lisp (file)


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

6.2.4 Classes

Class: index-template ()
Package

litterae

Source

templates/index.lisp (file)

Direct superclasses

template (class)

Direct methods

render-object (method)

Direct slots
Slot: title
Initargs

:title

Slot: description
Initargs

:description

Slot: url
Initargs

:url

Slot: body
Initargs

:body

Slot: lang
Initargs

:lang

Initform

"en"


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, litterae.asd: The litterae․asd file
File, Lisp, litterae/source/config.lisp: The litterae/source/config․lisp file
File, Lisp, litterae/source/litterae.lisp: The litterae/source/litterae․lisp file
File, Lisp, litterae/source/package.lisp: The litterae/source/package․lisp file
File, Lisp, litterae/source/templates/index.lisp: The litterae/source/templates/index․lisp file

L
Lisp File, litterae.asd: The litterae․asd file
Lisp File, litterae/source/config.lisp: The litterae/source/config․lisp file
Lisp File, litterae/source/litterae.lisp: The litterae/source/litterae․lisp file
Lisp File, litterae/source/package.lisp: The litterae/source/package․lisp file
Lisp File, litterae/source/templates/index.lisp: The litterae/source/templates/index․lisp file
litterae.asd: The litterae․asd file
litterae/source: The litterae/source module
litterae/source/config.lisp: The litterae/source/config․lisp file
litterae/source/litterae.lisp: The litterae/source/litterae․lisp file
litterae/source/package.lisp: The litterae/source/package․lisp file
litterae/source/templates/index.lisp: The litterae/source/templates/index․lisp file

M
Module, litterae/source: The litterae/source module

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   B   D   F   G   H   I   L   M   P   R   S  
Index Entry  Section

B
build-symbols-hash: Internal functions

D
do-node-lists: Internal macros
do-package-hashes: Internal macros

F
format-lambda-list: Internal functions
format-lambda-list-html: Internal functions
Function, build-symbols-hash: Internal functions
Function, format-lambda-list: Internal functions
Function, format-lambda-list-html: Internal functions
Function, g: Exported functions
Function, gen-html-node-item: Internal functions
Function, generate: Exported functions
Function, generate-html: Internal functions
Function, generate-html-index: Internal functions
Function, generate-html-index-body: Internal functions
Function, generate-id: Internal functions
Function, generate-list: Internal functions
Function, get-lambda-list: Internal functions
Function, get-node-type-string: Internal functions
Function, has-attr?: Internal functions
Function, html-api-docs: Internal functions
Function, html-hero: Internal functions
Function, html-readme: Internal functions
Function, html-sidebar: Internal functions
Function, initialize-system-information: Internal functions
Function, load-config: Internal functions
Function, make-index-template: Internal functions
Function, parse-markdown-docstring: Internal functions
Function, read-markdown: Internal functions
Function, search-and-load-config-file: Internal functions
Function, set-config: Internal functions

G
g: Exported functions
gen-html-node-item: Internal functions
generate: Exported functions
generate-html: Internal functions
generate-html-index: Internal functions
generate-html-index-body: Internal functions
generate-id: Internal functions
generate-list: Internal functions
get-lambda-list: Internal functions
get-node-type-string: Internal functions

H
has-attr?: Internal functions
html-api-docs: Internal functions
html-hero: Internal functions
html-readme: Internal functions
html-sidebar: Internal functions

I
initialize-system-information: Internal functions

L
load-config: Internal functions

M
Macro, do-node-lists: Internal macros
Macro, do-package-hashes: Internal macros
Macro, set-single-config: Internal macros
make-index-template: Internal functions

P
parse-markdown-docstring: Internal functions

R
read-markdown: Internal functions

S
search-and-load-config-file: Internal functions
set-config: Internal functions
set-single-config: Internal macros

Jump to:   B   D   F   G   H   I   L   M   P   R   S  

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

A.3 Variables

Jump to:   *  
B   D   L   S   T   U  
Index Entry  Section

*
*asdf-system*: Internal special variables
*config-filename*: Internal special variables
*docstrings-as-markdown?*: Internal special variables
*index*: Internal special variables
*symbols*: Internal special variables
*system-name*: Internal special variables

B
body: Internal classes

D
description: Internal classes

L
lang: Internal classes

S
Slot, body: Internal classes
Slot, description: Internal classes
Slot, lang: Internal classes
Slot, title: Internal classes
Slot, url: Internal classes
Special Variable, *asdf-system*: Internal special variables
Special Variable, *config-filename*: Internal special variables
Special Variable, *docstrings-as-markdown?*: Internal special variables
Special Variable, *index*: Internal special variables
Special Variable, *symbols*: Internal special variables
Special Variable, *system-name*: Internal special variables

T
title: Internal classes

U
url: Internal classes

Jump to:   *  
B   D   L   S   T   U  

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

A.4 Data types

Jump to:   C   I   L   P   S  
Index Entry  Section

C
Class, index-template: Internal classes

I
index-template: Internal classes

L
litterae: The litterae system
litterae: The litterae package

P
Package, litterae: The litterae package

S
System, litterae: The litterae system

Jump to:   C   I   L   P   S