Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow editing of notes in inspector #1280

Open
larkin opened this issue Oct 21, 2016 · 8 comments
Open

Allow editing of notes in inspector #1280

larkin opened this issue Oct 21, 2016 · 8 comments
Labels
help_wanted Help the Open MCT project!
Milestone

Comments

@larkin
Copy link
Contributor

larkin commented Oct 21, 2016

The notes field is hard to edit for objects that use edit mode. For instance, a display layout will show notes in the inspector, but editing that display layout does not give you a way to edit the notes. Instead you have to right click -> edit properties. It would be nice to make it easier to edit notes.

@larkin larkin modified the milestones: Sagan, Robinson Oct 21, 2016
@larkin
Copy link
Contributor Author

larkin commented Oct 21, 2016

@charlesh88 to do some UI sketches so we can make this into a help-wanted.

@larkin larkin removed the question label Oct 24, 2016
@charlesh88
Copy link
Contributor

Here's a UI sketch of how Notes could be extended into the Inspector in both browse and edit modes. There may be a case for allowing Notes to always be editable - that is, during browse mode as well. That said, starting with Notes editable via the Inspector only during Edit mode (and in the Properties dialog as currently implemented) is IMO the best way to initially implement this.

UI Open MCT v2.2.0 sketches.Notes and Inspector only.pdf

@charlesh88 charlesh88 added the help_wanted Help the Open MCT project! label Oct 27, 2016
@charlesh88 charlesh88 removed their assignment Oct 27, 2016
@larkin larkin modified the milestones: Robinson, Roddenberry Nov 14, 2016
@larkin larkin modified the milestones: Roddenberry, Sagan Dec 5, 2016
@charlesh88 charlesh88 modified the milestones: Sagan, Shelley Jan 11, 2017
@charlesh88 charlesh88 modified the milestones: Shelley, Simmons Jan 24, 2017
@charlesh88 charlesh88 modified the milestones: Simmons, Stephenson Feb 14, 2017
@charlesh88 charlesh88 removed this from the Simmons milestone Feb 14, 2017
@evanohara
Copy link

If you wanted to go ahead and assign me to this, I have a working solution to this. I am new to MVC/angular and contributing to open source. I am modifying it to make sure I think it is structured correctly. Thanks.

@akhenry
Copy link
Contributor

akhenry commented Feb 15, 2017

@evanohara Thanks for looking into this. I'm not able to assign issues to folks outside the NASA organization, but consider it assigned 😄

@charlesh88 charlesh88 modified the milestones: Stephenson, Sterling Mar 6, 2017
@evanohara
Copy link

Just wanted to give you an update. I have a solution that I am happy with. I still have a little work ahead of me with the unit tests. This would also be my first real leap into designing unit tests but I'm having fun. Is there a better forum to ask general things about the project or to get clarification? Thanks!

@larkin
Copy link
Contributor Author

larkin commented Mar 10, 2017

You can always email us at [email protected] and we usually respond pretty quick-- best between 8am and 6pm but usually pretty good for discussion. Otherwise, feeel free to leave comments here and we can respond publicly.

@akhenry
Copy link
Contributor

akhenry commented Mar 13, 2017

@evanohara Glad to hear you're having fun! In preparation for preparing a PR it's worth taking a look at the page on contributing on our website. It includes links to useful information about our process, and most importantly a link to the Contributor License Agreement which we will need signed before we can merge any of your code.

Once again, thanks for taking the time to help us out!

evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
Separated the notes property into a new region in order to allow it to
be hidden when in edit mode.  An editable template will take its place
in edit mode.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
Separated notes from object-properties to allow it to be hidden in
edit mode.  A new region will be added for the editable version.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
Created a new edit-notes.html and a corresponding EditNotesController
to be used to replace the notes region when in edit mode.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
Created the EditNotesService.js to allow for communication between
SaveAction and EditNotesController.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
EditNotesController now keeps the EditNotesService up to date with
any input the user enters into the textbox.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
SaveAction and SaveAndStopEditingAction now depend on EditNotesService
to allow the saving of the new notes property when these actions are
clicked.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
The bundle has been updated to reflect the new dependencies.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
SaveAction and SaveAndStopEditingAction simply needed dependencies
for EditNotesService.  InspectorRegion now expects 3 regions instead
of 1.

nasa#1280
evanohara added a commit to evanohara/openmct that referenced this issue Mar 19, 2017
Simple test cases added for new classes.

nasa#1280
charlesh88 added a commit that referenced this issue Mar 20, 2017
Fixes #1280
Added margin-bottom to .l-inspector-part;
Added class to edit-notes.html;
@charlesh88 charlesh88 assigned akhenry and unassigned akhenry Mar 20, 2017
@larkin larkin modified the milestones: Sterling, Stross Apr 5, 2017
@evanohara
Copy link

Sure! No problem. I sent the CLA to Kim. I've had some time to think about other ways to solve this. I mostly didn't like adding dependencies to any existing code. It seems if possible my contribution should stand alone. One solution would be to add a separate edit/save button just for the notes. I'll wait to hear what you think though. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help_wanted Help the Open MCT project!
Projects
None yet
Development

No branches or pull requests

4 participants