diff options
| author | Ralph Amissah <ralph@amissah.com> | 2007-09-23 05:16:21 +0100 |
|---|---|---|
| committer | Ralph Amissah <ralph@amissah.com> | 2007-09-23 05:16:21 +0100 |
| commit | 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 (patch) | |
| tree | 100c62d678f009139999bf77c26c81653a721eeb /data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml | |
| parent | sisu-0.58.3 + md5s (diff) | |
primarily todo with sisu documentation, changelog reproduced below:
* start documenting sisu using sisu
* sisu markup source files in
data/doc/sisu/sisu_markup_samples/sisu_manual/
/usr/share/doc/sisu/sisu_markup_samples/sisu_manual/
* default output [sisu -3] in
data/doc/manuals_generated/sisu_manual/
/usr/share/doc/manuals_generated/sisu_manual/
(adds substantially to the size of sisu package!)
* help related edits
* manpage, work on ability to generate manpages, improved
* param, exclude footnote mark count when occurs within code block
* plaintext changes made
* shared_txt, line wrap visited
* file:// link option introduced (in addition to existing https?:// and
ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and
hub]
* minor adjustments
* html url match refinement
* css added tiny_center
* plaintext
* endnotes fix
* footnote adjustment to make more easily distinguishable from substantive
text
* flag -a only [flags -A -e -E dropped]
controlled by modifiers --unix/msdos --footnote/endnote
* defaults, homepage
* renamed homepage (instead of index) implications for modifying skins,
which need likewise to have any homepage entry renamed
* added link to sisu_manual in homepage
* css the css for the default homepage is renamed homepage.css (instead of
index.css) [consider removing this and relying on html.css]
* ruby version < ruby1.9
* place stop on installation and working with for now [ruby String.strip
broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux],
2007-09-18:38/2]
* debian/control restrict use to ruby > 1.8.4 and ruby < 1.9
* debian
* debian/control restrict use to ruby > 1.8.4 and ruby < 1.9
* sisu-doc new sub-package for sisu documentation
debian/control and sisu-doc.install
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml')
| -rw-r--r-- | data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml | 466 |
1 files changed, 466 insertions, 0 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml new file mode 100644 index 00000000..3da1a79b --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_configuration/sax.xml @@ -0,0 +1,466 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<?xml-stylesheet type="text/css" href="../_sisu/css/sax.css"?> +<!-- Document processing information: + * Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) + * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] + * + * Last Generated on: Sun Sep 23 04:12:04 +0100 2007 + * SiSU http://www.jus.uio.no/sisu +--> + +<document> +<head> + <meta>Title:</meta> + <title class="dc"> + SiSU - Configuration [0.58] + </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"> + <ocn>1</ocn> + <text class="h1"> + SiSU - Configuration [0.58],<br /> Ralph Amissah + </text> +</object> +<object id="2"> + <ocn>2</ocn> + <text class="h2"> + Configuration of Environment + </text> +</object> +<object id="3"> + <ocn>3</ocn> + <text class="h4"> + 1. Configuration + </text> +</object> +<object id="4"> + <ocn>4</ocn> + <text class="h5"> + 1.1 Determining the Current Configuration + </text> +</object> +<object id="5"> + <ocn>5</ocn> + <text class="norm"> + Information on the current configuration of <b>SiSU</b> should be +available with the help command: + </text> +</object> +<object id="6"> + <ocn>6</ocn> + <text class="indent1"> + sisu -v + </text> +</object> +<object id="7"> + <ocn>7</ocn> + <text class="norm"> + which is an alias for: + </text> +</object> +<object id="8"> + <ocn>8</ocn> + <text class="indent1"> + sisu --help env + </text> +</object> +<object id="9"> + <ocn>9</ocn> + <text class="norm"> + Either of these should be executed from within a directory that +contains sisu markup source documents. + </text> +</object> +<object id="10"> + <ocn>10</ocn> + <text class="h5"> + 1.2 Configuration files (config.yml) + </text> +</object> +<object id="11"> + <ocn>11</ocn> + <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> +</object> +<object id="12"> + <ocn>12</ocn> + <text class="norm"> + The <b>SiSU</b> configuration file is a yaml file, which means +indentation is significant. + </text> +</object> +<object id="13"> + <ocn>13</ocn> + <text class="norm"> + <b>SiSU</b> resource configuration is determined by looking at the +following files if they exist: + </text> +</object> +<object id="14"> + <ocn>14</ocn> + <text class="indent1"> + ./_sisu/sisurc.yml + </text> +</object> +<object id="15"> + <ocn>15</ocn> + <text class="indent1"> + ~/.sisu/sisurc.yml + </text> +</object> +<object id="16"> + <ocn>16</ocn> + <text class="indent1"> + /etc/sisu/sisurc.yml + </text> +</object> +<object id="17"> + <ocn>17</ocn> + <text class="norm"> + The search is in the order listed, and the first one found is used. + </text> +</object> +<object id="18"> + <ocn>18</ocn> + <text class="norm"> + In the absence of instructions in any of these it falls back to the +internal program defaults. + </text> +</object> +<object id="19"> + <ocn>19</ocn> + <text class="norm"> + Configuration determines the output and processing directories and the +database access details. + </text> +</object> +<object id="20"> + <ocn>20</ocn> + <text class="norm"> + If <b>SiSU</b> is installed a sample sisurc.yml may be found in +/etc/sisu/sisurc.yml + </text> +</object> +<object id="21"> + <ocn>21</ocn> + <text class="h2"> + Configuration of Documents + </text> +</object> +<object id="22"> + <ocn>22</ocn> + <text class="h4"> + 2. Skins + </text> +</object> +<object id="23"> + <ocn>23</ocn> + <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> +</object> +<object id="24"> + <ocn>24</ocn> + <text class="indent1"> + ./_sisu/skin + </text> +</object> +<object id="25"> + <ocn>25</ocn> + <text class="indent1"> + ~/.sisu/skin + </text> +</object> +<object id="26"> + <ocn>26</ocn> + <text class="indent1"> + /etc/sisu/skin + </text> +</object> +<object id="27"> + <ocn>27</ocn> + <text class="norm"> + <b>Within the skin directory</b> are the following the default +sub-directories for document skins: + </text> +</object> +<object id="28"> + <ocn>28</ocn> + <text class="indent1"> + ./skin/doc + </text> +</object> +<object id="29"> + <ocn>29</ocn> + <text class="indent1"> + ./skin/dir + </text> +</object> +<object id="30"> + <ocn>30</ocn> + <text class="indent1"> + ./skin/site + </text> +</object> +<object id="31"> + <ocn>31</ocn> + <text class="norm"> + A skin is placed in the appropriate directory and the file named +skin_[name].rb + </text> +</object> +<object id="32"> + <ocn>32</ocn> + <text class="norm"> + The skin itself is a ruby file which modifies the default appearances +set in the program. + </text> +</object> +<object id="33"> + <ocn>33</ocn> + <text class="h5"> + 2.1 Document Skin + </text> +</object> +<object id="34"> + <ocn>34</ocn> + <text class="norm"> + Documents take on a document skin, if the header of the document +specifies a skin to be used. + </text> +</object> +<object id="35"> + <ocn>35</ocn> + <text class="code"> +    @skin: skin_united_nations     + </text> +</object> +<object id="36"> + <ocn>36</ocn> + <text class="h5"> + 2.2 Directory Skin + </text> +</object> +<object id="37"> + <ocn>37</ocn> + <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> +</object> +<object id="38"> + <ocn>38</ocn> + <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> +</object> +<object id="39"> + <ocn>39</ocn> + <text class="h5"> + 2.3 Site Skin + </text> +</object> +<object id="40"> + <ocn>40</ocn> + <text class="norm"> + A site skin, modifies the program default skin. + </text> +</object> +<object id="41"> + <ocn>41</ocn> + <text class="h5"> + 2.4 Sample Skins + </text> +</object> +<object id="42"> + <ocn>42</ocn> + <text class="norm"> + With <b>SiSU</b> installed sample skins may be found in: + </text> +</object> +<object id="43"> + <ocn>43</ocn> + <text class="indent1"> + /etc/sisu/skin/doc and +/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc + </text> +</object> +<object id="44"> + <ocn>44</ocn> + <text class="norm"> + (or equivalent directory) and if sisu-markup-samples is installed also +under: + </text> +</object> +<object id="45"> + <ocn>45</ocn> + <text class="indent1"> + /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc + </text> +</object> +<object id="46"> + <ocn>46</ocn> + <text class="norm"> + Samples of list.yml and promo.yml (which are used to create the right +column list) may be found in: + </text> +</object> +<object id="47"> + <ocn>47</ocn> + <text class="indent1"> + /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or +equivalent directory) + </text> +</object> +<object id="48"> + <ocn>48</ocn> + <text class="h4"> + 3. Homepages + </text> +</object> +<object id="49"> + <ocn>49</ocn> + <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> +</object> +<object id="50"> + <ocn>50</ocn> + <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> +</object> +<object id="51"> + <ocn>51</ocn> + <text class="norm"> + 2. through providing what you want as the home page in a skin, + </text> +</object> +<object id="52"> + <ocn>52</ocn> + <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> +</object> +<object id="53"> + <ocn>53</ocn> + <text class="h5"> + 3.1 Home page and other custom built pages in a sub-directory + </text> +</object> +<object id="54"> + <ocn>54</ocn> + <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; +~/_sisu; /etc/sisu From there they are copied to the root of the +output directory with the command: + </text> +</object> +<object id="55"> + <ocn>55</ocn> + <text class="indent1"> + sisu -CC + </text> +</object> +<object id="56"> + <ocn>56</ocn> + <text class="h5"> + 3.2 Home page within a skin + </text> +</object> +<object id="57"> + <ocn>57</ocn> + <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> +</object> +<object id="58"> + <ocn>58</ocn> + <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> +</object> +<object id="59"> + <ocn>59</ocn> + <text class="code"> +    class Home<br />   def homepage<br />   # place the html content of your homepage here, this will become index.html<br />   <<HOME <html><br />   <head></head><br />   <doc><br />   <p>this is my new homepage.</p><br />   </doc><br />   </html><br />   HOME<br />   end<br />   end     + </text> +</object> +</body> +</document> |