tcl-quill 0.3.0: Quill Project Automation System for Tcl/Tk

quilldoc(n): Quill Document Processor -- quill(n)

SYNOPSIS
DESCRIPTION
Man Page Links
COMMANDS
MACROS
AUTHOR
SEE ALSO

SYNOPSIS

package require quill 0.3.0
namespace import ::quill::*
quilldoc reset
quilldoc format infile ?options?
quilldoc eval args...
quilldoc expand text
quilldoc lb
quilldoc rb

DESCRIPTION

The quilldoc(n) module provides formatting for traditional documents with section numbers and cross-references written in quilldoc(5) format. quilldoc(5) is an HTML-like format in which the "tags" are macro(n) macros. quilldoc(n) formats the document nicely, and adds a table of contents and cross-reference links.

At present, quilldoc(n) produces HTML output only; however, there is no reason why it could not be provided with multiple back-ends, each supporting a different output format.

Man Page Links

quilldoc(n) supports links to manpage(5) manpages provided that the -manroot option is set when calling format.

COMMANDS

quilldoc(n) defines the following commands:

quilldoc reset
Initializes the module, and creates its internal macro(n) processor.

quilldoc format infile ?options?
Formats the given infile, producing (by default) a matching ".html" file in the same directory.

The following options may be used:

-outfile outfile
Specifies the output file name, overriding the default.

-header text
Specifies the text for the banner at the top of the document. Defaults to "Project Documentation". This text should usually identify the project name and version.

-version version
Specifies the project version number. It can be accessed using the version macro.

-manroot manroot
Specifies the root of the man page tree (i.e., the parent of the "mansec" directories) relative to the location of the output file. Defaults to ".".

quilldoc eval args...
quilldoc expand text
quilldoc lb
quilldoc rb
These commands are all delegated to the object's internal instance of macro(n). eval and expand are primarily useful for debugging. Be sure to call reset prior to any of these commands.

MACROS

The macros used to write Quill documents are defined in the quilldoc(5) man page.

AUTHOR

Will Duquette

SEE ALSO

quill(n), quilldoc(5), macro(n), manpage(5).
Generated from quilldoc.manpage on Sat Nov 08 09:29:59 PST 2014