LabRPS: Created page with " {{Docnav |Interface Customization |Start up and Configuration }} {{TOCright}} ==Introduction== To start the '''Preferences editor''' select the {{MenuCommand|Edit → Preferences...}} option from the menu. On the Mac OS the {{MenuCommand|Preferences...}} option appears in the {{MenuCommand|LabRPS}} menu instead (this is the default place for preferences on the Mac). LabRPS uses a workbench concept, where ea..."

2024-10-26T14:12:21Z

Created page with " {{Docnav |Interface Customization |Start up and Configuration }} {{TOCright}} ==Introduction== To start the '''Preferences editor''' select the {{MenuCommand|Edit → Preferences...}} option from the menu. On the Mac OS the {{MenuCommand|Preferences...}} option appears in the {{MenuCommand|LabRPS}} menu instead (this is the default place for preferences on the Mac). LabRPS uses a workbench concept, where ea..."

New page

{{Docnav
|[[Interface_Customization|Interface Customization]]
|[[Start_up_and_Configuration|Start up and Configuration]]
}}

{{TOCright}}

==Introduction==

To start the '''Preferences editor''' select the {{MenuCommand|Edit → Preferences...}} option from the menu. On the Mac OS the {{MenuCommand|Preferences...}} option appears in the {{MenuCommand|LabRPS}} menu instead (this is the default place for preferences on the Mac).

