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

Re: New XML conversion tool for Debiandoc SGML



On Mon, Oct 17, 2005 at 12:02:31PM +0200, W. Borgert wrote:
> Quoting Osamu Aoki <osamu@debian.org>:
> > I have uploaded debiandoc-sgml 1.1.91 which fix XHTML aissues and XML
> > conversion.
> 
> Thanks for your work!
> 
> Some suggestions (sorry, not as a patch):

To what.  debiandoc-sgml-doc ? or debiandoc-sgml

> 1. You correctly write, that DocBook is better maintained.
>    DocBook XML has more advantages, relevant to the reader:
> 
>   - table support
> 
>   - graphics support

OK.

>   - additional output formats (CHM, JavaHelp, nroff)

I have no idea bout these.

> 2. Not necessary, but good practise IMHO: Use UTF-8 - always!
>    Switching from SGML to XML is a good point in time to fix
>    the encoding as well.  To convert other encodings one can
>    use iconv, e.g. iconv -f iso-8859-1 -t utf-8

Yes.  Not required but the use of UTF-8 makes i18n life easier.

> 3. The use of ENTITY is XML is not really nice (too SGMLish?).
>    To include other documents, it's better to use xi:include,
>    so you can even include single sections or paragraphs from
>    other XML files.  Character entities are not necessary,
>    because we all use UTF-8, don't we?  Leaves "short-cuts"
>    such as &gpl; -> "GNU General Public License".

OK but I do not know about xi: thing.  Where is example and tutorial
info.  I need some one to guide me with xi: .

> 4. In DebianDoc, people use <sect1>, <sect2>, etc.  This is
>    possible in DocBook as well, but one should avoid it.
>    You cannot easily re-arrange a document or include a
>    sect2 from one docuement in a sect3 of another.  Better
>    use <section> - always.  When changing a document from
>    SGML into XML this should be done as well.

Yes, I know. I just imitated d-i style.  I should make this switchable.
This is simple.

> 5. There is an addtional method to test an XML document:
>    xmllint, which works very well.

Hmmm... I never used any XML thing yet.  Looks interesting.  This is my
TODO.

Osamu




Reply to: