<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
* $Rev$
* $Date$
*
* ***** BEGIN LICENSE BLOCK *****
*
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is detail_pane.htm
*
* The Initial Developer of the Original Code is Peter Johnson
* (http://www.delphidabbler.com/).
*
* Portions created by the Initial Developer are Copyright (C) 2005-2012 Peter
* Johnson. All Rights Reserved.
*
* ***** END LICENSE BLOCK *****
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
<title>
Detail Pane
</title>
<link rel="stylesheet" href="../css/codesnip.css" type="text/css">
</head>
<body>
<h1>
<a name="detail_pane"></a>Detail Pane
</h1>
<p>
This pane appears on the right hand side of the display and shows
detailed information about the currently selected snippet or section
heading in the <a href="overview_pane.htm">Overview pane</a>.
</p>
<p>
When a snippet is selected the display contains:
</p>
<ul>
<li>
A brief description of the snippet.
</li>
<li>
The source code (syntax highlighted).
</li>
<li>
A list of standard Delphi units required by the snippet.
</li>
<li>
A list of other snippet called by the selected snippet.
</li>
<li>
A cross reference to other similar snippets, labelled "See
also".
</li>
<li>
A table indicating which compilers the snippet is compatible with. (Not
displayed for <a href="snippet_freeform.htm">freeform</a> snippets.)
</li>
<li>
Optionally, some further information about the snippet, including
credits and links to related web sites.
</li>
</ul>
<p>
Clicking any of the snippets in the "Required snippets" and
"See also" lists causes the snippet in question to be
displayed. You can return to the original snippet using the
<img
alt="Previous button"
src="../Images/GoBack.png"
class="glyph"
> <em>Previous</em> toolbar button.
</p>
<p>
If a section header is selected in the
<a href="overview_pane.htm">Overview Pane</a>, a list of all the snippets
belonging to the section is displayed. A brief description of each snippet
is also displayed.
</p>
<h2>
Related Actions
</h2>
<ul>
<li>
Save a selected snippet to disk by using the
<a href="dlg_savesnippet.htm">Save Snippet</a> dialogue box that is
accessed from the
<img
alt="Save Snippet button"
src="../Images/SaveSnippet.gif"
class="glyph"
> <em>Save Snippet</em> toolbar button. (Not available for
<a href="snippet_freeform.htm">freeform</a> snippets).
</li>
<li>
Copy the selected snippet to the clipboard using one of the options on
the <em>Edit</em> menu.
</li>
</ul>
</body>
</html>
