Layout MGED Interface Reference DocumentBRL-CAD
Status: ClosedTime to complete: 72 hrs Mentors: Sean, Harmanpreet SinghTags: interface, gui, design, layout

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

This task involves taking the content gathered in a previous GCI task and making it all fit neatly on just one page.  It'll give a brief descriptive overview of the key bindings, mouse bindings, and primary GUI elements. It should include a screenshot/image that includes the command window, graphics window, raytrace control panel, combination editor, and geometry tree view.  It should incorporate the known key/mouse bindings.

References:

Examples:

Uploaded Work
File name/URLFile sizeDate submitted
TASK.bmp3.8 MBDecember 05 2012 18:11 UTC
Task2.bmp3.8 MBDecember 07 2012 18:48 UTC
mgen htkeys.txt556 bytesDecember 07 2012 19:00 UTC
mged_interface_document.psd2.4 MBDecember 25 2012 14:54 UTC
mged_interface_document(1).psd2.5 MBDecember 26 2012 14:37 UTC
mged_interface_document2.xcf1.1 MBDecember 28 2012 20:23 UTC
mged_interface_document2.png416.9 KBDecember 28 2012 20:26 UTC
mged_interface_document(3).psd2.7 MBDecember 31 2012 15:15 UTC
mged_interface_document(3).jpg292.9 KBDecember 31 2012 15:21 UTC
Comments
Krasimir Stoikovon November 29 2012 10:05 UTCTask Claimed

I would like to work on this task.

Andrei Popescu on November 29 2012 10:14 UTCTask Assigned

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

Krasimir Stoikovon December 1 2012 13:45 UTCClaim Removed

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

Shayantanon December 4 2012 18:41 UTCTask Claimed

I would like to work on this task.

Andrei Popescu on December 4 2012 19:22 UTCTask Assigned

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

Shayantanon December 5 2012 18:12 UTCReady for review

The work on this task is ready to be reviewed.

Daniel Rossberg on December 6 2012 20:18 UTCYou did the screenshot part of this task (only)

Your screenshot contains



  • command window

  • graphics window

  • raytrace control panel


but it's missing



  • combination editor

  • geometry tree view

Daniel Rossberg on December 6 2012 20:18 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.

Shayantanon December 7 2012 17:48 UTCExtension

Please Give Me An Extension .

Harmanpreet Singh on December 7 2012 17:51 UTCDeadline extended

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

Shayantanon December 7 2012 19:01 UTCReady for review

The work on this task is ready to be reviewed.

Sean on December 7 2012 19:51 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 7 2012 19:53 UTCwhat?

Shayantan,


Did you look at the provided references?  I think you may be completely miunderstanding this task.  The task is not to make a screenshot -- even if it were, this would be a terrible screenshot. :)  The task is to document the interface like in the various examples.


If you need more time, that's fine but be sure you understand the task before proceeding.

Shayantanon December 8 2012 16:54 UTCSorry

I Completely Misunderstood the task cause i didnt have adobe reader to view the pdf files. very sorry. now t hat i have it, i can accomplish the task.  can you please extend my deadline further ?

Harmanpreet Singh on December 8 2012 17:05 UTCDeadline extended

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

Sean on December 8 2012 18:12 UTCDeadline extended

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

Melange on December 11 2012 18:07 UTCTask Reopened

Melange has detected that the final deadline has passed and it has reopened the task.

Deep Inder Singhon December 21 2012 16:43 UTCTask Claimed

I would like to work on this task.

Sean on December 21 2012 16:43 UTCTask Assigned

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

Deep Inder Singhon December 24 2012 13:20 UTCExtend deadline

Please extend my dead line for one day


 

Harmanpreet Singh on December 24 2012 14:08 UTCDeadline extended

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

Deep Inder Singhon December 25 2012 14:55 UTCwork done so far

I have uploaded my work done so far.I am still working on it,but am running out of time.Can you please give me another extension?