LabRPS uses a workbench concept, where each workbench is responsible for specific tasks and functions. A workbench can have its own preferences. These will only appear in the Preferences editor if the workbench has been loaded in the current LabRPS session. See [[#Workbenches|Workbenches]] below for more information.

If no workbench is loaded, four sections appear in the Preferences editor: [[#General_settings|General]], [[#Workbenches|Workbenches]], [[#Plupins_settings|Plugins]], and [[#Addon_Manager|Addon Manager]]. Any workbenches that have been loaded, and have their own preferences, will appear below these.

Please note that pressing the {{Button|Reset}} button in the lower left corner of the Preferences dialog will reset '''all''' LabRPS preferences to their default values.

Some advanced preferences can only be changed in the [[Std_DlgParameter|Parameter editor]].

==General settings==

This preferences section has 10 tabs: General, Document, Selection, Cache, Editor, Python console, Output window, Macro, Units and help.

===General===

On the ''General'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Change language}}
| Selection of the language of the LabRPS user interface
|-
| {{MenuCommand|Use selected language number format}}
| If checked, the decimal separator of the selected language is used. Otherwise an English-like style ([https://en.wikipedia.org/wiki/POSIX POSIX]) will be used.
|-
| {{MenuCommand|Substitute decimal separator}}
| If checked, the numerical keypad decimal separator will be substituted with the locale's separator. Needs LabRPS to be restarted to take effect.
|-
| {{MenuCommand|Preference packs}}
| Lists the available [[Preference_Packs|preference packs]] and also allows you to save new packs.
|-
| {{MenuCommand|Size of recent file list}}
| Specification how many files should be listed in the recent files list.
|-
| {{MenuCommand|Enable tiled background}}
| If checked, the background of LabRPS's main window will by default consist of tiles of this image: [[File:Background.png|64px]]

This option only has an effect if no {{MenuCommand|Style sheet}} is selected.

The image can be changed by adding the folders {{FileName|Gui/Images}} in the folder:

{{FileName|[https://www.howtogeek.com/318177/what-is-the-appdata-folder-in-windows/ %APPDATA%]/LabRPS}} (on Windows),

{{FileName|$HOME/.LabRPS}} (on Linux) or

{{FileName|$HOME/Library/Preferences/LabRPS}} (on MacOS).

Place a file named {{FileName|background.png}} in the {{FileName|Images}} folder, and uncheck/check this option to see the changed file.
|-
| {{MenuCommand|Style sheet}}
| Selection of a style sheet. Style sheets define how the user interface of LabRPS looks. For technical details about the style sheets, see [[Interface_Customization#Themes|themes]].
|-
| {{MenuCommand|Size of toolbar icons}}
| Selection of the size for the toolbar icons
|-
| {{MenuCommand|Tree view mode}}
| Customization how the tree view is shown in the panel (restart required). The options are:
* '''Combo View''': combine tree view and property view into one panel.
* '''TreeView and PropertyView''': split tree view and property view into separate panel.
* '''Both''': keep all three panels, and you can have two sets of tree view and property view.
|-
| {{MenuCommand|Auto load module after start up}}
| Selection what workbench will be used directly after starting LabRPS
|-
| {{MenuCommand|Enable splash screen at start up}}
| If checked, a splash screen is shown when starting LabRPS.
|}

[[Image:Preferences_General_Tab_General.png]]

===Document===

On the ''Document'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Create new document at start up}}
| If checked, LabRPS will create a new document when started
|-
| {{MenuCommand|Document save compression level}}
| Specification of the compression level for {{FileName|FCStd}} files. {{FileName|FCStd}} files are ZIP-compressed files. Therefore you can rename their suffix {{FileName|.FCStd}} to {{FileName|.zip}} and open them with a ZIP archive program.
|-
| {{MenuCommand|Using Undo/Redo on documents}}
| If checked, all changes in documents are stored so that they can be undone/redone
|-
| {{MenuCommand|Maximum Undo/Redo steps}}
| Specification how many Undo/Redo steps should be recorded
|-
| {{MenuCommand|Allow aborting recomputation}}
| If checked, recomputations can be aborted by pressing {{KEY|Esc}}. This may slightly increase the recomputation time.
|-
| {{MenuCommand|Run AutoRecovery at startup}}
| If there is a recovery file available LabRPS will automatically run a file recovery when it is started. This way files can be restored if a crash occurred.
|-
| {{MenuCommand|Save AutoRecovery information every}}
| Specification how often a recovery file is written.
|-
| {{MenuCommand|Save thumbnail into project file when saving document}}
| If checked, a thumbnail will be stored when the document is saved. The thumbnail will for example be shown in the list of recent files in the [[Start_Workbench|Start workbench]]. It is possible to select a '''Size''' between 128×128 and 512×512 pixels for the thumbnail. Common sizes are the powers of two: 128, 256, 512.
|-
| {{MenuCommand|Add the program logo to the generated thumbnail}}
| If checked, the LabRPS program logo [[image:Labrps.svg|24px]] will be added to the thumbnail.
|-
| {{MenuCommand|Maximum number of backup files to keep when resaving document}}
| If checked, backup files will be kept when saving the document. You can specify the number of backup files to keep. Backup files are previously saved versions of the document. The first backup file will have the file suffix {{FileName|.FCStd1}}, the second {{FileName|.FCStd2}} and so on.
|-
| {{MenuCommand|Use date and FCBak extension}}
| If checked, backup files will get the extension {{FileName|.FCbak}} and their file names get a date suffix according to the specified date format. For a description of the date format see [https://devhints.io/datetime this site].
With the default settings a backup file will for example get this name {{FileName|TD-Cube.20200315-215654.FCBak}} (original filename is {{FileName|TD-Cube.FCStd}}).
|-
| {{MenuCommand|Allow duplicate object labels in one document}}
| If checked, objects can have the same label.
|-
| {{MenuCommand|Disable partial loading of external linked objects}}
| If partial loading of external linked objects is enabled, only the referenced objects and their dependencies will be loaded when the linked document is auto opened together with the main document. Such a partially loaded document cannot be edited. Double click the document icon in the tree view to reload it in full. A more detailed explanation of this feature can be found on the [https://github.com/realthunder/LabRPS_assembly3/wiki/Core-Changes#partial-document-loading Assembly3 documentation page]
|-
| {{MenuCommand|Author name}}
| All created documents will get the specified author name. Keep the author field blank if you do not want to include this information. If the option {{MenuCommand|Set on save}} is checked, the field '''Last modified by''' will be set to the specified author when saving the file. This field can be viewed using the {{MenuCommand|File → Project information}} menu option.
|-
| {{MenuCommand|Company}}
| All created documents will get the specified company name
|-
| {{MenuCommand|Default license}}
| Selection of the license for new documents. For predefined licenses the {{MenuCommand|License URL}} will automatically be set accordingly. Select '''Other''' for a custom license.
|-
| {{MenuCommand|License URL}}
| Specification of an URL describing the license selected in {{MenuCommand|Default license}}
|}

[[Image:Preferences_General_Tab_Document.png]]

===Selection===

On the ''Selection'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Auto switch to the Dependency graph view containing the selected item}}
| Enables the [[Std_TreeSyncView|Tree view SyncView mode]]
|-
| {{MenuCommand|Record selection in tree view in order to go back/forward using navigation button}}
| Enables the [[Std_TreeRecordSelection|Tree view RecordSelection mode]]
|-
| {{MenuCommand|Add checkboxes for selection in document tree}}
| Each [[Tree_view|document tree]] item will get a checkbox. This is for example useful for selecting multiple items on a touchscreen.
|}

[[Image:Preferences_General_Tab_Selection.png]]

===Cache===

These preferences are related to the cache directory where LabRPS stores temporary files.

On the ''Cache'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Location}}
| Specifies the path of the cache directory.
|-
| {{MenuCommand|Check periodically at program start}}
| Controls the frequency with which the directory size is checked. The options are:
* '''Always'''
* '''Daily'''
* '''Weekly'''
* '''Monthly'''
* '''Yearly'''
* '''Never'''
|-
| {{MenuCommand|Cache size limit}}
| Specifies the maximum size of the directory. You will be notified if a check is performed and the size exceeds this value. The options are:
* '''100 MB'''
* '''300 MB'''
* '''500 MB'''
* '''1 GB'''
* '''2 GB'''
* '''3 GB'''
|-
| {{MenuCommand|Current cache size}}
| Shows the current size of the directory, if available. Press the {{Button|Check now...}} button to update the value.
|}

[[Image:Preferences_General_Tab_Cache.png]]

===Editor===

The editor preferences settings affect the behavior of the macro editor. This editor can be opened using the menu {{MenuCommand|Macro → Macros... → Edit/Create}}.

The color and font settings also affect the [[Python console|Python console]]. This console is shown using the menu {{MenuCommand|View → Panels → Python console}}.

On the ''Editor'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Enable line numbers}}
| If checked, the code lines will be numbered
|-
| {{MenuCommand|Enable block cursor}}
| If checked, the cursor will have a block shape.
|-
| {{MenuCommand|Tab size}}
| Specification of the tabulator raster (how many spaces). If it is for example set to '''6''', pressing {{KEY|Tab}} will jump to character 7 or 13 or 19 etc., depending on the current cursor position. This setting is only used if {{MenuCommand|Keep tabs}} is selected.
|-
| {{MenuCommand|Indent size}}
| Specification of how many spaces will be inserted when pressing {{KEY|Tab}}. This setting is only used if {{MenuCommand|Insert spaces}} is selected.
|-
| {{MenuCommand|Keep tabs}}
| If selected, pressing {{KEY|Tab}} will insert a tabulator with the raster defined by {{MenuCommand|Tab size}}
|-
| {{MenuCommand|Insert spaces}}
| If selected, pressing {{KEY|Tab}} will insert the amount of spaces defined by {{MenuCommand|Indent size}}
|-
| {{MenuCommand|Display Items}}
| Selection of the code type. The color and font settings will be applied to the selected type. The result can be checked in the '''Preview''' field.
|-
| {{MenuCommand|Family}}
| Specification of the font family that should be used for the selected code type
|-
| {{MenuCommand|Size}}
| Specification of the font size that should be used for the selected code type
|-
| {{MenuCommand|Color}}
| Specification of the color that should be used for the selected code type
|}

[[Image:Preferences_General_Tab_Editor.png]]

===Python console===

These preferences control the behavior of the [[Python_console|Python console]]. This console can be opened using the {{MenuCommand|View → Panels → Python console}} menu option.

Note that the color and font settings for the console are defined on the [[#Editor|Editor]] tab.

On the ''Python console'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Enable word wrap}}
| If checked, words will be wrapped if they exceed the available horizontal space in the console.
|-
| {{MenuCommand|Enable block cursor}}
| If checked, the cursor will have a block shape.
|-
| {{MenuCommand|Save history}}
| If checked, Python history is saved across sessions.
|}

[[Image:Preferences_General_Tab_Python_console.png]]

===Output window===

The output preferences affect the behavior of the [[Report_view|Report view]]. This panel is shown using the menu {{MenuCommand|View → Panels → Report view}}.

On the ''Output'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Record normal messages}}
| If checked, normal messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Normal messages}}.
|-
| {{MenuCommand|Record log messages}}
| If checked, log messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Log messages}}.
|-
| {{MenuCommand|Record warnings}}
| If checked, warnings will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Warnings}}.
|-
| {{MenuCommand|Record error messages}}
| If checked, error messages will be recorded. They will be displayed in the [[Report_view|Report view]] with the color set in {{MenuCommand|Errors}}.
|-
| {{MenuCommand|Show report view on error}}
| If checked, the [[Report_view|Report view]] will be shown automatically when an error is recorded
|-
| {{MenuCommand|Show report view on warning}}
| If checked, the [[Report_view|Report view]] will be shown automatically when a warning is recorded
|-
| {{MenuCommand|Show report view on normal message}}
| If checked, the [[Report_view|Report view]] will be shown automatically when a normal message is recorded
|-
| {{MenuCommand|Show report view on log message}}
| If checked, the [[Report_view|Report view]] will be shown automatically when a log message is recorded
|-
| {{MenuCommand|Include a timecode for each entry}}
| If checked, each message and warning will receive a timecode
|-
| {{MenuCommand|Normal messages}}
| Specification of the font color for normal messages
|-
| {{MenuCommand|Log messages}}
| Specification of the font color for log messages
|-
| {{MenuCommand|Warnings}}
| Specification of the font color for warning messages
|-
| {{MenuCommand|Errors}}
| Specification of the font color for error messages

|-
| {{MenuCommand|Redirect internal Python output to report view}}
| If checked, internal Python output will be redirected from the [[Python_console|Python console]] to the [[Report_view|Report view]]
|-
| {{MenuCommand|Redirect internal Python errors to report view}}
| If checked, internal Python error messages will be redirected from the [[Python_console|Python console]] to the [[Report_view|Report view]]
|}

[[Image:Preferences_General_Tab_Output_window.png]]

===Macro===

On the ''Macro'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Run macros in local environment}}
| If checked, variables defined by macros are created as local variables, otherwise as global Python variables
|-
| {{MenuCommand|Macro path}}
| Specification of the path for macro files
|-
| {{MenuCommand|Record GUI commands}}
| If checked, [[Std_DlgMacroRecord|recorded macros]] will also contain user interface commands
|-
| {{MenuCommand|Record as comment}}
| If checked, [[Std_DlgMacroRecord|recorded macros]] will also contain user interface commands, but as comments. This is useful if you don't want to execute these commands when running the macro, but do want to see what has been done while recording.
|-
| {{MenuCommand|Show script commands in python console}}
| If checked, the commands executed by macro scripts are shown in the Python console. This console is shown using the {{MenuCommand|View → Panels → Python console}} menu option.
|-
| {{MenuCommand|Size of recent macros list}}
| Controls the number of recent macros to display in the menu
|-
| {{MenuCommand|Shortcut count}}
| Controls the number of recent macros that get dynamically assigned shortcuts
|-
| {{MenuCommand|Keyboard Modifiers}}
| Controls which keyboard modifiers are used for the shortcuts, example '''Ctrl+Shift+''' creates shortcuts in the form of '''Ctrl+Shift+1''', '''Ctrl+Shift+2''', etc.
|}

[[Image:Preferences_General_Tab_Macro.png]]

===Units===

On the ''Units'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Unit system}}
| Selection of the unit system to be used for all parts of LabRPS
|-
| {{MenuCommand|Number of decimals}}
| The number of decimals that should be shown for numbers and dimensions
|-
| {{MenuCommand|Minimum fractional inch}}
| Minimum fractional inch that should be displayed. This setting is only available if the unit system '''Building US (ft-in/sqft/cuft)''' is used.
|}

