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. --- sample.teco_ini | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'sample.teco_ini') diff --git a/sample.teco_ini b/sample.teco_ini index 6360d14..9cc9e1c 100644 --- a/sample.teco_ini +++ b/sample.teco_ini @@ -18,9 +18,11 @@ EMQ[$SCITECOPATH]/session.tes M[lexer.auto] ! Set up margins ! - 33ESTEXTWIDTH9U.w - 5*Q.w,0ESSETMARGINWIDTHN - Q.w,2ESSETMARGINWIDTHN + [_:M[lexer.test.woman]]_"F + 33ESTEXTWIDTH9U.w + 5*Q.w,0ESSETMARGINWIDTHN + Q.w,2ESSETMARGINWIDTHN + ' 0,32ED ! fall through ! -- cgit v1.2.3