Blame docs/params/README.BUILD

Packit 0f19cf
XSL Parameter Documentation Principle
Packit 0f19cf
-------------------------------------
Packit 0f19cf
- Each parameter is documented through an individual refentry file, like
Packit 0f19cf
  the DocBook Project does. These refentries stored unders params/ are the
Packit 0f19cf
  sources to maintain.
Packit 0f19cf
Packit 0f19cf
  There were built from the original parameter table (../custom/param.xml) with
Packit 0f19cf
  the command:
Packit 0f19cf
Packit 0f19cf
  xsltproc --xinclude ../../tools/param2ref.xsl ../custom/param.xml
Packit 0f19cf
Packit 0f19cf
  Each refentries XIncludes its related synopsis file. The reason of this
Packit 0f19cf
  structure (and not putting the synopsis directly in the refentries) is to be
Packit 0f19cf
  able to automatically update/sync the synopsis from the XSL stylesheets
Packit 0f19cf
  without modifying the refentries.
Packit 0f19cf
Packit 0f19cf
- The parameter synopsis are stored under the ./syn directory. They are 
Packit 0f19cf
  automatically produced from the dblatex XSL stylesheets with the following
Packit 0f19cf
  command:
Packit 0f19cf
Packit 0f19cf
  ../../tools/parambuild ./syn
Packit 0f19cf
Packit 0f19cf
- params/param.xml is the appendix that groups the whole refentries by
Packit 0f19cf
  XIncluding them. This file is currently maintained by hand, but it could be
Packit 0f19cf
  possible to build it through scripts.
Packit 0f19cf
Packit 0f19cf
- the params/param.xml file is XIncluded in the main documentation (manual.xml).
Packit 0f19cf