[[Image:Preferences_General_Tab_Units.png]]

===Help===

On the ''Help'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Help location}}
| Specifies the location of the Help files. The options are:
* {{MenuCommand|LabRPS Wiki (online)}}: The documentation pages will be fetched from the official LabRPSwiki at https://wiki.labrps.com
* {{MenuCommand|Markdown version (online)}}: The documentation pages will be fetched from an automatic Markdown conversion of the LabRPS wiki,hosted on LabRPS's GitHub account. This can be styled with a custom stylesheet below and can look nicer than the wiki option. The 'Markdown' or 'Pandoc' Python module should be installed for optimal results.
* {{MenuCommand|Github (online)}}: This will fetch the documentation from pages rendered on github. This is currently not available...
* {{MenuCommand|Custom location}}: Set this to a custom URL or the folder where the help files are located. You can easily download the documentation for offline use by using the Addon Manager and installing the "offline-documentation" addon. If this field is left blank, LabRPS will automatically search for the help files at the default location ($USERAPPDATADIR/Mod/offline-documentation)
* {{MenuCommand|Translation suffix}}: The translation suffix
|-
| {{MenuCommand|Display}}
| Specifies where the documentation should be displayed. The options are:
* {{MenuCommand|In a LabRPS tab}}: The documentation is displayed on a new tab in the [[Main_view_area|Main view area]].
* {{MenuCommand|In your default web browser}}: The documentation is displayed in the default web browser.
* {{MenuCommand|In a separate, embeddable, dialog}}: The documentation is displayed in a separate dialog. This dialog can be docked on top of the [[Combo_view|Combo view]] for example.
|-
| {{MenuCommand|Custom stylesheet}}
| Specifies an optional custom stylesheet. Not used for the Wiki URL.
|}

