* man pages for ConTeXt: looking for volunteers
@ 2013-03-21 11:59 Mojca Miklavec
2013-03-21 13:15 ` Marco Patzer
2013-03-21 14:44 ` Sietse Brouwer
0 siblings, 2 replies; 7+ messages in thread
From: Mojca Miklavec @ 2013-03-21 11:59 UTC (permalink / raw)
To: mailing list for ConTeXt users
Dear users,
In preparation of this year's TeX Live release, it would be nice to
also revise man pages a bit.
Hans just implemented auto-conversion of help into man pages for the
lua scripts. So the options are described as they should be, but if
there are any volunteers to help polishing out and provide either more
extensive descriptions, examples, ... or overall improvements, you are
invited to leave some feedback or provide some help (additional
text/descriptions or syntax corrections).
The old man pages are at
http://svn.contextgarden.net/suite/man/
and the new (possibly still experimental) man pages are now part of
ConTeXt (see doc/context/scripts).
Mojca
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: man pages for ConTeXt: looking for volunteers
2013-03-21 11:59 man pages for ConTeXt: looking for volunteers Mojca Miklavec
@ 2013-03-21 13:15 ` Marco Patzer
2013-03-21 14:44 ` Sietse Brouwer
1 sibling, 0 replies; 7+ messages in thread
From: Marco Patzer @ 2013-03-21 13:15 UTC (permalink / raw)
To: ntg-context
[-- Attachment #1.1: Type: text/plain, Size: 773 bytes --]
On 2013–03–21 Mojca Miklavec wrote:
> In preparation of this year's TeX Live release, it would be nice to
> also revise man pages a bit.
>
> Hans just implemented auto-conversion of help into man pages for the
> lua scripts. So the options are described as they should be, but if
> there are any volunteers to help polishing out and provide either more
> extensive descriptions, examples, ... or overall improvements, you are
> invited to leave some feedback or provide some help (additional
> text/descriptions or syntax corrections).
Just a small correction in mtxrun.{xml,man,html}:
--timedrun run a script an time its run
This should be rephrased, although I don't have suggestions since I
have no clue what this option is for.
Marco
[-- Attachment #1.2: Digital signature --]
[-- Type: application/pgp-signature, Size: 490 bytes --]
[-- Attachment #2: Type: text/plain, Size: 485 bytes --]
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: man pages for ConTeXt: looking for volunteers
2013-03-21 11:59 man pages for ConTeXt: looking for volunteers Mojca Miklavec
2013-03-21 13:15 ` Marco Patzer
@ 2013-03-21 14:44 ` Sietse Brouwer
2013-03-21 16:35 ` Hans Hagen
1 sibling, 1 reply; 7+ messages in thread
From: Sietse Brouwer @ 2013-03-21 14:44 UTC (permalink / raw)
To: mailing list for ConTeXt users
Mojca wrote:
> Hans just implemented auto-conversion of help into man pages for the
> lua scripts.
> but if
> there are any volunteers to help polishing out and provide either
> more extensive descriptions, examples, ... or overall improvements,
An excellent idea. To cut the work into bite-sized pieces: over the
coming weeks, I will post these files on the list one by one and
solicit specific improvements / check for befuddlement. First, though,
I have some questions:
1. I assume the man pages are created from the XML files, and we
should edit the XML files -- is this correct?
2. Is the XML-to-man script included in the distribution? That would
(a) make it easier to check the result of an edit, and (b) make it
easier to find the answer to question 3 for myself. ;-)
3. Is there a key to specify bold and italic in the XML? (\fB...\fP
and \fI...\fP in the man page.) Or, if you want to keep it semantic:
are <code> (\fB) and <emph> (\fI, or also \fB) supported?
4. I really really like the <subcategory> groupings of the flags in
the XML files. This useful grouping doesn't show up in the man pages,
however. Perhaps the end of a subcategory could correspond to
.TP
----
in the man pages?
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. This will make it easier for users to discover the man
pages. Example below. If such a block could be supported, I would be
happy to write it.
<seealsos>
<seealso name=mtx-grep>
<short></short>
</seealso>
</seealsos>
Cheers,
Sietse
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: man pages for ConTeXt: looking for volunteers
2013-03-21 14:44 ` Sietse Brouwer
@ 2013-03-21 16:35 ` Hans Hagen
[not found] ` <CAF=dkzwjs_0m3w7LncgtLE4sZXreb+U9J5=ouMP=Qnt53ZkAWA@mail.gmail.com>
0 siblings, 1 reply; 7+ messages in thread
From: Hans Hagen @ 2013-03-21 16:35 UTC (permalink / raw)
To: mailing list for ConTeXt users
On 3/21/2013 3:44 PM, Sietse Brouwer wrote:
> Mojca wrote:
>> Hans just implemented auto-conversion of help into man pages for the
>> lua scripts.
>
>> but if
>> there are any volunteers to help polishing out and provide either
>> more extensive descriptions, examples, ... or overall improvements,
>
> An excellent idea. To cut the work into bite-sized pieces: over the
> coming weeks, I will post these files on the list one by one and
> solicit specific improvements / check for befuddlement. First, though,
> I have some questions:
>
> 1. I assume the man pages are created from the XML files, and we
> should edit the XML files -- is this correct?
no, they are (since yesterday) generated from the scripts themselves:
mtxrun --script fonts --exporthelp=man|xml|html|all
> 2. Is the XML-to-man script included in the distribution? That would
> (a) make it easier to check the result of an edit, and (b) make it
> easier to find the answer to question 3 for myself. ;-)
they are in the scripts ... the helpinfo is a xml blob in the script and
that one is the base for help info ... so, any 'fixes' have to go in there
> 3. Is there a key to specify bold and italic in the XML? (\fB...\fP
> and \fI...\fP in the man page.) Or, if you want to keep it semantic:
> are <code> (\fB) and <emph> (\fI, or also \fB) supported?
no, we keep it simple ... all we can do is make the to-man converter
better if needed
> 4. I really really like the <subcategory> groupings of the flags in
> the XML files. This useful grouping doesn't show up in the man pages,
> however. Perhaps the end of a subcategory could correspond to
i must say that i have no clue what the man pages look like but
suggestions are welcome
> .TP
> ----
>
> in the man pages?
just tell me what to do
> 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. This will make it easier for users to discover the man
> pages. Example below. If such a block could be supported, I would be
> happy to write it.
>
> <seealsos>
> <seealso name=mtx-grep>
> <short></short>
> </seealso>
> </seealsos>
sure, we can add stuff
Hans
-----------------------------------------------------------------
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
-----------------------------------------------------------------
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: man pages for ConTeXt: looking for volunteers
[not found] ` <CAF=dkzwjs_0m3w7LncgtLE4sZXreb+U9J5=ouMP=Qnt53ZkAWA@mail.gmail.com>
@ 2013-03-26 0:15 ` Sietse Brouwer
2013-03-26 9:38 ` Hans Hagen
0 siblings, 1 reply; 7+ messages in thread
From: Sietse Brouwer @ 2013-03-26 0:15 UTC (permalink / raw)
To: Hans Hagen, mailing list for ConTeXt users
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>
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: man pages for ConTeXt: looking for volunteers
2013-03-26 0:15 ` Sietse Brouwer
@ 2013-03-26 9:38 ` Hans Hagen
2013-03-26 11:06 ` Sietse Brouwer
0 siblings, 1 reply; 7+ messages in thread
From: Hans Hagen @ 2013-03-26 9:38 UTC (permalink / raw)
To: Sietse Brouwer; +Cc: mailing list for ConTeXt users
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
-----------------------------------------------------------------
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
* Re: man pages for ConTeXt: looking for volunteers
2013-03-26 9:38 ` Hans Hagen
@ 2013-03-26 11:06 ` Sietse Brouwer
0 siblings, 0 replies; 7+ messages in thread
From: Sietse Brouwer @ 2013-03-26 11:06 UTC (permalink / raw)
To: Hans Hagen; +Cc: mailing list for ConTeXt users
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 <pragma@wxs.nl> wrote:
> 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
> -----------------------------------------------------------------
___________________________________________________________________________________
If your question is of interest to others as well, please add an entry to the Wiki!
maillist : ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
webpage : http://www.pragma-ade.nl / http://tex.aanhet.net
archive : http://foundry.supelec.fr/projects/contextrev/
wiki : http://contextgarden.net
___________________________________________________________________________________
^ permalink raw reply [flat|nested] 7+ messages in thread
end of thread, other threads:[~2013-03-26 11:06 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2013-03-21 11:59 man pages for ConTeXt: looking for volunteers Mojca Miklavec
2013-03-21 13:15 ` Marco Patzer
2013-03-21 14:44 ` Sietse Brouwer
2013-03-21 16:35 ` Hans Hagen
[not found] ` <CAF=dkzwjs_0m3w7LncgtLE4sZXreb+U9J5=ouMP=Qnt53ZkAWA@mail.gmail.com>
2013-03-26 0:15 ` Sietse Brouwer
2013-03-26 9:38 ` Hans Hagen
2013-03-26 11:06 ` Sietse Brouwer
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).