# Snippet Layout Preferences Page

This page of the Preferences dialogue box is used to customise the layout of pages that display the various kinds of snippet in the Detail Pane.

The page is accessed by selecting the Tools | Preferences menu item then clicking on Snippet Layout in the list on the left of the window.

## Overview

Each different kind of snippet has its own page customisation. This makes sense because some page "components" do not make sense for all snippet kinds. For example, freeform snippets can't be compiled, so there's little point in displaying the compiler results table for that kind of snippet.

Page components can be re-ordered, added and removed from a page. The available components are:

- Description
  Snippet's description: one or more paragraphs of text.
- Source Code
  Syntax-highlighted block of source code. Does not word-wrap.
- Type
  Snippet's type or kind, e.g. "Routine" or "Type Definition"
- Category
  Category that a snippet belongs to. Renders as a link.
- Required Units List
  List of units required by the selected snippet. Always empty for Unit snippets.
- Required Snippets List
  List of links to snippets called by the selected snippet. Always empty for Unit snippets.
- Cross Reference List
  List of links to any cross referenced snippets.
- Compiler Results Table
  Displays compilation results for all compilers that have been configured to display this information. Never provides useful information for Freeform snippets.
  Important Note: If no compilers have been set up to display compilation results then this component will display a warning message in place of the table. More information.
- Extra Information
  Additional information about the snippet. Not all snippet's have extra information.

## Usage

To customise the page layout for a chosen kind of snippet first choose the required snippet kind from the Edit page layout for snippet kind drop-down list.

The current page components will be displayed in the right hand Displayed page components list box. Any unused page components are listed in the Unused page components list box on the left.

You customise the page using these list boxes. Here are the available actions:

- Remove a page component from the display
  Select the page component in the Displayed page components list box and click the button or press Ctrl+Left. The component will be moved to the Unused page components list box.
- Add a page component to the display
  Select the required page component in the Unused page components list box and click the button or press Ctrl+Right. The selected component is moved to the end of the Displayed page components list box.
- Order the components on the page
  The page components are displayed in the order they appear in the Displayed page components list box. To move a page component up or down the page select it then click either the or buttons respectively. Alternatively press Ctrl+Up or Ctrl+Down.

Finally, you can reset all page layouts to their defaults by clicking the Restore Defaults button.