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/fb -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/fb subdirectory of the BRL-CAD source tree (about 38 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 | |
---|---|---|---|
man1.patch | 210.1 KB | November 30 2012 11:50 UTC | |
man1-fixed.patch | 213.9 KB | November 30 2012 12:17 UTC |
I would like to work on this task.
This task has been assigned to Freeman2430. You have 48 hours to complete this task, good luck!
The claim on this task has been removed, someone else can claim it now.
ask questions. we're here to help you. :)
I would like to work on this task.
This task has been assigned to stefi.stoyanova. You have 48 hours to complete this task, good luck!
The work on this task is ready to be reviewed.
Melange has detected that the deadline has passed and no more work can be submitted. The submitted work should be reviewed.
Congratulations, this task has been completed successfully.
Nice work, thanks. You have been credited with this contribution in our authorship documentation.
As GCI comes to a close, we wanted to take the time to say THANK YOU for all your efforts. This comment interface closes after GCI is over, so you're encouraged to join our mailing list where we'll be announcing contributions from GCI participants like yourelf over the upcoming months:
https://lists.sourceforge.net/lists/listinfo/brlcad-news
If you've provided your full name, we'll be sure to credit you in our authorship documentation and you'll see your name in a future announcement. If you contact us at devs@brlcad.org or via IRC, we'll even let you know when your work is integrated and follow up with updates. You're welcome and encouraged to contact us any time, especially if you have a question about how to continue participating in Open Source after GCI is over, but even if just to keep in touch. Note that ongoing participation in Open Source is one of the most impressive skills to have on your resumé. Take care, be well, and thank you again!