Re: Simplified DocBook

Subject: Re: Simplified DocBook
From: Megan Golding <mgolding -at- secureworks -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: 23 Sep 2002 14:45:20 -0400


On Mon, 2002-09-23 at 14:37, Bruce Byfield wrote:
> I've been developing my own simplified list of DocBook elements for an
> open source project.
>
> Now, the Docbook gurus have done the job for me:
>
> http://docbook.org/tdg/simple/en/html/

I've used DocBook for almost 2 years now and have yet to fully
understand how Simplified DocBook helps. Can you enlighten me?

For those unfamiliar with DocBook, imagine merging the markup style of
HTML and Word or Frame styles. The result is a semantic markup language
that describes what the parts of a document mean instead of what they
should look like. DocBook is a markup definition aimed at technical
authoring.

I see three benefits, but consider them marginal reasons for using
Simplified DocBook:

1. Simplified learning curve. The list of "all" elements is shorter in
Simplified DocBook. Don't confuse your users, that sort of thing.
However, I've referred many people to the online DocBook book at
http://www.docbook.org/tdg/en/html and, while most comment at all the
possible elements, few say it causes them problems in using DocBook.

2. Simplified stylesheet authoring. Because there are fewer parent/child
possibilities, you have fewer cases to "document" in your processing
stylesheets.

3. Simplified authoring. Authoring tools that can list all possible
tags, based on context, will present a shorter, less-confusing list. I
use psgml mode in Emacs and imagine this benefit to be somewhat useful.

Why Simplified DocBook? What am I missing?

Meg

--
Megan Golding (mgolding -at- secureworks -dot- net)
SecureWorks, Inc.



^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! http://www.ehelp.com/techwr-l

Enhance, optimize and automate your FrameMaker-to-PDF workflow with TimeSavers:
Define all PDF features in your source FrameMaker files ONCE, distill MANY.
Bookmark Controller, Link Controller, UnBloat & more : http://www.microtype.com

---
You are currently subscribed to techwr-l as:
archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.



Follow-Ups:

References:
Simplified DocBook: From: Bruce Byfield

Previous by Author: RE: Role of Technical Writer in IT
Next by Author: Re: Simplified DocBook
Previous by Thread: Simplified DocBook
Next by Thread: Re: Simplified DocBook


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


Sponsored Ads