Package Tinaa - internal and external symbols

Part of:

asdf-system tinaa
See only external symbols

A simple, yet extensible, Common Lisp documentation package.

Package Tinaa uses the packages Anaphora, Common-Lisp, Defsystem-Compatibility, Lisp-Markup-Language-2, Metabang.Bind, Metabang.Cl-Containers, Metabang.Moptilities and Metabang.Utilities. It is also known as Doclisp. It has 370 total symbols and 12 external ones.

Condition

cannot-make-part

This error is signaled when a part cannot be created.

part-kind-unknown-error

Class

basic-doclisp-part
basic-page-writer
direct-dependency-edge
direct-package-edge
doclisp-asdf-system
doclisp-assembly

A part with sub-parts.

doclisp-class
doclisp-condition
doclisp-constant
doclisp-file
doclisp-function
doclisp-generic-function
doclisp-macro
doclisp-method
doclisp-package
doclisp-part

A part without pieces (a leaf).

doclisp-slot
doclisp-symbol
doclisp-variable
name-holder-mixin
other-dependency-edge
other-package-edge
page-writer-with-graphs
simple-page-writer
subpart-kind
tinaa-asdf-system-vertex
tinaa-edge
tinaa-graph
tinaa-package-vertex
tinaa-part-graph
tinaa-part-vertex
tinaa-vertex

Variable

*css-file*

If set, this should point to the CSS file that Tinaa should use.

*current-index*
*current-part*
*current-part-index*
*default-packages-to-ignore*
*document-file*
*document-root*
*document-stream*
*graph-image-format*

The image format to use for graph files

*graph-size-in-inches*
*graphviz-directory*

The location of the various GraphViz files. In particular, dot, neato, circo and twopi should liv...

*make-part-methods*

Used to help ensure that we don't use up the stack trying to find a good method... Probably too b...

*output-calls*
*packages-to-document*
*required-index-contents*
*root-part*
*short-documentation-length*

The number of characters of documentation to show in summaries.

*tinaa-home-page*
*tinaa-version*

Function

add-package-to-document
add-tinaa-link
any-indexes-p
build-index
build-index-letters
build-license-page
build-part-graph
build-permuted-index

A permuted index includes each n-word entry up to n times, at points corresponding to the use of ...

canonical-package-id
class-graph->dot

Returns a string describing graph in DOT format.

class-sorter
class-uninteresting-p
conditionp

Returns true if and only if thing is a condition

content-things-from-part

Returns a list of < kind name url > triples for the subparts of part that should be displayed in ...

display-arguments
display-function
display-list-of-potential-parts
display-part-for-index
document-system

Create TINAA documentation for a system. System-kind should be 'package or
some other value for ...

file-depth-below-root
filtered-package-symbols
find-name-and-email

Returns (as multiple values) a name and e-mail address as parsed from a string. Handles only “nam...

graph-file-name-for-part
ignore-package-p
index-file-name
index-for-kind-p
index-part-p
interesting-subclasses
interesting-superclasses
lml-insert-file
local-index-url
make-local-class-graph
make-string-of-size
map-parts-from-leaves
map-subpart-kinds
maybe-display-part
method-sorter
nice-package-name
ns-tlp
output-table-summary
packages-to-document
packages-to-ignore
part-can-have-documention-p
part-has-parents-p
part-symbol-name
parts-matching-symbol

Returns a list of parts in name-holder than have the same name as symbol

parts-with-no-documentation
pathname->unix
permuted-index-delimiter-p
permuted-index-locations
princ-n-spaces
relative-url

Returns a URL that points to the same things as url but relative to (url current-part)

root-parent

Go up the parent chain until there are no parents... that's the root.

set-flags
slot-writer-name
some-parent
stylesheet-url
subpart-info
symbol-count
symbol-name-tree
system-packages
tinaa-home
update-document-part-p
url->file

Returns a file spec for the url rooted at document-root. The URL must be delimited using forwar...

url-name
write-css-file
write-part-graph

Generic-Function

add-contents-link
add-part-vertex
build-contents-page
build-documentation
build-index-links
build-indexes
css-file-for-writer
depth-for-part
direct-instance
direct-parent
display-part

Output information about a part. Example modes are
:subpart-list, :detail, :summary.

doclisp-footer
doclisp-header
document-part-p
document-part-to-file
documentation-exists-p
edge-kinds-for-part-graph
find-part

Returns a existing part if it can be found.

finish-grovel
graph-part-p
grovel-part
include-in-contents-p
include-kind-in-index-p

Returns true if part should include kind in it's index.

index-kinds

Returns a list describing what indexes to generate for this part. This list is a list of lists of...

layout-engine-for-part
layout-graph-to-file
make-link-for
make-name-link-for
make-part

Make a part named 'name' of kind 'kind' whose parent is 'parent'.

make-part-graph
make-root-pointing-url
maybe-show-documentation
name-holder
output-table-summary-of-parts
part-documentation

Returns whatever documentation is available for part using the Common Lisp documentation function...

part-kind-abbreviation
part-name

Returns the name of the part as a string

partname-list

Returns a list of the names of the subparts of part of type 'part-kind'. Usually, these will be s...

short-documentation

Returns the first bit of the documentation for part.
Change short-documentation-length to deter...

show-part-parents

Generate HTML to show the parents of a part. Called for a part only when it actually has parents ...

span-class-for-part-name

Returns the class to be used when displaying the part's name.

start-grovel
string->html
subpart-kinds

Returns a list of the kinds of the subparts of assembly.
This is a list of instances of subpart-k...

system-files
url-for-part

Returns the url for the part, creating it if necessary.

Macro

documenting
documenting-page
with-html-output