[generguide-devel] Re: Online DocBook XML Validator

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Yes, I think I understand.
We are doing something similar to importing external entities.

Rather than import <section> nodes as I suspect you are doing, we import 
<section> nodes using <xinclude>.
Using <xinclude> means that your source documentation remains valid XML which 
makes processing easier for your tools.    The included nodes can come from 
remote locations and get imported during docbook XSLT processing.  This is 
what the XML looks like:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0//EN"
  "http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd"
[
  <!ENTITY % xinclude
    PUBLIC "-//GenerGuide//ELEMENTS XInclude for SDocBook V1.0//EN"
    "http://generguide.sourceforge.net/xinclude/1.0/xinclude.mod">
  %xinclude;
]>
<section id="configurationmanagement">
  <title>Configuration Management</title>
  <para>Software configuration management involves recording 
      and retreiving all versions of software in a system.</para>
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="http://somelocation.com/generguide/guide/cvs.xml"/>
  <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="versionnumbers.xml"/>
</section>

Is using <xinclude> instead of ENTITIES an option for you?
We still use Entities for variable names, eg: &project_name; ,however we are 
considering alternatives for variable names due to the processing dificulties 
and hence poor support of ENTITIES.  In particular there is poor support for 
ENTITIES from WYSIWYM editors.

You may want to join the generguide-devel email list where we have been 
discussing these issues.  Follow links from 
http://sourceforge.net/projects/generguide .

On Thursday 23 Oct 2003 1:58 am, Saqib Ali wrote:
> Hello Cameron,
>
> This looks like an interesting project, and I think it can help me in my
> project. Here is what I need to do:
>
> Let us say there is a XML document at http://www.nowhere.com/doc.xml,
> which references multiple external entities.
>
> Now I need to be able to able to d/l all the entities that the document
> references, and place them on the local machine, with the same direcotry
> structure that the master xml document uses.
>
> I do not want to import/include external entities in one document, instead
> I want to download, and re-create the same directory structure.
>
> Let me know if my explanation was clear enough. I can give you more
> details.
>
> Thanks.
> Saqib Ali
> ---------
> http://validate.sourceforge.net <--- XHTML/HTML/DocBook Validator
>
> On Wed, 22 Oct 2003, Cameron Shorter wrote:
> > Hi,
> > You seem to be working on something similar to a project I'm working on:
> > http://generguide.sf.net
> > We are about a week away from our 0.2 release when we go public, but I
> > thought you might want a sneak preview since you are working on similar
> > stuff. In particular, check out:
> > http://www.gisontheweb.com:8080/~cameron/cgi-bin/processconfig.pl
> > (select the Build Documentation button).
> >
> > I'd be intersted to hear your thoughts on this project.
> >
> > On Wednesday 22 Oct 2003 1:13 am, Saqib Ali wrote:
> > > Thomas,
> > >
> > > Thanks for testing the validator. The Validator is a for simple
> > > documents, especially for people who are new to DocBook, and would like
> > > to validate their documents on-line.
> > >
> > > You are getting the error, because you are refencing external entities
> > > in your document, that the system doesn't know about.
> > > One of the things I need to implement is to allow uploads of tar files,
> > > which contain all the XML files (external entities as well). Hopefully
> > > I should be done next week with this (Lord Willing).
> > >
> > > Thanks.
> > >
> > > Saqib Ali
> > > ---------
> > > http://validate.sourceforge.net <--- XHTML/HTML/DocBook Validator
> > >
> > > On Tue, 21 Oct 2003 tho...@24... wrote:
> > > > Hello Ali,
> > > >
> > > > Thanks for your effort; I tried your validator and got a bunch of
> > > > error-messages i do not understand.
> > > >
> > > > The most of them concern my extensiv usage of "<!ENTITY...".
> > > >
> > > > The source (and related documents) are available from
> > > >  http://www.thomas.miglinci.name/simpad/xml/simpad-howto.xml
> > > >
> > > >
> > > > How can i handle those error-messages - besides: i can generate
> > > > documents from this sources - see e.g.
> > > > http://www.thomas.miglinci.name/simpad/simpad-howto.html
> > > > or
> > > >   http://www.thomas.miglinci.name/simpad/simpad-howto.pdf
> > > >
> > > > Thomas
> > > >
> > > >
> > > > -----Original Message-----
> > > > From:	"Saqib Ali" <sa...@se...>
> > > > Sent:	Tuesday, October 21, 2003 4:40 AM
> > > > To:	"di...@en..." <di...@en...>,
> > > > "do...@en..." <do...@en...> Subject:	Online DocBook
> > > > XML Validator
> > > >
> > > > Hello All,
> > > >
> > > > This evening I plugged in the DocBook 4.1.2 /4.2 DTD to my webbased
> > > > validator
> > > >
> > > > Here is the link to it :
> > > >
> > > > http://validate.sourceforge.net
> > > >
> > > > Give it a try. I need to make quite a few improvments. But let me
> > > > know your thoughts.
> > > >
> > > > Try this document http://www.xml-dev.com/xml/apache.xml (there is one
> > > > error in the document).
> > > >
> > > > Remember it only support 4.1.2 and 4.2 right now. Also the Doctype
> > > > must be declared in the first 3 lines of the document:
> > > > <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
> > > > "http://docbook.org/xml/4.2/docbookx.dtd"><!DOCTYPE article PUBLIC
> > > > "-//OASIS//DTD DocBook XML V4.2//EN"
> > > > "http://docbook.org/xml/4.2/docbookx.dtd">
> > > >
> > > > The validator is powered by onsgmls
> > > >
> > > > Saqib Ali
> > > > ---------
> > > > http://validate.sourceforge.net <--- XHTML/HTML/DocBook Validator
> > > >
> > > > ______________________
> > > > http://lists.tldp.org/
> > >
> > > ______________________
> > > http://lists.tldp.org/
> >
> > --
> > Cameron Shorter              http://cameron.shorter.net
> > Open Source Developer        http://generguide.sourceforge.net
> >                              http://mapbuilder.sourceforge.net
> >                              http://geotools.org
> > Senior Software Engineer     http://www.adi-limited.com

-- 
Cameron Shorter              http://cameron.shorter.net
Open Source Developer        http://generguide.sourceforge.net
                             http://mapbuilder.sourceforge.net
                             http://geotools.org
Senior Software Engineer     http://www.adi-limited.com