forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r411534 - /forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/linking.xml
Date Sun, 04 Jun 2006 07:55:08 GMT
Author: crossley
Date: Sun Jun  4 00:55:08 2006
New Revision: 411534

URL: http://svn.apache.org/viewvc?rev=411534&view=rev
Log:
Explain that there is one set of image handling with match "images" in the URI,
then another image handling for **.png which also uses SNG and ASCII Art.

Modified:
    forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/linking.xml

Modified: forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/linking.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/linking.xml?rev=411534&r1=411533&r2=411534&view=diff
==============================================================================
--- forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/linking.xml (original)
+++ forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/linking.xml Sun
Jun  4 00:55:08 2006
@@ -385,6 +385,8 @@
     src/documentation/resources/images/sub-dir/icon-c.png
     src/documentation/content/xdocs/images/icon-e.png
     src/documentation/content/xdocs/samples/icon-d.png
+    src/documentation/content/xdocs/samples/ellipse.svg
+    src/documentation/content/xdocs/samples/cocoon-pyramid.aart
 ]]></source>
       <p>Here is the effect of the various image links ...</p>
       <ol>
@@ -426,16 +428,20 @@
           The source file is found in src/documentation/resources/images/ directory.
           However there is a problem here. When using Forrest in command-line mode,
           the image will be generated outside the document directory.
-          It is better to use absolute /image/ URLs.
-        </li>
-        <li>
-          <img src="icon-d.png" alt="Icon" />
-          <code>&lt;img src="icon-d.png"</code>
-          ... Relative to this document. There is no leading slash, so the various image
-          locations are not used at all.
-          The source file is found in the current directory src/documentation/content/xdocs/samples/
+          It is better to use absolute /image/ URLs or be very careful about using
+          such relative links (Forrest will not repart an error).
         </li>
+      <li>
+        <img src="/images/ellipse-2.png" alt="Icon" /><br />
+        <code>&lt;img src="/images/ellipse-2.png"</code>
+        ... Cocoon tried the various locations for a PNG image called
+        ellipse-2.png but did not find one anywhere. So the next sitemap match
+        looks for a corresponding
+        ellipse-2.svg and generates the PNG image on-the-fly.
+        The source file is found in src/documentation/resources/images/ directory.
+      </li>
 <!-- Remove this sample.
+  See: http://marc.theaimsgroup.com/?t=114925130200003
         <li>
           <img src="/icon-b.png" alt="Icon" />
           <code>&lt;img src="/icon-b.png"</code>
@@ -444,15 +450,36 @@
         </li>
 -->
       </ol>
-      <p>There is also SVG magic.</p>
-      <p>
-        <img src="/images/ellipse-2.png" alt="Icon" />
-        <code>&lt;img src="/images/ellipse-2.png"</code>
-        ... Cocoon tried the various locations for an image called
-        ellipse-2.png but did not find one anywhere. So it looked again for a corresponding
-        ellipse-2.svg and generated the PNG image on-the-fly.
-        The source file is found in src/documentation/resources/images/ directory.
+      <p>The image links shown above are handled by the resources.xmap using
+      special matches for the "images" directory in the URI.
       </p>
+      <p>The main/webapp/resources.xmap has another section to deal specifically with
PNG images. It looks first for an SVG source file which will be used to generate the PNG image.
If that is not found then it looks for an ASCII art source file. Then looks for a pre-prepared
PNG image.</p>
+      <ol>
+       <li>
+        <img src="ellipse.png" alt="Icon" /><br />
+        <code>&lt;img src="ellipse.png"</code>
+        ... Cocoon tried the various locations for a PNG image called
+        ellipse-2.png but did not find one anywhere. So the next sitemap match
+        looks for a corresponding
+        ellipse-2.svg and generates the PNG image on-the-fly.
+        The source file is found in src/documentation/resources/images/ directory.
+      </li>
+      <li>
+        <img src="cocoon-pyramid.png" alt="Icon"/><br />
+        <code>&lt;img src="cocoon-pryamid.png"</code>
+        ... ASCII Art. Cocoon did not find a PNG image, nor an SVG file.
+        So the next sitemap match looks for a corresponding
+        cocoon-pryamid.aart and generates the PNG image on-the-fly.
+        The source file is found in src/documentation/resources/images/ directory.
+        </li>
+        <li>
+          <img src="icon-d.png" alt="Icon" />
+          <code>&lt;img src="icon-d.png"</code>
+          ... Relative to this document. There is no leading slash, so the various image
+          locations are not used at all.
+          The source file is found in the current directory src/documentation/content/xdocs/samples/
+        </li>
+      </ol>
       <note>
         You might wonder why the above images all show correctly in dynamic
         'forrest run' mode, but some appear to be broken during static docs



Mime
View raw message