Settings file format: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Created page with "The Solo family of products use an XML file format to store various application start-up settings including license codes, user preferences, start-up folders, window locations...")
 
imported>Jeremy
No edit summary
 
Line 1: Line 1:
The Solo family of products use an XML file format to store various application start-up settings including license codes, user preferences, start-up folders, window locations, squelched tips, and other user-defined settings.
The Solo family of products use an XML file format to store various application start-up settings including license codes, user preferences, start-up folders, window locations, squelched tips, and other user-defined settings.


The settings files are, in fact, a parallel to the [[setplspref]] functionality of PLS_Toolbox. As such, the preferences can specify a new value for any option on any function. The settings can also be created using the "File > Save As..." menu option in the [[Expert Preferences GUI]] accessible from the Edit menu in the Workspace Browser and Analysis Window. In addition, an example is included in the Solo_Predictor documentation [[Solo_Predictor_Installation_and_Configuration#Example_default.xml_File|describing the default.xml file]] used to define the server settings.
The settings files are, in fact, a parallel to the [[setplspref]] functionality of PLS_Toolbox. As such, the preferences can specify a new value for any option on any function. The settings can also be created using the "File > Save As..." menu option in the [[Expert Preferences GUI]] accessible from the Edit menu in the Workspace Browser and Analysis Window.


The basic format of the files is an XML structure with a top-level <tt>&lt;Settings&gt;</tt> tag containing a <tt>&lt;Preferences&gt;</tt> tag and an optional
The basic format of the files is an XML structure with a top-level <tt>&lt;Settings&gt;</tt> tag containing a <tt>&lt;Preferences&gt;</tt> tag and an optional
Line 14: Line 14:
</pre>
</pre>


Within the <tt>&lt;Preferences&gt;</tt> tag, the function-specific preferences can be included by creating a tag for the specific function to be modified and including within that tag a separate tag for each of the specific options to be overridden. The format of the preference itself is based on the generic XML format
Within the <tt>&lt;Preferences&gt;</tt> tag, the function-specific preferences can be included by creating a tag for the specific function to be modified and including within that tag a separate tag for each of the specific options to be overridden. The format of the preference itself is based on the generic XML format described in the [[parsexml]] documentation.


As an example, the following defines the font size multiplier (used in some graphical user interfaces to change the font size) :
As an example, the following defines the font size multiplier (used in some graphical user interfaces to change the font size) :
Line 27: Line 27:
</Settings>
</Settings>
</pre>
</pre>
An example file is included in the Solo_Predictor documentation [[Solo_Predictor_Installation_and_Configuration#Example_default.xml_File|describing the default.xml file]] used to define the server settings.

Latest revision as of 10:14, 7 July 2015

The Solo family of products use an XML file format to store various application start-up settings including license codes, user preferences, start-up folders, window locations, squelched tips, and other user-defined settings.

The settings files are, in fact, a parallel to the setplspref functionality of PLS_Toolbox. As such, the preferences can specify a new value for any option on any function. The settings can also be created using the "File > Save As..." menu option in the Expert Preferences GUI accessible from the Edit menu in the Workspace Browser and Analysis Window.

The basic format of the files is an XML structure with a top-level <Settings> tag containing a <Preferences> tag and an optional <Licensecode> tag in the general form:

<Settings>
  <Preferences>
  ...
  </Preferences>
  <Licensecode>xxxx-yyyy-zz-zzzz-zzzz</Licensecode>
</Settings>

Within the <Preferences> tag, the function-specific preferences can be included by creating a tag for the specific function to be modified and including within that tag a separate tag for each of the specific options to be overridden. The format of the preference itself is based on the generic XML format described in the parsexml documentation.

As an example, the following defines the font size multiplier (used in some graphical user interfaces to change the font size) :

<Settings>
  <Preferences>
    <getdefaultfontsize>
      <multiplier class="numeric">1.2</multiplier>
    </getdefaultfontsize>
  </Preferences>
</Settings>

An example file is included in the Solo_Predictor documentation describing the default.xml file used to define the server settings.