Harmanpreet Singh on December 25 2012 16:31 UTCDeadline extended

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

Deep Inder Singhon December 25 2012 16:59 UTCThanks

Thank you... :)

Deep Inder Singhon December 26 2012 14:38 UTCReady for review

The work on this task is ready to be reviewed.

Melange on December 26 2012 16:47 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 26 2012 22:23 UTChm, that's better

Deep, that's good progress and excellent content.  The layout could use some more work, though.  Some critiques to address:



  • the color scheme is a bit weak and inconsistent, ditch the teal, differentiate between the different sections

  • the fonts are inconsistent.  stick to just three or four sizes/fonts including your title headers.

  • padding: don't let text go right up to the edge of a box (e.g., "button 1" and "Keys" and a dozen others)

  • alignment: columns should be consistently left-aligned or centered.

  • images are scaled inconsistently, they should maintain the original aspect ratio.  this is most obvious with the raytrace control panel where it is squished

  • lots of dead space -- what's with the white panel on the right?  should use the entire page more effectively.


Like I said, the content is great and probably sufficient.  The layout, however, is severely lacking all around and needs to be polished.  If you see things that inconsistent, you should fix them (I certainly see them all and more that I haven't mentioned).

Sean on December 26 2012 22:24 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 26 2012 22:24 UTCDeadline extended

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

Deep Inder Singhon December 28 2012 20:26 UTCReady for review

The work on this task is ready to be reviewed.

Melange on December 29 2012 06:18 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 29 2012 06:29 UTCstill has inconsistencies

Deep,


That's looking better but there are still several problems:



  • two biggest words on the page are "Key Bindings" and "Mouse Bindings" and they're stretched out horizontally... that looks bad

  • that entire first column looks stretched (bad) and runs to the very edge of the image. It needs to have some internal padding.

  • combination editor image looks corrupted (what's the big P in the middle) and the title has a typo(!)

  • The center "MGED Graphic Window" panel should be "MGED Graphics Window", NOT be two separate fonts.

  • The center panel has great padding around the descriptive text. Why are none of the rest like that?


There are more issues, but that's a list to get started with.  If you see something that can be improved, be assurred that I see it too and it needs to be fixed if we're going to use your document (and we DO want to use it!)...


The biggest issue so far is the consistency, capitalization, and padding problems.  Fix those, and we can consider the task complete with maybe a follow-on task to clean up the content itself.  Either the layout needs to be perfect or the content needs to be perfect (or both).  Right now, you have problems with both.

Sean on December 29 2012 06:29 UTCDeadline extended

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

Sean on December 29 2012 06:29 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.

Deep Inder Singhon December 31 2012 15:16 UTCReady for review

The work on this task is ready to be reviewed.

Harmanpreet Singh on January 1 2013 02:24 UTCTask Closed

Congratulations, this task has been completed successfully.

Harmanpreet Singh on January 1 2013 02:29 UTCMuch Better

Hi Deep,


Now the document look much better than your previous submissions. Adding mouse figure is good decision. We may need to add a follow on task to clean up the contents. 


Anyway, thanks for your efforts. :)

Sean on January 14 2013 15:10 UTCthank you

As GCI comes to a close, we wanted to take the time to say THANK YOU for all your efforts.  This comment interface closes after GCI is over, so you're encouraged to join our mailing list where we'll be announcing contributions from GCI participants like yourelf over the upcoming months: 


https://lists.sourceforge.net/lists/listinfo/brlcad-news


If you've provided your full name, we'll be sure to credit you in our authorship documentation and you'll see your name in a future announcement.  If you contact us at devs@brlcad.org or via IRC, we'll even let you know when your work is integrated and follow up with updates.  You're welcome and encouraged to contact us any time, especially if you have a question about how to continue participating in Open Source after GCI is over, but even if just to keep in touch.  Note that ongoing participation in Open Source is one of the most impressive skills to have on your resumé.  Take care, be well, and thank you again!