Menu
▾
▴
[pilot-db-list] palm-db-tools 0_3_6 docs/manual.html patch
|
From: Larry W. V. <lv...@ca...> - 2003-08-29 12:28:40
|
Here's a patch that fixes some typos , formatting issues, etc.
Hopefully others find the resulting html file a little easier to read.
--- manual.html.orig 2003-08-29 07:52:27.440005000 -0400
+++ manual.html 2003-08-29 08:26:31.820020000 -0400
@@ -1,5 +1,6 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
-<header>
+<head>
<title>Palm DB Tools</title>
-</header>
+</head>
<body>
@@ -11,6 +12,6 @@
<p>The self-extractor will install xdbtools.xlt model sheet in your
-installation directory and your "Application data\Microsoft\Teplates"
+installation directory and your "Application data\Microsoft\Templates"
directory.</p>
-<p><ul>
+<ul>
<li>Create a new document with xdbtools model sheet. There is two ways
@@ -20,3 +21,3 @@
the "xdbtools" model.
- <li> Open directly the xdbtools.xlt file (you canfind a link in your
+ <li> Open directly the xdbtools.xlt file (you can find a link in your
start menu).
@@ -30,3 +31,3 @@
<li> Save and install: to save your data in the *.pdb file and ask
- the installation at the next synchronisation of your palm.
+ the installation at the next synchronization of your palm.
<li> Init: to load a new *.pdb file.
@@ -156,3 +157,4 @@
-<table border="1" width="100%"><tr><td>
+<table border="1" width="100%" summary="format control of pilot-db info file arguments">
+<tr><td>
* The "title" directive sets the title of the database as you would see
@@ -167,3 +169,5 @@
Replace TITLE with the title that you want.
-</td></tr><tr><td>
+</td></tr>
+
+<tr><td>
* The "type" directive sets the type of the database. It has the
@@ -172,3 +176,3 @@
<pre class="screen">
- title "FORMAT"
+ type "FORMAT"
</pre>
@@ -177,9 +181,16 @@
-<pre class="screen">
- DB: for Pilot-DB database format (Pilot-DB version after 0.3.0)
- JFile3: for JFile3 database format.
- MobileDB: for MobileDB database format.
- List: for List database format.
-</pre>
-</td></tr><tr><td>
+<DL class="screen">
+<dt>DB</dt>
+<dd>for Pilot-DB database format (Pilot-DB version after 0.3.0)</dd>
+<dt>JFile3</dt>
+<dd>for JFile3 database format.</dd>
+<dt>MobileDB</dt>
+<dd>for MobileDB database format.</dd>
+<dt>List</dt>
+<dd>for List database format.</dd>
+</dl>
+
+</td></tr>
+
+<tr><td>
* The "field" directive tells the conversion utility about what fields
@@ -194,14 +205,22 @@
actual values. Replace NAME with the name of the field. The TYPE of
-the field should be "string", "boolean", or "integer" if the type of
-the field is a string, checkbox (true/false), or a number
-respectively. The ARGUMENT parameter is used to pass informations
+the field should be "string", "boolean", "date", "time", "float",
+or "integer" if the type of
+the field is a string, checkbox (true/false), a calendar date, clock time,
+or a number (decimal or whole) respectively.
+Warning! Not all field types are supported for all database types.
+The ARGUMENT parameter is used to pass informations
about the field:
-<pre class="screen">
- string: ARGUMENT = default value (string)
- integer: ARGUMENT = default value (integer)
- float: ARGUMENT = default value (float)
-</pre>
+<dl class="screen">
+<dt>string</dt><dd>ARGUMENT = field's default value (string)</dd>
+<dt>boolean</dt><dd>ARGUMENT = field's default value (boolean)</dd>
+<dt>date</dt><dd>ARGUMENT = field's default value (date)</dd>
+<dt>time</dt><dd>ARGUMENT = field's default value (time)</dd>
+<dt>float</dt><dd>ARGUMENT = field's default value (float)</dd>
+<dt>integer</dt><dd>ARGUMENT = field's default value (integer)</dd>
+</dl>
-</td></tr><tr><td>
+</td></tr>
+
+<tr><td>
* The "extended" directive determines if the data file will be
@@ -218,3 +237,3 @@
</td></tr><tr><td>
-* The "separator" directive deternime the field separator type used in
+* The "separator" directive determine the field separator type used in
the CSV file. It has the following format:
@@ -222,3 +241,3 @@
<pre class="screen">
- separator SEPERATOR
+ separator SEPARATOR
</pre>
@@ -237,5 +256,7 @@
Replace FILENAME with the path and the file name of your CSV file or
-stdIO to read/write the CSV file on the standard In/Out.
+stdio to read/write the CSV file on the standard In/Out.
-</td></tr><tr><td>
+</td></tr>
+
+<tr><td>
* The "format" directive determine the format used for the time, date
@@ -257,3 +278,3 @@
<pre class="screen">
-attribut %:
+attribute %:
d day of month.
@@ -266,3 +287,5 @@
-</td></tr><tr><td>
+</td></tr>
+
+<tr><td>
* For databases which support multiple list views or a list view with
@@ -283,3 +306,3 @@
Several of the database formats do not support multiple list views. In
-this case, you can either specifiy a "view" directive matching the
+this case, you can either specify a "view" directive matching the
requirements of the database format exactly or just give the widths as
@@ -288,3 +311,5 @@
-</td></tr><tr><td>
+</td></tr>
+
+<tr><td>
* The "option" directive allows special parameters that are specific to
@@ -322,4 +347,4 @@
flag on or off, respectively. The default is "off".
- Warning!:This flag can do some troubles because it use only for
- database in ROM not in RAM!
+ Warning!: This flag can cause some trouble because it is used only for
+ databases in ROM not in RAM!
@@ -366,3 +391,3 @@
-<p>You can specify this database format by passing "DB" or "db" to the -t
+<p>You can specify the database format by passing "DB" or "db" to the -t
option of the csv2pdb conversion utility. This format is also the
@@ -370,6 +395,7 @@
-<p>Only one option is supported besides the standard options:
+<p>Three options are supported besides the standard options:
-<center><table width="80%"><tr><td>
- option find BOOLEAN<br>
+<center><table width="80%" summary="pilot-db version 0.3 format information">
+<tr><td>
+ <p>option find BOOLEAN<br>
@@ -378,12 +404,15 @@
"on" or "off" depending on whether you want to enable or disable
- Global Find, respectively. The default is "on".
-</td></tr><tr><td>
+ Global Find, respectively. The default is "on".</p>
+</td></tr>
+
+<tr><td>
<p>option read-only BOOLEAN<br>
- If this option are enable the database will be opened only in read
- only mode. You will not able to modify records or DB structure.
+ If this option is enabled, the database will be opened in read
+ only mode. You will not able to modify records or the DB structure.
Replace BOOLEAN with "on" or "off" depending on whether you want to
enable or disable ReadOnly, respectively. The default is "off".</p>
-</td></tr><tr><td>
+</td></tr>
+<tr><td>
<p>option systemPWD BOOLEAN<br>
@@ -416,3 +445,4 @@
-<center><table width="80%"><tr><td>
+<center><table width="80%" summary="pilot-db 0.2 info format description">
+<tr><td>
<p>option find BOOLEAN<br>
@@ -446,3 +476,4 @@
-<center><table width="80%"><tr><td>
+<center><table width="80%" summary="MobileDB info file parms">
+<tr><td>
<p>option find BOOLEAN<br>
@@ -453,4 +484,5 @@
Global Find, respectively. The default is "on".</p>
-</td></tr><tr><td>
+</td></tr>
+<tr><td>
<p>option edit-on-select BOOLEAN<br>
@@ -463,4 +495,5 @@
is "off".</p>
-</td></tr><tr><td>
+</td></tr>
+<tr><td>
<p>option password PASSWORD<br>
@@ -493,3 +526,4 @@
-<center><table width="80%"><tr><td>
+<center><table width="80%" summary="List info file description">
+<tr><td>
<p>option list-display-style STYLE<br>
@@ -499,4 +533,5 @@
which field is displayed first. The default is "field1-field2".</p>
-</td></tr><tr><td>
+</td></tr>
+<tr><td>
<p>option read-only BOOLEAN<br>
@@ -530,3 +565,4 @@
-<center><table width="80%"><tr><td>
+<center><table width="80%" summary="JFile version 3 info file description">
+<tr><td>
<p>option password PASSWORD<br>
@@ -579,5 +615,5 @@
-<small><p>Suppose you have a data file called foods.txt and an info file called
+<p><small>Suppose you have a data file called foods.txt and an info file called
foods.ifo. The following command will build a MobileDB database file
-called foods.pdb that you can HotSync to your Pilot:</p>
+called foods.pdb that you can HotSync to your Pilot:</small></p>
@@ -601,3 +637,3 @@
-<p>The other options should be straight-forward.</p></small>
+<p><small>The other options should be straight-forward.</small></p>
@@ -654,4 +690,4 @@
-<small><p>Suppose you wanted to convert a database called drinks.pdb back into
-text files. Just run this command and you're done:</p>
+<p><small>Suppose you wanted to convert a database called drinks.pdb back into
+text files. Just run this command and you're done:</small></p>
@@ -681,3 +717,3 @@
</pre>
-</small>
+
</body>
--
Tcl - The glue of a new generation. <URL: http://wiki.tcl.tk/ >
Larry W. Virden <mailto:lv...@ca...> <URL: http://www.purl.org/NET/lvirden/>
Even if explicitly stated to the contrary, nothing in this posting should
be construed as representing my employer's opinions.
-><-
|
