Difference between revisions of "Component Help Files"
(11 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
− | <sidebar>Sidebar: | + | <sidebar>Sidebar: Flowcode Help Overview:Components</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. | ||
+ | |||
+ | |||
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, ''Category'' | + | :'''Component:''', ''Component Name'', '''('''''Category''''')''' = [[Component: LCD (Outputs)]] |
− | :Component ID, ''guid'' = [[Component ID 0953aac0 9c23 4c2f 9843 88954a4191ea]], | + | :'''Component: ID''', ''guid'' = [[Component: ID 0953aac0 9c23 4c2f 9843 88954a4191ea]], |
− | [[File: | + | |
+ | [[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 component name, this is the 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 [[File:Btn_Question_Mark.png]] on the component details page. | 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. | ||
Line 13: | Line 21: | ||
− | 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. | + | 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 Macro Icon Properties|Component Macros]] and [[Simulation Macro Icon Properties|Simulation Macros]] . | 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 16:57, 7 March 2014
<sidebar>Sidebar: Flowcode Help Overview:Components</sidebar>
Component Help Files can be found on the wiki and specific component help files can be easily accessed by selecting the arrow button next to the component and then clicking 'Help' from the drop-down context menu.
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: LCD (Outputs)
- Component: ID, guid = Component: ID 0953aac0 9c23 4c2f 9843 88954a4191ea,
When creating or editing articles on the wiki, we advise you to link to component articles using the guid rather than component name, this is the 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 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 next to a component in the Components Toolbar menu.
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 .