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 them: find src/[glnrt]* -name \*.1 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 in the src/gtools, src/lgt, src/nirt, src/remrt, src/rt,src/rttherm, and src/tab subdirectories of the BRL-CAD source tree (about 24 files), then performing whatever manual corrections are needed to the autogenerated XML files to make them valid Docbook (some conversions have already been done and can serve as guides). Add new files to the doc/docbook/system/man1/en directory (via svn add), edit the CMakeLists.txt file in that same directory, verify no errors by compiling, and make a patch. References:
Code:
|
File name/URL | File size | Date submitted | |
---|---|---|---|
XML.zip | 125.9 KB | December 03 2012 01:41 UTC |
I would like to work on this task.
This task has been assigned to Harsh Vardhan. You have 48 hours to complete this task, good luck!
Melange has detected that the initial deadline has passed and it has set the task status to ActionNeeded. The student has 24 hours to submit the work before the task is reopened and sent back to the pool for other students to claim.
The claim on this task has been removed, someone else can claim it now.
I would like to work on this task.
This task has been assigned to Sean Bashaw. You have 48 hours to complete this task, good luck!
My code gets errors in classes I didn't edit. I get errors like:
53:48: error: CoreFoundation/CoreFoundation.h: No such file or directory
If you can help me msg me on the irc i am Barakados
The work on this task is ready to be reviewed.
Congratulations, this task has been completed successfully.