aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/sciteco.tmac
AgeCommit message (Collapse)AuthorFilesLines
2025-05-02grosciteco: folding in woman pagesRobin Haberkorn1-0/+23
* Support fold level configuration using `.SCITECO_FOLDLEVEL`. This sets the current output line as the fold header and all subsequent lines with the given fold level (until another `.SCITECO_FOLDLEVEL` instruction is encountered). * This is now done automatically for man's SH and SS macros, so the man-page based woman pages provide folding. * The folding margin is therefore now always enabled in fallback.teco_ini.
2025-03-31added tutorial document, which is automatically loaded on the first invocationRobin Haberkorn1-0/+5
* This is rendered with ms, so we now need the entire groff on Debian. This is not a big deal as it just adds a few kilobytes of build-time dependencies. Most platforms do not allow installation of some "groff-base" package anyway and always draw in the entire package. * sciteco.tmac has been extended to disable page breaks on ms. * The tutorial is installed like any other woman page and can be invoked interactively with ?tutorial$. * It is optimized to be still usable on a plain 80x24 terminal.
2024-11-10grosciteco: support .SCITECO_STARTSTYLING and .SCITECO_SETSTYLING macrosRobin Haberkorn1-1/+12
This could theoretically be used to apply Scintilla styles not natively and easily supported by grosciteco, eg. different fonts and font sizes.
2023-04-05sciteco.tmac: also set the LL register (refs #11)Robin Haberkorn1-1/+5
* Hopefully disables paragraph breaking in newer Groff versions, but needs to be tested.
2017-02-26more fixes for groff v1.19Robin Haberkorn1-3/+3
* fixes manpages, Groff warnings and building womanpages for older Groff versions. Groff v1.19 is in use eg. on FreeBSD 11. * tbl v1.19 has different column specifiers than on later versions. `X` cannot be used for expanded columns in these Groff versions.
2017-02-26fixup to 733e0126: fixed if-then-else in sciteco.tmacRobin Haberkorn1-1/+1
2017-02-22fixed womanpage-generation for Groff < v1.20Robin Haberkorn1-0/+14
* we had an undocumented dependency on Groff v1.20, since this version introduced the .device request. * this broke the womanpage generation e.g. on OS X 10.6. Even newer versions of OS X only appear to ship Groff v1.19. * Since it makes sense to support the Groff shipping with OS X, we work around this issue by reimplementing .device on platforms that lack it. * The fallback implementation still has subtle differences to the real .device, but they are acceptable for the time being.
2016-11-18implemented self-documenting (online) help systemRobin Haberkorn1-0/+65
* 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.