![]() |
![]()
| ![]() |
![]()
NAMEgrosciteco -- GNU roff post-processor for SciTECO SYNOPSIS
DESCRIPTIONgrosciteco is a post-processor for GNU roff which works similar to groff's grotty post-processor and driver. Similarily, grosciteco is a plain-text formatter — but since it lays out the document itself and is written in the SciTECO language, it will generate an additional SciTECO macro that can be executed to style the plain-text document. The plain-text document will usually have the extension “woman” and the accompanying SciTECO macro will have the extension “woman.tec”. Both files combined are called womanpage since they are commonly SciTECO-formatted man pages. Furthermore, womanpages can be indexed by search terms (called topics). A per-file topic index is generated as part of the “woman.tec” output file. Users of grosciteco can define topics in troff markup using the SCITECO_TOPIC troff macro defined in the “sciteco.tmac” macro package. This macro package should always be loaded when processing troff documents which are going to be post-processed by grosciteco. Preparing a womanpage for display is usually performed automatically by SciTECO's “woman.tes” lexer definition whenever you open a “*.woman” file in SciTECO. womanpages are recommended to be installed into a special directory in SciTECO's standard library. The SciTECO command ? provides an online help feature which gives fast access to properly-installed womanpages. It builds a global topic index of all womanpages installed in the $SCITECOPATH/women directory. grosciteco is thus a central component in providing SciTECO's help system, in documenting internal commands, the SciTECO standard library macros and third-party macro packages. The generation of womanpages at compile-time means that no troff is required by end users to browse documentation within SciTECO. OPTIONS
SPECIAL TROFF MACROStroff documents should be processed with the “sciteco.tmac” macro package that also ships with SciTECO. It tweaks formatting for display in SciTECO (assuming that the lexer system for womanpages is in place) and provides the following troff macros that can be called by documentation authors:
These public macros will be ignored if “sciteco.tmac” is not loaded, so it is safe to use them in man pages that are also installed into the system. Note that “sciteco.tmac” is not installed into the standard GNU roff macro search directories, but into SciTECO data directory at “/usr/local/share/gsciteco”. It must thus be moved or linked manually into one of the search paths, or the data dir must be added to the search paths. Alternatively, you may also add it to the groff command line with the -M option. EXAMPLESThe following UNIX shell commands will generate the womanpage for a SciTECO macro package with a man page called great-macro.tes(7sciteco): groff -Z -Kutf-8 -Tutf8 -man -M/usr/local/share/gsciteco -msciteco \ The resulting files should be installed to /usr/local/share/gsciteco/lib/women (or wherever $SCITECOPATH points to at runtime) to make the files accessible in SciTECO's online-help system. BUGSgrosciteco is quite slow, although this is a SciTECO issue. The pic(1) preprocessor is poorly supported and diacritics may not be rendered properly. SEE ALSO
AUTHORThis manpage and the SciTECO program was written by Robin Haberkorn.
|