<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
* This Source Code Form is subject to the terms of the Mozilla Public License,
* v. 2.0. If a copy of the MPL was not distributed with this file, You can
* obtain one at http://mozilla.org/MPL/2.0/
*
* Copyright (C) 2005-2012, Peter Johnson (www.delphidabbler.com).
*
* $Rev$
* $Date$
*
* Welcome help topic.
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
<title>
Welcome
</title>
<link rel="stylesheet" href="../css/codesnip.css" type="text/css">
</head>
<body>
<h1>
<a name="welcome"></a>Welcome
</h1>
<p>
<em>CodeSnip</em> is a code snippets manager and viewer targetted at the
Pascal language, with a specific emphasis on Delphi and Free Pascal
flavours.
</p>
<p>
In addition to managing your own code snippets, <em>CodeSnip</em> can also
download and display source code from the DelphiDabbler <a
class="weblink"
target="_blank"
href="http://www.delphidabbler.com/codesnip"
>Code Snippets Database</a> of reusable Pascal source code.
</p>
<p>
What makes <em>CodeSnip</em> different from other code snippets managers
is that it can test-compile snippets that are in the correct format. It
can also generate a compilable unit containing suitable selected snippets,
taking care of all dependencies.
</p>
<p>
<em>CodeSnip</em> understands several different
<a href="snippet_kinds.htm">kinds of snippet</a>: functions &
procedures, simple and complex type definitions (including classes and
advanced records), constants and complete units. The is also a free-form
format that lets you record source code in any form you want.
</p>
<p>
Using the program's multi tab interface you can navigate and search the
database. You can copy source code, save it, print it and share it with
others.
</p>
<p>
For a quick introduction see the <a
href="quickstart.htm">QuickStart Guide</a>. Alternatively you can learn
more about:
</p>
<ul>
<li>
The program's <a
href="main_display.htm">main display</a>.
</li>
<li>
<a
href="navigation.htm">Navigating</a> the database.
</li>
<li>
The <a
href="main_menu.htm">menu options</a>.
</li>
<li>
Performing <a
href="tasks.htm">common tasks</a>.
</li>
</ul>
<h2>
Welcome Page
</h2>
<p>
When the program starts it displays its welcome page. The page is divided
into five sections:
</p>
<ol>
<li>
<em>Local User Database</em>: provides information about the state of
the local user database.
</li>
<li>
<em>Code Snippets Database</em>: provides information about this
database (sometimes referred to as the "main" or
"online" database.
</li>
<li>
<em>Compilers</em>: lists the compilers, if any, that have been
configured for running test compilations within <em>CodeSnip</em>
</li>
<li>
<em>Help</em>: some usedful help links.
</li>
<li>
<em>Donate</em>: a request for donations to support <em>CodeSnip</em>
development.
</li>
</ol>
<p>
Some of the sections display links to related commands or help topics.
</p>
<p>
The welcome page can be re-displayed at any time by selecting the <em>View
| Welcome Page</em> menu option.
</p>
</body>
</html>
