BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix
This task involves writing basic documentation for '''JUST ONE''' of those commands in the Docbook XML format. Pick one (at random). Spend a few minutes learning how to use the tool, read the soure code for hints, then write a basic manual page for it. The command documentation should provide a one-sentence description, a detailed description (200+ words), explanation of '''all''' available command-line options, and one or two examples on how to use the command.
Code:
- doc/docbook/system/man1/en/Makefile.am
- doc/docbook/system/man1/en/*.xml
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| asc2g xml doc.txt | 3.1 KB | December 02 2013 18:35 UTC | |
| http://sourceforge.net/p/brlcad/patches/245/ | n/a | December 07 2013 17:15 UTC |
I would like to work on this task.
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 Alex. You have 72 hours to complete this task, good luck!
do i basically create this in a xml document? im not sure what a xml docbook is?
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.
Alex, did you see the references in the task description? There are many many many examples to follow including a blank template file that you can mostly fill out.
There's nothing special or complicated about an xml file. It's just a simple text file and similar to an html file where simple text tags describe what the text means.
Do you need more time?
The deadline of the task has been extended with 1 days and 0 hours.
thankyou will finish asap
The work on this task is ready to be reviewed.
Alex,
You've got the right idea, but you picked one that is already complete. Surely you discovered this because your file looks like it's our file with important sections removed. That won't do.
I suggest you try the first program in the list, 'a-d' and creating a valid manual page for it instead. You'll need to install BRL-CAD so you can run the a-d command and learn the basics for how to run it, what it does, etc. The source file with some of this information is in src/sig/a-d.c
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 deadline of the task has been extended with 2 days and 0 hours.
I haver brl-cad software installed and have been on archer entering 'a-d' but the command doesnt seem to be recognised (probably because is need to write it in a certain format) i just wanted to know how i should enter the command and how i need to test it? im not entirely sure on how archer or other brl-cad software works so how should i go about researching this a-d command?
also i cant seem to the src/sig/a-d.c?
even though i have it installed and the 'a-d'.exe file is there i cant find the a-d.c file.
Melange has detected that the final deadline has passed and it has reopened the task.
I would like to work on this task.
This task has been assigned to Shardul Chiplunkar. You have 72 hours to complete this task, good luck!
The work on this task is ready to be reviewed.
Congratulations, this task has been completed successfully.
The manual page for brep_simple looks great. I like how you took a little extra time to add the diagram from the source file comments.
Patch applied in r58882.