Difference between revisions of "Component Help Files"

From Flowcode Help
Jump to navigationJump to search
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>Sidebar: Taking Flowcode Further</sidebar>
+
[[File:Gen_Components_Toolbar_Menu_Help_LED_Array.png|right]]
 +
'''Component Help Files''' can be found on the wiki and specific component help files can be easily accessed by selecting the arrow button [[File:Btn_Arrow.png]] next to the component and then clicking 'Help' from the drop-down context menu. Alternatively you can right click on a component in either the System or Dashboard panel and select the '''Help''' option from there to access the component help.
 +
 
 +
 
 
Help files for individual components can be found on the wiki by searching the [[Component]] name or guid with a prefix of the title and category of the component, for example:
 
Help files for individual components can be found on the wiki by searching the [[Component]] name or guid with a prefix of the title and category of the component, for example:
:''Component Outputs ComponentName'' = [[Component Outputs LCD]]
+
:'''Component:''', ''Component Name'', '''('''''Category''''')''' = [[Component:_LED_Array_(LEDs)]]
:''Component ID guid'' = [[Component ID 0953aac0 9c23 4c2f 9843 88954a4191ea]],
+
:'''Component: ID''', ''guid'' = [[Component: ID b07ae733 c144 4558 979a be737044519c]],
[[File:Gen_Component_Details_LED Array.png|right]]
+
 
These component help files on the wiki can also be accessed from Flowcode by selecting the '?' button on the component details page.
+
[[File:Gen_Component_Details_LED_Array.png|right]]
 +
 
 +
When creating or editing articles on the wiki, we advise you to link to component articles using the guid rather than the component name, this is recommended because it is a more versatile, reliable and consistent method.
  
The component details page contains the name, version number, description and guid of the component, this can be accessed by right clicking on or clicking the arrow button [[File:Btn_Arrow.png]] next to a component in the [[Tools and Views#2) Components Toolbar|Components Toolbar]] menu.
+
These component help files on the wiki can also be accessed from Flowcode by selecting the '?' button [[File:Btn_Question_Mark.png]] on the component details page.
  
[[File:Gen Components Toolbar Menu Details LED Array.png]]
+
The component details page contains the name, version number, description and guid of the component, this can be accessed by right-clicking on or clicking the arrow button [[File:Btn_Arrow.png]] next to a component in the [[Tools and Views#2) Components Toolbar|Components Toolbar]] menu.
  
  
 +
[[File:Gen Components Toolbar Menu Details LED Array.png|center]]
  
This allows additional components to be added at a later date, or from third parties, and have a help file which is accessible from Flowcode.
 
  
The help file will detail connections and operating details for the component as well as property references, [[Component Macro Icon Properties|Component Macros]] and [[Simulation Macro Icon Properties|Simulation Macros]] .
 
  
 +
This allows additional components to be added at a later date, or from third parties, and have a help file which is accessible from Flowcode and will link to the wiki to explain the component in further detail.
  
Help files for the standard components have also been added to this wiki to aid the user.
+
The help file will detail connections and operating details for the component as well as property references, [[Component Macro Icon Properties|Component Macros]] and [[Simulation Macro Icon Properties|Simulation Macros]] .

Latest revision as of 14:06, 25 April 2023

Gen Components Toolbar Menu Help LED Array.png

Component Help Files can be found on the wiki and specific component help files can be easily accessed by selecting the arrow button Btn Arrow.png next to the component and then clicking 'Help' from the drop-down context menu. Alternatively you can right click on a component in either the System or Dashboard panel and select the Help option from there to access the component help.


Help files for individual components can be found on the wiki by searching the Component name or guid with a prefix of the title and category of the component, for example:

Component:, Component Name, (Category) = Component:_LED_Array_(LEDs)
Component: ID, guid = Component: ID b07ae733 c144 4558 979a be737044519c,
Gen Component Details LED Array.png

When creating or editing articles on the wiki, we advise you to link to component articles using the guid rather than the component name, this is recommended because it is a more versatile, reliable and consistent method.

These component help files on the wiki can also be accessed from Flowcode by selecting the '?' button Btn Question Mark.png on the component details page.

The component details page contains the name, version number, description and guid of the component, this can be accessed by right-clicking on or clicking the arrow button Btn Arrow.png next to a component in the Components Toolbar menu.


Gen Components Toolbar Menu Details LED Array.png


This allows additional components to be added at a later date, or from third parties, and have a help file which is accessible from Flowcode and will link to the wiki to explain the component in further detail.

The help file will detail connections and operating details for the component as well as property references, Component Macros and Simulation Macros .