| 1 | $Id: README,v 1.3 2005/06/07 09:34:13 xmldoc Exp $
|
|---|
| 2 |
|
|---|
| 3 | -----------------------------------------------------------------
|
|---|
| 4 | Notes
|
|---|
| 5 | -----------------------------------------------------------------
|
|---|
| 6 |
|
|---|
| 7 | Here are some minimal details (contributed by Barry Rountree)
|
|---|
| 8 | about the behavior of the manpages stylesheets.
|
|---|
| 9 |
|
|---|
| 10 | The first <refname> found is used to create the
|
|---|
| 11 | file name of the man page.
|
|---|
| 12 |
|
|---|
| 13 | The contents of <refentrytitle> are converted to
|
|---|
| 14 | ALL CAPS and used, with <manvolnum>, to decorate the
|
|---|
| 15 | bottom right and top corners of the page.
|
|---|
| 16 |
|
|---|
| 17 | Any <indexterm> is not used in man-page output.
|
|---|
| 18 |
|
|---|
| 19 | In order to document two or more items using the
|
|---|
| 20 | same page, add additional refnames to <refnamediv>.
|
|---|
| 21 | Each addtiona. refname will generate a small file
|
|---|
| 22 | that points to (via the magic of *roff)
|
|---|
| 23 |
|
|---|
| 24 | man[manvolnum]/[primaryRefname].gz
|
|---|
| 25 |
|
|---|
| 26 | More detailed how-to information about processing DocBook XML
|
|---|
| 27 | documents for man-page output will be available in the future.
|
|---|
| 28 | Somewhere. Written by someone...
|
|---|
| 29 |
|
|---|
| 30 | -----------------------------------------------------------------
|
|---|
| 31 | A short history of the DocBook manpages stylesheets
|
|---|
| 32 | -----------------------------------------------------------------
|
|---|
| 33 |
|
|---|
| 34 | October 2001 - September 2002: "The Silver Age"
|
|---|
| 35 | Martijn van Beers <lotr@users.sourceforge.net> contributes XSL
|
|---|
| 36 | stylesheets[1] for converting DocBook documents to *roff man pages,
|
|---|
| 37 | and maintains them in the [cvs]/docbook/contrib/xsl/db2man area
|
|---|
| 38 | of the project source-code repository, with frequent application
|
|---|
| 39 | of patches from Tim Waugh <twaugh@users.sourceforge.net>.
|
|---|
| 40 |
|
|---|
| 41 | [1] http://sourceforge.net/tracker/download.php?group_id=21935&atid=373749&file_id=11659&aid=468779
|
|---|
| 42 | http://docbook.sourceforge.net/archive/db2man.tar.gz
|
|---|
| 43 |
|
|---|
| 44 | September 2002 - March 2003: "The Joe Orton Era"
|
|---|
| 45 | The man-pages stylesheets are moved to [cvs]/docbook/xsl/manpages
|
|---|
| 46 | and become a standard part of all subsequent DocBook XSL
|
|---|
| 47 | Stylesheets releases. Joe Orton <jorton@users.sourceforge.net>
|
|---|
| 48 | takes over manpages maintenance; more patches from Tim Waugh.
|
|---|
| 49 |
|
|---|
| 50 | March 2003 - May 2005: "Tim Waugh At the Helm"
|
|---|
| 51 | Tim Waugh, eventually realizing that the possibility exists to
|
|---|
| 52 | commit changes to to a source-code repository *directly*, joins
|
|---|
| 53 | the project and takes over manpages maintenance, making a lot of
|
|---|
| 54 | fixes and refinements.
|
|---|
| 55 |
|
|---|
| 56 | May 2005 - present: "Journey Into Mystery"
|
|---|
| 57 | A sense of apprehension and uncertainty sets in as the
|
|---|
| 58 | least-skilled and most frequently inebriated member of the
|
|---|
| 59 | project takes over manpages maintenance.
|
|---|
| 60 |
|
|---|
| 61 | -----------------------------------------------------------------
|
|---|
| 62 | Original circa 2001 README contributed by Martijn van Beers
|
|---|
| 63 | -----------------------------------------------------------------
|
|---|
| 64 |
|
|---|
| 65 | README for db2man by Martijn van Beers (lotr@users.sourceforge.net)
|
|---|
| 66 |
|
|---|
| 67 | I've been working on some stylesheets to convert <refentry>s to man
|
|---|
| 68 | format. I thought I'd submit what I have for inclusion in the
|
|---|
| 69 | docbook-xsl package.
|
|---|
| 70 |
|
|---|
| 71 | See also:
|
|---|
| 72 |
|
|---|
| 73 | http://sourceforge.net/tracker/index.php?func=detail&aid=468779&group_id=21935&atid=373749
|
|---|
