Create an MGED Interface reference sheet (#2)BRL-CAD
Status: ClosedTime to complete: 48 hrs Mentors: SeanTags: interface, GUI, reference

BRL-CAD's primary geometry editor is called MGED. MGED's documentation is extensive but incomplete without a concise 1 or 2 page document that details MGED's interface.

This task involves writing an interface reference document that gives a brief descriptive overview of the key bindings, mouse bindings, and primary GUI elements.  It should minimally include the command window, the graphics window, the raytrace control panel, the combination editor, the geometry tree view, and overview graphics window key bindings.

See the below examples!

References:

Examples:

Uploaded Work
File name/URLFile sizeDate submitted
Introduction to Mged.docx208.5 KBDecember 26 2012 09:12 UTC
Introduction to Mged2.docx333.5 KBDecember 26 2012 15:58 UTC
Introduction to Mged3.docx504.2 KBDecember 27 2012 16:00 UTC
Introduction to Mged4.docx505.3 KBDecember 27 2012 17:25 UTC
Brlcad1.jpg581.9 KBDecember 28 2012 17:09 UTC
brlcas2.zip1.2 MBDecember 29 2012 17:45 UTC
Comments
Ashishon December 18 2012 16:21 UTCI need to ...

So i just need to briefly describe these - key bindings, mouse bindings, and primary GUI elements.  It should minimally include the command window, the graphics window, the raytrace control panel, the combination editor, the geometry tree view, and overview graphics window key bindings. 





Nothing else ??  


ps. i am taking this- http://www.tuxmagazine.com/system/files/Touring_The_GIMP.pdf as a model So0?? 

Sean on December 18 2012 16:34 UTCwell it did say minimally

That's what should be minimally included but it entirely depends on the design and information being presented.  There was a wide range of examples provided, some more and others less complicated.


Regardless of the format, this is meant to be concisely and precisely informative and it needs to look good.  It's going to be seen by tens of thousands of people if we use it.  Throwing a slew of screenshos and sentences into a word document won't be accepted.  It needs to be aesthetically presented, well organized, and usefully informative...


So "yes", but we expect you to put effort in and do a great job. ;)


 

Ashishon December 24 2012 18:08 UTCTask Claimed

I would like to work on this task.

Harmanpreet Singh on December 24 2012 18:15 UTCTask Assigned

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

Harmanpreet Singh on December 24 2012 18:21 UTCRead and understand

Though the task has been assigned to you, but it is recommended that you should read carefully and understand the task description and Sean's above mentioned comment before starting your work. It will save your time.

Ashishon December 26 2012 09:16 UTCTill now

I did this much as i was having some troubles using it in windows 


an extension will be needed 
and pleas tell if i am not following any of your instructions  

Ashishon December 26 2012 16:02 UTCAnother

There u go another file more work is needed i know but more time 

Harmanpreet Singh on December 26 2012 17:51 UTCDeadline extended

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

Ashishon December 26 2012 17:59 UTCWhat about

What about the work .. Am i doing it right ??


 

Ashishon December 27 2012 16:00 UTCReady for review

The work on this task is ready to be reviewed.

Ashishon December 27 2012 17:26 UTCDone

I think i have covered everything 


If not please tell me and increase the time :) 

Melange on December 28 2012 03: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.

Sean on December 28 2012 07:59 UTClayout, concise

So content-wise, you are spot-on and have done well to describe everything listed.  The layout/style/design, however, is a bit insane though... :)  10 pages!


Try to fit that all on just 1 or 2 pages.  These will be "print-quality" pages, so it's okay to go all the way out to the edge of a margin, okay to use small fonts (so long as it's still readable in pdf/printed form), okay to have small images, etc.  See our mged cheat sheet listed in the references.


You have the content and some great examples..  All that's left is fitting it into a tight space and organizing it all so that it makes sense.  You'll probably want to use columns and get creative.

Sean on December 28 2012 07:59 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 December 28 2012 07:59 UTCDeadline extended

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

Ashishon December 28 2012 17:08 UTCDone

I had no idea how to coincise 10 pages into 1-2   so i just ollowed the example 


