discuss: db2omf
Subject:
Re: db2omf
From:
David Merrill ####@####.####
Date:
8 Mar 2001 18:28:01 -0000
Message-Id: <20010308132654.D21048@lupercalia.net>
On Thu, Mar 08, 2001 at 12:20:05PM -0600, Patrick K. O'Brien wrote:
> Not yet, but I plan to. I've read the omf spec and it seems to me that I
> should keep the omf in mind as I create the new DocBook template that I'm
> going to be working on. So my plan is to analyze existing LDP DocBook files
> to see what kinds of omf-type metadata they already have, and to find good
> examples of each. I'll probably write some programs in Python to do that.
> Then I'll take the best examples I can find, plus the omf recommendations,
> to create a new template. Then I could write another Python program to
> compare existing files against the template to see what pieces are missing
> from existing docs that could be added by their authors. Then I could also
> create a program to extract the omf pieces from existing docs in a form that
> could be submitted to the omf repository. How does that sound?
Sounds good. I do have a couple of comments and suggestions.
We already have (I think) two templates, one for large docs and one
for regular docs, i.e., an <article> and a <book>. Look at them
(you'll find them in the LAG) and use them as you can. There is much
there that is already good; what they lack is the task I asked you to
do, which is a "recommended" "standard" outline. They already have
pretty good examples of tag usage and some comments that are helpful.
If I'm wrong about having <article> and <book> then at least we
*should* have <article> (i.e., HOWTO) and <book> (i.e., Guide)
templates. Their needs are sufficiently different.
Make your template using the latest version of DocBook, and preferably
in both SGML and XML. They're very close, so it won't take much to do
it.
The omf we need to generate should be compatible with scrollkeeper
because I believe scrollkeeper will be the way we access our
documentation a year from now. Download and install sk from
sourceforge (scrollkeeper.sourceforge.net) and look at the sample omf
in /usr/share/omf.
All else being equal, perl has the advantage of more available
programmers. I'm not the language police, though, so use what you
like.
License under GPL, and I will want to donate the scripts to
scrollkeeper because they will need this functionality also.
That's all I can think of atm. Good luck, and thanks.
> -----Original Message-----
> From: David Merrill ####@####.####
> Sent: Thursday, March 08, 2001 10:58 AM
> To: ldp-discuss
> Subject: db2omf
>
> Has anyone done any work on creating omf from our docbook sources?
>
> --
> Dr. David C. Merrill http://www.lupercalia.net
> Linux Documentation Project ####@####.####
> Collection Editor & Coordinator http://www.linuxdoc.org
> Finger me for my public key
>
> Q: How many lawyers does it take to change a light bulb?
> A: You won't find a lawyer who can change a light bulb. Now, if
> you're looking for a lawyer to screw a light bulb...
>
> _________________________
> http://list.linuxdoc.org/
>
>
> _________________________
> http://list.linuxdoc.org/
--
Dr. David C. Merrill http://www.lupercalia.net
Linux Documentation Project ####@####.####
Collection Editor & Coordinator http://www.linuxdoc.org
Finger me for my public key
Disraeli was pretty close: actually, there are Lies, Damn lies, Statistics,
Benchmarks, and Delivery dates.
