Document Browser

15.2. Document Browser

Checking a template for errors can be a cumbersome task, in order to help the template creator the document browser can be used. This functionality will list template errors found in a specific template and allow you to edit, remove and replace tags with errors. The tool can only detect if tags are valid and that template has correct structure, eventual tag code errors are not traced by the tool.

To open the document browser

  1. Open Document production template maintenance from desktop.
  2. Select a document type
  3. Select a template and press right mouse button
  4. Select option Open and Document browser. A dialog will be displayed while the template is being checked for errors.

inset_200593.jpg

The left-hand pane lists the errors detected by the tool. The right-hand pane shows the full template details.

  • If errors are detected they are shown by default in a list in the left hand side of the GUI. A color code can be found at the bottom of the GUI to indicate the type of error(s) that has been detected.
  • If no errors where detected you will be informed, and the left-hand pane is empty. If this is the case you can simply exit the Document Browser (Close Window Button).
  • Clicking on a tag in the left hand pane will highlight that tag in the document template in the right hand pane. This will also show a text message at the top of the GUI that will try to explain the error that has been found.
  • Data outside of the highlighted tag can look very complex, but generally can be ignored This data exists so that people who are familiar with Rich Text structure can find out more about the template.
  • Warning: what are shown in the right hand side of the GUI are your document templates contents. Modifying this and selecting Save Changes will write directly to your file. Making changes to parts of the document other than inside tag delimiters (<>) is strongly not advised, and should only be attempted by people with a good understanding of RTF (Rich Text) file structure. Different Template Views

When the Document Browser Opens, the default view is list view. This will list eventual errors. It is possible to get a more detailed view of your template’s tag structure by changing to the Tree View. This can be done by pressing the Tree View button. You can change back to the List View by pressing the List View button (replaces Tree View when the view is swapped).

The List View shows only tag errors, this is a useful view for quickly identifying if your template contains errors, however, often it is preferred to check where this tag lies with respect to other tags in the template in order to gain a better understanding of how to fix the error. In the Tree View all used tags are shown in an expandable/collapsible tree structure, in the order they are used in the template. Erroneous tags will still be highlighted in the colours specified at the bottom of the GUI so they can be easily identified. Using the Tree View is no different than using the List View, it is simply another way to look at the data.

As well as these two views, the user can choose to open the document into the document-associated program (some form of word processor defined in your operating system), by pressing Open Document button. Here the document can be edited in the normal way.

To Edit an Incorrect Tag

If a tag has been spelled incorrectly, or required a minor change like a new parameter, you may simply edit the tag by doing the following:

  1. Select a tag in the left-hand pane. The Document Browser finds and shows the selected tag in the right-hand pane.
  2. Edit the tag as required in the right-hand pane.
  3. Press the Save Changes button.

To Replace a Tag

A tag my be incorrect, or like above may contain an error, and it is often easier to replace the entire tag by copying and pasting. This also leaves less room for error.

  1. Find the tag that you want to replace in the left hand pane and select it.
  2. Press right mouse button and select option View available tags. This opens the_External Interface_ for the template, which contains all tags available.
  3. Select the tag that you want to copy it using either the Copy Tag button, or right clicking and choosing one of the copy commands from the popup menu. You can then close the External Interface window. This takes you back to document browser.
  4. Press the right mouse button in the right-hand pane and select menu option Paste, the selected tag is replaced with the one on the clipboard.
  5. Press Save Changes button.

To Remove a Tag

If a tag should simply not be there, or there is a duplicate, you can do the following:

  1. Select the tag that you want to remove in the left-hand pane.
  2. Press the delete button on your keyboard.
  3. Press Save changes.