Age | Commit message (Collapse) | Author | Files | Lines |
|
called tedoc.tes
* some code simplifications
* it now supports command line arguments via getopt.tes.
* the -C flag enabled C/C++ mode.
By default tedoc parses SciTECO code which means it can be used
to document macro packages as well.
* Therefore it is installed as a separate tool now.
It may be used as a Groff preprocessor for third-party macro
authors to generate (wo)man pages.
* there's a man page tedoc.tes(1)
* The troff placeholder macro is now called ".TEDOC".
* Help topics can now be specified after the starting comment /*$ or !*$.
Topics have been defined for all built-in commands.
|
|
* the new "?" (help) command can be used to look up
help topics.
* help topics are index from $SCITECOPATH/women/*.woman.tec
files.
* looking up a help topic opens the corresponding "womanpage"
and jumps to the position of the topic (it acts like an anchor
into the document).
* styling is performed by *.woman.tec files.
* Setting up the Scintilla view and munging the *.tec file
is performed by the new "woman.tes" lexer.
On supporting UIs (Gtk), womanpages are shown in a variable-width
font.
* Woman pages are usually not hand-written, but generated from manpages.
A special Groff post-processor grosciteco has been introduced for this
purpose. It is much like grotty, but can output SciTECO macros for styling
the document (ie. the *.woman.tec files).
It is documented in its own man-page.
* grosciteco also introduces sciteco.tmac - special Troff macros
for controlling the formatting of the document in SciTECO.
It also defines .SCITECO_TOPIC which can be used to mark up
help topics/terms in Troff markup.
* Woman pages are generated/formatted by grosciteco at compile-time, so
they will work on platforms without Groff (ie. as on windows).
* Groff has been added as a hard compile-time requirement.
* The sciteco(1) and sciteco(7) man pages have been augmented with
help topic anchors.
|
|
this breaks many existing scripts, and means you may have to rebuild SciTECO
with ./configure --enable-bootstrap
The syntax of SciTECO might change in backwards-incompatible until
version 1.0 is released.
|
|
insertions
|
|
it is customary for Troff preprocessors to interpret special preprocessor requests
instead of special comments
|
|
|
|
* the language reference is a manually written man-page template
* containing special references for generated documentation (\#$...)
* SciTECO script generate-docs.tes extracts TECO comments (/*$ ... */)
from all source files and transforms them to Troff requests that are
inserted into the document template.
* TECO doc comments are a rather sophisticated markup:
* first part until empty line is called header: simplified command syntax descriptions
* the rest is called body: <identifier> is automatically underlined,
empty lines generate new paragraphs, lines beginning with "-" or numbers
denote an indented unordered or numbered list item.
* regular Troff requests/macros can be used for more sophisticated markup
* since Autoconf substitutions are performed on the generated man-page,
@VARIABLEs@ may be used in doc comments as well
|