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

Add DocumentEditor feature #36

Merged
merged 6 commits into from
Apr 22, 2019
Merged

Add DocumentEditor feature #36

merged 6 commits into from
Apr 22, 2019

Conversation

bdice
Copy link
Member

@bdice bdice commented Jan 31, 2019

Created a feature similar to Notes that allows users to edit the job document directly in the dashboard.

To Do:

  • Clean up error message HTML (so it wraps)
  • Mark saving errors in red!

@bdice bdice added the enhancement New feature or request label Jan 31, 2019
@bdice bdice changed the base branch from master to develop January 31, 2019 05:59
@bdice bdice changed the title Feature/document editor Add DocumentEditor feature Jan 31, 2019
@bdice bdice mentioned this pull request Feb 4, 2019
@bdice bdice changed the base branch from develop to master April 14, 2019 12:41
@bdice bdice requested a review from a team April 14, 2019 15:15
@bdice
Copy link
Member Author

bdice commented Apr 14, 2019

@glotzerlab/signac-developers I'd appreciate some thoughts on the user interface for this Job Document Editor module. It's like the Notes module but more advanced. It uses ast.literal_eval to ensure that lists and dicts are preserved in the document.
image

@bdice bdice self-assigned this Apr 14, 2019
@csadorf
Copy link
Contributor

csadorf commented Apr 14, 2019

Aren't there existing DOM elements for the modification of tree-like structures? As a user I would expect something more along these lines: http://www.htmldrive.net/items/show/203/CSS-and-Javascript-Style-your-Sitemaps-tree-menu

@bdice
Copy link
Member Author

bdice commented Apr 15, 2019

@csadorf Thanks for the feedback! It would be possible (but rather difficult) to do something like what you linked. There aren't really DOM elements made for this. It takes a considerable amount of customizing nested <ul> structures with JS/CSS since you have to deal with dynamic hiding/showing, and that's before we even add form fields. Hierarchical dynamic forms are super messy to write, from my experience. In general I prefer to stick to elements included in Bulma, for simplicity: https://bulma.io/documentation/

@csadorf
Copy link
Contributor

csadorf commented Apr 15, 2019

@bdice Got it. I think that the elements you are presenting are much better than nothing and I'm all for moving forward with that, I just think that they will be hard to work with when it comes to non-trivial hierarchical documents.

@bdice bdice merged commit 7cde824 into master Apr 22, 2019
@bdice bdice deleted the feature/document_editor branch December 14, 2019 01:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants