CodeSnip Old Code (SVN)

A repository for source code snippets, designed with Pascal in mind.

Brought to you by: delphidabbler

[r2486]: / trunk / Src / Help / HTML / welcome.htm Maximize Restore History

83 lines (81 with data), 2.6 kB

<!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$
 *
 * Overview help topic (formerly Welcome topic).
-->
<html>
  <head>
    <meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
    <title>
      Overview
    </title>
    <link rel="stylesheet" href="../css/codesnip.css" type="text/css">
  </head>
  <body>
    <h1>
      <a name="welcome"></a>Overview
    </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://delphidabbler.com/url/csdb"
      >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 &amp;
      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&#39;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>
  </body>
</html>