From e7867fb0d9979c550e6e3d7597ece73b680c4af6 Mon Sep 17 00:00:00 2001 From: Robin Haberkorn Date: Fri, 26 Feb 2016 02:02:50 +0100 Subject: implemented self-documenting (online) help system * 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. --- lib/Makefile.am | 10 +++++++++- lib/lexers/woman.tes | 20 ++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 lib/lexers/woman.tes (limited to 'lib') diff --git a/lib/Makefile.am b/lib/Makefile.am index 53a9be8..a66aaef 100644 --- a/lib/Makefile.am +++ b/lib/Makefile.am @@ -11,9 +11,12 @@ colorschemedir = $(scitecolibdir)/colors dist_colorscheme_DATA = colors/terminal.tes \ colors/solarized.tes +lexerdir = $(scitecolibdir)/lexers + +# Lexer configurations for language +# syntax highlighting. # This list must be extended when adding # a new lexer configuration: -lexerdir = $(scitecolibdir)/lexers dist_lexer_DATA = lexers/verilog.tes \ lexers/php.tes \ lexers/pascal.tes \ @@ -85,3 +88,8 @@ dist_lexer_DATA = lexers/verilog.tes \ lexers/rust.tes \ lexers/blitzbasic.tes \ lexers/caml.tes + +# This lexer is responsible for styling +# womanpages and is thus useful even when omitting +# the syntax highlighting lexers. +dist_lexer_DATA += lexers/woman.tes diff --git a/lib/lexers/woman.tes b/lib/lexers/woman.tes new file mode 100644 index 0000000..23c6905 --- /dev/null +++ b/lib/lexers/woman.tes @@ -0,0 +1,20 @@ +!* + * Womanpage Lexing: These are internal or third-party + * on-line documentation files used by SciTECO. + * In contrast to normal lexers, Womanpages are styled + * using a SciTECO macro that ships with the woman-page + * document (.woman.tec). + *! + +@[lexer.test.woman]{ + :EN*.womanQ* +} + +@[lexer.set.woman]{ + 1ESSETWRAPMODE + 1ESSETWRAPINDENTMODE + 10,1#4ESSETYCARETPOLICY + 32ESSTYLESETFONTTimes ESSTYLECLEARALL + + 1:EN*Q*.tec"S EMQ*.tec ' +} -- cgit v1.2.3