Re: [NTG-context] man pages for ConTeXt: looking for volunteers
Sietse wrote:
5. Lastly, I think it would be good to include a standard SEE ALSO block at the end of each man page, to list all the scripts we have man pages for.
Hans wrote:
sure, we can add stuff
How about this? <seealsos> <seealso name="context">Compile a ConTeXt file or recompile ConTeXt.</seealso> <seealso name="mtx-babel">Convert LaTeX Babel codes for Greek into UTF-8</seealso> <seealso name="mtx-base">ConTeXt TDS Management Tool (aka luatools)</seealso> <seealso name="mtx-cache">Manage the ConTeXt and MetaTeX cache</seealso> <seealso name="mtx-chars">Generate MkII character tables</seealso> <seealso name="mtx-check">Check ConTeXt file for syntax errors</seealso> <!-- FIXME what sort of color file? Example invocation (with existing file) would help. --> <seealso name="mtx-colors">Show International Color Consortium table for a file</seealso> <seealso name="mtx-context"> (See `context`)</seealso> <seealso name="mtx-epub">Create ePub zip file</seealso> <seealso name="mtx-fcd">Convenience script for fast directory-changing</seealso> <seealso name="mtx-flac">Collect Flac albums in XML file</seealso> <seealso name="mtx-fonts">Inspect and manage the ConTeXt font database</seealso> <seealso name="mtx-grep">A simple Lua-based grep</seealso> <seealso name="mtx-interface">Lists of ConTeXt commands (for text editors)</seealso> <seealso name="mtx-metapost">Compile MetaPost to PDF</seealso> <!-- FIXME what sort of processes? --> <seealso name="mtx-metatex">MetaTeX process management</seealso> <seealso name="mtx-modules">Extract `%D`-style documentation from ConTeXt module source files</seealso> <seealso name="mtx-package">Merge: replace loadmodule(...) calls with module contents</seealso> <seealso name="mtx-patterns">Produce files for ConTeXt describing hyphenation patters</seealso> <seealso name="mtx-pdf">Inspect metadata and font info of PDFs</seealso> <!-- FIXME needs better description? --> <seealso name="mtx-profile">LuaTeX profiler</seealso> <seealso name="mtx-rsync">Rsync helper script</seealso> <seealso name="mtxrun">MetaTeX factotum: run scripts and get info</seealso> <seealso name="mtx-scite">Convert spelling dictionaries to SciTE Lua format</seealso> <seealso name="mtx-server">Simple webserver</seealso> <seealso name="mtx-texworks">TeXworks startup script</seealso> <seealso name="mtx-timing">Process timing data after `context --timing` run</seealso> <seealso name="mtx-tools">Tools to glob directories into XML</seealso> <seealso name="mtx-unzip">Simple unzipper</seealso> <seealso name="mtx-update">Updating script for ConTeXt minimals, used by first-setup.sh</seealso> <!-- FIXME check mtx-watch description --> <seealso name="mtx-watch">Watch a file for changes</seealso> </seealsos>
On 3/26/2013 1:15 AM, Sietse Brouwer wrote:
Sietse wrote:
5. Lastly, I think it would be good to include a standard SEE ALSO block at the end of each man page, to list all the scripts we have man pages for.
Hans wrote:
sure, we can add stuff
How about this?
and where should that go into?
<seealsos> <seealso name="context">Compile a ConTeXt file or recompile ConTeXt.</seealso> <seealso name="mtx-babel">Convert LaTeX Babel codes for Greek into UTF-8</seealso> <seealso name="mtx-base">ConTeXt TDS Management Tool (aka luatools)</seealso> <seealso name="mtx-cache">Manage the ConTeXt and MetaTeX cache</seealso> <seealso name="mtx-chars">Generate MkII character tables</seealso> <seealso name="mtx-check">Check ConTeXt file for syntax errors</seealso> <!-- FIXME what sort of color file? Example invocation (with existing file) would help. --> <seealso name="mtx-colors">Show International Color Consortium table for a file</seealso> <seealso name="mtx-context"> (See `context`)</seealso> <seealso name="mtx-epub">Create ePub zip file</seealso> <seealso name="mtx-fcd">Convenience script for fast directory-changing</seealso> <seealso name="mtx-flac">Collect Flac albums in XML file</seealso> <seealso name="mtx-fonts">Inspect and manage the ConTeXt font database</seealso> <seealso name="mtx-grep">A simple Lua-based grep</seealso> <seealso name="mtx-interface">Lists of ConTeXt commands (for text editors)</seealso> <seealso name="mtx-metapost">Compile MetaPost to PDF</seealso> <!-- FIXME what sort of processes? --> <seealso name="mtx-metatex">MetaTeX process management</seealso> <seealso name="mtx-modules">Extract `%D`-style documentation from ConTeXt module source files</seealso> <seealso name="mtx-package">Merge: replace loadmodule(...) calls with module contents</seealso> <seealso name="mtx-patterns">Produce files for ConTeXt describing hyphenation patters</seealso> <seealso name="mtx-pdf">Inspect metadata and font info of PDFs</seealso> <!-- FIXME needs better description? --> <seealso name="mtx-profile">LuaTeX profiler</seealso> <seealso name="mtx-rsync">Rsync helper script</seealso> <seealso name="mtxrun">MetaTeX factotum: run scripts and get info</seealso> <seealso name="mtx-scite">Convert spelling dictionaries to SciTE Lua format</seealso> <seealso name="mtx-server">Simple webserver</seealso> <seealso name="mtx-texworks">TeXworks startup script</seealso> <seealso name="mtx-timing">Process timing data after `context --timing` run</seealso> <seealso name="mtx-tools">Tools to glob directories into XML</seealso> <seealso name="mtx-unzip">Simple unzipper</seealso> <seealso name="mtx-update">Updating script for ConTeXt minimals, used by first-setup.sh</seealso> <!-- FIXME check mtx-watch description --> <seealso name="mtx-watch">Watch a file for changes</seealso> </seealsos>
-- ----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com | www.pragma-pod.nl -----------------------------------------------------------------
Sietse wrote:
How about this See Also block
Hans wrote:
and where should that go into?
At the end of each man page, as a standard footer --- so that people
may discover the mtx scripts and their capabilities. You can also
reduce it to just a list of script names without descriptions:
context mtx-flac mtx-profile
mtx-babel mtx-fonts mtx-rsync
mtx-base mtx-grep mtxrun
mtx-cache mtx-interface mtx-scite
mtx-chars mtx-metapost mtx-server
mtx-check mtx-metatex mtx-texworks
mtx-colors mtx-modules mtx-tools
mtx-context mtx-package mtx-unzip
mtx-epub mtx-patterns mtx-update
mtx-fcd mtx-pdf mtx-watch
--Sietse
On 26 March 2013 10:38, Hans Hagen
On 3/26/2013 1:15 AM, Sietse Brouwer wrote:
Sietse wrote:
5. Lastly, I think it would be good to include a standard SEE ALSO block at the end of each man page, to list all the scripts we have man pages for.
Hans wrote:
sure, we can add stuff
How about this?
and where should that go into?
<seealsos> <seealso name="context">Compile a ConTeXt file or recompile ConTeXt.</seealso> <seealso name="mtx-babel">Convert LaTeX Babel codes for Greek into UTF-8</seealso> <seealso name="mtx-base">ConTeXt TDS Management Tool (aka luatools)</seealso> <seealso name="mtx-cache">Manage the ConTeXt and MetaTeX cache</seealso> <seealso name="mtx-chars">Generate MkII character tables</seealso> <seealso name="mtx-check">Check ConTeXt file for syntax errors</seealso> <!-- FIXME what sort of color file? Example invocation (with existing file) would help. --> <seealso name="mtx-colors">Show International Color Consortium table for a file</seealso> <seealso name="mtx-context"> (See `context`)</seealso> <seealso name="mtx-epub">Create ePub zip file</seealso> <seealso name="mtx-fcd">Convenience script for fast directory-changing</seealso> <seealso name="mtx-flac">Collect Flac albums in XML file</seealso> <seealso name="mtx-fonts">Inspect and manage the ConTeXt font database</seealso> <seealso name="mtx-grep">A simple Lua-based grep</seealso> <seealso name="mtx-interface">Lists of ConTeXt commands (for text editors)</seealso> <seealso name="mtx-metapost">Compile MetaPost to PDF</seealso> <!-- FIXME what sort of processes? --> <seealso name="mtx-metatex">MetaTeX process management</seealso> <seealso name="mtx-modules">Extract `%D`-style documentation from ConTeXt module source files</seealso> <seealso name="mtx-package">Merge: replace loadmodule(...) calls with module contents</seealso> <seealso name="mtx-patterns">Produce files for ConTeXt describing hyphenation patters</seealso> <seealso name="mtx-pdf">Inspect metadata and font info of PDFs</seealso> <!-- FIXME needs better description? --> <seealso name="mtx-profile">LuaTeX profiler</seealso> <seealso name="mtx-rsync">Rsync helper script</seealso> <seealso name="mtxrun">MetaTeX factotum: run scripts and get info</seealso> <seealso name="mtx-scite">Convert spelling dictionaries to SciTE Lua format</seealso> <seealso name="mtx-server">Simple webserver</seealso> <seealso name="mtx-texworks">TeXworks startup script</seealso> <seealso name="mtx-timing">Process timing data after `context --timing` run</seealso> <seealso name="mtx-tools">Tools to glob directories into XML</seealso> <seealso name="mtx-unzip">Simple unzipper</seealso> <seealso name="mtx-update">Updating script for ConTeXt minimals, used by first-setup.sh</seealso> <!-- FIXME check mtx-watch description --> <seealso name="mtx-watch">Watch a file for changes</seealso> </seealsos>
--
----------------------------------------------------------------- Hans Hagen | PRAGMA ADE Ridderstraat 27 | 8061 GH Hasselt | The Netherlands tel: 038 477 53 69 | voip: 087 875 68 74 | www.pragma-ade.com | www.pragma-pod.nl -----------------------------------------------------------------
participants (2)
-
Hans Hagen -
Sietse Brouwer