[NeXus-definitions-tickets] [NeXusDefinitions] #193: manual: transition from DocBook sources to Restructured Text (ReST)

[NeXus Base Classes and Instrument Definitions]

#193: manual: transition from DocBook sources to Restructured Text (ReST)
-------------------------+-------------------------
 Reporter:  Pete Jemian  |      Owner:  Pete Jemian
     Type:  enhancement  |     Status:  new
 Priority:  major        |  Milestone:  later
Component:  general      |   Keywords:
-------------------------+-------------------------
 The source code for ReSTructured text relies on substantially less markup
 commands than does DocBook.  This makes it easier for non-experts to
 create useful documentation and also makes it easier to edit and review
 documentation sources.  Initial efforts at converting the first chapters
 have been promising.

 The Docbook source files can be converted, mostly, using an automated
 tool, such as db2rst.py.  There are additional tools that convert the NXDL
 files that must be recreated to generate ReST source.

 Initially, there seems to be a problem with the width of tables in PDF
 output.  A review of the LaTeX intermediary source may be helpful to
 resolve.

 ReST does not have a common mechanism at this time to number figures,
 tables, and equations.  We will have to drop those items.

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