From: Sietse Brouwer <sbbrouwer@gmail.com>
To: mailing list for ConTeXt users <ntg-context@ntg.nl>
Subject: Re: man pages for ConTeXt: looking for volunteers
Date: Thu, 21 Mar 2013 15:44:39 +0100 [thread overview]
Message-ID: <CAF=dkzyNJS2zT3vEYmRvZ9rcE40kvcCqHQzbdPzuEYRBVM3NXQ@mail.gmail.com> (raw)
In-Reply-To: <CALBOmsbpxU_3=kNOb8M6mHwXAEVTHHEQn6inqJrdnzEV_UYqVw@mail.gmail.com>
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
___________________________________________________________________________________
next prev parent reply other threads:[~2013-03-21 14:44 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-03-21 11:59 Mojca Miklavec
2013-03-21 13:15 ` Marco Patzer
2013-03-21 14:44 ` Sietse Brouwer [this message]
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
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAF=dkzyNJS2zT3vEYmRvZ9rcE40kvcCqHQzbdPzuEYRBVM3NXQ@mail.gmail.com' \
--to=sbbrouwer@gmail.com \
--cc=ntg-context@ntg.nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).