aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2007-09-25 23:23:03 +0100
committerRalph Amissah <ralph@amissah.com>2007-09-25 23:23:03 +0100
commita72e66db913de3a2e508080c8b1fc8d1342a899b (patch)
treef363583771edbb3646ef9360f87a26483575806e /data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml
parentmove generated output out of main package (diff)
remove generated output from main package
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml')
-rw-r--r--data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml467
1 files changed, 0 insertions, 467 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml
deleted file mode 100644
index 38260ae7..00000000
--- a/data/doc/manuals_generated/sisu_manual/sisu_configuration/scroll.xhtml
+++ /dev/null
@@ -1,467 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<?xml-stylesheet type="text/css" href="../_sisu/css/xhtml.css"?>
-<!-- Document processing information:
- * Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25)
- * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
- *
- * Last Generated on: Tue Sep 25 02:54:03 +0100 2007
- * SiSU http://www.jus.uio.no/sisu
--->
-
-<document>
-<head>
- <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
- <meta>Title:</meta>
- <title class="dc">
- SiSU - Configuration
- </title>
- <br />
- <meta>Creator:</meta>
- <creator class="dc">
- Ralph Amissah
- </creator>
- <br />
- <meta>Rights:</meta>
- <rights class="dc">
- Ralph Amissah
- </rights>
- <br />
- <meta>Type:</meta>
- <type class="dc">
- information
- </type>
- <br />
- <meta>Subject:</meta>
- <subject class="dc">
- ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
- </subject>
- <br />
- <meta>Date created:</meta>
- <date_created class="extra">
- 2002-08-28
- </date_created>
- <br />
- <meta>Date issued:</meta>
- <date_issued class="extra">
- 2002-08-28
- </date_issued>
- <br />
- <meta>Date available:</meta>
- <date_available class="extra">
- 2007-08-28
- </date_available>
- <br />
- <meta>Date modified:</meta>
- <date_modified class="extra">
- 2007-08-30
- </date_modified>
- <br />
- <meta>Date:</meta>
- <date class="dc">
- 2007-08-30
- </date>
- <br />
-</head>
-<body>
-<object id="1">
- <text class="h1">
- SiSU - Configuration,<br /> Ralph Amissah
- </text>
- <ocn>1</ocn>
-</object>
-<object id="2">
- <text class="h2">
- Configuration of Environment
- </text>
- <ocn>2</ocn>
-</object>
-<object id="3">
- <text class="h4">
- 1. Configuration
- </text>
- <ocn>3</ocn>
-</object>
-<object id="4">
- <text class="h5">
- 1.1 Determining the Current Configuration
- </text>
- <ocn>4</ocn>
-</object>
-<object id="5">
- <text class="norm">
- Information on the current configuration of <b>SiSU</b> should be
-available with the help command:
- </text>
- <ocn>5</ocn>
-</object>
-<object id="6">
- <text class="indent1">
- sisu -v
- </text>
- <ocn>6</ocn>
-</object>
-<object id="7">
- <text class="norm">
- which is an alias for:
- </text>
- <ocn>7</ocn>
-</object>
-<object id="8">
- <text class="indent1">
- sisu --help env
- </text>
- <ocn>8</ocn>
-</object>
-<object id="9">
- <text class="norm">
- Either of these should be executed from within a directory that
-contains sisu markup source documents.
- </text>
- <ocn>9</ocn>
-</object>
-<object id="10">
- <text class="h5">
- 1.2 Configuration files (config.yml)
- </text>
- <ocn>10</ocn>
-</object>
-<object id="11">
- <text class="norm">
- <b>SiSU</b> configration parameters are adjusted in the configuration
-file, which can be used to override the defaults set. This includes
-such things as which directory interim processing should be done in and
-where the generated output should be placed.
- </text>
- <ocn>11</ocn>
-</object>
-<object id="12">
- <text class="norm">
- The <b>SiSU</b> configuration file is a yaml file, which means
-indentation is significant.
- </text>
- <ocn>12</ocn>
-</object>
-<object id="13">
- <text class="norm">
- <b>SiSU</b> resource configuration is determined by looking at the
-following files if they exist:
- </text>
- <ocn>13</ocn>
-</object>
-<object id="14">
- <text class="indent1">
- ./_sisu/sisurc.yml
- </text>
- <ocn>14</ocn>
-</object>
-<object id="15">
- <text class="indent1">
- &#126;/.sisu/sisurc.yml
- </text>
- <ocn>15</ocn>
-</object>
-<object id="16">
- <text class="indent1">
- /etc/sisu/sisurc.yml
- </text>
- <ocn>16</ocn>
-</object>
-<object id="17">
- <text class="norm">
- The search is in the order listed, and the first one found is used.
- </text>
- <ocn>17</ocn>
-</object>
-<object id="18">
- <text class="norm">
- In the absence of instructions in any of these it falls back to the
-internal program defaults.
- </text>
- <ocn>18</ocn>
-</object>
-<object id="19">
- <text class="norm">
- Configuration determines the output and processing directories and the
-database access details.
- </text>
- <ocn>19</ocn>
-</object>
-<object id="20">
- <text class="norm">
- If <b>SiSU</b> is installed a sample sisurc.yml may be found in
-/etc/sisu/sisurc.yml
- </text>
- <ocn>20</ocn>
-</object>
-<object id="21">
- <text class="h2">
- Configuration of Documents
- </text>
- <ocn>21</ocn>
-</object>
-<object id="22">
- <text class="h4">
- 2. Skins
- </text>
- <ocn>22</ocn>
-</object>
-<object id="23">
- <text class="norm">
- Skins modify the default appearance of document output on a document,
-directory, or site wide basis. Skins are looked for in the following
-locations:
- </text>
- <ocn>23</ocn>
-</object>
-<object id="24">
- <text class="indent1">
- ./_sisu/skin
- </text>
- <ocn>24</ocn>
-</object>
-<object id="25">
- <text class="indent1">
- &#126;/.sisu/skin
- </text>
- <ocn>25</ocn>
-</object>
-<object id="26">
- <text class="indent1">
- /etc/sisu/skin
- </text>
- <ocn>26</ocn>
-</object>
-<object id="27">
- <text class="norm">
- <b>Within the skin directory</b> are the following the default
-sub-directories for document skins:
- </text>
- <ocn>27</ocn>
-</object>
-<object id="28">
- <text class="indent1">
- ./skin/doc
- </text>
- <ocn>28</ocn>
-</object>
-<object id="29">
- <text class="indent1">
- ./skin/dir
- </text>
- <ocn>29</ocn>
-</object>
-<object id="30">
- <text class="indent1">
- ./skin/site
- </text>
- <ocn>30</ocn>
-</object>
-<object id="31">
- <text class="norm">
- A skin is placed in the appropriate directory and the file named
-skin_[name].rb
- </text>
- <ocn>31</ocn>
-</object>
-<object id="32">
- <text class="norm">
- The skin itself is a ruby file which modifies the default appearances
-set in the program.
- </text>
- <ocn>32</ocn>
-</object>
-<object id="33">
- <text class="h5">
- 2.1 Document Skin
- </text>
- <ocn>33</ocn>
-</object>
-<object id="34">
- <text class="norm">
- Documents take on a document skin, if the header of the document
-specifies a skin to be used.
- </text>
- <ocn>34</ocn>
-</object>
-<object id="35">
- <ocn>35</ocn>
- <text class="code">
- &#160;&#160; &nbsp;&nbsp;@skin: skin_united_nations&#160;&#160;&#160;&#160;
- </text>
-</object>
-<object id="36">
- <text class="h5">
- 2.2 Directory Skin
- </text>
- <ocn>36</ocn>
-</object>
-<object id="37">
- <text class="norm">
- A directory may be mapped on to a particular skin, so all documents
-within that directory take on a particular appearance. If a skin exists
-in the skin/dir with the same name as the document directory, it will
-automatically be used for each of the documents in that directory,
-(except where a document specifies the use of another skin, in the
-skin/doc directory).
- </text>
- <ocn>37</ocn>
-</object>
-<object id="38">
- <text class="norm">
- A personal habit is to place all skins within the doc directory, and
-symbolic links as needed from the site, or dir directories as required.
- </text>
- <ocn>38</ocn>
-</object>
-<object id="39">
- <text class="h5">
- 2.3 Site Skin
- </text>
- <ocn>39</ocn>
-</object>
-<object id="40">
- <text class="norm">
- A site skin, modifies the program default skin.
- </text>
- <ocn>40</ocn>
-</object>
-<object id="41">
- <text class="h5">
- 2.4 Sample Skins
- </text>
- <ocn>41</ocn>
-</object>
-<object id="42">
- <text class="norm">
- With <b>SiSU</b> installed sample skins may be found in:
- </text>
- <ocn>42</ocn>
-</object>
-<object id="43">
- <text class="indent1">
- /etc/sisu/skin/doc and
-/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc
- </text>
- <ocn>43</ocn>
-</object>
-<object id="44">
- <text class="norm">
- (or equivalent directory) and if sisu-markup-samples is installed also
-under:
- </text>
- <ocn>44</ocn>
-</object>
-<object id="45">
- <text class="indent1">
- /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc
- </text>
- <ocn>45</ocn>
-</object>
-<object id="46">
- <text class="norm">
- Samples of list.yml and promo.yml (which are used to create the right
-column list) may be found in:
- </text>
- <ocn>46</ocn>
-</object>
-<object id="47">
- <text class="indent1">
- /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or
-equivalent directory)
- </text>
- <ocn>47</ocn>
-</object>
-<object id="48">
- <text class="h4">
- 3. Homepages
- </text>
- <ocn>48</ocn>
-</object>
-<object id="49">
- <text class="norm">
- <b>SiSU</b> is about the ability to auto-generate documents. Home pages
-are regarded as custom built items, and are not created by <b>SiSU</b>.
-More accurately, <b>SiSU</b> has a default home page, which will not be
-appropriate for use with other sites, and the means to provide your own
-home page instead in one of two ways as part of a site's configuration,
-these being:
- </text>
- <ocn>49</ocn>
-</object>
-<object id="50">
- <text class="norm">
- 1. through placing your home page and other custom built documents in
-the subdirectory _sisu/home/ (this probably being the easier and more
-convenient option)
- </text>
- <ocn>50</ocn>
-</object>
-<object id="51">
- <text class="norm">
- 2. through providing what you want as the home page in a skin,
- </text>
- <ocn>51</ocn>
-</object>
-<object id="52">
- <text class="norm">
- Document sets are contained in directories, usually organised by site
-or subject. Each directory can/should have its own homepage. See the
-section on directory structure and organisation of content.
- </text>
- <ocn>52</ocn>
-</object>
-<object id="53">
- <text class="h5">
- 3.1 Home page and other custom built pages in a sub-directory
- </text>
- <ocn>53</ocn>
-</object>
-<object id="54">
- <text class="norm">
- Custom built pages, including the home page index.html may be placed
-within the configuration directory _sisu/home/ in any of the locations
-that is searched for the configuration directory, namely ./_sisu;
-&#126;/_sisu; /etc/sisu From there they are copied to the root of the
-output directory with the command:
- </text>
- <ocn>54</ocn>
-</object>
-<object id="55">
- <text class="indent1">
- sisu -CC
- </text>
- <ocn>55</ocn>
-</object>
-<object id="56">
- <text class="h5">
- 3.2 Home page within a skin
- </text>
- <ocn>56</ocn>
-</object>
-<object id="57">
- <text class="norm">
- Skins are described in a separate section, but basically are a file
-written in the programming language <b>Ruby</b> that may be provided to
-change the defaults that are provided with sisu with respect to
-individual documents, a directories contents or for a site.
- </text>
- <ocn>57</ocn>
-</object>
-<object id="58">
- <text class="norm">
- If you wish to provide a homepage within a skin the skin should be in
-the directory _sisu/skin/dir and have the name of the directory for
-which it is to become the home page. Documents in the directory
-commercial_law would have the homepage modified in skin_commercial
-law.rb; or the directory poems in skin_poems.rb
- </text>
- <ocn>58</ocn>
-</object>
-<object id="59">
- <ocn>59</ocn>
- <text class="code">
- &#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;class Home<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;def homepage<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;# place the html content of your homepage here, this will become index.html<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;&lt;HOME &lt;html&gt;<br />&#160;&#160; &nbsp;&nbsp;&lt;head&gt;&lt;/head&gt;<br />&#160;&#160; &nbsp;&nbsp;&lt;doc&gt;<br />&#160;&#160; &nbsp;&nbsp;&lt;p&gt;this is my new homepage.&lt;/p&gt;<br />&#160;&#160; &nbsp;&nbsp;&lt;/doc&gt;<br />&#160;&#160; &nbsp;&nbsp;&lt;/html&gt;<br />&#160;&#160; &nbsp;&nbsp;HOME<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;end<br />&#160;&#160; &nbsp;&nbsp;&nbsp;&nbsp;end&#160;&#160;&#160;&#160;
- </text>
-</object>
-</body>
-</document>