6.1.3 Functions

Function: configuration KEY

Return KEY’s value in the current Declt configuration.

Package

net.didierverna.declt.setup

Source

setup.lisp (file)

Function: configure KEY VALUE

Set KEY to VALUE in the current Declt configuration.

Package

net.didierverna.declt.setup

Source

setup.lisp (file)

Function: declt SYSTEM-NAME &key LIBRARY-NAME TAGLINE VERSION CONTACT COPYRIGHT-YEARS LICENSE INTRODUCTION CONCLUSION TEXI-NAME TEXI-DIRECTORY INFO-NAME HYPERLINKS DECLT-NOTICE &aux SYSTEM CURRENT-TIME-STRING CONTACT-NAMES CONTACT-EMAILS

Generate a reference manual in Texinfo format for ASDF SYSTEM-NAME. SYSTEM-NAME is an ASDF system designator.

The following keyword arguments are available.
- LIBRARY-NAME: name of the library being documented. Defaults to the system name.
- TAGLINE: small text to be used as the manual’s subtitle. Defaults to the system long name or description.
- VERSION: version information. Defaults to the system version.
- CONTACT: contact information. Defaults to the system maintainer(s) and author(s), or "John Doe". Accepts an author string of the form
"My Name[ <my@address>]", or a list of such.

- COPYRIGHT-YEARS: copyright years information or NIL. Defaults to the current year.
- LICENSE: license information. Defaults to NIL. Also accepts :mit, :boost, :bsd, :gpl, and :lgpl.
- INTRODUCTION: introduction chapter contents or NIL. Defaults to NIL.
- CONCLUSION: conclusion chapter contents or NIL. Defaults to NIL.

- TEXI-NAME: Texinfo file basename sans extension. Defaults to the system name.
- TEXI-DIRECTORY: Texinfo file directory. Defaults to the current directory. - INFO-NAME: Info file basename sans extension. Defaults to TEXI-NAME.
- HYPERLINKS: create hyperlinks to files or directories. Defaults to NIL. - DECLT-NOTICE: small credit paragraph to Declt, or NIL. Defaults to :long. Also accepts :short.

INTRODUCTION and CONCLUSION are currently expected to be in Texinfo format.

Package

net.didierverna.declt

Source

declt.lisp (file)

Function: nickname-package &optional NICKNAME

Add NICKNAME (:DECLT by default) to the :NET.DIDIERVERNA.DECLT package.

Package

net.didierverna.declt

Source

meta.lisp (file)

Function: version &optional TYPE

Return the current version of Declt.
TYPE can be one of :number, :short or :long.

A version number is computed as major*10000 + minor*100 + patchlevel, leaving two digits for each level. Alpha, beta and rc status are ignored in version numbers.

A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel. Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored in the output, so that 1.3.0 appears as just 1.3.

A long version is something like
1.3 {alpha,beta,release candidate,patchlevel} 4 "James T. Kirk". As for the short version, a patchlevel of 0 is ignored in the output.

Package

net.didierverna.declt.setup

Source

setup.lisp (file)