sqlite3/www/docs.tcl

   1 # This script generates the "docs.html" page that describes various
   2 # sources of documentation available for SQLite.
   3 #
   4 set rcsid {$Id: docs.tcl,v 1.11 2005/03/19 14:45:50 drh Exp $}
   5 source common.tcl
   6 header {SQLite Documentation}
   7 puts {
   8 <h2>Available Documentation</h2>
   9 <table width="100%" cellpadding="5">
  10 }
  11
  12 proc doc {name url desc} {
  13   puts {<tr><td valign="top" align="right">}
  14   regsub -all { +} $name {\&nbsp;} name
  15   puts "<a href=\"$url\">$name</a></td>"
  16   puts {<td width="10"></td>}
  17   puts {<td align="top" align="left">}
  18   puts $desc
  19   puts {</td></tr>}
  20 }
  21
  22 doc {Appropriate Uses For SQLite} {whentouse.html} {
  23   This document describes situations where SQLite is an approriate
  24   database engine to use versus situations where a client/server
  25   database engine might be a better choice.
  26 }
  27
  28 doc {Distinctive Features} {different.html} {
  29   This document enumerates and describes some of the features of
  30   SQLite that make it different from other SQL database engines.
  31 }
  32
  33 doc {SQLite In 5 Minutes Or Less} {quickstart.html} {
  34   A very quick introduction to programming with SQLite.
  35 }
  36
  37 doc {SQL Syntax} {lang.html} {
  38   This document describes the SQL language that is understood by
  39   SQLite.
  40 }
  41
  42 doc {Pragma commands} {pragma.html} {
  43   This document describes SQLite performance tuning options and other
  44   special purpose database commands.
  45 }
  46
  47 doc {Version 2 C/C++ API} {c_interface.html} {
  48   A description of the C/C++ interface bindings for SQLite through version
  49   2.8
  50 }
  51 doc {SQLite Version 3} {version3.html} {
  52   A summary of of the changes between SQLite version 2.8 and SQLite version 3.0.
  53 }
  54 doc {Version 3 C/C++ API} {capi3.html} {
  55   A description of the C/C++ interface bindings for SQLite version 3.0.0
  56   and following.
  57 }
  58 doc {Version 3 C/C++ API<br>Reference} {capi3ref.html} {
  59   This document describes each API function separately.
  60 }
  61
  62 doc {Tcl API} {tclsqlite.html} {
  63   A description of the TCL interface bindings for SQLite.
  64 }
  65
  66 doc {Locking And Concurrency<br>In SQLite Version 3} {lockingv3.html} {
  67   A description of how the new locking code in version 3 increases
  68   concurrancy and decreases the problem of writer starvation.
  69 }
  70
  71 doc {Version 2 DataTypes } {datatypes.html} {
  72   A description of how SQLite version 2 handles SQL datatypes.
  73   Short summary:  Everything is a string.
  74 }
  75 doc {Version 3 DataTypes } {datatype3.html} {
  76   SQLite version 3 introduces the concept of manifest typing, where the
  77   type of a value is associated with the value itself, not the column that
  78   it is stored in.
  79   This page describes data typing for SQLite version 3 in further detail.
  80 }
  81
  82 doc {Release History} {changes.html} {
  83   A chronology of SQLite releases going back to version 1.0.0
  84 }
  85
  86 doc {Null Handling} {nulls.html} {
  87   Different SQL database engines handle NULLs in different ways.  The
  88   SQL standards are ambiguous.  This document describes how SQLite handles
  89   NULLs in comparison with other SQL database engines.
  90 }
  91
  92 doc {Copyright} {copyright.html} {
  93   SQLite is in the public domain.  This document describes what that means
  94   and the implications for contributors.
  95 }
  96
  97 doc {Unsupported SQL} {omitted.html} {
  98   This page describes features of SQL that SQLite does not support.
  99 }
 100
 101 doc {Speed Comparison} {speed.html} {
 102   The speed of version 2.7.6 of SQLite is compared against PostgreSQL and
 103   MySQL.
 104 }
 105
 106 doc {Architecture} {arch.html} {
 107   An architectural overview of the SQLite library, useful for those who want
 108   to hack the code.
 109 }
 110
 111 doc {VDBE Tutorial} {vdbe.html} {
 112   The VDBE is the subsystem within SQLite that does the actual work of
 113   executing SQL statements.  This page describes the principles of operation
 114   for the VDBE in SQLite version 2.7.  This is essential reading for anyone
 115   who want to modify the SQLite sources.
 116 }
 117
 118 doc {VDBE Opcodes} {opcode.html} {
 119   This document is an automatically generated description of the various
 120   opcodes that the VDBE understands.  Programmers can use this document as
 121   a reference to better understand the output of EXPLAIN listings from
 122   SQLite.
 123 }
 124
 125 doc {Compilation Options} {compile.html} {
 126   This document describes the compile time options that may be set to
 127   modify the default behaviour of the library or omit optional features
 128   in order to reduce binary size.
 129 }
 130
 131 doc {Backwards Compatibility} {formatchng.html} {
 132   This document details all of the incompatible changes to the SQLite
 133   file format that have occurred since version 1.0.0.
 134 }
 135
 136 puts {</table>}
 137 footer $rcsid