diff options
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml')
| -rw-r--r-- | data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml | 765 |
1 files changed, 0 insertions, 765 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml deleted file mode 100644 index 22662684..00000000 --- a/data/doc/manuals_generated/sisu_manual/sisu_quickstart/sax.xml +++ /dev/null @@ -1,765 +0,0 @@ -<?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.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:53:53 +0100 2007 - * SiSU http://www.jus.uio.no/sisu ---> - -<document> -<head> - <meta>Title:</meta> - <title class="dc"> - SiSU - Quickstart, installation and use - </title> - <br /> - <meta>Creator:</meta> - <creator class="dc"> - Ralph Amissah - </creator> - <br /> - <meta>Rights:</meta> - <rights class="dc"> - Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - </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"> - 2006-09-06 - </date_created> - <br /> - <meta>Date available:</meta> - <date_available class="extra"> - 2006-09-06 - </date_available> - <br /> - <meta>Date issued:</meta> - <date_issued class="extra"> - 2006-09-06 - </date_issued> - <br /> - <meta>Date modified:</meta> - <date_modified class="extra"> - 2007-09-16 - </date_modified> - <br /> - <meta>Date:</meta> - <date class="dc"> - 2007-09-16 - </date> - <br /> -</head> -<body> -<object id="1"> - <ocn>1</ocn> - <text class="h1"> - SiSU - Quickstart, installation and use,<br /> Ralph Amissah - </text> -</object> -<object id="2"> - <ocn>2</ocn> - <text class="h2"> - Quickstart - SiSU installation and use - </text> -</object> -<object id="3"> - <ocn>3</ocn> - <text class="h4"> - 1. Quickstart - Getting Started Howto - </text> -</object> -<object id="4"> - <ocn>4</ocn> - <text class="h5"> - 1.1 Installation - </text> -</object> -<object id="5"> - <ocn>5</ocn> - <text class="norm"> - Installation is currently most straightforward and tested on the -<b>Debian</b> platform, as there are packages for the installation of -sisu and all requirements for what it does. - </text> -</object> -<object id="6"> - <ocn>6</ocn> - <text class="h6"> - 1.1.1 Debian Installation - </text> -</object> -<object id="7"> - <ocn>7</ocn> - <text class="norm"> - <b>SiSU</b> is available directly from the <b>Debian</b> Sid and -testing archives (and possibly Ubuntu), assuming your -/etc/apt/sources.list is set accordingly: - </text> -</object> -<object id="8"> - <ocn>8</ocn> - <text class="code"> -    aptitude update<br />   aptitude install sisu-complete     - </text> -</object> -<object id="9"> - <ocn>9</ocn> - <text class="norm"> - The following /etc/apt/sources.list setting permits the download of -additional markup samples: - </text> -</object> -<object id="10"> - <ocn>10</ocn> - <text class="code"> -    #/etc/apt/sources.list<br /><br />   deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib<br />   deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib<br />   d     - </text> -</object> -<object id="11"> - <ocn>11</ocn> - <text class="norm"> - The aptitude commands become: - </text> -</object> -<object id="12"> - <ocn>12</ocn> - <text class="code"> -    aptitude update<br />   aptitude install sisu-complete sisu-markup-samples     - </text> -</object> -<object id="13"> - <ocn>13</ocn> - <text class="norm"> - If there are newer versions of <b>SiSU</b> upstream of the -<b>Debian</b> archives, they will be available by adding the following -to your /etc/apt/sources.list - </text> -</object> -<object id="14"> - <ocn>14</ocn> - <text class="code"> -    #/etc/apt/sources.list<br /><br />   deb http://www.jus.uio.no/sisu/archive unstable main non-free<br />   deb-src http://www.jus.uio.no/sisu/archive unstable main non-free     - </text> -</object> -<object id="15"> - <ocn>15</ocn> - <text class="norm"> - repeat the aptitude commands - </text> -</object> -<object id="16"> - <ocn>16</ocn> - <text class="code"> -    aptitude update<br />   aptitude install sisu-complete sisu-markup-samples     - </text> -</object> -<object id="17"> - <ocn>17</ocn> - <text class="norm"> - Note however that it is not necessary to install sisu-complete if not -all components of sisu are to be used. Installing just the package sisu -will provide basic functionality. - </text> -</object> -<object id="18"> - <ocn>18</ocn> - <text class="h6"> - 1.1.2 RPM Installation - </text> -</object> -<object id="19"> - <ocn>19</ocn> - <text class="norm"> - RPMs are provided though untested, they are prepared by running alien -against the source package, and against the debs. - </text> -</object> -<object id="20"> - <ocn>20</ocn> - <text class="norm"> - They may be downloaded from: - </text> -</object> -<object id="21"> - <ocn>21</ocn> - <text class="indent1"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/SiSU/download.html#rpm">http://www.jus.uio.no/sisu/SiSU/download.html#rpm</link>> - </text> -</object> -<object id="22"> - <ocn>22</ocn> - <text class="norm"> - as root type: - </text> -</object> -<object id="23"> - <ocn>23</ocn> - <text class="indent1"> - rpm -i [rpm package name] - </text> -</object> -<object id="24"> - <ocn>24</ocn> - <text class="h6"> - 1.1.3 Installation from source - </text> -</object> -<object id="25"> - <ocn>25</ocn> - <text class="norm"> - To install <b>SiSU</b> from source check information at: - </text> -</object> -<object id="26"> - <ocn>26</ocn> - <text class="indent1"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/SiSU/download.html#current">http://www.jus.uio.no/sisu/SiSU/download.html#current</link>> - </text> -</object> -<object id="27"> - <ocn>27</ocn> - <text class="indent_bullet"> - download the source package - </text> -</object> -<object id="28"> - <ocn>28</ocn> - <text class="indent_bullet"> - Unpack the source - </text> -</object> -<object id="29"> - <ocn>29</ocn> - <text class="norm"> - Two alternative modes of installation from source are provided, -setup.rb (by Minero Aoki) and a rant(by Stefan Lang) built install -file, in either case: the first steps are the same, download and unpack -the source file: - </text> -</object> -<object id="30"> - <ocn>30</ocn> - <text class="norm"> - For basic use <b>SiSU</b> is only dependent on the programming language -in which it is written <b>Ruby</b>, and <b>SiSU</b> will be able to -generate html, various XMLs, including ODF (and will also produce -LaTeX). Dependencies required for further actions, though it relies on -the installation of additional dependencies which the source tarball -does not take care of, for things like using a database (postgresql or -sqlite)<en>1</en> or converting LaTeX to pdf. - </text> - <endnote notenumber="1"> - <number>1</number> - <note> - There is nothing to stop MySQL support being added in future. - </note> - </endnote> -</object> -<object id="31"> - <ocn>31</ocn> - <text class="norm"> - <b>setup.rb</b> - </text> -</object> -<object id="32"> - <ocn>32</ocn> - <text class="norm"> - This is a standard ruby installer, using setup.rb is a three step -process. In the root directory of the unpacked <b>SiSU</b> as root -type: - </text> -</object> -<object id="33"> - <ocn>33</ocn> - <text class="code"> -    ruby setup.rb config <br />   ruby setup.rb setup <br />   #[and as root:]<br />   ruby setup.rb install     - </text> -</object> -<object id="34"> - <ocn>34</ocn> - <text class="norm"> - further information on setup.rb is available from: - </text> -</object> -<object id="35"> - <ocn>35</ocn> - <text class="indent1"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://i.loveruby.net/en/projects/setup/">http://i.loveruby.net/en/projects/setup/</link>> - </text> -</object> -<object id="36"> - <ocn>36</ocn> - <text class="indent1"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://i.loveruby.net/en/projects/setup/doc/usage.html">http://i.loveruby.net/en/projects/setup/doc/usage.html</link>> - </text> -</object> -<object id="37"> - <ocn>37</ocn> - <text class="norm"> - <b>"install"</b> - </text> -</object> -<object id="38"> - <ocn>38</ocn> - <text class="norm"> - The "install" file provided is an installer prepared using "rant". In -the root directory of the unpacked <b>SiSU</b> as root type: - </text> -</object> -<object id="39"> - <ocn>39</ocn> - <text class="indent1"> - ruby install base - </text> -</object> -<object id="40"> - <ocn>40</ocn> - <text class="norm"> - or for a more complete installation: - </text> -</object> -<object id="41"> - <ocn>41</ocn> - <text class="indent1"> - ruby install - </text> -</object> -<object id="42"> - <ocn>42</ocn> - <text class="norm"> - or - </text> -</object> -<object id="43"> - <ocn>43</ocn> - <text class="indent1"> - ruby install base - </text> -</object> -<object id="44"> - <ocn>44</ocn> - <text class="norm"> - This makes use of Rant (by Stefan Lang) and the provided Rantfile. It -has been configured to do post installation setup setup configuration -and generation of first test file. Note however, that additional -external package dependencies, such as tetex-extra are not taken care -of for you. - </text> -</object> -<object id="45"> - <ocn>45</ocn> - <text class="norm"> - Further information on "rant" is available from: - </text> -</object> -<object id="46"> - <ocn>46</ocn> - <text class="indent1"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://make.rubyforge.org/">http://make.rubyforge.org/</link>> - </text> -</object> -<object id="47"> - <ocn>47</ocn> - <text class="indent1"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://rubyforge.org/frs/?group_id=615">http://rubyforge.org/frs/?group_id=615</link>> - </text> -</object> -<object id="48"> - <ocn>48</ocn> - <text class="norm"> - For a list of alternative actions you may type: - </text> -</object> -<object id="49"> - <ocn>49</ocn> - <text class="indent1"> - ruby install help - </text> -</object> -<object id="50"> - <ocn>50</ocn> - <text class="indent1"> - ruby install -T - </text> -</object> -<object id="51"> - <ocn>51</ocn> - <text class="h5"> - 1.2 Testing SiSU, generating output - </text> -</object> -<object id="52"> - <ocn>52</ocn> - <text class="norm"> - To check which version of sisu is installed: - </text> -</object> -<object id="53"> - <ocn>53</ocn> - <text class="norm"> - sisu -v - </text> -</object> -<object id="54"> - <ocn>54</ocn> - <text class="norm"> - Depending on your mode of installation one or a number of markup sample -files may be found either in the directory: - </text> -</object> -<object id="55"> - <ocn>55</ocn> - <text class="norm"> - ... - </text> -</object> -<object id="56"> - <ocn>56</ocn> - <text class="norm"> - or - </text> -</object> -<object id="57"> - <ocn>57</ocn> - <text class="norm"> - ... - </text> -</object> -<object id="58"> - <ocn>58</ocn> - <text class="norm"> - change directory to the appropriate one: - </text> -</object> -<object id="59"> - <ocn>59</ocn> - <text class="norm"> - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg - </text> -</object> -<object id="60"> - <ocn>60</ocn> - <text class="h6"> - 1.2.1 basic text, plaintext, html, XML, ODF - </text> -</object> -<object id="61"> - <ocn>61</ocn> - <text class="norm"> - Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it - </text> -</object> -<object id="62"> - <ocn>62</ocn> - <text class="norm"> - sisu -NhwoabxXyv -free_as_in_freedom.rms_and_free_software.sam_williams.sst - </text> -</object> -<object id="63"> - <ocn>63</ocn> - <text class="norm"> - this will generate html including a concordance file, opendocument text -format, plaintext, XHTML and various forms of XML, and OpenDocument -text - </text> -</object> -<object id="64"> - <ocn>64</ocn> - <text class="h6"> - 1.2.2 LaTeX / pdf - </text> -</object> -<object id="65"> - <ocn>65</ocn> - <text class="norm"> - Assuming a LaTeX engine such as tetex or texlive is installed with the -required modules (done automatically on selection of sisu-pdf in -<b>Debian</b>) - </text> -</object> -<object id="66"> - <ocn>66</ocn> - <text class="norm"> - Having moved to the directory that contains the markup samples (see -instructions above if necessary), choose a file and run sisu against it - </text> -</object> -<object id="67"> - <ocn>67</ocn> - <text class="norm"> - sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst - </text> -</object> -<object id="68"> - <ocn>68</ocn> - <text class="norm"> - sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst - </text> -</object> -<object id="69"> - <ocn>69</ocn> - <text class="norm"> - should generate most available output formats: html including a -concordance file, opendocument text format, plaintext, XHTML and -various forms of XML, and OpenDocument text and pdf - </text> -</object> -<object id="70"> - <ocn>70</ocn> - <text class="h6"> - 1.2.3 relational database - postgresql, sqlite - </text> -</object> -<object id="71"> - <ocn>71</ocn> - <text class="norm"> - Relational databases need some setting up - you must have permission to -create the database and write to it when you run sisu. - </text> -</object> -<object id="72"> - <ocn>72</ocn> - <text class="norm"> - Assuming you have the database installed and the requisite permissions - </text> -</object> -<object id="73"> - <ocn>73</ocn> - <text class="norm"> - sisu --sqlite --recreate - </text> -</object> -<object id="74"> - <ocn>74</ocn> - <text class="norm"> - sisu --sqlite -v --import -free_as_in_freedom.rms_and_free_software.sam_williams.sst - </text> -</object> -<object id="75"> - <ocn>75</ocn> - <text class="norm"> - sisu --pgsql --recreate - </text> -</object> -<object id="76"> - <ocn>76</ocn> - <text class="norm"> - sisu --pgsql -v --import -free_as_in_freedom.rms_and_free_software.sam_williams.sst - </text> -</object> -<object id="77"> - <ocn>77</ocn> - <text class="h5"> - 1.3 Getting Help - </text> -</object> -<object id="78"> - <ocn>78</ocn> - <text class="h6"> - 1.3.1 The man pages - </text> -</object> -<object id="79"> - <ocn>79</ocn> - <text class="norm"> - Type: - </text> -</object> -<object id="80"> - <ocn>80</ocn> - <text class="indent1"> - man sisu - </text> -</object> -<object id="81"> - <ocn>81</ocn> - <text class="norm"> - The man pages are also available online, though not always kept as up -to date as within the package itself: - </text> -</object> -<object id="82"> - <ocn>82</ocn> - <text class="indent_bullet"> - <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/man/sisu.1"> sisu.1 </link> -<en>2</en> - </text> - <endnote notenumber="2"> - <number>2</number> - <note> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/man/sisu.1">http://www.jus.uio.no/sisu/man/sisu.1</link>> - </note> - </endnote> -</object> -<object id="83"> - <ocn>83</ocn> - <text class="indent_bullet"> - <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/man/sisu.8"> sisu.8 </link> -<en>3</en> - </text> - <endnote notenumber="3"> - <number>3</number> - <note> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/man/sisu.8">http://www.jus.uio.no/sisu/man/sisu.8</link>> - </note> - </endnote> -</object> -<object id="84"> - <ocn>84</ocn> - <text class="indent_bullet"> - <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/man"> man directory </link> -<en>4</en> - </text> - <endnote notenumber="4"> - <number>4</number> - <note> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/man">http://www.jus.uio.no/sisu/man</link>> - </note> - </endnote> -</object> -<object id="85"> - <ocn>85</ocn> - <text class="h6"> - 1.3.2 Built in help - </text> -</object> -<object id="86"> - <ocn>86</ocn> - <text class="norm"> - sisu --help - </text> -</object> -<object id="87"> - <ocn>87</ocn> - <text class="norm"> - sisu --help --env - </text> -</object> -<object id="88"> - <ocn>88</ocn> - <text class="norm"> - sisu --help --commands - </text> -</object> -<object id="89"> - <ocn>89</ocn> - <text class="norm"> - sisu --help --markup - </text> -</object> -<object id="90"> - <ocn>90</ocn> - <text class="h6"> - 1.3.3 The home page - </text> -</object> -<object id="91"> - <ocn>91</ocn> - <text class="norm"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu">http://www.jus.uio.no/sisu</link>> - </text> -</object> -<object id="92"> - <ocn>92</ocn> - <text class="norm"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/SiSU">http://www.jus.uio.no/sisu/SiSU</link>> - </text> -</object> -<object id="93"> - <ocn>93</ocn> - <text class="h5"> - 1.4 Markup Samples - </text> -</object> -<object id="94"> - <ocn>94</ocn> - <text class="norm"> - A number of markup samples (along with output) are available off: - </text> -</object> -<object id="95"> - <ocn>95</ocn> - <text class="norm"> - <<link xmlns:xlink="http://www.w3.org/1999/xlink" -xlink:type="simple" -xlink:href="http://www.jus.uio.no/sisu/SiSU/2.html">http://www.jus.uio.no/sisu/SiSU/2.html</link>> - </text> -</object> -<object id="96"> - <ocn>96</ocn> - <text class="norm"> - Additional markup samples are packaged separately in the file: - </text> -</object> -<object id="97"> - <ocn>97</ocn> - <text class="norm"> - <b>*</b> - </text> -</object> -<object id="98"> - <ocn>98</ocn> - <text class="norm"> - On <b>Debian</b> they are available in non-free<en>5</en> to include -them it is necessary to include non-free in your /etc/apt/source.list -or obtain them from the sisu home site. - </text> - <endnote notenumber="5"> - <number>5</number> - <note> - the <b>Debian</b> Free Software guidelines require that everything -distributed within <b>Debian</b> can be changed - and the documents are -authors' works that while freely distributable are not freely -changeable. - </note> - </endnote> -</object> -<object id="0"> - <ocn>0</ocn> - <text class="h4"> - Endnotes - </text> -</object> -</body> -</document> |