Novice - trying to get started with docbook



This is my first attempt at XML documentation.
I'm trying to get started with docbook so I can put a set
of documentation into docbook tags. I'm using 'XML In A
Nutshell" and "DocBook The Definitive Guide", both of which
are a bit outdated already.

I have a simple file that parses, but when I read it into
Netscape or Konqueror, I do not get the results that I would
hope for.

First, I'm not sure that the browsers are picking up
the referenced dtd file with the URL:
http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd

I'm opening the a local file, 'book.xml' in each of the browsers.
This file should be reading the local file, 'chap1.xml'. I'm
attaching both files.


In netscape I get the following results:

_________________________________________
This XML file does not appear to have any style information associated with it. The document tree is shown below.

- <book>
<title>My First Book</title>
<chapter>Chapter 2</chapter>
<chapter>Chapter 3</chapter>
</book>

_________________________________________


In Konqueror I get these results:

_________________________________________
Chapter 2Chapter 3
_________________________________________



Netscape simply displays the xml tags, implying it did
not know how to interpret them. Konqueror seems to have
digested the tags, implying they are legitimate tags and
also implying that it read the dtd. But there is no
formatting for the 'chapters', so this implys Konqueror
did not really handle the dtd.

My questions are as follows:

How do I know if the docbookx.dtd is actually being read?

Do I need to use a different xml processor?

Jim Anderson <?xml version='1.0' ?>
<!DOCTYPE Book SYSTEM "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
<!ENTITY chap1 SYSTEM "chap1.xml">
]>
<book>
<title>My First Book</title>
&chap1;
<chapter>Chapter 2</chapter>
<chapter>Chapter 3</chapter>
</book>
<chapter>
This is from 'chap1.xml' file.
</chapter>


Relevant Pages

  • Re: XML tags and /doc switch
    ... If I enable this for a single project, add some tags for most objects, ... complaining because you've stated you want documentation, ... So mark classes that you don't intend to be ... The XML file is cool, but I do not see it as ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: SV: Creating a list of TODOs
    ... VS doesn't really have a facility for this, unless you count XML comments. ... Almost all tools out there that process XML documentation are flexible enough to allow you to specify your own tags and how they should be processed, so there's little competition going on, really. ... However, XML comments are flexible enough that you can actually do this without much fuss -- if you often need to cooperate with other developers on code that's incomplete, for example, <todo> might come in handy. ...
    (microsoft.public.dotnet.languages.csharp)
  • Re: Code documentation.
    ... >> because all documentation tools use the same general syntax so a more ... XML has the advantage of being more easily ... I do agree that the c# way is easier to parse for a _program_. ... small hack that parse the documentation tags that has been in use for decades ...
    (microsoft.public.dotnet.general)
  • Re: Documenting a Tcl extension
    ... There is only *one* way to write documentation today: docbook. ... An easy way would be to write it in the code, using comments and tags ... It comes out like Javadocs. ...
    (comp.lang.tcl)
  • Re: Some .NET XML documentation tags are not recognized when I update my solutions documentation
    ... > I have a Windows program C# .NET solution where when I update its XML ... > documentation, some tags are not recognized and turned into the ... because it just does not support all the tags. ...
    (microsoft.public.dotnet.languages.csharp)