http://izatxamir.files.wordpress.com/2010/04/visio-2007-quick-reference-1.jpg   here 


Hope this is good enough 

Ashishon December 28 2012 17:12 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 29 2012 05:45 UTCthat's exactly how

That's exactly how you condense 10 pages into 1-2!


That is also definitely closer to what is needed for this task. Good work.  There are a few details to clean up, however.  There are LOTS of consistency problems:



  • I counted 8 different font sizes being used!  You shouldn't need more than 3 or 4.  All fonts of the same type sould be the same font (size and style).

  • You have five "boxes" but you only label two of them (The Combination Editor and Shader Options).  The teal titlebar clearly attempts to label two more, but is confusing as they don't make sense (the quotes are silly and "Keyboard Shortcuts" is wrong).

  • Some of your leader lines have shadows and some do not... should be all or none.  Some are bigger and smaller fonts.  They should all be the same size, font, and style.

  • The two shortcut tables are wrong presented as "Keyboard Shortcuts".  The first table are mouse bindings for the graphics window.  The second table is key bindings for the command window.


I suggest taking advantage of the natural layout paring and make the page be a 2-column layout with graphics window on left and graphics window mouse bindings on right.  Then command window on the next row with command window bindings on right.  Then raytrace control panel on left and maybe the geometry browser on the right.  Then combination editor and shader/color options on the last row.


Please provide an editable version of your layout in addition to any jpg/png preview image.  We'll need to be able to make changes to your page over time if we use this, right? :)


Again, nice work.  Just need to work on the consistency issues and this should be complete!

Sean on December 29 2012 05:45 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 December 29 2012 05:45 UTCDeadline extended

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

Ashishon December 29 2012 08:42 UTCFormat

Whcih format is fine for your editing purpose-- I am just using a screen shot utility by just taking screen shots and adding lines....


What format whould u like it in ??

Ashishon December 29 2012 17:44 UTCTried

Every letter now has a shadow


All font types are   12,26 and 48 


The zipped file contains a jpg and a psd(Photoshop compatible) file that you can use for editing


Ps. I tried doing what you asked aout the 2 colounm thingi but i did not do it as my command window sixe does not correspond to the numerous amount of Bindings for the command window and it looks very Odd leaving large white spaces and lets just say it looked ugly... 


 

Ashishon December 29 2012 17:45 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 29 2012 20:06 UTCokay

Unfortunately without the column cleanup and other changes (title bar, table going off the page, inconsistent arrows), we won't be able to publish your sheet as-is to our community as new documentation.  However, it will make for a nice guide for the next person (and we'll be sure to credit you accordingly).  Thanks for your efforts!


If you'd like to keep working on the sheet, let me know and we can work on characterizing a new follow-on task.


 

Sean on December 29 2012 20:06 UTCTask Closed

Congratulations, this task has been completed successfully.

Ashishon December 30 2012 02:47 UTCThanks

Will there be a follow up task for the other Mock up your Website thingi ??

Sean on January 10 2013 06:09 UTCthingi?

Ashish, I'm not sure what you're referring to but we can certainly add tasks if there's follow-up work you're interested in working on.  I noticed that it seems you're just one task completion away from the free t-shirt prize. ;)

Ashishon January 10 2013 10:17 UTCI Would love it !

Seriously i would love to do the Mock brlcad's interface !! 


But my studies for my board exams have started andi get only 1 hour a day on the computer for maintaining my site and all !! 


BTW i think i am getting a Tshirt cause i have completed 3 tasks .. One more from ownCloud 


Thanks.. For all the help--- WIll participaet next year...hope to do well next time  :) 

Sean on January 10 2013 11:02 UTCvery good

Ah, very good then.  The good thing about open source is that you can participate any time and regardless of GCI so feel free to stop by on our IRC channel or mailing list after your exams are over and contribute to anything that interests you.  Working with open source can be very fun and rewarding regardless of t-shirts. ;)

Ashishon January 10 2013 13:08 UTCOf course ...

After this exam - Supposed to be oneof the 2 biggest exams in my school life i get A full free time for 2 months...


Ps. yes i will come back to work with u guys after ICSE  :) 
Till then wish me luck !!