Difference between revisions of "Global Settings"

From Flowcode Help
Jump to navigationJump to search
 
(15 intermediate revisions by the same user not shown)
Line 17: Line 17:
  
  
==Application Tab==
+
==Application==
  
[[File:Global_sett_opts_Application.png|right|]]
 
  
'''Override Language'''
+
[[File:Global_sett_opts_Application.png]]
 +
 
 +
===Override Language===
  
 
Allows the user to override the default Flowcode language settings and to display Flowcode in the specified language.
 
Allows the user to override the default Flowcode language settings and to display Flowcode in the specified language.
Line 41: Line 42:
 
Displays a popup at the end of simulation which displays the duration of the simulation as well as other technical information.
 
Displays a popup at the end of simulation which displays the duration of the simulation as well as other technical information.
  
[[File:Gen_Simulation_Popup.png]]
+
[[File:Simulation_end_Popup.png]]
 
 
  
  
Line 48: Line 48:
  
 
Automatically opens the [[Icon Properties]] when adding a new icon.
 
Automatically opens the [[Icon Properties]] when adding a new icon.
 
  
  
Line 91: Line 90:
  
  
===Check for core updates on launch
+
===Check for core updates on launch===
 +
 
 +
Checks for any new versions of Flowcode and shows
  
Checks for any new versions of Flowcode and shows [[File:Core_update_available.png]] for a few seconds if any are found.
+
[[File:Core_update_available.png]]  
You will need to click on the ''Core update available'' text for the upgrade to start.
 
  
==Enable background checking for library updates.
+
for a few seconds if any are found.
When you add a component that has a later version available a pop-up will show [[Component_update_available.png]] for a few seconds.
 
You will need to click on the ''Updates Available'' text for the upgrade to start.  
 
  
===Show forums in external browser===
+
You will need to click on the '''Core update available''' text for the upgrade to start.
 +
 
 +
 
 +
===Enable background checking for library updates===  
 +
When you add a component that has a later version available a pop-up will show
 +
 
 +
[[File:Component_update_available.png]] for a few seconds.
  
 +
You will need to click on the '''Updates Available''' text for the upgrade to start.
  
  
Line 109: Line 114:
  
  
 +
==Flowchart==
  
==Flowchart Tab==
 
  
[[File:Global_setting_options.png|right|437×400px]]
+
[[File:Global_sett_flowch.png]]
  
 
===Font name===
 
===Font name===
Line 122: Line 127:
  
 
Allows users to set the default font size used by Flowcode
 
Allows users to set the default font size used by Flowcode
 
 
===Icon graphics style===
 
 
This menu allows users to select a different graphics style for the entire project, selecting a graphics style will alter the look of the flowchart view mode.
 
 
 
===Source graphics style===
 
 
This menu allows users to select a different graphics style for the source view mode.
 
  
  
Line 144: Line 139:
  
  
===Bind icon toolbar to programming view===
 
  
Changes whether the flowchart icons bind to individual flowchart windows or whether they are global throughout the program.
+
===Show descriptions for icons===
  
==Scheme Tab==
+
Shows the description at the top of each icon.
 +
E.g. Delay, Calculation & Component Macro, etc. 
  
[[File:Global_opts_scheme.png|right|521x342px]]
 
  
===Scheme===
+
===Show text inside icons===
 +
 
 +
Shows the text inside the icons
 +
 
  
This menu allows users to select a colour scheme for the flowchart icons.  Users can also choose their own colour schemes and save them.
+
===Show annotations===
  
===Background===
+
Shows the text to the right of the icons
  
Users can manually select the colour scheme, including foreground pattern, for the flowchart area. Users can also select the selection' and 'execution' colours.
+
===Limit description size for all icons===
  
===Icon===
+
Limits the description text to 18 characters.
  
Here users can manually change the colour of icons to suit their requirements.
 
  
 +
===Limit annotation size for new icons===
  
 +
Limits the text to the right of all new icons to 19 characters.
  
  
 +
