source: branches/lib/HELP_SOURCE/source/prop_configs.hlp

Last change on this file was 19532, checked in by westram, 4 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 1.9 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4
5#       sub topics:
6#SUB     subtopic.hlp
7
8# format described in ../help.readme
9
10
11TITLE           Property/settings configurations
12
13OCCURRENCE      Anywhere (buttons with config icon)
14
15DESCRIPTION     This provides a general way to store and restore settings
16                from the window, where this has been called from.
17
18                - Restore: restores a named configuration (from properties)
19                - Store: store current settings as named configuration (into properties)
20                - Delete: delete named configuration
21                - Load: load settings from a file, STORE and RESTORE
22                - Save: RESTORE stored settings and save them to a file
23                - Edit: allows to edit stored settings (see LINK{prop_configs_edit.hlp})
24                - Factory defaults: reset all values to their defaults
25
26                You may enter a description for each stored configuration.
27
28NOTES           To keep stored settings permanently (i.e. for future arb sessions),
29                use 'Save properties' from the 'Properties' menu!
30
31                Saving configurations allows you to share them with other users.
32                The configs are saved in directory pointed to by environmentvariable
33                ARBCONFIG (which defaults to ~/.arb_prop/cfgSave). See also LINK{arb_envar.hlp}.
34
35                Saving + loading also provides
36                 * cloning a config (=save it and reload it into a new config)
37                 * renaming a config (=clone and delete it)
38
39                Predefined (hardcoded) configurations are marked by a leading '*'.
40                You may only restore or save such configurations.
41
42EXAMPLES        None
43
44WARNINGS        Unfortunately we use the term 'configuration' for two things:
45                  * species-selections aka editor-configurations (as described in LINK{species_configs.hlp})
46                  * configurations of settings/properties (as described here)
47
48                Please do not mix them up.
49
50BUGS            None
Note: See TracBrowser for help on using the repository browser.