The Description page width option in the Overview view (for items) and in the Issue Editor (for issues) allows users to preview whether or not the content of a Description will fit within a configured page width, for example, for a particular document template. The preview allows them, for example, to view if any elements, e.g., tables, images, will be cut-off in the subsequent document output.


The configuration of this option is done using the swExplorer client via File > Configure the explorer and selecting Description page width on the Features tab. 


Prerequisites

  • An installation of the SystemWeaver swExplorer client
  • Assignment of the SW Architect role in the server
  • Knowledge of XML


To get started, select Description page width on the Features tab and click View example XML. Copy the example configuration from there (or from the example below). 


Example

<PageWidthIndicators>
  <Editor name="Template1" width="667"/>
  <Editor name="Template2" width="687"/>

  <Overview width="667">
    <!--
    <EdgeStyle color="Red" thickness="1" lineType="Dot" />
    -->
  </Overview>

  <!--
  <Editor name="Template3" width="667" default="true">
    <EdgeStyle color="Blue" thickness="1" lineType="Solid" />
  </Editor>
  -->
</PageWidthIndicators>

Each <Editor> defines a page width selection option available to users in the pop-up Description editor. In the below example, two options have been configured, i.e., Template1, Template2. 



The name attribute is the name of the option displayed in the drop-down list in the Description editor.


The width attribute defines the width of the work area in pixels*. For each use case, you will need to calculate the most suitable width, taking into account, for example, configured margins, header tables, etc. For example, if document "Template1" has a header table configured for A4 with a 20 mm left margin, a matching page width preview option should be configured for the page width selection list in the editor.


The optional default attribute can be used to set a pre-selected default in the editor for both items and issues.

If you choose to set a default, you can also configure to have the default indicator line display in the embedded Description in the Overview view by using <Overview> and setting the same width value used in the default <Editor> width. 


Next, modify the example configuration to meet your organization's needs. Click Save or OK to save the configuration. Users do not need to log out of the server to view the changes, however, they will need to refresh your view. 


Basic Configuration Options

Description page width configuration allows you to configure one or more indicator line options. Regardless of how many preview options you configure, there are basically four configuration scenarios. Select the one that best fits the needs of your organization. 


No Indicator Line

If you do not configure Description page width, the page width preview will not be available to users. This is the system default.


Page Width Selection without Default

This option will provide page width indicator line preview options in the pop-up Description editor, but no indicator line in the embedded Description in the Overview view. 


<PageWidthIndicators>
  <Editor name="Template1" width="667"/>
  <Editor name="Template2" width="687"/>    
</PageWidthIndicators>



Page Width Selection with Default

This option will provide page width preview options in the pop-up Description editor with one of the values pre-selected, but no indicator line in the embedded Description in the Overview view. 

<PageWidthIndicators>
  <Editor name="Template1" width="667" default="true"/>
  <Editor name="Template2" width="687"/>    
</PageWidthIndicators>



Page Width Selection with Default and Preset in Embedded Description

This option will provide page width preview options in the pop-up Description editor with one of the values pre-selected, and display an indicator line in the embedded Description in the Overview view. 

<PageWidthIndicators>
  <Editor name="Template1" width="667" default="true"/>
  <Editor name="Template2" width="687"/>      
  
  <Overview width="667"/>  
  
</PageWidthIndicators>


Custom Line Configuration

It is possible to customize the indicator line style, thickness, and/or color using <EdgeStyle>. 

The color attribute defines the color of the line. 

The thickness attribute defines the line thickness. 

The lineType defines the style of the line, e.g., solid, dashed, etc. 


Note: Dot, DashDot and DashDotDot are supported with thickness "1" only.


If no <EdgeStyle> is applied, the default line will be used which is thickness "1", color "Gray", and style "Dash". 

<PageWidthIndicators>

  <Editor name="Template1" width="667" default="true">
  <EdgeStyle color="Red" thickness="5" lineType="Solid" />
  </Editor>

  <Overview width="667">
    <EdgeStyle color="Red" thickness="5" lineType="Solid" />
  </Overview>       
  
</PageWidthIndicators>



To view all EdgeStyle lineType and color definition options, refer to the SystemWeaver Script Language Reference Manual in the application Help.