wamblee.org Git - utils/blob

   1 <?xml version="1.0"?>
   2 <!--
   3   Copyright 2002-2004 The Apache Software Foundation or its licensors,
   4   as applicable.
   5
   6   Licensed under the Apache License, Version 2.0 (the "License");
   7   you may not use this file except in compliance with the License.
   8   You may obtain a copy of the License at
   9
  10       http://www.apache.org/licenses/LICENSE-2.0
  11
  12   Unless required by applicable law or agreed to in writing, software
  13   distributed under the License is distributed on an "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15   See the License for the specific language governing permissions and
  16   limitations under the License.
  17 -->
  18 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
  19 <document>
  20   <header>
  21     <title>Static content - including raw un-processed files and documents</title>
  22   </header>
  23   <body>
  24     <section>
  25       <title>Linking to static content</title>
  26       <p>
  27         You can place some types of raw content into the xdocs directory. For example,
  28         you can place a PDF file in <code>src/documentation/content/xdocs</code> and link
  29         to it normally,
  30         <strong>&lt;a href="../hello.pdf"&gt;</strong><a href="../hello.pdf">hello.pdf</a><strong>&lt;/a&gt;</strong>
  31         However, note that if the file is one that Forrest is able to process, for example
  32         an HTML file, these files will be processed accordingly.</p>
  33
  34       <p>
  35         It is also worth noting that files in the xdocs directory will only be copied
  36         into your final site if there is a link to them somewhere in the site. See the next
  37         section for details of how to include content that is not linked.</p>
  38
  39       <p>
  40         For more information see the
  41         <a href="site:linking">Linking demonstration</a>.</p>
  42     </section>
  43
  44     <section>
  45       <title>Including Static Content that is Not Linked</title>
  46
  47       <p>
  48         You can include raw HTML, PDFs, plain-text, and other files. In your final site by
  49         placing them in the <code>src/documentation/content</code> directory. Files in this
  50         directory will be copied over automatically but will not be processed in any way by
  51         Forrest, that is they will be linked to as raw files.</p>
  52
  53       <p>
  54         You can also have sub-directories such as
  55         <code>src/documentation/content/samples/subdir/</code> which
  56         reflects your main
  57         <code>xdocs/</code> tree. The raw files will then end up
  58         beside your documents.
  59       </p>
  60     </section>
  61   </body>
  62 </document>