35. viewSettings

35. viewSettings
	Chapter 6. Configuration elements

<viewSettings>
  Content (in any order): center [ top ]? [ bottom ]? 
                          [ left ]? [ right ]?
</viewSettings>

<center
  css = non empty token; "-" for a tree view
  textSize = int beween 8 and 24 inclusive
  displayImages = (image|thumbnail|box)
  showTags = (no|yes|all)
  treeViewDetails = possibly empty list of 
                    (attribute|text|comment|pi)
/>

<top|bottom|left|right
  css = non empty token; "-" for a tree view
  size = double between 0 and 1 exclusive : 0.25
  textSize = int beween 8 and 24 inclusive
  displayImages = (image|thumbnail|box)
  showTags = (no|yes|all)
  treeViewDetails = possibly empty list of 
                    (attribute|text|comment|pi)
/>

By default, XXE creates a single view when a document is opened. This view is the tree view if no CSS style sheets are available for the opened document. This view is a styled view using first non-alternate CSS style sheet if one or more style sheets are available for the opened document.

The viewSettings element may be used to add up to four views at the top, bottom, left or right sides of the central, main view. Hence center child element is required and child elements top, bottom, left, right specify which view to is to be added and where it is added.

Moreover the center, top, bottom, left, right child elements all have attributes which may be used to specify how a document view is to be rendered on screen:

css

Required. Specifies which CSS style sheet to use. Use - to specify a tree view.

size

Optional. Default: 0.25. Specifies the proportional size of the four “border views”: top, bottom, left, right.

Example: <top css="-" size="0.25"/> means that a tree view will occupy one fourth of the available height and that this tree view will be found above the central, main view.

textSize

Optional. Applies to both tree views and styled views. Default: 10 for a tree view and 11 for a styled view. Specifies the base font size of the view, expressed in CSS points (a unit which is independent of the platform, screen, display scaling, etc).

displayImages

Optional. Applies only to styled views. Default: image. Specifies how images are to be displayed in the styled view.

image: Display the image normally.
thumbnail: Show the bounding box of the image and, if there is enough room in this rectangle, also show a thumbnail.
box: Show the bounding box of the image.

showTags

Optional. Applies only to styled views. Default: no. Specifies whether element tags are to be displayed in the styled view.

no: Hide element tags.
yes: Show most element tags.
all: Show all element tags, including those related to tables, that is, row group, row and cell tags.

treeViewDetails

Optional. Applies only to tree views. Default: "attribute text comment pi", that is, full details. Specifies whether attributes, text node characters, comment characters, processing-instruction characters, are to be displayed in their entirety in the tree view.

Two DocBook examples:

<viewSettings>
  <top css="Table of contents" size="0.15" />
  <center css="DocBook" />
</viewSettings>

<viewSettings>
  <left css="-" textSize="9" treeViewDetails="" />
  <center css="DocBook" />
  <bottom css="XML source" /> <!--Declared by the "Edit source" add-on-->
</viewSettings>

<css name="DocBook" location="css/docbook.css" />
<css name="Table of contents" alternate="true"
     location="css/toc.css" />


34. validateHook		36. Custom configuration elements