DocBook; was: Re: Giving up on XML

Subject: DocBook; was: Re: Giving up on XML
From: eric -dot- dunn -at- ca -dot- transport -dot- bombardier -dot- com
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Thu, 15 Mar 2007 08:03:48 -0500

>>For those still considering adopting DocBook, another reasonable
approach may
>>be to look at Simplified DocBook--then to add a few elements from
DocBook
>>itself to allow for books, since the simplified form has as its largest
>>element articles.

Excellent advice.

It is imperative that anyone adopting a Structure to understand what the
purpose of the structure is.

DocBook, ATA, the many milspec DTDs, and others are often INTERCHANGE
structures. And as such have many ambiguities that make addressing
specific needs difficult and may make them unsuitable for use as a
production environment.

Just as there is simplified DocBook, there are consultants who will
customise DocBook to your needs while maintaining compatibility. Same for
ATA and others. The ATA and milspec DTDs are often free. But to have a
useable work environment can cost a fortune.

Think of those DTDs as Word or Frame templates. You study a template and
understand it before you adopt it as your working template. I've often
found that even if constrained to deliver in a sanctioned industry or
institutional template, my working needs are best addressed by creating a
custom template that can be converted to the sanctioned one for delivery.

Same for XML/SGML structures. If DocBook, ATA, HTML, CALS, MathML, DITA,
or any of the other available templates don't meet your needs you either
have to identify the deficiencies and create workarounds when possible, or
create your own template to meet your specific needs.

It isn't the structure chosen that will necessarily reap the most
benefits, but the fact you start using a structure.

The learning curve for creating structure is steeper than a Word or Frame
template. But it need not be a ground up development or an expensive
project. But it will require you to learn some of the innards of the
process if an out-of-the-box solution can't be used.

Eric L. Dunn
Senior Technical Writer

_______________________________________________________________________________________________________________

This e-mail communication (and any attachment/s) may contain confidential
or privileged information and is intended only for the individual(s) or
entity named above and to others who have been specifically authorized to
receive it. If you are not the intended recipient, please do not read,
copy, use or disclose the contents of this communication to others. Please
notify the sender that you have received this e-mail in error by reply
e-mail, and delete the e-mail subsequently. Please note that in order to
protect the security of our information systems an AntiSPAM solution is in
use and will browse through incoming emails.
Thank you.
_________________________________________________________________________________________________________________


Ce message (ainsi que le(s) fichier/s), transmis par courriel, peut
contenir des renseignements confidentiels ou protégés et est destiné à
l?usage exclusif du destinataire ci-dessus. Toute autre personne est par
les présentes avisée qu?il est strictement interdit de le diffuser, le
distribuer ou le reproduire. Si vous l?avez reçu par inadvertance,
veuillez nous en aviser et détruire ce message. Veuillez prendre note
qu'une solution antipollupostage (AntiSPAM) est utilisée afin d'assurer la
sécurité de nos systems d'information et qu'elle furètera les courriels
entrant.
Merci.
_________________________________________________________________________________________________________________


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: Re: Giving up on XML
Next by Author: Re: Giving up on XML
Previous by Thread: DocBook; was: Re: Giving up on XML
Next by Thread: RE: DocBook; was: Re: Giving up on XML


What this post helpful? Share it with friends and colleagues:


Sponsored Ads