Menu
Logged-In As
ACCOUNTNot Logged In
Fix errors in Hacking BRL-CAD bookBRL-CAD
Status: ClosedTime to complete:
72 hrs
Mentors: starseeker
BRL-CAD was selected to participate in the 2013 Google Summer of Code Doc Camp. A team of contributors got together in California, brainstormed, and wrote an entire book for BRL-CAD in just a few days. They created a guide for contributing to BRL-CAD.
The text of this guide was converted in DocBook XML format, from which other formats (HTML, PDF, man page, etc.) can be generated. So there is an XML file to generate the Hacking BRL-CAD book. But this file is missing all the structuring elements.
References:
- http://brlcad.org/d/node/187
doc/docbook/books/en/BRL-CAD_Tutorial_Series-*.xml
- doc/docbook/books/en/HACKING_BRL-CAD.xml
This task involves inserting all missing "chapter", "para" and "programlisting" tags into the XML file.
Download our sources, edit the Code file, submit your changes (ideally in patch format if you can figure out how to do that).
Uploaded Work
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| hacking-format-ch123.patch | 187.3 KB | December 24 2013 02:03 UTC | |
| hacking-all.patch | 185.3 KB | December 25 2013 13:33 UTC |
I would like to work on this task.
This task has been assigned to Jacob B. You have 72 hours to complete this task, good luck!
The work on this task is ready to be reviewed.
One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.
On review, it looks like the code appendices all lost their formatting. They were in programlisting/programlisting blocks where all of the content between them is meant to be literally embedded with a fixed-width font. This patch removes that tag and removes the formatting of the code too as if it were chapter content.
The code blocks, examples, options, etc all need to retain their formatting which includes the spaces, tabs, and punctuation in those sections.
The work on this task is ready to be reviewed.
Looks like still the original upload only? Care to comment on the appendix code blocks?
One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.
The work on this task is ready to be reviewed.
Congratulations, this task has been completed successfully.
This looks perfect. Applied in r59161.