Block Diagram - Revision history

Logmanoriginal: Link to actual page instead of redirect page

2023-05-06T17:06:03Z

Link to actual page instead of redirect page

← Older revision		Revision as of 17:06, 6 May 2023
Line 48:		Line 48:
	=== Documentation ===		=== Documentation ===
	* When providing in-code documentation, document the ''Why's'' rather than the ''What's''. If code is written well, what the code does should be easy to read. The documentation should help programmers viewing the code understand the original programmers reasoning and intent.		* When providing in-code documentation, document the ''Why's'' rather than the ''What's''. If code is written well, what the code does should be easy to read. The documentation should help programmers viewing the code understand the original programmers reasoning and intent.
	* Add [[Documentation\|documentation]] at the appropriate level. [[Documentation]] can be added to the [[VI\|VIs]], [[Node\|Nodes]], [[Wire\|Wires]], [[Subdiagram\|Subdiagrams]], [[Constant\|Constants]] and as [[~~Free Label~~\|~~Free Labels~~]] on the Block Diagram.		* Add [[Documentation\|documentation]] at the appropriate level. [[Documentation]] can be added to the [[VI\|VIs]], [[Node\|Nodes]], [[Wire\|Wires]], [[Subdiagram\|Subdiagrams]], [[Constant\|Constants]] and as [[free label\|free label]]s on the Block Diagram.

	=== Design Patterns ===		=== Design Patterns ===

Logmanoriginal: Link to actual page instead of redirect page

2023-05-06T17:04:30Z

Link to actual page instead of redirect page

← Older revision		Revision as of 17:04, 6 May 2023
Line 32:		Line 32:

	=== Decorations ===		=== Decorations ===
	'''[[Decoration]]s''' are cosmetic elements that do not affect the operation of the code. Some decorations, such as [[~~Free Label~~]]s serve as in-code documentation.		'''[[Decoration]]s''' are cosmetic elements that do not affect the operation of the code. Some decorations, such as [[free label]]s serve as in-code documentation.

	==== Free Labels ====		==== Free Labels ====
	'''[[Free ~~Label~~]]s''' serve as in-code documentation. They can be free floating or attached by arrow to specific [[Node\|nodes]]. Free label that contain a hashtag '''(#)''' are known as [[Bookmark]]s and can be found throughout the [[Project]] using the [[Bookmark Manager]].		'''[[Free label]]s''' serve as in-code documentation. They can be free floating or attached by arrow to specific [[Node\|nodes]]. Free label that contain a hashtag '''(#)''' are known as [[Bookmark]]s and can be found throughout the [[Project]] using the [[Bookmark Manager]].

	== Best Practices ==		== Best Practices ==

Logmanoriginal: /* Tips and tricks */ Add performance tips

2020-05-15T12:39:29Z

Tips and tricks: Add performance tips

@@ Line 140: / Line 140: @@
 * Select a node and press '''Ctrl+F''' to open the '''Find''' dialog with the selected node as search parameter.
 * In the '''Search Results''' dialog, press '''Ctrl+G''' to go to the next match and '''Shift+Ctrl+G''' to go to the previous match.
 == See Also ==

Logmanoriginal: /* Tips and tricks */ Add searching tips

2020-05-15T12:36:27Z

Tips and tricks: Add searching tips

← Older revision		Revision as of 12:36, 15 May 2020
Line 136:		Line 136:
	* Right-click a subVI and select '''Call Setup''' to configure it for dynamic call at runtime. ''Note: This option is not commonly used.''		* Right-click a subVI and select '''Call Setup''' to configure it for dynamic call at runtime. ''Note: This option is not commonly used.''
	[[Image:Configuring the Call Setup.png\|center\|thumb\|300px\|Calling a VI dynamically using the Call Setup menu option]]		[[Image:Configuring the Call Setup.png\|center\|thumb\|300px\|Calling a VI dynamically using the Call Setup menu option]]

			=== Searching ===
			* Select a node and press '''Ctrl+F''' to open the '''Find''' dialog with the selected node as search parameter.
			* In the '''Search Results''' dialog, press '''Ctrl+G''' to go to the next match and '''Shift+Ctrl+G''' to go to the previous match.

	== See Also ==		== See Also ==

Logmanoriginal: /* Tips and tricks */ Add tips and tricks for calling or creating a subVI

2020-05-15T12:34:21Z

Tips and tricks: Add tips and tricks for calling or creating a subVI

@@ Line 124: / Line 124: @@
 * Use the [[system label]] (formally known as dialog label) from the controls palette, to label wires on the block diagram. The background color of this label will automatically adjust to the background color of the owning diagram (it is not transparent).
 [[Image:Dialog label example.png|thumb|center|400px|Dialog label example]]
 == See Also ==

Logmanoriginal: /* Tips and tricks */ Add documentation tips

2020-05-15T12:28:31Z

Tips and tricks: Add documentation tips

@@ Line 112: / Line 112: @@
 * Select '''Tools > Navigation Window''' to display an overview of the front panel or block diagram.
 * Press '''Ctrl+T''' to split the screen between the front panel and block diagram. Press '''Ctrl+Z''' to undo this operation. (It may be convenient to disable this feature under '''Tools > Options > Menu Shortcuts''' because '''Ctrl+T''' and '''Ctrl+R''' are very close on the keyboard.)
 == See Also ==

Logmanoriginal: /* Tips and tricks */ Add navigation tricks and minor style improvements

