diff options
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_filetypes/scroll.xhtml')
| -rw-r--r-- | data/doc/manuals_generated/sisu_manual/sisu_filetypes/scroll.xhtml | 529 |
1 files changed, 529 insertions, 0 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_filetypes/scroll.xhtml b/data/doc/manuals_generated/sisu_manual/sisu_filetypes/scroll.xhtml new file mode 100644 index 00000000..2f4605e6 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_filetypes/scroll.xhtml @@ -0,0 +1,529 @@ +<?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.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:18 +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 - Filetypes [0.58] + </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"> + 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"> + 2002-08-28 + </date_available> + <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"> + <text class="h1"> + SiSU - Filetypes [0.58],<br /> Ralph Amissah + </text> + <ocn>1</ocn> +</object> +<object id="2"> + <text class="h4"> + 1. SiSU filetypes + </text> + <ocn>2</ocn> +</object> +<object id="3"> + <text class="norm"> + <b>SiSU</b> has plaintext and binary filetypes, and can process either +type of document. + </text> + <ocn>3</ocn> +</object> +<object id="4"> + <text class="h5"> + 1.1 .sst .ssm .ssi marked up plain text + </text> + <ocn>4</ocn> +</object> +<object id="5"> + <text class="norm"> + <b>SiSU</b> documents are prepared as plain-text (utf-8) files with +<b>SiSU</b> markup. They may make reference to and contain images (for +example), which are stored in the directory beneath them _sisu/image. +<b>SiSU</b> plaintext markup files are of three types that may be +distinguished by the file extension used: regular text .sst; master +documents, composite documents that incorporate other text, which can +be any regular text or text insert; and inserts the contents of which +are like regular text except these are marked .ssi and are not +processed. + </text> + <ocn>5</ocn> +</object> +<object id="6"> + <text class="norm"> + <b>SiSU</b> processing can be done directly against a sisu documents; +which may be located locally or on a remote server for which a url is +provided. + </text> + <ocn>6</ocn> +</object> +<object id="7"> + <text class="norm"> + <b>SiSU</b> source markup can be shared with the command: + </text> + <ocn>7</ocn> +</object> +<object id="8"> + <text class="indent1"> + sisu -s [filename] + </text> + <ocn>8</ocn> +</object> +<object id="9"> + <text class="h6"> + 1.1.1 sisu text - regular files (.sst) + </text> + <ocn>9</ocn> +</object> +<object id="10"> + <text class="norm"> + The most common form of document in <b>SiSU</b>, see the section on +<b>SiSU</b> markup. + </text> + <ocn>10</ocn> +</object> +<object id="11"> + <text class="norm"> + <<link xmlns:xlink="http://www.w3.org/1999/xlink" +xlink:type="simple" +xlink:href="http://www.jus.uio.no/sisu/sisu_markup">http://www.jus.uio.no/sisu/sisu_markup</link>> + </text> + <ocn>11</ocn> +</object> +<object id="12"> + <text class="norm"> + <<link xmlns:xlink="http://www.w3.org/1999/xlink" +xlink:type="simple" +xlink:href="http://www.jus.uio.no/sisu/sisu_manual">http://www.jus.uio.no/sisu/sisu_manual</link>> + </text> + <ocn>12</ocn> +</object> +<object id="13"> + <text class="h6"> + 1.1.2 sisu master files (.ssm) + </text> + <ocn>13</ocn> +</object> +<object id="14"> + <text class="norm"> + Composite documents which incorporate other <b>SiSU</b> documents which +may be either regular <b>SiSU</b> text .sst which may be generated +independently, or inserts prepared solely for the purpose of being +incorporated into one or more master documents. + </text> + <ocn>14</ocn> +</object> +<object id="15"> + <text class="norm"> + The mechanism by which master files incorporate other documents is +described as one of the headings under under <b>SiSU</b> markup in the +<b>SiSU</b> manual. + </text> + <ocn>15</ocn> +</object> +<object id="16"> + <text class="norm"> + Note: Master documents may be prepared in a similar way to regular +documents, and processing will occur normally if a .sst file is renamed +.ssm without requiring any other documents; the .ssm marker flags that +the document may contain other documents. + </text> + <ocn>16</ocn> +</object> +<object id="17"> + <text class="norm"> + Note: a secondary file of the composite document is built prior to +processing with the same prefix and the suffix ._sst <en>1</en> + </text> + <endnote notenumber="1"> + 1. .ssc (for composite) is under consideration but ._sst makes clear +that this is not a regular file to be worked on, and thus less likely +that people will have "accidents", working on a .ssc file that is +overwritten by subsequent processing. It may be however that when the +resulting file is shared .ssc is an appropriate suffix to use. + </endnote> + <ocn>17</ocn> +</object> +<object id="18"> + <text class="norm"> + <<link xmlns:xlink="http://www.w3.org/1999/xlink" +xlink:type="simple" +xlink:href="http://www.jus.uio.no/sisu/sisu_markup">http://www.jus.uio.no/sisu/sisu_markup</link>> + </text> + <ocn>18</ocn> +</object> +<object id="19"> + <text class="norm"> + <<link xmlns:xlink="http://www.w3.org/1999/xlink" +xlink:type="simple" +xlink:href="http://www.jus.uio.no/sisu/sisu_manual">http://www.jus.uio.no/sisu/sisu_manual</link>> + </text> + <ocn>19</ocn> +</object> +<object id="20"> + <text class="h6"> + 1.1.3 sisu insert files (.ssi) + </text> + <ocn>20</ocn> +</object> +<object id="21"> + <text class="norm"> + Inserts are documents prepared solely for the purpose of being +incorporated into one or more master documents. They resemble regular +<b>SiSU</b> text files except they are ignored by the <b>SiSU</b> +processor. Making a file a .ssi file is a quick and convenient way of +flagging that it is not intended that the file should be processed on +its own. + </text> + <ocn>21</ocn> +</object> +<object id="22"> + <text class="h5"> + 1.2 sisupod, zipped binary container (sisupod.zip, .ssp) + </text> + <ocn>22</ocn> +</object> +<object id="23"> + <text class="norm"> + A sisupod is a zipped <b>SiSU</b> text file or set of <b>SiSU</b> text +files and any associated images that they contain (this will be +extended to include sound and multimedia-files) + </text> + <ocn>23</ocn> +</object> +<object id="24"> + <text class="norm"> + <b>SiSU</b> plaintext files rely on a recognised directory structure to +find contents such as images associated with documents, but all images +for example for all documents contained in a directory are located in +the sub-directory _sisu/image. Without the ability to create a sisupod +it can be inconvenient to manually identify all other files associated +with a document. A sisupod automatically bundles all associated files +with the document that is turned into a pod. + </text> + <ocn>24</ocn> +</object> +<object id="25"> + <text class="norm"> + The structure of the sisupod is such that it may for example contain a +single document and its associated images; a master document and its +associated documents and anything else; or the zipped contents of a +whole directory of prepared <b>SiSU</b> documents. + </text> + <ocn>25</ocn> +</object> +<object id="26"> + <text class="norm"> + The command to create a sisupod is: + </text> + <ocn>26</ocn> +</object> +<object id="27"> + <text class="indent1"> + sisu -S [filename] + </text> + <ocn>27</ocn> +</object> +<object id="28"> + <text class="norm"> + Alternatively, make a pod of the contents of a whole directory: + </text> + <ocn>28</ocn> +</object> +<object id="29"> + <text class="indent1"> + sisu -S + </text> + <ocn>29</ocn> +</object> +<object id="30"> + <text class="norm"> + <b>SiSU</b> processing can be done directly against a sisupod; which +may be located locally or on a remote server for which a url is +provided. + </text> + <ocn>30</ocn> +</object> +<object id="31"> + <text class="norm"> + <<link xmlns:xlink="http://www.w3.org/1999/xlink" +xlink:type="simple" +xlink:href="http://www.jus.uio.no/sisu/sisu_commands">http://www.jus.uio.no/sisu/sisu_commands</link>> + </text> + <ocn>31</ocn> +</object> +<object id="32"> + <text class="norm"> + <<link xmlns:xlink="http://www.w3.org/1999/xlink" +xlink:type="simple" +xlink:href="http://www.jus.uio.no/sisu/sisu_manual">http://www.jus.uio.no/sisu/sisu_manual</link>> + </text> + <ocn>32</ocn> +</object> +<object id="33"> + <text class="h4"> + 2. Experimental Alternative Input Representations + </text> + <ocn>33</ocn> +</object> +<object id="34"> + <text class="h5"> + 2.1 Alternative XML + </text> + <ocn>34</ocn> +</object> +<object id="35"> + <text class="norm"> + <b>SiSU</b> offers alternative XML input representations of documents +as a proof of concept, experimental feature. They are however not +strictly maintained, and incomplete and should be handled with care. + </text> + <ocn>35</ocn> +</object> +<object id="36"> + <text class="norm"> + <b>convert from sst to simple xml representations (sax, dom and +node):</b> + </text> + <ocn>36</ocn> +</object> +<object id="37"> + <text class="indent1"> + sisu --to-sax [filename/wildcard] or sisu --to-sxs +[filename/wildcard] + </text> + <ocn>37</ocn> +</object> +<object id="38"> + <text class="indent1"> + sisu --to-dom [filename/wildcard] or sisu --to-sxd +[filename/wildcard] + </text> + <ocn>38</ocn> +</object> +<object id="39"> + <text class="indent1"> + sisu --to-node [filename/wildcard] or sisu --to-sxn +[filename/wildcard] + </text> + <ocn>39</ocn> +</object> +<object id="40"> + <text class="norm"> + <b>convert to sst from any sisu xml representation (sax, dom and +node):</b> + </text> + <ocn>40</ocn> +</object> +<object id="41"> + <text class="indent1"> + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>41</ocn> +</object> +<object id="42"> + <text class="norm"> + or the same: + </text> + <ocn>42</ocn> +</object> +<object id="43"> + <text class="indent1"> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>43</ocn> +</object> +<object id="44"> + <text class="h6"> + 2.1.1 XML SAX representation + </text> + <ocn>44</ocn> +</object> +<object id="45"> + <text class="norm"> + To convert from sst to simple xml (sax) representation: + </text> + <ocn>45</ocn> +</object> +<object id="46"> + <text class="indent1"> + sisu --to-sax [filename/wildcard] or sisu --to-sxs +[filename/wildcard] + </text> + <ocn>46</ocn> +</object> +<object id="47"> + <text class="norm"> + To convert from any sisu xml representation back to sst + </text> + <ocn>47</ocn> +</object> +<object id="48"> + <text class="indent1"> + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>48</ocn> +</object> +<object id="49"> + <text class="norm"> + or the same: + </text> + <ocn>49</ocn> +</object> +<object id="50"> + <text class="indent1"> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>50</ocn> +</object> +<object id="51"> + <text class="h6"> + 2.1.2 XML DOM representation + </text> + <ocn>51</ocn> +</object> +<object id="52"> + <text class="norm"> + To convert from sst to simple xml (dom) representation: + </text> + <ocn>52</ocn> +</object> +<object id="53"> + <text class="indent1"> + sisu --to-dom [filename/wildcard] or sisu --to-sxd +[filename/wildcard] + </text> + <ocn>53</ocn> +</object> +<object id="54"> + <text class="norm"> + To convert from any sisu xml representation back to sst + </text> + <ocn>54</ocn> +</object> +<object id="55"> + <text class="indent1"> + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>55</ocn> +</object> +<object id="56"> + <text class="norm"> + or the same: + </text> + <ocn>56</ocn> +</object> +<object id="57"> + <text class="indent1"> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>57</ocn> +</object> +<object id="58"> + <text class="h6"> + 2.1.3 XML Node representation + </text> + <ocn>58</ocn> +</object> +<object id="59"> + <text class="norm"> + To convert from sst to simple xml (node) representation: + </text> + <ocn>59</ocn> +</object> +<object id="60"> + <text class="indent1"> + sisu --to-node [filename/wildcard] or sisu --to-sxn +[filename/wildcard] + </text> + <ocn>60</ocn> +</object> +<object id="61"> + <text class="norm"> + To convert from any sisu xml representation back to sst + </text> + <ocn>61</ocn> +</object> +<object id="62"> + <text class="indent1"> + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>62</ocn> +</object> +<object id="63"> + <text class="norm"> + or the same: + </text> + <ocn>63</ocn> +</object> +<object id="64"> + <text class="indent1"> + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + </text> + <ocn>64</ocn> +</object> +<object id="0"> + <text class="h4"> + Endnotes + </text> + <ocn>0</ocn> +</object> +</body> +</document> |