]> granicus.if.org Git - postgis/commitdiff
oops more mistakes in link end
authorRegina Obe <lr@pcorp.us>
Wed, 10 Jul 2013 11:28:45 +0000 (11:28 +0000)
committerRegina Obe <lr@pcorp.us>
Wed, 10 Jul 2013 11:28:45 +0000 (11:28 +0000)
git-svn-id: http://svn.osgeo.org/postgis/trunk@11657 b70326c6-7e19-0410-871a-916f4a2858ee

doc/extras_tigergeocoder.xml
doc/installation.xml

index 4ffb38bf7b2478fa54a5e66e2d2290a4dbdee741..b77c9640d1a4a4dd324d238cb5d929d3645ff11b 100644 (file)
@@ -22,7 +22,7 @@ until release.  If you have data from tiger_2010 and want replace with tiger_201
                          
                          <note><para>New in PostGIS 2.1.0 release is ability to install tiger geocoder with PostgreSQL extension model if you are running PostgreSQL 9.1+. Refer to <xref linkend="install_tiger_geocoder_extension" /> for details.</para></note>
                          </para>
-                         <para>Also new in PostGIS 2.1.0 is integration with pagc address standardizer C library which source can be downloaded from <ulink url="http://pagc.svn.sourceforge.net/viewvc/pagc/branches/sew-refactor/postgresql">PAGC PostgreSQL address standardizer extension</ulink> and after install and install of the libraray in your PostGIS database, you can use the <xref linkend="pagc_normalize_address" /> function as a drop in replacement for in-built <xref linkend="normalize_address" />.</para> 
+                         <para>Also new in PostGIS 2.1.0 is integration with pagc address standardizer C library which source can be downloaded from <ulink url="http://pagc.svn.sourceforge.net/viewvc/pagc/branches/sew-refactor/postgresql">PAGC PostgreSQL address standardizer extension</ulink> and after install and install of the libraray in your PostGIS database, you can use the <xref linkend="Pagc_Normalize_Address" /> function as a drop in replacement for in-built <xref linkend="Normalize_Address" />.</para> 
                
 
 
@@ -984,6 +984,76 @@ CREATE INDEX idx_tiger_data_ma_faces_countyfp ON tiger_data.ma_faces USING btree
          </refsection>
        </refentry>
        
