]> granicus.if.org Git - postgis/commitdiff
finish listing all key user defined tables -- needs more work but a start
authorRegina Obe <lr@pcorp.us>
Thu, 17 Jul 2014 04:12:32 +0000 (04:12 +0000)
committerRegina Obe <lr@pcorp.us>
Thu, 17 Jul 2014 04:12:32 +0000 (04:12 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@12788 b70326c6-7e19-0410-871a-916f4a2858ee

doc/extras_address_standardizer.xml

index 622398800a0848feb75b74c5f92dc352e64295ec..a96ad75acf76470e5b5b1fa787f817105f6e60ef 100644 (file)
@@ -142,7 +142,7 @@ into includes in the future for easier maintenance.</para></listitem>
         <title>Address Standardizer Tables</title>\r
         <refentry id="rulestab">\r
                                        <refnamediv>\r
-                                       <refname>rules</refname>\r
+                                       <refname>rules table</refname>\r
                                                <refpurpose>The rules table contains a set of rules that maps address input sequence tokens to standardized output sequence</refpurpose>\r
                                        </refnamediv>\r
                                        <refsection>\r
@@ -199,6 +199,92 @@ into includes in the future for easier maintenance.</para></listitem>
                                                                </varlistentry>\r
                                                </variablelist>\r
                                                \r
+                                       </refsection>\r
+                               </refentry>\r
+                               \r
+                               <refentry id="lextab">\r
+                                       <refnamediv>\r
+                                       <refname>lex table</refname>\r
+                                               <refpurpose>A lex table is used to classify alphanumeric input and associate that input with (a) input tokens ( See Input Tokens) and (b) standardized representations.</refpurpose>\r
+                                       </refnamediv>\r
+                                       <refsection>\r
+                                               <title>Description</title>\r
+                                               <para>A lex (short for lexicon) table is used to classify alphanumeric input and associate that input with <ulink url="http://www.pagcgeo.org/docs/html/pagc-12.html#--i-tok--">(a) input tokens</ulink> and (b) standardized representations. Things you will find in these tables are <code>ONE</code> mapped to stdworkd: <code>1</code>.</para>\r
+                                               \r
+                                               <para>A lex has at least the following columns in the table. You may add</para>\r
+                                                       <variablelist>\r
+                                                               <varlistentry>\r
+                                                                               <term>id</term>\r
+                                                                               <listitem>\r
+                                                                                       <para>Primary key of table</para>\r
+                                                                               </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>seq</term> \r
+                                                                       <listitem>\r
+                                                                               <para>integer: definition number?</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+\r
+                                                               <varlistentry><term>word</term> \r
+                                                                       <listitem>\r
+                                                                               <para>text: the input word</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>stdword</term> \r
+                                                                       <listitem>\r
+                                                                               <para>text: the standardized replacement word</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>token</term> \r
+                                                                       <listitem>\r
+                                                                               <para>integer: the kind of word it is.  Only if it is used in this context will it be replaced. Refer to <ulink url="http://www.pagcgeo.org/docs/html/pagc-12.html#--i-tok--">PAGC Tokens</ulink>.</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                               </variablelist>\r
+                                       </refsection>\r
+                               </refentry>\r
+                               \r
+                               <refentry id="gaztab">\r
+                                       <refnamediv>\r
+                                       <refname>gaz table</refname>\r
+                                               <refpurpose>A gaz table is used to standardize place names and associate that input with (a) input tokens ( See Input Tokens) and (b) standardized representations.</refpurpose>\r
+                                       </refnamediv>\r
+                                       <refsection>\r
+                                               <title>Description</title>\r
+                                               <para>A gaz (short for gazeteer) table is used to classify place names and associate that input with <ulink url="http://www.pagcgeo.org/docs/html/pagc-12.html#--i-tok--">(a) input tokens</ulink> and (b) standardized representations. For example if you are in US, you may load these with State Names and associated abbreviations.</para>\r
+                                               \r
+                                               <para>A gaz table has at least the following columns in the table. You may add more columns if you wish for your own purposes.</para>\r
+                                                       <variablelist>\r
+                                                               <varlistentry>\r
+                                                                               <term>id</term>\r
+                                                                               <listitem>\r
+                                                                                       <para>Primary key of table</para>\r
+                                                                               </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>seq</term> \r
+                                                                       <listitem>\r
+                                                                               <para>integer: definition number?</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>word</term> \r
+                                                                       <listitem>\r
+                                                                               <para>text: the input word</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>stdword</term> \r
+                                                                       <listitem>\r
+                                                                               <para>text: the standardized replacement word</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                                               <varlistentry><term>token</term> \r
+                                                                       <listitem>\r
+                                                                               <para>integer: the kind of word it is.  Only if it is used in this context will it be replaced. Refer to <ulink url="http://www.pagcgeo.org/docs/html/pagc-12.html#--i-tok--">PAGC Tokens</ulink>.</para>\r
+                                                                       </listitem>\r
+                                                               </varlistentry>\r
+                                               </variablelist>\r
+                                               \r
+                                       \r
+                                               \r
                                        </refsection>\r
                                </refentry>\r
   </sect1>\r
@@ -257,7 +343,7 @@ into includes in the future for easier maintenance.</para></listitem>
                <refsection>\r
                        <title>See Also</title>\r
        \r
-                       <para><xref linkend="stdaddr" /></para>\r
+                       <para><xref linkend="stdaddr" />, <xref linkend="rulestab" />, <xref linkend="lextab" />, , <xref linkend="gaztab" /></para>\r
                </refsection>\r
        </refentry>\r
   \r