[[Image:Preferences_General_Tab_Help.png]]

==Workbenches==

This preferences section has a single tab: Available Workbenches.

===Available Workbenches===

To preserve resources, LabRPS does not automatically load all available workbenches. And only if a workbench has been loaded will its preferences, if any, appear in the Preferences editor.

The ''Available Workbenches'' tab displays a list of all installed workbenches. To load a workbench press its {{Button|Load now}} button. If you check a workbench's {{MenuCommand|Autoload}} checkbox it will autoload when LabRPS starts up. Loading more workbenches will make the startup slower, but switching between workbenches that have already been loaded is faster.

If a newly loaded workbench has dedicated preference they will appear in a new section in the Preferences editor. Some workbenches add support for additional import and export formats. If there are any related preferences they will appear on one or more new tabs in the Preferences editor.

[[Image:Preferences_Workbenches_Tab_Available_Workbenches.png]]

==Plugins==

This preferences section has a single tab: Plugin Source.

===Plugin Source===

On the ''Plugin Source'' tab you can specify the location where plugin should be loaded from:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|From this device (local)}}
| If selected, LabRPS will try to load plugins from local folder named plugins under the LabRPS folder.
|-
| {{MenuCommand|From Github (onine)}}
| If selected, LabRPS will try to LabRPS plugins located on github repository.
|-
| {{MenuCommand|Both (local and online)}}
| If selected, LabRPS will try to load plugins from both local folder and online github repository.
|-
| {{MenuCommand|Custom location}}
| If selected, LabRPS will try to LabRPS plugins from local folder specified by the user.
|}