+               <refentry id="Normalize_Address">
+         <refnamediv>
+               <refname>Normalize_Address</refname>
+
+               <refpurpose>Given a textual street address, returns a composite <varname>norm_addy</varname> type that has road suffix, prefix and type standardized, street, streetname etc. broken into separate fields.  This function 
+               will work with just the lookup data packaged with the tiger_geocoder (no need for tiger census data).</refpurpose>
+         </refnamediv>
+
+         <refsynopsisdiv>
+               <funcsynopsis>
+                 <funcprototype>
+                       <funcdef>norm_addy <function>normalize_address</function></funcdef>
+                       <paramdef><type>varchar </type> <parameter>in_address</parameter></paramdef>
+                 </funcprototype>
+               </funcsynopsis>
+         </refsynopsisdiv>
+
+         <refsection>
+               <title>Description</title>
+
+               <para>Given a textual street address, returns a composite <varname>norm_addy</varname> type that has road suffix, prefix and type standardized, street, streetname etc. broken into separate fields.  This is the first step in the geocoding process to 
+                   get all addresses into normalized postal form. No other data is required aside from what is packaged with the geocoder.</para>
+               <para>This function just uses the various direction/state/suffix lookup tables preloaded with the tiger_geocoder and located in the <varname>tiger</varname> schema, so it doesn't need you to download tiger census data or any other additional data to make use of it.
+                You may find the need to add more abbreviations or alternative namings to the various lookup tables in the  <varname>tiger</varname> schema.</para>
+               <para>It uses various control lookup tables located in <varname>tiger</varname> schema to normalize the input address.</para>
+               <para>Fields in the <varname>norm_addy</varname> type object returned by this function in this order where  () indicates a field required by the geocoder, [] indicates an optional field:</para>
+               <para>(address) [predirAbbrev] (streetName) [streetTypeAbbrev] [postdirAbbrev] [internal] [location] [stateAbbrev] [zip]</para>
+         <orderedlist>
+          <listitem>
+            <para><varname>address</varname> is an integer:  The street number</para>
+          </listitem>
+          <listitem>
+            <para><varname>predirAbbrev</varname> is varchar: Directional prefix of road such as N, S, E, W etc.  These are controlled using the <varname>direction_lookup</varname> table.</para>
+          </listitem>
+          <listitem>
+            <para><varname>streetName</varname> varchar</para>
+          </listitem>
+          <listitem>
+            <para><varname>streetTypeAbbrev</varname> varchar abbreviated version of street type: e.g. St, Ave, Cir.  These are controlled using the <varname>street_type_lookup</varname> table.</para>
+          </listitem>
+          <listitem>
+            <para><varname>postdirAbbrev</varname> varchar abbreviated directional suffice of road N, S, E, W etc. These are controlled using the <varname>direction_lookup</varname> table.</para>
+          </listitem>
+          <listitem>
+            <para><varname>internal</varname> varchar internal address such as an apartment or suite number.</para>
+          </listitem>
+          <listitem>
+            <para><varname>location</varname> varchar usually a city or governing province.</para>
+          </listitem>
+           <listitem>
+            <para><varname>stateAbbrev</varname> varchar two character US State.  e.g MA, NY, MI.  These are controlled by the <varname>state_lookup</varname> table.</para>
+          </listitem>
+          <listitem>
+            <para><varname>zip</varname> varchar 5-digit zipcode. e.g. 02109.</para>
+          </listitem>
+          <listitem>
+            <para><varname>parsed</varname> boolean - denotes if addess was formed from normalize process. The normalize_address function sets this to true before returning the address.</para>
+          </listitem>
+        </orderedlist>
+
+         </refsection>
+
+
+         <!-- Optionally add a "See Also" section -->
+         <refsection>
+               <title>See Also</title>
+               <para><xref linkend="Normalize_Address"/></para>
+         </refsection>
+       </refentry>
+       
        <refentry id="Pprint_Addy">
          <refnamediv>
                <refname>Pprint_Addy</refname>
index 5e2185e862040a8e17ee7fedf8d424e3534e70ef..7d133c822f48929e535eecc7dfdbcebe20c6578c 100644 (file)
@@ -1235,11 +1235,11 @@ SELECT 'debbie', declare_sect, pgbin, wget, unzip_command, psql, path_sep,
                </sect3>
                
                <sect3 id="installing_pagc_address_standardizer"><title>Using PAGC address standardizer</title>
-                       <para>One of the many complaints of folks is the address normalizer function <xref linkend="normalize_address" /> function that normalizes an address for prepping before geocoding.  The normalizer is far from perfect and trying to patch its imperfectness takes a vast amount of resources.  As such we have integrated with another
+                       <para>One of the many complaints of folks is the address normalizer function <xref linkend="Normalize_Address" /> function that normalizes an address for prepping before geocoding.  The normalizer is far from perfect and trying to patch its imperfectness takes a vast amount of resources.  As such we have integrated with another
                        project that has a much better address standardizer engine.  This is currently a separate project, which is a subproject of PAGC.  The source code for this PostgreSQL standardizer extension can be downloaded from <ulink url="http://pagc.svn.sourceforge.net/viewvc/pagc/branches/sew-refactor/postgresql">PAGC PostgreSQL Address Standardizer</ulink>.  To use this new normalizer, you compile the pagc extension and install as an extension in your database with:</para>
                        <programlisting>CREATE EXTENSION address_standardizer;</programlisting>
                        
-                       <para>Once you install this extension in the same database as you have installed <code>postgis_tiger_geocoder</code>, then the <xref linkend="pagc_normalize_address" /> can be used instead of <xref linkend="normalize_address" />. The other nice thing about this extension is that its tiger agnostic, so can be used with other data sources such as international addresses.</para>
+                       <para>Once you install this extension in the same database as you have installed <code>postgis_tiger_geocoder</code>, then the <xref linkend="Pagc_Normalize_Address" /> can be used instead of <xref linkend="Normalize_Address" />. The other nice thing about this extension is that its tiger agnostic, so can be used with other data sources such as international addresses.</para>
 
                </sect3>
        </sect2>