2020-05-15T12:18:29Z

Tips and tricks: Add navigation tricks and minor style improvements

← Older revision		Revision as of 12:18, 15 May 2020
Line 54:		Line 54:

	== Tips and tricks ==		== Tips and tricks ==
			=== General ===
	* Press '''Ctrl''' and drag to make more space on the block diagram (press '''Esc''' to abort).		* Press '''Ctrl''' and drag to make more space on the block diagram (press '''Esc''' to abort).
	* Press '''Alt+Ctrl''' and drag to remove space on the block diagram (press '''Esc''' to abort).		* Press '''Alt+Ctrl''' and drag to remove space on the block diagram (press '''Esc''' to abort).
Line 67:		Line 68:
	[[Image:switching application instances.png\|center\|thumb\|300px\|Switching application instances]]		[[Image:switching application instances.png\|center\|thumb\|300px\|Switching application instances]]
	* Double-click a terminal on the block diagram to highlight the corresponding control or indicator on the front panel. This also works for local variables and references.		* Double-click a terminal on the block diagram to highlight the corresponding control or indicator on the front panel. This also works for local variables and references.

	=== Moving objects ===		=== Moving objects ===
	* Press '''Shift''' before moving an object, to restrict the direction to horizontally or vertically, respectively.		* Press '''Shift''' before moving an object, to restrict the direction to horizontally or vertically, respectively.
Line 78:		Line 80:
	\|-		\|-
	\|}		\|}
	===Wiring===
			=== Wiring ===
	* While wiring		* While wiring
	** Press '''Esc''', right-click or click the source terminal to cancel the wire operation.		** Press '''Esc''', right-click or click the source terminal to cancel the wire operation.
Line 99:		Line 102:
	* On a broken wire between an array and a scalar, select '''Insert Index Array''' or '''Insert Build Array''' from the right-click menu, respectively, to fix the broken wire.		* On a broken wire between an array and a scalar, select '''Insert Index Array''' or '''Insert Build Array''' from the right-click menu, respectively, to fix the broken wire.
	* Select '''Description and Tip''' from the right-click menu to add a meaningful name to the wire. The name will appear in the Context Help window. ''Note: Adding wire descriptions is unusual in LabVIEW. They disappear when the wire is removed. Use free labels instead.''		* Select '''Description and Tip''' from the right-click menu to add a meaningful name to the wire. The name will appear in the Context Help window. ''Note: Adding wire descriptions is unusual in LabVIEW. They disappear when the wire is removed. Use free labels instead.''

			=== Navigation ===
			* Scroll on the horizontal scroll bar to scroll left and right.
			* Scroll on the vertical scroll bar to scroll up and down.
			* Press '''Shift''' while scrolling to scroll faster.
			* Double-click on a SubVI to open the front panel of the SubVI.
			* Press '''Ctrl''' and double-click a SubVI to open the block diagram of the SubVI.
			* Press '''Ctrl''' and scroll to step through subdiagrams in '''[[Functions Palette/Programming/Structures/Case Structure\|Case Structure]]s''' and '''[[Functions Palette/Programming/Structures/Event Structure\|Event Structure]]s'''.
			* Select '''Tools > Navigation Window''' to display an overview of the front panel or block diagram.
			* Press '''Ctrl+T''' to split the screen between the front panel and block diagram. Press '''Ctrl+Z''' to undo this operation. (It may be convenient to disable this feature under '''Tools > Options > Menu Shortcuts''' because '''Ctrl+T''' and '''Ctrl+R''' are very close on the keyboard.)

	== See Also ==		== See Also ==

Logmanoriginal: /* Tips and tricks */ Split into subcategories and add wiring tips

2020-05-15T12:16:34Z

Tips and tricks: Split into subcategories and add wiring tips

@@ Line 67: / Line 67: @@
 [[Image:switching application instances.png|center|thumb|300px|Switching application instances]]
 * Double-click a terminal on the block diagram to highlight the corresponding control or indicator on the front panel. This also works for local variables and references.
 * Press '''Shift''' before moving an object, to restrict the direction to horizontally or vertically, respectively.
 * Use the '''arrow''' keys to move selected objects.
@@ Line 77: / Line 78: @@
 |-
 |}
 == See Also ==

Logmanoriginal: /* Tips and tricks */ Add movement tricks

2020-05-15T12:13:19Z

Tips and tricks: Add movement tricks

@@ Line 67: / Line 67: @@
 [[Image:switching application instances.png|center|thumb|300px|Switching application instances]]
 * Double-click a terminal on the block diagram to highlight the corresponding control or indicator on the front panel. This also works for local variables and references.
 == See Also ==

Logmanoriginal: /* Tips and tricks */ Add terminal highlight trick

2020-05-15T12:10:22Z

Tips and tricks: Add terminal highlight trick

← Older revision		Revision as of 12:10, 15 May 2020
Line 66:		Line 66:
	* Right-click the application instance name on the status bar to quickly switch between application instances.		* Right-click the application instance name on the status bar to quickly switch between application instances.
	[[Image:switching application instances.png\|center\|thumb\|300px\|Switching application instances]]		[[Image:switching application instances.png\|center\|thumb\|300px\|Switching application instances]]
			* Double-click a terminal on the block diagram to highlight the corresponding control or indicator on the front panel. This also works for local variables and references.

	== See Also ==		== See Also ==