diff options
| author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2016-02-26 02:02:50 +0100 |
|---|---|---|
| committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2016-11-18 07:05:52 +0100 |
| commit | e7867fb0d9979c550e6e3d7597ece73b680c4af6 (patch) | |
| tree | dc7a273abc5dd75ecdd94bc62419cd966f38b6d0 /configure.ac | |
| parent | c0fe49457d37e4c51cd4fd829895a60ae24bc8af (diff) | |
| download | sciteco-e7867fb0d9979c550e6e3d7597ece73b680c4af6.tar.gz | |
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.
Diffstat (limited to 'configure.ac')
| -rw-r--r-- | configure.ac | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/configure.ac b/configure.ac index dd37664..517f4a0 100644 --- a/configure.ac +++ b/configure.ac @@ -56,6 +56,7 @@ AC_PROG_CXX AC_PROG_CC AC_PROG_CC_C99 AC_PROG_GREP +AC_PROG_SED AC_PROG_INSTALL # Additionally required by the Scintilla build process: @@ -82,8 +83,20 @@ if [[ x$DATE = x ]]; then AC_MSG_ERROR([Required tool date not found!]) fi -# not necessarily required (depends on --enable-html-manual) +# SciTECO's online help system is based on Troff. +# Its `grosciteco` postprocessor practically only works with GNU roff. +# There are other good Troff implementations like Heirloom Troff, +# but the postprocessor relies on ditroff generating +# intermediate output in TTY/nroff mode. +# In the original UNIX Troff, nroff is a distinct implementation +# that does not work with postprocessors. +# +# Groff may also be used to generate HTML versions of +# sciteco(1) and sciteco(7). AC_CHECK_PROG(GROFF, groff, groff) +if [[ x$GROFF = x ]]; then + AC_MSG_ERROR([GNU roff required!]) +fi # not necessarily required (depends on --enable-developer-doc) AC_CHECK_PROG(DOXYGEN, doxygen, doxygen) @@ -295,10 +308,6 @@ AC_ARG_ENABLE(html-manual, AS_HELP_STRING([--enable-html-manual], [Generate and install HTML manuals using Groff [default=no]]), [html_man=$enableval], [html_man=no]) -if [[ $html_man = yes -a x$GROFF = x ]]; then - AC_MSG_ERROR([Enabled generating HTML manuals, but Groff cannot be found! - Try --disable-html-manual.]) -fi AM_CONDITIONAL(BUILD_HTMLMAN, [test $html_man = yes]) AC_ARG_ENABLE(developer-doc, |