<feed xmlns='http://www.w3.org/2005/Atom'>
<title>sciteco/doc/generate-docs.tes, branch v2.5.2</title>
<subtitle>Scintilla-based Text Editor and COrrector</subtitle>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/'/>
<entry>
<title>the manual generator (generator-docs.tes) has been cleaned up and is now called tedoc.tes</title>
<updated>2016-11-18T06:25:00+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2016-11-16T15:30:46+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=be39ab9fdbaba118ece1dcc3e064c8452fcdd277'/>
<id>be39ab9fdbaba118ece1dcc3e064c8452fcdd277</id>
<content type='text'>
 * some code simplifications
 * it now supports command line arguments via getopt.tes.
 * the -C flag enabled C/C++ mode.
   By default tedoc parses SciTECO code which means it can be used
   to document macro packages as well.
 * Therefore it is installed as a separate tool now.
   It may be used as a Groff preprocessor for third-party macro
   authors to generate (wo)man pages.
 * there's a man page tedoc.tes(1)
 * The troff placeholder macro is now called ".TEDOC".
 * Help topics can now be specified after the starting comment /*$ or !*$.
   Topics have been defined for all built-in commands.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
 * some code simplifications
 * it now supports command line arguments via getopt.tes.
 * the -C flag enabled C/C++ mode.
   By default tedoc parses SciTECO code which means it can be used
   to document macro packages as well.
 * Therefore it is installed as a separate tool now.
   It may be used as a Groff preprocessor for third-party macro
   authors to generate (wo)man pages.
 * there's a man page tedoc.tes(1)
 * The troff placeholder macro is now called ".TEDOC".
 * Help topics can now be specified after the starting comment /*$ or !*$.
   Topics have been defined for all built-in commands.
</pre>
</div>
</content>
</entry>
<entry>
<title>implemented self-documenting (online) help system</title>
<updated>2016-11-18T06:05:52+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2016-02-26T01:02:50+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=e7867fb0d9979c550e6e3d7597ece73b680c4af6'/>
<id>e7867fb0d9979c550e6e3d7597ece73b680c4af6</id>
<content type='text'>
 * 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.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
 * 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.
</pre>
</div>
</content>
</entry>
<entry>
<title>changed syntax for long Q-Register names: use [] brackets instead of {}</title>
<updated>2014-11-01T23:06:28+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2014-11-01T23:06:28+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=a395c9df173b53e095f1a20d6bc583063cdb60c7'/>
<id>a395c9df173b53e095f1a20d6bc583063cdb60c7</id>
<content type='text'>
this breaks many existing scripts, and means you may have to rebuild SciTECO
with ./configure --enable-bootstrap

The syntax of SciTECO might change in backwards-incompatible until
version 1.0 is released.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
this breaks many existing scripts, and means you may have to rebuild SciTECO
with ./configure --enable-bootstrap

The syntax of SciTECO might change in backwards-incompatible until
version 1.0 is released.
</pre>
</div>
</content>
</entry>
<entry>
<title>use new ^E\ string building character for arrays and to simplify number insertions</title>
<updated>2013-03-17T17:46:55+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2013-03-17T17:46:55+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=fee2f8c935e6a9675ac4b0e1559a564728e681e5'/>
<id>fee2f8c935e6a9675ac4b0e1559a564728e681e5</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>generate-docs: marker looks like a Troff request now</title>
<updated>2013-03-16T17:07:33+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2013-03-13T16:20:32+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=1298a5da2ee0a99403a7ccd8df09e2520bc0156a'/>
<id>1298a5da2ee0a99403a7ccd8df09e2520bc0156a</id>
<content type='text'>
it is customary for Troff preprocessors to interpret special preprocessor requests
instead of special comments
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
it is customary for Troff preprocessors to interpret special preprocessor requests
instead of special comments
</pre>
</div>
</content>
</entry>
<entry>
<title>documented generate-docs.tes Troff preprocessor</title>
<updated>2013-03-16T17:07:30+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2013-03-16T16:42:14+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=d619d66b47a4788bf3ac9fcb3faf08a8def98a95'/>
<id>d619d66b47a4788bf3ac9fcb3faf08a8def98a95</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>first draft of TECO command documentation generator</title>
<updated>2013-03-16T17:07:30+00:00</updated>
<author>
<name>Robin Haberkorn</name>
<email>robin.haberkorn@googlemail.com</email>
</author>
<published>2013-02-26T15:35:08+00:00</published>
<link rel='alternate' type='text/html' href='https://git.fmsbw.de/sciteco/commit/?id=8a0a8a49472dc879188215838e83ae00fc78fb3f'/>
<id>8a0a8a49472dc879188215838e83ae00fc78fb3f</id>
<content type='text'>
 * the language reference is a manually written man-page template
 * containing special references for generated documentation (\#$...)
 * SciTECO script generate-docs.tes extracts TECO comments (/*$ ... */)
   from all source files and transforms them to Troff requests that are
   inserted into the document template.
 * TECO doc comments are a rather sophisticated markup:
   * first part until empty line is called header: simplified command syntax descriptions
   * the rest is called body: &lt;identifier&gt; is automatically underlined,
     empty lines generate new paragraphs, lines beginning with "-" or numbers
     denote an indented unordered or numbered list item.
   * regular Troff requests/macros can be used for more sophisticated markup
   * since Autoconf substitutions are performed on the generated man-page,
     @VARIABLEs@ may be used in doc comments as well
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
 * the language reference is a manually written man-page template
 * containing special references for generated documentation (\#$...)
 * SciTECO script generate-docs.tes extracts TECO comments (/*$ ... */)
   from all source files and transforms them to Troff requests that are
   inserted into the document template.
 * TECO doc comments are a rather sophisticated markup:
   * first part until empty line is called header: simplified command syntax descriptions
   * the rest is called body: &lt;identifier&gt; is automatically underlined,
     empty lines generate new paragraphs, lines beginning with "-" or numbers
     denote an indented unordered or numbered list item.
   * regular Troff requests/macros can be used for more sophisticated markup
   * since Autoconf substitutions are performed on the generated man-page,
     @VARIABLEs@ may be used in doc comments as well
</pre>
</div>
</content>
</entry>
</feed>
