Convert src/util manual pages to Docbook XMLBRL-CAD
Status: ClosedTime to complete: 48 hrs Mentors: SeanTags: docbook, xml, man page, text editing

BRL-CAD is in the process of converting its documentation in order to enable automatic generation of output in different formats (html, pdf, man) from a single source. We need to convert our existing UNIX man pages to the Docbook XML format. There is a doclifter conversion tool available to help automatically convert files, then just a little bit of cleanup is needed. This will find all of the pages specific to this task:

find . -name *.1 -not -regex '.*cmake.*' -not -regex '.*external.*' -not -regex '.*other.*' | grep util


This is approximately 93.  The simplest way to confirm the files are successfully converted is to incorporate them into BRL-CAD's build logic (edit CMakeLists.txt) and view the output using brlman and an html viewer. It is recommended to use the Emacs editor with the nxml mode in order to more easily identify and fix errors, but this is not a requirement.

This task involves using the doclifter tool to perform a rough conversion to Docbook of all man pages pertaining to BRL-CAD that are in our source tree but not already covered by other GCI tasks, then performing whatever manual corrections are needed to the autogenerated XML files to make them valid Docbook.  Many conversions have already been done and can serve as guides. Add new files to the doc/docbook/system/man1/en directory (via svn add), update the CMakeLists.txt file there (add references), remove the old files (via svn rm), and edit the src/util CMakeLists.txt and Makefile.am files to remove references.

Verify no warnings or errors by compiling, and make a patch (svn diff my_changes.patch).  You will probably have to make minor edits to make them compile cleanly.


Uploaded Work
File name/URLFile sizeDate submitted
srcutil.patch763.6 KBDecember 02 2012 04:00 UTC
srcutil.patch763.2 KBDecember 02 2012 05:14 UTC
Comments
Cezaron December 2 2012 02:33 UTCTask Claimed

I would like to work on this task.

Harmanpreet Singh on December 2 2012 02:37 UTCTask Assigned

This task has been assigned to Cezar. You have 48 hours to complete this task, good luck!

Cezaron December 2 2012 04:00 UTCReady for review

The work on this task is ready to be reviewed.

Cezaron December 2 2012 05:56 UTCCommit r53940

Commit r53940

Sean on December 2 2012 06:02 UTCTask Closed

Congratulations, this task has been completed successfully.