Write a ''BRL-CAD Commands Quick Reference'' documentBRL-CAD
Status: ClosedTime to complete: 72 hrs Mentors: SeanTags:

There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.

This task involves writing a quick reference document similar to [http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf the MGED quick reference] but for BRL-CAD commands. The sheet should minimally include the following commands:

mged, rt*, *-g, g-*, fb*, *fb, nirt, remrt, rtsrv, asc2g, g2asc, dbupgrade, pix*, *pix, *-*, brlman, benchmark

References:

  • http://brlcad.org/wiki/Documentation
  • http://brlcad.org/w/images/5/52/MGED_Quick_Reference_Card.pdf
  • http://appletree.or.kr/quick_reference_cards/CVS-Subversion-Git/git-cheat-sheet-large.png
  • http://www.stdout.org/~winston/latex/latexsheet-0.png
  • http://img.docstoccdn.com/thumb/orig/524314.png
  • http://www.inmensia.com/files/pictures/internal/CheatSheetDrupal4.7.png
  • http://www.phpmagicbook.com/wp-content/uploads/2010/06/php-reference-card.jpg
Uploaded Work
File name/URLFile sizeDate submitted
BRL-CAD Commands Quick Reference.pdf63.3 KBNovember 25 2013 17:19 UTC
BRL-CAD Commands Quick Reference (Updated).pdf65.4 KBNovember 25 2013 23:25 UTC
BRL-CAD Commands Quick Reference Improved.zip131.8 KBNovember 26 2013 17:50 UTC
BRL-CAD Commands Quick Reference (New Version).rar166.4 KBNovember 27 2013 19:31 UTC
Comments
Darcey Mckelveyon November 19 2013 16:05 UTCTask Claimed

I would like to work on this task.

Harmanpreet on November 19 2013 16:16 UTCTask Assigned

This task has been assigned to Darcey Mckelvey. You have 72 hours to complete this task, good luck!

Darcey Mckelveyon November 19 2013 20:22 UTCClaim Removed

The claim on this task has been removed, someone else can claim it now.

Alexon November 22 2013 17:49 UTCTask Claimed

I would like to work on this task.

Mandeep Kaur on November 22 2013 17:51 UTCTask Assigned

This task has been assigned to Alex. You have 72 hours to complete this task, good luck!

Alexon November 22 2013 17:51 UTCBRL-CAD Commands

I understand the task but would just like to know how do i find out what each of the commands is used for/ does?

Alexon November 22 2013 18:45 UTCList of commands

Also is there somewhere i can find a full list of BRL-CAD commands to include? or are the ones stated in the paragraph all i should include?

Alexon November 22 2013 23:30 UTClanguage? format?

I just wanted to know while writing in this task and future tasks should i use american language instead of english language (just minor differences like 'colour' to 'color')


Also should i do this reference guide in a landscape view? as chosen for the MGED quick reference 


 

Alexon November 25 2013 17:19 UTCReady for review

The work on this task is ready to be reviewed.

Melange on November 25 2013 17:51 UTCNo more Work can be submitted

Melange has detected that the deadline has passed and no more work can be submitted. The submitted work should be reviewed.

Daniel Rossberg on November 25 2013 18:48 UTCbeside other things

I'm missing some words aboud the options.  How should these commands be called?

Daniel Rossberg on November 25 2013 18:48 UTCTask Needs More Work

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.

Daniel Rossberg on November 25 2013 18:48 UTCDeadline extended

The deadline of the task has been extended with 2 days and 0 hours.

Daniel Rossberg on November 25 2013 18:51 UTCList of commands

For a list of commands you could look at the BRL-CAD installation's bin directory.  The options are explained in the corresponding manual pages.

Alexon November 25 2013 23:24 UTCWill improve

thanks for feedback will include more on options.

Alexon November 25 2013 23:25 UTCReady for review

The work on this task is ready to be reviewed.

Sean on November 26 2013 06:11 UTCsource format

Alex, would you submit editable source files too?  PDF is great for seeing how it should ultimately look, but we'll need files that can be edited too.


Also, there shouldn't be a "miscellaneous" category.  All of those commands fit into other cagegories or don't belong on the sheet.  The ordering of the groups should make sense too, e.g., mged and archer are our main modeling interface tools, so they should be easily located not just somewhere on the page.

Sean on November 26 2013 06:11 UTCTask Needs More Work

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.

Alexon November 26 2013 17:43 UTCchanges done

ok i have got rid of the miscellaneous category and have rearranged the alphabetically. 

Alexon November 26 2013 17:51 UTCReady for review

The work on this task is ready to be reviewed.

Sean on November 27 2013 06:36 UTCMore cleanup

Alex,


That's looking better, but there are a few issues remaining:



  • some of the commands are capitalized on your sheet (undoubtedly automatically), but those are incorrect and will result in command-not-found errors

  • mged and archer are modeling commands, belong in your modeling category

  • use U.S. spelling, not Brittish (e.g., modeling not modelling).  check for other similar issues.

  • convert should be Geometry Conversion

  • asterisks are missing on the *-g and g-* converters

  • some descriptions begin with a capital letter, some with a lowercase letter.  should be consistenly one or the other.

  • "Texture scale" is not a tool name.

  • description of archer and mged are self-referential, and that's bad.  makes for a useless description.  explain what they are and how they differ from each other (i.e., archer is a next-generation prototype modeling interface, mged is the main geometry editing application interface.

  • the animation tools seem incomplete and out-of-place compared to the other categories.  need to expand or eliminate.

  • The options make no sense presented that way.  Presumably, they'd be options that apply to all tools, but that is not true.  Need to justify the intent or replace that section with another more useful section (like more image conversion processing tools)


Remember to look at the example quick-reference card URLS that were provided for inspiration and ideas.  In particular, our existing MGED command reference card and the git reference card are quite relevant.  We can create a follow-on guide to styleize the card and make it "pretty", but you should be thinking about the layout a little more.  This is a good start, but you need to put a little more attention to detail throughout for it to be useful.


 

Sean on November 27 2013 06:36 UTCTask Needs More Work

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.

Sean on November 27 2013 06:36 UTCDeadline extended

The deadline of the task has been extended with 1 days and 12 hours.

Alexon November 27 2013 19:26 UTCworked on

thanks for the detailed feedback i have taken your points on board and worked on them. i have tried to make the page look better also. 

Alexon November 27 2013 19:32 UTCReady for review

The work on this task is ready to be reviewed.

Sean on November 28 2013 06:45 UTCTask Closed

Congratulations, this task has been completed successfully.

Sean on November 28 2013 06:46 UTCNice work

Nice improvements Alex!  That's looking like the start of something very useful.


Pretty sure I've mentioned it to you already, but if not ... you may wish to join our brlcad-news mailing list if/when we announce your new quick reference sheet at some point in the future.


 

Alexon November 28 2013 07:32 UTC

yes i have joined the mailing list