Skip to content

NodesHelpDocumentation 12 Nodes#3399

Open
stevecbc wants to merge 1 commit into
DynamoDS:masterfrom
stevecbc:SteveDeWitt_NodeDocumentation_Batch3-5
Open

NodesHelpDocumentation 12 Nodes#3399
stevecbc wants to merge 1 commit into
DynamoDS:masterfrom
stevecbc:SteveDeWitt_NodeDocumentation_Batch3-5

Conversation

@stevecbc
Copy link
Copy Markdown
Collaborator

Revit.Elements.Subelement.Category
Revit.Elements.Subelement.Element
Revit.Elements.Subelement.GetAllParameters
Revit.Elements.Subelement.GetParameterValue
Revit.Elements.Tag.LeaderElbow
Revit.Elements.Views.AxonometricView.ByEyePointTargetAndBoundingBox Revit.Elements.Views.PerspectiveView.ByEyePointAndTarget Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndBoundingBox Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndElement Revit.Filter.FilterRule.ByRuleType
Revit.GeometryReferences.ElementCurveReference.ByCurve Revit.GeometryReferences.ElementFaceReference.BySurface

Please Note:

  1. Before submitting the PR, please review How to Contribute to Dynamo
  2. Dynamo Team will meet 1x a month to review PRs found on Github (Issues will be handled separately)
  3. PRs will be reviewed from oldest to newest
  4. If a reviewed PR requires changes by the owner, the owner of the PR has 30 days to respond. If the PR has seen no activity by the next session, it will be either closed by the team or depending on its utility will be taken over by someone on the team
  5. PRs should use either Dynamo's default PR template or one of these other template options in order to be considered for review.
  6. PRs that do not have one of the Dynamo PR templates completely filled out with all declarations satisfied will not be reviewed by the Dynamo team.
  7. PRs made to the DynamoRevit repo will need to be cherry-picked into all the DynamoRevit Release branches that Dynamo supports. Contributors will be responsible for cherry-picking their reviewed commits to the other branches after a LGTM label is added to the PR.

Purpose

(FILL ME IN) This section describes why this PR is here. Usually it would include a reference
to the tracking task that it is part or all of the solution for.

Declarations

Check these if you believe they are true

  • The code base 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
  • Snapshot of UI changes, if any.

Reviewers

(FILL ME IN) Reviewer 1 (If possible, assign the Reviewer for the PR)

(FILL ME IN, optional) Any additional notes to reviewers or testers.

FYIs

(FILL ME IN, Optional) Names of anyone else you wish to be notified of

Revit.Elements.Subelement.Category
Revit.Elements.Subelement.Element
Revit.Elements.Subelement.GetAllParameters
Revit.Elements.Subelement.GetParameterValue
Revit.Elements.Tag.LeaderElbow
Revit.Elements.Views.AxonometricView.ByEyePointTargetAndBoundingBox
Revit.Elements.Views.PerspectiveView.ByEyePointAndTarget
Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndBoundingBox
Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndElement
Revit.Filter.FilterRule.ByRuleType
Revit.GeometryReferences.ElementCurveReference.ByCurve
Revit.GeometryReferences.ElementFaceReference.BySurface
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds Dynamo node help documentation for 12 Revit nodes by introducing example .dyn graphs and corresponding English (en-US) fallback Markdown docs. These files support the in-product node help experience by providing runnable examples and “In Depth” descriptions with referenced screenshots.

