[NeXus-definitions-tickets] [NeXusDefinitions] #132: Control autogenerated names for HTML manual pages

[NeXus Base Classes and Instrument Definitions]

#132: Control autogenerated names for HTML manual pages
------------------------+---------------------------------------------------
Reporter:  Pete Jemian  |       Owner:  Pete Jemian     
    Type:  task         |      Status:  assigned        
Priority:  minor        |   Milestone:  release NXDL 1.0
Keywords:               |  
------------------------+---------------------------------------------------
Changes (by Pete Jemian):

  * status:  new => assigned


Old description:

> When the manual is written into separate HTML pages, the pages come out
> with generic names such as {{{bk02ch03s01.html}}} and {{{bk01apf.html}}}.
> Find the way to influence dblatex to use names of our selection such as
> {{{NXDL.html}}} and {{{Introduction}}}.
>
> This relates to TRAC ticket #120

New description:

 When the manual is written into separate HTML pages, the pages come out
 with generic names such as {{{bk02ch03s01.html}}} and {{{bk01apf.html}}}.
 Find the way to influence dblatex to use names of our selection such as
 {{{NXDL.html}}} and {{{Introduction}}}.

 This will allow us to create permanent names (HTML file names that won't
 change if manual sections are rearranged) that can be cited from other WWW
 pages.

 This relates to TRAC ticket #120

--

Comment:

 '''''docbook''''' (not ''dblatex'') has options to provide this:
  * http://www.sagehill.net/docbookxsl/Chunking.html
  *
 http://docbook.sourceforge.net/release/xsl/current/doc/html/use.id.as.filename.html

 Basically:
  1. in {{{Makefile}}}, add {{{--stringparam use.id.as.filename 1}}} to the
 build rules for {{{html/index.html:}}}
  1. in each DocBook {{{.xml}}} file, set {{{xml:id="UniqueFileName"}}} so
 that file {{{html/UniqueFileName.html}}} will be produced.  These are the
 elements that, when 'chunked', will produce separate HTML files:
    * appendix
    * article
    * bibliography  ''in article or book''
    * book
    * chapter
    * colophon
    * glossary      ''in article or book''
    * index         ''in article or book''
    * part
    * preface
    * refentry
    * reference
    * sect1        ''except first''
    * section      ''if equivalent to sect1''
    * set
    * setindex

-- 
Ticket URL: <http://trac.nexusformat.org/definitions/ticket/132#comment:1>
NeXus Base Classes and Instrument Definitions <http://www.nexusformat.org/>
NeXus Base Classes and Instrument Definitions