Documentation Source Text

Check-in [df95e4e1ec]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Fix typos in documentation.
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: df95e4e1ec75dcd2a224abdb1189f7e99896d584
User & Date: drh 2013-10-16 23:58:48
Context
2013-10-17
12:54
Add news for the 3.8.1 release. Other final documentation tweaks prior to release. check-in: ca4b03a1f2 user: drh tags: trunk
2013-10-16
23:58
Fix typos in documentation. check-in: df95e4e1ec user: drh tags: trunk
2013-10-15
19:08
Added the fts4aux languageid column. Fix typos in famous.html check-in: cd0e9d17ed user: drh tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Changes to pages/fts3.in.

  1376   1376       When set to the value "fts3", the matchinfo option reduces the amount of
  1377   1377       information stored by FTS4 with the consequence that the "l" option of
  1378   1378       [matchinfo()] is no longer available.
  1379   1379   
  1380   1380     <tr><td>notindexed<td> 
  1381   1381       This option is used to specify the name of a column for which data is
  1382   1382       not indexed. Values stored in columns that are not indexed are not
  1383         -    matched by MATCH queries. Nor are they recognized by auxilliary functions.
         1383  +    matched by MATCH queries. Nor are they recognized by auxiliary functions.
  1384   1384       A single CREATE VIRTUAL TABLE statement may have any number of notindexed 
  1385   1385       options.
  1386   1386   
  1387   1387     <tr><td>order<td>
  1388   1388       <tcl>hd_fragment fts4order {FTS4 order option}</tcl>
  1389   1389       ^The "order" option may be set to either "DESC" or "ASC" (in upper or
  1390   1390       lower case). ^If it is set to "DESC", then FTS4 stores its data in such
................................................................................
  1769   1769     <i>-- are tokenized and added to the inverted index.</i>
  1770   1770     CREATE VIRTUAL TABLE t1 USING fts4(c1, c2, c3, c4, notindexed=c1, notindexed=c3);
  1771   1771   </codeblock>
  1772   1772   
  1773   1773   <p>
  1774   1774     Values stored in unindexed columns are not eligible to match MATCH 
  1775   1775     operators. The do not influence the results of the offsets() or matchinfo()
  1776         -  auxilliary functions. Nor will the snippet() function ever return a
         1776  +  auxiliary functions. Nor will the snippet() function ever return a
  1777   1777     snippet based on a value stored in an unindexed column.
  1778   1778   
  1779   1779   <tcl>hd_fragment fts4prefix {FTS4 prefix option}</tcl>
  1780   1780   <h2 tags="fts4 prefix option">The prefix= option</h2>
  1781   1781   
  1782   1782   <p>
  1783   1783     ^The FTS4 prefix option causes FTS to index term prefixes of specified lengths
................................................................................
  2073   2073     case folding according to rules in Unicode Version 6.1 and it recognizes
  2074   2074     unicode space and punctuation characters and uses those to separate tokens.
  2075   2075     The simple tokenizer only does case folding of ASCII characters and only
  2076   2076     recognizes ASCII space and punctuation characters as token separators.
  2077   2077   
  2078   2078   <p>
  2079   2079     By default, "unicode61" also removes all diacritics from Latin script
  2080         -  characters. This behaviour can be overriden by adding the tokenizer argument
         2080  +  characters. This behaviour can be overridden by adding the tokenizer argument
  2081   2081     "remove_diacritics=0". For example:
  2082   2082   
  2083   2083   <codeblock>
  2084   2084       <i>-- Create tables that remove diacritics from Latin script characters</i>
  2085   2085       <i>-- as part of tokenization.</i>
  2086   2086       CREATE VIRTUAL TABLE txt1 USING fts4(tokenize=unicode61);
  2087   2087       CREATE VIRTUAL TABLE txt2 USING fts4(tokenize=unicode61 "remove_diacritics=1");

Changes to pages/lang.in.

  2154   2154     between 0.0 and 1.0, inclusive.)^
  2155   2155     ^The likelihood(X) function is a no-op that the code generator
  2156   2156     optimizes away so that it consumes no CPU cycles during run-time
  2157   2157     (that is, during calls to [sqlite3_step()]).
  2158   2158     ^The purpose of the likelihood(X,Y) function is to provide a hint
  2159   2159     to the query planner that the argument X is a boolean that is
  2160   2160     true with a probability of approximately Y.
  2161         -  ^(The [unlikely(X)] fucntion is short-hand for likelihood(X,0.0625).)^
         2161  +  ^(The [unlikely(X)] function is short-hand for likelihood(X,0.0625).)^
  2162   2162   }
  2163   2163   
  2164   2164   funcdef {load_extension(X) load_extension(X,Y)} {} {
  2165   2165     ^The load_extension(X,Y) function loads [SQLite extensions] out of the shared
  2166   2166     library file named X using the entry point Y.  ^The result of load_extension()
  2167   2167     is always a NULL.  ^If Y is omitted then the default entry point name is used.
  2168   2168     ^The load_extension() function raises an exception if the extension fails to
................................................................................
  3126   3126   the join operations are processed in order from left to right. In other 
  3127   3127   words, the FROM clause (A join-op-1 B join-op-2 C) is computed as 
  3128   3128   ((A join-op-1 B) join-op-2 C).)^
  3129   3129   
  3130   3130   <tcl>hd_fragment crossjoin {treats the CROSS JOIN operator specially}</tcl>
  3131   3131   <p><b>Side note: Special handling of CROSS JOIN.</b>
  3132   3132   ^There is no difference between the "INNER JOIN", "JOIN" and "," join
  3133         -operators. They are completely interchangable in SQLite.
         3133  +operators. They are completely interchangeable in SQLite.
  3134   3134   ^(The "CROSS JOIN" join operator produces the same result as the 
  3135   3135   "INNER JOIN", "JOIN" and "," operators)^, but is 
  3136   3136   <a href=optoverview.html#crossjoin>handled differently by the query
  3137   3137   optimizer</a> in that it prevents the query optimizer from reordering
  3138   3138   the tables in the join.  An application programmer can use the CROSS JOIN 
  3139         -operator to directly influense the algorithm that is chosen to implement
         3139  +operator to directly influence the algorithm that is chosen to implement
  3140   3140   the SELECT statement.  Avoid using CROSS JOIN except in specific situations 
  3141   3141   where manual control of the query optimizer is desired.  Avoid using
  3142   3142   CROSS JOIN early in the development of an application as doing so is
  3143   3143   a <a href="http://c2.com/cgi/wiki?PrematureOptimization">premature
  3144   3144   optimization</a>.  The special handling of CROSS JOIN is an SQLite-specific
  3145   3145   feature and is not a part of standard SQL.
  3146   3146          