[[Image:Preferences_Plugins_Tab_PluginSource.png]]

==Addon Manager==

This preferences section has a single tab: Addon manager options.

===Addon manager options===

These preferences control the behavior of the [[Std AddonMgr|Addon manager]].

On the ''Addon manager options'' tab you can specify the following:

{| class="wikitable float-right mw-collapsible mw-collapsed"
!style="width: 33%;"|Name
!style="width: 66%;"|Description
|-
| {{MenuCommand|Automatically check for updates at start (requires GitPython)}}
| If checked, the Addon manager will check for updates when it is launched. GitPython and git must be installed for this to work.
|-
| {{MenuCommand|Download Macro metadata (approximately 10MB)}}
| If checked, macro metadata is downloaded for display in the Addon manager's main addon listing. This data is cached locally.
|-
| {{MenuCommand|Cache update frequency}}
| Controls the frequency with which the locally cached addon availability and metadata information is updated. The options are:
* '''Manual (no automatic updates)'''
* '''Daily'''
* '''Weekly'''
|-
| {{MenuCommand|Hide Addons marked Python 2 Only}}
| If checked, addons marked as "Python 2 Only" are not included in the listing. These addons are unlikely to work in the current LabRPS version.
|-
| {{MenuCommand|Hide Addons marked Obsolete}}
| If checked, addons marked as "Obsolete" are not included in the listing.
|-
| {{MenuCommand|Hide Addons that require a newer version of LabRPS}}
| If checked, addons that require a newer LabRPS version are not included in the listing.
|-
| {{MenuCommand|Custom repositories (one per line)}}
| Custom repositories can be specified here. They should include the name of the branch you intend to use (typically "master" or "main").
|-
| {{MenuCommand|Proxy}}
| The Addon manager includes experimental support for proxies requiring authentication, set up as user-defined proxies.
|-
| {{MenuCommand|Python executable (optional)}}
| The Addon manager attempts to determine the Python executable that should be used for the automatic pip-based installation of Python dependencies. To override this selection, the path to the executable can be set here.
|-
| {{MenuCommand|Show option to change branches (requires GitPython)}}
| For developers and beta-testers, the Addon manager can provide an interface on the addon's details screen that allows switching which git branch is currently checked out. This is intended for advanced users only, as it is possible that a non-primary-branch version of the Addon may result in instability and compatibility issues. GitPython must be installed for this to work. Use with caution.
|}

[[Image:Preferences_Addon_Manager_Tab_Addon_manager_options.png]]
==Related==

* [[Std_DlgParameter|Parameter editor]]

{{Docnav
|[[Interface_Customization|Interface Customization]]
|[[Start_up_and_Configuration|Start up and Configuration]]
}}

[[Category:Preferences]]
{{Userdocnavi}}

Preferences Editor - Revision history