Menu

#170 Procedure in example

closed-accepted
DocBook (176)
5
2004-11-23
2004-11-22
No

I'm trying to add a set of step-by-step instructions to
an example. Wouldn't this be a perfect use of
<procedure>? However, procedure isn't allowed in <example>.

Could the DTD please be updated to allow <procedure> as
a child of <example>?

thanks!

Discussion

  • Michael(tm) Smith

    Logged In: YES
    user_id=118135

    I agree.

    I personally think DocBook is overly prescriptive
    with regard to where it allows procedure to be used.

    This runs counter to one of the fundamental design
    principles that DocBook has had from its beginning: To
    be descriptive rather than prescriptive.

    I can't see any good reason why a procedure should not
    be allowed within an example.

    The procedure element has from the beginning basically
    just been an orderedlist with a semantic name-- a list
    wrapper for a set up steps rather than listitems. But
    still basically an orderedlist. If it really were a
    model for a real procedure, we wouldn't have needed to
    add the task element.

    So we should allow it anywhere where orderedlist is valid.

     
  • Robert Stayton

    Robert Stayton - 2004-11-23
    • status: open --> closed-accepted
     
  • Robert Stayton

    Robert Stayton - 2004-11-23

    Logged In: YES
    user_id=193218

    The Committee accepted the premise, but expressed concern
    about putting an element that can have a title inside
    a formal element that has a title. Since the
    inner title is optional, it is the author's call.
    ACCEPTED. Too late for 4.4, however.

     

Log in to post a comment.