Changes to pages/rtree.in.

   129    129   <blockquote><pre>
   130    130   INSERT INTO demo_index VALUES(
   131    131       1,                   -- Primary key -- SQLite.org headquarters
   132    132       -80.7749, -80.7747,  -- Longitude range
   133    133       35.3776, 35.3778     -- Latitude range
   134    134   );
   135    135   INSERT INTO demo_index VALUES(
   136         -    2,                   -- NC 12th Congressional Distrinct in 2010
          136  +    2,                   -- NC 12th Congressional District in 2010
   137    137       -81.0, -79.6,
   138    138       35.0, 36.2
   139    139   );
   140    140   </pre></blockquote>)^
   141    141   
   142    142   <p>
   143    143   The entries above might represent (for example) a bounding box around

Changes to pages/spellfix1.in.

   211    211   rows.  This value is an integer which is the number of
   212    212   of words examined using the edit-distance algorithm to
   213    213   find the top matches that are ultimately displayed.  This
   214    214   value is for diagnostic use only.
   215    215   
   216    216   <dt><p><b>soundslike</b><dd>
   217    217   (HIDDEN)  When inserting vocabulary entries, this field
   218         -can be set to an spelling that matches what the word
          218  +can be set to a spelling that matches what the word
   219    219   sounds like.  See the DEALING WITH UNUSUAL AND DIFFICULT
   220    220   SPELLINGS section below for details.
   221    221   
   222    222   <dt><p><b>command</b><dd>
   223    223   (HIDDEN)  The value of the "command" column is always NULL.  However,
   224    224   applications can insert special strings into the "command" column in order
   225    225   to provoke certain behaviors in the spellfix1 virtual table.
................................................................................
   429    429   <dt><p><b>editdist3(P,W)<br>editdist2(P,W,L)<br>editdist3(T)</b><dd>
   430    430   These routines provide direct access to the version of the Wagner
   431    431   edit-distance function that allows for application-defined weights
   432    432   on edit operations.  The first two forms of this function compare
   433    433   pattern P against word W and return the edit distance.  In the first
   434    434   function, the langid is assumed to be 0 and in the second, the
   435    435   langid is given by the L parameter.  The third form of this function
   436         -reloads edit distance coefficience from the table named by T.
          436  +reloads edit distance coefficients from the table named by T.
   437    437   
   438    438   <dt><p><b>spellfix1_editdist(P,W)</b><dd>
   439    439   This routine provides access to the built-in Wagner edit-distance
   440    440   function that uses default, fixed costs.  The value returned is
   441    441   the edit distance needed to transform W into P.
   442    442   
   443    443   <dt><p><b>spellfix1_phonehash(X)</b><dd>
................................................................................
   476    476   
   477    477   <ul>
   478    478   <li><p>It works with unicode (UTF8) text.
   479    479   
   480    480   <li><p>A table of insertion, deletion, and substitution costs can be 
   481    481          provided by the application.
   482    482   
   483         -<li><p>Multi-character insertsions, deletions, and substitutions can be
          483  +<li><p>Multi-character insertions, deletions, and substitutions can be
   484    484          enumerated in the cost table.
   485    485   </ul>
   486    486   
   487    487   <h2>The editdist3 COST table</h2>
   488    488   
   489    489   <p>To program the costs of editdist3, create a table such as the following:
   490    490   
   491    491   <blockquote><pre>
   492    492   CREATE TABLE editcost(
   493    493     iLang INT,   -- The language ID
   494    494     cFrom TEXT,  -- Convert text from this
   495    495     cTo   TEXT,  -- Convert text into this
   496         -  iCost INT    -- The cost of doing the conversionnn
          496  +  iCost INT    -- The cost of doing the conversion
   497    497   );
   498    498   </pre></blockquote>
   499    499   
   500    500   <p>The cost table can be named anything you want - it does not have to be
   501    501   called "editcost".  And the table can contain additional columns.
   502    502   The only requirement is that the
   503    503   table must contain the four columns show above, with exactly the names shown.
................................................................................
   582    582   with weights and the weight table changes, simply rerun the single-argument
   583    583   form of editdist3() to reload revised coefficients.  Note that the 
   584    584   edit distance
   585    585   weights used by the editdist3() SQL function are independent from the
   586    586   weights used by the spellfix1 virtual table.
   587    587   
   588    588   <p>The second and third forms return the computed edit distance between strings
   589         -'string1' and "string2'.  In the second form, an language id of 0 is used.
          589  +'string1' and "string2'.  In the second form, a language id of 0 is used.
   590    590   The language id is specified in the third form.