docbook-apps

  • 1.  Re: [docbook-apps] DocBook Customization

    Posted 05-19-2009 21:36
    DocBook CustomizationHi Eric,
    My impression is that many groups adopt DITA because they want to work in topics rather than chapters. Then they do whatever is needed to use DITA to write topics. I have been in contact with more than one group that has adopted DITA without any DTD customization. As you say, people often do crazy things. 8^)

    One common DocBook customization practice is to cut down on the number of elements. There are several reasons why:

    a. When using an XML editor that presents a list of valid tag names, the list can be quite long in many contexts (such as inlines). Many such elements are never to be used, so remove them from sight.

    b. Reducing ambiguity in choosing among similar elements.

    c. Reducing the complexity of a stylesheet customization. If you know you are only supporting certain elements you don't need to have templates for all elements.

    d. Reduce the complexity of the para element by removing block element children (making it like simpara).

    It is possible to make a subset that still produces documents that validate with the full DocBook schema. But of course not the other way around.

    In terms of the cost of customization, I have found customizing the DocBook 4 DTD to be easier than customizing the DITA DTDs. In DITA's DTDs, everything is a twice-removed parameter entity, and it is hard to keep track of where an element is actually declared and what children it can contain. DocBook 4 uses parameter entities, but not to such a complex degree. DocBook 5's RelaxNG grammar is even easier to customize, once you learn the grammar.

    Bob Stayton
    Sagehill Enterprises
    bobs@sagehill.net





  • 2.  Re: [docbook-apps] DocBook Customization

    Posted 05-19-2009 22:34
    > In terms of the cost of customization, I have found customizing the
    > DocBook 4 DTD to be easier than customizing the DITA DTDs.

    Talk about complex transforms: I've been using DITA recently, and the OT
    stylesheets look pretty intimidating to me - and no 'DITA XSL The
    Complete Guide' to help sort them out!


    Bob Stayton wrote:
    > Hi Eric,
    > My impression is that many groups adopt DITA because they want to work
    > in topics rather than chapters. Then they do whatever is needed to use
    > DITA to write topics. I have been in contact with more than one group
    > that has adopted DITA without any DTD customization. As you say, people
    > often do crazy things. 8^)
    >
    > One common DocBook customization practice is to cut down on the number
    > of elements. There are several reasons why:
    >
    > a. When using an XML editor that presents a list of valid tag names,
    > the list can be quite long in many contexts (such as inlines). Many
    > such elements are never to be used, so remove them from sight.
    >
    > b. Reducing ambiguity in choosing among similar elements.
    >
    > c. Reducing the complexity of a stylesheet customization. If you know
    > you are only supporting certain elements you don't need to have
    > templates for all elements.
    >
    > d. Reduce the complexity of the para element by removing block element
    > children (making it like simpara).
    >
    > It is possible to make a subset that still produces documents that
    > validate with the full DocBook schema. But of course not the other way
    > around.
    >
    > In terms of the cost of customization, I have found customizing the
    > DocBook 4 DTD to be easier than customizing the DITA DTDs. In DITA's
    > DTDs, everything is a twice-removed parameter entity, and it is hard to
    > keep track of where an element is actually declared and what children it
    > can contain. DocBook 4 uses parameter entities, but not to such a
    > complex degree. DocBook 5's RelaxNG grammar is even easier to
    > customize, once you learn the grammar.
    >
    > Bob Stayton
    > Sagehill Enterprises
    > bobs@sagehill.net <mailto:bobs@sagehill.net>
    >
    >
    >
    >


  • 3.  RE: [docbook-apps] DocBook Customization

    Posted 05-19-2009 22:50
    While the DITA DTDs are messy and complex, I do find the way that the DITAOT XSLs process data (i.e. refering to @class attributes rather than element names) to be a lovely, elegant way of allowing fall-through generalization. To me, it makes just as much sense to abstract the XSL from the XML as it does to abstract content from presentation.

    That said, it's a damn good thing that the XSLs are easy to work with, because they sure require a lot of work when you're used to the feature set offered by DocbookXSL.

    > In terms of the cost of customization, I have found customizing the
    > DocBook 4 DTD to be easier than customizing the DITA DTDs.

    Talk about complex transforms: I've been using DITA recently, and the OT
    stylesheets look pretty intimidating to me - and no 'DITA XSL The
    Complete Guide' to help sort them out!




  • 4.  Re: [docbook-apps] DocBook Customization

    Posted 05-20-2009 08:37
    Jeff Hooker wrote:

    > Talk about complex transforms: I've been using DITA recently, and the OT
    > stylesheets look pretty intimidating to me - and no 'DITA XSL The
    > Complete Guide' to help sort them out!

    In one project customer for no valid reason insisted on DITA, but wanted
    several high quality outputs. The easiest way to tackle it was to create
    DocBook content from DITA and then use DocBook stylesheets to generate
    various output formats. But this was 3 years ago, might be that DITA-OT
    is more mature now.

    Jirka

    --
    ------------------------------------------------------------------
    Jirka Kosek e-mail: jirka@kosek.cz http://xmlguru.cz
    ------------------------------------------------------------------
    Professional XML consulting and training services
    DocBook customization, custom XSLT/XSL-FO document processing
    ------------------------------------------------------------------
    OASIS DocBook TC member, W3C Invited Expert, ISO JTC1/SC34 member
    ------------------------------------------------------------------




  • 5.  Re: [docbook-apps] DocBook Customization

    Posted 05-20-2009 01:23
    If you want to "start" with a simplified version of DocBook, you should
    check out the Simplified DocBook DTD or the new Publishers schema. These
    are "official" customizations that minimize the number of elements.

    With the proposed Modular DocBook addition to the standard (likely
    v5.1), there soon will be a way to more easily work at a topic level
    while remaining in DocBook compliance.

    I second Eric's opinion that there is no DITA XSL: The Complete Guide,
    so the customization for DITA is much more challenging!

    Best regards,

    --Scott

    Bob Stayton wrote:
    > Hi Eric,
    > My impression is that many groups adopt DITA because they want to work
    > in topics rather than chapters. Then they do whatever is needed to use
    > DITA to write topics. I have been in contact with more than one group
    > that has adopted DITA without any DTD customization. As you say, people
    > often do crazy things. 8^)
    >
    > One common DocBook customization practice is to cut down on the number
    > of elements. There are several reasons why:
    >
    > a. When using an XML editor that presents a list of valid tag names,
    > the list can be quite long in many contexts (such as inlines). Many
    > such elements are never to be used, so remove them from sight.
    >
    > b. Reducing ambiguity in choosing among similar elements.
    >
    > c. Reducing the complexity of a stylesheet customization. If you know
    > you are only supporting certain elements you don't need to have
    > templates for all elements.
    >
    > d. Reduce the complexity of the para element by removing block element
    > children (making it like simpara).
    >
    > It is possible to make a subset that still produces documents that
    > validate with the full DocBook schema. But of course not the other way
    > around.
    >
    > In terms of the cost of customization, I have found customizing the
    > DocBook 4 DTD to be easier than customizing the DITA DTDs. In DITA's
    > DTDs, everything is a twice-removed parameter entity, and it is hard to
    > keep track of where an element is actually declared and what children it
    > can contain. DocBook 4 uses parameter entities, but not to such a
    > complex degree. DocBook 5's RelaxNG grammar is even easier to
    > customize, once you learn the grammar.
    >
    > Bob Stayton
    > Sagehill Enterprises
    > bobs@sagehill.net <mailto:bobs@sagehill.net>
    >
    >
    >
    >


  • 6.  RE: [docbook-apps] DocBook Customization

    Posted 05-20-2009 02:24
    Scott,

    Good points.

    I'm a firm fan of DocBook and think it can do anything
    that DITA can (and more). But, if anyone on the list has
    the chops to do a DITA XSL: The Definitive Guide, let me
    know; I think it's needed and I'd like to publish it.

    Dick Hamilton
    ---------------------------------
    XML Press
    XML for Technical Communicators
    http://xmlpress.net
    (970) 231-3624


    >


  • 7.  RE: [docbook-apps] DocBook Customization

    Posted 05-20-2009 12:48
    I'd like to know more about he modular DocBook stuff. Are there any
    early drafts of the proposal or information I could look at?

    Will it make interop between DocBook and DITA easier?




  • 8.  Re: [docbook-apps] DocBook Customization

    Posted 05-20-2009 17:41
    Hi Eric,

    the proposals are archived on the public DocBook TC list:
    http://markmail.org/message/hp4bfbybnsfimyoc
    http://markmail.org/message/ig2rmioc6bljwiqk

    We are still considering the structures involved, so we welcome any
    feedback!

    I have a distinct interest in DocBook/DITA interoperability as well, so
    we will certainly try to enable interop where possible!

    Thanks and best regards,

    --Scott

    Scott Hudson
    Senior XML Architect

    +1 (303) 542-2146 | Office
    +1 (303) 332-1883 | Cell
    Scott.Hudson@flatironssolutions.com
    ==========================================
    Flatirons Solutions
    http://www.flatironssolutions.com


    Eric Johnson wrote:
    > I'd like to know more about he modular DocBook stuff. Are there any
    > early drafts of the proposal or information I could look at?
    >
    > Will it make interop between DocBook and DITA easier?
    >
    >