From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- .../sisu_manual/sisu_filetypes/sax.xml | 531 +++++++++++++++++++++ 1 file changed, 531 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_filetypes/sax.xml (limited to 'data/doc/manuals_generated/sisu_manual/sisu_filetypes/sax.xml') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_filetypes/sax.xml b/data/doc/manuals_generated/sisu_manual/sisu_filetypes/sax.xml new file mode 100644 index 00000000..c4721c36 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_filetypes/sax.xml @@ -0,0 +1,531 @@ + + + + + + + Title: + + SiSU - Filetypes [0.58] + +
+ Creator: + + Ralph Amissah + +
+ Rights: + + Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +
+ Type: + + information + +
+ Subject: + + ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +
+ Date created: + + 2002-08-28 + +
+ Date issued: + + 2002-08-28 + +
+ Date available: + + 2002-08-28 + +
+ Date modified: + + 2007-09-16 + +
+ Date: + + 2007-09-16 + +
+ + + + 1 + + SiSU - Filetypes [0.58],
Ralph Amissah + + + + 2 + + 1. SiSU filetypes + + + + 3 + + SiSU has plaintext and binary filetypes, and can process either +type of document. + + + + 4 + + 1.1 .sst .ssm .ssi marked up plain text + + + + 5 + + SiSU documents are prepared as plain-text (utf-8) files with +SiSU markup. They may make reference to and contain images (for +example), which are stored in the directory beneath them _sisu/image. +SiSU 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. + + + + 6 + + SiSU 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. + + + + 7 + + SiSU source markup can be shared with the command: + + + + 8 + + sisu -s [filename] + + + + 9 + + 1.1.1 sisu text - regular files (.sst) + + + + 10 + + The most common form of document in SiSU, see the section on +SiSU markup. + + + + 11 + + <http://www.jus.uio.no/sisu/sisu_markup> + + + + 12 + + <http://www.jus.uio.no/sisu/sisu_manual> + + + + 13 + + 1.1.2 sisu master files (.ssm) + + + + 14 + + Composite documents which incorporate other SiSU documents which +may be either regular SiSU text .sst which may be generated +independently, or inserts prepared solely for the purpose of being +incorporated into one or more master documents. + + + + 15 + + The mechanism by which master files incorporate other documents is +described as one of the headings under under SiSU markup in the +SiSU manual. + + + + 16 + + 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. + + + + 17 + + Note: a secondary file of the composite document is built prior to +processing with the same prefix and the suffix ._sst 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. + + + + + 18 + + <http://www.jus.uio.no/sisu/sisu_markup> + + + + 19 + + <http://www.jus.uio.no/sisu/sisu_manual> + + + + 20 + + 1.1.3 sisu insert files (.ssi) + + + + 21 + + Inserts are documents prepared solely for the purpose of being +incorporated into one or more master documents. They resemble regular +SiSU text files except they are ignored by the SiSU +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. + + + + 22 + + 1.2 sisupod, zipped binary container (sisupod.zip, .ssp) + + + + 23 + + A sisupod is a zipped SiSU text file or set of SiSU text +files and any associated images that they contain (this will be +extended to include sound and multimedia-files) + + + + 24 + + SiSU 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. + + + + 25 + + 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 SiSU documents. + + + + 26 + + The command to create a sisupod is: + + + + 27 + + sisu -S [filename] + + + + 28 + + Alternatively, make a pod of the contents of a whole directory: + + + + 29 + + sisu -S + + + + 30 + + SiSU processing can be done directly against a sisupod; which +may be located locally or on a remote server for which a url is +provided. + + + + 31 + + <http://www.jus.uio.no/sisu/sisu_commands> + + + + 32 + + <http://www.jus.uio.no/sisu/sisu_manual> + + + + 33 + + 2. Experimental Alternative Input Representations + + + + 34 + + 2.1 Alternative XML + + + + 35 + + SiSU 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. + + + + 36 + + convert from sst to simple xml representations (sax, dom and +node): + + + + 37 + + sisu --to-sax [filename/wildcard] or sisu --to-sxs +[filename/wildcard] + + + + 38 + + sisu --to-dom [filename/wildcard] or sisu --to-sxd +[filename/wildcard] + + + + 39 + + sisu --to-node [filename/wildcard] or sisu --to-sxn +[filename/wildcard] + + + + 40 + + convert to sst from any sisu xml representation (sax, dom and +node): + + + + 41 + + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + + + + 42 + + or the same: + + + + 43 + + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + + + + 44 + + 2.1.1 XML SAX representation + + + + 45 + + To convert from sst to simple xml (sax) representation: + + + + 46 + + sisu --to-sax [filename/wildcard] or sisu --to-sxs +[filename/wildcard] + + + + 47 + + To convert from any sisu xml representation back to sst + + + + 48 + + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + + + + 49 + + or the same: + + + + 50 + + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + + + + 51 + + 2.1.2 XML DOM representation + + + + 52 + + To convert from sst to simple xml (dom) representation: + + + + 53 + + sisu --to-dom [filename/wildcard] or sisu --to-sxd +[filename/wildcard] + + + + 54 + + To convert from any sisu xml representation back to sst + + + + 55 + + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + + + + 56 + + or the same: + + + + 57 + + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + + + + 58 + + 2.1.3 XML Node representation + + + + 59 + + To convert from sst to simple xml (node) representation: + + + + 60 + + sisu --to-node [filename/wildcard] or sisu --to-sxn +[filename/wildcard] + + + + 61 + + To convert from any sisu xml representation back to sst + + + + 62 + + sisu --from-xml2sst [filename/wildcard +[.sxs.xml,.sxd.xml,sxn.xml]] + + + + 63 + + or the same: + + + + 64 + + sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + + + + 0 + + Endnotes + + + + -- cgit v1.2.3