Initial version of forrest site for kiss crawler.

[utils] / crawler / kiss / docs / content / xdocs / samples / static.xml
diff --git a/crawler/kiss/docs/content/xdocs/samples/static.xml b/crawler/kiss/docs/content/xdocs/samples/static.xml

new file mode 100644 (file)

index 0000000..9553525
--- /dev/null
+++ b/crawler/kiss/docs/content/xdocs/samples/static.xml
@@ -0,0 +1,62 @@
+<?xml version="1.0"?>
+<!--
+  Copyright 2002-2004 The Apache Software Foundation or its licensors,
+  as applicable.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+<document> 
+  <header> 
+    <title>Static content - including raw un-processed files and documents</title> 
+  </header> 
+  <body> 
+    <section>
+      <title>Linking to static content</title>
+      <p>
+        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>
+        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 by
+        Forrest, that is they will be linked to as raw files.</p>
+        
+      <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>
+    </section>
+  </body>
+</document>