===Anotation style===
  
 +
allows the look of the annotation to the right of each new icon to be changed.
 +
E.g. C Code will add '''//''' at the start etc.
  
  
  
 +
===Icon graphics style===
  
 +
This menu allows users to select a different graphics style for the entire project, selecting a graphics style will alter the look of the flowchart view mode.
  
  
 +
===Source graphics style===
  
 +
This menu allows users to select a different graphics style for the source view mode.
  
==Annotations Tab==
 
  
[[File:Global_opts_anno.png|right|521x342px]]
+
==Scheme==
  
===Show description for icons===
+
[[File:Global_sett_scheme.png]]
  
Controls whether the descriptions for icons are shown above the icon in the flowchart window.
+
===Scheme===
  
 +
This menu allows users to select a colour scheme for the flowchart icons.  Users can also choose their own colour schemes and save them.
  
===Show text inside icons===
+
===Background===
  
Controls the text inside the flowchart icons allowing it to be displayed or hidden.
+
Users can manually select the colour scheme, including foreground pattern, for the flowchart area. Users can also select the selection' and 'execution' colours.  
  
 +
===Icon===
  
===Show Annotations===
+
Here users can manually change the colour of icons to suit their requirements.
  
Controls the bubble annotations next to the flowchart icons allowing them to be displayed or hidden.
+
==Locations==
  
 +
[[File:Global_sett_locations.png]]
  
===Limit description size for all icons===
+
===Send compiler output to===
  
Selecting this option will limit the size of the descriptions above the icons to a suitably sensible width.
+
This option decides the default target directory to output to when compiling.
  
  
===Limit annotation size for all new icons===
+
===Create an embedded project backup file as ===
  
This option will limit the annotation size for any newly created icons, retaining any previously resized annotation.
+
Allows a backup embedded project file to be created based on the previous save of the file. If you need to go back then simply rename the file using Windows explorer and change the filetype from .001 to .fcfx.
  
  
===Annotation style===
+
===Create an App Developer project backup file as ===
  
This will set the global default annotation style for newly created icons. Icons can also have their annotation styles changed on an individual basis, selecting this option will not change existing icons annotation styles.
+
Allows a backup App developer project file to be created based on the previous save of the file. If you need to go back then simply rename the file using Windows explorer and change the filetype from .001 to .fcsx.
  
  
* ''Flowcode'' - This annotation style shows the Flowcode code behind the icon
+
===Override toolchain locations===
  
* ''C code'' - This style will show C code behind the icon
+
The toolchain locations Flowcode will use.
 +
All except ESP and PICO will be entered automatically after installing the appropriate toolchain
  
* ''Comments'' - Setting this style will show any custom comments in the annotation.
 
  
 +
===Look for components in===
  
===Tooltip style===
+
This option allows you to include additional directories for Flowcode to search when looking for components.
 +
If you have more than one different directory with the same component.
 +
The component with the latest date/time will be loaded
  
This will set the global tooltip style, the tooltip is shown when hovering over any icon in the main flowchart window. This is independent of the annotation style which can be changed on a per-icon basis, the tooltips are changed by this global setting only.
 
  
''Annotation'' - By selecting this option the tooltip will recreate the same information as the annotation.
 
  
''Flowcode'' - This tooltip style shows the Flowcode code behind the icon
+
==UI Trees==
  
''C code'' - This style will show C code behind the icon
+
[[File:Global_sett_UI_Trees.png]]
  
''Comments'' - Setting this style will show any custom comments in the tooltip.
 
  
 +
