[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: SGML-format docs -- compile-time, what to do?



"Ben" == Ben Gertzfield <che@debian.org> writes:
> I'm making a new libgtk-doc package. Included with the upstream
> source is a SGML-formatted GTK FAQ. Should I:

Aren't you the lucky one!  I love SGML!

> 1) convert the SGML to HTML/LaTeX/??? at compile time 

Yes.  Create at the least HTML files.  Extra credit: create PDF
files.  Latex isn't that useful; DVI is marginally useful.  The only
necessary format (and it's stated by policy) is to ship with HTML if
possible.

> 2) convert the SGML to HTML/LaTeX/??? in the postinst

No.  You never can tell what other packages the user has, and there's
probably some day (soon?!) going to be a system-defined way to go
between document formats.

> 3) forget this silliness?

No, that would be a bug!

> And if I do convert the SGML to whatever, how should I go about
> doing that the best way?

Um.  There should be instructions.  I guess it basically depends on
the DTD; it could use either 'jade' (the standard method, see
/usr/doc/jade/*) or 'sdc' (if it uses a 'jfw*' DTD) or the special
linuxdoc or debiandoc tools if it uses those DTDs.  Soon it will all
be jade I think, but you'll still need the right DTD/DSSSL files
installed.

I'm happy to help you more, but I need to know what DTD your doco
uses.

.....A. P. Harris...apharris@onShore.com...<URL:http://www.onShore.com/>


Reply to: