Menu
Logged-In As
ACCOUNTNot Logged In
Write manual page documentation (for archer)BRL-CAD
Status: ClosedTime to complete:
100 hrs
Mentors: Popescu Andrei, Jacob B
BRL-CAD has hundreds of tools but they're not all documented. We use the Docbook XML system for documentation, which is very much like HTML, but don't worry -- we have LOTS of examples you can follow. Our build system will even validate your file to make sure you didn't make a mistake.
This task entails briefly learning how the archer tool works and then writing initial documentation for it. Look at the other XML files in the doc/docbook/system/man1/en directory for dozens of examples.
Once you've created your new file, you'll want to check your work.
- download BRL-CAD from Subversion or use our VM image
- compile BRL-CAD: http://brlcad.org/wiki/Compiling
- create your new file (doc/docbook/system/man1/en/archer.xml)
- add it to the build system ( edit doc/docbook/system/man1/en/CMakeLists.txt )
- compile again (make) and make sure it doesn't give an error
- check the compiled version ( in your build directory, run: bin/brlman archer)
A lot of little steps, but it's really very easy.
References:- doc/docbook/system/man1/en/*.xml
- doc/docbook/system/man1/en/mged.xml -- this is particularly relevant/similar
- doc/docbook/system/man1/en/archer.xml -- you'll create this
- doc/docbook/system/man1/en/CMakeLists.txt -- add your new file here
Uploaded Work
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| archer.rtf | 6.1 KB | December 12 2014 02:09 UTC | |
| archer_doc.patch | 5.5 KB | December 26 2014 07:53 UTC |
I would like to work on this task.
This task has been assigned to Parth Miglani. You have 100 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.
Parth, I have no idea what you submitted, but it has absolutely nothing to do with BRL-CAD. It's clearly something you found on the web, so also understand that submitting work you found on the web as your own without citing your sources is a form of plagiarism and is unacceptable in any form. If you're going to use materials made by others, you should credit them.
That said, what you submitted really does have nothing to do with our archer application. Please install BRL-CAD and run our archer application if you intend to write documentation for it, as that's really the only way to learn what it does. The work for this task is to write that documentation.
Please don't submit any more content that you find from the web.
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 shardulc. You have 100 hours to complete this task, good luck!
The work on this task is ready to be reviewed.
After going through src/archer/archer, src/tclscripts/archer/ArcherCore.tcl, and other related files, I could not find anything to do with command-line options except for the database conversion thing I've written about in the docfile. I asked on the IRC channel as well, and nobody seemed to know.
Then is my work all right? Thanks for your attention!
Congratulations, this task has been completed successfully.
Thanks for your patience with this review. Many of our mentors were on holiday yesterday.
This manpage looks like a great start. You are certainly on the right track and this is good effort for the task that we can use without much cleanup. Please keep the manual pages coming! This is awesome!