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.

Sign up for GitHub

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

Jump to bottom

DocumentationBrowserViewExtension Upgrade + Insert #13414

Merged
merged 39 commits into from
Nov 1, 2022
Merged

DocumentationBrowserViewExtension Upgrade + Insert #13414

merged 39 commits into from
Nov 1, 2022

Conversation

dnenov
Copy link
Collaborator

@dnenov dnenov commented Oct 20, 2022 •
edited
Loading

Purpose

This PR covers the work done in two directions:

  • DocumentationBrowserViewExtension Upgrade
  • Insert Functionality (new File Menu Item)

DocumentationBrowserViewExtension

  • Update the UI to modernize and align with the current design language of Dynamo
  • New functionality - interactive image panel with zoom in, zoom out and pan function
  • New functionality - insert dynamo example graph associated with node help information
  • New functionality - Warning notification message displays in the Documentation Browser UI

general usage_part 1
general usage_part 2
general usage_part 3

Insert

  • New File Menu Item - Dynamo now allows users to insert .dyn or .dyf (to confirm) in the current workspace environment.

insert

Declarations

Check these if you believe they are true

  • The codebase is in a better state after this PR
  • Is documented according to the standards
  • The level of testing this PR includes is appropriate
  • User facing strings, if any, are extracted into *.resx files
  • All tests pass using the self-service CI.
  • Snapshot of UI changes, if any.
  • Changes to the API follow Semantic Versioning and are documented in the API Changes document.
  • This PR modifies some build requirements and the readme is updated

Release Notes

(FILL ME IN) Brief description of the fix / enhancement. Mandatory section

Reviewers

@reddyashish

FYIs

@Amoursol

dnenov added 14 commits September 25, 2022 20:01
@dnenov
Stylesheet Update
263c0ce 
- updated the MarkdownStyling.html containing the css for styling the browser
- first updates to the NodeDocumentationHtmlGenerator to test the styling
@dnenov
HtmlGenerator Structure Change
11c1ee3 
- adopting the components of the new UI design
@dnenov
Markdown Moved
bd5ab74 
- location of markdown part of the document moved to the Node Information sections (first expander)
@dnenov
Input Output Table Style Update
3d1acd7 
- work on the table containing Inputs and Outputs
- css style changes
- dpi script change to allow for 100% width
@dnenov
Inputs Outputs Tables Finished
5aa8df5 
- restyling of inputs and outputs table done
@dnenov
Body Style Changes
5ff399e 
- slight changes to the left/right margin of the body
@dnenov
Image Navigation Started
4dc5d89 
- added the initial Image navigation implementation in javascript
- KNOWN ISSUES - HTML Sanitize will remove 'position: absolute/relative' from CSS code. Current workaround is very patchy and a better solution needs to be found
- button restyling WIP
- zoom-in/zoom-out recenters image (WIP)
@dnenov
Breadcrumbs ILayoutSpecSource Implementation, Image Navigation
77fa947 
- now reads the layoutspec.json by using the ILayoutSpecSource interface
- added a Func to ILayoutSpec to allow for the layoutspec.json to be retrieved after all extensions are loaded
- zooming in/out of image in browser javascript implementation
- styling WIP
- whitelisted CSS position property in Md2HtmlSanitizer
@dnenov
Image Navigation Styling
12edda3 
- added icons to image navigation buttons
- added an eventhandler to button click handling Insert function
@dnenov
Insert Functionality Started
987cab2 
- WIP Insert file from path
@dnenov
Insert Functionality Working with JSON Graphs
ea167c1 
- the full workflow now inserts a graph with all the relevant Annotations
- the functionality was added in the DynamoModel class
@dnenov
Dynamo Graph from MD File Location
98f60fd 
- now tries to find the corresponding Dynamo graph from the MarkDown location (fallback_docks folder)
@dnenov
DissolveNestedGroups Command Added, Multiple Changes to Documentation…
14274f8 
…BrowserViewExtension

- added a command to help 'dissolve' nested group into their parent group
- improved the logic when inserting links into file using the DocumentationBrowserViewExtension
@dnenov
Insert WIP
69f419d 
- progression work on 'Insert' function
dnenov added 5 commits October 21, 2022 16:43
@dnenov
Dyf | Dyn Split
aaf268d 
- will only allow for .dyn files to be inserted in HomeWorkspaceModel
- will only prompt for .dyf files to be inserted in CustomNodeWorkspaceModel
- the *.* option will still allow you to potentially mix-and-match, needs testing
@dnenov
Removed Prompt to Save File
553499c 
- when inserting no longer prompts the user to save the current progress
@dnenov
Toast Notifications Added
3453637 
- added notifications when flipping RunType to Manual before insertion
@dnenov
Note Alignment Fix
2b140c3 
- small fix for the location of notes outside group in DocumentaionBrowser routine
@dnenov
Initial Tests Added
ce6f658 
- added a test for the new Insert function
@reddyashish reddyashish marked this pull request as ready for review October 25, 2022 20:34
@dnenov
Image Controls - Visual Bump
e357f7f 
- aligning the style of the image control buttons to the existing workspace visual controls in Dynamo
dnenov added 3 commits October 29, 2022 13:22
@dnenov
RunSettings Tooltips Changes
ecc5159 
- changes to existing tooltips regarding RunSettings dropdown
- new ? info tooltip added to Preferences panel inline with Default Run Settings
@dnenov
Toast Notificaiton from DynamoModel to DynamoViewModel
9f18653 
- now raises a toast notification when failing to insert a graph due to nodes already existing in the workspace
@dnenov
Unsubscribe RequestNotification
2f7a2a9
@reddyashish
Copy link
Contributor

@dnenov Looks like there is one test that is failing: CheckThatEmbeddedHtmlContentDoesNotSanitize.

@dnenov
Mk2Html Whitlisting CSS Properties Added
7e9d00a 
- added properties used in MarkdownStyling.html
- removed unnecessary 'include' statements for the DocumentationBrowser project
- cleaned up unused code
reddyashish
reddyashish reviewed Oct 31, 2022
View reviewed changes
Copy link
Contributor

@reddyashish reddyashish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @dnenov. Looks good with some comments.

dnenov added 2 commits October 31, 2022 19:41
@dnenov
Comments
16fc325
@dnenov
Comments
b4e18bc 
- API break - introduced a separate overload to fix the potential issue
- used localized resource instead of hard-coded value
@reddyashish
Copy link
Contributor

Running the CI job here: https://master-15.jenkins.autodesk.com/view/DYN/job/DYN-DevCI_Self_Service/1099/

@dnenov
Test Fix
171249c 
- fixed expected result for CanCreateNodeDocumenationHtmlFromNodeAnnotationEventArgsWithPackageNodeWithAddtionalDocumentation
@reddyashish
Copy link
Contributor

Passed: https://master-15.jenkins.autodesk.com/view/DYN/job/DYN-DevCI_Self_Service/1102/

@reddyashish reddyashish merged commit ef6b0c1 into DynamoDS:master Nov 1, 2022
@RobertGlobant20 RobertGlobant20 mentioned this pull request Feb 1, 2023
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reddyashish reddyashish reddyashish approved these changes

@sm6srw sm6srw Awaiting requested review from sm6srw

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dnenov @reddyashish