This allows you to completely customise '''[[Using_the_Project_Explorer|Project Explorer]] and Icon Lists with any of the available tabs.
  
  
==Editor Tab==
+
==User Tools==
  
[[File:Global_opts_edit.png|right|521x342px]]
+
[[File:Global_sett_User_Tools.png]]
  
  
==Locations Tab==
+
User Tools allows a user to run external programs or batch files from Flowcode.  They will appear on the Build menu:
  
[[File:Global_opts_loc.png|right|521x342px]]
+
[[File:User_Tools.png]]
  
 +
Typical uses will be to execute common external tools that you use during development, for example to integrate with version control software
  
===Send compiler output to...===
+
To create a tool, click the Build >> “Customise…” button or open '''[[Global_Settings|Global Settings]]''' and select the “User Tools” menu.
  
This option decides the default target directory to output to when compiling.
+
[[File:User_Tools2.png]]
  
 +
Select New (Insert) button
  
===Create a backup file as===
+
[[File:User_Tools_New_Insert_icon.png]]
  
Allows a backup project file to be created based on the previous save of the file. If you need to go back then simply rename the file using Windows explorer and change the filetype from .001 to .fcfx.
+
Enter the required name for the new tool.
  
 +
If at a later stage, the name requires editing, just double-click on it.
  
===Look for components in...===
+
Click on the tool name you just added so you can select the three dots to allow you to choose a file or a folder.
  
This option allows you to include additional directories for Flowcode to search when looking for components.
+
For the Arguments, select the down arrow and chose from the list of arguments.
  
 +
[[File:User_Tools4.png]]
  
===Clear component cache===
+
If $(outdir) is selected and there is a space within the directory, then it will need to be enclosed within speech marks.
 +
For example "$(outdir)"
  
Refreshes the current component cache based on the directories provided. Also performed when opening the Flowcode application and loading a project.
+
Before selecting the next Argument, a space must be added after the last Argument.
  
 +
To run the tools, select Build ribbon then the name of the tool.
  
===Look for dictionaries in...===
+
Here’s an example of running a batch file accessing some substitution arguments:
  
This option allows you to include additional directories for Flowcode to search when looking for dictionaries to integrate into Flowcode.
+
[[File:User_Tools3.png]]

Latest revision as of 10:57, 19 September 2023

GlobalSettings.png

The Global Settings allow the user to set display options for Flowcode. You can access these settings by pressing 'File' then 'Global Settings...' at the bottom.

The options are split into tabs (sections) which each contain different options to allow you to change different aspects of Flowcode.


These options configure the program itself, from changes to appearance, customization of the program to the ability to personalize the program to your preference.


Other options available also allow control over web access and proxy settings as well as the ability to override the default language to display a different language.


You also have the ability to add directories and locations to search for components and directories to be used in Flowcode, you can also change the default directory of the compiler output location, you can do all this and more from within the Global Settings.



Application

Global sett opts Application.png

Override Language

Allows the user to override the default Flowcode language settings and to display Flowcode in the specified language. Select the language from those available on the drop down list. Note: The relevant language packs need to be installed for Flowcode to enable that particular language.

Use dashboard as default panel

When checked, components are added to the dashboard panel by default, instead of the system panel.


Disable system panel

Disables the system panel completely, leaving the 2D panel to handle components and 2D graphics.


Show popup on simulation end

Displays a popup at the end of simulation which displays the duration of the simulation as well as other technical information.

Simulation end Popup.png


Auto-edit new icons

Automatically opens the Icon Properties when adding a new icon.


Autosave periodically

Enables the autosave feature of Flowcode. This will create a backup file named the same as your project but with the .fcbx file suffix. You can set how often the autosave will work, the minimum setting is every 60 seconds.


Add icons comments to C code

Toggling this option will change whether icons include their associated C-code comments.


Allow errors in flowcharts

Allows you to edit icons without error messages, errors messages still occur when simulating and compiling the program.


Allow unconnected ports and pins

Allows you to change component connection properties to unconnected, error messages still occur when simulating and compiling the program.


Create separate .c and .h files

C code files are optionally saved as separate c/h files for incorporation into external projects


Web Access

Configures the settings to allow Flowcode to connect to the internet. Used for features like online activation and to drive the content in the start page and auto updates.


Show help in external browser

Opens wiki help pages in your default external browser


Show forums in external browser

Opens the forums main page in your default external browser


Check for core updates on launch

Checks for any new versions of Flowcode and shows

Core update available.png

for a few seconds if any are found.

You will need to click on the Core update available text for the upgrade to start.


Enable background checking for library updates

When you add a component that has a later version available a pop-up will show

Component update available.png for a few seconds.

You will need to click on the Updates Available text for the upgrade to start.


Graphics Engine

Configures how we display objects on the simulation panels. Software mode is the default setting as it is more reliable for all users at the cost of being fairly slow. Hardware mode obviously is dependent on your specific 3D acceleration hardware meaning it may potentially have problems, if it does work ok with your hardware then it should be faster then the software mode.


Flowchart

Global sett flowch.png

Font name

Allows users to set the font used by Flowcode


Font size

Allows users to set the default font size used by Flowcode


Indent loop flowlines

Allows the flowchart line to be indented when part of a loop to make it much more obvious what code is placed inside the braces of the loop icon.


Transparent background

Selecting this option will set all backgrounds to be fully transparent when saving any .png or .bmp files from flowcode, this will ignore any colors set as the background.


Show descriptions for icons

Shows the description at the top of each icon. E.g. Delay, Calculation & Component Macro, etc.


Show text inside icons

Shows the text inside the icons


Show annotations

Shows the text to the right of the icons

Limit description size for all icons

Limits the description text to 18 characters.


Limit annotation size for new icons

Limits the text to the right of all new icons to 19 characters.


Anotation style

allows the look of the annotation to the right of each new icon to be changed. E.g. C Code will add // at the start etc.


Icon graphics style

This menu allows users to select a different graphics style for the entire project, selecting a graphics style will alter the look of the flowchart view mode.


Source graphics style

This menu allows users to select a different graphics style for the source view mode.


Scheme

Global sett scheme.png

Scheme

This menu allows users to select a colour scheme for the flowchart icons. Users can also choose their own colour schemes and save them.

Background

Users can manually select the colour scheme, including foreground pattern, for the flowchart area. Users can also select the selection' and 'execution' colours.

Icon

Here users can manually change the colour of icons to suit their requirements.

Locations

Global sett locations.png

Send compiler output to

This option decides the default target directory to output to when compiling.


Create an embedded project backup file as

Allows a backup embedded project file to be created based on the previous save of the file. If you need to go back then simply rename the file using Windows explorer and change the filetype from .001 to .fcfx.


Create an App Developer project backup file as

Allows a backup App developer project file to be created based on the previous save of the file. If you need to go back then simply rename the file using Windows explorer and change the filetype from .001 to .fcsx.


Override toolchain locations

The toolchain locations Flowcode will use. All except ESP and PICO will be entered automatically after installing the appropriate toolchain


Look for components in

This option allows you to include additional directories for Flowcode to search when looking for components. If you have more than one different directory with the same component. The component with the latest date/time will be loaded


UI Trees

Global sett UI Trees.png


This allows you to completely customise Project Explorer and Icon Lists with any of the available tabs.


User Tools

Global sett User Tools.png


User Tools allows a user to run external programs or batch files from Flowcode. They will appear on the Build menu:

User Tools.png

Typical uses will be to execute common external tools that you use during development, for example to integrate with version control software

To create a tool, click the Build >> “Customise…” button or open Global Settings and select the “User Tools” menu.

User Tools2.png

Select New (Insert) button

User Tools New Insert icon.png

Enter the required name for the new tool.

If at a later stage, the name requires editing, just double-click on it.

Click on the tool name you just added so you can select the three dots to allow you to choose a file or a folder.

For the Arguments, select the down arrow and chose from the list of arguments.

User Tools4.png

If $(outdir) is selected and there is a space within the directory, then it will need to be enclosed within speech marks. For example "$(outdir)"

Before selecting the next Argument, a space must be added after the last Argument.

To run the tools, select Build ribbon then the name of the tool.

Here’s an example of running a batch file accessing some substitution arguments:

User Tools3.png