forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r178279 - in /forrest/trunk/main/fresh-site/src/documentation/content/xdocs: samples/static.xml test1.html test2.html
Date Tue, 24 May 2005 20:51:48 GMT
Author: rgardler
Date: Tue May 24 13:51:47 2005
New Revision: 178279

Update info on raw file linking (FOR-470)


Modified: forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/static.xml
--- forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/static.xml (original)
+++ forrest/trunk/main/fresh-site/src/documentation/content/xdocs/samples/static.xml Tue May
24 13:51:47 2005
@@ -24,25 +24,37 @@
       <title>Linking to static content</title>
-        You can include raw HTML, PDFs, plain-text, and other files.
-        They are included in the Forrest-built site, by placing them in the
-        <code>src/documentation/content/</code> directory and
-        they will be copied over automatically. You can link to them as
-        normal, e.g.
-        <strong>&lt;a href="test3.html"&gt;</strong><a href="test3.html">test3.html</a><strong>&lt;/a&gt;</strong>
-        and
+        You can place some types of raw content into the xdocs directory. For example,
+        you can place a PDF file in <code>src/documentation/content/xdocs</code>
and link
+        to it normally, 
         <strong>&lt;a href="../hello.pdf"&gt;</strong><a href="../hello.pdf">hello.pdf</a><strong>&lt;/a&gt;</strong>
-      </p>
+        However, note that if the file is one that Forrest is able to process, for example
+        an HTML file, these files will be processed accordingly.</p>
+      <p>
+        It is also worth noting that files in the xdocs directory will only be copied 
+        into your final site if there is a link to them somewhere in the site. See the next
+        section for details of how to include content that is not linked.</p>
+      <p>
+        For more information see the
+        <a href="site:linking">Linking demonstration</a>.</p>
+    </section>
+    <section>
+      <title>Including Static Content that is Not Linked</title>
+      <p>
+        You can include raw HTML, PDFs, plain-text, and other files. In your final site by
+        placing them in the <code>src/documentation/content</code> directory.
Files in this
+        directory will be copied over automatically but will not be processed in any way
+        Forrest, that is they will be linked to as raw files.</p>
         You can also have sub-directories such as 
         <code>src/documentation/content/samples/subdir/</code> which
         reflects your main
         <code>xdocs/</code> tree. The raw files will then end up
         beside your documents.
-      </p>
-      <p>
-        More information in the
-        <a href="site:linking">Linking demonstration</a>.

View raw message