guiPreferences

There are two types of user preferences: role and non-role preferences. The value of a role preference depends on the user's current role. The (fallback) values are defined for every role in the section gui. Their values can be overridden by the user's configuration if the specific preference is not marked as fixed in the role. See the section Role Preferences for details. Providing values for role preferences in the guiPreferences is optional.

Non-role preferences, on the other hand, are by definition role-independent. All non-role preferences must be present in the section guiPreferences. They must provide the default value.

guiPreferences: User-specific presets for the Content Navigator. In addition to the optional elements this element must have the following subelements:

  • browserStates: Determines the properties of the menu area (menu and column view).
    • cb determines the properties of the column view.
    • tb refers to the hierarchical view.
    Both have browserWidth as a subelement, which defines the position of the horizontal split bar. cb additionally contains numCols (the number of columns). tb additionally contains root (first folder of the partial tree displayed) as well as expandedNodes (the nodes, subelement node) displayed in the columns. Example:
    <browserStates>
      <cb>
        <browserWidth>60</browserWidth>
        <numCols>5</numCols>
      </cb>
      <tb>
        <browserWidth>40</browserWidth>
        <root />
        <expandedNodes />
      </tb>
    </browserStates>
    
  • currentRole: Name of the user interface to be used for new users. This name can be used to make part of the user interface accessible to particular users (and hide them from others). The name must be one of the interface names defined in roles. By means of the fixed="true" attribute a user's access to the GUI can be restricted to one interface definition, meaning that she or he cannot switch to a different interface. Example:
    userConfigForUser mueller setElements guiPreferences.currentRole \
    "<currentRole fixed='true'>editor</currentRole>"
    
  • externalEditorEncoding: The character set to which the versions of documents, folders and layouts are converted before they are transferred to a client for editing with a local application. The value must be an encoding name accepted by Java.
  • externalEditors: The external editors a user has configured for himself. For each file name extension (content type) externalEditors has a subelement, whose name is the file name extension and whose contents is the command line with which the editor is executed. Example:
    <externalEditors>
      <html>notepad.exe</html>
      <txt>notepad.exe</txt>
    </externalEditors>
    
  • objClassHistory: File formats the user recently used in the Content Navigator. Any number of file formats can be specified. However, the GUI offers only the first 5 file formats from this list to the user. Each element in this list is represented by an objClass element. Example:
    <objClassHistory>
      <objClass>publication</objClass>
      <objClass>document</objClass>
    </objClassHistory>
    
  • startArea: The section of the HTML user interface that is displayed after the user has logged-in to the system. The following values can be specified:
    • browse_page (Content Navigator)
    • wizard_page (Wizard selection page)
  • startingPublication:The folder that is selected, after the user has logged-in.
  • theme: The default theme name.
  • userMenu: Bookmarks of new users.
  • userStyle: Font and other display options.
  • wantChildrenSorted: Determines whether the subfiles of a folder are sorted by name (or title, respectively) (default behaviour of versions prior to 6.10: true) or by the rules used during the export (false).
  • wantWorkflowConfirmation: Determines whether the confirmation page is to be displayed (YES) or not (NO) after workflow actions have been performed in the GUI. This setting does not apply to the give action.