diff options
Diffstat (limited to 'data/doc/manuals_generated/sisu_manual/sisu_markup/dom.xml')
| -rw-r--r-- | data/doc/manuals_generated/sisu_manual/sisu_markup/dom.xml | 3138 |
1 files changed, 3138 insertions, 0 deletions
diff --git a/data/doc/manuals_generated/sisu_manual/sisu_markup/dom.xml b/data/doc/manuals_generated/sisu_manual/sisu_markup/dom.xml new file mode 100644 index 00000000..8dbe0f02 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_markup/dom.xml @@ -0,0 +1,3138 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<?xml-stylesheet type="text/css" href="../_sisu/css/dom.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:09 +0100 2007 + * SiSU http://www.jus.uio.no/sisu +--> + +<document> + +<head> + + <header> + <meta>Title:</meta> + <title> + SiSU - Markup [0.58] + </title> + </header> + + <header> + <meta>Creator:</meta> + <creator> + Ralph Amissah + </creator> + </header> + + <header> + <meta>Rights:</meta> + <rights> + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + </rights> + </header> + + <header> + <meta>Type:</meta> + <type> + information + </type> + </header> + + <header> + <meta>Subject:</meta> + <subject> + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + </subject> + </header> + + <header> + <meta>Date created:</meta> + <date_created> + 2002-08-28 + </date_created> + </header> + + <header> + <meta>Date issued:</meta> + <date_issued> + 2002-08-28 + </date_issued> + </header> + + <header> + <meta>Date available:</meta> + <date_available> + 2002-08-28 + </date_available> + </header> + + <header> + <meta>Date modified:</meta> + <date_modified> + 2007-09-16 + </date_modified> + </header> + + <header> + <meta>Date:</meta> + <date> + 2007-09-16 + </date> + </header> + + + + + + +</head> + +<body> + +<heading1> + <heading> + <object id="1"> + <ocn>1</ocn> + <text>SiSU - Markup [0.58],<br /> Ralph Amissah</text> + </object> + </heading> + + <heading2> + <heading> + <object id="2"> + <ocn>2</ocn> + <text>SiSU Markup</text> + </object> + </heading> + + <contents1> + <heading> + <object id="3"> + <ocn>3</ocn> + <nametag>markup</nametag> + + <text>1. Introduction to SiSU Markup<endnote><number>1</number><note>From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful.</note></endnote> </text> + </object> + </heading> + <content> + + </content> + + <contents2> + <heading> + <object id="4"> + <ocn>4</ocn> + <nametag>1.1</nametag> + + <text>1.1 Summary</text> + </object> + </heading> + <content> + + <object id="5"> + + + <ocn>5</ocn> + + + <text class="norm"><b>SiSU</b> source documents are plaintext (UTF-8)<endnote><number>2</number><note>files should be prepared using UTF-8 character encoding</note></endnote> files</text> + + </object> + + + <object id="6"> + + + <ocn>6</ocn> + + + <text class="norm">All paragraphs are separated by an empty line.</text> + + </object> + + + <object id="7"> + + + <ocn>7</ocn> + + + <text class="norm">Markup is comprised of:</text> + + </object> + + + <object id="8"> + + + <ocn>8</ocn> + + + <text class="indent_bullet"> at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down)</text> + + </object> + + + <object id="9"> + + + <ocn>9</ocn> + + + <text class="indent_bullet"> followed by the prepared substantive text of which the most important single characteristic is the markup of different heading levels, which define the primary outline of the document structure. Markup of substantive text includes:</text> + + </object> + + + <object id="10"> + + + <ocn>10</ocn> + + + <text class="indent_bullet1"> heading levels defines document structure</text> + + </object> + + + <object id="11"> + + + <ocn>11</ocn> + + + <text class="indent_bullet1"> text basic attributes, italics, bold etc.</text> + + </object> + + + <object id="12"> + + + <ocn>12</ocn> + + + <text class="indent_bullet1"> grouped text (objects), which are to be treated differently, such as code blocks or poems.</text> + + </object> + + + <object id="13"> + + + <ocn>13</ocn> + + + <text class="indent_bullet1"> footnotes/endnotes</text> + + </object> + + + <object id="14"> + + + <ocn>14</ocn> + + + <text class="indent_bullet1"> linked text and images</text> + + </object> + + + <object id="15"> + + + <ocn>15</ocn> + + + <text class="indent_bullet1"> paragraph actions, such as indent, bulleted, numbered-lists, etc.</text> + + </object> + + + <object id="16"> + + + <ocn>16</ocn> + + + <text class="norm">Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup</text> + + </object> + + + </content> + + </contents2> + + <contents2> + <heading> + <object id="17"> + <ocn>17</ocn> + <nametag>1.2</nametag> + + <text>1.2 Markup Examples</text> + </object> + </heading> + <content> + + </content> + + <contents3> + <heading> + <object id="18"> + <ocn>18</ocn> + <nametag>1.2.1</nametag> + + <text>1.2.1 Online</text> + </object> + </heading> + <content> + + <object id="19"> + + + <ocn>19</ocn> + + + <text class="norm">Online markup examples are available together with the respective outputs produced from <<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>> or from <<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_examples/">http://www.jus.uio.no/sisu/sisu_examples/</link>></text> + + </object> + + + <object id="20"> + + + <ocn>20</ocn> + + + <text class="norm">There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: <<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> + + </object> + + + <object id="21"> + + + <ocn>21</ocn> + + + <text class="norm">Some example marked up files are available as html with syntax highlighting for viewing: <<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sample/syntax">http://www.jus.uio.no/sisu/sample/syntax</link>></text> + + </object> + + + <object id="22"> + + + <ocn>22</ocn> + + + <text class="norm">an alternative presentation of markup syntax: <<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sample/on_markup.txt">http://www.jus.uio.no/sisu/sample/on_markup.txt</link>></text> + + </object> + + + </content> + + </contents3> + + <contents3> + <heading> + <object id="23"> + <ocn>23</ocn> + <nametag>1.2.2</nametag> + + <text>1.2.2 Installed</text> + </object> + </heading> + <content> + + <object id="24"> + + + <ocn>24</ocn> + + + <text class="norm">With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/sisu_markup_samples/non-free</text> + + </object> + + + </content> + + </contents3> + + </contents2> + + </contents1> + + <contents1> + <heading> + <object id="25"> + <ocn>25</ocn> + <nametag>headers</nametag> + + <text>2. Markup of Headers </text> + </object> + </heading> + <content> + + <object id="26"> + + + <ocn>26</ocn> + + + <text class="norm">Headers consist of semantic meta-data about a document, which can be used by any output module of the program; and may in addition include extra processing instructions.</text> + + </object> + + + <object id="27"> + + + <ocn>27</ocn> + + + <text class="norm">Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment:</text> + + </object> + + + <object id="28"> + + + <ocn>28</ocn> + + + <text class="code"> + +    % this would be a comment     + + </text> + + </object> + + + </content> + + <contents2> + <heading> + <object id="29"> + <ocn>29</ocn> + <nametag>2.1</nametag> + + <text>2.1 Sample Header</text> + </object> + </heading> + <content> + + <object id="30"> + + + <ocn>30</ocn> + + + <text class="norm">This current document has a header similar to this one (without the comments):</text> + + </object> + + + <object id="31"> + + + <ocn>31</ocn> + + + <text class="code"> + +    % SiSU 0.57<br /><br />   @title: SiSU<br /><br />   @subtitle: Markup [0.58]<br /><br />   @creator: Ralph Amissah<br /><br />   @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3<br /><br />   @type: information<br /><br />   @subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search<br /><br />   @date.created: 2002-08-28<br /><br />   @date.issued: 2002-08-28<br /><br />   @date.available: 2002-08-28<br /><br />   @date.modified: 2007-09-16<br /><br />   @date: 2007-09-16<br /><br />   @level: new=C; break=1; num_top=1<br /><br />   % comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population).<br /><br />   @skin: skin_sisu_manual<br /><br />   % skins modify the appearance of a document and are placed in a sub-directory under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site-wide. (A document is affected by a single skin)<br /><br />   @bold: /Gnu|Debian|Ruby|SiSU/<br /><br />   @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ <br />   { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html <br />   { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU <br />   { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ <br />   { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ <br />   { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html <br />   { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html <br />   { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html<br /> <br />     + + </text> + + </object> + + + </content> + + </contents2> + + <contents2> + <heading> + <object id="32"> + <ocn>32</ocn> + <nametag>2.2</nametag> + + <text>2.2 Available Headers</text> + </object> + </heading> + <content> + + <object id="33"> + + + <ocn>33</ocn> + + + <text class="norm">Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions take either the form @headername: or 0~headername. All Dublin Core meta tags are available</text> + + </object> + + + <object id="34"> + + + <ocn>34</ocn> + + + <text class="norm"><b>@indentifier:</b> information or instructions</text> + + </object> + + + <object id="35"> + + + <ocn>35</ocn> + + + <text class="norm">where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified</text> + + </object> + + + <object id="36"> + + + <ocn>36</ocn> + + + <text class="norm">Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know.</text> + + </object> + + + <object id="37"> + + + <ocn>37</ocn> + + + <text class="norm">This is a sample header</text> + + </object> + + + <object id="38"> + + + <ocn>38</ocn> + + + <text class="norm"><b>% SiSU 0.38</b> [declared file-type identifier with markup version]</text> + + </object> + + + <object id="39"> + + + <ocn>39</ocn> + + + <text class="norm"><b>@title:</b> [title text] This is the title of the document and used as such, this header is the only one that is <u>mandatory</u></text> + + </object> + + + <object id="40"> + + + <ocn>40</ocn> + + + <text class="norm"><b>@subtitle:</b> The Subtitle if any</text> + + </object> + + + <object id="41"> + + + <ocn>41</ocn> + + + <text class="norm"><b>@creator:</b> [or @author:] Name of Author</text> + + </object> + + + <object id="42"> + + + <ocn>42</ocn> + + + <text class="norm"><b>@subject:</b> (whatever your subject)</text> + + </object> + + + <object id="43"> + + + <ocn>43</ocn> + + + <text class="norm"><b>@description:</b></text> + + </object> + + + <object id="44"> + + + <ocn>44</ocn> + + + <text class="norm"><b>@publisher:</b></text> + + </object> + + + <object id="45"> + + + <ocn>45</ocn> + + + <text class="norm"><b>@contributor:</b></text> + + </object> + + + <object id="46"> + + + <ocn>46</ocn> + + + <text class="norm"><b>@translator:</b> [or @translated_by:]</text> + + </object> + + + <object id="47"> + + + <ocn>47</ocn> + + + <text class="norm"><b>@illustrator:</b> [or @illustrated_by:]</text> + + </object> + + + <object id="48"> + + + <ocn>48</ocn> + + + <text class="norm"><b>@prepared_by:</b> [or @digitized_by:]</text> + + </object> + + + <object id="49"> + + + <ocn>49</ocn> + + + <text class="norm"><b>@date: 2000-08-27</b> [ also @date.created: @date.issued: @date.available: @date.valid: @date.modified: ]</text> + + </object> + + + <object id="50"> + + + <ocn>50</ocn> + + + <text class="norm"><b>@type: article</b></text> + + </object> + + + <object id="51"> + + + <ocn>51</ocn> + + + <text class="norm"><b>@format:</b></text> + + </object> + + + <object id="52"> + + + <ocn>52</ocn> + + + <text class="norm"><b>@identifier:</b></text> + + </object> + + + <object id="53"> + + + <ocn>53</ocn> + + + <text class="norm"><b>@source:</b></text> + + </object> + + + <object id="54"> + + + <ocn>54</ocn> + + + <text class="norm"><b>@language:</b> [or @language.document:] [country code for language if available, or language, English, en is the default setting] (en - English, fr - French, de - German, it - Italian, es - Spanish, pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, is - Icelandic, nl - Dutch, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian, hr - Croatian, cs - Czech, bg - Bul garian ) [however, encodings are not available for all of the languages listed.]</text> + + </object> + + + <object id="55"> + + + <ocn>55</ocn> + + + <text class="norm">[@language.original: original language in which the work was published]</text> + + </object> + + + <object id="56"> + + + <ocn>56</ocn> + + + <text class="norm"><b>@papersize:</b> (A4|US_letter|book_B5|book_A5|US_legal)</text> + + </object> + + + <object id="57"> + + + <ocn>57</ocn> + + + <text class="norm"><b>@relation:</b></text> + + </object> + + + <object id="58"> + + + <ocn>58</ocn> + + + <text class="norm"><b>@coverage:</b></text> + + </object> + + + <object id="59"> + + + <ocn>59</ocn> + + + <text class="norm"><b>@rights:</b> Copyright (c) Name of Right Holder, all rights reserved, or as granted: public domain, copyleft, creative commons variant, etc.</text> + + </object> + + + <object id="60"> + + + <ocn>60</ocn> + + + <text class="norm"><b>@owner:</b></text> + + </object> + + + <object id="61"> + + + <ocn>61</ocn> + + + <text class="norm"><b>@keywords:</b> text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches]</text> + + </object> + + + <object id="62"> + + + <ocn>62</ocn> + + + <text class="norm"><b>@abstract:</b> [paper abstract, placed after table of contents]</text> + + </object> + + + <object id="63"> + + + <ocn>63</ocn> + + + <text class="norm"><b>@comment:</b> [...]</text> + + </object> + + + <object id="64"> + + + <ocn>64</ocn> + + + <text class="norm"><b>@catalogue:</b> loc=[Library of Congress classification]; dewey=[Dewey classification]; isbn=[ISBN]; pg=[Project Gutenberg text number]</text> + + </object> + + + <object id="65"> + + + <ocn>65</ocn> + + + <text class="norm"><b>@classify_loc:</b> [Library of Congress classification]</text> + + </object> + + + <object id="66"> + + + <ocn>66</ocn> + + + <text class="norm"><b>@classify_dewey:</b> [Dewey classification]</text> + + </object> + + + <object id="67"> + + + <ocn>67</ocn> + + + <text class="norm"><b>@classify_isbn:</b> [ISBN]</text> + + </object> + + + <object id="68"> + + + <ocn>68</ocn> + + + <text class="norm"><b>@classify_pg:</b> [Project Gutenberg text number]</text> + + </object> + + + <object id="69"> + + + <ocn>69</ocn> + + + <text class="norm"><b>@prefix:</b> [prefix is placed just after table of contents]</text> + + </object> + + + <object id="70"> + + + <ocn>70</ocn> + + + <text class="norm"><b>@prefix_a:</b> [prefix is placed just before table of contents - not implemented]</text> + + </object> + + + <object id="71"> + + + <ocn>71</ocn> + + + <text class="norm"><b>@prefix_b:</b></text> + + </object> + + + <object id="72"> + + + <ocn>72</ocn> + + + <text class="norm"><b>@rcs:</b> $Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to a document ]</text> + + </object> + + + <object id="73"> + + + <ocn>73</ocn> + + + <text class="norm"><b>@structure:</b> PART; CHAPTER; SECTION; ARTICLE; none; none;<br /> optional, document structure can be defined by words to match or regular expression (the regular expression is assumed to start at the beginning of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used within text instead, without this header tag, and may be used to supplement the instructions provided in this header tag if provided (@structure: is a synonym for @toc:)</text> + + </object> + + + <object id="74"> + + + <ocn>74</ocn> + + + <text class="norm"><b>@level:</b> newpage=3; breakpage=4<br /> [paragraph level, used by latex to breakpages, the page is optional eg. in newpage]</text> + + </object> + + + <object id="75"> + + + <ocn>75</ocn> + + + <text class="norm"><b>@markup:</b> information on the markup used, e.g. new=1,2,3; break=4; num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage, heading level, used by LaTeX to breakpages. breakpage: starts on a new page in single column text and on a new column in double column text; newpage: starts on a new page for both single and double column texts.<br /> num_top=4 [auto-number document, starting at level 4. the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level]<br /> num_extract [take numbering of headings provided (manually in marked up source document), and use for numbering of segments. Available where a clear numbering structure is provided within document, without the repetition of a number in a header.] [In 0.38 notation, you would map to the equivalent levels, the examples provided would map to the following new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] see headings]</text> + + </object> + + + <object id="76"> + + + <ocn>76</ocn> + + + <text class="norm"><b>@bold:</b> [regular expression of words/phrases to be made bold]</text> + + </object> + + + <object id="77"> + + + <ocn>77</ocn> + + + <text class="norm"><b>@italics:</b> [regular expression of words/phrases to italicise]</text> + + </object> + + + <object id="78"> + + + <ocn>78</ocn> + + + <text class="norm"><b>@vocabulary:</b> name of taxonomy/vocabulary/wordlist to use against document</text> + + </object> + + + <object id="79"> + + + <ocn>79</ocn> + + + <text class="norm"><b>@skin:</b> skin_doc_[name_of_desired_document_skin]<br /> skins change default settings related to the appearance of documents generated, such as the urls of the home site, and the icon/logo for the document or site.</text> + + </object> + + + <object id="80"> + + + <ocn>80</ocn> + + + <text class="norm"><b>@links:</b> { <b>SiSU</b> }http://www.jus.uio.no/sisu/;<br /> { FSF }http://www.fsf.org</text> + + </object> + + + <object id="81"> + + + <ocn>81</ocn> + + + <text class="norm"><b>@promo:</b> sisu, ruby, search_libre_docs, open_society<br /> [places content in right pane in html, makes use of list.yml and promo.yml, commented out sample in document sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]</text> + + </object> + + + </content> + + </contents2> + + </contents1> + + <contents1> + <heading> + <object id="82"> + <ocn>82</ocn> + <nametag>3</nametag> + + <text>3. Markup of Substantive Text</text> + </object> + </heading> + <content> + + </content> + + <contents2> + <heading> + <object id="83"> + <ocn>83</ocn> + <nametag>heading_levels</nametag> + + <text>3.1 Heading Levels </text> + </object> + </heading> + <content> + + <object id="84"> + + + <ocn>84</ocn> + + + <text class="norm">Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed by other heading levels, and 1 -6 being headings followed by substantive text or sub-headings. :A~ usually the title :A~? conditional level 1 heading (used where a stand-alone document may be imported into another)</text> + + </object> + + + <object id="85"> + + + <ocn>85</ocn> + + + <text class="norm"><b>:A~ [heading text]</b> Top level heading [this usually has similar content to the title @title: ] NOTE: the heading levels described here are in 0.38 notation, see heading</text> + + </object> + + + <object id="86"> + + + <ocn>86</ocn> + + + <text class="norm"><b>:B~ [heading text]</b> Second level heading [this is a heading level divider]</text> + + </object> + + + <object id="87"> + + + <ocn>87</ocn> + + + <text class="norm"><b>:C~ [heading text]</b> Third level heading [this is a heading level divider]</text> + + </object> + + + <object id="88"> + + + <ocn>88</ocn> + + + <text class="norm"><b>1~ [heading text]</b> Top level heading preceding substantive text of document or sub-heading 2, the heading level that would normally be marked 1. or 2. or 3. etc. in a document, and the level on which sisu by default would break html output into named segments, names are provided automatically if none are given (a number), otherwise takes the form 1~my_filename_for_this_segment</text> + + </object> + + + <object id="89"> + + + <ocn>89</ocn> + + + <text class="norm"><b>2~ [heading text]</b> Second level heading preceding substantive text of document or sub-heading 3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document.</text> + + </object> + + + <object id="90"> + + + <ocn>90</ocn> + + + <text class="norm"><b>3~ [heading text]</b> Third level heading preceding substantive text of document, that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document</text> + + </object> + + + <object id="91"> + + + <ocn>91</ocn> + + + <text class="code"> + +    1~filename level 1 heading,<br /><br />   % the primary division such as Chapter that is followed by substantive text, and may be further subdivided (this is the level on which by default html segments are made)     + + </text> + + </object> + + + </content> + + </contents2> + + <contents2> + <heading> + <object id="92"> + <ocn>92</ocn> + <nametag>3.2</nametag> + + <text>3.2 Font Attributes</text> + </object> + </heading> + <content> + + <object id="93"> + + + <ocn>93</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="94"> + + + <ocn>94</ocn> + + + <text class="code"> + +    normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+<br /><br />   normal text<br /><br />   !{emphasis}!<br /><br />   *{bold text}*<br /><br />   _{underscore}<br /><br />   /{italics}/<br /><br />   "{citation}"<br /><br />   ^{superscript}^<br /><br />   ,{subscript},<br /><br />   +{inserted text}+<br /><br />   -{strikethrough}-     + + </text> + + </object> + + + <object id="95"> + + + <ocn>95</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="96"> + + + <ocn>96</ocn> + + + <text class="norm">normal text <em>emphasis</em> <b>bold text</b> <u>underscore</u> <i>italics</i> <cite>citation</cite> <sup>superscript</sup> <sub>subscript</sub> <ins>inserted text</ins> <del>strikethrough</del></text> + + </object> + + + <object id="97"> + + + <ocn>97</ocn> + + + <text class="norm">normal text</text> + + </object> + + + <object id="98"> + + + <ocn>98</ocn> + + + <text class="norm"><em>emphasis</em></text> + + </object> + + + <object id="99"> + + + <ocn>99</ocn> + + + <text class="norm"><b>bold text</b></text> + + </object> + + + <object id="100"> + + + <ocn>100</ocn> + + + <text class="norm"><u>underscore</u></text> + + </object> + + + <object id="101"> + + + <ocn>101</ocn> + + + <text class="norm"><i>italics</i></text> + + </object> + + + <object id="102"> + + + <ocn>102</ocn> + + + <text class="norm"><cite>citation</cite></text> + + </object> + + + <object id="103"> + + + <ocn>103</ocn> + + + <text class="norm"><sup>superscript</sup></text> + + </object> + + + <object id="104"> + + + <ocn>104</ocn> + + + <text class="norm"><sub>subscript</sub></text> + + </object> + + + <object id="105"> + + + <ocn>105</ocn> + + + <text class="norm"><ins>inserted text</ins></text> + + </object> + + + <object id="106"> + + + <ocn>106</ocn> + + + <text class="norm"><del>strikethrough</del></text> + + </object> + + + </content> + + </contents2> + + <contents2> + <heading> + <object id="107"> + <ocn>107</ocn> + <nametag>3.3</nametag> + + <text>3.3 Indentation and bullets</text> + </object> + </heading> + <content> + + <object id="108"> + + + <ocn>108</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="109"> + + + <ocn>109</ocn> + + + <text class="code"> + +    ordinary paragraph<br /><br />   _1 indent paragraph one step<br /><br />   _2 indent paragraph two steps<br /><br />   _9 indent paragraph nine steps     + + </text> + + </object> + + + <object id="110"> + + + <ocn>110</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="111"> + + + <ocn>111</ocn> + + + <text class="norm">ordinary paragraph</text> + + </object> + + + <object id="112"> + + + <ocn>112</ocn> + + + <text class="indent1"> indent paragraph one step</text> + + </object> + + + <object id="113"> + + + <ocn>113</ocn> + + + <text class="indent2"> indent paragraph two steps</text> + + </object> + + + <object id="114"> + + + <ocn>114</ocn> + + + <text class="indent9"> indent paragraph nine steps</text> + + </object> + + + <object id="115"> + + + <ocn>115</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="116"> + + + <ocn>116</ocn> + + + <text class="code"> + +    _* bullet text<br /><br />   _1* bullet text, first indent<br /><br />   _2* bullet text, two step indent     + + </text> + + </object> + + + <object id="117"> + + + <ocn>117</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="118"> + + + <ocn>118</ocn> + + + <text class="indent_bullet"> bullet text</text> + + </object> + + + <object id="119"> + + + <ocn>119</ocn> + + + <text class="indent_bullet1"> bullet text, first indent</text> + + </object> + + + <object id="120"> + + + <ocn>120</ocn> + + + <text class="indent_bullet2"> bullet text, two step indent</text> + + </object> + + + <object id="121"> + + + <ocn>121</ocn> + + + <text class="norm">Numbered List (not to be confused with headings/titles, (document structure))</text> + + </object> + + + <object id="122"> + + + <ocn>122</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="123"> + + + <ocn>123</ocn> + + + <text class="code"> + +    # numbered list numbered list 1., 2., 3, etc.<br /><br />   _# numbered list numbered list indented a., b., c., d., etc.     + + </text> + + </object> + + + </content> + + </contents2> + + <contents2> + <heading> + <object id="124"> + <ocn>124</ocn> + <nametag>3.4</nametag> + + <text>3.4 Footnotes / Endnotes</text> + </object> + </heading> + <content> + + <object id="125"> + + + <ocn>125</ocn> + + + <text class="norm">Footnotes and endnotes not distinguished in markup. They are automatically numbered. Depending on the output file format (html, odf, pdf etc.), the document output selected will have either footnotes or endnotes.</text> + + </object> + + + <object id="126"> + + + <ocn>126</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="127"> + + + <ocn>127</ocn> + + + <text class="code"> + +    ~{ a footnote or endnote }~     + + </text> + + </object> + + + <object id="128"> + + + <ocn>128</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="129"> + + + <ocn>129</ocn> + + + <text class="norm"><endnote><number>3</number><note>a footnote or endnote</note></endnote></text> + + </object> + + + <object id="130"> + + + <ocn>130</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="131"> + + + <ocn>131</ocn> + + + <text class="code"> + +    normal text~{ self contained endnote marker & endnote in one }~ continues     + + </text> + + </object> + + + <object id="132"> + + + <ocn>132</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="133"> + + + <ocn>133</ocn> + + + <text class="norm">normal text<endnote><number>4</number><note>self contained endnote marker & endnote in one</note></endnote> continues</text> + + </object> + + + <object id="134"> + + + <ocn>134</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="135"> + + + <ocn>135</ocn> + + + <text class="code"> + +    normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues<br /><br />   normal text ~{** another unnumbered asterisk footnote/endnote }~ continues     + + </text> + + </object> + + + <object id="136"> + + + <ocn>136</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="137"> + + + <ocn>137</ocn> + + + <text class="norm">normal text <endnote><symbol>*</symbol><note>unnumbered asterisk footnote/endnote, insert multiple asterisks if required</note></endnote> continues</text> + + </object> + + + <object id="138"> + + + <ocn>138</ocn> + + + <text class="norm">normal text <endnote><symbol>**</symbol><note>another unnumbered asterisk footnote/endnote</note></endnote> continues</text> + + </object> + + + <object id="139"> + + + <ocn>139</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="140"> + + + <ocn>140</ocn> + + + <text class="code"> + +    normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues<br /><br />   normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues     + + </text> + + </object> + + + <object id="141"> + + + <ocn>141</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="142"> + + + <ocn>142</ocn> + + + <text class="norm">normal text <endnote><symbol>*1</symbol><note>editors notes, numbered asterisk footnote/endnote series</note></endnote> continues</text> + + </object> + + + <object id="143"> + + + <ocn>143</ocn> + + + <text class="norm">normal text <endnote><symbol>+1</symbol><note>editors notes, numbered asterisk footnote/endnote series</note></endnote> continues</text> + + </object> + + + <object id="144"> + + + <ocn>144</ocn> + + + <text class="norm"><b>Alternative endnote pair notation for footnotes/endnotes:</b></text> + + </object> + + + <object id="145"> + + + <ocn>145</ocn> + + + <text class="code"> + +    % note the endnote marker "~^"<br /><br />   normal text~^ continues<br /><br />   ^~ endnote text following the paragraph in which the marker occurs     + + </text> + + </object> + + + <object id="146"> + + + <ocn>146</ocn> + + + <text class="norm">the standard and pair notation cannot be mixed in the same document</text> + + </object> + + + </content> + + </contents2> + + <contents2> + <heading> + <object id="147"> + <ocn>147</ocn> + <nametag>3.5</nametag> + + <text>3.5 Links</text> + </object> + </heading> + <content> + + </content> + + <contents3> + <heading> + <object id="148"> + <ocn>148</ocn> + <nametag>3.5.1</nametag> + + <text>3.5.1 Naked URLs within text, dealing with urls</text> + </object> + </heading> + <content> + + <object id="149"> + + + <ocn>149</ocn> + + + <text class="norm">urls are found within text and marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the decoration is omitted).</text> + + </object> + + + <object id="150"> + + + <ocn>150</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="151"> + + + <ocn>151</ocn> + + + <text class="code"> + +    normal text http://www.jus.uio.no/sisu continues     + + </text> + + </object> + + + <object id="152"> + + + <ocn>152</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="153"> + + + <ocn>153</ocn> + + + <text class="norm">normal text <<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>> continues</text> + + </object> + + + <object id="154"> + + + <ocn>154</ocn> + + + <text class="norm">An escaped url without decoration</text> + + </object> + + + <object id="155"> + + + <ocn>155</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="156"> + + + <ocn>156</ocn> + + + <text class="code"> + +    normal text _http://www.jus.uio.no/sisu continues<br /><br />   deb _http://www.jus.uio.no/sisu/archive unstable main non-free     + + </text> + + </object> + + + <object id="157"> + + + <ocn>157</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="158"> + + + <ocn>158</ocn> + + + <text class="norm">normal text <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> continues</text> + + </object> + + + <object id="159"> + + + <ocn>159</ocn> + + + <text class="norm">deb <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/archive">http://www.jus.uio.no/sisu/archive</link> unstable main non-free</text> + + </object> + + + <object id="160"> + + + <ocn>160</ocn> + + + <text class="norm">where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document</text> + + </object> + + + <object id="161"> + + + <ocn>161</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="162"> + + + <ocn>162</ocn> + + + <text class="code"> + +    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="163"> + + + <ocn>163</ocn> + + + <text class="norm">To link text or an image to a url the markup is as follows</text> + + </object> + + + <object id="164"> + + + <ocn>164</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="165"> + + + <ocn>165</ocn> + + + <text class="code"> + +    about { SiSU }http://url.org markup     + + </text> + + </object> + + + </content> + + </contents3> + + <contents3> + <heading> + <object id="166"> + <ocn>166</ocn> + <nametag>3.5.2</nametag> + + <text>3.5.2 Linking Text</text> + </object> + </heading> + <content> + + <object id="167"> + + + <ocn>167</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="168"> + + + <ocn>168</ocn> + + + <text class="norm">about <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/"> SiSU </link> markup</text> + + </object> + + + <object id="169"> + + + <ocn>169</ocn> + + + <text class="norm">A shortcut notation is available so the url link may also be provided automatically as a footnote</text> + + </object> + + + <object id="170"> + + + <ocn>170</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="171"> + + + <ocn>171</ocn> + + + <text class="code"> + +    about {~^ SiSU }http://url.org markup     + + </text> + + </object> + + + <object id="172"> + + + <ocn>172</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="173"> + + + <ocn>173</ocn> + + + <text class="norm">about <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/"> SiSU </link> <endnote><number>5</number><note><<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>></note></endnote> markup</text> + + </object> + + + </content> + + </contents3> + + <contents3> + <heading> + <object id="174"> + <ocn>174</ocn> + <nametag>3.5.3</nametag> + + <text>3.5.3 Linking Images</text> + </object> + </heading> + <content> + + <object id="175"> + + + <ocn>175</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="176"> + + + <ocn>176</ocn> + + + <text class="code"> + +    {tux.png 64x80 }image<br /><br />   % various url linked images<br /><br />   {tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/<br /> <br />   {GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/<br /> <br />   {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/<br /> <br />     + + </text> + + </object> + + + <object id="177"> + + + <ocn>177</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="178"> + + + <ocn>178</ocn> + + + <text class="norm">{tux.png 64x80 }image</text> + + </object> + + + <object id="179"> + + + <ocn>179</ocn> + + + <text class="norm"><image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:actuate="onLoad" xlink:show="embed" xlink:href="../_sisu/image_local/tux.png" width="64" height="80" />[tux.png] "Gnu/Linux - a better way"</text> + + </object> + + + <object id="180"> + + + <ocn>180</ocn> + + + <text class="norm">[ ruby_logo (png missing) ] <endnote><number>6</number><note><<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.ruby-lang.org/en/">http://www.ruby-lang.org/en/</link>></note></endnote></text> + + </object> + + + <object id="181"> + + + <ocn>181</ocn> + + + <text class="norm"><image xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:actuate="onLoad" xlink:show="embed" xlink:href="../_sisu/image_local/GnuDebianLinuxRubyBetterWay.png" width="100" height="101" />[GnuDebianLinuxRubyBetterWay.png] "Way Better - with Gnu/Linux, Debian and Ruby"</text> + + </object> + + + <object id="182"> + + + <ocn>182</ocn> + + + <text class="norm"><b>linked url footnote shortcut</b></text> + + </object> + + + <object id="183"> + + + <ocn>183</ocn> + + + <text class="code"> + +    {~^ [text to link] }http://url.org<br /> <br />   % maps to: { [text to link] }http://url.org ~{ http://url.org }~<br /><br />   % which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink     + + </text> + + </object> + + + <object id="184"> + + + <ocn>184</ocn> + + + <text class="code"> + +    text marker *~name     + + </text> + + </object> + + + <object id="185"> + + + <ocn>185</ocn> + + + <text class="norm">note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention.</text> + + </object> + + + </content> + + </contents3> + + </contents2> + + <contents2> + <heading> + <object id="186"> + <ocn>186</ocn> + <nametag>3.6</nametag> + + <text>3.6 Grouped Text</text> + </object> + </heading> + <content> + + </content> + + <contents3> + <heading> + <object id="187"> + <ocn>187</ocn> + <nametag>3.6.1</nametag> + + <text>3.6.1 Tables</text> + </object> + </heading> + <content> + + <object id="188"> + + + <ocn>188</ocn> + + + <text class="norm">Tables may be prepared in two either of two forms</text> + + </object> + + + <object id="189"> + + + <ocn>189</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="190"> + + + <ocn>190</ocn> + + + <text class="code"> + +    table{ c3; 40; 30; 30;<br /><br />   This is a table<br />   this would become column two of row one<br />   column three of row one is here<br /><br />   And here begins another row<br />   column two of row two<br />   column three of row two, and so on<br /><br />   }table     + + </text> + + </object> + + + <object id="191"> + + + <ocn>191</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + +<object id="192"> + + + +<ocn></ocn><table summary="normal text css" width="100%" border="0" bgcolor="white" cellpadding="2" align="center"> + <tr> + <td width="40%" valign="top"> + This is a table + </td> + <td width="30%" valign="top"> + this would become column two of row one + </td> + <td width="30%" valign="top"> + column three of row one is here +</td> +</tr> + + <tr> + <td width="40%" valign="top"> + And here begins another row + </td> + <td width="30%" valign="top"> + column two of row two + </td> + <td width="30%" valign="top"> + column three of row two, and so on +</td> +</tr> + + </table> + + + + +</object> + + + <object id="193"> + + + <ocn>193</ocn> + + + <text class="norm">a second form may be easier to work with in cases where there is not much information in each column</text> + + </object> + + + <object id="194"> + + + <ocn>194</ocn> + + + <text class="norm"><b>markup example:</b><endnote><number>7</number><note>Table from the Wealth of Networks by Yochai Benkler<br /> <<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler">http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</link>></note></endnote></text> + + </object> + + + <object id="195"> + + + <ocn>195</ocn> + + + <text class="code"> + +    !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005<br /><br />   {table~h 24; 12; 12; 12; 12; 12; 12;}<br />   |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006<br />   Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721<br />   Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945<br />   Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016<br />   No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000<br />   No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000<br /><br />   \* Contributed at least ten times; \** at least 5 times in last month; \*\** more than 100 times in last month.     + + </text> + + </object> + + + <object id="196"> + + + <ocn>196</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="197"> + + + <ocn>197</ocn> + + + <text class="norm"><b>Table 3.1: Contributors to Wikipedia, January 2001 - June 2005</b></text> + + </object> + + +<object id="198"> + + + +<ocn></ocn><table summary="normal text css" width="100%" border="0" bgcolor="white" cellpadding="2" align="center"> + <tr> + <td width="24%" valign="top"> + <b> </b></td><td width="12%" valign="top"> + <b>Jan. 2001</b></td><td width="12%" valign="top"> + <b>Jan. 2002</b></td><td width="12%" valign="top"> + <b>Jan. 2003</b></td><td width="12%" valign="top"> + <b>Jan. 2004</b></td><td width="12%" valign="top"> + <b>July 2004</b></td><td width="12%" valign="top"> + <b>June 2006</b> +</td> +</tr> + <tr> + <td width="24%" valign="top"> + Contributors* + </td> + <td width="12%" valign="top"> + 10 + </td> + <td width="12%" valign="top"> + 472 + </td> + <td width="12%" valign="top"> + 2,188 + </td> + <td width="12%" valign="top"> + 9,653 + </td> + <td width="12%" valign="top"> + 25,011 + </td> + <td width="12%" valign="top"> + 48,721 +</td> +</tr> + + <tr> + <td width="24%" valign="top"> + Active contributors** + </td> + <td width="12%" valign="top"> + 9 + </td> + <td width="12%" valign="top"> + 212 + </td> + <td width="12%" valign="top"> + 846 + </td> + <td width="12%" valign="top"> + 3,228 + </td> + <td width="12%" valign="top"> + 8,442 + </td> + <td width="12%" valign="top"> + 16,945 +</td> +</tr> + + <tr> + <td width="24%" valign="top"> + Very active contributors*** + </td> + <td width="12%" valign="top"> + 0 + </td> + <td width="12%" valign="top"> + 31 + </td> + <td width="12%" valign="top"> + 190 + </td> + <td width="12%" valign="top"> + 692 + </td> + <td width="12%" valign="top"> + 1,639 + </td> + <td width="12%" valign="top"> + 3,016 +</td> +</tr> + + <tr> + <td width="24%" valign="top"> + No. of English language articles + </td> + <td width="12%" valign="top"> + 25 + </td> + <td width="12%" valign="top"> + 16,000 + </td> + <td width="12%" valign="top"> + 101,000 + </td> + <td width="12%" valign="top"> + 190,000 + </td> + <td width="12%" valign="top"> + 320,000 + </td> + <td width="12%" valign="top"> + 630,000 +</td> +</tr> + + <tr> + <td width="24%" valign="top"> + No. of articles, all languages + </td> + <td width="12%" valign="top"> + 25 + </td> + <td width="12%" valign="top"> + 19,000 + </td> + <td width="12%" valign="top"> + 138,000 + </td> + <td width="12%" valign="top"> + 490,000 + </td> + <td width="12%" valign="top"> + 862,000 + </td> + <td width="12%" valign="top"> + 1,600,000 +</td> +</tr> + + </table> + + + + +</object> + + + <object id="199"> + + + <ocn>199</ocn> + + + <text class="norm">* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.</text> + + </object> + + + </content> + + </contents3> + + <contents3> + <heading> + <object id="200"> + <ocn>200</ocn> + <nametag>3.6.2</nametag> + + <text>3.6.2 Poem</text> + </object> + </heading> + <content> + + <object id="201"> + + + <ocn>201</ocn> + + + <text class="norm"><b>basic markup:</b></text> + + </object> + + + <object id="202"> + + + <ocn>202</ocn> + + + <text class="code"> + +    poem{<br /><br />   Your poem here<br /><br />   }poem<br /><br />   Each verse in a poem is given a separate object number.     + + </text> + + </object> + + + <object id="203"> + + + <ocn>203</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="204"> + + + <ocn>204</ocn> + + + <text class="code"> + +    poem{<br /><br />   'Fury said to a<br />   mouse, That he<br />   met in the<br />   house,<br />   "Let us<br />   both go to<br />   law: I will<br />   prosecute<br />   YOU. --Come,<br />   I'll take no<br />   denial; We<br />   must have a<br />   trial: For<br />   really this<br />   morning I've<br />   nothing<br />   to do."<br />   Said the<br />   mouse to the<br />   cur, "Such<br />   a trial,<br />   dear Sir,<br />   With<br />   no jury<br />   or judge,<br />   would be<br />   wasting<br />   our<br />   breath."<br />   "I'll be<br />   judge, I'll<br />   be jury,"<br />   Said<br />   cunning<br />   old Fury:<br />   "I'll<br />   try the<br />   whole<br />   cause,<br />   and<br />   condemn<br />   you<br />   to<br />   death."'<br /><br />   }poem     + + </text> + + </object> + + + <object id="205"> + + + <ocn>205</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="206"> + + + <ocn>206</ocn> + + + <text class="verse"> + + 'Fury said to a<br /> mouse, That he<br /> met in the<br /> house,<br /> "Let us<br /> both go to<br /> law: I will<br /> prosecute<br /> YOU. --Come,<br /> I'll take no<br /> denial; We<br /> must have a<br /> trial: For<br /> really this<br /> morning I've<br /> nothing<br /> to do."<br /> Said the<br /> mouse to the<br /> cur, "Such<br /> a trial,<br /> dear Sir,<br /> With<br /> no jury<br /> or judge,<br /> would be<br /> wasting<br /> our<br /> breath."<br /> "I'll be<br /> judge, I'll<br /> be jury,"<br /> Said<br /> cunning<br /> old Fury:<br /> "I'll<br /> try the<br /> whole<br /> cause,<br /> and<br /> condemn<br /> you<br /> to<br /> death."'<br /> + + </text> + + </object> + + + </content> + + </contents3> + + <contents3> + <heading> + <object id="207"> + <ocn>207</ocn> + <nametag>3.6.3</nametag> + + <text>3.6.3 Group</text> + </object> + </heading> + <content> + + <object id="208"> + + + <ocn>208</ocn> + + + <text class="norm"><b>basic markup:</b></text> + + </object> + + + <object id="209"> + + + <ocn>209</ocn> + + + <text class="code"> + +    group{<br /><br />   Your grouped text here<br /><br />   }group<br /><br />   A group is treated as an object and given a single object number.     + + </text> + + </object> + + + <object id="210"> + + + <ocn>210</ocn> + + + <text class="norm"><b>markup example:</b></text> + + </object> + + + <object id="211"> + + + <ocn>211</ocn> + + + <text class="code"> + +    group{<br /><br />   'Fury said to a<br />   mouse, That he<br />   met in the<br />   house,<br />   "Let us<br />   both go to<br />   law: I will<br />   prosecute<br />   YOU. --Come,<br />   I'll take no<br />   denial; We<br />   must have a<br />   trial: For<br />   really this<br />   morning I've<br />   nothing<br />   to do."<br />   Said the<br />   mouse to the<br />   cur, "Such<br />   a trial,<br />   dear Sir,<br />   With<br />   no jury<br />   or judge,<br />   would be<br />   wasting<br />   our<br />   breath."<br />   "I'll be<br />   judge, I'll<br />   be jury,"<br />   Said<br />   cunning<br />   old Fury:<br />   "I'll<br />   try the<br />   whole<br />   cause,<br />   and<br />   condemn<br />   you<br />   to<br />   death."'<br /><br />   }group     + + </text> + + </object> + + + <object id="212"> + + + <ocn>212</ocn> + + + <text class="norm"><b>resulting output:</b></text> + + </object> + + + <object id="213"> + + + <ocn>213</ocn> + + + <text class="group"> + + 'Fury said to a<br /> mouse, That he<br /> met in the<br /> house,<br /> "Let us<br /> both go to<br /> law: I will<br /> prosecute<br /> YOU. --Come,<br /> I'll take no<br /> denial; We<br /> must have a<br /> trial: For<br /> really this<br /> morning I've<br /> nothing<br /> to do."<br /> Said the<br /> mouse to the<br /> cur, "Such<br /> a trial,<br /> dear Sir,<br /> With<br /> no jury<br /> or judge,<br /> would be<br /> wasting<br /> our<br /> breath."<br /> "I'll be<br /> judge, I'll<br /> be jury,"<br /> Said<br /> cunning<br /> old Fury:<br /> "I'll<br /> try the<br /> whole<br /> cause,<br /> and<br /> condemn<br /> you<br /> to<br /> death."'<br /> + + </text> + + </object> + + + </content> + + </contents3> + + <contents3> + <heading> + <object id="214"> + <ocn>214</ocn> + <nametag>3.6.4</nametag> + + <text>3.6.4 Code</text> + </object> + </heading> + <content> + + <object id="215"> + + + <ocn>215</ocn> + + + <text class="norm">Code tags are used to escape regular sisu markup, and have been used extensively within this document to provide examples of <b>SiSU</b> markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags.</text> + + </object> + + + <object id="216"> + + + <ocn>216</ocn> + + + <text class="norm">A code-block is treated as an object and given a single object number. [an option to number each line of code may be considered at some later time]</text> + + </object> + + + <object id="217"> + + + <ocn>217</ocn> + + + <text class="norm"><b>use of code tags instead of poem compared, resulting output:</b></text> + + </object> + + + <object id="218"> + + + <ocn>218</ocn> + + + <text class="code"> + +    'Fury said to a<br />   mouse, That he<br />   met in the<br />   house,<br />   "Let us<br />   both go to<br />   law: I will<br />   prosecute<br />   YOU. --Come,<br />   I'll take no<br />   denial; We<br />   must have a<br />   trial: For<br />   really this<br />   morning I've<br />   nothing<br />   to do."<br />   Said the<br />   mouse to the<br />   cur, "Such<br />   a trial,<br />   dear Sir,<br />   With<br />   no jury<br />   or judge,<br />   would be<br />   wasting<br />   our<br />   breath."<br />   "I'll be<br />   judge, I'll<br />   be jury,"<br />   Said<br />   cunning<br />   old Fury:<br />   "I'll<br />   try the<br />   whole<br />   cause,<br />   and<br />   condemn<br />   you<br />   to<br />   death."'     + + </text> + + </object> + + + </content> + + </contents3> + + </contents2> + + </contents1> + + <contents1> + <heading> + <object id="219"> + <ocn>219</ocn> + <nametag>4</nametag> + + <text>4. Composite documents markup</text> + </object> + </heading> + <content> + + <object id="220"> + + + <ocn>220</ocn> + + + <text class="norm">It is possible to build a document by creating a master document that requires other documents. The documents required may be complete documents that could be generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built from other documents), it should be named with the suffix <b>.ssm</b> Within this document you would provide information on the other documents that should be included within the text. These may be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix <b>._sst</b></text> + + </object> + + + <object id="221"> + + + <ocn>221</ocn> + + + <text class="norm">basic markup for importing a document into a master document</text> + + </object> + + + <object id="222"> + + + <ocn>222</ocn> + + + <text class="code"> + +    << |filename1.sst|@|^|<br /><br />   << |filename2.ssi|@|^|     + + </text> + + </object> + + + <object id="223"> + + + <ocn>223</ocn> + + + <text class="norm">The form described above should be relied on. Within the Vim editor it results in the text thus linked becoming hyperlinked to the document it is calling in which is convenient for editing. Alternative markup for importation of documents under consideration, and occasionally supported have been.</text> + + </object> + + + <object id="224"> + + + <ocn>224</ocn> + + + <text class="code"> + +    r{filename}<br /><br />   {filename.ssi}require<br /><br />   << {filename.ssi}<br /><br />   % using textlink alternatives<br /><br />   |filename.ssi|@|^|require<br /><br />   << |filename.ssi|@|^|<br /><br />   % using thlnk alternatives<br /><br />   <url:filename.ssi>require<br /><br />   << <url:filename.ssi>     + + </text> + + </object> + + + </content> + + </contents1> + + <heading3> + <heading> + <object id="225"> + <ocn>225</ocn> + <text>Markup Syntax History</text> + </object> + </heading> + + <contents1> + <heading> + <object id="226"> + <ocn>226</ocn> + <nametag>5</nametag> + + <text>5. Notes related to Files-types and Markup Syntax</text> + </object> + </heading> + <content> + + <object id="227"> + + + <ocn>227</ocn> + + + <text class="norm">0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37</text> + + </object> + + + <object id="228"> + + + <ocn>228</ocn> + + + <text class="norm"><b>0.52</b> (2007w14/6) declared document type identifier at start of text/document:</text> + + </object> + + + <object id="229"> + + + <ocn>229</ocn> + + + <text class="indent1"> <b>SiSU</b> 0.52</text> + + </object> + + + <object id="230"> + + + <ocn>230</ocn> + + + <text class="norm">or, backward compatible using the comment marker:</text> + + </object> + + + <object id="231"> + + + <ocn>231</ocn> + + + <text class="indent1"> % <b>SiSU</b> 0.38</text> + + </object> + + + <object id="232"> + + + <ocn>232</ocn> + + + <text class="norm">variations include '<b>SiSU</b> (text|master|insert) [version]' and 'sisu-[version]'</text> + + </object> + + + <object id="233"> + + + <ocn>233</ocn> + + + <text class="norm"><b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged</text> + + </object> + + + <object id="234"> + + + <ocn>234</ocn> + + + <text class="norm"><b>0.42</b> (2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author</text> + + </object> + + + <object id="235"> + + + <ocn>235</ocn> + + + <text class="norm"><b>0.38</b> (2006w15/7) introduced new/alternative notation for headers, e.g. @title: (instead of 0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6)</text> + + </object> + + + <object id="236"> + + + <ocn>236</ocn> + + + <text class="norm"><b>0.37</b> (2006w09/7) introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged</text> + + </object> + + + <object id="237"> + + + <ocn>237</ocn> + + + <text class="norm"><b>0.35</b> (2005w52/3) sisupod, zipped content file introduced</text> + + </object> + + + <object id="238"> + + + <ocn>238</ocn> + + + <text class="norm"><b>0.23</b> (2005w36/2) utf-8 for markup file</text> + + </object> + + + <object id="239"> + + + <ocn>239</ocn> + + + <text class="norm"><b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available to be relied upon</text> + + </object> + + + <object id="240"> + + + <ocn>240</ocn> + + + <text class="norm"><b>0.20.4</b> (2005w33/4) header 0~links</text> + + </object> + + + <object id="241"> + + + <ocn>241</ocn> + + + <text class="norm"><b>0.16</b> (2005w25/2) substantial changes introduced to make markup cleaner, header 0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start of a text line as comment marker</text> + + </object> + + + </content> + + </contents1> + + <contents1> + <heading> + <object id="0"> + <ocn>0</ocn> + <nametag>endnotes</nametag> + + <text>Endnotes</text> + </object> + </heading> + <content> + + </content> + </contents1> + + </heading3> + + </heading2> + +</heading1> + +</body> + +</document> + |