svn commit: r292870 - /forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml

[rg...@apache.org]

Author: rgardler
Date: Fri Sep 30 16:09:45 2005
New Revision: 292870

URL: http://svn.apache.org/viewcvs?rev=292870&view=rev
Log:
Add naming convention notes from IRC session (thanks to Tim Williams for writing them up)

Modified:
    forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml

Modified: forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml
URL: http://svn.apache.org/viewcvs/forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml?rev=292870&r1=292869&r2=292870&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_80/locationmap.xml Fri Sep 30 16:09:45 2005
@@ -58,6 +58,50 @@
       
     </section>
     
+    <section id="namingConvention">
+      <title>Naming Convention</title>
+      <p>For those that are familiar with name
+      resolution servers or the Handles Service, it might be easier to think of the
+      locationmap as a name resolution module or sort of a handle resolution module
+      that it accepts "names" or whatever you desire to call these "hints" and
+      returns the location.</p> 
+
+      <p>The thought is that by using hints that look a little like a
+      file name it disguises what locationmaps are really doing for us.
+      By using URN-style names, we are truly
+      disassociating the name/hint form the physical location.</p>
+
+      <p>For example, here is a locationmap entry based purely on filename:</p>
+      
+      <source><![CDATA[
+<map:transform src="{lm:xhtml2html.xsl}"/>
+      ]]></source>
+
+      <p>and here is that same entry using a "name" style.  One implies 
+      a certain physical location where as the one below is truly a name that 
+      needs to be resolved to a physical location.</p>
+
+      <source><![CDATA[
+<map:transform src="{lm:transform.xhtml2.html}"/>
+      ]]></source>
+
+      <p>The format is essentially one of:</p>
+      
+      <source>
+resource-type(dot)from-format(dot)to-format
+      </source>
+      <p>or</p>
+      <source>
+resource-type(dot)type(dot)name
+      </source>
+
+      <p>Examples of these two:</p>
+      <source>
+transform.xslt.xthml2.html
+graphic.png.project-logo
+      </source>
+  </section>
+    
     <section id="examples">
       <title>Locationmap Examples</title>
       <section>