Menu

#153 References: Consider using DocBook's <refsect1> and related markup

whenever
Started
nobody
None
Low
Enhancement
2017-01-18
2011-11-07
Anonymous
No

Originally created by: cmpilato

DocBook offers what appears to be a pretty complete collection of tags related to reference sections.  We should consider using those instead of the simple <refsect1> sections we are using today.

For example, we could be using <refsynopsisdiv> and <cmdsynopsis> for our binary subcommand reference synopsis bits.

See http://www.docbook.org/tdg/en/html/ch02.html#making-refentry for details.

Discussion

  • Anonymous

    Anonymous - 2013-01-18

    Originally posted by: cmpilato

    (No comment was entered for this change.)

    Owner: ---

     
  • Anonymous

    Anonymous - 2013-02-07

    Originally posted by: cmpilato

    (No comment was entered for this change.)

    Summary: References: Consider using DocBook's <refsynopsisdiv> and related markup

     
  • Anonymous

    Anonymous - 2013-02-13

    Originally posted by: cmpilato

    As of [r4434], the book uses <refsynopsisdiv> sections.  Now, we need to consider if <cmdsynopsis> will be worth the hassle.

    Status: Started

     

    Related

    Commit: [r4434]

  • C. Michael Pilato

    • summary: References: Consider using DocBook'sand related markup --> References: Consider using DocBook's <refsect1> and related markup
    • Description has changed:

    Diff:

    
    
     

Log in to post a comment.