Changes:

  • Added 12 node help example graphs (doc/distrib/NodeHelpFiles/*.dyn).
  • Added 12 en-US fallback help pages (doc/distrib/NodeHelpFiles/en-US/fallback_docs/*.md).
  • Included/linked example screenshots via the Markdown image references.

Reviewed changes

Copilot reviewed 24 out of 36 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
doc/distrib/NodeHelpFiles/Revit.GeometryReferences.ElementFaceReference.BySurface.dyn Adds a Dynamo graph example for creating an element face reference from a Revit-derived surface.
doc/distrib/NodeHelpFiles/Revit.GeometryReferences.ElementCurveReference.ByCurve.dyn Adds a Dynamo graph example for creating an element curve reference from a Revit-derived curve.
doc/distrib/NodeHelpFiles/Revit.Filter.FilterRule.ByRuleType.dyn Adds a Dynamo graph example for creating a filter rule and applying it to a view.
doc/distrib/NodeHelpFiles/Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndElement.dyn Adds a Dynamo graph example for creating a perspective view from eye/target points and an element.
doc/distrib/NodeHelpFiles/Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndBoundingBox.dyn Adds a Dynamo graph example for creating a perspective view from eye/target points and a bounding box.
doc/distrib/NodeHelpFiles/Revit.Elements.Views.PerspectiveView.ByEyePointAndTarget.dyn Adds a Dynamo graph example for creating a perspective view from eye/target points and element/bounding box input.
doc/distrib/NodeHelpFiles/Revit.Elements.Views.AxonometricView.ByEyePointTargetAndBoundingBox.dyn Adds a Dynamo graph example for creating an axonometric view from eye/target points and a bounding box.
doc/distrib/NodeHelpFiles/Revit.Elements.Tag.LeaderElbow.dyn Adds a Dynamo graph example for reading a tag leader elbow point.
doc/distrib/NodeHelpFiles/Revit.Elements.Subelement.GetParameterValue.dyn Adds a Dynamo graph example for retrieving a parameter value from a subelement.
doc/distrib/NodeHelpFiles/Revit.Elements.Subelement.GetAllParameters.dyn Adds a Dynamo graph example for listing parameter IDs on a subelement.
doc/distrib/NodeHelpFiles/Revit.Elements.Subelement.Element.dyn Adds a Dynamo graph example for retrieving the parent element of a subelement.
doc/distrib/NodeHelpFiles/Revit.Elements.Subelement.Category.dyn Adds a Dynamo graph example for retrieving the category of a subelement.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.GeometryReferences.ElementFaceReference.BySurface.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.GeometryReferences.ElementCurveReference.ByCurve.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Filter.FilterRule.ByRuleType.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndElement.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Views.PerspectiveView.ByEyePointTargetAndBoundingBox.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Views.PerspectiveView.ByEyePointAndTarget.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Views.AxonometricView.ByEyePointTargetAndBoundingBox.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Tag.LeaderElbow.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Subelement.GetParameterValue.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Subelement.GetAllParameters.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Subelement.Element.md Adds en-US fallback “In Depth” documentation and image reference for the node.
doc/distrib/NodeHelpFiles/en-US/fallback_docs/Revit.Elements.Subelement.Category.md Adds en-US fallback “In Depth” documentation and image reference for the node.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## In Depth
This node creates a Revit element curve reference from a Dynamo curve. A curve reference is useful when another Revit node needs a selectable or referenceable curve, rather than just Dynamo geometry. This is commonly used for workflows that require Revit references, such as creating dimensions, alignments, constraints, or other elements that need to reference model geometry.

In this example, a curve is selected and used as the input for ElementCurveReference.ByCurve. The output is an ElemenCurveReference that is then used as a Revit curve reference for downstream nodes that require curve-based references.
@@ -0,0 +1,8 @@
## In Depth
This node creates a new Revit perspective 3D view using an eye point, a target point, a element, a name and isolateElement.
## In Depth
This node creates a Revit filter rule based on a selected rule type, parameter, and comparison value.

In this example, a wall type is identified and the Fire Rating parameter is being used as an input to the FilterRule.ByRuleType node along with a value and rule type. The output is a filter is created. This filter is then applied to a view.
@@ -0,0 +1,8 @@
## In Depth
This node retrieves the category assigned to a Revit subelement. subelements are components or pieces of a larger Revit element, such as layers, mullions, curtain panels, rebars, or nested geometry that can exist within a parent element.
{
"Uuid": "67142c1b-51b1-4ea5-9a50-5cabca5e580e",
"IsCustomNode": false,
"Description": "Demonstration of RevitNodes.Revit.GeometryReferences.ElementCurveReference.ByCurve - shows how to create Revit curve references from existing element curves for parametric operations",
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants