Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
mantid
Manage
Activity
Members
Labels
Plan
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Deploy
Releases
Model registry
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Code review analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
mantidproject
mantid
Commits
879f2e7d
Commit
879f2e7d
authored
6 years ago
by
Peterson, Peter
Browse files
Options
Downloads
Patches
Plain Diff
Add note about boolean properties
parent
2c95954f
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/source/concepts/PropertiesFile.rst
+16
-0
16 additions, 0 deletions
docs/source/concepts/PropertiesFile.rst
with
16 additions
and
0 deletions
docs/source/concepts/PropertiesFile.rst
+
16
−
0
View file @
879f2e7d
...
@@ -24,6 +24,9 @@ The Properties
...
@@ -24,6 +24,9 @@ The Properties
.. note:: Use forward slash (``/``) or double up on the number of backslash (``\``) characters for all paths
.. note:: Use forward slash (``/``) or double up on the number of backslash (``\``) characters for all paths
.. note:: Boolean properties evaluate ``true``, ``1``, and ``on`` (case insensitive) as ``true``, all other values as ``false``.
General properties
General properties
******************
******************
...
@@ -69,6 +72,8 @@ Directory Properties
...
@@ -69,6 +72,8 @@ Directory Properties
+--------------------------------------+---------------------------------------------------+-------------------------------------+
+--------------------------------------+---------------------------------------------------+-------------------------------------+
|Property |Description |Example value |
|Property |Description |Example value |
+======================================+===================================================+=====================================+
+======================================+===================================================+=====================================+
| ``colormaps.directory`` | The directory where colormaps are located | ``/opt/mantid/colormaps`` |
+--------------------------------------+---------------------------------------------------+-------------------------------------+
| ``datasearch.directories`` | A semi-colon(``;``) separated list of directories | ``../data;\\\\isis\\isis$\\ndxgem`` |
| ``datasearch.directories`` | A semi-colon(``;``) separated list of directories | ``../data;\\\\isis\\isis$\\ndxgem`` |
| | to use to search for data. | |
| | to use to search for data. | |
+--------------------------------------+---------------------------------------------------+-------------------------------------+
+--------------------------------------+---------------------------------------------------+-------------------------------------+
...
@@ -152,6 +157,11 @@ MantidPlot Properties
...
@@ -152,6 +157,11 @@ MantidPlot Properties
| ``MantidOptions.InstrumentView.UseOpenGL`` |Controls the use of OpenGL in rendering the | ``On``, ``Off`` |
| ``MantidOptions.InstrumentView.UseOpenGL`` |Controls the use of OpenGL in rendering the | ``On``, ``Off`` |
| |"unwrapped" (flat) instrument views. | |
| |"unwrapped" (flat) instrument views. | |
+--------------------------------------------+---------------------------------------------------+-----------------+
+--------------------------------------------+---------------------------------------------------+-----------------+
| ``PeakColumn.hklPrec`` |Precision of hkl values shown in tables | ``2`` |
+--------------------------------------------+---------------------------------------------------+-----------------+
| ``cluster.submission`` |Enable cluster submission elements in GUIs | ``On``, ``Off`` |
+--------------------------------------------+---------------------------------------------------+-----------------+
Network Properties
Network Properties
******************
******************
...
@@ -159,9 +169,14 @@ Network Properties
...
@@ -159,9 +169,14 @@ Network Properties
+-------------------------------------------+---------------------------------------------------+---------------------------------+
+-------------------------------------------+---------------------------------------------------+---------------------------------+
|Property |Description |Example value |
|Property |Description |Example value |
+===========================================+===================================================+=================================+
+===========================================+===================================================+=================================+
| ``catalog.timeout.value`` | Network timeout for ICAT4 requests | ``30`` |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``CheckMantidVersion.OnStartup`` | Check if there is a newer version available and | |
| ``CheckMantidVersion.OnStartup`` | Check if there is a newer version available and | |
| | logs a message at ``information`` level | ``1`` |
| | logs a message at ``information`` level | ``1`` |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``ISISDAE.Timeout`` | Timeout for network requests when reading live | ``100`` |
| | data from ISIS (in seconds) | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
| ``network.default.timeout`` |Defines the default timeout for all network | ``30`` |
| ``network.default.timeout`` |Defines the default timeout for all network | ``30`` |
| |operations (in seconds). | |
| |operations (in seconds). | |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
+-------------------------------------------+---------------------------------------------------+---------------------------------+
...
@@ -186,6 +201,7 @@ Network Properties
...
@@ -186,6 +201,7 @@ Network Properties
| ``usagereports.enabled`` | Enable usage reporting | ``1`` |
| ``usagereports.enabled`` | Enable usage reporting | ``1`` |
+-------------------------------------------+---------------------------------------------------+---------------------------------+
+-------------------------------------------+---------------------------------------------------+---------------------------------+
'', # partially documented in docs/source/release/v3.13.0/framework.rst
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment