From b571083d97d62e381d9b0cccd41889cfc95256a4 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 7 Feb 2011 11:53:21 -0500 Subject: documentation & man pages, add sisu3, sisu-po and touches --- .../sisu/v3/markup-samples/sisu_manual/en/sisu.ssm | 103 ++ .../sisu_manual/en/sisu_commands.sst | 374 ++++++ .../markup-samples/sisu_manual/en/sisu_config.ssi | 80 ++ .../sisu_manual/en/sisu_content_directories.ssi | 141 ++ .../v3/markup-samples/sisu_manual/en/sisu_css.ssi | 63 + .../sisu_manual/en/sisu_description.sst | 564 ++++++++ .../sisu_manual/en/sisu_download.ssi | 163 +++ .../sisu_manual/en/sisu_examples.ssi | 54 + .../sisu_manual/en/sisu_examples.sst | 220 +++ .../v3/markup-samples/sisu_manual/en/sisu_faq.sst | 221 +++ .../sisu_manual/en/sisu_filetypes.sst | 170 +++ .../v3/markup-samples/sisu_manual/en/sisu_help.sst | 131 ++ .../sisu_manual/en/sisu_help_sources.sst | 202 +++ .../sisu_manual/en/sisu_homepages.ssi | 87 ++ .../v3/markup-samples/sisu_manual/en/sisu_how.ssi | 47 + .../markup-samples/sisu_manual/en/sisu_howto.sst | 1406 +++++++++++++++++++ .../sisu_manual/en/sisu_hyperestraier.ssi | 115 ++ .../sisu_manual/en/sisu_installation.ssi | 389 ++++++ .../sisu_manual/en/sisu_interesting_to_whom.ssi | 53 + .../sisu_manual/en/sisu_introduction.sst | 72 + .../markup-samples/sisu_manual/en/sisu_manual.ssm | 118 ++ .../markup-samples/sisu_manual/en/sisu_markup.sst | 1417 ++++++++++++++++++++ .../sisu_manual/en/sisu_output_overview.sst | 160 +++ .../sisu_manual/en/sisu_postgresql.sst | 98 ++ .../sisu_manual/en/sisu_quickstart.sst | 272 ++++ .../markup-samples/sisu_manual/en/sisu_remote.sst | 106 ++ .../markup-samples/sisu_manual/en/sisu_search.ssm | 53 + .../sisu_manual/en/sisu_search_cgi.ssi | 99 ++ .../sisu_manual/en/sisu_search_intro.ssi | 52 + .../sisu_manual/en/sisu_short_feature_summary.ssi | 103 ++ .../v3/markup-samples/sisu_manual/en/sisu_skin.sst | 104 ++ .../v3/markup-samples/sisu_manual/en/sisu_sql.ssi | 68 + .../markup-samples/sisu_manual/en/sisu_sqlite.sst | 98 ++ .../sisu_manual/en/sisu_synopsis.ssi | 64 + .../sisu_manual/en/sisu_syntax_highlighting.sst | 169 +++ .../markup-samples/sisu_manual/en/sisu_webrick.sst | 93 ++ .../en/sisu_work_needed_and_wishlist.ssi | 78 ++ .../sisu/v3/markup-samples/sisu_manual/sisu.ssm | 103 -- .../markup-samples/sisu_manual/sisu_commands.sst | 365 ----- .../v3/markup-samples/sisu_manual/sisu_config.ssi | 80 -- .../sisu_manual/sisu_content_directories.ssi | 141 -- .../v3/markup-samples/sisu_manual/sisu_css.ssi | 63 - .../sisu_manual/sisu_description.sst | 564 -------- .../markup-samples/sisu_manual/sisu_download.ssi | 163 --- .../markup-samples/sisu_manual/sisu_examples.ssi | 54 - .../markup-samples/sisu_manual/sisu_examples.sst | 220 --- .../v3/markup-samples/sisu_manual/sisu_faq.sst | 221 --- .../markup-samples/sisu_manual/sisu_filetypes.sst | 170 --- .../v3/markup-samples/sisu_manual/sisu_help.sst | 131 -- .../sisu_manual/sisu_help_sources.sst | 180 --- .../markup-samples/sisu_manual/sisu_homepages.ssi | 87 -- .../v3/markup-samples/sisu_manual/sisu_how.ssi | 47 - .../v3/markup-samples/sisu_manual/sisu_howto.sst | 1406 ------------------- .../sisu_manual/sisu_hyperestraier.ssi | 115 -- .../sisu_manual/sisu_installation.ssi | 389 ------ .../sisu_manual/sisu_interesting_to_whom.ssi | 53 - .../sisu_manual/sisu_introduction.sst | 72 - .../v3/markup-samples/sisu_manual/sisu_manual.ssm | 118 -- .../v3/markup-samples/sisu_manual/sisu_markup.sst | 1417 -------------------- .../sisu_manual/sisu_output_overview.sst | 160 --- .../markup-samples/sisu_manual/sisu_postgresql.sst | 98 -- .../markup-samples/sisu_manual/sisu_quickstart.sst | 272 ---- .../v3/markup-samples/sisu_manual/sisu_remote.sst | 106 -- .../v3/markup-samples/sisu_manual/sisu_search.ssm | 53 - .../markup-samples/sisu_manual/sisu_search_cgi.ssi | 99 -- .../sisu_manual/sisu_search_intro.ssi | 52 - .../sisu_manual/sisu_short_feature_summary.ssi | 103 -- .../v3/markup-samples/sisu_manual/sisu_skin.sst | 104 -- .../v3/markup-samples/sisu_manual/sisu_sql.ssi | 68 - .../v3/markup-samples/sisu_manual/sisu_sqlite.sst | 98 -- .../markup-samples/sisu_manual/sisu_synopsis.ssi | 64 - .../sisu_manual/sisu_syntax_highlighting.sst | 169 --- .../v3/markup-samples/sisu_manual/sisu_webrick.sst | 93 -- .../sisu_manual/sisu_work_needed_and_wishlist.ssi | 78 -- 74 files changed, 7807 insertions(+), 7776 deletions(-) create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu.ssm create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_commands.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_config.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_content_directories.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_css.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_description.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_download.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_faq.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_filetypes.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help_sources.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_homepages.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_how.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_howto.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_hyperestraier.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_installation.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_introduction.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_manual.ssm create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_markup.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_output_overview.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_postgresql.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_quickstart.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_remote.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search.ssm create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_cgi.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_intro.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_skin.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sql.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sqlite.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_synopsis.ssi create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_webrick.sst create mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu.ssm delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_commands.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_config.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_content_directories.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_css.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_description.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_download.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_faq.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_filetypes.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help_sources.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_homepages.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_how.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_howto.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_hyperestraier.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_installation.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_introduction.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_manual.ssm delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_markup.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_output_overview.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_postgresql.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_quickstart.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_remote.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search.ssm delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_cgi.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_intro.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_short_feature_summary.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_skin.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sql.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sqlite.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_synopsis.ssi delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_syntax_highlighting.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_webrick.sst delete mode 100644 data/doc/sisu/v3/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi (limited to 'data/doc') diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu.ssm b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu.ssm new file mode 100644 index 00000000..47a029fa --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu.ssm @@ -0,0 +1,103 @@ +% SiSU master 3.0 + +@title: SiSU + :subtitle: Manual + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: manual + +@date: + :published: 2008-05-22 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v1 [operations] + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~ @title @creator + +:B~ What is SiSU? + +% << sisu_synopsis.ssi + +<< sisu_introduction.sst + +% :B~? SiSU Commands + +<< sisu_commands.sst + +<< sisu_help.sst + +% :B~? SiSU Markup + +<< sisu_markup.sst + +<< sisu_filetypes.sst + +% :B~? SiSU Configuration and Skins + +<< sisu_config.ssi + +<< sisu_skin.sst + +<< sisu_css.ssi + +<< sisu_content_directories.ssi + +<< sisu_homepages.ssi + +% :B~? SiSU Output and Markup Examples + +<< sisu_examples.ssi + +<< sisu_search_intro.ssi + +<< sisu_sql.ssi + +<< sisu_postgresql.sst + +<< sisu_sqlite.sst + +<< sisu_search_cgi.ssi + +<< sisu_hyperestraier.ssi + +<< sisu_webrick.sst + +<< sisu_remote.sst + +<< sisu_quickstart.sst + +<< sisu_syntax_highlighting.sst + +<< sisu_how.ssi + +<< sisu_short_feature_summary.ssi + +<< sisu_help_sources.sst diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_commands.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_commands.sst new file mode 100644 index 00000000..18620d1b --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_commands.sst @@ -0,0 +1,374 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Commands + +@creator: + :author: Amissah, Ralph + +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual SiSU.ssm + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Commands + +1~commands Commands Summary + +2~ Description + +SiSU SiSU is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu + +% 2~ Summary of man page + +% This man page covers a number of subjects in brief, including: document processing command flags; document markup (basic markup and headers); configuration files; directory structure; skins; document naming; interactive help and other information. + +2~ Document Processing Command Flags + +!_ -a [filename/wildcard]
+produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) + +!_ -b [filename/wildcard]
+see --xhtml + +!_ --color-toggle [filename/wildcard]
+screen toggle ansi screen colour on or off depending on default set (unless -c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined screen output will be without colour). Alias -c + +!_ --concordance [filename/wildcard]
+produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 words unless this limit is increased in the file sisurc.yml). Alias -w + +!_ -C [--init-site]
+configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). -C --init-site configure/initialise site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. + +!_ -CC
+configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). The equivalent of: -C --init-site configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if -CC is used. + +!_ -c [filename/wildcard]
+see --color-toggle + +!_ --dal [filename/wildcard/url]
+assumed for most other flags, creates new intermediate files for processing (document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m + +!_ --delete [filename/wildcard]
+see --zap + +!_ -D [instruction] [filename]
+see --pg + +!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename]
+see --sqlite + +!_ --epub [filename/wildcard]
+produces an epub document, [sisu version 2 only] (filename.epub). Alias -e + +!_ -e [filename/wildcard]
+see --epub + +!_ -F [--webserv=webrick]
+see --sample-search-form + +!_ --git [filename/wildcard]
+produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g + +!_ -g [filename/wildcard]
+see --git + +!_ --harvest *.ss[tm]
+makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, title, date, topic_register). Can be used with maintenance (-M) and remote placement (-R) flags. + +!_ --help [topic]
+provides help on the selected topic, where topics (keywords) include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql, features, license + +!_ --html [filename/wildcard]
+produces html output, segmented text with table of contents (toc.html and index.html) and the document in a single file (scroll.html). Alias -h + +!_ -h [filename/wildcard]
+see --html + +!_ -I [filename/wildcard]
+see --texinfo + +!_ -i [filename/wildcard]
+see --manpage + +!_ -L
+prints license information. + +!_ --machine [filename/wildcard/url]
+see --dal (document abstraction level/layer) + +!_ --maintenance [filename/wildcard/url]
+maintenance mode files created for processing preserved and their locations indicated. (also see -V). Alias -M + +!_ --manpage [filename/wildcard]
+produces man page of file, not suitable for all outputs. Alias -i + +!_ -M [filename/wildcard/url]
+see --maintenance + +!_ -m [filename/wildcard/url]
+see --dal (document abstraction level/layer) + +!_ --no-ocn
+[with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. + +!_ -N [filename/wildcard/url]
+document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). -NV for verbose digest output to screen. + +!_ -n [filename/wildcard/url]
+skip the creation of intermediate processing files (document abstraction) if they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags. + +!_ --odf [filename/wildcard/url]
+see --odt + +!_ --odt [filename/wildcard/url]
+output basic document in opendocument file format (opendocument.odt). Alias -o + +!_ -o [filename/wildcard/url]
+see --odt + +!_ --pdf [filename/wildcard]
+produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias -p + +!_ --pg [instruction] [filename]
+database postgresql ( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -D + +!_ --po [language_directory/filename language_directory]
+see --po4a + +!_ --po4a [language_directory/filename language_directory]
+produces .pot and po files for the file in the languages specified by the language directory. SiSU markup is placed in subdirectories named with the language code, e.g. en/ fr/ es/. The sisu config file must set the output directory structure to multilingual. v3, experimental + +!_ -P [language_directory/filename language_directory]
+see --po4a + +!_ -p [filename/wildcard]
+see --pdf + +!_ --quiet [filename/wildcard]
+quiet less output to screen. + +!_ -q [filename/wildcard]
+see --quiet + +!_ --rsync [filename/wildcard]
+copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see --scp. Alias -R + +!_ -R [filename/wildcard]
+see --rsync + +!_ -r [filename/wildcard]
+see --scp + +!_ --sample-search-form [--webserv=webrick]
+generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). -Fv (in addition to the above) provides some information on setting up hyperestraier for sisu. Alias -F + +!_ --scp [filename/wildcard]
+copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r + +!_ --sqlite --[instruction] [filename]
+database type default set to sqlite, (for which --sqlite may be used instead) or to specify another database --db-[pgsql, sqlite] (however see -D) possible instructions include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -d + +!_ --sisupod
+produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option is tested only with zsh). Alias -S + +!_ --sisupod [filename/wildcard]
+produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related images and skin. SiSU commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the -S option without [filename/wildcard]. Alias -S + +!_ --source [filename/wildcard]
+copies sisu markup file to output directory. Alias -s + +!_ -S
+see --sisupod + +!_ -S [filename/wildcard]
+see --sisupod + +!_ -s [filename/wildcard]
+see --source + +!_ --texinfo [filename/wildcard]
+produces texinfo and info file, (view with pinfo). Alias -I + +!_ --txt [filename/wildcard]
+produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t + +!_ -T [filename/wildcard (*.termsheet.rb)]
+standard form document builder, preprocessing feature + +!_ -t [filename/wildcard]
+see --txt + +!_ --urls [filename/wildcard]
+prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml. Alias -U + +!_ -U [filename/wildcard]
+see --urls + +!_ -u [filename/wildcard]
+provides url mapping of output files for the flags requested for processing, also see -U + +!_ --v1 [filename/wildcard]
+invokes the sisu v1 document parser/generator. For use with sisu v1 markup documents. (Markup conversion to v2 involves the modification of document headers) + +!_ --v2 [filename/wildcard]
+invokes the sisu v2 document parser/generator. This is the default and is normally omitted. + +!_ --verbose [filename/wildcard]
+provides verbose output of what is being generated, where output is placed (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests. Alias -v + +!_ -V
+on its own, provides SiSU version and environment information (sisu --help env) + +!_ -V [filename/wildcard]
+even more verbose than the -v flag. + +!_ -v
+on its own, provides SiSU version information + +!_ -v [filename/wildcard]
+see --verbose + +!_ --webrick
+starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the -h option rather than -H ; also, note -F webrick ]. Alias -W + +!_ -W
+see --webrick + +!_ --wordmap [filename/wildcard]
+see --concordance + +!_ -w [filename/wildcard]
+see --concordance + +!_ --xhtml [filename/wildcard]
+produces xhtml/XML output for browser viewing (sax parsing). Alias -b + +!_ --xml-dom [filename/wildcard]
+produces XML output with deep document structure, in the nature of dom. Alias -X + +!_ --xml-sax [filename/wildcard]
+produces XML output shallow structure (sax parsing). Alias -x + +!_ -X [filename/wildcard]
+see --xml-dom + +!_ -x [filename/wildcard]
+see --xml-sax + +!_ -Y [filename/wildcard]
+produces a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week]) + +!_ -y [filename/wildcard]
+produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. + +!_ --zap [filename/wildcard]
+Zap, if used with other processing flags deletes output files of the type about to be processed, prior to processing. If -Z is used as the lone processing related flag (or in conjunction with a combination of -[mMvVq]), will remove the related document output directory. Alias -Z + +!_ -Z [filename/wildcard]
+see --zap + +1~command_modifiers command line modifiers + +!_ --no-ocn
+[with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. + +!_ --no-annotate
+strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign + +!_ --no-asterisk
+strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign + +!_ --no-dagger
+strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign + +1~commands_database database commands + +dbi - database interface + +-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable with --db=[database type (pgsql or sqlite)] + +!_ --pg -v --createall
+initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) [ -dv --createall sqlite equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at the present time for postgresql it may be necessary to manually create the database. The command would be 'createdb [database name]' where database name would be SiSU_[present working directory name (without path)]. Please use only alphanumerics and underscores. + +!_ --pg -v --import
+[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] + +!_ --pg -v --update
+[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] + +!_ --pg --remove
+[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] + +!_ --pg --dropall
+kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] + +The -v is for verbose output. + +1~command_shorcuts Shortcuts, Shorthand for multiple flags + +!_ --update [filename/wildcard]
+Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous runs, only the -hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. + +!_ -0 to -5 [filename or wildcard]
+Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): + +!_ -0
+-mNhwpAobxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] + +!_ -1
+-mhewpy + +!_ -2
+-mhewpaoy + +!_ -3
+-mhewpAobxXyY + +!_ -4
+-mhewpAobxXDyY --import + +!_ -5
+-mhewpAobxXDyY --update + +add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] + +consider -u for appended url info or -v for verbose output + +2~ Command Line with Flags - Batch Processing + +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. + +Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_config.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_config.ssi new file mode 100644 index 00000000..274a056f --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_config.ssi @@ -0,0 +1,80 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Configuration + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? Configuration + +:B~? Configure Environment + +1~config Configuration + +2~ Determining the Current Configuration + +Information on the current configuration of SiSU should be available with the help command: + +_1 sisu -v + +which is an alias for: + +_1 sisu --help env + +Either of these should be executed from within a directory that contains sisu markup source documents. + +2~ Configuration files (config.yml) + +SiSU configration parameters are adjusted in the configuration file, which can be used to override the defaults set. This includes such things as which directory interim processing should be done in and where the generated output should be placed. + +The SiSU configuration file is a yaml file, which means indentation is significant. + +SiSU resource configuration is determined by looking at the following files if they exist: + +_1 ./_sisu/sisurc.yml + +_1 ~/.sisu/sisurc.yml + +_1 /etc/sisu/sisurc.yml + +The search is in the order listed, and the first one found is used. + +In the absence of instructions in any of these it falls back to the internal program defaults. + +Configuration determines the output and processing directories and the database access details. + +If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_content_directories.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_content_directories.ssi new file mode 100644 index 00000000..4c3a506a --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_content_directories.ssi @@ -0,0 +1,141 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Content Directories, Organising Content + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2007-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? Organisation of Content + +:B~? Content Directories + +1~organising_content Organising Content + +2~ Directory Structure and Mapping + +The output directory root can be set in the sisurc.yml file. Under the root, subdirectories are made for each directory in which a document set resides. If you have a directory named poems or conventions, that directory will be created under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) + +The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type within a directory identifying them. This grouping as suggested could be by subject (sales_law, english_literature); or just as conveniently by some other classification (X University). The mapping means it is also possible to place in the same output directory documents that are for organisational purposes kept separately, for example documents on a given subject of two different institutions may be kept in two different directories of the same name, under a directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. + +3~ General Directories + +code{ + +./subject_name/ + +% files stored at this level e.g. sisu_manual.sst + +./subject_name/_sisu + +% configuration file e.g. sisurc.yml + +./subject_name/_sisu/skin + +% skins in various skin directories doc, dir, site, yml + +./subject_name/_sisu/css + +./subject_name/_sisu/image + +% images for documents contained in this directory + +./subject_name/_sisu/mm + +}code + +3~ Remote Directories + +code{ + +./subject_name/ + +% containing sub_directories named after the generated files from which they are made + +./subject_name/src + +% contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip + +./subject_name/_sisu + +% configuration file e.g. sisurc.yml + +./subject_name/_sisu/skin + +% skins in various skin directories doc, dir, site, yml + +./subject_name/_sisu/css + +./subject_name/_sisu/image + +% images for documents contained in this directory + +./subject_name/_sisu/mm + +}code + +3~ Sisupod + +code{ + +./sisupod/ + +% files stored at this level e.g. sisu_manual.sst + +./sisupod/_sisu + +% configuration file e.g. sisurc.yml + +./sisupod/_sisu/skin + +% skins in various skin directories doc, dir, site, yml + +./sisupod/_sisu/css + +./sisupod/_sisu/image + +% images for documents contained in this directory + +./sisupod/_sisu/mm + +}code + +2~ Organising Content + + + +% .SH "SKINS \- document, directory and site skins" + + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_css.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_css.ssi new file mode 100644 index 00000000..2035b7c3 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_css.ssi @@ -0,0 +1,63 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: CSS - Cascading Style Sheets + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2007-08-28 + :issued: 2007-08-28 + :available: 2007-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? CSS + +1~css CSS - Cascading Style Sheets (for html, XHTML and XML) + +CSS files to modify the appearance of SiSU html, XHTML or XML may be placed in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories with the command sisu -CC. + +The basic CSS file for html output is html.css, placing a file of that name in directory _sisu/css or equivalent will result in the default file of that name being overwritten. + +HTML: +html.css + +XML DOM: +dom.css + +XML SAX: +sax.css + +XHTML: +xhtml.css + +The default homepage may use homepage.css or html.css + +Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS file that is looked for in a skin.~{ SiSU has worked this way in the past, though this was dropped as it was thought the complexity outweighed the flexibility, however, the balance was rather fine and this behaviour could be reinstated. }~ diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_description.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_description.sst new file mode 100644 index 00000000..e924c433 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_description.sst @@ -0,0 +1,564 @@ +% SiSU 3.0 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + :subtitle: Description + +@creator: :author: Amissah, Ralph + +@classify: + :type: information + :topic_register: electronic documents;SiSU:document:description;sisu:document:description + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% SiSU.ssm + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@date: + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :published: 2007-08-30 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu + :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|rant|utf-?8|WARNING/ + :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i + +@links: + {What does SiSU do? Summary}../SiSU/1.html#summary + {Book Samples and Markup Examples}../SiSU/examples.html + {SiSU Markup Syntax}../sample + {*Citation System* Object Citation Numbering}../SiSU/1.html#citation + {*Granular Search*}../SiSU/1.html#search + {The Chart (pdf)}../diagram/sisu.chart.pdf + {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf + {Standard}../SiSU/standard.html + {License}../SiSU/license.html + {man pages}../SiSU/3.html#man + {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ + {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html + {Download}../SiSU/download.html + {Changelog}../SiSU/changelog.html + +:A~? @title @creator + +:B~? SiSU an attempt to describe + +1~ Description + +2~ Outline + +SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html for information on this version. Dates related to the development of SiSU are mostly contained within the Chronology section of this document, e.g. http://www.jus.uio.no/sisu/sisu_chronology }~ + +SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),~{ also chosen for the meaning of the Finnish term "sisu". }~ is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search. + +Using markup applied to a document, SiSU can produce plain text, HTML, XHTML, XML, OpenDocument, EPUB, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity (e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. + +SiSU is the data/information structuring and transforming tool, that has resulted from work on one of the oldest law web projects. It makes possible the one time, simple human readable markup of documents, that SiSU can then publish in various forms, suitable for paper~{ pdf via LaTeX }~, web~{ currently html (two forms of html presentation one based on css the other on tables), and /PHP/; potentially structured XML }~ and relational database~{ any SQL - currently PostgreSQL and /sqlite/ (for portability, testing and development) }~ presentations, retaining common data-structure and meta-information across the output/presentation formats. Several requirements of legal and scholarly publication on the web have been addressed, including the age old need to be able to reliably cite/pinpoint text within a document, to easily make footnotes/endnotes, to allow for semantic document meta-tagging, and to keep required markup to a minimum. These and other features of interest are listed and described below. A few points are worth making early (and will be repeated a number of times): + +_1 (i) The SiSU document generator was the first to place material on the web with a system that makes possible citation across different document types, with paragraph, or rather object citation numbering~{ previously called "text object numbering" }~ a text positioning system, available for the pinpointing of text, 1997, a simple idea from which much benefit, and SiSU remains today, to the best of my knowledge, the only multiple format e-book/ electronic-document system on the web that gives you this possibility (including for relational databases). + +_1 (ii) Markup is done once for the multiple formats produced. + +_1 (iii) Markup is simple, and human readable (with a little practice), in almost all cases there is less and simpler markup required than basic html. In any event the markup required is very much simpler than the html, EPUB, LaTeX, [lout], structured XML, ODF (OpenDocument), PostgreSQL or SQLite feed etc. that you can have SiSU generate for you. + +_1 (iv) SiSU is a batch processor, dealing with as many files as you need to generate at a time. + +_1 (v) Scalability is dependent on your file system (in my case Reiserfs), the database (currently Postgresql and/or SQLite) and your hardware. + +SiSU Sabaki~{ SiSU Sabaki, release version. Pre-release version SiSU Scribe, and version prior to that SiSU nicknamed Scribbler. Pre-release versions go back several years. Both Scribbler and Scribe (still maintained) made system calls to SiSU's various parts, instead of using libraries. }~ (or just SiSU) is the provisional name given to the software described here that helps structure documents for web and other publication. The name SiSU is a loose anagram for something along the lines of *{/{"SiSU is structuring unit"}/}*, or /{"SiSU, information structuring unit"}/ or the more descriptive /{"Structured information, Serialized Units"}/ or *{/{"simple - information structuring unit"}/}* or the more descriptive /{"Structured information, Serialized Units"}/ or what it may be directed towards /{"*semantic* and *{information structuring universe}*"}/,~{ A little universe it may be, but semantic you may have a hard time getting away with, given the meaning the word has taken on with markup. On a document wide basis semantic information may be provided, which can be really useful, (and meaningful, especially) if you have a large document set, and use this with rss feeds or in an sql database etc. On a markup level, I have little inclination to add semantic markup formally beyond references, title, author [Dublin Core entities? addresses?] etc. Actually this deserves a bit of thought possibly use letter tags (including letter alias/synonyms for font faces) to create a small set of default semantic tags, with the possibility for per document adjustments. Will seek to permit XML entity tagging, within SiSU markup and have that ignored/removed by the parts of the program that have no use for it. }~ tongue in cheek, only just. Guess I'll get away with *{/{"Simple - information Structuring Universe"}/}*. SiSU is also a Finnish word roughly meaning guts, inner strength and perseverance.~{ "Sisu refers not to the courage of optimism, but to a concept of life that says, 'I may not win, but I will gladly give my life for what I believe.'" Aini Rajanen, Of Finnish Ways, 1981, p. 10.
http://www.humanlanguages.com/finnishenglish/rlfs.htm
"Every Finn has his own pet definition. To me, sisu means patience without passion. But there are many varieties of sisu. Sisu can be a sudden outburst or it can be the kind that lasts. A man can have both kinds. It is outside reason. It is something in the soul. It comes from oneself. For instance, it makes a soldier do things because he himself must, not because he has been told." Paavo Nurmi
http://personalweb.smcvt.edu/tmatikainen/finnishtraditions.htm }~ + +SiSU was born of the need to find a way, with minimal effort, and for as wide a range of document types as possible, to produce high quality publishing output in a variety of document formats. As such it was necessary to find a simple document representation that would work across a large number of document types, and the most convenient way(s) to produce acceptable output formats. The project leading to this program was started in 1993 (together with the trade law project now known as Lex Mercatoria) as an investigation of how to effectively/efficiently place documents on the web. The unified document handling, together with features such as paragraph numbering, endnote handling and tables... appeared in 1996/97. SiSU was originally written in Perl,~{ http://www.perl.org/ }~ and converted to Ruby,~{ http://www.ruby-lang.org/en/ }~ in 2000, one of the most impressive programming languages in existence! In its current form it has been written to run on the Gnu/Linux platform, and in particular on Debian,~{ http://www.debian.org/ }~ taking advantage of many of the wonderful projects that are available there. + +SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), EPUB, XML (in this case, structural representation), ODF (OpenDocument [experimental]), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ + +From markup that is simpler and more sparse than html you get: + +_* far greater output possibilities, including html, EPUB, XML, ODF (OpenDocument), LaTeX (pdf), and SQL; + +_* the advantages implicit in the very different output possibilities; + +_* a common citation system (for all outputs - including the relational database, search results are relevant for all outputs); + +For more see the short summary of features provided below. + +SiSU processes files with minimal tagging to produce various document outputs including html, EPUB, ODF, LaTeX (which is converted to pdf) and if required loads the structured information into an SQL database (PostgreSQL and SQLite have been used for this). SiSU produces an intermediate processing format.~{ This proved to be the easiest way to develop syntax, changes could be made, or alternatives provided for the markup syntax whilst the intermediate markup syntax was largely held constant. There is actually an optional second intermediate markup format in YAML http://www.yaml.org/ }~ + +SiSU is used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). + +2~ Short summary of features *~summary + +!_ (i) +markup syntax: (a) simpler than html, (b) mnemonic, influenced by mail/messaging/wiki markup practices, (c) human readable, and easily writable, + +!_ (ii) +(a) minimal markup requirement, (b) single file marked up for multiple outputs, + +notes: + +* documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. + +* markup is easily readable/parsed by the human eye, (basic markup is simpler and more sparse than the most basic html), [this may also be converted to XML representations of the same input/source document]. + +* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. + +!_ (iii) +(a) multiple outputs primarily industry established and institutionally accepted open standard formats, include amongst others: plaintext (UTF-8); html; EPUB; (structured) XML; ODF (Open Document text)l; LaTeX; PDF (via LaTeX); SQL type databases (currently PostgreSQL and SQLite). Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) + +!_ (iv) +outputs share a common numbering system (dubbed "object citation numbering" (ocn)) that is meaningful (to man and machine) across various digital outputs whether paper, screen, or database oriented, (PDF, html, EPUB, XML, Opendocument, sqlite, postgresql), this numbering system can be used to reference content. + +!_ (v) +SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperesteier]. + +!_ (vi) +use of semantic meta-tags in headers permit the addition of semantic information on documents, (the available fields are easily extended) + +!_ (vii) +creates organised directory/file structure for (file-system) output, easily mapped with its clearly defined structure, with all text objects numbered, you know in advance where in each document output type, a bit of text will be found (e.g. from an SQL search, you know where to go to find the prepared html output or PDF etc.)... there is more; easy directory management and document associations, the document preparation (sub-)directory may be used to determine output (sub-)directory, the skin used, and the SQL database used, + +!_ (viii) +"Concordance file" wordmap, consisting of all the words in a document and their (text/ object) locations within the text, (and the possibility of adding vocabularies), + +!_ (ix) +document content certification and comparison considerations: the document and each object within it stamped with an md5 hash making it possible to easily check or guarantee that the substantive content of a document is unchanged. + +!_ (x) +SiSU's minimalist markup makes for meaningful "diffing" of the substantive content of markup-files, + +!_ (xi) +easily skinnable, document appearance on a project/site wide, directory wide, or document instance level easily controlled/changed, + +!_ (xii) +in many cases a regular expression may be used (once in the document header) to define all or part of a documents structure obviating or reducing the need to provide structural markup within the document, + +!_ (xiii) +prepared files may be batch process, documents produced are static files so this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) + +!_ (xiv) +possible to pre-process, which permits: the easy creation of standard form documents, and templates/term-sheets, or; building of composite documents (master documents) from other sisu marked up documents, or marked up parts, i.e. import documents or parts of text into a main document should this be desired + +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. + +!_ (xv) +there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added: (a) modular, (thanks in no small part to Ruby) another output format required, write another module.... (b) easy to update output formats (eg html, XHTML, EPUB, LaTeX/PDF produced can be updated in program and run against whole document set), (c) easy to add, modify, or have alternative syntax rules for input, should you need to, + +!_ (xvi) +scalability, dependent on your file-system (ext3, Reiserfs, XFS, whatever) and on the relational database used (currently Postgresql and SQLite), and your hardware, + +!_ (xvii) +only marked up files need be backed up, to secure the larger document set produced, + +!_ (xviii) +document management, + +!_ (xix) +Syntax highlighting for SiSU markup is available for a number of text editors. + +!_ (xx) +remote operations: (a) run SiSU on a remote server, (having prepared sisu markup documents locally or on that server, i.e. this solution where sisu is installed on the remote server, would work whatever type of machine you chose to prepare your markup documents on), (b) generated document outputs may be posted by sisu to remote sites (using rsync/scp) (c)document source (plaintext utf-8) if shared on the net may be identified by its url and processed locally to produce the different document outputs. + +!_ (xxi) +document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs, these may be downloaded, shared as email attachments, or processed by running sisu against them, either using a url or the filename. + +!_ (xxii) +for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, html, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to PDF, a LaTeX processor like tetex or texlive. + +as a developers tool it is flexible and extensible + +SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time. + +SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored. + +Some modules are more mature than others, the most mature being html and LaTeX / pdf. PostgreSQL and search functions are useable and together with /ocn/ unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept. + +2~ How it works + +SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within text which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the instruction header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). + +2~ Simple markup + +SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), EPUB, XML (in this case, structural representation), ODF (OpenDocument), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ + +3~ Sparse markup requirement, try to get the most out of markup + +One of its strengths is that very small amounts of initial tagging is required for the program to generate its output. + +This is a basic markup example: + +_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ + +_* { view basic markup, as it would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html ~{ http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html as it would appear with syntax highlighting (by vim) }~ + +Emphasis has been on simplicity and minimalism in markup requirements. Design philosophy is to try keep the amount of markup required low, for whatever has been determined to be acceptable output.~{ seems there are several "smart ASCIIs" available, primarily for ascii to html conversion, that make this, and reasonable looking ascii their goal
http://webseitz.fluxent.com/wiki/SmartAscii
http://daringfireball.net/projects/markdown/
http://www.textism.com/tools/textile/ }~ + +SiSU's markup is more minimalistic and simpler than (the equivalent) html and for it, you get considerably more than just html, as this preparation gives you all available output formats, upon request. + +3~ Single markup file provides multiple output formats + +For each document, there is only one (input, minimalistically marked up) file from which all the available output types are generated.~{ These include richly laid out and linked html (table or css variants), /PHP/, LaTeX (from which pdf portrait and landscape documents are produced), texinfo (for info files etc.), and PostgreSQL and/or SQLite. And the opportunity to fairly easily build additional modules, such as XML. See the examples provided in this document. }~ + +Eg. the markup example: + +_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst + +_* {~^ view as syntax would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html + +Produces the following output: + +_* {~^ Segmented html version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html + +_* {~^ Full length html document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/doc.html + +_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.pdf + +_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.pdf + +_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt + +_* {~^ /xml/ sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml + +_* {~^ /xml/ dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml + +_* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/concordance.html + +(and in addition to these: PostgreSQL, SQLite, texinfo and -{YAML}- ~{ discontinued for the time being }~ versions if desired) + +3~ Syntax relatively easy to read and remember + +Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup_table/doc.html#h200306
Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ + +3~ Kept simple by having a limited publishing feature set, and features identified as most important, are available across several document types + +To keep SiSU markup sparse and simple SiSU deliberately provides a limited publishing feature set, including: indent levels; bold; italics; superscript; subscript; simple tables; images; tables of contents and; endnotes. Which in most cases are available across the different output formats. + +The publishing feature set may be expanded as required. + +2~ Designed with usability in mind + +Output is designed to be uniform, easy to read, navigate and cite. + +2~ Code separate from content + +Code~{ the program that generates the documents }~ is separated from content. This means that when changes are desired in the output presentation, the code that produces them, and not the marked up text data set (which could be thousands of documents) is modified. Separating code from content makes large scale changes to output appearance trivial, and permits the easy addition of new output modules. + +2~ Object citation numbering, a text or object positioning / citation system - "paragraph" (or text object) numbering, that remains same and usable across all output formats by people and machine *~citation *~ocn + +Object citation numbering is a simple object (text) positioning and cition system that is human relevant and machine useable, used by SiSU for all manner of presentations, and that is available for use in all text mappings. It is based on the automated sequential numbering of objects (roughly paragraphs, (headings, tables, verse) or other blocks of text or images etc.). The text positioning system (in which I claim copyright) is invaluable for publishing requiring the citing text across multiple output formats, and for the general mapping of text within a document: + +_* in html, html not being easily citeable (change font size, or use a different browser and the page on which specific text appears has changed), and + +_* across multiple formats being common to all output formats html/xml/pdf/sql output, + +_* the results of an sql search can just be "live" citation references to the documents in which the text is found, {~^ much like an index (see image examples provided). }http://www.jus.uio.no/sisu/SiSU/1.html#search + +I claim copyright on the system I use which is the most basic of all, numbering all text in headings and paragraphs sequentially (with tables and images being treated as a single paragraph) and only footnotes/endnotes not following this numbering, as their position in text is not strictly determined, (a change from footnotes to endnotes would change their numbering), footnotes instead "belong" to the paragraph from which they are referenced, and have sequential numbers of their own. + +SiSU has a paragraph numbering system, that remains the same regardless of the output format. This provides an effective means of citation, pinpointing text accurately in all output formats, using the same reference. This is particularly useful where text has to be located across different output formats - for example once html is printed the number of pages and pages on which given text is found will vary depending on the browser, its settings the font size setting etc. Similarly SiSU produces pdf in different forms, eg. on the example site Lex Mercatoria as portrait and landscape documents - here too page numbering varies, but paragraph numbering is the same, /{vis a vis}/ all versions of the text (portrait and landscape pdf and the html versions of the text, and as stored (with "paragraphs" as records) to the PostgreSQL or SQLite database). + +These numbers are placed in the text margins and are intended to be independent of and not to interfere with authors tagging. [The citation system (object citation numbering system, automated "paragraph numbering") which is automatically generated and is common and identical across all document formats] The paragraph numbering system is more accurately described as an (text) object numbering system, as headings are also numbered... all headings and paragraphs are numbered sequentially. Endnotes are automatically numbered independently and rather "belong" to the paragraph from which they are referenced, as an endnote does not (necessarily) form a part of a documents sequence, (they may be produced as either endnotes or footnotes (or both depending on what output you choose to look at - if you take the segmented html version document provided as an example, you will find that the endnotes are placed both at the end of each section, and in a separate section of their own called endnotes, and these are hyper-linked)). An attractive feature of providing citation numbering in this way is that it is independent of the document structure... it remains the same regardless of what is done about the document structure. + +The rules have been kept very simple, unique incremental object citation numbers are assigned to headings, paragraphs, verse, tables and images. It is possible to manually override this feature on a per heading or comment basis though this should be used exceptionally, it may be of use where there a substantive text, and the addition of a minor comment by the publisher that should not be mapped as part of the text. + +The object citation number markers contain additional numbering information with regard to the document structure, that can be used for alternative presentations, including such detail as the type of object (heading, paragraph, table, image, etc.), numbered sequentially. + +An advantage is that the numbering remains the same regardless of document structure. + +Text object ("paragraph") numbering is the same for all output versions of the same document, vis html, epub, pdf, pgsql, etc. + +In the relational database, as individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, the results of searches may be tailored just to provide the location of the search result in all available document formats. + +/{ Note: there is a bug in the released behaviour of object citation numbering, (not certain when it was introduced) tables should be numbered, ie each table gets an ocn, required amongst other things for relational database. This will be corrected in a future release. Citation numbering of existing documents that contain tables will changed. }/ + +2~ Handling of Dublin Core meta-tags making use of the Resource Description Framework + +SiSU is able to use meta tags based on the Dublin Core~{ http://dublincore.org/ }~ and Resource Description Framework~{ http://www.w3.org/RDF/ }~ + +This provides the means of providing semantic information about a document, both as computer processable meta-tags, and as human readable information that may be of value for classification purposes. + +This information is provided both in html metatags, and (where available) under the section titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html + +2~ Easy directory management + +#1 Directory file association, skins and special image management, made simpler.~{ The previous way was directory associations for file output were set up in the configuration file. The present system is a more natural way to work requireing less configuration. }~ + +The last part of the name of the work directory in which markup is being done, or rather from where SiSU is run in order to generate document output, is used in determining the sub-directory name for output files, that is created in the document output directory. This provides a rather easy way to associate documents e.g. of a given subject, or by owner. + +code{ + +/www/docs + /intellectual_property + /arbitration + /contract_law + +/www/docs + /ralph + /sisu + +}code + +all are placed in their own directories within the directory structure created. Similar rules are used in the creation of sql type databases (though they can be overridden). + +There are a couple of further associations with these directories. + +Directory wide skins. + +Directory specific images. + +# If there is a "directory skin", that is a skin of the same name as the directory, it is used in the generation of the documents within it, rather than the default skin, unless the document has a specific skin associated with it. + +_# default skin (always available) + +_# directory skin (precedence over default if exists) + +_# document skin (takes precedence wherever document requests a specific skin) + +Skins are defined in the document skin directory and if a directory association is desired a softlink made to the relevant skin. Skins (directory association auto load) auto load skin if a directory skin exists of same name as directory stub, (and there is no specific doc skin) + +# If the working directory has within it a sub-directory called image_local, the images within that directory are used for references to images, that are not part of the default site build. + +2~ Document Version Control Information + +The possibility of citing an exact document version. + +Permits the inclusion of document version control information to the document body and metatags.~{ from a version control system such as CVS }~ This provides a much more certain method of referring to the exact version of a particular document, (assuming that the document is from a trusted source, that will retain earlier versions of a document).~{ The version control system must be run, so the version number is obtained, prior to the SiSU document generation, and subsequent posting of the document. }~ + +This information (where available) is provided under the section of the document titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html + +2~ Table of contents + +SiSU produces a rudimentary a table of contents based on document headings. + +2~ Auto-numbering of headings + +Headings can be automatically numbered, (and automatically named for hyper-linking) + +2~ Numbering and cross-hyperlinking of endnotes + +SiSU can automatically number footnotes/endnotes. This is the default operation where no number is provided. + +Footnotes/endnotes may also be manually numbered. Where a number, or numbers are provided for a footnote/endnote, this does not increment the automatic footnote/endnote number counter. + +In the html output footnotes/endnotes are cross-hyper-linked (to their reference point and vice versa). In th pdf output footnotes are linked from their reference point only. + +2~ "Skinnable" + +SiSU is skinnable, on a site-wide, directory-wide and per document basis, so different looking versions of things may be produced with little difficulty. There is a default skin which may be modified, as the background site skin, and each working directory may have a skin associated with it, as may each individual document. The hierarchy of application is document, directory, then site... ie if a document skin exists it gets precedence. + +Whilst it is skinnable, the default output styles are selected to work across the widest possible range of document types. + +2~ Multiple Outputs + +From markup that is simpler and more sparse than html you get: + +_* far greater output possibilities, including multiple html types, XML (different structured types), LaTeX (pdf landscape, portrait), and SQL (Postgresql or SQLite or other); + +_* the advantages implicit in these very different output possibilities;~{ e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), SQL (e.g. document set searches; representation of the constituent parts of documents based on their structure, headings, chapters, paragraphs as desired; control of use) }~ + +_* a common citation system + +As many output formats/presentations as one cares to write modules for - several types of html (e.g. structure based on css, or structure based on tables); /{LaTeX/pdf}/ and /{Lout/pdf}/; pgsql other databases easily added; yaml... + +3~ html - several presentations: full length & segmented; css & table based + +Most documents are produced in single and segmented html versions, described below: + +!_ The Scroll (full length text presentations) + +The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un_contracts_international_sale_of_goods_convention_1980/doc
The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc or
The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ + +For various reasons texts may only be provided in this form (such as this one which is short), though most are also provided as segmented texts. + +"Scroll" is a reference to the historical scroll, a single long document/ parchment, and also no doubt to what you will have to do to get to the bottom of the text.~{ Scrolling is not however necessarily confined to full length documents as you will have to scroll to get to the bottom of any long segment (eg. chapter) of a segmented text. }~ + +!_ The Segmented Text + +The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980
The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994
The Autonomous Contract http://www.jus.uio.no/sisu/the.autonomous.contract.2000.amissah or
WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ + +If you know exactly what you are looking for, loading a segment of text is faster (the segments being smaller). Occasionally longer documents such as the WTA 1994 http://www.jus.uio.no/lm/wta.1994/toc are only provided in segmented form. + +!_ Cascading Style Sheet, and Table based html + +SiSU outputs html, two current standard forms available are: + +{ css based }http://www.jus.uio.no/sisu/SiSU/toc.html + +and + +table based [largely discontinued]~{ formatting possibility still exists in code tree but maintenance has been largely discontinuted. }~ + +!_ The html is tested across several browsers + +I like to remind you that there are other excellent browsers out there, many of which have long supported practical features like tabbing. + +The html is tested across several browsers, including: + +_* {~^ *Firefox* (Mozilla-Firefox) }http://www.mozilla.org/products/firefox/ + +_* {~^ Kazehakase }http://kazehakase.sourceforge.jp/ + +_* {~^ Konqueror }http://www.konqueror.org/ + +_* {~^ Mozilla }http://www.mozilla.org/ + +_* {~^ MS Internet Explorer }http://www.microsoft.com/windows/ie/default.asp + +_* {~^ Netscape }http://home.netscape.com/comprod/mirror/client_download.html + +_* {~^ Opera }http://www.opera.com/ + +Also lighter weight graphical browsers: + +_* {~^ Dillo }http://www.dillo.org/ + +_* {~^ *Epiphany* }http://www.gnome.org/projects/epiphany/ + +_* {~^ *Galeon* }http://galeon.sourceforge.net/ + +And for console/text browsing: + +_* {~^ *elinks* }http://elinks.or.cz/ + +_* {~^ *links2* }http://links.twibright.com/ + +_* {~^ *w3m* }http://w3m.sourceforge.net/ + +The html tables output is rendered more accurately across a wider variety set and older versions of browsers (than the html css output). + +3~ EPUB + +SiSU generates EPUB documents. + +3~ XML + +SiSU generates well formed XML, and multiple versions. An XML SAX version with a flat/shallow structure, and XML DOM version with a deeper (embedded) structure. There is also a released working xhtml module. Examples of SAX and DOM versions are provided within this document. + +3~ ODT:ODF, Open Document Format - ISO/IEC 26300:2006 + +SiSU generates Open Document Output format. + +3~ PDF - portrait and landscape, (through the generation of LaTeX output which is then transformed to pdf) + +SiSU outputs LaTeX if required which is easily transformed to PDF.~{ LaTeX and pdf features introduced 18^th^ June 2001, Landscape and portrait pdfs introduced 7^th^ October 2001., Lout is a more recent addition 22^th^ April 2003 }~ PDF documents are generated on the site from the same source files and Ruby program that produce html. Landscape oriented pdf introduced, providing easier screen viewing, they are also (paper saving, being currently) formatted to have fewer pages than their portrait equivalents. + +_* {~^ Adobe Reader }http://www.adobe.com/products/acrobat/readstep2.html + +_* {~^ *Evince* }http://www.gnome.org/projects/evince/ + +_* {~^ xpdf }http://www.foolabs.com/xpdf/ + +3~ Search - loading/populating of relational database while retaining document structure information, object citation numbering and other features (currently PostgreSQL and/or SQLite) + +SiSU (from the same markup input file) automatically feeds into PostgreSQL~{ http://www.postgresql.org/
http://advocacy.postgresql.org/
http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/
http://en.wikipedia.org/wiki/Sqlite }~ database (could be any other of the better relational databases)~{ Relational database features retaining document structure and citation introduced 15^th^ July 2002 }~ - together with all additional information related to document structure, and the alternative ways in which it is generated on the site retained. As regards scaling of the database, it is as scalable as the database (here Postgresql or SQLite) and hardware allow. I will prune the images later. + +This is one of the more interesting output forms, as all the structural data for the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four pgsql database tables: + +_1* one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); + +_1* another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and + +_1* a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). + +_1* a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. + +There is of course the possibility to add further structures. + +At this level SiSU loads a relational database with documents broken in to their smallest logical structurally constituent parts, as text objects, with their object citation number and all other structural information needed to construct the structured document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. + +Because the document structure of sites created is clearly defined, and the text object citation system is available for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. + +The combination of the SiSU citation system with a relational database is pretty powerful, giving rise to several possibilities. As individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, complex searches can be tailored to return just the locations of the search results relevant for all available output formats, with live links to the precise locations in the database or in html/xml documents; or, the structural information provided makes it possible to search the full contents of the database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well). + +This is a larger scale project, (with little development on the front end largely ignored), though the "infrastructure" has been in place since 2002. + +3~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search + +{~^ Sample search frontend }http://search.sisudoc.org +A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. }~ + +SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, EPUB, XML, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. + +(further work needs to be done on the sample search form, which is rudimentary and only passes simple booleans correctly at present to the SQL engine) + +A few canned searches, showing object numbers. Search for: + +{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 + +{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 + +{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 + +{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 + +Note that the searches done in this form are case sensitive. + +Expand those same searches, showing the matching text in each document: + +{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 + +{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 + +{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 + +{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 + +Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ + +!_ OCN index mode, +(object citation number) the numbers displayed are relevant (and may be used to reference the match) in any sisu generated rendition of the text~{ OCN are provided for HTML, XML, EPUB, pdf ... though currently omitted in plain-text and opendocument format output }~ the links provided are to the locations of matches within the html generated by SiSU. + +!_ Paragraph mode, +you may alternatively display the text of each paragraph in which the match was made, again the object/paragraph numbers are relevant to any SiSU generated/published text. + +Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. + +Simple search, results with files in which search found, and text object (paragraph or endnote) where found within files. + +3~ Other forms + +There are other forms as well, YAML file, Ruby Marshal dumps, document pre-processing (processing of documents prior to the steps described here, to produce input suitable for the program) snap in a new module as required/desired, well formed XML, no problem. + +2~ Concordance / Word Map or rudimentary index + +Concordance /WordMaps:~{ Concordance/ WordMaps introduced 15^th^ August 2002 }~ SiSU produces a rudimentary index based on the words within the text, making use of paragraph numbers to identify text locations. This is generated in html and hyper-linked but identifies these words locations in the other document formats. Though it is possible to search using a search engine, this is a means for browsing an alphabetical list of words which may suggest other useful content. + +% Concordance files may be built using a document vocabulary. The vocabulary to be used may be specified on a per document basis. + +2~ Managed (document) directory, database, or site structure + +SiSU builds the web site (or more generically provides a suitable directory structure) - placing various output texts in the hierarchy of the web-site (or db), which (for directories) is a sub-directory with the name of the text file. + +2~ Batch processing + +SiSU is a batch processing tool, handling and transforming multiple (or individual) documents (in many ways) with a single instruction. + +2~ Integration to superior Gnu/Linux and Unix tools + +As should have been noted by the above description of SiSU, it makes use of existing programs found on Gnu/Linux and Unix, amongst those already mentioned include the LaTeX to pdf converters and the database PostgreSQL or SQLite. + +3~ Backup and version control + +Unix provides many tools for version control. For documents Subversion, CVS and even the old RCS are useful for the per-document histories they provide. + +For writing code superior (more recent) version control system exist. These can also be used for documents though they tend to take stamps of changes across the repository as a whole, rather than for each individual file that is tracked, (as CVS and RCS do). My personal preference is for distributed systems such as Git, Mercurial or Darcs, of which I use Git for both code and documents. + +Several backup tools exist. At the base level I tend to use rdiff. + +3~ Editor support + +SiSU documents are prepared / marked up in utf-8 text _{you are free to use the text editor of your choice.}_ + +Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.jus.uio.no/sisu/syntax_highlight. {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. + +2~ Modular design, need something new add a module + +Need a new output format that does not already exist, write a new module. + +Prefer a new input syntax, you could write a new syntax matching the existing design, though my personal preference is some uniformity in entry appearance. If necessary has been fairly easy to extend the design parameters. It is intended to incorporate some additional basic semantic tagging, (book, article, author etc.) However, keeping the requirements for input minimal, and relatively simple has been a design goal. + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_download.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_download.ssi new file mode 100644 index 00000000..2d5c6508 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_download.ssi @@ -0,0 +1,163 @@ +% SiSU insert 3.0 + +@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units + :subtitle: Download, Stable and Development Branches + +@creator: :author: Amissah, Ralph + +% used_by: SiSU.ssm + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :published: 2009-01-18 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu + :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|atomic search|rant|utf-?8|UTF-?8|WARNING/ + :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|atomic search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i + +@links: + {What does SiSU do? Summary}../SiSU/1.html#summary + { Book Samples and Markup Examples }../SiSU/examples.html + {SiSU Markup Syntax}../sample + {*Citation System* Object Citation Numbering}../SiSU/1.html#citation + {*Granular Search*}../SiSU/1.html#search + {The Chart (pdf)}../diagram/sisu.chart.pdf + {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf + {Standard}../SiSU/standard.html + {License}../SiSU/license.html + {man pages}../SiSU/3.html#man + {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ + {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html + {Download}../SiSU/download.html + {Changelog}../SiSU/changelog.html + +:A~? @title @creator + +:B~? SiSU Downloads, Stable and Development Branches + +:C~ Download information + +1~download Download SiSU - Linux/Unix + +2~current- SiSU Current Version - Linux/Unix + +3~source- Source (tarball tar.gz) + +_* {~^ sisu_2.5.1.orig.tar.gz (2010-06-12:23/6) }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1.orig.tar.gz + +_* {~^ sisu-markup-samples_2.0.3.orig.tar.gz (of 2010-05-01:17/6 ) }http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_2.0.3.orig.tar.gz *~sisu-markup-samples + +For installation notes see http://sisudoc.org/sisu/sisu_manual/installation.html + +For more general use see http://sisudoc.org/sisu/sisu_manual + +For changelogs see http://www.jus.uio.no/sisu/SiSU/changelog.html + +3~git- Git (source control management) + +Git repository currently at: + +_* git clone git://git.sisudoc.org/git/code/sisu.git + +_* git clone _http://git.sisudoc.org/git/code/sisu.git + +_* http://git.sisudoc.org/?p=code/sisu.git;a=summary + +On using git, see + +!_ Git documentation: +{~^ Git User's Manual }http://www.kernel.org/pub/software/scm/git/docs/user-manual.html, {~^ Everyday GIT With 20 Commands Or So }http://www.kernel.org/pub/software/scm/git/docs/everyday.html, {~^ A tutorial introduction to git }http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial.html, {~^ A tutorial introduction to git: part two }http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial-2.html + +!_ User contributed texts: +{~^ The Git Community Book }http://book.git-scm.com/index.html, {~^ Git Magic }http://www-cs-students.stanford.edu/~blynn/gitmagic/, {~^ Git From the Bottom Up (pdf) }http://www.newartisans.com/blog_assets/git.from.bottom.up.pdf + +3~debian- Debian + +This section contains information on the latest SiSU release. For installation notes see http://sisudoc.org/sisu/sisu_manual/installation.html + +SiSU is updated fairly regularly in Debian testing and unstable, and should be available therefrom. + +To add this archive, should you still choose to do so, add the following lines to your /etc/apt/sources.list + +code{ + +deb http://www.jus.uio.no/sisu/archive unstable main non-free +deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +group{ + +*{Source}* + +{~^ sisu_2.5.1.orig.tar.gz }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1.orig.tar.gz + +{~^ sisu_2.5.1-1.diff.gz }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1-1.diff.gz + +{~^ sisu_2.5.1-1.dsc }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1-1.dsc + +}group + +group{ + +*{Debs}* + +{~^ sisu_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_2.5.1-1_all.deb ~{
sisu, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies
Depends: ruby (>=1.8.2), libwebrick-ruby
Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, vim-sisu, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl }~ + +{~^ sisu-complete_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-complete_2.5.1-1_all.deb ~{
a package that pulls in other packages to build the whole of sisu (excluding sisu-examples)
Depends: ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite, vim-sisu
Recommends: sisu-examples }~ + +{~^ sisu-pdf_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-pdf_2.5.1-1_all.deb ~{
dependencies used by sisu to produce pdf from LaTeX generated
Depends: sisu, tetex-bin, tetex-extra, latex-ucs
Suggests: evince, xpdf }~ + +{~^ sisu-postgresql_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-postgresql_2.5.1-1_all.deb ~{
dependencies used by sisu to populate postgresql database (further configuration is necessary)
Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 }~ + +{~^ sisu-sqlite_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-sqlite_2.5.1-1_all.deb ~{
dependencies used by sisu to populate sqlite database
Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
Suggests: libdbd-sqlite }~ + +}group + +For changelogs see: + +_1 http://www.jus.uio.no/sisu/SiSU/changelog.html + +_1 http://www.jus.uio.no/sisu/sisu_changelog/changelog.html + +!_ non-free + +Book markup samples have been moved to non-free as the substantive text of the documents are available under the author or original publisher's license, and usually do not comply with the Debian Free Software Guidelines. + +_* {~^ sisu-markup-samples_2.0.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_2.0.3-1_all.deb ~{
marked up documents and other examples related to sisu, a larger package containing a number of texts
Depends: sisu }~ + +_* {~^ sisu-markup-samples_2.0.3-1.dsc }http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_2.0.3-1.dsc ~{
sisu-markup-samples_2.0.3-1.dsc }~ + +For changelogs see: + +_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html + +_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html + +3~rpm- RPM + +The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. + +sudo rpm -i [package name] + +_* {~^ sisu-2.5.1-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu-2.5.1-2.noarch.rpm ~{
created using alien }~ + +_* {~^ sisu-markup-samples_2.0.3.orig-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu-markup-samples_2.0.3.orig-2.noarch.rpm ~{
http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_2.0.3-1_all.deb
created using: alien -r sisu_0.70.5-1_all.deb }~ + +For changelogs see: + +_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html + +_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.ssi new file mode 100644 index 00000000..1188b109 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.ssi @@ -0,0 +1,54 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Markup Samples, Output Examples + +@creator: :author: Amissah, Ralph + +@classify: + :type: information + :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: SiSU.ssm + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@date: + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual +% :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + {Book Samples and Markup Examples}../SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Markup and Output Examples + +1~examples Markup and Output Examples + +2~ Markup examples *~markup + +Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html + +Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. + +For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.sst new file mode 100644 index 00000000..491f96a4 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_examples.sst @@ -0,0 +1,220 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Markup Samples, Output Examples + +@creator: :author: Amissah, Ralph + +@classify: + :type: information + :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: SiSU.ssm + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@date: + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual +% :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + {Book Samples and Markup Examples}../SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Markup and Output Examples + +1~examples Markup and Output Examples + +2~ Markup examples *~markup + +Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html + +Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. + +For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. + +<:pb> + +2~ A few book (and other) examples *~books *~sample *~example *~output + +3~wealth_of_networks- /{"The Wealth of Networks"}/, Yochai Benkler + +{ "The Wealth of Networks", Yochai Benkler [3sS]}the_wealth_of_networks.yochai_benkler.sst + +3~two_bits- /{"Two Bits"}/, Christopher Kelty + +{ "Two Bits", Christopher Kelty [3sS]}two_bits.christopher_kelty.sst + +3~freeculture- /{"Free Culture"}/, Lawrence Lessig + +{ "Free Culture", Lawrence Lessig [3sS]}free_culture.lawrence_lessig.sst + +3~free_as_in_freedom- /{"Free as in Freedom: Richard Stallman's Crusade for Free Software"}/, by Sam Williams + +{ "Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams [3sS]}free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst + +3~free_for_all- /{"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans"}/, by Peter Wayner + +{ "Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner [3sS]}free_for_all.peter_wayner.sst + +3~catb- /{"The Cathedral and the Bazaar"}/, by Eric S. Raymond + +{ "The Cathedral and the Bazaar", by Eric S. Raymond [3sS]}the_cathedral_and_the_bazaar.eric_s_raymond.sst + +3~littlebrother- /{"Little Brother"}/, Cory Doctorow *~doctorow + +{ "Little Brother", Cory Doctorow [3sS]}little_brother.cory_doctorow.sst *~littlebrother + +3~accelerando- /{"Accelerando"}/, Charles Stross *~stross + +{ "Accelerando", Charles Stross [3sS]}accelerando.charles_stross.sst *~accelerando + +3~tainaron- /{"Tainaron"}/, Leena Krohn *~krohn + +{ "Tainaron", Leena Krohn [3sS]}tainaron.leena_krohn.1998.sst *~tainaron + +3~sphinx- /{"Sphinx or Robot"}/, Leena Krohn *~sor + +{ "Sphinx or Robot", Leena Krohn [3sS]}sphinx_or_robot.leena_krohn.1996.sst + +3~war_and_peace- /{"War and Peace"}/, Leo Tolstoy, PG Etext 2600 *~wap *~gutenberg + +{ "War and Peace", Leo Tolstoy [3sS]}war_and_peace.leo_tolstoy.sst ~{ http://www.jus.uio.no/sisu/war_and_peace.leo_tolstoy/toc.html
The ascii text was taken from Project Gutenberg. The markup transforms required are trivial. Of interest, in this instance I am saved by having alternative syntaxes/(structural modes) for marking up endnotes... as it was possible to do a simple search and replace to make the Project Gutenberg ascii presentation suitable for SiSU, using the older endnote markup style. This example instructs the program to use regular expressions, in this example the words: none; none; BOOK|FIRST|SECOND; CHAPTER; occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). Note that there was _{very little markup required}_ after the document headers and Project Gutenberg legal notices. As I presume the legal notices are similar in Project Gutenberg documents, (and I could not bear to think of preparing the same legal notices twice), I moved those to the "skin" for the Project, and these are now represented in the markup by \<:insert1\> and \<:insert2\> and the legal notices are available for similar insertion into the next Project Gutenberg text prepared for SiSU, should there be one.
I did a stylesheet/skin for the Gutenberg Project, ... I may have to remove. }~ + +3~quixote- /{"Don Quixote"}/, Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996 + +{ "Don Quixote", Miguel de Cervantes [Saavedra] [3sS]}don_quixote.miguel_de_cervantes.sst + +3~gulliver- /{"Gulliver's Travels"}/, Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829 *~swift + +{ "Gulliver's Travels", Jonathan Swift [3sS]}gullivers_travels.jonathan_swift.sst + +3~alice- /{"Alice's Adventures in Wonderland"}/, Lewis Carroll, PG Etext 11 + +{ "Alice's Adventures in Wonderland", Lewis Carroll [3sS]}alices_adventures_in_wonderland.lewis_carroll.sst + +3~glass- /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etext 12 + +{ "Through The Looking-Glass", Lewis Carroll [3sS]}through_the_looking_glass.lewis_carroll.sst + +3~alice- /{"Alice's Adventures in Wonderland"}/ and /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etexts 11 and 12 + +{ "Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll [3sS]}alices_adventures_in_wonderland_and_through_the_looking_glass.lewis_carroll.ssm + +3~gpl- /{"Gnu Public License 2"}/, (GPL 2) Free Software Foundation + +{ "Gnu Public License 2", (GPL 2) Free Software Foundation [3sS]}gpl2.fsf.sst + +3~gpl- /{"Gnu Public License v3 - Third discussion draft"}/, (GPLv3) Free Software Foundation + +{ "Gnu Public License 3 - Third discussion draft", (GPL v3 draft3) Free Software Foundation [3sS]}gpl3_draft3.fsf.sst + +3~dsc- /{"Debian Social Contract"}/ + +{ "Debian Social Contract" [3sS]}debian_social_contract_v1.1.sst + +3~dc- /{"Debian Constitution v1.3"}/, (simple/default markup) + +{ "Debian Constitution v1.3" [3sS]}debian_constitution_v1.3.sst + +3~dc- /{"Debian Constitution v1.3"}/, (markup adjusted for output to more closely match the original) + +{ "Debian Constitution v1.3", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.3.adjusted.sst + +3~dc- /{"Debian Constitution v1.2"}/, (simple/default markup) + +{ "Debian Constitution v1.2 (more translations)" [3sS]}debian_constitution_v1.2.sst + +3~dc- /{"Debian Constitution v1.2"}/, (markup adjusted for output to more closely match the original) + +{ "Debian Constitution (more translations)", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.2.adjusted.sst + +3~terminology- /{"A Uniform Sales Terminology"}/, Vikki Rogers and Albert Kritzer + +{ "A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer [3sS]}a_uniform_international_sales_terminology.vikki_rogers.and.albert_kritzer.sst + +3~autonomous- /{"The Autonomous Contract" 1997 }/ - markup sample + +{ "The Autonomous Contract" 1997 - markup sample [3sS]}the_autonomous_contract.amissah.19970710.sst + +3~autonomous- /{"The Autonomous Contract Revisited"}/ - markup sample + +{ "The Autonomous Contract Revisited" - markup sample [3sS]}autonomy_markup0.sst ~{ http://www.jus.uio.no/sisu/autonomy_markup0/toc.html
alternative markup variations revolving around endnotes
(i) as above, markup with embedded endnotes, and header list of words/phrases to emphasise
http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup0.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst
(ii) Again markup with embedded endnotes, but font faces changed within paragraphs rather than in header as in i
http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup1.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup1.sst
(iii) Markup with endnote placemarks within paragraphs, the endnotes following the paragraph that contains them http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup2.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup2.sst
(iv) Another alternative is to place the marked up endnotes sequentially and at the end of the text. This also works. The paragraph variant iii is perhaps easier to visually check should there be missing endnotes; but this variant iv may better suit the conversion of alternatively pre-prepared documents. }~ + +3~cisg- /{"United Nations Convention on Contracts for the International Sale of Goods"}/ + +{ "United Nations Convention on Contracts for the International Sale of Goods" [3sS]}un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html
This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents).
This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). }~ + +3~pecl- /PECL/ the "Principles of European Contract Law" + +{ "Principles of European Contract Law" [3sS]}eu_contract_principles_parts_1_to_3_2002.sst + +2~sql SQL - PostgreSQL, SQLite + +A Sample search form is available at http://search.sisudoc.org + +A few canned searches, showing object numbers. Search for: + +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 + +_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 + +Note that the searches done in this form are case sensitive. + +Expand those same searches, showing the matching text in each document: + +_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 + +_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 + +Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ + +2~ Lex Mercatoria as an example + +There is quite a bit to peruse if you explore the site Lex Mercatoria: + +http://www.lexmercatoria.org/ ~{ http://www.jus.uio.no/lm/index }~ + +or perhaps: + +http://lexmercatoria.org/treaties.and.organisations/lm.chronological ~{ http://www.jus.uio.no/lm/treaties.and.organisations/lm.chronological }~ + +2~ For good measure the markup for a document with lots of (simple) tables + +SiSU is not optimised for table making, but does handle simple tables. + +_* {~^ SiSU marked up file with tables }http://www.jus.uio.no/sisu/sample/syntax/un_conventions_membership_status.sst.html ~{
http://www.jus.uio.no/sisu/sample/markup/un_conventions_membership_status.sst }~ + +_* {~^ Output of table file example }http://www.jus.uio.no/lm/un_conventions_membership_status/toc.html + +2~ And a link to the output of a reported case + +http://www.jus.uio.no/lm/england.fothergill.v.monarch.airlines.hl.1980/toc.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_faq.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_faq.sst new file mode 100644 index 00000000..44a5a590 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_faq.sst @@ -0,0 +1,221 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: FAQ - Frequently Asked/Answered Questions + +@creator: :author: Amissah, Ralph + +@classify: + :type: information + :topic_register: electronic documents;SiSU:document:FAQ;sisu:document:FAQ;SiSU:manual:FAQ;electronic documents:SiSU:manual:FAQ + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: manual SiSU.ssm + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@date: + :published: 2008-03-12 + :created: 2006-09-06 + :available: 2006-09-06 + :issued: 2006-09-06 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }../SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +1~faq FAQ - Frequently Asked/Answered Questions + +2~ Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ? + +Try the following rune: + +_* sisu -W + +This should start the ruby webserver. It should be done after having produced some output as it scans the output directory for what to serve. + +2~ I cannot find my output, where is it? + +The following should provide help on output paths: + +_* sisu --help env + +_* sisu -V [same as the previous command] + +_* sisu --help directory + +_* sisu --help path + +_* sisu -U [filename] + +_* man sisu + +2~ I do not get any pdf output, why? + +SiSU produces LaTeX and pdflatex is run against that to generate pdf files. + +If you use Debian the following will install the required dependencies + +_* aptitude install sisu-pdf + +the following packages are required: tetex-bin, tetex-extra, latex-ucs + +2~ Where is the latex (or some other interim) output? + +Try adding -M (for maintenance) to your command flags, e.g.: + +_* sisu -HpMv [filename] + +this should result in the interim processing output being retained, and information being provided on where to find it. + +_* sisu --help directory + +_* sisu --help path + +should also provide some relevant information as to where it is placed. + +2~ Why isn't SiSU markup XML + +I worked with text and (though I find XML immensely valuable) disliked noise +... better to sidestep the question and say: + +SiSU currently "understands" three XML input representations - or more accurately, converts from three forms of XML to native SiSU markup for processing. The three types correspond to SAX (structure described), DOM (structure embedded, whole document must be read before structure is correctly discernable) and node based (a tree) forms of XML document structure representation. Problem is I use them very seldom and check that all is as it should be with them seldom, so I would not be surprised if something breaks there, but as far as I know they are working. I will check and add an XML markup help page before the next release. There already is a bit of information in the man page under the title SiSU VERSION CONVERSION + +_1 sisu --to-sax [filename/wildcard] + +_1 sisu --to-dom [filename/wildcard] + +_1 sisu --to-node [filename/wildcard] + +The XML should be well formed... must check, but lacks sensible headers. Suggestions welcome as to what to make of them. [For the present time I am satisfied that I can convert (both ways) between 3 forms of XML representation and SiSU markup]. + +_1 sisu --from-xml2sst [filename/wildcard] + +2~ LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU? + +% what are some similarities and differences between LaTex and SiSU? + +SiSU is not really about type-setting. + +LaTeX is the ultimate computer instruction type-setting language for paper based publication. + +LaTeX is able to control just about everything that happens on page and pixel, position letters kerning, space variation between characters, words, paragraphs etc. formula. + +SiSU is not really about type-setting at all. It is about a lightweight markup instruction that provides enough information for an abstraction of the documents structure and objects, from which different forms of representation of the document can be generated. + +SiSU with very little markup instruction is able to produce relatively high quality pdf by virtue of being able to generate usable default LaTeX; it produces "quality" html by generating the html directly; likewise it populates an SQL database in a useful way with the document in object sized chunks and its meta-data. But SiSU works on an abstraction of the document's structure and content and custom builds suitable uniform output. The html for browser viewing and pdf for paper viewing/publishing are rather different things with different needs for layout - as indeed is what is needed to store information in a database in searchable objects. + +% SiSU is a lightweight document abstraction, meta-(structure and markup) syntax designed to make use of a minimal amount of preparation detail that can be used across very different ways of representing documents + +The pdfs or html produced for example by open office based on open document format and other office/word processor suits usually attempt to have similar looking outputs - your document rendered in html looks much the same, or in pdf... sisu is less this way, it seeks to have a starting point with as little information about appearance as possible, and to come up with the best possible appearance for each output that can be derived based on this minimal information. + +Where there are large document sets, it provides consistency in appearance in each output format for the documents. + +The excuse for going this way is, it is a waste of time to think much about appearance when working on substantive content, it is the substantive content that is relevant, not the way it looks beyond the basic informational tags - and yet you want to be able to take advantage of as many useful different ways of representing documents as are available, and for various types of output to to be/look as good as it can for each medium/format in which it is presented, (with different mediums having different focuses) and SiSU tries to achieve this from minimal markup. + +2~ Can the SiSU markup be used to prepare for a LaTex automatic building of an index to the work? + +Has not been, is of interest though the question on introducing such possibilities is how to keep them as unobtrusive as possible, and as generically relevant as possible to other output formats (which is why the focus on object numbers). Unobtrusive refers both to the markup (where there is no big problem with introducing optional extras); and, more challengingly how to minimise impact on competing ideas/interests, such allowing the addition of semantic tags which could be tied to objects, mapped against the objects that contain them, (permitting mapping and mining of content in various ways that would be largely agnostic of output format - object numbering being an attempt to move beyond output format based content locators (such as page numbers). The desire being to (be a meta markup and) maintain agnosticism as to what is being generated and in development to favor solutions of that nature. Keep bridging LaTeX, XML, SQL ... make use of objects and serialisation for mapping whether against content or meta-content (such as semantic [or additional structural] markers). + +2~ Can the conversion from SiSU to LaTeX be modified if we have special needs for the LaTeX, or do we need to modify the LaTeX manually? + +Should be possible to modify code, it is GPLv3, should be possible either to modify existing modules or write an independent module for generating bespoke latex. Generic improvements are welcome for inclusion/incorporation in the existing code base. + +If there are tools to generate mathematical/scientific formula from latex to images (jpg, png), the latex parser could conceivably be used to make these available to other output formats. + +2~ How do I create GIN or GiST index in Postgresql for use in SiSU + +This at present needs to be done "manually" and it is probably necessary to alter the sample search form. The following is a helpful response from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06: + +"I have tsearch2 slides which introduces tsearch2 +http://www.sai.msu.su/~megera/wiki/tsearch2slides + +FTS in PostgreSQL is provided by tsearch2, which should works without +any indices (GiST or GIN) ! Indices provide performance, not functionality. + +In your example I'd do ( simple way, just for demo): + +!_ 0. +compile, install tsearch2 and load tsearch2 into your database + +_1 cd contrib/tsearch2; make&&make&&install&&make installcheck; psql DB < tsearch2.sql + +!_ 1. +Add column fts, which holds tsvector + +_1 alter table documents add column fts tsvector; + +!_ 2. +Fill fts column + +_1 update document set fts = to_tsvector(clean); + +!_ 3. +create index - just for performance ! + +_1 create index fts_gin_idx on document using gin(fts); + +!_ 4. +Run vacuum + +_1 vacuum analyze document; + +That's all. + +Now you can search: + +select lid, metadata_tid, rank_cd(fts, q,2)as rank from document, plainto_tsquery('markup syntax') q where q @@ fts order by rank desc limit 10; + +2~ Are there some examples of using Ferret Search with a SiSU repository? + +Heard good things about Ferret, but have not used it. The output directory structure and content produced by SiSU is very uniform. Have looked at a couple of other engines (hyperestraier, lucene). There it was enough to identify the files that needed to be indexed and pass them to the search indexing tool. Some Unix rune doing the job, such as: + +code{ + +find /home/ralph/sisu_www -type f | \ +egrep '/sisu_www/(sisu|document_archive)/.+?.html$' | \ +egrep -v '(doc|concordance).html$' | \ +estcmd gather -sd casket - + +}code + +you would have to experiment with what gives the desired result, the file doc.html is the complete text in html (there are additional smaller html segments), and plain.txt the document as a text file. It may be possible to index the text file and return the html document. + + +2~ Have you had any reports of building SiSU from tar on Mac OS 10.4? + +None. In the early days of its release a Mac friend built and run the ruby code part that did not rely on system calls to bits like the latex engine. That is already some years back. He was not into writing or document markup, and did it as a favour at the time. I have not followed up that thread of development. + +It should however be possible, much of the output relies on plain ruby, and the system commands to latex etc. could be made appropriate for the underlying OS. + +2~ Where is version 1.0? + +Most of SiSU is mature and stable. +Version 1.0 will be based on the current markup, (more likely with optional additions rather than significant changes) and directory structure. +At this point (semantic tagging apart) it is largely a matter of choice as to when the version change is made. + +The feature set for html,~{ html w3c compliance has been largely met. }~ LaTeX/pdf and opendocument is in place. +XML, and plaintext are in order. + +html and LaTeX/pdf may be regarded as reference copy outputs + +With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done. + +We are still almost there. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_filetypes.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_filetypes.sst new file mode 100644 index 00000000..4e46323c --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_filetypes.sst @@ -0,0 +1,170 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Filetypes + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual:filetypes;electronic documents:SiSU:manual:filetypes + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +1~filetypes SiSU filetypes + +SiSU has plaintext and binary filetypes, and can process either type of document. + +2~ .sst .ssm .ssi marked up plain text + +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. + +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. + +SiSU source markup can be shared with the command: + +_1 sisu -s [filename] + +3~ sisu text - regular files (.sst) + +The most common form of document in SiSU, see the section on SiSU markup. + +http://www.jus.uio.no/sisu/sisu_markup + +http://www.jus.uio.no/sisu/sisu_manual + +3~ sisu master files (.ssm) + +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. + +The mechanism by which master files incorporate other documents is described as one of the headings under under SiSU markup in the SiSU manual. + +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. + +Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst ~{ .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. }~ + +http://www.jus.uio.no/sisu/sisu_markup + +http://www.jus.uio.no/sisu/sisu_manual + +3~ sisu insert files (.ssi) + +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. + +2~ sisupod, zipped binary container (sisupod.zip, .ssp) + +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) + +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. + +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. + +The command to create a sisupod is: + +_1 sisu -S [filename] + +Alternatively, make a pod of the contents of a whole directory: + +_1 sisu -S + +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. + +http://www.jus.uio.no/sisu/sisu_commands + +http://www.jus.uio.no/sisu/sisu_manual + +1~alt Experimental Alternative Input Representations + +2~ Alternative XML + +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. + +!_ convert from sst to simple xml representations (sax, dom and node): + +_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] + +_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] + +_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] + +!_ convert to sst from any sisu xml representation (sax, dom and node): + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +3~ XML SAX representation + +To convert from sst to simple xml (sax) representation: + +_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] + +To convert from any sisu xml representation back to sst + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +3~ XML DOM representation + +To convert from sst to simple xml (dom) representation: + +_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] + +To convert from any sisu xml representation back to sst + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +3~ XML Node representation + +To convert from sst to simple xml (node) representation: + +_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] + +To convert from any sisu xml representation back to sst + +_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +or the same: + +_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] + +% .SH "SKINS \- document, directory and site skins" diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help.sst new file mode 100644 index 00000000..a49b3522 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help.sst @@ -0,0 +1,131 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Help + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual:help;electronic documents:manual:SiSU:help + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-08-30 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Help + +1~help Help + +2~ SiSU Manual + +The most up to date information on sisu should be contained in the sisu_manual, available at: + +_1 http://sisudoc.org/sisu/sisu_manual/ + +The manual can be generated from source, found respectively, either within the SiSU tarball +or installed locally at: + +_1 ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ + +_1 /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/ + +move to the respective directory and type e.g.: + +_1 sisu sisu_manual.ssm + +% The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component. + +2~ SiSU man pages *~man + +If SiSU is installed on your system usual man commands should be available, try: + +_1 man sisu + +_1 man sisu_markup + +_1 man sisu_commands + +Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: + +_1 ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ + +Once installed, directory equivalent to: + +_1 /usr/share/doc/sisu/sisu_manual/ + +Available man pages are converted back to html using man2html: + +_1 /usr/share/doc/sisu/v2/html/ + +_1 ./data/doc/sisu/v2/html/ + +An online version of the sisu man page is available here: + +_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/ + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html + +2~ SiSU built-in interactive help + +This is particularly useful for getting the current sisu setup/environment information: + +_1 sisu --help + +_1 sisu --help [subject] + +_2 sisu --help commands + +_2 sisu --help markup + +_2 sisu --help env [for feedback on the way your system is setup with regard to sisu] + +_1 sisu -V [environment information, same as above command] + +_1 sisu (on its own provides version and some help information) + +Apart from real-time information on your current configuration the SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). + +NOTE: Running the command sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. + +2~ Help Sources + +For lists of alternative help sources, see: + +!_ man page + +_1 man sisu_help_sources + +!_ man2html + +_1 /usr/share/doc/sisu/v2/html/sisu.1.html + +_1 http://sisudoc.org/sisu/sisu_help_sources/index.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help_sources.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help_sources.sst new file mode 100644 index 00000000..90a0efc6 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_help_sources.sst @@ -0,0 +1,202 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: References + +@creator: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual:help sources;electronic documents:SiSU:manual:help sources + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual + +@date: + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Help Sources + +1~help_sources Help Sources + +For a summary of alternative ways to get help on SiSU try one of the following: + +!_ man page + +_1 man sisu_help + +!_ man2html + +_1 http://www.jus.uio.no/sisu/man/sisu_help.1.html + +!_ sisu generated output - links to html + +_1 http://sisudoc.org/sisu/sisu_help/index.html + +!_ help sources lists + +Alternative sources for this help sources page listed here: + +_1 man sisu_help_sources + +_1 http://sisudoc.org/sisu/sisu_help_sources/index.html + +2~ man pages + +3~ man + +_1 man sisu + +_1 man sisu-concordance + +_1 man sisu-epub + +_1 man sisu-git + +_1 man sisu-harvest + +_1 man sisu-html + +_1 man sisu-odf + +_1 man sisu-pdf + +_1 man sisu-pg + +_1 man sisu-po + +_1 man sisu-sqlite + +_1 man sisu-txt + +_1 man 7 sisu_complete + +_1 man 7 sisu_pdf + +_1 man 7 sisu_postgresql + +_1 man 7 sisu_sqlite + +_1 man sisu_termsheet + +_1 man sisu_webrick + +2~ sisu generated output - links to html + +Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, odf and epub, which may be also be accessed via the html pages~{ named index.html or more extensively through sisu_manifest.html }~ + +3~ www.sisudoc.org + +http://sisudoc.org/sisu/sisu_manual/index.html + +_1 http://sisudoc.org/sisu/sisu_manual/index.html + +_1 http://sisudoc.org/sisu/sisu_commands/index.html + +_1 http://sisudoc.org/sisu/sisu_complete/index.html + +_1 http://sisudoc.org/sisu/sisu_configuration/index.html + +_1 http://sisudoc.org/sisu/sisu_description/index.html + +_1 http://sisudoc.org/sisu/sisu_examples/index.html + +_1 http://sisudoc.org/sisu/sisu_faq/index.html + +_1 http://sisudoc.org/sisu/sisu_filetypes/index.html + +_1 http://sisudoc.org/sisu/sisu_help/index.html + +_1 http://sisudoc.org/sisu/sisu_help_sources/index.html + +_1 http://sisudoc.org/sisu/sisu_howto/index.html + +_1 http://sisudoc.org/sisu/sisu_introduction/index.html + +_1 http://sisudoc.org/sisu/sisu_manual/index.html + +_1 http://sisudoc.org/sisu/sisu_markup/index.html + +_1 http://sisudoc.org/sisu/sisu_output_overview/index.html + +_1 http://sisudoc.org/sisu/sisu_pdf/index.html + +_1 http://sisudoc.org/sisu/sisu_postgresql/index.html + +_1 http://sisudoc.org/sisu/sisu_quickstart/index.html + +_1 http://sisudoc.org/sisu/sisu_remote/index.html + +_1 http://sisudoc.org/sisu/sisu_search/index.html + +_1 http://sisudoc.org/sisu/sisu_skin/index.html + +_1 http://sisudoc.org/sisu/sisu_sqlite/index.html + +_1 http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html + +_1 http://sisudoc.org/sisu/sisu_vim/index.html + +_1 http://sisudoc.org/sisu/sisu_webrick/index.html + +2~ man2html + +3~ locally installed + +file:///usr/share/doc/sisu/v2/html/sisu.1.html + +file:///usr/share/doc/sisu/v2/html/sisu_help.1.html + +file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html + +_1 /usr/share/doc/sisu/v2/html/sisu.1.html + +_1 /usr/share/doc/sisu/v2/html/sisu_pdf.7.html + +_1 /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html + +_1 /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html + +_1 /usr/share/doc/sisu/v2/html/sisu_webrick.1.html + +3~ www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu/man/sisu.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu.1.html + +_1 http://www.jus.uio.no/sisu/man/sisu_complete.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_pdf.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html + +_1 http://www.jus.uio.no/sisu/man/sisu_webrick.1.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_homepages.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_homepages.ssi new file mode 100644 index 00000000..0fd681fa --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_homepages.ssi @@ -0,0 +1,87 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Homepages + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual.ssm sisu.ssm + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2007-08-28 + :issued: 2007-08-28 + :available: 2007-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Setting up of homepages + +1~home Homepages + +SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by SiSU. More accurately, SiSU has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways as part of a site's configuration, these being: + +# through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) + +# through providing what you want as the home page in a skin, + +Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. + +2~ Home page and other custom built pages in a sub-directory + +Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu +From there they are copied to the root of the output directory with the command: + +_1 sisu -CC + +2~ Home page within a skin + +Skins are described in a separate section, but basically are a file written in the programming language Ruby that may be provided to change the defaults that are provided with sisu with respect to individual documents, a directories contents or for a site. + +If you wish to provide a homepage within a skin the skin should be in the directory _sisu/skin/dir and have the name of the directory for which it is to become the home page. Documents in the directory commercial_law would have the homepage modified in skin_commercial law.rb ; or the directory poems in skin_poems.rb + +code{ + + class Home + def homepage + # place the html content of your homepage here, this will become index.html + < + + +

this is my new homepage.

+ + +HOME + end + end + +}code + +% .SH "SKINS \- document, directory and site skins" + + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_how.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_how.ssi new file mode 100644 index 00000000..bd7f15d8 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_how.ssi @@ -0,0 +1,47 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: How Does SiSU Work? + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Description + +1~sisu_how How does sisu work? + +SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within the substantive text of the document, which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_howto.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_howto.sst new file mode 100644 index 00000000..8dfee20b --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_howto.sst @@ -0,0 +1,1406 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Technical, Howto + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual:howto;electronic documents:SiSU:manual:howto;SiSU:document:howto;sisu:document:howto + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual SiSU.ssm document + +@date: + :published: 2007-09-16 + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU some technical information + +:C~ HowTo + +1~howto_help Getting Help + +An online manual of sorts should be available at: + +http://www.jus.uio.no/sisu_manual/ + +The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component. + +2~ SiSU "man" pages *~man + +If SiSU is installed on your system usual man commands should be available, try: + +man sisu + +The SiSU man pages can be viewed online at:~{ generated from source using rman
http://polyglotman.sourceforge.net/rman.html
With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:
http://www.jus.uio.no/sample }~ + +An online version of the sisu man page is available here: + +_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/ + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html + +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html + +_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html + +_* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html + +2~ SiSU built-in help + +_1 sisu --help + +_1 sisu --help [subject] + +_2 sisu --help env [for feedback on the way your system is setup with regard to sisu] + +_2 sisu -V [same as above command] + +_2 sisu --help commands + +_2 sisu --help markup + +2~ Command Line with Flags - Batch Processing + +Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. + +In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. + +1~howto_setup Setup, initialisation + +2~ initialise output directory + +Images, css files for a document directory are copied to their respective locations in the output directory. + +while within your document markup/preparation directory, issue the following command + +_1 sisu -CC + +3~ Use of search functionality, an example using sqlite + +SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases. + +This note provides an example to get you started and will use sqlite + +It is necessary to: + +(1) make sure the required dependencies have been installed + +(2) have a directory with sisu markup samples that is writable + +(3) use sisu to create a database + +(4) use sisu tp populate a database + +(5) use sisu to start the webrick (httpd) server + +(6) use sisu to create a search form + +(7) copy the search form to the cgi directory + +(8) open up the form in your browser + +(9) query the database using the search form + +!_ (1) make sure the required dependencies have been installed + +if you use Debian, the following command will install the required dependencies + +aptitude install sisu-sqlite + +!_ (2) have a directory with sisu markup samples that is writable + +ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) + +cp -rv /usr/share/doc/sisu-markup-samples/v2/samples /. + +!_ (3) use sisu to create an sqlite database + +within the sisu-examples directory + +sisu -dv createall + +!_ (4) use sisu tp populate a database with some text + +within the sisu-examples directory + +sisu -div free_*.sst + +or + +sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst gpl2.fsf.sst + +!_ (5) use sisu to start the webrick (httpd) server (if it has not already been started): + +sisu -W + +!_ (6) use sisu to create a search form (for use with the webrick server, and your sample documents) + +within the sisu-examples directory + +sisu -F webrick + +#here i run into a problem, you are working from a read only +#directory..., not my usual mode of operation, to complete the example +#the following is necessary +sudo touch sisu_sqlite.cgi sisu_pgsql.cgi +sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi + +#now this should be possible: +sisu -F webrick + +!_ (7) copy the search form to the cgi directory + +the string should be provided as output from the previous command + +sudo cp -vi /usr/share/doc/sisu-markup-samples/v2/samples/sisu_sqlite.cgi /usr/lib/cgi-bin + +sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi + +!_ (8) open up the form in your browser and query it + +url: + +http://localhost:8081/cgi-bin/sisu_sqlite.cgi + +or as instructed by command sisu -F webrick + +!_ (9) query the database using the search form + +if there are other options in the dropdown menu select + +document_samples_sisu_markup + +and search for some text, e.g.: + +aim OR project + +_* selecting the *index* radio button gives an index of results using the object numbers + +_* selecting the *text* radio button gives the content of the matched paragraphs with the match highlighted + +!_ (10) to start again with a new database + +to start from scratch you can drop the database with the command + +sisu -dv dropall + +and go to step 3 + +to get to step 3 in one step with a single command + +sisu -dv recreate + +continue subsequent steps + +2~ misc + +3~ url for output files -u -U + +_1 sisu -uv[and other flags] [filename/wildcard] + +_1 sisu -Uv [filename/wildcard] + +3~ toggle screen color + +_1 sisu -cv[and processing flags] [filename/wildcard] + +3~ verbose mode + +_1 sisu -v[and processing flags] [filename/wildcard] + +_1 sisu -V[and processing flags] [filename/wildcard] + +3~ quiet mode + +_1 sisu -q[and processing flags] [filename/wildcard] + +3~ maintenance mode +intermediate files kept -M + +_1 sisu -Mv[and other flags] [filename/wildcard] + +3~ start the webrick server + +_1 sisu -W + +2~ remote placement of output + +configuration is necessary + +scp + +_1 sisu -vr[and processing flags] [filename/wildcard] + +rsync + +_1 sisu -vR[and processing flags] [filename/wildcard] + +1~howto_config Configuration Files + +Sample provided, on untarring the source tarball: + +_1 conf/sisu/sisurc.yaml + +and on installation under: + +_1 /etc/sisu/sisurc.yaml + +The following paths are searched: + +_1 ./_sisu/sisurc.yaml + +_1 ~/.sisu/sisurc.yaml + +_1 ./etc/sisu/sisurc.yaml + +1~howto_markup Markup + +See sample markup provided on + +http://www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu_markup + +http://www.jus.uio.no/sisu/SiSU + +in particular for each of the document output samples provided, the source document is provided as well + +http://www.jus.uio.no/sisu/SiSU/2#books + +on untarring the source tarball: + +_1 data/sisu-examples/sample/document_samples_sisu_markup/ + +or the same once source is installed (or sisu-examples) under: + +_1 /usr/share/doc/sisu-markup-samples/v2/samples + +Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* + +SiSU is for literary and legal text, also for some social science material. In particular it does not do formula, and is not particularly suited to technical documentation. Despite the latter caveat, some notes will be provided here and added to over time: + +2~ Headers + +Headers @headername: provide information related to the document, this may relate to + +# how it is to be processed, such as whether headings are to be numbered, what skin is to be used and markup instructions, such as the document structure, or words to be made bold within the document + +# semantic information about the document including the dublin core + +2~ Font Face + +Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ... + +3~ Bold + +\@bold: [list of words that should be made bold within document] + +!_ bold line + +\!_ bold line + +*{ bold word or sentence }* + +!\{ bold word or sentence \}! + +*\{ bold word or sentence \}* + +*boldword* or !boldword! + +\*boldword\* or \!boldword\! + +3~ Italics + +\@italics: [list of words that should be italicised within document] + +/{ italicise word or sentence }/ + +/\{ italicise word or sentence \}/ + +/italicisedword/ + +\/italicisedword\/ + +3~ Underscore + +_{ underscore word or sentence }_ + +_\{ underscore word or sentence \}_ + +_underscoreword_ + +3~ Strikethrough + +-{ strikethrough word or sentence }- + +-\{ strikethrough word or sentence \}- + +-strikeword- + +\-strikeword\- + +2~ Endnotes + +There are two forms of markup for endnotes, they cannot be mixed within the same document + +here~{ this is an endnote }~ + +# preferred endnote markup + +here~\{ this is an endnote \}~ + +# alternative markup equivalent, kept because it is possible to search and replace to get markup in existing texts such as Project Gutenberg + +here\~^ + +^\~ this is an endote + +2~ Links + +{ SiSU }http://sisudoc.org + +code{ + +{ SiSU }http://sisudoc.org + +}code + +{sisu.png }http://sisudoc.org + +code{ + +{sisu.png }http://sisudoc.org + +}code + +{tux.png 64x80 }image + +code{ + +{ tux.png 64x80 }image + +}code + +{~^ SiSU }http://sisudoc.org + +code{ + +{~^ SiSU }http://sisudoc.org + +}code + +is equivalent to: + +code{ + +{ SiSU }http://sisudoc.org ~{ http://sisudoc.org }~ + +}code + +the same can be done with an image: + +{~^ sisu.png "SiSU" }http://sisudoc.org + +code{ + +{~^ sisu.png "SiSU" }http://sisudoc.org + +}code + +2~ Number Titles + +Set with the header @markup: + +2~ Line operations + +Line Operations (marker placed at start of line) + +\!_ bold line + +!_ bold line + +\_1 indent paragraph one level + +_1 indent paragraph one level + +\_2 indent paragraph two steps + +_2 indent paragraph two steps + +\_* bullet paragraph + +_* bullet paragraph + +\# number paragraph (see headers for numbering document headings) + +# number paragraph (see headers for numbering document headings) + +\_# number paragraph level 2 (see headers for numbering document headings) + +_# number paragraph level 2 (see headers for numbering document headings) + +2~ Tables + +Table markup sample + +code{ + +table{~h c3; 26; 32; 32; + +This is a table, column1 +this would become row one of column two +column three of row one is here + +column one row 2 +column two of row two +column three of row two, and so on + +column one row three +and so on +here + +}table + +}code + +Alternative form of table markup + +code{ + +{t~h} + |Mon|Tue|Wed|Thu|Fri|Sat|Sun +0 | * | * | * | * | * | * | * +1 | * | * | * | * | | | +2 | - | * | * | * | * | * | +3 | - | * | * | * | * | * | * +4 | - | | | * | * | * | +5 | * | * | * | * | * | * | * + +}code + +2~ Grouped Text + +code{ + + 5.times { puts 'Ruby' } + +}code + +code\{ + +code{ + + 5.times { puts 'Ruby' } + +}code + +\}code + +poem{ + +A Limerick + +There was a young lady from Clyde, +who ate a green apple and died, +but the apple fermented inside the lamented, +and made cider inside her inside. + +}poem + +code{ + +poem{ + +There was a young lady from Clyde, +who ate a green apple and died, +but the apple fermented inside the lamented, +and made cider inside her inside. + +}poem + +}code + +2~ Composite Document + +To import another document, the master document or importing document should be named filename.r3 (r for require) + +\<\< \{ filename.sst \} + +\<\< \{ filename.ssi \} + +1~howto_appearance Change Appearance + +2~ Skins + +"Skins" may be used to change various aspects related to the output documents appearance, including such things as the url for the home page on which the material will be published, information on the credit band, and for html documents colours and icons used in navigation bars. Skins are ruby files which permit changing of the default values set within the program for SiSU output. + +There are a few examples provided, on untarring the source tarball: + +_1 conf/sisu/skin/doc/ + +_1 data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc + +and on installation under: + +_1 /etc/sisu/skin/doc/ + +_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc + +The following paths are searched: + +_1 ./_sisu/skin + +_1 ~/.sisu/skin + +_1 /etc/sisu/skin + +Skins under the searched paths in a per document directory, a per directory directory, or a site directory, named: + +doc [may be specified individually in each document] + +dir [used if identifier part of name matches markup directory name] + +site + +It is usual to place all skins in the document directory, with symbolic links as required from dir or site directories. + +2~ CSS + +The appearance of html and XML related output can be changed for an ouput collection directory by prepareing and placing a new css file in one of the sisu css directories searched in the sisu configuration path. These are located at: + +_./_sisu/css + +~/.sisu/css + +and + +/etc/sisu/css + +The contents of the first directory found in the search path are copied to the corresponding sisu output directory with the commnd: + +sisu -CC + +The SiSU standard css files for SiSU output are: + +dom.css html.css html_tables.css index.css sax.css xhtml.css + +A document may specify its own/bespoke css file using the css header. + +\@css: + +[expand] + +:C~ Extracts from the README + +1~howto_readme README + +SiSU 0.55 2007w27/6 2007-07-07 + +Homepage: http://www.jus.uio.no/sisu + +!_ Description + +SiSU is lightweight markup based document creation and publishing framework that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats. + +With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, EPUB, XML, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) in paragraph sized chunks so that document searches are done at this "atomic" level of granularity. + +Outputs share a common citation numbering system, and any semantic meta-data provided about the document. + +SiSU also provides concordance files, document content certificates and manifests of generated output. + +SiSU takes advantage of well established open standard ways of representing text, and provides a bridge to take advantage of the strengths of each, while remaining simple. SiSU implements across document formats a "useful common feature set" [coming from a humanities, law, and possibly social sciences perspective, rather than technical or scientific writing] ... focus is primarily on content and data integrity rather than appearance, (though outputs in the various formats are respectable). + +A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU. + +man pages, and interactive help are provided. + +Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. + +Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. + +Homepage: http://www.jus.uio.no/sisu + +SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works. + +SiSU can be used for Internet, Intranet, local filesystem or cd publishing. + +SiSU can be used directly off the filesystem, or from a database. + +SiSU's scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql. + +Amongst it's characteristics are: + +_* simple mnemonoic markup style, + +_* the ability to produce multiple output formats, including html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database whilst retaining document structure - Postgresql and Sqlite, + +_* that all share a common citation system (a simple idea from which much good), possibly most exciting, the following: if fed into a relational database (as it can be automatically), the document set is searchable, with results displayed at a paragraph level, or the possibility of an indexed display of documents in which the match is found together with a hyperlinked listing for each of each paragraph in which the match is found. In any event citations using this system (with or without the relational database) are relevant for all output formats. + +_* it is command line driven, and can be set up on a remote server + +_* Documents are marked up in SiSU syntax in your favourite editor. SiSU syntax may be regarded as a type of smart ascii - which in its basic form is simpler than the most elementary html. There is currently a syntax highlighter, and folding for Vim. Syntax highlighters for other editors are welcome. + +Input files should be UTF-8 + +Once set up it is simple to use. + +2~ Online Information, places to look + +http://www.jus.uio.no/sisu + +Download Sources: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian + +2~ Installation + +NB. Platform is Unix / Linux. + +3~ Debian + +If you use Debian use the Debian packages, check the information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian + +(A) SiSU is available directly off the Debian archives for Sid and testing. It +should necessary only to run as root: + +_1 aptitude update + +_1 aptitude install sisu-complete + +(B) If there are newer versions of SiSU upstream of the Debian archives, they +will be available by adding the following to your /etc/apt/sources.list + +_1 deb http://www.jus.uio.no/sisu/archive unstable main non-free + +_1 deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +[the non-free line is for document markup samples, for which the substantive text is provided under the author or original publisher's license and which in most cases will not be debian free software guideline compliant] + +Then as root run: + +_1 aptitude update + +_1 aptitude install sisu-complete + +3~ RPM + +RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. + +They may be downloaded from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm + +3~ Source package .tgz + +Otherwise to install SiSU from source, check information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +alternative modes of installation from source are provided, setup.rb (by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan Lang) built install file, + +Ruby is the essential dependency for the basic operation of SiSU + +1. Download the latest source (information available) from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +2. Unpack the source + +Note however, that additional external package dependencies, such as texlive or postgresql should you desire to use it are not taken care of for you. + +3~ to use setup.rb + +this is a three step process, in the root directory of the unpacked SiSU as root type: + +_1 ruby setup.rb config + +_1 ruby setup.rb setup + +as root: + +_1 ruby setup.rb install + +further information: + +_1 http://i.loveruby.net/en/projects/setup/ + +_1 http://i.loveruby.net/en/projects/setup/doc/usage.html + +3~ to use install (prapared with "Rake") + +Rake must be installed on your system: + +_1 http://rake.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=50 + +in the root directory of the unpacked SiSU as root type: + +_1 rake + +or + +_1 rake base + +This makes use of Rake (by Jim Weirich) and the provided Rakefile + +For a list of alternative actions you may type: + +_1 rake help + +_1 rake -T + +3~ to use install (prapared with "Rant") + +(you may use the instructions above for rake substituting rant if rant is +installed on your system, or you may use an independent installer created using +rant as follows:) + +in the root directory of the unpacked SiSU as root type: + +_1 ruby ./sisu-install + +or + +_1 ruby ./sisu-install base + +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. + +further information: + +_1 http://make.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=615 + +For a list of alternative actions you may type: + +_1 ruby ./sisu-install help + +_1 ruby ./sisu-install -T + +2~ Dependencies + +Once installed see 'man 8 sisu' for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) 'man sisu_markup-samples' may also be of interest if the sisu-markup-samples package has also been installed. + +The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU). + +The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. + +code{ + +Package: sisu +Architecture: all +Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip +Conflicts: vim-sisu, sisu-vim, sisu-remote +Replaces: vim-sisu, sisu-vim +Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, +tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, +hyperestraier, kdissert, vim-addon-manager +Suggests: rcs | cvs, lv, texinfo, pinfo + +Package: sisu-complete +Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +Recommends: hyperestraier + +Package: sisu-pdf +Architecture: all +Depends: sisu, texlive-latex-base, texlive-fonts-recommended, +texlive-latex-recommended, texlive-latex-extra +Suggests: evince, xpdf + +Package: sisu-postgresql +Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby +Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 + +Package: sisu-sqlite +Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby +Suggests: libdbd-sqlite + +Package: sisu-markup-samples +Depends: sisu + +}code + +code{ + +Source: sisu +Section: text +Priority: optional +Maintainer: Ralph Amissah +Build-Depends: debhelper (>= 5) +Standards-Version: 3.7.2 + +Package: sisu +Architecture: all +Depends: ruby (>= 1.8.2), ruby (<< 1.9), libwebrick-ruby, unzip, zip +Conflicts: vim-sisu, sisu-vim, sisu-remote +Replaces: vim-sisu, sisu-vim +Recommends: sisu-doc, sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager +Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang +Description: documents - structuring, publishing in multiple formats and search + SiSU is a lightweight markup based, command line oriented, document + structuring, publishing and search framework for document collections. + . + With minimal preparation of a plain-text, (UTF-8) file, using its native +markup syntax in your text editor of choice, SiSU can generate various document +formats (most of which share a common object numbering system for locating +content), including plain text, HTML, XHTML, EPUB, XML, OpenDocument text +(ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly +paragraph-sized chunks) so searches may be performed and matches returned with +that degree of granularity: your search criteria is met by these documents and +at these locations within each document. Object numbering is particularly +suitable for "published" works (finalized texts as opposed to works that are +frequently changed or updated) for which it provides a fixed means of reference +of content. Document outputs also share semantic meta-data provided. + . + SiSU also provides concordance files, document content certificates and + manifests of generated output. + . + A vim syntax highlighting file and an ftplugin with folds for sisu markup is + provided, as are syntax highlighting files for kate, kwrite, gedit and + diakonos. Vim 7 includes syntax highlighting for SiSU. + . + man pages, and interactive help are provided. + . + Dependencies for various features are taken care of in sisu related packages. + The package sisu-complete installs the whole of SiSU. + . + Additional document markup samples are provided in the package + sisu-markup-samples which is found in the non-free archive the licenses for + the substantive content of the marked up documents provided is that provided + by the author or original publisher. + . + Homepage: + +}code + +code{ + +Package: sisu-complete +Architecture: all +Depends: ruby (>= 1.8.2), ruby (<< 1.9), sisu, sisu-doc, sisu-pdf, sisu-postgresql, sisu-sqlite +Recommends: hyperestraier +Description: installs all SiSU related packages + This package installs SiSU and related packages that enable sisu to produce + pdf and to populate postgresql and sqlite databases. + . + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + See sisu for a description of the package. + . + Homepage: + +}code + +code{ + +Package: sisu-doc +Architecture: all +Depends: sisu +Recommends: sisu-pdf, sisu-postgresql, sisu-sqlite +Description: sisu manual and other documentation for sisu + Multiple file formats generated output of sisu documentation generated from + sisu markup source documents included in the main package + . + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + Homepage: + +}code + +code{ + +Package: sisu-pdf +Architecture: all +Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, texlive-latex-extra +Recommends: sisu-doc +Description: dependencies to convert SiSU LaTeX output to pdf + This package enables the conversion of SiSU LaTeX output to pdf. + . + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + Homepage: + +}code + +code{ + +Package: sisu-postgresql +Architecture: all +Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql +Recommends: sisu-doc, libfcgi-ruby +Suggests: postgresql-contrib +Description: SiSU dependencies for use with postgresql database + This package enables SiSU to populate a postgresql database. This is done at + an object/paragraph level, making granular searches of documents possible. + . + This relational database feature of SiSU is not required but provides + interesting possibilities, including that of granular searches of documents + for matching units of text, primarily paragraphs that can be displayed or + identified by object citation number, from which an index of documents + matched and each matched paragraph within them can be displayed. + . + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + Homepage: + +}code + +code{ + +Package: sisu-sqlite +Architecture: all +Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby +Recommends: sisu-doc, libfcgi-ruby +Description: SiSU dependencies for use with sqlite database + This package enables SiSU to populate an sqlite database. This is done at an + object/paragraph level, making granular searches of documents possible. + . + This relational database feature of SiSU is not required but provides + interesting possibilities, including that of granular searches of documents + for matching units of text, primarily paragraphs that can be displayed or + identified by object citation number, from which an index of documents + matched and each matched paragraph within them can be displayed. + . + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + Homepage: + +}code + +2~ Quick start + +Most of the installation should be taken care of by the aptitude or rant +install. (The rant install if run in full will also test run the generation of +the first document). + +After installation of sisu-complete, move to the document samples directory + +_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples + +and run + +_1 sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +or the same: + +_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +look at output results, see the "sisu_manifest" page created for the document + +or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. + +sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst + +the database stuff is extra perhaps, the latex stuff could be considered extra perhaps but neither needs to be installed for most of sisu output to work + +examine source document, vim has syntax support + +gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst + +additional markup samples in + +_1 http://www.jus.uio.no/sisu/SiSU/examples.html + +For help + +_1 man sisu + +or + +_1 sisu --help + +e.g. + +for the way sisu "sees/maps" your system + +_1 sisu --help env + +for list of commands and so on + +_1 sisu --help commands + +2~ Configuration files + +The default configuration/setup is contained within the program and is altered by configuration settings in /etc/[sisu version]/sisurc.yml or in ~/.sisu/sisurc.yml + +_* configuration file - a yaml file + +_1 /etc/sisu/[sisu version]/sisurc.yml + +_1 ~/.sisu/sisurc.yml + +_* directory structure - setting up of output and working directory. + +* skins - changing the appearance of a project, directory or individual +documents within ~/.sisu/skin + +_1 ~/.sisu/skin/doc contains individual skins, with symbolic links from + +_1 ~/.sisu/skin/dir if the contents of a directory are to take a particular document skin. + +_* additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on Debian), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are required for basic html or XML processing. + +_* if you use Vim as editor there is a syntax highlighter and fold resource config file for SiSU. I hope more syntax highlighters follow. + +There are post installation steps (which are really part of the overall installation) + +sisu -C in your marked up document directory, should do some auto-configuring provided you have the right permissions for the output directories. (and provided the output directories have already been specified if you are not using the defaults). + +2~ Use General Overview + +Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm + +Marked up SiSU documents are usually kept in a sub-directory of your choosing + +use the interactive help and man pages + +_1 sisu --help + +_1 man sisu + +2~ Help + +interactive help described below, or man page: + +_1 man sisu + +_1 man 8 sisu + +'man sisu_markup-samples' [if the sisu-markup-samples package is also installed] + +Once installed an interactive help is available typing 'sisu' (without) any flags, and select an option: + +_1 sisu + +alternatively, you could type e.g. + +_1 sisu --help commands + +_1 sisu --help env + +_1 sisu --help headers + +_1 sisu --help markup + +_1 sisu --help headings + +etc. + +for questions about mappings, output paths etc. + +_1 sisu --help env + +_1 sisu --help path + +_1 sisu --help directory + +2~ Directory Structure + +Once installed, type: + +_1 sisu --help env + +or + +_1 sisu -V + +2~ Configuration File + +The defaults can be changed via SiSU's configure file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that order, stopping on the first one found) + +2~ Markup + +See man pages. + +_1 man sisu + +_1 man 8 sisu + +Once installed there is some information on SiSU Markup in its help: + +_1 sisu --help markup + +and + +_1 sisu --help headers + +Sample marked up document are provided with the download tarball in the directory: + +_1 ./data/doc/sisu/sisu_markup_samples/dfsg + +These are installed on the system usually at: + +_1 /usr/share/doc/sisu/v2/sisu_markup_samples/samples + +More markup samples are available in the package sisu-markup-samples + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples + +Many more are available online off: + +_1 http://www.jus.uio.no/sisu/SiSU/examples.html + +2~ Additional Things + +There is syntax support for some editors provided (together with a README file) in + +_1 ./data/sisu/conf/syntax + +usually installed to: + +_1 /usr/share/sisu/v2/conf/syntax + +2~ License + +License: GPL 3 or later see the copyright file in + +_1 ./data/doc/sisu + +usually installed to: + +_1 /usr/share/doc/sisu + +2~ SiSU Standard + +SiSU uses: + +_* Standard SiSU markup syntax, + +_* Standard SiSU meta-markup syntax, and the + +_* Standard SiSU object citation numbering and system + +© Ralph Amissah 1997, current 2006 All Rights Reserved. + +_* however note the License section + +CHANGELOG + +_1 ./CHANGELOG + +and see + +_1 http://www.jus.uio.no/sisu/SiSU/changelog.html + +_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html + +:C~ Extracts from man 8 sisu + +1~howto_setup_post_installation Post Installation Setup + +2~ Post Installation Setup - Quick start + +After installation of sisu-complete, move to the document samples directory, + +_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples + +[this is not where you would normally work but provides sample documents for +testing, you may prefer instead to copy the contents of that directory to a local +directory before proceeding] + +and in that directory, initialise the output directory with the command + +_1 sisu -CC + +then run: + +_1 sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +or the same: + +_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +look at output results, see the "sisu_manifest" page created for the document + +for an overview of your current sisu setup, type: + +_1 sisu --help env + +or + +_1 sisu -V + +To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g. + +_1 sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst + +_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst + +examine source document, vim has syntax highlighting support + +gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst + +additional markup samples in + +_1 http://www.jus.uio.no/sisu/SiSU/examples.html + +it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely. + +_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip + +there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended: + +_1 sisu -3 --trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip + +For help + +_1 man sisu + +_1 sisu --help + +_1 sisu --help env +for the way sisu "sees/maps" your system + +_1 sisu --help commands +for list of commands and so on + +2~ Document markup directory + +% B. Generate a (local) document from a markup/work directory. + +Perhaps the easiest way to begin is to create a directory for sisu marked up documents within your home directory, and copy the file structure (and document samples) provided in the document sample directory: + +_1 mkdir ~/sisu_test + +_1 cd ~/sisu_test + +_1 cp -a /usr/share/doc/sisu/v2/sisu_markup_samples/samples/* ~/sisu_test/. + +!_ Tip: +the markup syntax examples may be of interest + +_1 http://www.jus.uio.no/sisu/sample/ + +!_ Tip: + +_1 sisu -U [sisu markup filename] + +should printout the different possible outputs and where sisu would place them. + +!_ Tip: +if you want to toggle ansi color add + +_1 c + +to your flags. + +3~ Configuration files + +SiSU configuration file search path is: + +_1 ./_sisu/sisurc.yaml + +_1 ~/.sisu/sisurc.yaml + +_1 /etc/sisu/sisurc.yaml + +.\"%% Debian Installation Note + +3~ Debian INSTALLATION Note + +It is best you see + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian + +for up the most up to date information. + +notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU): + +Package: sisu + +SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. + +With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), EPUB, LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs also share semantic meta-data provided. + +SiSU also provides concordance files, document content certificates and manifests of generated output. + +A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided, as are syntax highlighting files for kate, kwrite, gedit and diakonos. Vim 7 includes syntax highlighting for SiSU. + +man pages, and interactive help are provided. + +Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. + +Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. + +Homepage: http://www.jus.uio.no/sisu + +3~ Document Resource Configuration + +!_ sisu +resource configuration information is obtained from sources (where they exist): + +_1 ~/.sisu/sisurc.yaml + +_1 /etc/sisu/[sisu version]/sisurc.yaml + +_1 sisu program defaults + +3~ Skins + +!_ Skins +default document appearance may be modified using skins contained in sub-directories located at the following paths: + +_1 ./_sisu/skin + +_1 ~/.sisu/skin + +_1 /etc/sisu/skin + +more specifically, the following locations (or their /etc/sisu equivalent) should be used: + +_1 ~/.sisu/skin/doc + +skins for individual documents; + +_1 ~/.sisu/skin/dir + +skins for directories of matching names; + +_1 ~/.sisu/skin/site + +site-wide skin modifying the site-wide appearance of documents. + +Usually all skin files are placed in the document skin directory: + +_1 ~/.sisu/skin/doc + +with softlinks being made to the skins contained there from other skin +directories as required. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_hyperestraier.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_hyperestraier.ssi new file mode 100644 index 00000000..5674b4b4 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_hyperestraier.ssi @@ -0,0 +1,115 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Hyperestraier Search + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search - Hyperestraier + +:C~? Search + +1~search_hyperestraier Hyperestraier + +See the documentation for hyperestraier: + +_1 http://hyperestraier.sourceforge.net/ + +_1 /usr/share/doc/hyperestraier/index.html + +_1 man estcmd + +on sisu_hyperestraier: + +_1 man sisu_hyperestraier + +_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html + +NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www + +(A) to generate the index within the webserver directory to be indexed: + +_1 estcmd gather -sd [index name] [directory path to index] + +the following are examples that will need to be tailored according to your needs: + +_1 cd /home/ralph/sisu_www + +_1 estcmd gather -sd casket /home/ralph/sisu_www + +you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: + +_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - + +Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index. + +As sisu duplicates output in multiple file formats, it it is probably preferable to limit the estraier index to html output, and as it may also be desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as these duplicate information held in other html output e.g. + +_1 find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket - + +from your current document preparation/markup directory, you would construct a rune along the following lines: + +_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify first directory for inclusion]|[specify second directory for inclusion]|[another directory for inclusion? ...])/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd /home/ralph/sisu_www/casket - + +(B) to set up the search form + +(i) copy estseek.cgi to your cgi directory and set file permissions to 755: + +_1 sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin + +_1 sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi + +_1 sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin + +_1 [see estraier documentation for paths] + +(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:': + +_1 indexname: /home/ralph/sisu_www/casket + +_1 replace: ^file:///home/ralph/sisu_www{{!}}http://localhost + +_1 replace: /index.html?${{!}}/ + +(C) to test using webrick, start webrick: + +_1 sisu -W + +and try open the url: http://localhost:8081/cgi-bin/estseek.cgi + + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_installation.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_installation.ssi new file mode 100644 index 00000000..cde444ed --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_installation.ssi @@ -0,0 +1,389 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Installation + +@creator: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual.ssm SiSU.ssm + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? SiSU Installation notes + +:C~ Installation + +1~installation Installation + +See the {~^ download pages }http://www.jus.uio.no/sisu/SiSU/download ~{
http://www.jus.uio.no/sisu/sisu_download }~ for information related to installation. + +2~ Debian + +SiSU is developed on Debian, and packages are available for Debian that take care of the dependencies encountered on installation. + +The package is divided into the following components: + +_1 *sisu*, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies + +_1 *sisu-complete*, a dummy package that installs the whole of greater sisu as described below, apart from sisu-examples + +_1 *sisu-pdf*, dependencies used by sisu to produce pdf from LaTeX generated + +_1 *sisu-postgresql*, dependencies used by sisu to populate postgresql database (further configuration is necessary) + +_1 *sisu-remote*, dependencies used to place sisu output on a remote server (further configuration is necessary) + +_1 *sisu-sqlite*, dependencies used by sisu to populate sqlite database + +_1 *sisu-markup-samples*, sisu markup samples and other miscellany (under Debian Free Software Guidelines non-free) + +SiSU is available off { Debian Unstable and Testing }http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu&sourceid=mozilla-search ~{ http://packages.qa.debian.org/s/sisu.html }~ install it using apt-get, aptitude or alternative Debian install tools. SiSU is currently comprised of eight packages. *~apt-get + +Initial packaging is done here and to get the latest version of SiSU available you may add the following line(s) to your sources list: *~sources.list + +code{ + +#/etc/apt/sources.list + +deb http://www.jus.uio.no/sisu/archive unstable main non-free +deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +The non-free section is for sisu markup samples provided, which contain authored works the substantive text of which cannot be changed, and which as a result do not meet the debian free software guidelines. + +On Debian there is little more to know beyond how to install software on Debian using apt, aptitude or synaptic. + +code{ + +#Using aptitude: + + aptitude update + + aptitude install sisu-complete sisu-markup-samples + +}code + +code{ + +Using apt-get + + apt-get update + + apt get install sisu-complete sisu-examples + +}code + +2~ Other Unix / Linux + +A source tarball or an rpms built using alien are available, (however dependencies have not been tested). SiSU is first packaged and tested with dependency handling for Debian.~{ Notes on dependencies are provided in the section that follows }~ Information on dependencies configured for Debian is provided as this may be of assistance. + +3~ source tarball + +!_ installation with provided install script + +To install SiSU, in the root directory of the unpacked SiSU _{as root type}_:~{ This makes use of rant and the provided Rantfile. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. }~ + +_1 ruby install + +Once installed see man 8 sisu for information on additional programs that sisu makes use of. + +Further notes on install script. + +The install script is prepared using Rant, and a Rantfile *~rant is provided,~{ a Rantfile has been configured to do post installation setup }~ with more comprehensive install options, and post install and setup configuration and generation of first test file, if you have installed Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/
http://rubyforge.org/frs/?group_id=615 }~ installed. While in the package directory, type: rant help, or rant -T, or to install SiSU _{as root}_, type: + +*install* is an install script prepared using Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/
http://rubyforge.org/frs/?group_id=615 }~ It should work whether you have previously installed Rant or not. It has fairly comprehensive install options, and can do some post install and setup configuration and generation of first test file. For options type: + +_1 ruby install -T + +To install as root type: + +_1 ruby install + +For a minimal install type: + +_1 ruby install base + +!_ installation with setup.rb + +{~^ setup.rb }http://i.loveruby.net/en/projects/setup/ is provided the package and will install SiSU~{ Minero Aoki
http://i.loveruby.net/en/projects/setup/doc/ }~ installation is a 3 step process~{ Installation instructions
http://i.loveruby.net/en/projects/setup/doc/usage.html }~ the following string assumes you are in the package directory and that you have root as sudo: + +_1 ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install + +!_ installation of rpm + +The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. + +1~install_dependencies_and_notes SiSU Components, Dependencies and Notes + +The dependency lists are from the Debian control file for SiSU version 0.36, and may assist in building SiSU on other distributions. + +2~ sisu + +_* the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies + +*Depends:* on ruby (>=1.8.2), libwebrick-ruby + +*Recommends:* sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl + +initialise directory + +_1 sisu -CC + +html + +_1 sisu -hv [filename/wildcard] + +_1 sisu -Hv [filename/wildcard] + +LaTeX (but sisu-pdf dependencies required to convert that to pdf) + +_1 sisu -pv [filename/wildcard] + +plain text Unix with footnotes + +_1 sisu -av [filename/wildcard] + +plain text Dos with footnotes + +_1 sisu -Av [filename/wildcard] + +plain text Unix with endnotes + +_1 sisu -ev [filename/wildcard] + +plain text Dos with endnotes + +_1 sisu -Ev [filename/wildcard] + +openoffice odt + +_1 sisu -ov [filename/wildcard] + +xhtml + +_1 sisu -bv [filename/wildcard] + +XML SAX + +_1 sisu -xv [filename/wildcard] + +XML DOM + +_1 sisu -Xv [filename/wildcard] + +wordmap (a rudimentary index of content) + +_1 sisu -wv [filename/wildcard] + +document content certificate + +_1 sisu -Nv [filename/wildcard] + +placement of sourcefile in output directory + +_1 sisu -sv [filename/wildcard] + +creation of source tarball with images, and placement of source tarball in ouput directory + +_1 sisu -Sv [filename/wildcard] + +manifest of output produced (polls output directory and provides links to existing output) + +_1 sisu -yv [filename/wildcard] + +url for output files -u -U + +_1 sisu -uv[and other flags] [filename/wildcard] + +_1 sisu -Uv [filename/wildcard] + +toggle screen colour + +_1 sisu -cv[and processing flags] [filename/wildcard] + +verbose mode + +_1 sisu -v[and processing flags] [filename/wildcard] + +_1 sisu -V[and processing flags] [filename/wildcard] + +quiet mode + +_1 sisu -q[and processing flags] [filename/wildcard] + +maintenance mode, intermediate files kept -M + +_1 sisu -Mv[and other flags] [filename/wildcard] + +[the -v is for verbose] + +start the webrick server + +_1 sisu -W + +2~ sisu-complete + +_* a dummy package that installs the whole SiSU, apart from sisu-examples + +*Depends:* ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite + +*Recommends:* sisu-examples + +2~ sisu-examples + +_* installs sisu markup samples and other miscelleny + +*Depends:* sisu + +2~ sisu-pdf + +_* dependencies used by sisu to produce pdf from LaTeX generated + +*Depends:* sisu, tetex-bin, tetex-extra, latex-ucs + +*Suggests:* evince, xpdf + +converts sisu LaTeX produced to pdf + +_1 sisu -pv [filename/wildcard] + +[the -v is for verbose] + +2~ sisu-postgresql + +_* dependencies used by sisu to populate postgresql database (further configuration is necessary) + +*Depends:* sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby + +*Suggests:* pgaccess, libdbd-pgsql, postgresql-contrib-8.1 + +installs dependencies for sisu to work with and populate postgresql database + +create database + +_1 sisu -Dv createall + +drop database + +_1 sisu -Dv dropall + +import content + +_1 sisu -Div [filename/wildcard] + +_1 sisu -Dv import [filename/wildcard] + +update content + +_1 sisu -Duv [filename/wildcard] + +_1 sisu -Dv update [filename/wildcard] + +[the -v is for verbose] + +The following are available without installation of the sisu-postgresql component, but are of interest in this context + +generate a sample database query form for use with webserver on port 80 + +_1 sisu -F + +or for use with webrick server + +_1 sisu -F webrick + +to start webrick server + +_1 sisu -W + +2~ sisu-remote + +_* dependencies used to place sisu output on a remote server (further configuration is necessary) + +scp + +_1 sisu -vr[and processing flags] [filename/wildcard] + +rsync + +_1 sisu -vR[and processing flags] [filename/wildcard] + +[the -v is for verbose] + +*Depends:* sisu, rsync, openssh-client|lsh-client, keychain + +2~ sisu-sqlite + +_* dependencies used by sisu to populate sqlite database + +*Depends:* sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby + +*Suggests:* libdbd-sqlite + +installs dependencies for sisu to work with and populate sqlite database + +create database + +_1 sisu -dv createall + +drop database + +_1 sisu -dv dropall + +update content + +_1 sisu -div [filename/wildcard] + +_1 sisu -dv import [filename/wildcard] + +update content + +_1 sisu -duv [filename/wildcard] + +_1 sisu -dv update [filename/wildcard] + +[the -v is for verbose] + +The following are available without installation of the sisu-sqlite component, but are of interest in this context + +generate a sample database query form for use with webserver on port 80 + +_1 sisu -F + +or for use with webrick server + +_1 sisu -F webrick + +to start webrick server + +_1 sisu -W + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi new file mode 100644 index 00000000..3c8b12b0 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_interesting_to_whom.ssi @@ -0,0 +1,53 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Who Might Be Interested? + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Who might SiSU interest? + +1~sisu_interest Who might be interested in the SiSU feature set? + +SiSU is most likely to be of interest to people who are working with medium to large volumes of published texts that would like to have the presented in a uniform way that is searchable (either using sisu database integration or an appropriate indexing tool), with the possibility of multiple alternative output formats that may be added to and upgraded/updated over time. SiSU should be of interest to institutions/ organisations/ governments/ individuals with document collections and some technical knowhow that are interested in: + +_* long term maintenance and reducing downstream/future costs of maintaining those document sets for which SiSU is suited. + +_* the ability to output multiple standard format outputs for various purposes. + +_* the implications for search offered diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_introduction.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_introduction.sst new file mode 100644 index 00000000..b01eed59 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_introduction.sst @@ -0,0 +1,72 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Introduction + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? What is SiSU? + +:C~? Description + +1~sisu_intro Introduction - What is SiSU? + +SiSU is a framework for document structuring, publishing (in multiple open standard formats) and search, comprising of: (a) a lightweight document structure and presentation markup syntax; and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs (including the population of sql databases) that (can) share a common numbering system for the citation of text within a document. + +SiSU is developed under an open source, software libre license (GPL3). Its use case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output formats. Various output formats (including search related output) share a common mechanism for cross-output-format citation. + +SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, EPUB, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. + +Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. + +In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds~{ i.e. the html, pdf, epub, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested. + +SiSU works with an abstraction of the document based on its structure which is comprised of its headings~{ the different heading levels }~ and objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common basis for citing material within a document across the different output format types. This is significant as page numbers are not well suited to the digital age, in web publishing, changing a browser's default font or using a different browser can mean that text will appear on a different page; and publishing in different formats, html, landscape and portrait pdf etc. again page numbers are not useful to cite text. Dealing with documents at an object level together with object numbering also has implications for search that SiSU is able to take advantage of. + +One of the challenges of maintaining documents is to keep them in a format that allows use of them independently of proprietary platforms. Consider issues related to dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of producing documents in multiple non-proprietary open formats including html, pdf~{ Specification submitted by Adobe to ISO to become a full open ISO specification
http://www.linux-watch.com/news/NS7542722606.html }~ ODF,~{ ISO standard ISO/IEC 26300:2006 }~ and EPUB.~{ An open standard format for e-books }~ Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre, which means that that code base can be used, updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006 when it became an ISO standard for office applications and the archival of documents), EPUB was introduced in 2009; and allows the technical representations existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). + +The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. + +SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has further possibilities for the research and development of other document representations, the availability of objects is useful for example for topic maps and thesauri, together with the flexibility of SiSU offers great possibilities. + +SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. + +http://www.jus.uio.no/sisu + +% SiSU is a way of preparing, publishing, managing and searching documents. + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_manual.ssm b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_manual.ssm new file mode 100644 index 00000000..7622d0b0 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_manual.ssm @@ -0,0 +1,118 @@ +% SiSU master 3.0 + +@title: SiSU + :subtitle: Manual + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: manual + +@date: + :published: 2008-07-21 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~ @title @creator + +:B~ What is SiSU? + +<< sisu_introduction.sst + +<< sisu_how.ssi + +<< sisu_short_feature_summary.ssi + +<< sisu_help.sst + +% :B~? SiSU Commands + +<< sisu_commands.sst + +% :B~? SiSU Markup + +<< sisu_markup.sst + +<< sisu_filetypes.sst + +% :B~? SiSU Configuration and Skins + +<< sisu_config.ssi + +<< sisu_skin.sst + +<< sisu_css.ssi + +<< sisu_content_directories.ssi + +<< sisu_homepages.ssi + +% :B~? SiSU Output and Markup Examples + +<< sisu_examples.sst + +<< sisu_output_overview.sst + +<< sisu_search_intro.ssi + +<< sisu_sql.ssi + +<< sisu_postgresql.sst + +<< sisu_sqlite.sst + +<< sisu_search_cgi.ssi + +<< sisu_hyperestraier.ssi + +<< sisu_webrick.sst + +<< sisu_remote.sst + +% :B~? SiSU Download and Installation + +<< sisu_download.ssi + +<< sisu_installation.ssi + +<< sisu_quickstart.sst + +% :B~? SiSU Howto and FAQ + +<< sisu_howto.sst + +<< sisu_faq.sst + +<< sisu_interesting_to_whom.ssi + +<< sisu_work_needed_and_wishlist.ssi + +<< sisu_syntax_highlighting.sst + +<< sisu_help_sources.sst diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_markup.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_markup.sst new file mode 100644 index 00000000..be36fc79 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_markup.sst @@ -0,0 +1,1417 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Markup + +@creator: + :author: Amissah, Ralph + +@rights: + :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation + :license: GPL 3 or later + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: SiSU.ssm sisu.ssm + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2008-05-22 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }../SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Markup + +1~markup Introduction to SiSU Markup~{ 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. }~ + +2~ Summary + +SiSU source documents are plaintext (UTF-8)~{ files should be prepared using UTF-8 character encoding }~ files + +All paragraphs are separated by an empty line. + +Markup is comprised of: + +_* 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) + +_* 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: + +_1* heading levels defines document structure + +_1* text basic attributes, italics, bold etc. + +_1* grouped text (objects), which are to be treated differently, such as code blocks or poems. + +_1* footnotes/endnotes + +_1* linked text and images + +_1* paragraph actions, such as indent, bulleted, numbered-lists, etc. + +Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup + +To check the markup in a file: + +_1 sisu --identify [filename].sst + +For brief descriptive summary of markup history + +_1 sisu --query-history + +or if for a particular version: + +_1 sisu --query-0.38 + +2~ Markup Examples + +3~ Online + +Online markup examples are available together with the respective outputs produced from http://www.jus.uio.no/sisu/SiSU/examples.html or from http://www.jus.uio.no/sisu/sisu_examples/ + +There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: http://www.jus.uio.no/sisu/sisu_markup/ + +Some example marked up files are available as html with syntax highlighting for viewing: http://www.jus.uio.no/sisu/sample/syntax + +an alternative presentation of markup syntax: http://www.jus.uio.no/sisu/sample/on_markup.txt + +3~ Installed + +With SiSU 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 + +1~headers Markup of Headers + +Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions. + +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: + +code{ + +% this would be a comment + +}code + +2~ Sample Header + +This current document is loaded by a master document that has a header similar to this one: + +code{ + +% SiSU master 2.0 + +@title: SiSU + :subtitle: Manual + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, + electronic document, electronic citation, data structure, + citation systems, search + +% used_by: manual + +@date: + :published: 2008-05-22 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2010-03-03 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; + synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] + . sisu [-Ddcv] [instruction] + . sisu [-CcFLSVvW] + . sisu --v2 [operations] + . sisu --v1 [operations] + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +}code + +2~ Available Headers + +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 the form @headername: or on the next line and indented by once space :subheadername: All Dublin Core meta tags are available + +!_ @indentifier: +information or instructions + +where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified + +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. + +This is a sample header + +% (Dublin Core in fuschia, other information headers in cyan, markup instructions in red): + +code{ + +% SiSU 2.0 [declared file-type identifier with markup version] + +}code + + +code{ + +@title: [title text] [this header is the only one that is mandatory] + :subtitle: [subtitle if any] + :language: English + +}code + +code{ + +@creator: + :author: [Lastname, First names] + :illustrator: [Lastname, First names] + :translator: [Lastname, First names] + :prepared_by: [Lastname, First names] + +}code + +code{ + +@date: + :published: [year or yyyy-mm-dd] + :created: [year or yyyy-mm-dd] + :issued: [year or yyyy-mm-dd] + :available: [year or yyyy-mm-dd] + :modified: [year or yyyy-mm-dd] + :valid: [year or yyyy-mm-dd] + :added_to_site: [year or yyyy-mm-dd] + :translated: [year or yyyy-mm-dd] + +}code + +code{ + +@rights: + :copyright: Copyright (C) [Year and Holder] + :license: [Use License granted] + :text: [Year and Holder] + :translation: [Name, Year] + :illustrations: [Name, Year] + +}code + +code{ + +@classify: + :topic_register: SiSU:markup sample:book;book:novel:fantasy + :type: + :subject: + :description: + :keywords: + :abstract: + :isbn: [ISBN] + :loc: [Library of Congress classification] + :dewey: [Dewey classification + :pg: [Project Gutenberg text number] + +}code + +code{ + +@links: { SiSU }http://www.jus.uio.no/sisu/ + { FSF }http://www.fsf.org + +}code + +code{ + +@make: + :skin: skin_name [skins change default settings related to the appearance of documents generated] + :num_top: 1 + :headings: [text to match for each level + (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) + :breaks: new=:C; break=1 + :promo: sisu, ruby, sisu_search_libre, open_society + :bold: [regular expression of words/phrases to be made bold] + :italics: [regular expression of words/phrases to italicise] + +}code + +code{ + +@original: + :language: [language] + +}code + +code{ + +@notes: + :comment: + :prefix: [prefix is placed just after table of contents] + +}code + +% header ends here, NB only @title: is mandatory [this would be a comment] +% NOTE: headings/levels below refer to 0.38 expermental markup (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 and 0.38 markup simple) + +1~ Markup of Substantive Text + +2~heading_levels Heading Levels + +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) + +!_ :A~ [heading text] +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 + +!_ :B~ [heading text] +Second level heading [this is a heading level divider] + +!_ :C~ [heading text] +Third level heading [this is a heading level divider] + +!_ 1~ [heading text] +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 + +!_ 2~ [heading text] +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. + +!_ 3~ [heading text] +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 + +code{ + +1~filename level 1 heading, + +% 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) + +}code + +2~ Font Attributes + +!_ markup example: + +code{ + +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# + +normal text + +*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] + +!{bold text}! + +/{italics}/ + +_{underscore}_ + +"{citation}" + +^{superscript}^ + +,{subscript}, + ++{inserted text}+ + +-{strikethrough}- + +#{monospace}# + +}code + +!_ resulting output: + +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# + +normal text + +*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] + +!{bold text}! + +/{italics}/ + +_{underscore}_ + +"{citation}" + +^{superscript}^ + +,{subscript}, + ++{inserted text}+ + +-{strikethrough}- + +#{monospace}# + +2~ Indentation and bullets + +!_ markup example: + +code{ + +ordinary paragraph + +_1 indent paragraph one step + +_2 indent paragraph two steps + +_9 indent paragraph nine steps + +}code + +!_ resulting output: + +ordinary paragraph + +_1 indent paragraph one step + +_2 indent paragraph two steps + +_9 indent paragraph nine steps + +!_ markup example: + +code{ + +_* bullet text + +_1* bullet text, first indent + +_2* bullet text, two step indent + +}code + +!_ resulting output: + +_* bullet text + +_1* bullet text, first indent + +_2* bullet text, two step indent + +Numbered List (not to be confused with headings/titles, (document structure)) + +!_ markup example: + +code{ + +# numbered list numbered list 1., 2., 3, etc. + +_# numbered list numbered list indented a., b., c., d., etc. + +}code + +2~ Footnotes / Endnotes + +Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced + +!_ markup example: + +code{ + +~{ a footnote or endnote }~ + +}code + +!_ resulting output: + +~{ a footnote or endnote }~ + +!_ markup example: + +code{ + +normal text~{ self contained endnote marker & endnote in one }~ continues + +}code + +!_ resulting output: + +normal text~{ self contained endnote marker & endnote in one }~ continues + +!_ markup example: + +code{ + +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues + +}code + +!_ resulting output: + +normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues + +normal text ~{** another unnumbered asterisk footnote/endnote }~ continues + +!_ markup example: + +code{ + +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues + +}code + +!_ resulting output: + +normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues + +normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues + +!_ Alternative endnote pair notation for footnotes/endnotes: + +code{ + +% note the endnote marker "~^" + +normal text~^ continues + +^~ endnote text following the paragraph in which the marker occurs + +}code + +the standard and pair notation cannot be mixed in the same document + +2~ Links + +3~ Naked URLs within text, dealing with urls + +urls found within text are 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). + +!_ markup example: + +code{ + +normal text http://www.jus.uio.no/sisu continues + +}code + +!_ resulting output: + +normal text http://www.jus.uio.no/sisu continues + +An escaped url without decoration + +!_ markup example: + +code{ + +normal text _http://www.jus.uio.no/sisu continues + +deb http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +!_ resulting output: + +normal text _http://www.jus.uio.no/sisu continues + +deb _http://www.jus.uio.no/sisu/archive unstable main non-free + +where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document + +!_ resulting output: + +code{ + +deb http://www.jus.uio.no/sisu/archive unstable main non-free +deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +3~link_text Linking Text + +To link text or an image to a url the markup is as follows + +!_ markup example: + +code{ + +about { SiSU }http://url.org markup + +}code + +!_ resulting output: + +about { SiSU }http://www.jus.uio.no/sisu/ markup + +A shortcut notation is available so the url link may also be provided automatically as a footnote + +!_ markup example: + +code{ + +about {~^ SiSU }http://url.org markup + +}code + +!_ resulting output: + +about {~^ SiSU }http://www.jus.uio.no/sisu/ markup + +Internal document links to a tagged location, including an ocn + +!_ markup example: + +code{ + +about { text links }#link_text + +}code + +!_ resulting output: + +about { text links }#link_text + +Shared document collection link + +!_ markup example: + +code{ + +about { SiSU book markup examples }:SiSU/examples.html + +}code + +!_ resulting output: + +about { SiSU book markup examples }:SiSU/examples.html + +3~ Linking Images + +!_ markup example: + +code{ + +{ tux.png 64x80 }image + +% various url linked images + +{tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/ + +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ + +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + +}code + +!_ resulting output: + +{ tux.png 64x80 }image + +{tux.png 64x80 "Gnu/Linux - a better way" }http://www.jus.uio.no/sisu/ + +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ + +{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ + +!_ linked url footnote shortcut + +code{ + +{~^ [text to link] }http://url.org + +% maps to: { [text to link] }http://url.org ~{ http://url.org }~ + +% which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink + +}code + +code{ + +text marker *~name + +}code + +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. + +2~ Grouped Text + +3~ Tables + +Tables may be prepared in two either of two forms + +!_ markup example: + +code{ + +table{ c3; 40; 30; 30; + +This is a table +this would become column two of row one +column three of row one is here + +And here begins another row +column two of row two +column three of row two, and so on + +}table + +}code + +!_ resulting output: + +table{ c3; 40; 30; 30; + +This is a table +this would become column two of row one +column three of row one is here + +And here begins another row +column two of row two +column three of row two, and so on + +}table + +a second form may be easier to work with in cases where there is not much information in each column + +*{markup example:}*~{ Table from the Wealth of Networks by Yochai Benkler
http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler }~ + +code{ + +!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 + +{table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 +Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 +Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 +Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 +No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 +No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 + +\* Contributed at least ten times; \** at least 5 times in last month; \*\** more than 100 times in last month. + +}code + +!_ resulting output: + + +!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 + +{table~h 24; 12; 12; 12; 12; 12; 12;} + |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 +Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 +Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 +Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 +No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 +No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 + +\* Contributed at least ten times; \** at least 5 times in last month; \*\** more than 100 times in last month. + +% code{ + +% test + +% ~# + +% % unnumbered paragraph (place marker at end of paragraph) + +% -# + +% % unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] + +% % add a comment to text, that will be removed prior to processing (place marker at beginning of line) + +% }code + +3~ Poem + +!_ basic markup: + +code{ + +poem{ + + Your poem here + +}poem + +Each verse in a poem is given an object number. + +}code + +!_ markup example: + +code{ + +poem{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}poem + +}code + +!_ resulting output: + +poem{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}poem + +3~ Group + +!_ basic markup: + +code{ + +group{ + + Your grouped text here + +}group + +A group is treated as an object and given a single object number. + +}code + +!_ markup example: + +code{ + +group{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}group + +}code + +!_ resulting output: + +group{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}group + +3~ Code + +Code tags #{ code{ ... }code }# (used as with other group tags described above) are used to escape regular sisu markup, and have been used extensively within this document to provide examples of SiSU markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. + +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] + +!_ use of code tags instead of poem compared, resulting output: + +code{ + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}code + +From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag #{ code{# }# as demonstrated here: + +code{# + + `Fury said to a + mouse, That he + met in the + house, + "Let us + both go to + law: I will + prosecute + YOU. --Come, + I'll take no + denial; We + must have a + trial: For + really this + morning I've + nothing + to do." + Said the + mouse to the + cur, "Such + a trial, + dear Sir, + With + no jury + or judge, + would be + wasting + our + breath." + "I'll be + judge, I'll + be jury," + Said + cunning + old Fury: + "I'll + try the + whole + cause, + and + condemn + you + to + death."' + +}code + +2~ Book index + +To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. + +Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon. + +code{ + + Paragraph containing main term and sub-term. + ={Main term:sub-term} + +}code + +The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup. + +The structure of the resulting index would be: + +code{ + + Main term, 1 + sub-term, 1 + +}code + +Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. + +code{ + + Paragraph containing main term, second term and sub-term. + ={first term; second term: sub-term} + +}code + +The structure of the resulting index would be: + +code{ + + First term, 1, + Second term, 1, + sub-term, 1 + +}code + +If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. + +code{ + + Paragraph containing main term, second term and sub-term. + ={Main term:sub-term+1|second sub-term + + A paragraph that continues discussion of the first sub-term + +}code + +The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: + +code{ + + Main term, 1, + sub-term, 1-3, + second sub-term, 1, + +}code + +1~ Composite documents markup + +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 *{.ssm}* 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 *{.sst}* regular markup file, or *{.ssi}* (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix *{._sst}* + +basic markup for importing a document into a master document + +code{ + +<< filename1.sst + +<< filename2.ssi + +}code + +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. + +code{ + +<< filename.ssi + +<<{filename.ssi} + +% using textlink alternatives + +<< |filename.ssi|@|^| + +}code + +:C~ Markup Syntax History + +1~ Notes related to Files-types and Markup Syntax + +2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) + +0.38 is substantially current for version 1.0 + +depreciated 0.16 supported, though file names were changed at 0.37 + +_* sisu --query=[sisu version [0.38] or 'history] + +provides a short history of changes to SiSU markup + +!_ SiSU 2.0 +(2010-03-06:09/6) +same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g. + +code{ + +@title: + :subtitle: + +@creator: + :author: + :translator: + :illustrator: + +@rights: + :text: + :illustrations: + +}code + +see document markup samples, and sisu --help headers + +the monospace tag takes the form of a hash '#' + +code{ + +#{ this enclosed text would be monospaced }# + +}code + +!_ 1.0 +(2009-12-19:50/6) +same as 0.69 + +!_ 0.69 +(2008-09-16:37/2) +(same as 1.0) and as previous (0.57) with the addition of book index tags + +code{ + +/^={.+?}$/ + +}code + +e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object" + +code{ + + ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} + +}code + +code{ + +Free Software Foundation, 1-6 +GNU/Linux community distribution, 1 + Debian, 1-3 + Fedora, 1 + Gentoo, + +}code + +!_ 0.66 +(2008-02-24:07/7) +same as previous, adds semantic tags, [experimental and not-used] + +code{ + +/[:;]{.+?}[:;][a-z+]/ + +}code + +!_ 0.57 +(2007w34/4) +SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the contents of the headers @title: and @author:] + +code{ + +:A~ @title by @author + +}code + +!_ 0.52 +(2007w14/6) +declared document type identifier at start of text/document: + +_1 SiSU 0.52 + +or, backward compatible using the comment marker: + +_1 % SiSU 0.38 + +variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' + +!_ 0.51 +(2007w13/6) +skins changed (simplified), markup unchanged + +!_ 0.42 +(2006w27/4) +* (asterisk) type endnotes, used e.g. in relation to author + +SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types, + +Introduces some variations on endnotes, in particular the use of the asterisk + +code{ + +~{* for example for describing an author }~ and ~{** for describing a second author }~ + +}code + +* for example for describing an author + +** for describing a second author + +and + +code{ + +~[* my note ]~ or ~[+ another note ]~ + +}code + +which numerically increments an asterisk and plus respectively + +*1 my note ++1 another note + +!_ 0.38 +(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) + +SiSU 0.38 introduced alternative experimental header and heading/structure markers, + +code{ + +@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ + +}code + +as the equivalent of: + +code{ + +0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ + +}code + +The internal document markup of SiSU 0.16 remains valid and standard Though note that SiSU 0.37 introduced a new file naming convention + +SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 must exist, optional 2 and 3 may follow in sequence i.e. there are two independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes explicit an aspect of structuring documents in SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels + +!_ 0.37 +(2006w09/7) +introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged + +SiSU 0.37 introduced new file naming convention, using the file extensions .sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si + +this is captured by the following file 'rename' instruction: + +code{ + +rename 's/\.s[123]$/\.sst/' *.s{1,2,3} +rename 's/\.r[123]$/\.ssm/' *.r{1,2,3} +rename 's/\.si$/\.ssi/' *.si + +}code + +The internal document markup remains unchanged, from SiSU 0.16 + +!_ 0.35 +(2005w52/3) +sisupod, zipped content file introduced + +!_ 0.23 +(2005w36/2) +utf-8 for markup file + +!_ 0.22 +(2005w35/3) +image dimensions may be omitted if rmagick is available to be relied upon + +!_ 0.20.4 +(2005w33/4) +header 0~links + +!_ 0.16 +(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 + +SiSU 0.16 (0.15 development branch) introduced the use of + +the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ + +in place of the 0.1 header, heading/structure notation + +SiSU 0.1 headers and headings structure represented by +header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_output_overview.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_output_overview.sst new file mode 100644 index 00000000..9664a189 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_output_overview.sst @@ -0,0 +1,160 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: SiSU overview of status of features available in various outputs + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:markup table;SiSU:manual:output overview;electronic documents:SiSU:manual:output overview;SiSU:document:output overview;SiSU:document:output overview + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: manual, document + +@date: + :published: 2007-09-16 + :created: 2005-10-31 + :available: 2006-10-31 + :issued: 2006-10-31 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual +% :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU overview of status of features available in various outputs + +1~ A Checklist of Output Features + +% 2~ features available in various output types + +This table gives an indication of the features that are available +for various forms of output of SiSU. + +!_ sisu-2.0.0 on 2010-03-06 + +{table~h 28} +feature |txt|ltx/pdf|HTML|EPUB|XML/s|XML/d|ODF|SQLite|pgSQL +headings | * | * | * | * | * | * | * | * | * +footnotes | * | * | * | * | * | * | * | * | * +bold, underscore, italics | . | * | * | * | * | * | * | * | * +strikethrough | . | * | * | * | * | * | * | | +superscript, subscript | . | * | * | * | * | * | * | | +extended ascii set (utf-8)| * | * | * | * | * | * | * | | * +indents | * | * | * | * | * | * | * | | +bullets | . | * | * | * | * | * | . | | +groups | | | | | | | | | +* tables | | * | * | * | . | . | . | . | . +* poem | * | * | * | * | . | . | * | . | . +* code | * | * | * | * | . | . | * | . | . +url | * | * | * | * | * | * | * | . | . +links | * | * | * | * | * | * | * | . | . +images | - | * | * | * | T | T | * | T | T +image caption | - | * | * | * | | | | | +table of contents | | * | * | * | * | * | . | | +page header/footer? | - | * | * | * | * | * | t | | +line break | * | * | * | * | * | * | * | | +page break | | * | | | | | * | | +segments | | | * | * | | | | | +skins | * | * | * | * | * | * | | | +ocn | . | * | * | * | * | * | -?| * | * +auto-heading numbers | * | * | * | * | * | * | * | * | * +minor list numbering | * | * | * | * | * | * | * | * | * +special characters | . | . | . | . | | | | | + +!_ sisu-1.0.0 on 2009-10-28 + +{table~h 28} +feature |txt|ltx/pdf|HTML|XML/s|XML/d|ODF|SQLite|pgSQL +headings | * | * | * | * | * | * | * | * +footnotes | * | * | * | * | * | * | * | * +bold, underscore, italics | . | * | * | * | * | * | * | * +strikethrough | . | * | * | * | * | * | | +superscript, subscript | . | * | * | * | * | * | | +extended ascii set (utf-8)| * | * | * | * | * | * | | * +indents | * | * | * | * | * | * | | +bullets | . | * | * | * | * | . | | +groups | | | | | | | | +* tables | | * | * | . | . | . | . | . +* poem | * | * | * | . | . | * | . | . +* code | * | * | * | . | . | * | . | . +url | * | * | * | * | * | * | . | . +links | * | * | * | * | * | * | . | . +images | - | * | * | T | T | * | T | T +image caption | - | * | * | | | | | +table of contents | | * | * | * | * | . | | +page header/footer? | - | * | * | * | * | t | | +line break | * | * | * | * | * | * | | +page break | | * | | | | * | | +segments | | | * | | | | | +skins | * | * | * | * | * | | | +ocn | . | * | * | * | * | -?| * | * +auto-heading numbers | * | * | * | * | * | * | * | * +minor list numbering | * | * | * | * | * | * | * | * +special characters | . | . | . | | | | | + +!_ sisu-0.36.6 on 2006-01-23 + +{table~h 28; 8; 8; 8; 8; 8; 8; 8; 8; 8;} +feature |txt|ltx/pdf|HTML|XHTML|XML/s|XML/d|ODF|SQLite|pgSQL +headings | * | * | * | * | * | * | * | * | * +footnotes | * | * | * | * | * | * | * | * | * +bold, underscore, italics | . | * | * | * | * | * | * | * | * +strikethrough | . | * | * | * | * | * | * | | +superscript, subscript | . | * | * | * | * | * | * | | +extended ascii set (utf-8)| * | * | * | * | * | * | * | | * +indents | * | * | * | * | * | * | * | | +bullets | . | * | * | * | * | * | . | | +groups | | | | | | | | | +* tables | | * | * | . | . | . | . | . | . +* poem | * | * | * | . | . | . | * | . | . +* code | * | * | * | . | . | . | * | . | . +url | * | * | * | * | * | * | * | . | . +links | * | * | * | * | * | * | * | . | . +images | - | * | * | T | T | T | * | T | T +image caption | - | * | * | | | | | | +table of contents | | * | * | * | * | * | . | | +page header/footer? | - | * | * | * | * | * | t | | +line break | * | * | * | * | * | * | * | | +page break | | * | | | | | * | | +segments | | | * | | | | | | +skins | * | * | * | * | * | * | | | +ocn | . | * | * | * | * | * | -?| * | * +auto-heading numbers | * | * | * | * | * | * | * | * | * +minor list numbering | * | * | * | * | * | * | * | * | * +special characters | . | . | . | | | | | | + +group{ + + Done + * yes/done + . partial + + - not available/appropriate + + Not Done + T task todo + t lesser task/todo + not done + +}group + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_postgresql.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_postgresql.sst new file mode 100644 index 00000000..9d226d66 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_postgresql.sst @@ -0,0 +1,98 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Search + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :topic_register: electronic documents:SiSU:document:postgresql;SiSU:manual:postgresql;electronic documents:SiSU:manual:postgresql;SiSU:document:postgresql;SiSU:document:postgresql; + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual.ssm SiSU.ssm + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -Dv [filename/wildcard ]\n sisu -Dv [instruction] + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +% :B~? SiSU Postgresql + +1~postgresql Postgresql + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system, postgresql dependency package + +2~ Description + +Information related to using postgresql with sisu (and related to the sisu_postgresql dependency package, which is a dummy package to install dependencies needed for SiSU to populate a postgresql database, this being part of SiSU - man sisu). + +2~ Synopsis + +_1 sisu -D [instruction] [filename/wildcard if required] + +_1 sisu -D --pg --[instruction] [filename/wildcard if required] + + +2~ Commands + +Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql may be used + +!_ -D or --pgsql +may be used interchangeably. + +3~ create and destroy database + +!_ --pgsql --createall
+initial step, creates required relations (tables, indexes) in existing (postgresql) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) + +!_ sisu -D --createdb
+creates database where no database existed before + +!_ sisu -D --create
+creates database tables where no database tables existed before + +!_ sisu -D --Dropall
+destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). + +!_ sisu -D --recreate
+destroys existing database and builds a new empty database structure + +3~ import and remove documents + +!_ sisu -D --import -v [filename/wildcard]
+populates database with the contents of the file. Imports documents(s) specified to a postgresql database (at an object level). + +!_ sisu -D --update -v [filename/wildcard]
+updates file contents in database + +!_ sisu -D --remove -v [filename/wildcard]
+removes specified document from postgresql database. + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_quickstart.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_quickstart.sst new file mode 100644 index 00000000..0752264e --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_quickstart.sst @@ -0,0 +1,272 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Quickstart, installation and use + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:quickstart;SiSU:manual:quickstart;electronic documents:SiSU:manual:quickstart;SiSU:document:quickstart;SiSU:document:quickstart + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: SiSU.ssm sisu_manual.ssm + +@date: + :created: 2006-09-06 + :available: 2006-09-06 + :issued: 2006-09-06 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Quickstart - SiSU installation and use + +1~ Quickstart - Getting Started Howto + +2~ Installation + +Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. + +3~ Debian Installation + +SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: + +code{ + + aptitude update + aptitude install sisu-complete + +}code + +The following /etc/apt/sources.list setting permits the download of additional markup samples: + +code{ + +#/etc/apt/sources.list + + deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib + deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib + +}code + +The aptitude commands become: + +code{ + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +}code + +If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list + +code{ + +#/etc/apt/sources.list + + deb http://www.jus.uio.no/sisu/archive unstable main non-free + deb-src http://www.jus.uio.no/sisu/archive unstable main non-free + +}code + +repeat the aptitude commands + +code{ + + aptitude update + aptitude install sisu-complete sisu-markup-samples + +}code + +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. + +3~ RPM Installation + +RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. + +They may be downloaded from: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm + +as root type: + +_1 rpm -i [rpm package name] + +3~ Installation from source + +To install SiSU from source check information at: + +_1 http://www.jus.uio.no/sisu/SiSU/download.html#current + +_* download the source package + +_* Unpack the source + +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: + +For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, EPUB, 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)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf. + +!_ setup.rb + +This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: + +code{ + + ruby setup.rb config + ruby setup.rb setup + #[and as root:] + ruby setup.rb install + +}code + +further information on setup.rb is available from: + +_1 http://i.loveruby.net/en/projects/setup/ + +_1 http://i.loveruby.net/en/projects/setup/doc/usage.html + +!_ "install" + +The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: + +_1 ruby install base + +or for a more complete installation: + +_1 ruby install + +or + +_1 ruby install base + +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. + +Further information on "rant" is available from: + +_1 http://make.rubyforge.org/ + +_1 http://rubyforge.org/frs/?group_id=615 + +For a list of alternative actions you may type: + +_1 ruby install help + +_1 ruby install -T + +2~ Testing SiSU, generating output + +To check which version of sisu is installed: + +sisu -v + +Depending on your mode of installation one or a number of markup sample files may be found either in the directory: + +... + +or + +... + +change directory to the appropriate one: + +cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + +3~ basic text, plaintext, html, XML, ODF, EPUB + +Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + +sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text + +3~ LaTeX / pdf + +Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) + +Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it + +sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst + +sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst + +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 + +3~ relational database - postgresql, sqlite + +Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. + +Assuming you have the database installed and the requisite permissions + +sisu --sqlite --recreate + +sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +sisu --pgsql --recreate + +sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst + +2~ Getting Help + +3~ The man pages + +Type: + +_1 man sisu + +The man pages are also available online, though not always kept as up to date as within the package itself: + +_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1 + +_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8 + +_* {~^ man directory }http://www.jus.uio.no/sisu/man + +3~ Built in help + +sisu --help + +sisu --help --env + +sisu --help --commands + +sisu --help --markup + +3~ The home page + +http://www.jus.uio.no/sisu + +http://www.jus.uio.no/sisu/SiSU + +2~ Markup Samples + +A number of markup samples (along with output) are available off: + +http://www.jus.uio.no/sisu/SiSU/examples.html + +Additional markup samples are packaged separately in the file: + +*** + +On Debian they are available in non-free~{ the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. }~ to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_remote.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_remote.sst new file mode 100644 index 00000000..0782a290 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_remote.sst @@ -0,0 +1,106 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Remote Operations + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:remote;SiSU:manual:remote;electronic documents:SiSU:manual:remote;SiSU:document:remote;SiSU:document:remote + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual.ssm SiSU.ssm + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Remote Operations + +1~remote_source Remote Source Documents + +SiSU processing instructions can be run against remote source documents by providing the url of the documents against which the processing instructions are to be carried out. The remote SiSU documents can either be sisu marked up files in plaintext .sst or .ssm or; zipped sisu files, sisupod.zip or filename.ssp + +!_ .sst / .ssm - sisu text files + +SiSU can be run against source text files on a remote machine, provide the processing instruction and the url. The source file and any associated parts (such as images) will be downloaded and generated locally. + +code{ + +sisu -3 http://[provide url to valid .sst or .ssm file] + +}code + +Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url for the desired document. + +NOTE: to set up a remote machine to serve SiSU documents in this way, images should be in the directory relative to the document source ../_sisu/image + +!_ sisupod - zipped sisu files + +A sisupod is the zipped content of a sisu marked up text or texts and any other associated parts to the document such as images. + +SiSU can be run against a sisupod on a (local or) remote machine, provide the processing instruction and the url, the sisupod will be downloaded and the documents it contains generated locally. + +code{ + +sisu -3 http://[provide url to valid sisupod.zip or .ssp file] + +}code + +Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url for the desired document. + +:C~ Remote Document Output + +1~remote_output Remote Output + +Once properly configured SiSU output can be automatically posted once generated to a designated remote machine using either rsync, or scp. + +In order to do this some ssh authentication agent and keychain or similar tool will need to be configured. Once that is done the placement on a remote host can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used in conjunction with other processing flags, e.g. + +code{ + +sisu -3R sisu_remote.sst + +}code + +2~ commands + +!_ -R [filename/wildcard]
+copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see -r + +!_ -r [filename/wildcard]
+copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see -R + +2~ configuration + +[expand on the setting up of an ssh-agent / keychain] + +1~remote_servers Remote Servers + +As SiSU is generally operated using the command line, and works within a Unix type environment, SiSU the program and all documents can just as easily be on a remote server, to which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search.ssm b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search.ssm new file mode 100644 index 00000000..e2d8c459 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search.ssm @@ -0,0 +1,53 @@ +% SiSU master 3.0 + +@title: SiSU + :subtitle: Search + +@creator: :author: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +<< sisu_search_intro.ssi + +<< sisu_sql.ssi + +<< sisu_postgresql.sst + +<< sisu_sqlite.sst + +<< sisu_search_cgi.ssi + +<< sisu_hyperestraier.ssi diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_cgi.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_cgi.ssi new file mode 100644 index 00000000..dd5f1b54 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_cgi.ssi @@ -0,0 +1,99 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Search + +@creator: :author: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual.ssm sisu.ssm + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? CGI Search Form + +1~search_cgi Introduction + +2~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search + +{~^ Sample search frontend }http://search.sisudoc.org +A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. }~ + +SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. + +Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ + +% Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. + +!_ sisu -F --webserv-webrick
+builds a cgi web search frontend for the database created + +The following is feedback on the setup on a machine provided by the help command: + +_1 sisu --help sql + +code{ + +Postgresql + user: ralph + current db set: SiSU_sisu + port: 5432 + dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 + +sqlite + current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db + dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db + +}code + +Note on databases built + +By default, [unless otherwise specified] databases are built on a directory basis, from collections of documents within that directory. The name of the directory you choose to work from is used as the database name, i.e. if you are working in a directory called /home/ralph/ebook the database SiSU_ebook is used. [otherwise a manual mapping for the collection is necessary] + +2~ Search Form + +!_ sisu -F
+generates a sample search form, which must be copied to the web-server cgi directory + +!_ sisu -F --webserv-webrick
+generates a sample search form for use with the webrick server, which must be copied to the web-server cgi directory + +!_ sisu -Fv
+as above, and provides some information on setting up hyperestraier + +!_ sisu -W
+starts the webrick server which should be available wherever sisu is properly installed + +The generated search form must be copied manually to the webserver directory as instructed diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_intro.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_intro.ssi new file mode 100644 index 00000000..da18f3fc --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_search_intro.ssi @@ -0,0 +1,52 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Search + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual.ssm + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +1~search_intro SiSU Search - Introduction + +SiSU output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. + +Because the document structure of sites created is clearly defined, and the text object citation system is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. + +In addition to this SiSU has the ability to populate a relational sql type database with documents at an object level, with objects numbers that are shared across different output types, which make them searchable with that degree of granularity. Basically, your match criteria is met by these documents and at these locations within each document, which can be viewed within the database directly or in various output formats. + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi new file mode 100644 index 00000000..baf0c6bb --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_short_feature_summary.ssi @@ -0,0 +1,103 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Summary of Features + +@creator: :author: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: manual + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@date: :published: 2007-09-16 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? What is SiSU? + +:C~? Description + +1~sisu_feature_summary Summary of features + +_* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. + +_* markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. + +_* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, epub, xml, odf, latex, pdf, sql) + +_* for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: + +_1* html - both as a single scrollable text and a segmented document + +_1* xhtml + +_1* epub + +_1* XML - both in sax and dom style xml structures for further development as required + +_1* ODF - open document format, the iso standard for document storage + +_1* LaTeX - used to generate pdf + +_1* pdf (via LaTeX) + +_1* sql - population of an sql database, (at the same object level that is used to cite text within a document) + +Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) + +_* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this numbering system can be used to reference content. + +_* Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. + +_* long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts + +_* SQL search aside, documents are generated as required and static once generated. + +_* documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) + +_* document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs + +_* document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs + +_* generated document outputs may automatically be posted to remote sites. + +_* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. + +_* as a developers tool it is flexible and extensible + +Syntax highlighting for SiSU markup is available for a number of text editors. + +SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content + +i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... + +the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_skin.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_skin.sst new file mode 100644 index 00000000..c1035824 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_skin.sst @@ -0,0 +1,104 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Skins + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:skins;SiSU:manual:skins;electronic documents:SiSU:manual:skins;SiSU:document:skins;SiSU:document:skins + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual.ssm SiSU.ssm + +@date: + :published: 2007-09-16 + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Document Skins - configuration + +1~skins Skins + +% .SH "SKINS \- document, directory and site skins" + +Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: + +_1 ./_sisu/skin + +_1 ~/.sisu/skin + +_1 /etc/sisu/skin + +!_ Within the skin directory +are the following the default sub-directories for document skins: + +_1 ./skin/doc + +_1 ./skin/dir + +_1 ./skin/site + +A skin is placed in the appropriate directory and the file named skin_[name].rb + +The skin itself is a ruby file which modifies the default appearances set in the program. + +2~ Document Skin + +Documents take on a document skin, if the header of the document specifies a skin to be used. + +code{ + +@skin: skin_united_nations + +}code + +2~ Directory Skin + +A directory may be mapped on to a particular skin, so all documents within that directory take on a particular appearance. If a skin exists in the skin/dir with the same name as the document directory, it will automatically be used for each of the documents in that directory, (except where a document specifies the use of another skin, in the skin/doc directory). + +A personal habit is to place all skins within the doc directory, and symbolic links as needed from the site, or dir directories as required. + +2~ Site Skin + +A site skin, modifies the program default skin. + +2~ Sample Skins + +With SiSU installed sample skins may be found in: + +_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc + +(or equivalent directory) and if sisu-markup-samples is installed also under: + +_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc + +Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: + +_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sql.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sql.ssi new file mode 100644 index 00000000..c68fcbc6 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sql.ssi @@ -0,0 +1,68 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: SQL and Search + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +% used_by: sisu_manual.ssm + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Search + +:C~? Search + +1~search_sql SQL + +2~ populating SQL type databases + +SiSU feeds sisu markupd documents into sql type databases PostgreSQL~{ http://www.postgresql.org/
http://advocacy.postgresql.org/
http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/
http://en.wikipedia.org/wiki/Sqlite }~ database together with information related to document structure. + +This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: + +_1* one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); + +_1* another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and + +_1* a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). + +_1* a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. + +There is of course the possibility to add further structures. + +At this level SiSU loads a relational database with documents chunked into objects, their smallest logical structurally constituent parts, as text objects, with their object citation number and all other structural information needed to construct the document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. + +Being able to search a relational database at an object level with the SiSU citation system is an effective way of locating content generated by SiSU. As individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, complex searches can be tailored to return just the locations of the search results relevant for all available output formats, with live links to the precise locations in the database or in html/xml documents; or, the structural information provided makes it possible to search the full contents of the database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well). + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sqlite.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sqlite.sst new file mode 100644 index 00000000..c3f7e0ef --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_sqlite.sst @@ -0,0 +1,98 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Sqlite / search + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:sqlite;SiSU:manual:sqlite;electronic documents:SiSU:manual:sqlite;SiSU:document:sqlite;SiSU:document:sqlite + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual.ssm SiSU.ssm + +@date: + :published: 2007-09-16 + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -dv [filename/wildcard ]\n sisu -dv [instruction] + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +% :B~? SiSU Sqlite + +1~sqlite Sqlite + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system. + + +2~ Description + +Information related to using sqlite with sisu (and related to the sisu_sqlite dependency package, which is a dummy package to install dependencies needed for SiSU to populate an sqlite database, this being part of SiSU - man sisu). + +2~ Synopsis + +_1 sisu -d [instruction] [filename/wildcard if required] + +_1 sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required] + + +2~ Commands + +Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql may be used + +!_ -d or --sqlite +may be used interchangeably. + +3~ create and destroy database + +!_ --sqlite --createall
+initial step, creates required relations (tables, indexes) in existing (sqlite) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) + +!_ sisu -d --createdb
+creates database where no database existed before + +!_ sisu -d --create
+creates database tables where no database tables existed before + +!_ sisu -d --dropall
+destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). + +!_ sisu -d --recreate
+destroys existing database and builds a new empty database structure + +3~ import and remove documents + +!_ sisu -d --import -v [filename/wildcard]
+populates database with the contents of the file. Imports documents(s) specified to an sqlite database (at an object level). + +!_ sisu -d --update -v [filename/wildcard]
+updates file contents in database + +!_ sisu -d --remove -v [filename/wildcard]
+removes specified document from sqlite database. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_synopsis.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_synopsis.ssi new file mode 100644 index 00000000..9fac39a8 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_synopsis.ssi @@ -0,0 +1,64 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Commands + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual SiSU.ssm + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Commands + +1~ Synopsis + +SiSU - Structured information, Serialized Units - a document publishing system + +sisu [ -abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ] + +sisu [ -Ddcv ] [ instruction ] + +sisu [ -CcFLSVvW ] + +Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. + +sisu is at version 2, to use sisu version 1 + +sisu --v1 [and options/operations as above] + +for settings see sisu --help env + +sisu [ filename/ wildcard] == sisu -0 [filename/wildcard] diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst new file mode 100644 index 00000000..924abf11 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_syntax_highlighting.sst @@ -0,0 +1,169 @@ +% SiSU insert 3.0 + +@title: SiSU + :subtitle: Syntax Highlighting + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:syntax highlighting;SiSU:manual:syntax highlighting;electronic documents:SiSU:manual:syntax highlighting;SiSU:document:syntax highlighting;SiSU:document:syntax highlighting + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual.ssm SiSU.ssm + +@date: + :published: 2007-09-16 + :created: 2002-11-12 + :issued: 2002-11-12 + :available: 2002-11-12 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Syntax Highlighting + +1~ Editor Files, Syntax Highlighting + +The directory: + +_1 ./data/sisu/conf/editor-syntax-etc/ + +_1 /usr/share/sisu/conf/editor-syntax-etc + +contains rudimentary sisu syntax highlighting files for: + +_* (g)vim http://www.vim.org + +_1 package: sisu-vim + +status: largely done + +_1 there is a vim syntax highlighting and folds component + +_* gedit http://www.gnome.org/projects/gedit + +_* gobby http://gobby.0x539.de/ + +_1 file: sisu.lang + +place in: + +_1 /usr/share/gtksourceview-1.0/language-specs + +or + +_1 ~/.gnome2/gtksourceview-1.0/language-specs + +_1 status: very basic syntax highlighting + +_1 comments: this editor features display line wrap and is used by Goby! + +_* nano http://www.nano-editor.org + +_1 file: nanorc + +save as: + +_1 ~/.nanorc + +_1 status: basic syntax highlighting + +_1 comments: assumes dark background; no display line-wrap; does line breaks + +_* diakonos (an editor written in ruby) http://purepistos.net/diakonos + +file: diakonos.conf + +save as: + +_1 ~/.diakonos/diakonos.conf + +includes: + +_1 status: basic syntax highlighting + +comments: assumes dark background; no display line-wrap + +_* kate & kwrite http://kate.kde.org + +_1 file: sisu.xml + +_1 place in: + +_2 /usr/share/apps/katepart/syntax + +_1 or + +_2 ~/.kde/share/apps/katepart/syntax + +_1 [settings::configure kate::{highlighting,filetypes}] + +_1 [tools::highlighting::{markup,scripts}::SiSU] + +% kde-config --prefix +% KDEDIR/share/apps/katepart/syntax/ +% KDEHOME/share/apps/katepart/syntax +% [In the configure dialog in kate, go to the "Editor->highlighting" page and +% >select a highlight to change the mimetype/pattern associations for it.] +% /etc/mime.types +% /usr/share/mime/text + +_* nedit http://www.nedit.org + +_1 file: sisu_nedit.pats + +_1 nedit -import sisu_nedit.pats + +_1 status: a very clumsy first attempt [not really done] + +_1 comments: this editor features display line wrap + +_* emacs http://www.gnu.org/software/emacs/emacs.html + +_1 files: sisu-mode.el + +_1 to file ~/.emacs add the following 2 lines: + +_2 (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") + +_2 (require 'sisu-mode.el) + +_1 [not done / not yet included] + +_* vim & gvim http://www.vim.org + +_1 files: + +_1 package is the most comprehensive sisu syntax highlighting and editor environment provided to date (is for vim/ gvim, and is separate from the contents of this directory) + +_1 status: this includes: syntax highlighting; vim folds; some error checking + +_1 comments: this editor features display line wrap + +NOTE: + +[SiSU parses files with long lines or line breaks, but, display linewrap (without line-breaks) is a convenient editor feature to have for sisu markup] + +% aeditor (an editor written in ruby) + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_webrick.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_webrick.sst new file mode 100644 index 00000000..282513d7 --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_webrick.sst @@ -0,0 +1,93 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: sisu_webrick + +@creator: :author: Amissah, Ralph + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:webrick;SiSU:manual:webrick;electronic documents:SiSU:manual:webrick;SiSU:document:webrick;SiSU:document:webrick + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +% used_by: sisu_manual.ssm SiSU.ssm + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2007-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W + +@links: + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? SiSU Webrick + +1~webrick sisu_webrick + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system + +2~ Synopsis + +sisu_webrick [port] + +or + +sisu -W [port] + +2~ Description + +sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby's Webrick web-server and points it to the directories to which SiSU output is written, providing a list of these directories (assuming SiSU is in use and they exist). + +The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system). + +2~ Summary of man page + +sisu_webrick, may be started on it's own with the command: sisu_webrick [port] or using the sisu command with the -W flag: sisu -W [port] + +where no port is given and settings are unchanged the default port is 8081 + +2~ Document processing command flags + +sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 + +2~ Further information + +For more information on SiSU see: http://www.jus.uio.no/sisu + +or man sisu + +2~ Author + +Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com + +2~ SEE ALSO + +_1 sisu(1) + +_1 sisu_vim(7) + +_1 sisu(8) + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi new file mode 100644 index 00000000..42e3b93c --- /dev/null +++ b/data/doc/sisu/v3/markup-samples/sisu_manual/en/sisu_work_needed_and_wishlist.ssi @@ -0,0 +1,78 @@ +% SiSU 3.0 + +@title: SiSU + :subtitle: Work Needed and Wishlist + +@creator: :author: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date: + :created: 2002-08-28 + :issued: 2002-08-28 + :available: 2002-08-28 + :published: 2007-09-16 + :modified: 2011-02-07 + +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + +@links: + { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ + { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ + { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + +:A~? @title @creator + +:B~? Work Needed and Wishlist + +1~sisu_work_needed Work Needed + +SiSU is fairly mature and for most purposes the syntax and what it is supposed to do is clear. For the most part additions and changes are minor and backward compatible, (in particular there may be things of interest that to be able to achieve will require additions to the syntax). + +_* Amongst the most requested features is a way to represent and extract bibliographies from scholarly and other writings. This involves an extension of sisu markup syntax and a new module to extract the bibliography. + +_* Integration of postgresql tsearch2 / gin indexing, (which currently needs to be done manually, and) which has been waiting for the integration of tsearch2 / gin into Postgresql main, which is supposed to occur in Postgresql 8.3 + +_* Internationalisation always. SiSU is utf-8 and for those parts that are utf-8 friendly will work out of the box - html and postgresql for example work out of the box (and for example comfortably represent Chinese text), LaTeX and odf do not work out of the box, they need additional work for extended language sets. + +_* Refinements and improvements to output representations, some are fairly mature, others (such as manpages and info files (and even ODF) remain young. + +_* Simple extension to contain, link and share included audio and multi-media files, (including sisupod.zip) + +1~sisu_wishlist Wishlist + +SiSU provides a lot of "plumbing" and is readily usable as a tool by those comfortable with marking up documents with an editor. The syntax is fairly easy to learn, especially the subset required to start using SiSU effectively. + +SiSU might also be of interest to developers interested in: + +_* experimenting with the search implications offered + +_* producing additional output formats + +_* producing conversion tools + +_* producing input interfaces, (experimenting with additional interfaces for producing sisu source documents) + +Several tools that are of interest would come under the heading interface and conversion. Amongst others, the following are of interest: + +_* Converters from various document formats, such as Open Document Text (ODF), MS Word(TM) and Word Perfect(TM), even html. The problem here is one of the most important things for SiSU is to be able to recognise the structure of a document, and many documents prepared in other formats have not been prepared strictly with a view to representing structure, but appearance - so heading levels may be "painted" to look right rather than have the correct structural representation. Even if conversion is not perfect this may serve as a first step in assisting in conversion of documents to SiSU for those with legacy document sets that they would like to have in sisu format. (once in SiSU it is easier to get out in various other formats as this is what sisu does, within the constraints of the information that sisu uses to generate output) + +_* The possibility to save directly from from various word processors, and possibly templates within them to assist in making sure the document structure is "understood" by SiSU. + +_* Web interface/front-end, a form like front end for the writing or submission of sisu documents to a server which uses SiSU to generate output. Headers could be made available as separate small entry forms with help provided to explain where they might be used. Apart from the most important headers such as title, author, date and possibly subject the remainder of the header forms could be placed after the form for substantive content. This would offer a more Web 2.0 like approach to the use of SiSU and the possibility of using it for collaborative editing of content (possibly for documents that are to be finalised/published as the citation system is most suited to published works). [Collaborative editing is currently possible through use of a collaborative editor such as Gobby which makes use of the Obby protocol]. + diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu.ssm deleted file mode 100644 index c162db3f..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu.ssm +++ /dev/null @@ -1,103 +0,0 @@ -% SiSU master 2.0 - -@title: SiSU - :subtitle: Manual - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual - -@date: - :published: 2008-05-22 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2010-07-07 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdFehIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu --v2 [operations] . sisu --v1 [operations] - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~ @title @creator - -:B~ What is SiSU? - -% << sisu_synopsis.ssi - -<< sisu_introduction.sst - -% :B~? SiSU Commands - -<< sisu_commands.sst - -<< sisu_help.sst - -% :B~? SiSU Markup - -<< sisu_markup.sst - -<< sisu_filetypes.sst - -% :B~? SiSU Configuration and Skins - -<< sisu_config.ssi - -<< sisu_skin.sst - -<< sisu_css.ssi - -<< sisu_content_directories.ssi - -<< sisu_homepages.ssi - -% :B~? SiSU Output and Markup Examples - -<< sisu_examples.ssi - -<< sisu_search_intro.ssi - -<< sisu_sql.ssi - -<< sisu_postgresql.sst - -<< sisu_sqlite.sst - -<< sisu_search_cgi.ssi - -<< sisu_hyperestraier.ssi - -<< sisu_webrick.sst - -<< sisu_remote.sst - -<< sisu_quickstart.sst - -<< sisu_syntax_highlighting.sst - -<< sisu_how.ssi - -<< sisu_short_feature_summary.ssi - -<< sisu_help_sources.sst diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_commands.sst deleted file mode 100644 index d32c9dad..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_commands.sst +++ /dev/null @@ -1,365 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Commands - -@creator: - :author: Amissah, Ralph - -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual SiSU.ssm - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2010-09-17 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Commands - -1~commands Commands Summary - -2~ Description - -SiSU SiSU is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, xhtml, XML, epub, odt (odf text), LaTeX, pdf, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: http://www.jus.uio.no/sisu - -% 2~ Summary of man page - -% This man page covers a number of subjects in brief, including: document processing command flags; document markup (basic markup and headers); configuration files; directory structure; skins; document naming; interactive help and other information. - -2~ Document Processing Command Flags - -!_ -a [filename/wildcard]
-produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) - -!_ -b [filename/wildcard]
-see --xhtml - -!_ --color-toggle [filename/wildcard]
-screen toggle ansi screen colour on or off depending on default set (unless -c flag is used: if sisurc colour default is set to 'true', output to screen will be with colour, if sisurc colour default is set to 'false' or is undefined screen output will be without colour). Alias -c - -!_ --concordance [filename/wildcard]
-produces concordance (wordmap) a rudimentary index of all the words in a document. (Concordance files are not generated for documents of over 260,000 words unless this limit is increased in the file sisurc.yml). Alias -w - -!_ -C [--init-site]
-configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). -C --init-site configure/initialise site more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. - -!_ -CC
-configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). The equivalent of: -C --init-site configure/initialise site, more extensive than -C on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if -CC is used. - -!_ -c [filename/wildcard]
-see --color-toggle - -!_ --dal [filename/wildcard/url]
-assumed for most other flags, creates new intermediate files for processing (document abstraction) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see -n. Alias -m - -!_ --delete [filename/wildcard]
-see --zap - -!_ -D [instruction] [filename]
-see --pg - -!_ -d [--db-[database type (sqlite|pg)]] --[instruction] [filename]
-see --sqlite - -!_ --epub [filename/wildcard]
-produces an epub document, [sisu version 2 only] (filename.epub). Alias -e - -!_ -e [filename/wildcard]
-see --epub - -!_ -F [--webserv=webrick]
-see --sample-search-form - -!_ --git [filename/wildcard]
-produces or updates markup source file structure in a git repo (experimental and subject to change). Alias -g - -!_ -g [filename/wildcard]
-see --git - -!_ --harvest *.ss[tm]
-makes two lists of sisu output based on the sisu markup documents in a directory: list of author and authors works (year and titles), and; list by topic with titles and author. Makes use of header metadata fields (author, title, date, topic_register). Can be used with maintenance (-M) and remote placement (-R) flags. - -!_ --help [topic]
-provides help on the selected topic, where topics (keywords) include: list, (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers, headings, endnotes, tables, example, customise, skin, (dir)ectories, path, (lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql, features, license - -!_ --html [filename/wildcard]
-produces html output, segmented text with table of contents (toc.html and index.html) and the document in a single file (scroll.html). Alias -h - -!_ -h [filename/wildcard]
-see --html - -!_ -I [filename/wildcard]
-see --texinfo - -!_ -i [filename/wildcard]
-see --manpage - -!_ -L
-prints license information. - -!_ --machine [filename/wildcard/url]
-see --dal (document abstraction level/layer) - -!_ --maintenance [filename/wildcard/url]
-maintenance mode files created for processing preserved and their locations indicated. (also see -V). Alias -M - -!_ --manpage [filename/wildcard]
-produces man page of file, not suitable for all outputs. Alias -i - -!_ -M [filename/wildcard/url]
-see --maintenance - -!_ -m [filename/wildcard/url]
-see --dal (document abstraction level/layer) - -!_ --no-ocn
-[with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. - -!_ -N [filename/wildcard/url]
-document digest or document content certificate ( DCC ) as md5 digest tree of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). -NV for verbose digest output to screen. - -!_ -n [filename/wildcard/url]
-skip the creation of intermediate processing files (document abstraction) if they already exist, this skips the equivalent of -m which is otherwise assumed by most processing flags. - -!_ --odf [filename/wildcard/url]
-see --odt - -!_ --odt [filename/wildcard/url]
-output basic document in opendocument file format (opendocument.odt). Alias -o - -!_ -o [filename/wildcard/url]
-see --odt - -!_ --pdf [filename/wildcard]
-produces LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Alias -p - -!_ --pg [instruction] [filename]
-database postgresql ( --pgsql may be used instead) possible instructions, include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -D - -!_ -p [filename/wildcard]
-see --pdf - -!_ --quiet [filename/wildcard]
-quiet less output to screen. - -!_ -q [filename/wildcard]
-see --quiet - -!_ --rsync [filename/wildcard]
-copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see --scp. Alias -R - -!_ -R [filename/wildcard]
-see --rsync - -!_ -r [filename/wildcard]
-see --scp - -!_ --sample-search-form [--webserv=webrick]
-generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). -Fv (in addition to the above) provides some information on setting up hyperestraier for sisu. Alias -F - -!_ --scp [filename/wildcard]
-copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r - -!_ --sqlite --[instruction] [filename]
-database type default set to sqlite, (for which --sqlite may be used instead) or to specify another database --db-[pgsql, sqlite] (however see -D) possible instructions include: --createdb; --create; --dropall; --import [filename]; --update [filename]; --remove [filename]; see database section below. Alias -d - -!_ --sisupod
-produces a sisupod a zipped sisu directory of markup files including sisu markup source files and the directories local configuration file, images and skins. Note: this only includes the configuration files or skins contained in ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option is tested only with zsh). Alias -S - -!_ --sisupod [filename/wildcard]
-produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named with the filename extension .ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related images and skin. SiSU commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag --trust or --trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. Note: if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the -S option without [filename/wildcard]. Alias -S - -!_ --source [filename/wildcard]
-copies sisu markup file to output directory. Alias -s - -!_ -S
-see --sisupod - -!_ -S [filename/wildcard]
-see --sisupod - -!_ -s [filename/wildcard]
-see --source - -!_ --texinfo [filename/wildcard]
-produces texinfo and info file, (view with pinfo). Alias -I - -!_ --txt [filename/wildcard]
-produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias -t - -!_ -T [filename/wildcard (*.termsheet.rb)]
-standard form document builder, preprocessing feature - -!_ -t [filename/wildcard]
-see --txt - -!_ --urls [filename/wildcard]
-prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml. Alias -U - -!_ -U [filename/wildcard]
-see --urls - -!_ -u [filename/wildcard]
-provides url mapping of output files for the flags requested for processing, also see -U - -!_ --v1 [filename/wildcard]
-invokes the sisu v1 document parser/generator. For use with sisu v1 markup documents. (Markup conversion to v2 involves the modification of document headers) - -!_ --v2 [filename/wildcard]
-invokes the sisu v2 document parser/generator. This is the default and is normally omitted. - -!_ --verbose [filename/wildcard]
-provides verbose output of what is being generated, where output is placed (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests. Alias -v - -!_ -V
-on its own, provides SiSU version and environment information (sisu --help env) - -!_ -V [filename/wildcard]
-even more verbose than the -v flag. - -!_ -v
-on its own, provides SiSU version information - -!_ -v [filename/wildcard]
-see --verbose - -!_ --webrick
-starts ruby's webrick webserver points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the -h option rather than -H ; also, note -F webrick ]. Alias -W - -!_ -W
-see --webrick - -!_ --wordmap [filename/wildcard]
-see --concordance - -!_ -w [filename/wildcard]
-see --concordance - -!_ --xhtml [filename/wildcard]
-produces xhtml/XML output for browser viewing (sax parsing). Alias -b - -!_ --xml-dom [filename/wildcard]
-produces XML output with deep document structure, in the nature of dom. Alias -X - -!_ --xml-sax [filename/wildcard]
-produces XML output shallow structure (sax parsing). Alias -x - -!_ -X [filename/wildcard]
-see --xml-dom - -!_ -x [filename/wildcard]
-see --xml-sax - -!_ -Y [filename/wildcard]
-produces a short sitemap entry for the document, based on html output and the sisu_manifest. --sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week]) - -!_ -y [filename/wildcard]
-produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. - -!_ --zap [filename/wildcard]
-Zap, if used with other processing flags deletes output files of the type about to be processed, prior to processing. If -Z is used as the lone processing related flag (or in conjunction with a combination of -[mMvVq]), will remove the related document output directory. Alias -Z - -!_ -Z [filename/wildcard]
-see --zap - -1~command_modifiers command line modifiers - -!_ --no-ocn
-[with --html --pdf or --epub] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. - -!_ --no-annotate
-strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign - -!_ --no-asterisk
-strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign - -!_ --no-dagger
-strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign - -1~commands_database database commands - -dbi - database interface - --D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable with --db=[database type (pgsql or sqlite)] - -!_ --pg -v --createall
-initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) [ -dv --createall sqlite equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at the present time for postgresql it may be necessary to manually create the database. The command would be 'createdb [database name]' where database name would be SiSU_[present working directory name (without path)]. Please use only alphanumerics and underscores. - -!_ --pg -v --import
-[filename/wildcard] imports data specified to postgresql db (rb.dbi) [ -dv --import sqlite equivalent] - -!_ --pg -v --update
-[filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ -dv --update sqlite equivalent] - -!_ --pg --remove
-[filename/wildcard] removes specified data to postgresql db (rb.dbi) [ -d --remove sqlite equivalent] - -!_ --pg --dropall
-kills data" and drops (postgresql or sqlite) db, tables & indexes [ -d --dropall sqlite equivalent] - -The -v is for verbose output. - -1~command_shorcuts Shortcuts, Shorthand for multiple flags - -!_ --update [filename/wildcard]
-Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous runs, only the -hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. - -!_ -0 to -5 [filename or wildcard]
-Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): - -!_ -0
--mNhwpAobxXyYv [this is the default action run when no options are give, i.e. on 'sisu [filename]'] - -!_ -1
--mhewpy - -!_ -2
--mhewpaoy - -!_ -3
--mhewpAobxXyY - -!_ -4
--mhewpAobxXDyY --import - -!_ -5
--mhewpAobxXDyY --update - -add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] - -consider -u for appended url info or -v for verbose output - -2~ Command Line with Flags - Batch Processing - -In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. - -Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_config.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_config.ssi deleted file mode 100644 index b7370b4c..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_config.ssi +++ /dev/null @@ -1,80 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Configuration - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? Configuration - -:B~? Configure Environment - -1~config Configuration - -2~ Determining the Current Configuration - -Information on the current configuration of SiSU should be available with the help command: - -_1 sisu -v - -which is an alias for: - -_1 sisu --help env - -Either of these should be executed from within a directory that contains sisu markup source documents. - -2~ Configuration files (config.yml) - -SiSU configration parameters are adjusted in the configuration file, which can be used to override the defaults set. This includes such things as which directory interim processing should be done in and where the generated output should be placed. - -The SiSU configuration file is a yaml file, which means indentation is significant. - -SiSU resource configuration is determined by looking at the following files if they exist: - -_1 ./_sisu/sisurc.yml - -_1 ~/.sisu/sisurc.yml - -_1 /etc/sisu/sisurc.yml - -The search is in the order listed, and the first one found is used. - -In the absence of instructions in any of these it falls back to the internal program defaults. - -Configuration determines the output and processing directories and the database access details. - -If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_content_directories.ssi deleted file mode 100644 index 11590de2..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_content_directories.ssi +++ /dev/null @@ -1,141 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Content Directories, Organising Content - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2007-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? Organisation of Content - -:B~? Content Directories - -1~organising_content Organising Content - -2~ Directory Structure and Mapping - -The output directory root can be set in the sisurc.yml file. Under the root, subdirectories are made for each directory in which a document set resides. If you have a directory named poems or conventions, that directory will be created under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier stripped (.sst .ssm) - -The last part of a directory path, representing the sub-directory in which a document set resides, is the directory name that will be used for the output directory. This has implications for the organisation of document collections as it could make sense to place documents of a particular subject, or type within a directory identifying them. This grouping as suggested could be by subject (sales_law, english_literature); or just as conveniently by some other classification (X University). The mapping means it is also possible to place in the same output directory documents that are for organisational purposes kept separately, for example documents on a given subject of two different institutions may be kept in two different directories of the same name, under a directory named after each institution, and these would be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance. - -3~ General Directories - -code{ - -./subject_name/ - -% files stored at this level e.g. sisu_manual.sst - -./subject_name/_sisu - -% configuration file e.g. sisurc.yml - -./subject_name/_sisu/skin - -% skins in various skin directories doc, dir, site, yml - -./subject_name/_sisu/css - -./subject_name/_sisu/image - -% images for documents contained in this directory - -./subject_name/_sisu/mm - -}code - -3~ Remote Directories - -code{ - -./subject_name/ - -% containing sub_directories named after the generated files from which they are made - -./subject_name/src - -% contains shared source files text and binary e.g. sisu_manual.sst and sisu_manual.sst.zip - -./subject_name/_sisu - -% configuration file e.g. sisurc.yml - -./subject_name/_sisu/skin - -% skins in various skin directories doc, dir, site, yml - -./subject_name/_sisu/css - -./subject_name/_sisu/image - -% images for documents contained in this directory - -./subject_name/_sisu/mm - -}code - -3~ Sisupod - -code{ - -./sisupod/ - -% files stored at this level e.g. sisu_manual.sst - -./sisupod/_sisu - -% configuration file e.g. sisurc.yml - -./sisupod/_sisu/skin - -% skins in various skin directories doc, dir, site, yml - -./sisupod/_sisu/css - -./sisupod/_sisu/image - -% images for documents contained in this directory - -./sisupod/_sisu/mm - -}code - -2~ Organising Content - - - -% .SH "SKINS \- document, directory and site skins" - - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_css.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_css.ssi deleted file mode 100644 index 5ef419f1..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_css.ssi +++ /dev/null @@ -1,63 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: CSS - Cascading Style Sheets - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2007-08-28 - :issued: 2007-08-28 - :available: 2007-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? CSS - -1~css CSS - Cascading Style Sheets (for html, XHTML and XML) - -CSS files to modify the appearance of SiSU html, XHTML or XML may be placed in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css and these will be copied to the output directories with the command sisu -CC. - -The basic CSS file for html output is html.css, placing a file of that name in directory _sisu/css or equivalent will result in the default file of that name being overwritten. - -HTML: -html.css - -XML DOM: -dom.css - -XML SAX: -sax.css - -XHTML: -xhtml.css - -The default homepage may use homepage.css or html.css - -Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS file that is looked for in a skin.~{ SiSU has worked this way in the past, though this was dropped as it was thought the complexity outweighed the flexibility, however, the balance was rather fine and this behaviour could be reinstated. }~ diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_description.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_description.sst deleted file mode 100644 index fe3b5c46..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_description.sst +++ /dev/null @@ -1,564 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - :subtitle: Description - -@creator: :author: Amissah, Ralph - -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:description;sisu:document:description - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% SiSU.ssm - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@date: - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :published: 2007-08-30 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu - :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|rant|utf-?8|WARNING/ - :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i - -@links: - {What does SiSU do? Summary}../SiSU/1.html#summary - {Book Samples and Markup Examples}../SiSU/examples.html - {SiSU Markup Syntax}../sample - {*Citation System* Object Citation Numbering}../SiSU/1.html#citation - {*Granular Search*}../SiSU/1.html#search - {The Chart (pdf)}../diagram/sisu.chart.pdf - {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf - {Standard}../SiSU/standard.html - {License}../SiSU/license.html - {man pages}../SiSU/3.html#man - {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ - {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html - {Download}../SiSU/download.html - {Changelog}../SiSU/changelog.html - -:A~? @title @creator - -:B~? SiSU an attempt to describe - -1~ Description - -2~ Outline - -SiSU is a flexible document preparation, generation publishing and search system.~{ This information was first placed on the web 12 November 2002; with predating material taken from http://www.jus.uio.no/lm/lm.information/toc.html part of a site started and developed since 1993. See document metadata section http://www.jus.uio.no/sisu/SiSU/metadata.html for information on this version. Dates related to the development of SiSU are mostly contained within the Chronology section of this document, e.g. http://www.jus.uio.no/sisu/sisu_chronology }~ - -SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),~{ also chosen for the meaning of the Finnish term "sisu". }~ is a Unix command line oriented framework for document structuring, publishing and search. Featuring minimalistic markup, multiple standard outputs, a common citation system, and granular search. - -Using markup applied to a document, SiSU can produce plain text, HTML, XHTML, XML, OpenDocument, EPUB, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity (e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. - -SiSU is the data/information structuring and transforming tool, that has resulted from work on one of the oldest law web projects. It makes possible the one time, simple human readable markup of documents, that SiSU can then publish in various forms, suitable for paper~{ pdf via LaTeX }~, web~{ currently html (two forms of html presentation one based on css the other on tables), and /PHP/; potentially structured XML }~ and relational database~{ any SQL - currently PostgreSQL and /sqlite/ (for portability, testing and development) }~ presentations, retaining common data-structure and meta-information across the output/presentation formats. Several requirements of legal and scholarly publication on the web have been addressed, including the age old need to be able to reliably cite/pinpoint text within a document, to easily make footnotes/endnotes, to allow for semantic document meta-tagging, and to keep required markup to a minimum. These and other features of interest are listed and described below. A few points are worth making early (and will be repeated a number of times): - -_1 (i) The SiSU document generator was the first to place material on the web with a system that makes possible citation across different document types, with paragraph, or rather object citation numbering~{ previously called "text object numbering" }~ a text positioning system, available for the pinpointing of text, 1997, a simple idea from which much benefit, and SiSU remains today, to the best of my knowledge, the only multiple format e-book/ electronic-document system on the web that gives you this possibility (including for relational databases). - -_1 (ii) Markup is done once for the multiple formats produced. - -_1 (iii) Markup is simple, and human readable (with a little practice), in almost all cases there is less and simpler markup required than basic html. In any event the markup required is very much simpler than the html, EPUB, LaTeX, [lout], structured XML, ODF (OpenDocument), PostgreSQL or SQLite feed etc. that you can have SiSU generate for you. - -_1 (iv) SiSU is a batch processor, dealing with as many files as you need to generate at a time. - -_1 (v) Scalability is dependent on your file system (in my case Reiserfs), the database (currently Postgresql and/or SQLite) and your hardware. - -SiSU Sabaki~{ SiSU Sabaki, release version. Pre-release version SiSU Scribe, and version prior to that SiSU nicknamed Scribbler. Pre-release versions go back several years. Both Scribbler and Scribe (still maintained) made system calls to SiSU's various parts, instead of using libraries. }~ (or just SiSU) is the provisional name given to the software described here that helps structure documents for web and other publication. The name SiSU is a loose anagram for something along the lines of *{/{"SiSU is structuring unit"}/}*, or /{"SiSU, information structuring unit"}/ or the more descriptive /{"Structured information, Serialized Units"}/ or *{/{"simple - information structuring unit"}/}* or the more descriptive /{"Structured information, Serialized Units"}/ or what it may be directed towards /{"*semantic* and *{information structuring universe}*"}/,~{ A little universe it may be, but semantic you may have a hard time getting away with, given the meaning the word has taken on with markup. On a document wide basis semantic information may be provided, which can be really useful, (and meaningful, especially) if you have a large document set, and use this with rss feeds or in an sql database etc. On a markup level, I have little inclination to add semantic markup formally beyond references, title, author [Dublin Core entities? addresses?] etc. Actually this deserves a bit of thought possibly use letter tags (including letter alias/synonyms for font faces) to create a small set of default semantic tags, with the possibility for per document adjustments. Will seek to permit XML entity tagging, within SiSU markup and have that ignored/removed by the parts of the program that have no use for it. }~ tongue in cheek, only just. Guess I'll get away with *{/{"Simple - information Structuring Universe"}/}*. SiSU is also a Finnish word roughly meaning guts, inner strength and perseverance.~{ "Sisu refers not to the courage of optimism, but to a concept of life that says, 'I may not win, but I will gladly give my life for what I believe.'" Aini Rajanen, Of Finnish Ways, 1981, p. 10.
http://www.humanlanguages.com/finnishenglish/rlfs.htm
"Every Finn has his own pet definition. To me, sisu means patience without passion. But there are many varieties of sisu. Sisu can be a sudden outburst or it can be the kind that lasts. A man can have both kinds. It is outside reason. It is something in the soul. It comes from oneself. For instance, it makes a soldier do things because he himself must, not because he has been told." Paavo Nurmi
http://personalweb.smcvt.edu/tmatikainen/finnishtraditions.htm }~ - -SiSU was born of the need to find a way, with minimal effort, and for as wide a range of document types as possible, to produce high quality publishing output in a variety of document formats. As such it was necessary to find a simple document representation that would work across a large number of document types, and the most convenient way(s) to produce acceptable output formats. The project leading to this program was started in 1993 (together with the trade law project now known as Lex Mercatoria) as an investigation of how to effectively/efficiently place documents on the web. The unified document handling, together with features such as paragraph numbering, endnote handling and tables... appeared in 1996/97. SiSU was originally written in Perl,~{ http://www.perl.org/ }~ and converted to Ruby,~{ http://www.ruby-lang.org/en/ }~ in 2000, one of the most impressive programming languages in existence! In its current form it has been written to run on the Gnu/Linux platform, and in particular on Debian,~{ http://www.debian.org/ }~ taking advantage of many of the wonderful projects that are available there. - -SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), EPUB, XML (in this case, structural representation), ODF (OpenDocument [experimental]), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ - -From markup that is simpler and more sparse than html you get: - -_* far greater output possibilities, including html, EPUB, XML, ODF (OpenDocument), LaTeX (pdf), and SQL; - -_* the advantages implicit in the very different output possibilities; - -_* a common citation system (for all outputs - including the relational database, search results are relevant for all outputs); - -For more see the short summary of features provided below. - -SiSU processes files with minimal tagging to produce various document outputs including html, EPUB, ODF, LaTeX (which is converted to pdf) and if required loads the structured information into an SQL database (PostgreSQL and SQLite have been used for this). SiSU produces an intermediate processing format.~{ This proved to be the easiest way to develop syntax, changes could be made, or alternatives provided for the markup syntax whilst the intermediate markup syntax was largely held constant. There is actually an optional second intermediate markup format in YAML http://www.yaml.org/ }~ - -SiSU is used in constructing Lex Mercatoria http://lexmercatoria.org/ or http://www.jus.uio.no/lm/ (one of the oldest law web sites), and considerable thought went into producing output that would be suitable for legal and academic writings (that do not have formulae) given the limitations of html, and publication in a wide variety of "formats", in particular in relation to the convenient and accurate citation of text. However, the construction of Lex Mercatoria uses only a fraction of the features available from SiSU today, /vis/ generation of flat file structures, rather than in addition the building of ("granular") SQL database content, (at an object level with relevant relational tables, and other outputs also available). - -2~ Short summary of features *~summary - -!_ (i) -markup syntax: (a) simpler than html, (b) mnemonic, influenced by mail/messaging/wiki markup practices, (c) human readable, and easily writable, - -!_ (ii) -(a) minimal markup requirement, (b) single file marked up for multiple outputs, - -notes: - -* documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. - -* markup is easily readable/parsed by the human eye, (basic markup is simpler and more sparse than the most basic html), [this may also be converted to XML representations of the same input/source document]. - -* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. - -!_ (iii) -(a) multiple outputs primarily industry established and institutionally accepted open standard formats, include amongst others: plaintext (UTF-8); html; EPUB; (structured) XML; ODF (Open Document text)l; LaTeX; PDF (via LaTeX); SQL type databases (currently PostgreSQL and SQLite). Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) - -!_ (iv) -outputs share a common numbering system (dubbed "object citation numbering" (ocn)) that is meaningful (to man and machine) across various digital outputs whether paper, screen, or database oriented, (PDF, html, EPUB, XML, Opendocument, sqlite, postgresql), this numbering system can be used to reference content. - -!_ (v) -SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperesteier]. - -!_ (vi) -use of semantic meta-tags in headers permit the addition of semantic information on documents, (the available fields are easily extended) - -!_ (vii) -creates organised directory/file structure for (file-system) output, easily mapped with its clearly defined structure, with all text objects numbered, you know in advance where in each document output type, a bit of text will be found (e.g. from an SQL search, you know where to go to find the prepared html output or PDF etc.)... there is more; easy directory management and document associations, the document preparation (sub-)directory may be used to determine output (sub-)directory, the skin used, and the SQL database used, - -!_ (viii) -"Concordance file" wordmap, consisting of all the words in a document and their (text/ object) locations within the text, (and the possibility of adding vocabularies), - -!_ (ix) -document content certification and comparison considerations: the document and each object within it stamped with an md5 hash making it possible to easily check or guarantee that the substantive content of a document is unchanged. - -!_ (x) -SiSU's minimalist markup makes for meaningful "diffing" of the substantive content of markup-files, - -!_ (xi) -easily skinnable, document appearance on a project/site wide, directory wide, or document instance level easily controlled/changed, - -!_ (xii) -in many cases a regular expression may be used (once in the document header) to define all or part of a documents structure obviating or reducing the need to provide structural markup within the document, - -!_ (xiii) -prepared files may be batch process, documents produced are static files so this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) - -!_ (xiv) -possible to pre-process, which permits: the easy creation of standard form documents, and templates/term-sheets, or; building of composite documents (master documents) from other sisu marked up documents, or marked up parts, i.e. import documents or parts of text into a main document should this be desired - -there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. - -!_ (xv) -there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added: (a) modular, (thanks in no small part to Ruby) another output format required, write another module.... (b) easy to update output formats (eg html, XHTML, EPUB, LaTeX/PDF produced can be updated in program and run against whole document set), (c) easy to add, modify, or have alternative syntax rules for input, should you need to, - -!_ (xvi) -scalability, dependent on your file-system (ext3, Reiserfs, XFS, whatever) and on the relational database used (currently Postgresql and SQLite), and your hardware, - -!_ (xvii) -only marked up files need be backed up, to secure the larger document set produced, - -!_ (xviii) -document management, - -!_ (xix) -Syntax highlighting for SiSU markup is available for a number of text editors. - -!_ (xx) -remote operations: (a) run SiSU on a remote server, (having prepared sisu markup documents locally or on that server, i.e. this solution where sisu is installed on the remote server, would work whatever type of machine you chose to prepare your markup documents on), (b) generated document outputs may be posted by sisu to remote sites (using rsync/scp) (c)document source (plaintext utf-8) if shared on the net may be identified by its url and processed locally to produce the different document outputs. - -!_ (xxi) -document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs, these may be downloaded, shared as email attachments, or processed by running sisu against them, either using a url or the filename. - -!_ (xxii) -for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, html, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to PDF, a LaTeX processor like tetex or texlive. - -as a developers tool it is flexible and extensible - -SiSU was developed in relation to legal documents, and is strong across a wide variety of texts (law, literature...). SiSU handles images but is not suitable for formulae/ statistics, or for technical writing at this time. - -SiSU has been developed and has been in use for several years. Requirements to cover a wide range of documents within its use domain have been explored. - -Some modules are more mature than others, the most mature being html and LaTeX / pdf. PostgreSQL and search functions are useable and together with /ocn/ unique (to the best of my knowledge). The XML output document set is "well formed" but largely proof of concept. - -2~ How it works - -SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within text which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the instruction header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). - -2~ Simple markup - -SiSU markup is based on requiring the minimum markup needed to determine the structure of a document. (This can be as little as saying in a header to look for the word Book at a specified level and the word Chapter at another level). SiSU then breaks a document into its smallest parts (at a heading, and paragraph level) while retaining all structural information. This break up of the document and information on its structure is taken advantage of in the transformations made in generating the very different output types that can be created, and in providing as much as can be for what each output type is best at doing, e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), EPUB, XML (in this case, structural representation), ODF (OpenDocument), SQL (e.g. document search; representing constituent parts of documents based on their structure, headings, chapters, paragraphs as required; user control).~{ where explicit structure is provided through the use of tagging headings, it could be reduced (still) further, for example by reducing the number of characters used to identify heading levels; but in many cases even that information is not required as regular expressions can be used to extract the implicit structure. }~ - -3~ Sparse markup requirement, try to get the most out of markup - -One of its strengths is that very small amounts of initial tagging is required for the program to generate its output. - -This is a basic markup example: - -_* { basic markup example, text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst output provided as example in the next section }~ - -_* { view basic markup, as it would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html ~{ http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html as it would appear with syntax highlighting (by vim) }~ - -Emphasis has been on simplicity and minimalism in markup requirements. Design philosophy is to try keep the amount of markup required low, for whatever has been determined to be acceptable output.~{ seems there are several "smart ASCIIs" available, primarily for ascii to html conversion, that make this, and reasonable looking ascii their goal
http://webseitz.fluxent.com/wiki/SmartAscii
http://daringfireball.net/projects/markdown/
http://www.textism.com/tools/textile/ }~ - -SiSU's markup is more minimalistic and simpler than (the equivalent) html and for it, you get considerably more than just html, as this preparation gives you all available output formats, upon request. - -3~ Single markup file provides multiple output formats - -For each document, there is only one (input, minimalistically marked up) file from which all the available output types are generated.~{ These include richly laid out and linked html (table or css variants), /PHP/, LaTeX (from which pdf portrait and landscape documents are produced), texinfo (for info files etc.), and PostgreSQL and/or SQLite. And the opportunity to fairly easily build additional modules, such as XML. See the examples provided in this document. }~ - -Eg. the markup example: - -_* {~^ original text file - an international convention }http://www.jus.uio.no/sisu/sample/markup/un_contracts_international_sale_of_goods_convention_1980.sst - -_* {~^ view as syntax would be highlighted by vim editor }http://www.jus.uio.no/sisu/sample/syntax/un_contracts_international_sale_of_goods_convention_1980.sst.html - -Produces the following output: - -_* {~^ Segmented html version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html - -_* {~^ Full length html document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/doc.html - -_* {~^ pdf landscape version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/landscape.pdf - -_* {~^ pdf portrait version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/portrait.pdf - -_* {~^ clean tex ascii version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/plain.txt - -_* {~^ /xml/ sax version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/sax.xml - -_* {~^ /xml/ dom version of document }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/dom.xml - -_* {~^ Concordance }http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/concordance.html - -(and in addition to these: PostgreSQL, SQLite, texinfo and -{YAML}- ~{ discontinued for the time being }~ versions if desired) - -3~ Syntax relatively easy to read and remember - -Syntax is kept simple and mnemonic.~{ SiSU markup syntax, an incomplete summary: http://www.jus.uio.no/sisu/sisu_markup_table/doc.html#h200306
Visual check of elementary font face modifiers: *bold* *{bold}* !{emphasis}! /{italics}/ _{underscore}_ -{strikethrough}- ^{superscript}^ ,{subscript}, }~ - -3~ Kept simple by having a limited publishing feature set, and features identified as most important, are available across several document types - -To keep SiSU markup sparse and simple SiSU deliberately provides a limited publishing feature set, including: indent levels; bold; italics; superscript; subscript; simple tables; images; tables of contents and; endnotes. Which in most cases are available across the different output formats. - -The publishing feature set may be expanded as required. - -2~ Designed with usability in mind - -Output is designed to be uniform, easy to read, navigate and cite. - -2~ Code separate from content - -Code~{ the program that generates the documents }~ is separated from content. This means that when changes are desired in the output presentation, the code that produces them, and not the marked up text data set (which could be thousands of documents) is modified. Separating code from content makes large scale changes to output appearance trivial, and permits the easy addition of new output modules. - -2~ Object citation numbering, a text or object positioning / citation system - "paragraph" (or text object) numbering, that remains same and usable across all output formats by people and machine *~citation *~ocn - -Object citation numbering is a simple object (text) positioning and cition system that is human relevant and machine useable, used by SiSU for all manner of presentations, and that is available for use in all text mappings. It is based on the automated sequential numbering of objects (roughly paragraphs, (headings, tables, verse) or other blocks of text or images etc.). The text positioning system (in which I claim copyright) is invaluable for publishing requiring the citing text across multiple output formats, and for the general mapping of text within a document: - -_* in html, html not being easily citeable (change font size, or use a different browser and the page on which specific text appears has changed), and - -_* across multiple formats being common to all output formats html/xml/pdf/sql output, - -_* the results of an sql search can just be "live" citation references to the documents in which the text is found, {~^ much like an index (see image examples provided). }http://www.jus.uio.no/sisu/SiSU/1.html#search - -I claim copyright on the system I use which is the most basic of all, numbering all text in headings and paragraphs sequentially (with tables and images being treated as a single paragraph) and only footnotes/endnotes not following this numbering, as their position in text is not strictly determined, (a change from footnotes to endnotes would change their numbering), footnotes instead "belong" to the paragraph from which they are referenced, and have sequential numbers of their own. - -SiSU has a paragraph numbering system, that remains the same regardless of the output format. This provides an effective means of citation, pinpointing text accurately in all output formats, using the same reference. This is particularly useful where text has to be located across different output formats - for example once html is printed the number of pages and pages on which given text is found will vary depending on the browser, its settings the font size setting etc. Similarly SiSU produces pdf in different forms, eg. on the example site Lex Mercatoria as portrait and landscape documents - here too page numbering varies, but paragraph numbering is the same, /{vis a vis}/ all versions of the text (portrait and landscape pdf and the html versions of the text, and as stored (with "paragraphs" as records) to the PostgreSQL or SQLite database). - -These numbers are placed in the text margins and are intended to be independent of and not to interfere with authors tagging. [The citation system (object citation numbering system, automated "paragraph numbering") which is automatically generated and is common and identical across all document formats] The paragraph numbering system is more accurately described as an (text) object numbering system, as headings are also numbered... all headings and paragraphs are numbered sequentially. Endnotes are automatically numbered independently and rather "belong" to the paragraph from which they are referenced, as an endnote does not (necessarily) form a part of a documents sequence, (they may be produced as either endnotes or footnotes (or both depending on what output you choose to look at - if you take the segmented html version document provided as an example, you will find that the endnotes are placed both at the end of each section, and in a separate section of their own called endnotes, and these are hyper-linked)). An attractive feature of providing citation numbering in this way is that it is independent of the document structure... it remains the same regardless of what is done about the document structure. - -The rules have been kept very simple, unique incremental object citation numbers are assigned to headings, paragraphs, verse, tables and images. It is possible to manually override this feature on a per heading or comment basis though this should be used exceptionally, it may be of use where there a substantive text, and the addition of a minor comment by the publisher that should not be mapped as part of the text. - -The object citation number markers contain additional numbering information with regard to the document structure, that can be used for alternative presentations, including such detail as the type of object (heading, paragraph, table, image, etc.), numbered sequentially. - -An advantage is that the numbering remains the same regardless of document structure. - -Text object ("paragraph") numbering is the same for all output versions of the same document, vis html, epub, pdf, pgsql, etc. - -In the relational database, as individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, the results of searches may be tailored just to provide the location of the search result in all available document formats. - -/{ Note: there is a bug in the released behaviour of object citation numbering, (not certain when it was introduced) tables should be numbered, ie each table gets an ocn, required amongst other things for relational database. This will be corrected in a future release. Citation numbering of existing documents that contain tables will changed. }/ - -2~ Handling of Dublin Core meta-tags making use of the Resource Description Framework - -SiSU is able to use meta tags based on the Dublin Core~{ http://dublincore.org/ }~ and Resource Description Framework~{ http://www.w3.org/RDF/ }~ - -This provides the means of providing semantic information about a document, both as computer processable meta-tags, and as human readable information that may be of value for classification purposes. - -This information is provided both in html metatags, and (where available) under the section titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html - -2~ Easy directory management - -#1 Directory file association, skins and special image management, made simpler.~{ The previous way was directory associations for file output were set up in the configuration file. The present system is a more natural way to work requireing less configuration. }~ - -The last part of the name of the work directory in which markup is being done, or rather from where SiSU is run in order to generate document output, is used in determining the sub-directory name for output files, that is created in the document output directory. This provides a rather easy way to associate documents e.g. of a given subject, or by owner. - -code{ - -/www/docs - /intellectual_property - /arbitration - /contract_law - -/www/docs - /ralph - /sisu - -}code - -all are placed in their own directories within the directory structure created. Similar rules are used in the creation of sql type databases (though they can be overridden). - -There are a couple of further associations with these directories. - -Directory wide skins. - -Directory specific images. - -# If there is a "directory skin", that is a skin of the same name as the directory, it is used in the generation of the documents within it, rather than the default skin, unless the document has a specific skin associated with it. - -_# default skin (always available) - -_# directory skin (precedence over default if exists) - -_# document skin (takes precedence wherever document requests a specific skin) - -Skins are defined in the document skin directory and if a directory association is desired a softlink made to the relevant skin. Skins (directory association auto load) auto load skin if a directory skin exists of same name as directory stub, (and there is no specific doc skin) - -# If the working directory has within it a sub-directory called image_local, the images within that directory are used for references to images, that are not part of the default site build. - -2~ Document Version Control Information - -The possibility of citing an exact document version. - -Permits the inclusion of document version control information to the document body and metatags.~{ from a version control system such as CVS }~ This provides a much more certain method of referring to the exact version of a particular document, (assuming that the document is from a trusted source, that will retain earlier versions of a document).~{ The version control system must be run, so the version number is obtained, prior to the SiSU document generation, and subsequent posting of the document. }~ - -This information (where available) is provided under the section of the document titled "Document Information - MetaData", near the end of a document, for example in the segmented html version of this text at: http://www.jus.uio.no/sisu/SiSU/metadata.html - -2~ Table of contents - -SiSU produces a rudimentary a table of contents based on document headings. - -2~ Auto-numbering of headings - -Headings can be automatically numbered, (and automatically named for hyper-linking) - -2~ Numbering and cross-hyperlinking of endnotes - -SiSU can automatically number footnotes/endnotes. This is the default operation where no number is provided. - -Footnotes/endnotes may also be manually numbered. Where a number, or numbers are provided for a footnote/endnote, this does not increment the automatic footnote/endnote number counter. - -In the html output footnotes/endnotes are cross-hyper-linked (to their reference point and vice versa). In th pdf output footnotes are linked from their reference point only. - -2~ "Skinnable" - -SiSU is skinnable, on a site-wide, directory-wide and per document basis, so different looking versions of things may be produced with little difficulty. There is a default skin which may be modified, as the background site skin, and each working directory may have a skin associated with it, as may each individual document. The hierarchy of application is document, directory, then site... ie if a document skin exists it gets precedence. - -Whilst it is skinnable, the default output styles are selected to work across the widest possible range of document types. - -2~ Multiple Outputs - -From markup that is simpler and more sparse than html you get: - -_* far greater output possibilities, including multiple html types, XML (different structured types), LaTeX (pdf landscape, portrait), and SQL (Postgresql or SQLite or other); - -_* the advantages implicit in these very different output possibilities;~{ e.g. LaTeX (professional document typesetting, easy conversion to pdf or Postscript), XML (in this case, structural representation), SQL (e.g. document set searches; representation of the constituent parts of documents based on their structure, headings, chapters, paragraphs as desired; control of use) }~ - -_* a common citation system - -As many output formats/presentations as one cares to write modules for - several types of html (e.g. structure based on css, or structure based on tables); /{LaTeX/pdf}/ and /{Lout/pdf}/; pgsql other databases easily added; yaml... - -3~ html - several presentations: full length & segmented; css & table based - -Most documents are produced in single and segmented html versions, described below: - -!_ The Scroll (full length text presentations) - -The full length of the text in a single scrollable document.~{ CISG http://www.jus.uio.no/lm/un_contracts_international_sale_of_goods_convention_1980/doc
The Unidroit Contract Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994/doc or
The Autonomous Contract http://www.jus.uio.no/lm/autonomous.contract.2000.amissah/doc }~ As a rule the files they are saved in are named: /doc/ or more precisely /{doc.html}/ - -For various reasons texts may only be provided in this form (such as this one which is short), though most are also provided as segmented texts. - -"Scroll" is a reference to the historical scroll, a single long document/ parchment, and also no doubt to what you will have to do to get to the bottom of the text.~{ Scrolling is not however necessarily confined to full length documents as you will have to scroll to get to the bottom of any long segment (eg. chapter) of a segmented text. }~ - -!_ The Segmented Text - -The text divided into segments (such as articles or chapters depending on the text)~{ CISG http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980
The Unidroit Principles http://www.jus.uio.no/lm/unidroit.contract.principles.1994
The Autonomous Contract http://www.jus.uio.no/sisu/the.autonomous.contract.2000.amissah or
WTA 1994 http://www.jus.uio.no/lm/wta.1994 }~ As a rule the files they are saved in are named: /toc/ and /index/ or more precisely /{toc.html}/ and /{index.html}/ - -If you know exactly what you are looking for, loading a segment of text is faster (the segments being smaller). Occasionally longer documents such as the WTA 1994 http://www.jus.uio.no/lm/wta.1994/toc are only provided in segmented form. - -!_ Cascading Style Sheet, and Table based html - -SiSU outputs html, two current standard forms available are: - -{ css based }http://www.jus.uio.no/sisu/SiSU/toc.html - -and - -table based [largely discontinued]~{ formatting possibility still exists in code tree but maintenance has been largely discontinuted. }~ - -!_ The html is tested across several browsers - -I like to remind you that there are other excellent browsers out there, many of which have long supported practical features like tabbing. - -The html is tested across several browsers, including: - -_* {~^ *Firefox* (Mozilla-Firefox) }http://www.mozilla.org/products/firefox/ - -_* {~^ Kazehakase }http://kazehakase.sourceforge.jp/ - -_* {~^ Konqueror }http://www.konqueror.org/ - -_* {~^ Mozilla }http://www.mozilla.org/ - -_* {~^ MS Internet Explorer }http://www.microsoft.com/windows/ie/default.asp - -_* {~^ Netscape }http://home.netscape.com/comprod/mirror/client_download.html - -_* {~^ Opera }http://www.opera.com/ - -Also lighter weight graphical browsers: - -_* {~^ Dillo }http://www.dillo.org/ - -_* {~^ *Epiphany* }http://www.gnome.org/projects/epiphany/ - -_* {~^ *Galeon* }http://galeon.sourceforge.net/ - -And for console/text browsing: - -_* {~^ *elinks* }http://elinks.or.cz/ - -_* {~^ *links2* }http://links.twibright.com/ - -_* {~^ *w3m* }http://w3m.sourceforge.net/ - -The html tables output is rendered more accurately across a wider variety set and older versions of browsers (than the html css output). - -3~ EPUB - -SiSU generates EPUB documents. - -3~ XML - -SiSU generates well formed XML, and multiple versions. An XML SAX version with a flat/shallow structure, and XML DOM version with a deeper (embedded) structure. There is also a released working xhtml module. Examples of SAX and DOM versions are provided within this document. - -3~ ODT:ODF, Open Document Format - ISO/IEC 26300:2006 - -SiSU generates Open Document Output format. - -3~ PDF - portrait and landscape, (through the generation of LaTeX output which is then transformed to pdf) - -SiSU outputs LaTeX if required which is easily transformed to PDF.~{ LaTeX and pdf features introduced 18^th^ June 2001, Landscape and portrait pdfs introduced 7^th^ October 2001., Lout is a more recent addition 22^th^ April 2003 }~ PDF documents are generated on the site from the same source files and Ruby program that produce html. Landscape oriented pdf introduced, providing easier screen viewing, they are also (paper saving, being currently) formatted to have fewer pages than their portrait equivalents. - -_* {~^ Adobe Reader }http://www.adobe.com/products/acrobat/readstep2.html - -_* {~^ *Evince* }http://www.gnome.org/projects/evince/ - -_* {~^ xpdf }http://www.foolabs.com/xpdf/ - -3~ Search - loading/populating of relational database while retaining document structure information, object citation numbering and other features (currently PostgreSQL and/or SQLite) - -SiSU (from the same markup input file) automatically feeds into PostgreSQL~{ http://www.postgresql.org/
http://advocacy.postgresql.org/
http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/
http://en.wikipedia.org/wiki/Sqlite }~ database (could be any other of the better relational databases)~{ Relational database features retaining document structure and citation introduced 15^th^ July 2002 }~ - together with all additional information related to document structure, and the alternative ways in which it is generated on the site retained. As regards scaling of the database, it is as scalable as the database (here Postgresql or SQLite) and hardware allow. I will prune the images later. - -This is one of the more interesting output forms, as all the structural data for the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four pgsql database tables: - -_1* one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); - -_1* another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and - -_1* a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). - -_1* a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. - -There is of course the possibility to add further structures. - -At this level SiSU loads a relational database with documents broken in to their smallest logical structurally constituent parts, as text objects, with their object citation number and all other structural information needed to construct the structured document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. - -Because the document structure of sites created is clearly defined, and the text object citation system is available for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. - -The combination of the SiSU citation system with a relational database is pretty powerful, giving rise to several possibilities. As individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, complex searches can be tailored to return just the locations of the search results relevant for all available output formats, with live links to the precise locations in the database or in html/xml documents; or, the structural information provided makes it possible to search the full contents of the database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well). - -This is a larger scale project, (with little development on the front end largely ignored), though the "infrastructure" has been in place since 2002. - -3~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search - -{~^ Sample search frontend }http://search.sisudoc.org -A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. }~ - -SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, EPUB, XML, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. - -(further work needs to be done on the sample search form, which is rudimentary and only passes simple booleans correctly at present to the SQL engine) - -A few canned searches, showing object numbers. Search for: - -{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 - -{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 - -{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 - -{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 - -Note that the searches done in this form are case sensitive. - -Expand those same searches, showing the matching text in each document: - -{ English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 - -{ GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 - -{ invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 - -{ copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 - -Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ - -!_ OCN index mode, -(object citation number) the numbers displayed are relevant (and may be used to reference the match) in any sisu generated rendition of the text~{ OCN are provided for HTML, XML, EPUB, pdf ... though currently omitted in plain-text and opendocument format output }~ the links provided are to the locations of matches within the html generated by SiSU. - -!_ Paragraph mode, -you may alternatively display the text of each paragraph in which the match was made, again the object/paragraph numbers are relevant to any SiSU generated/published text. - -Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. - -Simple search, results with files in which search found, and text object (paragraph or endnote) where found within files. - -3~ Other forms - -There are other forms as well, YAML file, Ruby Marshal dumps, document pre-processing (processing of documents prior to the steps described here, to produce input suitable for the program) snap in a new module as required/desired, well formed XML, no problem. - -2~ Concordance / Word Map or rudimentary index - -Concordance /WordMaps:~{ Concordance/ WordMaps introduced 15^th^ August 2002 }~ SiSU produces a rudimentary index based on the words within the text, making use of paragraph numbers to identify text locations. This is generated in html and hyper-linked but identifies these words locations in the other document formats. Though it is possible to search using a search engine, this is a means for browsing an alphabetical list of words which may suggest other useful content. - -% Concordance files may be built using a document vocabulary. The vocabulary to be used may be specified on a per document basis. - -2~ Managed (document) directory, database, or site structure - -SiSU builds the web site (or more generically provides a suitable directory structure) - placing various output texts in the hierarchy of the web-site (or db), which (for directories) is a sub-directory with the name of the text file. - -2~ Batch processing - -SiSU is a batch processing tool, handling and transforming multiple (or individual) documents (in many ways) with a single instruction. - -2~ Integration to superior Gnu/Linux and Unix tools - -As should have been noted by the above description of SiSU, it makes use of existing programs found on Gnu/Linux and Unix, amongst those already mentioned include the LaTeX to pdf converters and the database PostgreSQL or SQLite. - -3~ Backup and version control - -Unix provides many tools for version control. For documents Subversion, CVS and even the old RCS are useful for the per-document histories they provide. - -For writing code superior (more recent) version control system exist. These can also be used for documents though they tend to take stamps of changes across the repository as a whole, rather than for each individual file that is tracked, (as CVS and RCS do). My personal preference is for distributed systems such as Git, Mercurial or Darcs, of which I use Git for both code and documents. - -Several backup tools exist. At the base level I tend to use rdiff. - -3~ Editor support - -SiSU documents are prepared / marked up in utf-8 text _{you are free to use the text editor of your choice.}_ - -Syntax highlighting for a number of editors are provided. Amongst them Vim, Kwrite, Kate, Gedit and diakonos. These may be found with configuration instructions at http://www.jus.uio.no/sisu/syntax_highlight. {~^ Vim }http://www.vim.org/ as of version 7 has built in sytax highlighting for SiSU. - -2~ Modular design, need something new add a module - -Need a new output format that does not already exist, write a new module. - -Prefer a new input syntax, you could write a new syntax matching the existing design, though my personal preference is some uniformity in entry appearance. If necessary has been fairly easy to extend the design parameters. It is intended to incorporate some additional basic semantic tagging, (book, article, author etc.) However, keeping the requirements for input minimal, and relatively simple has been a design goal. - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_download.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_download.ssi deleted file mode 100644 index b71ddbca..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_download.ssi +++ /dev/null @@ -1,163 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - SiSU information Structuring Universe / Structured information, Serialized Units - :subtitle: Download, Stable and Development Branches - -@creator: :author: Amissah, Ralph - -% used_by: SiSU.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :published: 2009-01-18 - :modified: 2010-06-11 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu - :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|atomic search|rant|utf-?8|UTF-?8|WARNING/ - :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|atomic search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i - -@links: - {What does SiSU do? Summary}../SiSU/1.html#summary - { Book Samples and Markup Examples }../SiSU/examples.html - {SiSU Markup Syntax}../sample - {*Citation System* Object Citation Numbering}../SiSU/1.html#citation - {*Granular Search*}../SiSU/1.html#search - {The Chart (pdf)}../diagram/sisu.chart.pdf - {Accompanying Diagrams}../diagram/sisu_provisional_patent_application_diagram_200408.pdf - {Standard}../SiSU/standard.html - {License}../SiSU/license.html - {man pages}../SiSU/3.html#man - {SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - {SiSU @ Freshmeat}http://freshmeat.net/projects/sisu/ - {SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - {SiSU @ Debian}http://packages.qa.debian.org/s/sisu.html - {Download}../SiSU/download.html - {Changelog}../SiSU/changelog.html - -:A~? @title @creator - -:B~? SiSU Downloads, Stable and Development Branches - -:C~ Download information - -1~download Download SiSU - Linux/Unix - -2~current- SiSU Current Version - Linux/Unix - -3~source- Source (tarball tar.gz) - -_* {~^ sisu_2.5.1.orig.tar.gz (2010-06-12:23/6) }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1.orig.tar.gz - -_* {~^ sisu-markup-samples_2.0.3.orig.tar.gz (of 2010-05-01:17/6 ) }http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_2.0.3.orig.tar.gz *~sisu-markup-samples - -For installation notes see http://sisudoc.org/sisu/sisu_manual/installation.html - -For more general use see http://sisudoc.org/sisu/sisu_manual - -For changelogs see http://www.jus.uio.no/sisu/SiSU/changelog.html - -3~git- Git (source control management) - -Git repository currently at: - -_* git clone git://git.sisudoc.org/git/code/sisu.git - -_* git clone _http://git.sisudoc.org/git/code/sisu.git - -_* http://git.sisudoc.org/?p=code/sisu.git;a=summary - -On using git, see - -!_ Git documentation: -{~^ Git User's Manual }http://www.kernel.org/pub/software/scm/git/docs/user-manual.html, {~^ Everyday GIT With 20 Commands Or So }http://www.kernel.org/pub/software/scm/git/docs/everyday.html, {~^ A tutorial introduction to git }http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial.html, {~^ A tutorial introduction to git: part two }http://www.kernel.org/pub/software/scm/git/docs/v1.4.4.4/tutorial-2.html - -!_ User contributed texts: -{~^ The Git Community Book }http://book.git-scm.com/index.html, {~^ Git Magic }http://www-cs-students.stanford.edu/~blynn/gitmagic/, {~^ Git From the Bottom Up (pdf) }http://www.newartisans.com/blog_assets/git.from.bottom.up.pdf - -3~debian- Debian - -This section contains information on the latest SiSU release. For installation notes see http://sisudoc.org/sisu/sisu_manual/installation.html - -SiSU is updated fairly regularly in Debian testing and unstable, and should be available therefrom. - -To add this archive, should you still choose to do so, add the following lines to your /etc/apt/sources.list - -code{ - -deb http://www.jus.uio.no/sisu/archive unstable main non-free -deb-src http://www.jus.uio.no/sisu/archive unstable main non-free - -}code - -group{ - -*{Source}* - -{~^ sisu_2.5.1.orig.tar.gz }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1.orig.tar.gz - -{~^ sisu_2.5.1-1.diff.gz }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1-1.diff.gz - -{~^ sisu_2.5.1-1.dsc }http://www.jus.uio.no/sisu/pkg/src/sisu_2.5.1-1.dsc - -}group - -group{ - -*{Debs}* - -{~^ sisu_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_2.5.1-1_all.deb ~{
sisu, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies
Depends: ruby (>=1.8.2), libwebrick-ruby
Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, vim-sisu, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl }~ - -{~^ sisu-complete_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-complete_2.5.1-1_all.deb ~{
a package that pulls in other packages to build the whole of sisu (excluding sisu-examples)
Depends: ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite, vim-sisu
Recommends: sisu-examples }~ - -{~^ sisu-pdf_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-pdf_2.5.1-1_all.deb ~{
dependencies used by sisu to produce pdf from LaTeX generated
Depends: sisu, tetex-bin, tetex-extra, latex-ucs
Suggests: evince, xpdf }~ - -{~^ sisu-postgresql_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-postgresql_2.5.1-1_all.deb ~{
dependencies used by sisu to populate postgresql database (further configuration is necessary)
Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby
Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 }~ - -{~^ sisu-sqlite_2.5.1-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-sqlite_2.5.1-1_all.deb ~{
dependencies used by sisu to populate sqlite database
Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby
Suggests: libdbd-sqlite }~ - -}group - -For changelogs see: - -_1 http://www.jus.uio.no/sisu/SiSU/changelog.html - -_1 http://www.jus.uio.no/sisu/sisu_changelog/changelog.html - -!_ non-free - -Book markup samples have been moved to non-free as the substantive text of the documents are available under the author or original publisher's license, and usually do not comply with the Debian Free Software Guidelines. - -_* {~^ sisu-markup-samples_2.0.3-1_all.deb }http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_2.0.3-1_all.deb ~{
marked up documents and other examples related to sisu, a larger package containing a number of texts
Depends: sisu }~ - -_* {~^ sisu-markup-samples_2.0.3-1.dsc }http://www.jus.uio.no/sisu/pkg/src/sisu-markup-samples_2.0.3-1.dsc ~{
sisu-markup-samples_2.0.3-1.dsc }~ - -For changelogs see: - -_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html - -_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html - -3~rpm- RPM - -The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. - -sudo rpm -i [package name] - -_* {~^ sisu-2.5.1-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu-2.5.1-2.noarch.rpm ~{
created using alien }~ - -_* {~^ sisu-markup-samples_2.0.3.orig-2.noarch.rpm }http://www.jus.uio.no/sisu/pkg/rpm/sisu-markup-samples_2.0.3.orig-2.noarch.rpm ~{
http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_2.0.3-1_all.deb
created using: alien -r sisu_0.70.5-1_all.deb }~ - -For changelogs see: - -_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html - -_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.ssi deleted file mode 100644 index 64a1fe90..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.ssi +++ /dev/null @@ -1,54 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Markup Samples, Output Examples - -@creator: :author: Amissah, Ralph - -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@date: - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual -% :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - {Book Samples and Markup Examples}../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Markup and Output Examples - -1~examples Markup and Output Examples - -2~ Markup examples *~markup - -Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html - -Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. - -For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.sst deleted file mode 100644 index 9460615e..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_examples.sst +++ /dev/null @@ -1,220 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Markup Samples, Output Examples - -@creator: :author: Amissah, Ralph - -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@date: - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual -% :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - {Book Samples and Markup Examples}../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Markup and Output Examples - -1~examples Markup and Output Examples - -2~ Markup examples *~markup - -Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html - -Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date. - -For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. - -<:pb> - -2~ A few book (and other) examples *~books *~sample *~example *~output - -3~wealth_of_networks- /{"The Wealth of Networks"}/, Yochai Benkler - -{ "The Wealth of Networks", Yochai Benkler [3sS]}the_wealth_of_networks.yochai_benkler.sst - -3~two_bits- /{"Two Bits"}/, Christopher Kelty - -{ "Two Bits", Christopher Kelty [3sS]}two_bits.christopher_kelty.sst - -3~freeculture- /{"Free Culture"}/, Lawrence Lessig - -{ "Free Culture", Lawrence Lessig [3sS]}free_culture.lawrence_lessig.sst - -3~free_as_in_freedom- /{"Free as in Freedom: Richard Stallman's Crusade for Free Software"}/, by Sam Williams - -{ "Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams [3sS]}free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst - -3~free_for_all- /{"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans"}/, by Peter Wayner - -{ "Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner [3sS]}free_for_all.peter_wayner.sst - -3~catb- /{"The Cathedral and the Bazaar"}/, by Eric S. Raymond - -{ "The Cathedral and the Bazaar", by Eric S. Raymond [3sS]}the_cathedral_and_the_bazaar.eric_s_raymond.sst - -3~littlebrother- /{"Little Brother"}/, Cory Doctorow *~doctorow - -{ "Little Brother", Cory Doctorow [3sS]}little_brother.cory_doctorow.sst *~littlebrother - -3~accelerando- /{"Accelerando"}/, Charles Stross *~stross - -{ "Accelerando", Charles Stross [3sS]}accelerando.charles_stross.sst *~accelerando - -3~tainaron- /{"Tainaron"}/, Leena Krohn *~krohn - -{ "Tainaron", Leena Krohn [3sS]}tainaron.leena_krohn.1998.sst *~tainaron - -3~sphinx- /{"Sphinx or Robot"}/, Leena Krohn *~sor - -{ "Sphinx or Robot", Leena Krohn [3sS]}sphinx_or_robot.leena_krohn.1996.sst - -3~war_and_peace- /{"War and Peace"}/, Leo Tolstoy, PG Etext 2600 *~wap *~gutenberg - -{ "War and Peace", Leo Tolstoy [3sS]}war_and_peace.leo_tolstoy.sst ~{ http://www.jus.uio.no/sisu/war_and_peace.leo_tolstoy/toc.html
The ascii text was taken from Project Gutenberg. The markup transforms required are trivial. Of interest, in this instance I am saved by having alternative syntaxes/(structural modes) for marking up endnotes... as it was possible to do a simple search and replace to make the Project Gutenberg ascii presentation suitable for SiSU, using the older endnote markup style. This example instructs the program to use regular expressions, in this example the words: none; none; BOOK|FIRST|SECOND; CHAPTER; occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). Note that there was _{very little markup required}_ after the document headers and Project Gutenberg legal notices. As I presume the legal notices are similar in Project Gutenberg documents, (and I could not bear to think of preparing the same legal notices twice), I moved those to the "skin" for the Project, and these are now represented in the markup by \<:insert1\> and \<:insert2\> and the legal notices are available for similar insertion into the next Project Gutenberg text prepared for SiSU, should there be one.
I did a stylesheet/skin for the Gutenberg Project, ... I may have to remove. }~ - -3~quixote- /{"Don Quixote"}/, Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996 - -{ "Don Quixote", Miguel de Cervantes [Saavedra] [3sS]}don_quixote.miguel_de_cervantes.sst - -3~gulliver- /{"Gulliver's Travels"}/, Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829 *~swift - -{ "Gulliver's Travels", Jonathan Swift [3sS]}gullivers_travels.jonathan_swift.sst - -3~alice- /{"Alice's Adventures in Wonderland"}/, Lewis Carroll, PG Etext 11 - -{ "Alice's Adventures in Wonderland", Lewis Carroll [3sS]}alices_adventures_in_wonderland.lewis_carroll.sst - -3~glass- /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etext 12 - -{ "Through The Looking-Glass", Lewis Carroll [3sS]}through_the_looking_glass.lewis_carroll.sst - -3~alice- /{"Alice's Adventures in Wonderland"}/ and /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etexts 11 and 12 - -{ "Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll [3sS]}alices_adventures_in_wonderland_and_through_the_looking_glass.lewis_carroll.ssm - -3~gpl- /{"Gnu Public License 2"}/, (GPL 2) Free Software Foundation - -{ "Gnu Public License 2", (GPL 2) Free Software Foundation [3sS]}gpl2.fsf.sst - -3~gpl- /{"Gnu Public License v3 - Third discussion draft"}/, (GPLv3) Free Software Foundation - -{ "Gnu Public License 3 - Third discussion draft", (GPL v3 draft3) Free Software Foundation [3sS]}gpl3_draft3.fsf.sst - -3~dsc- /{"Debian Social Contract"}/ - -{ "Debian Social Contract" [3sS]}debian_social_contract_v1.1.sst - -3~dc- /{"Debian Constitution v1.3"}/, (simple/default markup) - -{ "Debian Constitution v1.3" [3sS]}debian_constitution_v1.3.sst - -3~dc- /{"Debian Constitution v1.3"}/, (markup adjusted for output to more closely match the original) - -{ "Debian Constitution v1.3", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.3.adjusted.sst - -3~dc- /{"Debian Constitution v1.2"}/, (simple/default markup) - -{ "Debian Constitution v1.2 (more translations)" [3sS]}debian_constitution_v1.2.sst - -3~dc- /{"Debian Constitution v1.2"}/, (markup adjusted for output to more closely match the original) - -{ "Debian Constitution (more translations)", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.2.adjusted.sst - -3~terminology- /{"A Uniform Sales Terminology"}/, Vikki Rogers and Albert Kritzer - -{ "A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer [3sS]}a_uniform_international_sales_terminology.vikki_rogers.and.albert_kritzer.sst - -3~autonomous- /{"The Autonomous Contract" 1997 }/ - markup sample - -{ "The Autonomous Contract" 1997 - markup sample [3sS]}the_autonomous_contract.amissah.19970710.sst - -3~autonomous- /{"The Autonomous Contract Revisited"}/ - markup sample - -{ "The Autonomous Contract Revisited" - markup sample [3sS]}autonomy_markup0.sst ~{ http://www.jus.uio.no/sisu/autonomy_markup0/toc.html
alternative markup variations revolving around endnotes
(i) as above, markup with embedded endnotes, and header list of words/phrases to emphasise
http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup0.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst
(ii) Again markup with embedded endnotes, but font faces changed within paragraphs rather than in header as in i
http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup1.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup1.sst
(iii) Markup with endnote placemarks within paragraphs, the endnotes following the paragraph that contains them http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup2.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup2.sst
(iv) Another alternative is to place the marked up endnotes sequentially and at the end of the text. This also works. The paragraph variant iii is perhaps easier to visually check should there be missing endnotes; but this variant iv may better suit the conversion of alternatively pre-prepared documents. }~ - -3~cisg- /{"United Nations Convention on Contracts for the International Sale of Goods"}/ - -{ "United Nations Convention on Contracts for the International Sale of Goods" [3sS]}un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html
This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents).
This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). }~ - -3~pecl- /PECL/ the "Principles of European Contract Law" - -{ "Principles of European Contract Law" [3sS]}eu_contract_principles_parts_1_to_3_2002.sst - -2~sql SQL - PostgreSQL, SQLite - -A Sample search form is available at http://search.sisudoc.org - -A few canned searches, showing object numbers. Search for: - -_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=index&a=1 - -_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=index&a=1 - -_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=index&a=1 - -_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=index&a=1 - -Note that the searches done in this form are case sensitive. - -Expand those same searches, showing the matching text in each document: - -_1 { English documents matching Linux OR Debian }http://search.sisudoc.org?s1=Linux%2BOR%2BDebian&lang=En&db=SiSU_sisu&view=text&a=1 - -_1 { GPL OR Richard Stallman }http://search.sisudoc.org?s1=GPL%2BOR%2BRichard%2BStallman&lang=En&db=SiSU_sisu&view=text&a=1 - -_1 { invention OR innovation in English language }http://search.sisudoc.org?s1=invention%2BOR%2Binnovation&lang=En&db=SiSU_sisu&view=text&a=1 - -_1 { copyright in English language documents }http://search.sisudoc.org?s1=copyright&lang=En&db=SiSU_sisu&view=text&a=1 - -Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ - -2~ Lex Mercatoria as an example - -There is quite a bit to peruse if you explore the site Lex Mercatoria: - -http://www.lexmercatoria.org/ ~{ http://www.jus.uio.no/lm/index }~ - -or perhaps: - -http://lexmercatoria.org/treaties.and.organisations/lm.chronological ~{ http://www.jus.uio.no/lm/treaties.and.organisations/lm.chronological }~ - -2~ For good measure the markup for a document with lots of (simple) tables - -SiSU is not optimised for table making, but does handle simple tables. - -_* {~^ SiSU marked up file with tables }http://www.jus.uio.no/sisu/sample/syntax/un_conventions_membership_status.sst.html ~{
http://www.jus.uio.no/sisu/sample/markup/un_conventions_membership_status.sst }~ - -_* {~^ Output of table file example }http://www.jus.uio.no/lm/un_conventions_membership_status/toc.html - -2~ And a link to the output of a reported case - -http://www.jus.uio.no/lm/england.fothergill.v.monarch.airlines.hl.1980/toc.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_faq.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_faq.sst deleted file mode 100644 index 3acbbb74..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_faq.sst +++ /dev/null @@ -1,221 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: FAQ - Frequently Asked/Answered Questions - -@creator: :author: Amissah, Ralph - -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:FAQ;sisu:document:FAQ;SiSU:manual:FAQ;electronic documents:SiSU:manual:FAQ - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual SiSU.ssm - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@date: - :published: 2008-03-12 - :created: 2006-09-06 - :available: 2006-09-06 - :issued: 2006-09-06 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -1~faq FAQ - Frequently Asked/Answered Questions - -2~ Why are urls produced with the -v (and -u) flag that point to a web server on port 8081 ? - -Try the following rune: - -_* sisu -W - -This should start the ruby webserver. It should be done after having produced some output as it scans the output directory for what to serve. - -2~ I cannot find my output, where is it? - -The following should provide help on output paths: - -_* sisu --help env - -_* sisu -V [same as the previous command] - -_* sisu --help directory - -_* sisu --help path - -_* sisu -U [filename] - -_* man sisu - -2~ I do not get any pdf output, why? - -SiSU produces LaTeX and pdflatex is run against that to generate pdf files. - -If you use Debian the following will install the required dependencies - -_* aptitude install sisu-pdf - -the following packages are required: tetex-bin, tetex-extra, latex-ucs - -2~ Where is the latex (or some other interim) output? - -Try adding -M (for maintenance) to your command flags, e.g.: - -_* sisu -HpMv [filename] - -this should result in the interim processing output being retained, and information being provided on where to find it. - -_* sisu --help directory - -_* sisu --help path - -should also provide some relevant information as to where it is placed. - -2~ Why isn't SiSU markup XML - -I worked with text and (though I find XML immensely valuable) disliked noise -... better to sidestep the question and say: - -SiSU currently "understands" three XML input representations - or more accurately, converts from three forms of XML to native SiSU markup for processing. The three types correspond to SAX (structure described), DOM (structure embedded, whole document must be read before structure is correctly discernable) and node based (a tree) forms of XML document structure representation. Problem is I use them very seldom and check that all is as it should be with them seldom, so I would not be surprised if something breaks there, but as far as I know they are working. I will check and add an XML markup help page before the next release. There already is a bit of information in the man page under the title SiSU VERSION CONVERSION - -_1 sisu --to-sax [filename/wildcard] - -_1 sisu --to-dom [filename/wildcard] - -_1 sisu --to-node [filename/wildcard] - -The XML should be well formed... must check, but lacks sensible headers. Suggestions welcome as to what to make of them. [For the present time I am satisfied that I can convert (both ways) between 3 forms of XML representation and SiSU markup]. - -_1 sisu --from-xml2sst [filename/wildcard] - -2~ LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU? - -% what are some similarities and differences between LaTex and SiSU? - -SiSU is not really about type-setting. - -LaTeX is the ultimate computer instruction type-setting language for paper based publication. - -LaTeX is able to control just about everything that happens on page and pixel, position letters kerning, space variation between characters, words, paragraphs etc. formula. - -SiSU is not really about type-setting at all. It is about a lightweight markup instruction that provides enough information for an abstraction of the documents structure and objects, from which different forms of representation of the document can be generated. - -SiSU with very little markup instruction is able to produce relatively high quality pdf by virtue of being able to generate usable default LaTeX; it produces "quality" html by generating the html directly; likewise it populates an SQL database in a useful way with the document in object sized chunks and its meta-data. But SiSU works on an abstraction of the document's structure and content and custom builds suitable uniform output. The html for browser viewing and pdf for paper viewing/publishing are rather different things with different needs for layout - as indeed is what is needed to store information in a database in searchable objects. - -% SiSU is a lightweight document abstraction, meta-(structure and markup) syntax designed to make use of a minimal amount of preparation detail that can be used across very different ways of representing documents - -The pdfs or html produced for example by open office based on open document format and other office/word processor suits usually attempt to have similar looking outputs - your document rendered in html looks much the same, or in pdf... sisu is less this way, it seeks to have a starting point with as little information about appearance as possible, and to come up with the best possible appearance for each output that can be derived based on this minimal information. - -Where there are large document sets, it provides consistency in appearance in each output format for the documents. - -The excuse for going this way is, it is a waste of time to think much about appearance when working on substantive content, it is the substantive content that is relevant, not the way it looks beyond the basic informational tags - and yet you want to be able to take advantage of as many useful different ways of representing documents as are available, and for various types of output to to be/look as good as it can for each medium/format in which it is presented, (with different mediums having different focuses) and SiSU tries to achieve this from minimal markup. - -2~ Can the SiSU markup be used to prepare for a LaTex automatic building of an index to the work? - -Has not been, is of interest though the question on introducing such possibilities is how to keep them as unobtrusive as possible, and as generically relevant as possible to other output formats (which is why the focus on object numbers). Unobtrusive refers both to the markup (where there is no big problem with introducing optional extras); and, more challengingly how to minimise impact on competing ideas/interests, such allowing the addition of semantic tags which could be tied to objects, mapped against the objects that contain them, (permitting mapping and mining of content in various ways that would be largely agnostic of output format - object numbering being an attempt to move beyond output format based content locators (such as page numbers). The desire being to (be a meta markup and) maintain agnosticism as to what is being generated and in development to favor solutions of that nature. Keep bridging LaTeX, XML, SQL ... make use of objects and serialisation for mapping whether against content or meta-content (such as semantic [or additional structural] markers). - -2~ Can the conversion from SiSU to LaTeX be modified if we have special needs for the LaTeX, or do we need to modify the LaTeX manually? - -Should be possible to modify code, it is GPLv3, should be possible either to modify existing modules or write an independent module for generating bespoke latex. Generic improvements are welcome for inclusion/incorporation in the existing code base. - -If there are tools to generate mathematical/scientific formula from latex to images (jpg, png), the latex parser could conceivably be used to make these available to other output formats. - -2~ How do I create GIN or GiST index in Postgresql for use in SiSU - -This at present needs to be done "manually" and it is probably necessary to alter the sample search form. The following is a helpful response from one of the contributors of GiN to Postgresql Oleg Bartunov 2006-12-06: - -"I have tsearch2 slides which introduces tsearch2 -http://www.sai.msu.su/~megera/wiki/tsearch2slides - -FTS in PostgreSQL is provided by tsearch2, which should works without -any indices (GiST or GIN) ! Indices provide performance, not functionality. - -In your example I'd do ( simple way, just for demo): - -!_ 0. -compile, install tsearch2 and load tsearch2 into your database - -_1 cd contrib/tsearch2; make&&make&&install&&make installcheck; psql DB < tsearch2.sql - -!_ 1. -Add column fts, which holds tsvector - -_1 alter table documents add column fts tsvector; - -!_ 2. -Fill fts column - -_1 update document set fts = to_tsvector(clean); - -!_ 3. -create index - just for performance ! - -_1 create index fts_gin_idx on document using gin(fts); - -!_ 4. -Run vacuum - -_1 vacuum analyze document; - -That's all. - -Now you can search: - -select lid, metadata_tid, rank_cd(fts, q,2)as rank from document, plainto_tsquery('markup syntax') q where q @@ fts order by rank desc limit 10; - -2~ Are there some examples of using Ferret Search with a SiSU repository? - -Heard good things about Ferret, but have not used it. The output directory structure and content produced by SiSU is very uniform. Have looked at a couple of other engines (hyperestraier, lucene). There it was enough to identify the files that needed to be indexed and pass them to the search indexing tool. Some Unix rune doing the job, such as: - -code{ - -find /home/ralph/sisu_www -type f | \ -egrep '/sisu_www/(sisu|document_archive)/.+?.html$' | \ -egrep -v '(doc|concordance).html$' | \ -estcmd gather -sd casket - - -}code - -you would have to experiment with what gives the desired result, the file doc.html is the complete text in html (there are additional smaller html segments), and plain.txt the document as a text file. It may be possible to index the text file and return the html document. - - -2~ Have you had any reports of building SiSU from tar on Mac OS 10.4? - -None. In the early days of its release a Mac friend built and run the ruby code part that did not rely on system calls to bits like the latex engine. That is already some years back. He was not into writing or document markup, and did it as a favour at the time. I have not followed up that thread of development. - -It should however be possible, much of the output relies on plain ruby, and the system commands to latex etc. could be made appropriate for the underlying OS. - -2~ Where is version 1.0? - -Most of SiSU is mature and stable. -Version 1.0 will be based on the current markup, (more likely with optional additions rather than significant changes) and directory structure. -At this point (semantic tagging apart) it is largely a matter of choice as to when the version change is made. - -The feature set for html,~{ html w3c compliance has been largely met. }~ LaTeX/pdf and opendocument is in place. -XML, and plaintext are in order. - -html and LaTeX/pdf may be regarded as reference copy outputs - -With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done. - -We are still almost there. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_filetypes.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_filetypes.sst deleted file mode 100644 index 55ab627f..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_filetypes.sst +++ /dev/null @@ -1,170 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Filetypes - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:filetypes;electronic documents:SiSU:manual:filetypes - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -1~filetypes SiSU filetypes - -SiSU has plaintext and binary filetypes, and can process either type of document. - -2~ .sst .ssm .ssi marked up plain text - -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. - -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. - -SiSU source markup can be shared with the command: - -_1 sisu -s [filename] - -3~ sisu text - regular files (.sst) - -The most common form of document in SiSU, see the section on SiSU markup. - -http://www.jus.uio.no/sisu/sisu_markup - -http://www.jus.uio.no/sisu/sisu_manual - -3~ sisu master files (.ssm) - -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. - -The mechanism by which master files incorporate other documents is described as one of the headings under under SiSU markup in the SiSU manual. - -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. - -Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst ~{ .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. }~ - -http://www.jus.uio.no/sisu/sisu_markup - -http://www.jus.uio.no/sisu/sisu_manual - -3~ sisu insert files (.ssi) - -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. - -2~ sisupod, zipped binary container (sisupod.zip, .ssp) - -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) - -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. - -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. - -The command to create a sisupod is: - -_1 sisu -S [filename] - -Alternatively, make a pod of the contents of a whole directory: - -_1 sisu -S - -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. - -http://www.jus.uio.no/sisu/sisu_commands - -http://www.jus.uio.no/sisu/sisu_manual - -1~alt Experimental Alternative Input Representations - -2~ Alternative XML - -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. - -!_ convert from sst to simple xml representations (sax, dom and node): - -_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] - -_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] - -_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] - -!_ convert to sst from any sisu xml representation (sax, dom and node): - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -3~ XML SAX representation - -To convert from sst to simple xml (sax) representation: - -_1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] - -To convert from any sisu xml representation back to sst - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -3~ XML DOM representation - -To convert from sst to simple xml (dom) representation: - -_1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] - -To convert from any sisu xml representation back to sst - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -3~ XML Node representation - -To convert from sst to simple xml (node) representation: - -_1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] - -To convert from any sisu xml representation back to sst - -_1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -or the same: - -_1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] - -% .SH "SKINS \- document, directory and site skins" diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help.sst deleted file mode 100644 index c10807bd..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help.sst +++ /dev/null @@ -1,131 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Help - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:help;electronic documents:manual:SiSU:help - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-08-30 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Help - -1~help Help - -2~ SiSU Manual - -The most up to date information on sisu should be contained in the sisu_manual, available at: - -_1 http://sisudoc.org/sisu/sisu_manual/ - -The manual can be generated from source, found respectively, either within the SiSU tarball -or installed locally at: - -_1 ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ - -_1 /usr/share/doc/sisu/v2/sisu_markup_samples/sisu_manual/ - -move to the respective directory and type e.g.: - -_1 sisu sisu_manual.ssm - -% The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component. - -2~ SiSU man pages *~man - -If SiSU is installed on your system usual man commands should be available, try: - -_1 man sisu - -_1 man sisu_markup - -_1 man sisu_commands - -Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: - -_1 ./data/doc/sisu/v2/sisu_markup_samples/sisu_manual/ - -Once installed, directory equivalent to: - -_1 /usr/share/doc/sisu/sisu_manual/ - -Available man pages are converted back to html using man2html: - -_1 /usr/share/doc/sisu/v2/html/ - -_1 ./data/doc/sisu/v2/html/ - -An online version of the sisu man page is available here: - -_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/ - -_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html - -2~ SiSU built-in interactive help - -This is particularly useful for getting the current sisu setup/environment information: - -_1 sisu --help - -_1 sisu --help [subject] - -_2 sisu --help commands - -_2 sisu --help markup - -_2 sisu --help env [for feedback on the way your system is setup with regard to sisu] - -_1 sisu -V [environment information, same as above command] - -_1 sisu (on its own provides version and some help information) - -Apart from real-time information on your current configuration the SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). - -NOTE: Running the command sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. - -2~ Help Sources - -For lists of alternative help sources, see: - -!_ man page - -_1 man sisu_help_sources - -!_ man2html - -_1 /usr/share/doc/sisu/v2/html/sisu.1.html - -_1 http://sisudoc.org/sisu/sisu_help_sources/index.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help_sources.sst deleted file mode 100644 index edd4699e..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_help_sources.sst +++ /dev/null @@ -1,180 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: References - -@creator: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:help sources;electronic documents:SiSU:manual:help sources - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual - -@date: - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Help Sources - -1~help_sources Help Sources - -For a summary of alternative ways to get help on SiSU try one of the following: - -!_ man page - -_1 man sisu_help - -!_ man2html - -_1 http://www.jus.uio.no/sisu/man/sisu_help.1.html - -!_ sisu generated output - links to html - -_1 http://sisudoc.org/sisu/sisu_help/index.html - -!_ help sources lists - -Alternative sources for this help sources page listed here: - -_1 man sisu_help_sources - -_1 http://sisudoc.org/sisu/sisu_help_sources/index.html - -2~ man pages - -3~ man - -_1 man sisu - -_1 man 7 sisu_complete - -_1 man 7 sisu_pdf - -_1 man 7 sisu_postgresql - -_1 man 7 sisu_sqlite - -_1 man sisu_termsheet - -_1 man sisu_webrick - -2~ sisu generated output - links to html - -Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, odf and epub, which may be also be accessed via the html pages~{ named index.html or more extensively through sisu_manifest.html }~ - -3~ www.sisudoc.org - -http://sisudoc.org/sisu/sisu_manual/index.html - -_1 http://sisudoc.org/sisu/sisu_manual/index.html - -_1 http://sisudoc.org/sisu/sisu_commands/index.html - -_1 http://sisudoc.org/sisu/sisu_complete/index.html - -_1 http://sisudoc.org/sisu/sisu_configuration/index.html - -_1 http://sisudoc.org/sisu/sisu_description/index.html - -_1 http://sisudoc.org/sisu/sisu_examples/index.html - -_1 http://sisudoc.org/sisu/sisu_faq/index.html - -_1 http://sisudoc.org/sisu/sisu_filetypes/index.html - -_1 http://sisudoc.org/sisu/sisu_help/index.html - -_1 http://sisudoc.org/sisu/sisu_help_sources/index.html - -_1 http://sisudoc.org/sisu/sisu_howto/index.html - -_1 http://sisudoc.org/sisu/sisu_introduction/index.html - -_1 http://sisudoc.org/sisu/sisu_manual/index.html - -_1 http://sisudoc.org/sisu/sisu_markup/index.html - -_1 http://sisudoc.org/sisu/sisu_output_overview/index.html - -_1 http://sisudoc.org/sisu/sisu_pdf/index.html - -_1 http://sisudoc.org/sisu/sisu_postgresql/index.html - -_1 http://sisudoc.org/sisu/sisu_quickstart/index.html - -_1 http://sisudoc.org/sisu/sisu_remote/index.html - -_1 http://sisudoc.org/sisu/sisu_search/index.html - -_1 http://sisudoc.org/sisu/sisu_skin/index.html - -_1 http://sisudoc.org/sisu/sisu_sqlite/index.html - -_1 http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html - -_1 http://sisudoc.org/sisu/sisu_vim/index.html - -_1 http://sisudoc.org/sisu/sisu_webrick/index.html - -2~ man2html - -3~ locally installed - -file:///usr/share/doc/sisu/v2/html/sisu.1.html - -file:///usr/share/doc/sisu/v2/html/sisu_help.1.html - -file:///usr/share/doc/sisu/v2/html/sisu_help_sources.1.html - -_1 /usr/share/doc/sisu/v2/html/sisu.1.html - -_1 /usr/share/doc/sisu/v2/html/sisu_pdf.7.html - -_1 /usr/share/doc/sisu/v2/html/sisu_postgresql.7.html - -_1 /usr/share/doc/sisu/v2/html/sisu_sqlite.7.html - -_1 /usr/share/doc/sisu/v2/html/sisu_webrick.1.html - -3~ www.jus.uio.no/sisu - -http://www.jus.uio.no/sisu/man/sisu.1.html - -_1 http://www.jus.uio.no/sisu/man/sisu.1.html - -_1 http://www.jus.uio.no/sisu/man/sisu_complete.7.html - -_1 http://www.jus.uio.no/sisu/man/sisu_pdf.7.html - -_1 http://www.jus.uio.no/sisu/man/sisu_postgresql.7.html - -_1 http://www.jus.uio.no/sisu/man/sisu_sqlite.7.html - -_1 http://www.jus.uio.no/sisu/man/sisu_webrick.1.html diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_homepages.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_homepages.ssi deleted file mode 100644 index 31b44c1c..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_homepages.ssi +++ /dev/null @@ -1,87 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Homepages - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm sisu.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2007-08-28 - :issued: 2007-08-28 - :available: 2007-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? Setting up of homepages - -1~home Homepages - -SiSU is about the ability to auto-generate documents. Home pages are regarded as custom built items, and are not created by SiSU. More accurately, SiSU has a default home page, which will not be appropriate for use with other sites, and the means to provide your own home page instead in one of two ways as part of a site's configuration, these being: - -# through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) - -# through providing what you want as the home page in a skin, - -Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content. - -2~ Home page and other custom built pages in a sub-directory - -Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched for the configuration directory, namely ./_sisu ; ~/_sisu ; /etc/sisu -From there they are copied to the root of the output directory with the command: - -_1 sisu -CC - -2~ Home page within a skin - -Skins are described in a separate section, but basically are a file written in the programming language Ruby that may be provided to change the defaults that are provided with sisu with respect to individual documents, a directories contents or for a site. - -If you wish to provide a homepage within a skin the skin should be in the directory _sisu/skin/dir and have the name of the directory for which it is to become the home page. Documents in the directory commercial_law would have the homepage modified in skin_commercial law.rb ; or the directory poems in skin_poems.rb - -code{ - - class Home - def homepage - # place the html content of your homepage here, this will become index.html - < - - -

this is my new homepage.

- - -HOME - end - end - -}code - -% .SH "SKINS \- document, directory and site skins" - - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_how.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_how.ssi deleted file mode 100644 index 7928abb5..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_how.ssi +++ /dev/null @@ -1,47 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: How Does SiSU Work? - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? Description - -1~sisu_how How does sisu work? - -SiSU markup is fairly minimalistic, it consists of: a (largely optional) document header, made up of information about the document (such as when it was published, who authored it, and granting what rights) and any processing instructions; and markup within the substantive text of the document, which is related to document structure and typeface. SiSU must be able to discern the structure of a document, (text headings and their levels in relation to each other), either from information provided in the document header or from markup within the text (or from a combination of both). Processing is done against an abstraction of the document comprising of information on the document's structure and its objects,[2] which the program serializes (providing the object numbers) and which are assigned hash sum values based on their content. This abstraction of information about document structure, objects, (and hash sums), provides considerable flexibility in representing documents different ways and for different purposes (e.g. search, document layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones). diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_howto.sst deleted file mode 100644 index d53bafa2..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_howto.sst +++ /dev/null @@ -1,1406 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Technical, Howto - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:howto;electronic documents:SiSU:manual:howto;SiSU:document:howto;sisu:document:howto - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual SiSU.ssm document - -@date: - :published: 2007-09-16 - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU some technical information - -:C~ HowTo - -1~howto_help Getting Help - -An online manual of sorts should be available at: - -http://www.jus.uio.no/sisu_manual/ - -The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component. - -2~ SiSU "man" pages *~man - -If SiSU is installed on your system usual man commands should be available, try: - -man sisu - -The SiSU man pages can be viewed online at:~{ generated from source using rman
http://polyglotman.sourceforge.net/rman.html
With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:
http://www.jus.uio.no/sample }~ - -An online version of the sisu man page is available here: - -_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/ - -_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html - -_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html - -_* {~^ sisu_examples.1 }http://www.jus.uio.no/sisu/man/sisu_examples.1.html - -_* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html - -2~ SiSU built-in help - -_1 sisu --help - -_1 sisu --help [subject] - -_2 sisu --help env [for feedback on the way your system is setup with regard to sisu] - -_2 sisu -V [same as above command] - -_2 sisu --help commands - -_2 sisu --help markup - -2~ Command Line with Flags - Batch Processing - -Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. - -In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. - -1~howto_setup Setup, initialisation - -2~ initialise output directory - -Images, css files for a document directory are copied to their respective locations in the output directory. - -while within your document markup/preparation directory, issue the following command - -_1 sisu -CC - -3~ Use of search functionality, an example using sqlite - -SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases. - -This note provides an example to get you started and will use sqlite - -It is necessary to: - -(1) make sure the required dependencies have been installed - -(2) have a directory with sisu markup samples that is writable - -(3) use sisu to create a database - -(4) use sisu tp populate a database - -(5) use sisu to start the webrick (httpd) server - -(6) use sisu to create a search form - -(7) copy the search form to the cgi directory - -(8) open up the form in your browser - -(9) query the database using the search form - -!_ (1) make sure the required dependencies have been installed - -if you use Debian, the following command will install the required dependencies - -aptitude install sisu-sqlite - -!_ (2) have a directory with sisu markup samples that is writable - -ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) - -cp -rv /usr/share/doc/sisu-markup-samples/v2/samples /. - -!_ (3) use sisu to create an sqlite database - -within the sisu-examples directory - -sisu -dv createall - -!_ (4) use sisu tp populate a database with some text - -within the sisu-examples directory - -sisu -div free_*.sst - -or - -sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst gpl2.fsf.sst - -!_ (5) use sisu to start the webrick (httpd) server (if it has not already been started): - -sisu -W - -!_ (6) use sisu to create a search form (for use with the webrick server, and your sample documents) - -within the sisu-examples directory - -sisu -F webrick - -#here i run into a problem, you are working from a read only -#directory..., not my usual mode of operation, to complete the example -#the following is necessary -sudo touch sisu_sqlite.cgi sisu_pgsql.cgi -sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi - -#now this should be possible: -sisu -F webrick - -!_ (7) copy the search form to the cgi directory - -the string should be provided as output from the previous command - -sudo cp -vi /usr/share/doc/sisu-markup-samples/v2/samples/sisu_sqlite.cgi /usr/lib/cgi-bin - -sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi - -!_ (8) open up the form in your browser and query it - -url: - -http://localhost:8081/cgi-bin/sisu_sqlite.cgi - -or as instructed by command sisu -F webrick - -!_ (9) query the database using the search form - -if there are other options in the dropdown menu select - -document_samples_sisu_markup - -and search for some text, e.g.: - -aim OR project - -_* selecting the *index* radio button gives an index of results using the object numbers - -_* selecting the *text* radio button gives the content of the matched paragraphs with the match highlighted - -!_ (10) to start again with a new database - -to start from scratch you can drop the database with the command - -sisu -dv dropall - -and go to step 3 - -to get to step 3 in one step with a single command - -sisu -dv recreate - -continue subsequent steps - -2~ misc - -3~ url for output files -u -U - -_1 sisu -uv[and other flags] [filename/wildcard] - -_1 sisu -Uv [filename/wildcard] - -3~ toggle screen color - -_1 sisu -cv[and processing flags] [filename/wildcard] - -3~ verbose mode - -_1 sisu -v[and processing flags] [filename/wildcard] - -_1 sisu -V[and processing flags] [filename/wildcard] - -3~ quiet mode - -_1 sisu -q[and processing flags] [filename/wildcard] - -3~ maintenance mode -intermediate files kept -M - -_1 sisu -Mv[and other flags] [filename/wildcard] - -3~ start the webrick server - -_1 sisu -W - -2~ remote placement of output - -configuration is necessary - -scp - -_1 sisu -vr[and processing flags] [filename/wildcard] - -rsync - -_1 sisu -vR[and processing flags] [filename/wildcard] - -1~howto_config Configuration Files - -Sample provided, on untarring the source tarball: - -_1 conf/sisu/sisurc.yaml - -and on installation under: - -_1 /etc/sisu/sisurc.yaml - -The following paths are searched: - -_1 ./_sisu/sisurc.yaml - -_1 ~/.sisu/sisurc.yaml - -_1 ./etc/sisu/sisurc.yaml - -1~howto_markup Markup - -See sample markup provided on - -http://www.jus.uio.no/sisu - -http://www.jus.uio.no/sisu_markup - -http://www.jus.uio.no/sisu/SiSU - -in particular for each of the document output samples provided, the source document is provided as well - -http://www.jus.uio.no/sisu/SiSU/2#books - -on untarring the source tarball: - -_1 data/sisu-examples/sample/document_samples_sisu_markup/ - -or the same once source is installed (or sisu-examples) under: - -_1 /usr/share/doc/sisu-markup-samples/v2/samples - -Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* - -SiSU is for literary and legal text, also for some social science material. In particular it does not do formula, and is not particularly suited to technical documentation. Despite the latter caveat, some notes will be provided here and added to over time: - -2~ Headers - -Headers @headername: provide information related to the document, this may relate to - -# how it is to be processed, such as whether headings are to be numbered, what skin is to be used and markup instructions, such as the document structure, or words to be made bold within the document - -# semantic information about the document including the dublin core - -2~ Font Face - -Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ... - -3~ Bold - -\@bold: [list of words that should be made bold within document] - -!_ bold line - -\!_ bold line - -*{ bold word or sentence }* - -!\{ bold word or sentence \}! - -*\{ bold word or sentence \}* - -*boldword* or !boldword! - -\*boldword\* or \!boldword\! - -3~ Italics - -\@italics: [list of words that should be italicised within document] - -/{ italicise word or sentence }/ - -/\{ italicise word or sentence \}/ - -/italicisedword/ - -\/italicisedword\/ - -3~ Underscore - -_{ underscore word or sentence }_ - -_\{ underscore word or sentence \}_ - -_underscoreword_ - -3~ Strikethrough - --{ strikethrough word or sentence }- - --\{ strikethrough word or sentence \}- - --strikeword- - -\-strikeword\- - -2~ Endnotes - -There are two forms of markup for endnotes, they cannot be mixed within the same document - -here~{ this is an endnote }~ - -# preferred endnote markup - -here~\{ this is an endnote \}~ - -# alternative markup equivalent, kept because it is possible to search and replace to get markup in existing texts such as Project Gutenberg - -here\~^ - -^\~ this is an endote - -2~ Links - -{ SiSU }http://sisudoc.org - -code{ - -{ SiSU }http://sisudoc.org - -}code - -{sisu.png }http://sisudoc.org - -code{ - -{sisu.png }http://sisudoc.org - -}code - -{tux.png 64x80 }image - -code{ - -{ tux.png 64x80 }image - -}code - -{~^ SiSU }http://sisudoc.org - -code{ - -{~^ SiSU }http://sisudoc.org - -}code - -is equivalent to: - -code{ - -{ SiSU }http://sisudoc.org ~{ http://sisudoc.org }~ - -}code - -the same can be done with an image: - -{~^ sisu.png "SiSU" }http://sisudoc.org - -code{ - -{~^ sisu.png "SiSU" }http://sisudoc.org - -}code - -2~ Number Titles - -Set with the header @markup: - -2~ Line operations - -Line Operations (marker placed at start of line) - -\!_ bold line - -!_ bold line - -\_1 indent paragraph one level - -_1 indent paragraph one level - -\_2 indent paragraph two steps - -_2 indent paragraph two steps - -\_* bullet paragraph - -_* bullet paragraph - -\# number paragraph (see headers for numbering document headings) - -# number paragraph (see headers for numbering document headings) - -\_# number paragraph level 2 (see headers for numbering document headings) - -_# number paragraph level 2 (see headers for numbering document headings) - -2~ Tables - -Table markup sample - -code{ - -table{~h c3; 26; 32; 32; - -This is a table, column1 -this would become row one of column two -column three of row one is here - -column one row 2 -column two of row two -column three of row two, and so on - -column one row three -and so on -here - -}table - -}code - -Alternative form of table markup - -code{ - -{t~h} - |Mon|Tue|Wed|Thu|Fri|Sat|Sun -0 | * | * | * | * | * | * | * -1 | * | * | * | * | | | -2 | - | * | * | * | * | * | -3 | - | * | * | * | * | * | * -4 | - | | | * | * | * | -5 | * | * | * | * | * | * | * - -}code - -2~ Grouped Text - -code{ - - 5.times { puts 'Ruby' } - -}code - -code\{ - -code{ - - 5.times { puts 'Ruby' } - -}code - -\}code - -poem{ - -A Limerick - -There was a young lady from Clyde, -who ate a green apple and died, -but the apple fermented inside the lamented, -and made cider inside her inside. - -}poem - -code{ - -poem{ - -There was a young lady from Clyde, -who ate a green apple and died, -but the apple fermented inside the lamented, -and made cider inside her inside. - -}poem - -}code - -2~ Composite Document - -To import another document, the master document or importing document should be named filename.r3 (r for require) - -\<\< \{ filename.sst \} - -\<\< \{ filename.ssi \} - -1~howto_appearance Change Appearance - -2~ Skins - -"Skins" may be used to change various aspects related to the output documents appearance, including such things as the url for the home page on which the material will be published, information on the credit band, and for html documents colours and icons used in navigation bars. Skins are ruby files which permit changing of the default values set within the program for SiSU output. - -There are a few examples provided, on untarring the source tarball: - -_1 conf/sisu/skin/doc/ - -_1 data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc - -and on installation under: - -_1 /etc/sisu/skin/doc/ - -_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc - -The following paths are searched: - -_1 ./_sisu/skin - -_1 ~/.sisu/skin - -_1 /etc/sisu/skin - -Skins under the searched paths in a per document directory, a per directory directory, or a site directory, named: - -doc [may be specified individually in each document] - -dir [used if identifier part of name matches markup directory name] - -site - -It is usual to place all skins in the document directory, with symbolic links as required from dir or site directories. - -2~ CSS - -The appearance of html and XML related output can be changed for an ouput collection directory by prepareing and placing a new css file in one of the sisu css directories searched in the sisu configuration path. These are located at: - -_./_sisu/css - -~/.sisu/css - -and - -/etc/sisu/css - -The contents of the first directory found in the search path are copied to the corresponding sisu output directory with the commnd: - -sisu -CC - -The SiSU standard css files for SiSU output are: - -dom.css html.css html_tables.css index.css sax.css xhtml.css - -A document may specify its own/bespoke css file using the css header. - -\@css: - -[expand] - -:C~ Extracts from the README - -1~howto_readme README - -SiSU 0.55 2007w27/6 2007-07-07 - -Homepage: http://www.jus.uio.no/sisu - -!_ Description - -SiSU is lightweight markup based document creation and publishing framework that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats. - -With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, EPUB, XML, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) in paragraph sized chunks so that document searches are done at this "atomic" level of granularity. - -Outputs share a common citation numbering system, and any semantic meta-data provided about the document. - -SiSU also provides concordance files, document content certificates and manifests of generated output. - -SiSU takes advantage of well established open standard ways of representing text, and provides a bridge to take advantage of the strengths of each, while remaining simple. SiSU implements across document formats a "useful common feature set" [coming from a humanities, law, and possibly social sciences perspective, rather than technical or scientific writing] ... focus is primarily on content and data integrity rather than appearance, (though outputs in the various formats are respectable). - -A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU. - -man pages, and interactive help are provided. - -Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. - -Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. - -Homepage: http://www.jus.uio.no/sisu - -SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works. - -SiSU can be used for Internet, Intranet, local filesystem or cd publishing. - -SiSU can be used directly off the filesystem, or from a database. - -SiSU's scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql. - -Amongst it's characteristics are: - -_* simple mnemonoic markup style, - -_* the ability to produce multiple output formats, including html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database whilst retaining document structure - Postgresql and Sqlite, - -_* that all share a common citation system (a simple idea from which much good), possibly most exciting, the following: if fed into a relational database (as it can be automatically), the document set is searchable, with results displayed at a paragraph level, or the possibility of an indexed display of documents in which the match is found together with a hyperlinked listing for each of each paragraph in which the match is found. In any event citations using this system (with or without the relational database) are relevant for all output formats. - -_* it is command line driven, and can be set up on a remote server - -_* Documents are marked up in SiSU syntax in your favourite editor. SiSU syntax may be regarded as a type of smart ascii - which in its basic form is simpler than the most elementary html. There is currently a syntax highlighter, and folding for Vim. Syntax highlighters for other editors are welcome. - -Input files should be UTF-8 - -Once set up it is simple to use. - -2~ Online Information, places to look - -http://www.jus.uio.no/sisu - -Download Sources: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#current - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian - -2~ Installation - -NB. Platform is Unix / Linux. - -3~ Debian - -If you use Debian use the Debian packages, check the information at: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian - -(A) SiSU is available directly off the Debian archives for Sid and testing. It -should necessary only to run as root: - -_1 aptitude update - -_1 aptitude install sisu-complete - -(B) If there are newer versions of SiSU upstream of the Debian archives, they -will be available by adding the following to your /etc/apt/sources.list - -_1 deb http://www.jus.uio.no/sisu/archive unstable main non-free - -_1 deb-src http://www.jus.uio.no/sisu/archive unstable main non-free - -[the non-free line is for document markup samples, for which the substantive text is provided under the author or original publisher's license and which in most cases will not be debian free software guideline compliant] - -Then as root run: - -_1 aptitude update - -_1 aptitude install sisu-complete - -3~ RPM - -RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. - -They may be downloaded from: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm - -3~ Source package .tgz - -Otherwise to install SiSU from source, check information at: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#current - -alternative modes of installation from source are provided, setup.rb (by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan Lang) built install file, - -Ruby is the essential dependency for the basic operation of SiSU - -1. Download the latest source (information available) from: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#current - -2. Unpack the source - -Note however, that additional external package dependencies, such as texlive or postgresql should you desire to use it are not taken care of for you. - -3~ to use setup.rb - -this is a three step process, in the root directory of the unpacked SiSU as root type: - -_1 ruby setup.rb config - -_1 ruby setup.rb setup - -as root: - -_1 ruby setup.rb install - -further information: - -_1 http://i.loveruby.net/en/projects/setup/ - -_1 http://i.loveruby.net/en/projects/setup/doc/usage.html - -3~ to use install (prapared with "Rake") - -Rake must be installed on your system: - -_1 http://rake.rubyforge.org/ - -_1 http://rubyforge.org/frs/?group_id=50 - -in the root directory of the unpacked SiSU as root type: - -_1 rake - -or - -_1 rake base - -This makes use of Rake (by Jim Weirich) and the provided Rakefile - -For a list of alternative actions you may type: - -_1 rake help - -_1 rake -T - -3~ to use install (prapared with "Rant") - -(you may use the instructions above for rake substituting rant if rant is -installed on your system, or you may use an independent installer created using -rant as follows:) - -in the root directory of the unpacked SiSU as root type: - -_1 ruby ./sisu-install - -or - -_1 ruby ./sisu-install base - -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. - -further information: - -_1 http://make.rubyforge.org/ - -_1 http://rubyforge.org/frs/?group_id=615 - -For a list of alternative actions you may type: - -_1 ruby ./sisu-install help - -_1 ruby ./sisu-install -T - -2~ Dependencies - -Once installed see 'man 8 sisu' for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) 'man sisu_markup-samples' may also be of interest if the sisu-markup-samples package has also been installed. - -The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU). - -The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. - -code{ - -Package: sisu -Architecture: all -Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip -Conflicts: vim-sisu, sisu-vim, sisu-remote -Replaces: vim-sisu, sisu-vim -Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, -tidy, librexml-ruby, openssl, rsync, openssh-client | lsh-client, keychain, -hyperestraier, kdissert, vim-addon-manager -Suggests: rcs | cvs, lv, texinfo, pinfo - -Package: sisu-complete -Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite -Recommends: hyperestraier - -Package: sisu-pdf -Architecture: all -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, -texlive-latex-recommended, texlive-latex-extra -Suggests: evince, xpdf - -Package: sisu-postgresql -Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby -Suggests: pgaccess, libdbd-pgsql, postgresql-contrib-8.1 - -Package: sisu-sqlite -Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby -Suggests: libdbd-sqlite - -Package: sisu-markup-samples -Depends: sisu - -}code - -code{ - -Source: sisu -Section: text -Priority: optional -Maintainer: Ralph Amissah -Build-Depends: debhelper (>= 5) -Standards-Version: 3.7.2 - -Package: sisu -Architecture: all -Depends: ruby (>= 1.8.2), ruby (<< 1.9), libwebrick-ruby, unzip, zip -Conflicts: vim-sisu, sisu-vim, sisu-remote -Replaces: vim-sisu, sisu-vim -Recommends: sisu-doc, sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager -Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang -Description: documents - structuring, publishing in multiple formats and search - SiSU is a lightweight markup based, command line oriented, document - structuring, publishing and search framework for document collections. - . - With minimal preparation of a plain-text, (UTF-8) file, using its native -markup syntax in your text editor of choice, SiSU can generate various document -formats (most of which share a common object numbering system for locating -content), including plain text, HTML, XHTML, EPUB, XML, OpenDocument text -(ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly -paragraph-sized chunks) so searches may be performed and matches returned with -that degree of granularity: your search criteria is met by these documents and -at these locations within each document. Object numbering is particularly -suitable for "published" works (finalized texts as opposed to works that are -frequently changed or updated) for which it provides a fixed means of reference -of content. Document outputs also share semantic meta-data provided. - . - SiSU also provides concordance files, document content certificates and - manifests of generated output. - . - A vim syntax highlighting file and an ftplugin with folds for sisu markup is - provided, as are syntax highlighting files for kate, kwrite, gedit and - diakonos. Vim 7 includes syntax highlighting for SiSU. - . - man pages, and interactive help are provided. - . - Dependencies for various features are taken care of in sisu related packages. - The package sisu-complete installs the whole of SiSU. - . - Additional document markup samples are provided in the package - sisu-markup-samples which is found in the non-free archive the licenses for - the substantive content of the marked up documents provided is that provided - by the author or original publisher. - . - Homepage: - -}code - -code{ - -Package: sisu-complete -Architecture: all -Depends: ruby (>= 1.8.2), ruby (<< 1.9), sisu, sisu-doc, sisu-pdf, sisu-postgresql, sisu-sqlite -Recommends: hyperestraier -Description: installs all SiSU related packages - This package installs SiSU and related packages that enable sisu to produce - pdf and to populate postgresql and sqlite databases. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - See sisu for a description of the package. - . - Homepage: - -}code - -code{ - -Package: sisu-doc -Architecture: all -Depends: sisu -Recommends: sisu-pdf, sisu-postgresql, sisu-sqlite -Description: sisu manual and other documentation for sisu - Multiple file formats generated output of sisu documentation generated from - sisu markup source documents included in the main package - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: - -}code - -code{ - -Package: sisu-pdf -Architecture: all -Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, texlive-latex-extra -Recommends: sisu-doc -Description: dependencies to convert SiSU LaTeX output to pdf - This package enables the conversion of SiSU LaTeX output to pdf. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: - -}code - -code{ - -Package: sisu-postgresql -Architecture: all -Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql -Recommends: sisu-doc, libfcgi-ruby -Suggests: postgresql-contrib -Description: SiSU dependencies for use with postgresql database - This package enables SiSU to populate a postgresql database. This is done at - an object/paragraph level, making granular searches of documents possible. - . - This relational database feature of SiSU is not required but provides - interesting possibilities, including that of granular searches of documents - for matching units of text, primarily paragraphs that can be displayed or - identified by object citation number, from which an index of documents - matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: - -}code - -code{ - -Package: sisu-sqlite -Architecture: all -Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby -Recommends: sisu-doc, libfcgi-ruby -Description: SiSU dependencies for use with sqlite database - This package enables SiSU to populate an sqlite database. This is done at an - object/paragraph level, making granular searches of documents possible. - . - This relational database feature of SiSU is not required but provides - interesting possibilities, including that of granular searches of documents - for matching units of text, primarily paragraphs that can be displayed or - identified by object citation number, from which an index of documents - matched and each matched paragraph within them can be displayed. - . - SiSU is a lightweight markup based document structuring, publishing and search - framework for document collections. - . - Homepage: - -}code - -2~ Quick start - -Most of the installation should be taken care of by the aptitude or rant -install. (The rant install if run in full will also test run the generation of -the first document). - -After installation of sisu-complete, move to the document samples directory - -_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples - -and run - -_1 sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst - -or the same: - -_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -look at output results, see the "sisu_manifest" page created for the document - -or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. - -sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst - -the database stuff is extra perhaps, the latex stuff could be considered extra perhaps but neither needs to be installed for most of sisu output to work - -examine source document, vim has syntax support - -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst - -additional markup samples in - -_1 http://www.jus.uio.no/sisu/SiSU/examples.html - -For help - -_1 man sisu - -or - -_1 sisu --help - -e.g. - -for the way sisu "sees/maps" your system - -_1 sisu --help env - -for list of commands and so on - -_1 sisu --help commands - -2~ Configuration files - -The default configuration/setup is contained within the program and is altered by configuration settings in /etc/[sisu version]/sisurc.yml or in ~/.sisu/sisurc.yml - -_* configuration file - a yaml file - -_1 /etc/sisu/[sisu version]/sisurc.yml - -_1 ~/.sisu/sisurc.yml - -_* directory structure - setting up of output and working directory. - -* skins - changing the appearance of a project, directory or individual -documents within ~/.sisu/skin - -_1 ~/.sisu/skin/doc contains individual skins, with symbolic links from - -_1 ~/.sisu/skin/dir if the contents of a directory are to take a particular document skin. - -_* additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on Debian), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are required for basic html or XML processing. - -_* if you use Vim as editor there is a syntax highlighter and fold resource config file for SiSU. I hope more syntax highlighters follow. - -There are post installation steps (which are really part of the overall installation) - -sisu -C in your marked up document directory, should do some auto-configuring provided you have the right permissions for the output directories. (and provided the output directories have already been specified if you are not using the defaults). - -2~ Use General Overview - -Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm - -Marked up SiSU documents are usually kept in a sub-directory of your choosing - -use the interactive help and man pages - -_1 sisu --help - -_1 man sisu - -2~ Help - -interactive help described below, or man page: - -_1 man sisu - -_1 man 8 sisu - -'man sisu_markup-samples' [if the sisu-markup-samples package is also installed] - -Once installed an interactive help is available typing 'sisu' (without) any flags, and select an option: - -_1 sisu - -alternatively, you could type e.g. - -_1 sisu --help commands - -_1 sisu --help env - -_1 sisu --help headers - -_1 sisu --help markup - -_1 sisu --help headings - -etc. - -for questions about mappings, output paths etc. - -_1 sisu --help env - -_1 sisu --help path - -_1 sisu --help directory - -2~ Directory Structure - -Once installed, type: - -_1 sisu --help env - -or - -_1 sisu -V - -2~ Configuration File - -The defaults can be changed via SiSU's configure file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that order, stopping on the first one found) - -2~ Markup - -See man pages. - -_1 man sisu - -_1 man 8 sisu - -Once installed there is some information on SiSU Markup in its help: - -_1 sisu --help markup - -and - -_1 sisu --help headers - -Sample marked up document are provided with the download tarball in the directory: - -_1 ./data/doc/sisu/sisu_markup_samples/dfsg - -These are installed on the system usually at: - -_1 /usr/share/doc/sisu/v2/sisu_markup_samples/samples - -More markup samples are available in the package sisu-markup-samples - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples - -Many more are available online off: - -_1 http://www.jus.uio.no/sisu/SiSU/examples.html - -2~ Additional Things - -There is syntax support for some editors provided (together with a README file) in - -_1 ./data/sisu/conf/syntax - -usually installed to: - -_1 /usr/share/sisu/v2/conf/syntax - -2~ License - -License: GPL 3 or later see the copyright file in - -_1 ./data/doc/sisu - -usually installed to: - -_1 /usr/share/doc/sisu - -2~ SiSU Standard - -SiSU uses: - -_* Standard SiSU markup syntax, - -_* Standard SiSU meta-markup syntax, and the - -_* Standard SiSU object citation numbering and system - -© Ralph Amissah 1997, current 2006 All Rights Reserved. - -_* however note the License section - -CHANGELOG - -_1 ./CHANGELOG - -and see - -_1 http://www.jus.uio.no/sisu/SiSU/changelog.html - -_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html - -:C~ Extracts from man 8 sisu - -1~howto_setup_post_installation Post Installation Setup - -2~ Post Installation Setup - Quick start - -After installation of sisu-complete, move to the document samples directory, - -_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples - -[this is not where you would normally work but provides sample documents for -testing, you may prefer instead to copy the contents of that directory to a local -directory before proceeding] - -and in that directory, initialise the output directory with the command - -_1 sisu -CC - -then run: - -_1 sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst - -or the same: - -_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -look at output results, see the "sisu_manifest" page created for the document - -for an overview of your current sisu setup, type: - -_1 sisu --help env - -or - -_1 sisu -V - -To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g. - -_1 sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst - -_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst - -examine source document, vim has syntax highlighting support - -gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst - -additional markup samples in - -_1 http://www.jus.uio.no/sisu/SiSU/examples.html - -it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely. - -_1 sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip - -there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended: - -_1 sisu -3 --trust http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip - -For help - -_1 man sisu - -_1 sisu --help - -_1 sisu --help env -for the way sisu "sees/maps" your system - -_1 sisu --help commands -for list of commands and so on - -2~ Document markup directory - -% B. Generate a (local) document from a markup/work directory. - -Perhaps the easiest way to begin is to create a directory for sisu marked up documents within your home directory, and copy the file structure (and document samples) provided in the document sample directory: - -_1 mkdir ~/sisu_test - -_1 cd ~/sisu_test - -_1 cp -a /usr/share/doc/sisu/v2/sisu_markup_samples/samples/* ~/sisu_test/. - -!_ Tip: -the markup syntax examples may be of interest - -_1 http://www.jus.uio.no/sisu/sample/ - -!_ Tip: - -_1 sisu -U [sisu markup filename] - -should printout the different possible outputs and where sisu would place them. - -!_ Tip: -if you want to toggle ansi color add - -_1 c - -to your flags. - -3~ Configuration files - -SiSU configuration file search path is: - -_1 ./_sisu/sisurc.yaml - -_1 ~/.sisu/sisurc.yaml - -_1 /etc/sisu/sisurc.yaml - -.\"%% Debian Installation Note - -3~ Debian INSTALLATION Note - -It is best you see - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian - -for up the most up to date information. - -notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU): - -Package: sisu - -SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. - -With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), EPUB, LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs also share semantic meta-data provided. - -SiSU also provides concordance files, document content certificates and manifests of generated output. - -A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided, as are syntax highlighting files for kate, kwrite, gedit and diakonos. Vim 7 includes syntax highlighting for SiSU. - -man pages, and interactive help are provided. - -Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. - -Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. - -Homepage: http://www.jus.uio.no/sisu - -3~ Document Resource Configuration - -!_ sisu -resource configuration information is obtained from sources (where they exist): - -_1 ~/.sisu/sisurc.yaml - -_1 /etc/sisu/[sisu version]/sisurc.yaml - -_1 sisu program defaults - -3~ Skins - -!_ Skins -default document appearance may be modified using skins contained in sub-directories located at the following paths: - -_1 ./_sisu/skin - -_1 ~/.sisu/skin - -_1 /etc/sisu/skin - -more specifically, the following locations (or their /etc/sisu equivalent) should be used: - -_1 ~/.sisu/skin/doc - -skins for individual documents; - -_1 ~/.sisu/skin/dir - -skins for directories of matching names; - -_1 ~/.sisu/skin/site - -site-wide skin modifying the site-wide appearance of documents. - -Usually all skin files are placed in the document skin directory: - -_1 ~/.sisu/skin/doc - -with softlinks being made to the skins contained there from other skin -directories as required. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_hyperestraier.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_hyperestraier.ssi deleted file mode 100644 index 4b528900..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_hyperestraier.ssi +++ /dev/null @@ -1,115 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Hyperestraier Search - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Search - Hyperestraier - -:C~? Search - -1~search_hyperestraier Hyperestraier - -See the documentation for hyperestraier: - -_1 http://hyperestraier.sourceforge.net/ - -_1 /usr/share/doc/hyperestraier/index.html - -_1 man estcmd - -on sisu_hyperestraier: - -_1 man sisu_hyperestraier - -_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html - -NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www - -(A) to generate the index within the webserver directory to be indexed: - -_1 estcmd gather -sd [index name] [directory path to index] - -the following are examples that will need to be tailored according to your needs: - -_1 cd /home/ralph/sisu_www - -_1 estcmd gather -sd casket /home/ralph/sisu_www - -you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: - -_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - - -Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index. - -As sisu duplicates output in multiple file formats, it it is probably preferable to limit the estraier index to html output, and as it may also be desirable to exclude files 'plain.txt', 'toc.html' and 'concordance.html', as these duplicate information held in other html output e.g. - -_1 find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket - - -from your current document preparation/markup directory, you would construct a rune along the following lines: - -_1 find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/([specify first directory for inclusion]|[specify second directory for inclusion]|[another directory for inclusion? ...])/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd /home/ralph/sisu_www/casket - - -(B) to set up the search form - -(i) copy estseek.cgi to your cgi directory and set file permissions to 755: - -_1 sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin - -_1 sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi - -_1 sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin - -_1 [see estraier documentation for paths] - -(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:': - -_1 indexname: /home/ralph/sisu_www/casket - -_1 replace: ^file:///home/ralph/sisu_www{{!}}http://localhost - -_1 replace: /index.html?${{!}}/ - -(C) to test using webrick, start webrick: - -_1 sisu -W - -and try open the url: http://localhost:8081/cgi-bin/estseek.cgi - - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_installation.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_installation.ssi deleted file mode 100644 index adf5b921..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_installation.ssi +++ /dev/null @@ -1,389 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Installation - -@creator: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm SiSU.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? SiSU Installation notes - -:C~ Installation - -1~installation Installation - -See the {~^ download pages }http://www.jus.uio.no/sisu/SiSU/download ~{
http://www.jus.uio.no/sisu/sisu_download }~ for information related to installation. - -2~ Debian - -SiSU is developed on Debian, and packages are available for Debian that take care of the dependencies encountered on installation. - -The package is divided into the following components: - -_1 *sisu*, the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies - -_1 *sisu-complete*, a dummy package that installs the whole of greater sisu as described below, apart from sisu-examples - -_1 *sisu-pdf*, dependencies used by sisu to produce pdf from LaTeX generated - -_1 *sisu-postgresql*, dependencies used by sisu to populate postgresql database (further configuration is necessary) - -_1 *sisu-remote*, dependencies used to place sisu output on a remote server (further configuration is necessary) - -_1 *sisu-sqlite*, dependencies used by sisu to populate sqlite database - -_1 *sisu-markup-samples*, sisu markup samples and other miscellany (under Debian Free Software Guidelines non-free) - -SiSU is available off { Debian Unstable and Testing }http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu&sourceid=mozilla-search ~{ http://packages.qa.debian.org/s/sisu.html }~ install it using apt-get, aptitude or alternative Debian install tools. SiSU is currently comprised of eight packages. *~apt-get - -Initial packaging is done here and to get the latest version of SiSU available you may add the following line(s) to your sources list: *~sources.list - -code{ - -#/etc/apt/sources.list - -deb http://www.jus.uio.no/sisu/archive unstable main non-free -deb-src http://www.jus.uio.no/sisu/archive unstable main non-free - -}code - -The non-free section is for sisu markup samples provided, which contain authored works the substantive text of which cannot be changed, and which as a result do not meet the debian free software guidelines. - -On Debian there is little more to know beyond how to install software on Debian using apt, aptitude or synaptic. - -code{ - -#Using aptitude: - - aptitude update - - aptitude install sisu-complete sisu-markup-samples - -}code - -code{ - -Using apt-get - - apt-get update - - apt get install sisu-complete sisu-examples - -}code - -2~ Other Unix / Linux - -A source tarball or an rpms built using alien are available, (however dependencies have not been tested). SiSU is first packaged and tested with dependency handling for Debian.~{ Notes on dependencies are provided in the section that follows }~ Information on dependencies configured for Debian is provided as this may be of assistance. - -3~ source tarball - -!_ installation with provided install script - -To install SiSU, in the root directory of the unpacked SiSU _{as root type}_:~{ This makes use of rant and the provided Rantfile. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. }~ - -_1 ruby install - -Once installed see man 8 sisu for information on additional programs that sisu makes use of. - -Further notes on install script. - -The install script is prepared using Rant, and a Rantfile *~rant is provided,~{ a Rantfile has been configured to do post installation setup }~ with more comprehensive install options, and post install and setup configuration and generation of first test file, if you have installed Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/
http://rubyforge.org/frs/?group_id=615 }~ installed. While in the package directory, type: rant help, or rant -T, or to install SiSU _{as root}_, type: - -*install* is an install script prepared using Stefan Lang's {~^ Rant }http://make.rubyforge.org/ ~{ http://make.rubyforge.org/
http://rubyforge.org/frs/?group_id=615 }~ It should work whether you have previously installed Rant or not. It has fairly comprehensive install options, and can do some post install and setup configuration and generation of first test file. For options type: - -_1 ruby install -T - -To install as root type: - -_1 ruby install - -For a minimal install type: - -_1 ruby install base - -!_ installation with setup.rb - -{~^ setup.rb }http://i.loveruby.net/en/projects/setup/ is provided the package and will install SiSU~{ Minero Aoki
http://i.loveruby.net/en/projects/setup/doc/ }~ installation is a 3 step process~{ Installation instructions
http://i.loveruby.net/en/projects/setup/doc/usage.html }~ the following string assumes you are in the package directory and that you have root as sudo: - -_1 ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install - -!_ installation of rpm - -The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. - -1~install_dependencies_and_notes SiSU Components, Dependencies and Notes - -The dependency lists are from the Debian control file for SiSU version 0.36, and may assist in building SiSU on other distributions. - -2~ sisu - -_* the base code, (the main package on which the others depend), without any dependencies other than ruby (and for convenience the ruby webrick web server), this generates a number of types of output on its own, other packages provide additional functionality, and have their dependencies - -*Depends:* on ruby (>=1.8.2), libwebrick-ruby - -*Recommends:* sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl - -initialise directory - -_1 sisu -CC - -html - -_1 sisu -hv [filename/wildcard] - -_1 sisu -Hv [filename/wildcard] - -LaTeX (but sisu-pdf dependencies required to convert that to pdf) - -_1 sisu -pv [filename/wildcard] - -plain text Unix with footnotes - -_1 sisu -av [filename/wildcard] - -plain text Dos with footnotes - -_1 sisu -Av [filename/wildcard] - -plain text Unix with endnotes - -_1 sisu -ev [filename/wildcard] - -plain text Dos with endnotes - -_1 sisu -Ev [filename/wildcard] - -openoffice odt - -_1 sisu -ov [filename/wildcard] - -xhtml - -_1 sisu -bv [filename/wildcard] - -XML SAX - -_1 sisu -xv [filename/wildcard] - -XML DOM - -_1 sisu -Xv [filename/wildcard] - -wordmap (a rudimentary index of content) - -_1 sisu -wv [filename/wildcard] - -document content certificate - -_1 sisu -Nv [filename/wildcard] - -placement of sourcefile in output directory - -_1 sisu -sv [filename/wildcard] - -creation of source tarball with images, and placement of source tarball in ouput directory - -_1 sisu -Sv [filename/wildcard] - -manifest of output produced (polls output directory and provides links to existing output) - -_1 sisu -yv [filename/wildcard] - -url for output files -u -U - -_1 sisu -uv[and other flags] [filename/wildcard] - -_1 sisu -Uv [filename/wildcard] - -toggle screen colour - -_1 sisu -cv[and processing flags] [filename/wildcard] - -verbose mode - -_1 sisu -v[and processing flags] [filename/wildcard] - -_1 sisu -V[and processing flags] [filename/wildcard] - -quiet mode - -_1 sisu -q[and processing flags] [filename/wildcard] - -maintenance mode, intermediate files kept -M - -_1 sisu -Mv[and other flags] [filename/wildcard] - -[the -v is for verbose] - -start the webrick server - -_1 sisu -W - -2~ sisu-complete - -_* a dummy package that installs the whole SiSU, apart from sisu-examples - -*Depends:* ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite - -*Recommends:* sisu-examples - -2~ sisu-examples - -_* installs sisu markup samples and other miscelleny - -*Depends:* sisu - -2~ sisu-pdf - -_* dependencies used by sisu to produce pdf from LaTeX generated - -*Depends:* sisu, tetex-bin, tetex-extra, latex-ucs - -*Suggests:* evince, xpdf - -converts sisu LaTeX produced to pdf - -_1 sisu -pv [filename/wildcard] - -[the -v is for verbose] - -2~ sisu-postgresql - -_* dependencies used by sisu to populate postgresql database (further configuration is necessary) - -*Depends:* sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby - -*Suggests:* pgaccess, libdbd-pgsql, postgresql-contrib-8.1 - -installs dependencies for sisu to work with and populate postgresql database - -create database - -_1 sisu -Dv createall - -drop database - -_1 sisu -Dv dropall - -import content - -_1 sisu -Div [filename/wildcard] - -_1 sisu -Dv import [filename/wildcard] - -update content - -_1 sisu -Duv [filename/wildcard] - -_1 sisu -Dv update [filename/wildcard] - -[the -v is for verbose] - -The following are available without installation of the sisu-postgresql component, but are of interest in this context - -generate a sample database query form for use with webserver on port 80 - -_1 sisu -F - -or for use with webrick server - -_1 sisu -F webrick - -to start webrick server - -_1 sisu -W - -2~ sisu-remote - -_* dependencies used to place sisu output on a remote server (further configuration is necessary) - -scp - -_1 sisu -vr[and processing flags] [filename/wildcard] - -rsync - -_1 sisu -vR[and processing flags] [filename/wildcard] - -[the -v is for verbose] - -*Depends:* sisu, rsync, openssh-client|lsh-client, keychain - -2~ sisu-sqlite - -_* dependencies used by sisu to populate sqlite database - -*Depends:* sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby - -*Suggests:* libdbd-sqlite - -installs dependencies for sisu to work with and populate sqlite database - -create database - -_1 sisu -dv createall - -drop database - -_1 sisu -dv dropall - -update content - -_1 sisu -div [filename/wildcard] - -_1 sisu -dv import [filename/wildcard] - -update content - -_1 sisu -duv [filename/wildcard] - -_1 sisu -dv update [filename/wildcard] - -[the -v is for verbose] - -The following are available without installation of the sisu-sqlite component, but are of interest in this context - -generate a sample database query form for use with webserver on port 80 - -_1 sisu -F - -or for use with webrick server - -_1 sisu -F webrick - -to start webrick server - -_1 sisu -W - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi deleted file mode 100644 index f3a94e0e..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi +++ /dev/null @@ -1,53 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Who Might Be Interested? - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? Who might SiSU interest? - -1~sisu_interest Who might be interested in the SiSU feature set? - -SiSU is most likely to be of interest to people who are working with medium to large volumes of published texts that would like to have the presented in a uniform way that is searchable (either using sisu database integration or an appropriate indexing tool), with the possibility of multiple alternative output formats that may be added to and upgraded/updated over time. SiSU should be of interest to institutions/ organisations/ governments/ individuals with document collections and some technical knowhow that are interested in: - -_* long term maintenance and reducing downstream/future costs of maintaining those document sets for which SiSU is suited. - -_* the ability to output multiple standard format outputs for various purposes. - -_* the implications for search offered diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_introduction.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_introduction.sst deleted file mode 100644 index e2df51d0..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_introduction.sst +++ /dev/null @@ -1,72 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Introduction - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? What is SiSU? - -:C~? Description - -1~sisu_intro Introduction - What is SiSU? - -SiSU is a framework for document structuring, publishing (in multiple open standard formats) and search, comprising of: (a) a lightweight document structure and presentation markup syntax; and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs (including the population of sql databases) that (can) share a common numbering system for the citation of text within a document. - -SiSU is developed under an open source, software libre license (GPL3). Its use case for development is work with medium to large document sets and cope with evolving document formats/ representation technologies. Documents are prepared once, and generated as need be to update the technical presentation or add additional output formats. Various output formats (including search related output) share a common mechanism for cross-output-format citation. - -SiSU both defines a markup syntax and provides an engine that produces open standards format outputs from documents prepared with SiSU markup. From a single lightly prepared document sisu custom builds several standard output formats which share a common (text object) numbering system for citation of content within a document (that also has implications for search). The sisu engine works with an abstraction of the document's structure and content from which it is possible to generate different forms of representation of the document. Significantly SiSU markup is more sparse than html and outputs which include html, EPUB, LaTeX, landscape and portrait pdfs, Open Document Format (ODF), all of which can be added to and updated. SiSU is also able to populate SQL type databases at an object level, which means that searches can be made with that degree of granularity. - -Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds (to take advantage of the strengths of different ways of representing documents) various standard open output formats including plain text, HTML, XHTML, XML, EPUB, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects~{ objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. }~ (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. - -In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds~{ i.e. the html, pdf, epub, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. }~ the different forms of output requested. - -SiSU works with an abstraction of the document based on its structure which is comprised of its headings~{ the different heading levels }~ and objects~{ units of text, primarily paragraphs and headings, also any tables, poems, code-blocks }~, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common basis for citing material within a document across the different output format types. This is significant as page numbers are not well suited to the digital age, in web publishing, changing a browser's default font or using a different browser can mean that text will appear on a different page; and publishing in different formats, html, landscape and portrait pdf etc. again page numbers are not useful to cite text. Dealing with documents at an object level together with object numbering also has implications for search that SiSU is able to take advantage of. - -One of the challenges of maintaining documents is to keep them in a format that allows use of them independently of proprietary platforms. Consider issues related to dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of producing documents in multiple non-proprietary open formats including html, pdf~{ Specification submitted by Adobe to ISO to become a full open ISO specification
http://www.linux-watch.com/news/NS7542722606.html }~ ODF,~{ ISO standard ISO/IEC 26300:2006 }~ and EPUB.~{ An open standard format for e-books }~ Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre, which means that that code base can be used, updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006 when it became an ISO standard for office applications and the archival of documents), EPUB was introduced in 2009; and allows the technical representations existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). - -The document formats are written to the file-system and available for indexing by independent indexing tools, whether off the web like Google and Yahoo or on the site like Lucene and Hyperestraier. - -SiSU also provides other features such as concordance files and document content certificates, and the working against an abstraction of document structure has further possibilities for the research and development of other document representations, the availability of objects is useful for example for topic maps and thesauri, together with the flexibility of SiSU offers great possibilities. - -SiSU is primarily for published works, which can take advantage of the citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared in SiSU. - -http://www.jus.uio.no/sisu - -% SiSU is a way of preparing, publishing, managing and searching documents. - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_manual.ssm b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_manual.ssm deleted file mode 100644 index 878dc5cb..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_manual.ssm +++ /dev/null @@ -1,118 +0,0 @@ -% SiSU master 2.0 - -@title: SiSU - :subtitle: Manual - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual - -@date: - :published: 2008-07-21 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~ @title @creator - -:B~ What is SiSU? - -<< sisu_introduction.sst - -<< sisu_how.ssi - -<< sisu_short_feature_summary.ssi - -<< sisu_help.sst - -% :B~? SiSU Commands - -<< sisu_commands.sst - -% :B~? SiSU Markup - -<< sisu_markup.sst - -<< sisu_filetypes.sst - -% :B~? SiSU Configuration and Skins - -<< sisu_config.ssi - -<< sisu_skin.sst - -<< sisu_css.ssi - -<< sisu_content_directories.ssi - -<< sisu_homepages.ssi - -% :B~? SiSU Output and Markup Examples - -<< sisu_examples.sst - -<< sisu_output_overview.sst - -<< sisu_search_intro.ssi - -<< sisu_sql.ssi - -<< sisu_postgresql.sst - -<< sisu_sqlite.sst - -<< sisu_search_cgi.ssi - -<< sisu_hyperestraier.ssi - -<< sisu_webrick.sst - -<< sisu_remote.sst - -% :B~? SiSU Download and Installation - -<< sisu_download.ssi - -<< sisu_installation.ssi - -<< sisu_quickstart.sst - -% :B~? SiSU Howto and FAQ - -<< sisu_howto.sst - -<< sisu_faq.sst - -<< sisu_interesting_to_whom.ssi - -<< sisu_work_needed_and_wishlist.ssi - -<< sisu_syntax_highlighting.sst - -<< sisu_help_sources.sst diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_markup.sst deleted file mode 100644 index 09f3cc63..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_markup.sst +++ /dev/null @@ -1,1417 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Markup - -@creator: - :author: Amissah, Ralph - -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation - :license: GPL 3 or later - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm sisu.ssm - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2008-05-22 - :modified: 2010-10-14 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }../SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Markup - -1~markup Introduction to SiSU Markup~{ 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. }~ - -2~ Summary - -SiSU source documents are plaintext (UTF-8)~{ files should be prepared using UTF-8 character encoding }~ files - -All paragraphs are separated by an empty line. - -Markup is comprised of: - -_* 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) - -_* 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: - -_1* heading levels defines document structure - -_1* text basic attributes, italics, bold etc. - -_1* grouped text (objects), which are to be treated differently, such as code blocks or poems. - -_1* footnotes/endnotes - -_1* linked text and images - -_1* paragraph actions, such as indent, bulleted, numbered-lists, etc. - -Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup - -To check the markup in a file: - -_1 sisu --identify [filename].sst - -For brief descriptive summary of markup history - -_1 sisu --query-history - -or if for a particular version: - -_1 sisu --query-0.38 - -2~ Markup Examples - -3~ Online - -Online markup examples are available together with the respective outputs produced from http://www.jus.uio.no/sisu/SiSU/examples.html or from http://www.jus.uio.no/sisu/sisu_examples/ - -There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: http://www.jus.uio.no/sisu/sisu_markup/ - -Some example marked up files are available as html with syntax highlighting for viewing: http://www.jus.uio.no/sisu/sample/syntax - -an alternative presentation of markup syntax: http://www.jus.uio.no/sisu/sample/on_markup.txt - -3~ Installed - -With SiSU 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 - -1~headers Markup of Headers - -Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions. - -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: - -code{ - -% this would be a comment - -}code - -2~ Sample Header - -This current document is loaded by a master document that has a header similar to this one: - -code{ - -% SiSU master 2.0 - -@title: SiSU - :subtitle: Manual - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, - electronic document, electronic citation, data structure, - citation systems, search - -% used_by: manual - -@date: - :published: 2008-05-22 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2010-03-03 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; - synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] - . sisu [-Ddcv] [instruction] - . sisu [-CcFLSVvW] - . sisu --v2 [operations] - . sisu --v1 [operations] - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -}code - -2~ Available Headers - -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 the form @headername: or on the next line and indented by once space :subheadername: All Dublin Core meta tags are available - -!_ @indentifier: -information or instructions - -where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified - -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. - -This is a sample header - -% (Dublin Core in fuschia, other information headers in cyan, markup instructions in red): - -code{ - -% SiSU 2.0 [declared file-type identifier with markup version] - -}code - - -code{ - -@title: [title text] [this header is the only one that is mandatory] - :subtitle: [subtitle if any] - :language: English - -}code - -code{ - -@creator: - :author: [Lastname, First names] - :illustrator: [Lastname, First names] - :translator: [Lastname, First names] - :prepared_by: [Lastname, First names] - -}code - -code{ - -@date: - :published: [year or yyyy-mm-dd] - :created: [year or yyyy-mm-dd] - :issued: [year or yyyy-mm-dd] - :available: [year or yyyy-mm-dd] - :modified: [year or yyyy-mm-dd] - :valid: [year or yyyy-mm-dd] - :added_to_site: [year or yyyy-mm-dd] - :translated: [year or yyyy-mm-dd] - -}code - -code{ - -@rights: - :copyright: Copyright (C) [Year and Holder] - :license: [Use License granted] - :text: [Year and Holder] - :translation: [Name, Year] - :illustrations: [Name, Year] - -}code - -code{ - -@classify: - :topic_register: SiSU:markup sample:book;book:novel:fantasy - :type: - :subject: - :description: - :keywords: - :abstract: - :isbn: [ISBN] - :loc: [Library of Congress classification] - :dewey: [Dewey classification - :pg: [Project Gutenberg text number] - -}code - -code{ - -@links: { SiSU }http://www.jus.uio.no/sisu/ - { FSF }http://www.fsf.org - -}code - -code{ - -@make: - :skin: skin_name [skins change default settings related to the appearance of documents generated] - :num_top: 1 - :headings: [text to match for each level - (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;) - :breaks: new=:C; break=1 - :promo: sisu, ruby, sisu_search_libre, open_society - :bold: [regular expression of words/phrases to be made bold] - :italics: [regular expression of words/phrases to italicise] - -}code - -code{ - -@original: - :language: [language] - -}code - -code{ - -@notes: - :comment: - :prefix: [prefix is placed just after table of contents] - -}code - -% header ends here, NB only @title: is mandatory [this would be a comment] -% NOTE: headings/levels below refer to 0.38 expermental markup (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 and 0.38 markup simple) - -1~ Markup of Substantive Text - -2~heading_levels Heading Levels - -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) - -!_ :A~ [heading text] -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 - -!_ :B~ [heading text] -Second level heading [this is a heading level divider] - -!_ :C~ [heading text] -Third level heading [this is a heading level divider] - -!_ 1~ [heading text] -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 - -!_ 2~ [heading text] -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. - -!_ 3~ [heading text] -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 - -code{ - -1~filename level 1 heading, - -% 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) - -}code - -2~ Font Attributes - -!_ markup example: - -code{ - -normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", -^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# - -normal text - -*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] - -!{bold text}! - -/{italics}/ - -_{underscore}_ - -"{citation}" - -^{superscript}^ - -,{subscript}, - -+{inserted text}+ - --{strikethrough}- - -#{monospace}# - -}code - -!_ resulting output: - -normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", -^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}# - -normal text - -*{emphasis}* [note: can be configured to be represented by bold, italics or underscore] - -!{bold text}! - -/{italics}/ - -_{underscore}_ - -"{citation}" - -^{superscript}^ - -,{subscript}, - -+{inserted text}+ - --{strikethrough}- - -#{monospace}# - -2~ Indentation and bullets - -!_ markup example: - -code{ - -ordinary paragraph - -_1 indent paragraph one step - -_2 indent paragraph two steps - -_9 indent paragraph nine steps - -}code - -!_ resulting output: - -ordinary paragraph - -_1 indent paragraph one step - -_2 indent paragraph two steps - -_9 indent paragraph nine steps - -!_ markup example: - -code{ - -_* bullet text - -_1* bullet text, first indent - -_2* bullet text, two step indent - -}code - -!_ resulting output: - -_* bullet text - -_1* bullet text, first indent - -_2* bullet text, two step indent - -Numbered List (not to be confused with headings/titles, (document structure)) - -!_ markup example: - -code{ - -# numbered list numbered list 1., 2., 3, etc. - -_# numbered list numbered list indented a., b., c., d., etc. - -}code - -2~ Footnotes / Endnotes - -Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced - -!_ markup example: - -code{ - -~{ a footnote or endnote }~ - -}code - -!_ resulting output: - -~{ a footnote or endnote }~ - -!_ markup example: - -code{ - -normal text~{ self contained endnote marker & endnote in one }~ continues - -}code - -!_ resulting output: - -normal text~{ self contained endnote marker & endnote in one }~ continues - -!_ markup example: - -code{ - -normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues - -normal text ~{** another unnumbered asterisk footnote/endnote }~ continues - -}code - -!_ resulting output: - -normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues - -normal text ~{** another unnumbered asterisk footnote/endnote }~ continues - -!_ markup example: - -code{ - -normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues - -normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues - -}code - -!_ resulting output: - -normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues - -normal text ~[+ editors notes, numbered asterisk footnote/endnote series ]~ continues - -!_ Alternative endnote pair notation for footnotes/endnotes: - -code{ - -% note the endnote marker "~^" - -normal text~^ continues - -^~ endnote text following the paragraph in which the marker occurs - -}code - -the standard and pair notation cannot be mixed in the same document - -2~ Links - -3~ Naked URLs within text, dealing with urls - -urls found within text are 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). - -!_ markup example: - -code{ - -normal text http://www.jus.uio.no/sisu continues - -}code - -!_ resulting output: - -normal text http://www.jus.uio.no/sisu continues - -An escaped url without decoration - -!_ markup example: - -code{ - -normal text _http://www.jus.uio.no/sisu continues - -deb http://www.jus.uio.no/sisu/archive unstable main non-free - -}code - -!_ resulting output: - -normal text _http://www.jus.uio.no/sisu continues - -deb _http://www.jus.uio.no/sisu/archive unstable main non-free - -where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document - -!_ resulting output: - -code{ - -deb http://www.jus.uio.no/sisu/archive unstable main non-free -deb-src http://www.jus.uio.no/sisu/archive unstable main non-free - -}code - -3~link_text Linking Text - -To link text or an image to a url the markup is as follows - -!_ markup example: - -code{ - -about { SiSU }http://url.org markup - -}code - -!_ resulting output: - -about { SiSU }http://www.jus.uio.no/sisu/ markup - -A shortcut notation is available so the url link may also be provided automatically as a footnote - -!_ markup example: - -code{ - -about {~^ SiSU }http://url.org markup - -}code - -!_ resulting output: - -about {~^ SiSU }http://www.jus.uio.no/sisu/ markup - -Internal document links to a tagged location, including an ocn - -!_ markup example: - -code{ - -about { text links }#link_text - -}code - -!_ resulting output: - -about { text links }#link_text - -Shared document collection link - -!_ markup example: - -code{ - -about { SiSU book markup examples }:SiSU/examples.html - -}code - -!_ resulting output: - -about { SiSU book markup examples }:SiSU/examples.html - -3~ Linking Images - -!_ markup example: - -code{ - -{ tux.png 64x80 }image - -% various url linked images - -{tux.png 64x80 "a better way" }http://www.jus.uio.no/sisu/ - -{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ - -{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ - -}code - -!_ resulting output: - -{ tux.png 64x80 }image - -{tux.png 64x80 "Gnu/Linux - a better way" }http://www.jus.uio.no/sisu/ - -{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.jus.uio.no/sisu/ - -{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ - -!_ linked url footnote shortcut - -code{ - -{~^ [text to link] }http://url.org - -% maps to: { [text to link] }http://url.org ~{ http://url.org }~ - -% which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink - -}code - -code{ - -text marker *~name - -}code - -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. - -2~ Grouped Text - -3~ Tables - -Tables may be prepared in two either of two forms - -!_ markup example: - -code{ - -table{ c3; 40; 30; 30; - -This is a table -this would become column two of row one -column three of row one is here - -And here begins another row -column two of row two -column three of row two, and so on - -}table - -}code - -!_ resulting output: - -table{ c3; 40; 30; 30; - -This is a table -this would become column two of row one -column three of row one is here - -And here begins another row -column two of row two -column three of row two, and so on - -}table - -a second form may be easier to work with in cases where there is not much information in each column - -*{markup example:}*~{ Table from the Wealth of Networks by Yochai Benkler
http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler }~ - -code{ - -!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 - -{table~h 24; 12; 12; 12; 12; 12; 12;} - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 -Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 -Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 -Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 -No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 -No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 - -\* Contributed at least ten times; \** at least 5 times in last month; \*\** more than 100 times in last month. - -}code - -!_ resulting output: - - -!_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 - -{table~h 24; 12; 12; 12; 12; 12; 12;} - |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006 -Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721 -Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945 -Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 -No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 -No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 - -\* Contributed at least ten times; \** at least 5 times in last month; \*\** more than 100 times in last month. - -% code{ - -% test - -% ~# - -% % unnumbered paragraph (place marker at end of paragraph) - -% -# - -% % unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] - -% % add a comment to text, that will be removed prior to processing (place marker at beginning of line) - -% }code - -3~ Poem - -!_ basic markup: - -code{ - -poem{ - - Your poem here - -}poem - -Each verse in a poem is given an object number. - -}code - -!_ markup example: - -code{ - -poem{ - - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - -}poem - -}code - -!_ resulting output: - -poem{ - - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - -}poem - -3~ Group - -!_ basic markup: - -code{ - -group{ - - Your grouped text here - -}group - -A group is treated as an object and given a single object number. - -}code - -!_ markup example: - -code{ - -group{ - - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - -}group - -}code - -!_ resulting output: - -group{ - - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - -}group - -3~ Code - -Code tags #{ code{ ... }code }# (used as with other group tags described above) are used to escape regular sisu markup, and have been used extensively within this document to provide examples of SiSU markup. You cannot however use code tags to escape code tags. They are however used in the same way as group or poem tags. - -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] - -!_ use of code tags instead of poem compared, resulting output: - -code{ - - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - -}code - -From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag #{ code{# }# as demonstrated here: - -code{# - - `Fury said to a - mouse, That he - met in the - house, - "Let us - both go to - law: I will - prosecute - YOU. --Come, - I'll take no - denial; We - must have a - trial: For - really this - morning I've - nothing - to do." - Said the - mouse to the - cur, "Such - a trial, - dear Sir, - With - no jury - or judge, - would be - wasting - our - breath." - "I'll be - judge, I'll - be jury," - Said - cunning - old Fury: - "I'll - try the - whole - cause, - and - condemn - you - to - death."' - -}code - -2~ Book index - -To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. - -Currently two levels are provided, a main term and if needed a sub-term. Sub-terms are separated from the main term by a colon. - -code{ - - Paragraph containing main term and sub-term. - ={Main term:sub-term} - -}code - -The index syntax starts on a new line, but there should not be an empty line between paragraph and index markup. - -The structure of the resulting index would be: - -code{ - - Main term, 1 - sub-term, 1 - -}code - -Several terms may relate to a paragraph, they are separated by a semicolon. If the term refers to more than one paragraph, indicate the number of paragraphs. - -code{ - - Paragraph containing main term, second term and sub-term. - ={first term; second term: sub-term} - -}code - -The structure of the resulting index would be: - -code{ - - First term, 1, - Second term, 1, - sub-term, 1 - -}code - -If multiple sub-terms appear under one paragraph, they are separated under the main term heading from each other by a pipe symbol. - -code{ - - Paragraph containing main term, second term and sub-term. - ={Main term:sub-term+1|second sub-term - - A paragraph that continues discussion of the first sub-term - -}code - -The plus one in the example provided indicates the first sub-term spans one additional paragraph. The logical structure of the resulting index would be: - -code{ - - Main term, 1, - sub-term, 1-3, - second sub-term, 1, - -}code - -1~ Composite documents markup - -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 *{.ssm}* 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 *{.sst}* regular markup file, or *{.ssi}* (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix *{._sst}* - -basic markup for importing a document into a master document - -code{ - -<< filename1.sst - -<< filename2.ssi - -}code - -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. - -code{ - -<< filename.ssi - -<<{filename.ssi} - -% using textlink alternatives - -<< |filename.ssi|@|^| - -}code - -:C~ Markup Syntax History - -1~ Notes related to Files-types and Markup Syntax - -2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset) - -0.38 is substantially current for version 1.0 - -depreciated 0.16 supported, though file names were changed at 0.37 - -_* sisu --query=[sisu version [0.38] or 'history] - -provides a short history of changes to SiSU markup - -!_ SiSU 2.0 -(2010-03-06:09/6) -same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g. - -code{ - -@title: - :subtitle: - -@creator: - :author: - :translator: - :illustrator: - -@rights: - :text: - :illustrations: - -}code - -see document markup samples, and sisu --help headers - -the monospace tag takes the form of a hash '#' - -code{ - -#{ this enclosed text would be monospaced }# - -}code - -!_ 1.0 -(2009-12-19:50/6) -same as 0.69 - -!_ 0.69 -(2008-09-16:37/2) -(same as 1.0) and as previous (0.57) with the addition of book index tags - -code{ - -/^={.+?}$/ - -}code - -e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object" - -code{ - - ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5} - -}code - -code{ - -Free Software Foundation, 1-6 -GNU/Linux community distribution, 1 - Debian, 1-3 - Fedora, 1 - Gentoo, - -}code - -!_ 0.66 -(2008-02-24:07/7) -same as previous, adds semantic tags, [experimental and not-used] - -code{ - -/[:;]{.+?}[:;][a-z+]/ - -}code - -!_ 0.57 -(2007w34/4) -SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the contents of the headers @title: and @author:] - -code{ - -:A~ @title by @author - -}code - -!_ 0.52 -(2007w14/6) -declared document type identifier at start of text/document: - -_1 SiSU 0.52 - -or, backward compatible using the comment marker: - -_1 % SiSU 0.38 - -variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' - -!_ 0.51 -(2007w13/6) -skins changed (simplified), markup unchanged - -!_ 0.42 -(2006w27/4) -* (asterisk) type endnotes, used e.g. in relation to author - -SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types, - -Introduces some variations on endnotes, in particular the use of the asterisk - -code{ - -~{* for example for describing an author }~ and ~{** for describing a second author }~ - -}code - -* for example for describing an author - -** for describing a second author - -and - -code{ - -~[* my note ]~ or ~[+ another note ]~ - -}code - -which numerically increments an asterisk and plus respectively - -*1 my note -+1 another note - -!_ 0.38 -(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) - -SiSU 0.38 introduced alternative experimental header and heading/structure markers, - -code{ - -@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~ - -}code - -as the equivalent of: - -code{ - -0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~ - -}code - -The internal document markup of SiSU 0.16 remains valid and standard Though note that SiSU 0.37 introduced a new file naming convention - -SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 must exist, optional 2 and 3 may follow in sequence i.e. there are two independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes explicit an aspect of structuring documents in SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels - -!_ 0.37 -(2006w09/7) -introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged - -SiSU 0.37 introduced new file naming convention, using the file extensions .sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si - -this is captured by the following file 'rename' instruction: - -code{ - -rename 's/\.s[123]$/\.sst/' *.s{1,2,3} -rename 's/\.r[123]$/\.ssm/' *.r{1,2,3} -rename 's/\.si$/\.ssi/' *.si - -}code - -The internal document markup remains unchanged, from SiSU 0.16 - -!_ 0.35 -(2005w52/3) -sisupod, zipped content file introduced - -!_ 0.23 -(2005w36/2) -utf-8 for markup file - -!_ 0.22 -(2005w35/3) -image dimensions may be omitted if rmagick is available to be relied upon - -!_ 0.20.4 -(2005w33/4) -header 0~links - -!_ 0.16 -(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 - -SiSU 0.16 (0.15 development branch) introduced the use of - -the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~ - -in place of the 0.1 header, heading/structure notation - -SiSU 0.1 headers and headings structure represented by -header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{ diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_output_overview.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_output_overview.sst deleted file mode 100644 index 92d5274e..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_output_overview.sst +++ /dev/null @@ -1,160 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: SiSU overview of status of features available in various outputs - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:markup table;SiSU:manual:output overview;electronic documents:SiSU:manual:output overview;SiSU:document:output overview;SiSU:document:output overview - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual, document - -@date: - :published: 2007-09-16 - :created: 2005-10-31 - :available: 2006-10-31 - :issued: 2006-10-31 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual -% :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU overview of status of features available in various outputs - -1~ A Checklist of Output Features - -% 2~ features available in various output types - -This table gives an indication of the features that are available -for various forms of output of SiSU. - -!_ sisu-2.0.0 on 2010-03-06 - -{table~h 28} -feature |txt|ltx/pdf|HTML|EPUB|XML/s|XML/d|ODF|SQLite|pgSQL -headings | * | * | * | * | * | * | * | * | * -footnotes | * | * | * | * | * | * | * | * | * -bold, underscore, italics | . | * | * | * | * | * | * | * | * -strikethrough | . | * | * | * | * | * | * | | -superscript, subscript | . | * | * | * | * | * | * | | -extended ascii set (utf-8)| * | * | * | * | * | * | * | | * -indents | * | * | * | * | * | * | * | | -bullets | . | * | * | * | * | * | . | | -groups | | | | | | | | | -* tables | | * | * | * | . | . | . | . | . -* poem | * | * | * | * | . | . | * | . | . -* code | * | * | * | * | . | . | * | . | . -url | * | * | * | * | * | * | * | . | . -links | * | * | * | * | * | * | * | . | . -images | - | * | * | * | T | T | * | T | T -image caption | - | * | * | * | | | | | -table of contents | | * | * | * | * | * | . | | -page header/footer? | - | * | * | * | * | * | t | | -line break | * | * | * | * | * | * | * | | -page break | | * | | | | | * | | -segments | | | * | * | | | | | -skins | * | * | * | * | * | * | | | -ocn | . | * | * | * | * | * | -?| * | * -auto-heading numbers | * | * | * | * | * | * | * | * | * -minor list numbering | * | * | * | * | * | * | * | * | * -special characters | . | . | . | . | | | | | - -!_ sisu-1.0.0 on 2009-10-28 - -{table~h 28} -feature |txt|ltx/pdf|HTML|XML/s|XML/d|ODF|SQLite|pgSQL -headings | * | * | * | * | * | * | * | * -footnotes | * | * | * | * | * | * | * | * -bold, underscore, italics | . | * | * | * | * | * | * | * -strikethrough | . | * | * | * | * | * | | -superscript, subscript | . | * | * | * | * | * | | -extended ascii set (utf-8)| * | * | * | * | * | * | | * -indents | * | * | * | * | * | * | | -bullets | . | * | * | * | * | . | | -groups | | | | | | | | -* tables | | * | * | . | . | . | . | . -* poem | * | * | * | . | . | * | . | . -* code | * | * | * | . | . | * | . | . -url | * | * | * | * | * | * | . | . -links | * | * | * | * | * | * | . | . -images | - | * | * | T | T | * | T | T -image caption | - | * | * | | | | | -table of contents | | * | * | * | * | . | | -page header/footer? | - | * | * | * | * | t | | -line break | * | * | * | * | * | * | | -page break | | * | | | | * | | -segments | | | * | | | | | -skins | * | * | * | * | * | | | -ocn | . | * | * | * | * | -?| * | * -auto-heading numbers | * | * | * | * | * | * | * | * -minor list numbering | * | * | * | * | * | * | * | * -special characters | . | . | . | | | | | - -!_ sisu-0.36.6 on 2006-01-23 - -{table~h 28; 8; 8; 8; 8; 8; 8; 8; 8; 8;} -feature |txt|ltx/pdf|HTML|XHTML|XML/s|XML/d|ODF|SQLite|pgSQL -headings | * | * | * | * | * | * | * | * | * -footnotes | * | * | * | * | * | * | * | * | * -bold, underscore, italics | . | * | * | * | * | * | * | * | * -strikethrough | . | * | * | * | * | * | * | | -superscript, subscript | . | * | * | * | * | * | * | | -extended ascii set (utf-8)| * | * | * | * | * | * | * | | * -indents | * | * | * | * | * | * | * | | -bullets | . | * | * | * | * | * | . | | -groups | | | | | | | | | -* tables | | * | * | . | . | . | . | . | . -* poem | * | * | * | . | . | . | * | . | . -* code | * | * | * | . | . | . | * | . | . -url | * | * | * | * | * | * | * | . | . -links | * | * | * | * | * | * | * | . | . -images | - | * | * | T | T | T | * | T | T -image caption | - | * | * | | | | | | -table of contents | | * | * | * | * | * | . | | -page header/footer? | - | * | * | * | * | * | t | | -line break | * | * | * | * | * | * | * | | -page break | | * | | | | | * | | -segments | | | * | | | | | | -skins | * | * | * | * | * | * | | | -ocn | . | * | * | * | * | * | -?| * | * -auto-heading numbers | * | * | * | * | * | * | * | * | * -minor list numbering | * | * | * | * | * | * | * | * | * -special characters | . | . | . | | | | | | - -group{ - - Done - * yes/done - . partial - - - not available/appropriate - - Not Done - T task todo - t lesser task/todo - not done - -}group - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_postgresql.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_postgresql.sst deleted file mode 100644 index addf1bd1..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_postgresql.sst +++ /dev/null @@ -1,98 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Search - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :topic_register: electronic documents:SiSU:document:postgresql;SiSU:manual:postgresql;electronic documents:SiSU:manual:postgresql;SiSU:document:postgresql;SiSU:document:postgresql; - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -Dv [filename/wildcard ]\n sisu -Dv [instruction] - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -% :B~? SiSU Postgresql - -1~postgresql Postgresql - -2~ Name - -SiSU - Structured information, Serialized Units - a document publishing system, postgresql dependency package - -2~ Description - -Information related to using postgresql with sisu (and related to the sisu_postgresql dependency package, which is a dummy package to install dependencies needed for SiSU to populate a postgresql database, this being part of SiSU - man sisu). - -2~ Synopsis - -_1 sisu -D [instruction] [filename/wildcard if required] - -_1 sisu -D --pg --[instruction] [filename/wildcard if required] - - -2~ Commands - -Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql may be used - -!_ -D or --pgsql -may be used interchangeably. - -3~ create and destroy database - -!_ --pgsql --createall
-initial step, creates required relations (tables, indexes) in existing (postgresql) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) - -!_ sisu -D --createdb
-creates database where no database existed before - -!_ sisu -D --create
-creates database tables where no database tables existed before - -!_ sisu -D --Dropall
-destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). - -!_ sisu -D --recreate
-destroys existing database and builds a new empty database structure - -3~ import and remove documents - -!_ sisu -D --import -v [filename/wildcard]
-populates database with the contents of the file. Imports documents(s) specified to a postgresql database (at an object level). - -!_ sisu -D --update -v [filename/wildcard]
-updates file contents in database - -!_ sisu -D --remove -v [filename/wildcard]
-removes specified document from postgresql database. - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_quickstart.sst deleted file mode 100644 index 652b12f2..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_quickstart.sst +++ /dev/null @@ -1,272 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Quickstart, installation and use - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:quickstart;SiSU:manual:quickstart;electronic documents:SiSU:manual:quickstart;SiSU:document:quickstart;SiSU:document:quickstart - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm sisu_manual.ssm - -@date: - :created: 2006-09-06 - :available: 2006-09-06 - :issued: 2006-09-06 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? Quickstart - SiSU installation and use - -1~ Quickstart - Getting Started Howto - -2~ Installation - -Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. - -3~ Debian Installation - -SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: - -code{ - - aptitude update - aptitude install sisu-complete - -}code - -The following /etc/apt/sources.list setting permits the download of additional markup samples: - -code{ - -#/etc/apt/sources.list - - deb http://ftp.fi.debian.org/debian/ unstable main non-free contrib - deb-src http://ftp.fi.debian.org/debian/ unstable main non-free contrib - -}code - -The aptitude commands become: - -code{ - - aptitude update - aptitude install sisu-complete sisu-markup-samples - -}code - -If there are newer versions of SiSU upstream of the Debian archives, they will be available by adding the following to your /etc/apt/sources.list - -code{ - -#/etc/apt/sources.list - - deb http://www.jus.uio.no/sisu/archive unstable main non-free - deb-src http://www.jus.uio.no/sisu/archive unstable main non-free - -}code - -repeat the aptitude commands - -code{ - - aptitude update - aptitude install sisu-complete sisu-markup-samples - -}code - -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. - -3~ RPM Installation - -RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. - -They may be downloaded from: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm - -as root type: - -_1 rpm -i [rpm package name] - -3~ Installation from source - -To install SiSU from source check information at: - -_1 http://www.jus.uio.no/sisu/SiSU/download.html#current - -_* download the source package - -_* Unpack the source - -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: - -For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, EPUB, 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)~{ There is nothing to stop MySQL support being added in future. }~ or converting LaTeX to pdf. - -!_ setup.rb - -This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: - -code{ - - ruby setup.rb config - ruby setup.rb setup - #[and as root:] - ruby setup.rb install - -}code - -further information on setup.rb is available from: - -_1 http://i.loveruby.net/en/projects/setup/ - -_1 http://i.loveruby.net/en/projects/setup/doc/usage.html - -!_ "install" - -The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: - -_1 ruby install base - -or for a more complete installation: - -_1 ruby install - -or - -_1 ruby install base - -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. - -Further information on "rant" is available from: - -_1 http://make.rubyforge.org/ - -_1 http://rubyforge.org/frs/?group_id=615 - -For a list of alternative actions you may type: - -_1 ruby install help - -_1 ruby install -T - -2~ Testing SiSU, generating output - -To check which version of sisu is installed: - -sisu -v - -Depending on your mode of installation one or a number of markup sample files may be found either in the directory: - -... - -or - -... - -change directory to the appropriate one: - -cd /usr/share/doc/sisu/sisu_markup_samples/dfsg - -3~ basic text, plaintext, html, XML, ODF, EPUB - -Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it - -sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text - -3~ LaTeX / pdf - -Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) - -Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it - -sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst - -sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst - -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 - -3~ relational database - postgresql, sqlite - -Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. - -Assuming you have the database installed and the requisite permissions - -sisu --sqlite --recreate - -sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst - -sisu --pgsql --recreate - -sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst - -2~ Getting Help - -3~ The man pages - -Type: - -_1 man sisu - -The man pages are also available online, though not always kept as up to date as within the package itself: - -_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1 - -_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8 - -_* {~^ man directory }http://www.jus.uio.no/sisu/man - -3~ Built in help - -sisu --help - -sisu --help --env - -sisu --help --commands - -sisu --help --markup - -3~ The home page - -http://www.jus.uio.no/sisu - -http://www.jus.uio.no/sisu/SiSU - -2~ Markup Samples - -A number of markup samples (along with output) are available off: - -http://www.jus.uio.no/sisu/SiSU/examples.html - -Additional markup samples are packaged separately in the file: - -*** - -On Debian they are available in non-free~{ the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. }~ to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_remote.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_remote.sst deleted file mode 100644 index 3f85743f..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_remote.sst +++ /dev/null @@ -1,106 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Remote Operations - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:remote;SiSU:manual:remote;electronic documents:SiSU:manual:remote;SiSU:document:remote;SiSU:document:remote - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Remote Operations - -1~remote_source Remote Source Documents - -SiSU processing instructions can be run against remote source documents by providing the url of the documents against which the processing instructions are to be carried out. The remote SiSU documents can either be sisu marked up files in plaintext .sst or .ssm or; zipped sisu files, sisupod.zip or filename.ssp - -!_ .sst / .ssm - sisu text files - -SiSU can be run against source text files on a remote machine, provide the processing instruction and the url. The source file and any associated parts (such as images) will be downloaded and generated locally. - -code{ - -sisu -3 http://[provide url to valid .sst or .ssm file] - -}code - -Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url for the desired document. - -NOTE: to set up a remote machine to serve SiSU documents in this way, images should be in the directory relative to the document source ../_sisu/image - -!_ sisupod - zipped sisu files - -A sisupod is the zipped content of a sisu marked up text or texts and any other associated parts to the document such as images. - -SiSU can be run against a sisupod on a (local or) remote machine, provide the processing instruction and the url, the sisupod will be downloaded and the documents it contains generated locally. - -code{ - -sisu -3 http://[provide url to valid sisupod.zip or .ssp file] - -}code - -Any of the source documents in the sisu examples page can be used in this way, see http://www.jus.uio.no/sisu/SiSU/examples.html and use the url for the desired document. - -:C~ Remote Document Output - -1~remote_output Remote Output - -Once properly configured SiSU output can be automatically posted once generated to a designated remote machine using either rsync, or scp. - -In order to do this some ssh authentication agent and keychain or similar tool will need to be configured. Once that is done the placement on a remote host can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used in conjunction with other processing flags, e.g. - -code{ - -sisu -3R sisu_remote.sst - -}code - -2~ commands - -!_ -R [filename/wildcard]
-copies sisu output files to remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if -R is used with other flags from if used alone. Alone the rsync --delete parameter is sent, useful for cleaning the remote directory (when -R is used together with other flags, it is not). Also see -r - -!_ -r [filename/wildcard]
-copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see -R - -2~ configuration - -[expand on the setting up of an ssh-agent / keychain] - -1~remote_servers Remote Servers - -As SiSU is generally operated using the command line, and works within a Unix type environment, SiSU the program and all documents can just as easily be on a remote server, to which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search.ssm b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search.ssm deleted file mode 100644 index e72d2a4c..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search.ssm +++ /dev/null @@ -1,53 +0,0 @@ -% SiSU master 2.0 - -@title: SiSU - :subtitle: Search - -@creator: :author: Ralph Amissah - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Search - -<< sisu_search_intro.ssi - -<< sisu_sql.ssi - -<< sisu_postgresql.sst - -<< sisu_sqlite.sst - -<< sisu_search_cgi.ssi - -<< sisu_hyperestraier.ssi diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_cgi.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_cgi.ssi deleted file mode 100644 index 7e7e211f..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_cgi.ssi +++ /dev/null @@ -1,99 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Search - -@creator: :author: Ralph Amissah - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm sisu.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Search - -:C~? CGI Search Form - -1~search_cgi Introduction - -2~ Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) *~search - -{~^ Sample search frontend }http://search.sisudoc.org -A small database and sample query front-end (search from) that makes use of the citation system, _{object citation numbering}_ to demonstrates functionality.~{ (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. }~ - -SiSU can provide information on which documents are matched and at what locations within each document the matches are found. These results are relevant across all outputs using object citation numbering, which includes html, XML, EPUB, LaTeX, PDF and indeed the SQL database. You can then refer to one of the other outputs or in the SQL database expand the text within the matched objects (paragraphs) in the documents matched. - -Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ - -% Several options for output - select database to search, show results in index view (links to locations within text), show results with text, echo search in form, show what was searched, create and show a "canned url" for search, show available search fields. Also shows counters number of documents in which found and number of locations within documents where found. [could consider sorting by document with most occurrences of the search result]. - -!_ sisu -F --webserv-webrick
-builds a cgi web search frontend for the database created - -The following is feedback on the setup on a machine provided by the help command: - -_1 sisu --help sql - -code{ - -Postgresql - user: ralph - current db set: SiSU_sisu - port: 5432 - dbi connect: DBI:Pg:database=SiSU_sisu;port=5432 - -sqlite - current db set: /home/ralph/sisu_www/sisu/sisu_sqlite.db - dbi connect DBI:SQLite:/home/ralph/sisu_www/sisu/sisu_sqlite.db - -}code - -Note on databases built - -By default, [unless otherwise specified] databases are built on a directory basis, from collections of documents within that directory. The name of the directory you choose to work from is used as the database name, i.e. if you are working in a directory called /home/ralph/ebook the database SiSU_ebook is used. [otherwise a manual mapping for the collection is necessary] - -2~ Search Form - -!_ sisu -F
-generates a sample search form, which must be copied to the web-server cgi directory - -!_ sisu -F --webserv-webrick
-generates a sample search form for use with the webrick server, which must be copied to the web-server cgi directory - -!_ sisu -Fv
-as above, and provides some information on setting up hyperestraier - -!_ sisu -W
-starts the webrick server which should be available wherever sisu is properly installed - -The generated search form must be copied manually to the webserver directory as instructed diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_intro.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_intro.ssi deleted file mode 100644 index 24ae1cea..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_search_intro.ssi +++ /dev/null @@ -1,52 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Search - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Search - -1~search_intro SiSU Search - Introduction - -SiSU output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. - -Because the document structure of sites created is clearly defined, and the text object citation system is available hypothetically at least, for all forms of output, it is possible to search the sql database, and either read results from that database, or just as simply map the results to the html output, which has richer text markup. - -In addition to this SiSU has the ability to populate a relational sql type database with documents at an object level, with objects numbers that are shared across different output types, which make them searchable with that degree of granularity. Basically, your match criteria is met by these documents and at these locations within each document, which can be viewed within the database directly or in various output formats. - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_short_feature_summary.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_short_feature_summary.ssi deleted file mode 100644 index 0009352e..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_short_feature_summary.ssi +++ /dev/null @@ -1,103 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Summary of Features - -@creator: :author: Ralph Amissah - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@date: :published: 2007-09-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? What is SiSU? - -:C~? Description - -1~sisu_feature_summary Summary of features - -_* sparse/minimal markup (clean utf-8 source texts). Documents are prepared in a single UTF-8 file using a minimalistic mnemonic syntax. Typical literature, documents like "War and Peace" require almost no markup, and most of the headers are optional. - -_* markup is easily readable/parsable by the human eye, (basic markup is simpler and more sparse than the most basic HTML), [this may also be converted to XML representations of the same input/source document]. - -_* markup defines document structure (this may be done once in a header pattern-match description, or for heading levels individually); basic text attributes (bold, italics, underscore, strike-through etc.) as required; and semantic information related to the document (header information, extended beyond the Dublin core and easily further extended as required); the headers may also contain processing instructions. SiSU markup is primarily an abstraction of document structure and document metadata to permit taking advantage of the basic strengths of existing alternative practical standard ways of representing documents [be that browser viewing, paper publication, sql search etc.] (html, epub, xml, odf, latex, pdf, sql) - -_* for output produces reasonably elegant output of established industry and institutionally accepted open standard formats.[3] takes advantage of the different strengths of various standard formats for representing documents, amongst the output formats currently supported are: - -_1* html - both as a single scrollable text and a segmented document - -_1* xhtml - -_1* epub - -_1* XML - both in sax and dom style xml structures for further development as required - -_1* ODF - open document format, the iso standard for document storage - -_1* LaTeX - used to generate pdf - -_1* pdf (via LaTeX) - -_1* sql - population of an sql database, (at the same object level that is used to cite text within a document) - -Also produces: concordance files; document content certificates (md5 or sha256 digests of headings, paragraphs, images etc.) and html manifests (and sitemaps of content). (b) takes advantage of the strengths implicit in these very different output types, (e.g. PDFs produced using typesetting of LaTeX, databases populated with documents at an individual object/paragraph level, making possible granular search (and related possibilities)) - -_* ensuring content can be cited in a meaningful way regardless of selected output format. Online publishing (and publishing in multiple document formats) lacks a useful way of citing text internally within documents (important to academics generally and to lawyers) as page numbers are meaningless across browsers and formats. sisu seeks to provide a common way of pinpoint the text within a document, (which can be utilized for citation and by search engines). The outputs share a common numbering system that is meaningful (to man and machine) across all digital outputs whether paper, screen, or database oriented, (pdf, HTML, EPUB, xml, sqlite, postgresql), this numbering system can be used to reference content. - -_* Granular search within documents. SQL databases are populated at an object level (roughly headings, paragraphs, verse, tables) and become searchable with that degree of granularity, the output information provides the object/paragraph numbers which are relevant across all generated outputs; it is also possible to look at just the matching paragraphs of the documents in the database; [output indexing also work well with search indexing tools like hyperestraier]. - -_* long term maintainability of document collections in a world of changing formats, having a very sparsely marked-up source document base. there is a considerable degree of future-proofing, output representations are "upgradeable", and new document formats may be added. e.g. addition of odf (open document text) module in 2006, epub in 2009 and in future html5 output sometime in future, without modification of existing prepared texts - -_* SQL search aside, documents are generated as required and static once generated. - -_* documents produced are static files, and may be batch processed, this needs to be done only once but may be repeated for various reasons as desired (updated content, addition of new output formats, updated technology document presentations/representations) - -_* document source (plaintext utf-8) if shared on the net may be used as input and processed locally to produce the different document outputs - -_* document source may be bundled together (automatically) with associated documents (multiple language versions or master document with inclusions) and images and sent as a zip file called a sisupod, if shared on the net these too may be processed locally to produce the desired document outputs - -_* generated document outputs may automatically be posted to remote sites. - -_* for basic document generation, the only software dependency is Ruby, and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML, ODF, LaTeX). To use a database you of course need that, and to convert the LaTeX generated to pdf, a latex processor like tetex or texlive. - -_* as a developers tool it is flexible and extensible - -Syntax highlighting for SiSU markup is available for a number of text editors. - -SiSU is less about document layout than about finding a way with little markup to be able to construct an abstract representation of a document that makes it possible to produce multiple representations of it which may be rather different from each other and used for different purposes, whether layout and publishing, or search of content - -i.e. to be able to take advantage from this minimal preparation starting point of some of the strengths of rather different established ways of representing documents for different purposes, whether for search (relational database, or indexed flat files generated for that purpose whether of complete documents, or say of files made up of objects), online viewing (e.g. html, xml, pdf), or paper publication (e.g. pdf)... - -the solution arrived at is by extracting structural information about the document (about headings within the document) and by tracking objects (which are serialized and also given hash values) in the manner described. It makes possible representations that are quite different from those offered at present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document. - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_skin.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_skin.sst deleted file mode 100644 index 9cff0ed7..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_skin.sst +++ /dev/null @@ -1,104 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Skins - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:skins;SiSU:manual:skins;electronic documents:SiSU:manual:skins;SiSU:document:skins;SiSU:document:skins - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - -@date: - :published: 2007-09-16 - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? Document Skins - configuration - -1~skins Skins - -% .SH "SKINS \- document, directory and site skins" - -Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: - -_1 ./_sisu/skin - -_1 ~/.sisu/skin - -_1 /etc/sisu/skin - -!_ Within the skin directory -are the following the default sub-directories for document skins: - -_1 ./skin/doc - -_1 ./skin/dir - -_1 ./skin/site - -A skin is placed in the appropriate directory and the file named skin_[name].rb - -The skin itself is a ruby file which modifies the default appearances set in the program. - -2~ Document Skin - -Documents take on a document skin, if the header of the document specifies a skin to be used. - -code{ - -@skin: skin_united_nations - -}code - -2~ Directory Skin - -A directory may be mapped on to a particular skin, so all documents within that directory take on a particular appearance. If a skin exists in the skin/dir with the same name as the document directory, it will automatically be used for each of the documents in that directory, (except where a document specifies the use of another skin, in the skin/doc directory). - -A personal habit is to place all skins within the doc directory, and symbolic links as needed from the site, or dir directories as required. - -2~ Site Skin - -A site skin, modifies the program default skin. - -2~ Sample Skins - -With SiSU installed sample skins may be found in: - -_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/v2/sisu_markup_samples/samples/_sisu/skin/doc - -(or equivalent directory) and if sisu-markup-samples is installed also under: - -_1 /usr/share/doc/sisu-markup-samples/v2/samples/_sisu/skin/doc - -Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: - -_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sql.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sql.ssi deleted file mode 100644 index 0f2e8b7b..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sql.ssi +++ /dev/null @@ -1,68 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: SQL and Search - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Search - -:C~? Search - -1~search_sql SQL - -2~ populating SQL type databases - -SiSU feeds sisu markupd documents into sql type databases PostgreSQL~{ http://www.postgresql.org/
http://advocacy.postgresql.org/
http://en.wikipedia.org/wiki/Postgresql }~ and/or SQLite~{ http://www.hwaci.com/sw/sqlite/
http://en.wikipedia.org/wiki/Sqlite }~ database together with information related to document structure. - -This is one of the more interesting output forms, as all the structural data of the documents are retained (though can be ignored by the user of the database should they so choose). All site texts/documents are (currently) streamed to four tables: - -_1* one containing semantic (and other) headers, including, title, author, subject, (the Dublin Core...); - -_1* another the substantive texts by individual "paragraph" (or object) - along with structural information, each paragraph being identifiable by its paragraph number (if it has one which almost all of them do), and the substantive text of each paragraph quite naturally being searchable (both in formatted and clean text versions for searching); and - -_1* a third containing endnotes cross-referenced back to the paragraph from which they are referenced (both in formatted and clean text versions for searching). - -_1* a fourth table with a one to one relation with the headers table contains full text versions of output, eg. pdf, html, xml, and ascii. - -There is of course the possibility to add further structures. - -At this level SiSU loads a relational database with documents chunked into objects, their smallest logical structurally constituent parts, as text objects, with their object citation number and all other structural information needed to construct the document. Text is stored (at this text object level) with and without elementary markup tagging, the stripped version being so as to facilitate ease of searching. - -Being able to search a relational database at an object level with the SiSU citation system is an effective way of locating content generated by SiSU. As individual text objects of a document stored (and indexed) together with object numbers, and all versions of the document have the same numbering, complex searches can be tailored to return just the locations of the search results relevant for all available output formats, with live links to the precise locations in the database or in html/xml documents; or, the structural information provided makes it possible to search the full contents of the database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well). - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sqlite.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sqlite.sst deleted file mode 100644 index 7f312e0f..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_sqlite.sst +++ /dev/null @@ -1,98 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Sqlite / search - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:sqlite;SiSU:manual:sqlite;electronic documents:SiSU:manual:sqlite;SiSU:document:sqlite;SiSU:document:sqlite - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - -@date: - :published: 2007-09-16 - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -dv [filename/wildcard ]\n sisu -dv [instruction] - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -% :B~? SiSU Sqlite - -1~sqlite Sqlite - -2~ Name - -SiSU - Structured information, Serialized Units - a document publishing system. - - -2~ Description - -Information related to using sqlite with sisu (and related to the sisu_sqlite dependency package, which is a dummy package to install dependencies needed for SiSU to populate an sqlite database, this being part of SiSU - man sisu). - -2~ Synopsis - -_1 sisu -d [instruction] [filename/wildcard if required] - -_1 sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required] - - -2~ Commands - -Mappings to two databases are provided by default, postgresql and sqlite, the same commands are used within sisu to construct and populate databases however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql, alternatively --sqlite or --pgsql may be used - -!_ -d or --sqlite -may be used interchangeably. - -3~ create and destroy database - -!_ --sqlite --createall
-initial step, creates required relations (tables, indexes) in existing (sqlite) database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) - -!_ sisu -d --createdb
-creates database where no database existed before - -!_ sisu -d --create
-creates database tables where no database tables existed before - -!_ sisu -d --dropall
-destroys database (including all its content)! kills data and drops tables, indexes and database associated with a given directory (and directories of the same name). - -!_ sisu -d --recreate
-destroys existing database and builds a new empty database structure - -3~ import and remove documents - -!_ sisu -d --import -v [filename/wildcard]
-populates database with the contents of the file. Imports documents(s) specified to an sqlite database (at an object level). - -!_ sisu -d --update -v [filename/wildcard]
-updates file contents in database - -!_ sisu -d --remove -v [filename/wildcard]
-removes specified document from sqlite database. diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_synopsis.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_synopsis.ssi deleted file mode 100644 index 909cb2c2..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_synopsis.ssi +++ /dev/null @@ -1,64 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Commands - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual SiSU.ssm - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Commands - -1~ Synopsis - -SiSU - Structured information, Serialized Units - a document publishing system - -sisu [ -abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ] - -sisu [ -Ddcv ] [ instruction ] - -sisu [ -CcFLSVvW ] - -Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. - -sisu is at version 2, to use sisu version 1 - -sisu --v1 [and options/operations as above] - -for settings see sisu --help env - -sisu [ filename/ wildcard] == sisu -0 [filename/wildcard] diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_syntax_highlighting.sst deleted file mode 100644 index 24f72c71..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_syntax_highlighting.sst +++ /dev/null @@ -1,169 +0,0 @@ -% SiSU insert 2.0 - -@title: SiSU - :subtitle: Syntax Highlighting - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:syntax highlighting;SiSU:manual:syntax highlighting;electronic documents:SiSU:manual:syntax highlighting;SiSU:document:syntax highlighting;SiSU:document:syntax highlighting - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - -@date: - :published: 2007-09-16 - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Syntax Highlighting - -1~ Editor Files, Syntax Highlighting - -The directory: - -_1 ./data/sisu/conf/editor-syntax-etc/ - -_1 /usr/share/sisu/conf/editor-syntax-etc - -contains rudimentary sisu syntax highlighting files for: - -_* (g)vim http://www.vim.org - -_1 package: sisu-vim - -status: largely done - -_1 there is a vim syntax highlighting and folds component - -_* gedit http://www.gnome.org/projects/gedit - -_* gobby http://gobby.0x539.de/ - -_1 file: sisu.lang - -place in: - -_1 /usr/share/gtksourceview-1.0/language-specs - -or - -_1 ~/.gnome2/gtksourceview-1.0/language-specs - -_1 status: very basic syntax highlighting - -_1 comments: this editor features display line wrap and is used by Goby! - -_* nano http://www.nano-editor.org - -_1 file: nanorc - -save as: - -_1 ~/.nanorc - -_1 status: basic syntax highlighting - -_1 comments: assumes dark background; no display line-wrap; does line breaks - -_* diakonos (an editor written in ruby) http://purepistos.net/diakonos - -file: diakonos.conf - -save as: - -_1 ~/.diakonos/diakonos.conf - -includes: - -_1 status: basic syntax highlighting - -comments: assumes dark background; no display line-wrap - -_* kate & kwrite http://kate.kde.org - -_1 file: sisu.xml - -_1 place in: - -_2 /usr/share/apps/katepart/syntax - -_1 or - -_2 ~/.kde/share/apps/katepart/syntax - -_1 [settings::configure kate::{highlighting,filetypes}] - -_1 [tools::highlighting::{markup,scripts}::SiSU] - -% kde-config --prefix -% KDEDIR/share/apps/katepart/syntax/ -% KDEHOME/share/apps/katepart/syntax -% [In the configure dialog in kate, go to the "Editor->highlighting" page and -% >select a highlight to change the mimetype/pattern associations for it.] -% /etc/mime.types -% /usr/share/mime/text - -_* nedit http://www.nedit.org - -_1 file: sisu_nedit.pats - -_1 nedit -import sisu_nedit.pats - -_1 status: a very clumsy first attempt [not really done] - -_1 comments: this editor features display line wrap - -_* emacs http://www.gnu.org/software/emacs/emacs.html - -_1 files: sisu-mode.el - -_1 to file ~/.emacs add the following 2 lines: - -_2 (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") - -_2 (require 'sisu-mode.el) - -_1 [not done / not yet included] - -_* vim & gvim http://www.vim.org - -_1 files: - -_1 package is the most comprehensive sisu syntax highlighting and editor environment provided to date (is for vim/ gvim, and is separate from the contents of this directory) - -_1 status: this includes: syntax highlighting; vim folds; some error checking - -_1 comments: this editor features display line wrap - -NOTE: - -[SiSU parses files with long lines or line breaks, but, display linewrap (without line-breaks) is a convenient editor feature to have for sisu markup] - -% aeditor (an editor written in ruby) - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_webrick.sst b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_webrick.sst deleted file mode 100644 index 52f8c579..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_webrick.sst +++ /dev/null @@ -1,93 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: sisu_webrick - -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:webrick;SiSU:manual:webrick;electronic documents:SiSU:manual:webrick;SiSU:document:webrick;SiSU:document:webrick - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2007-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W - -@links: - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? SiSU Webrick - -1~webrick sisu_webrick - -2~ Name - -SiSU - Structured information, Serialized Units - a document publishing system - -2~ Synopsis - -sisu_webrick [port] - -or - -sisu -W [port] - -2~ Description - -sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby's Webrick web-server and points it to the directories to which SiSU output is written, providing a list of these directories (assuming SiSU is in use and they exist). - -The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system). - -2~ Summary of man page - -sisu_webrick, may be started on it's own with the command: sisu_webrick [port] or using the sisu command with the -W flag: sisu -W [port] - -where no port is given and settings are unchanged the default port is 8081 - -2~ Document processing command flags - -sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, on the port provided, or if no port is provided and the defaults have not been changed in ~/.sisu/sisurc.yaml then on port 8081 - -2~ Further information - -For more information on SiSU see: http://www.jus.uio.no/sisu - -or man sisu - -2~ Author - -Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com - -2~ SEE ALSO - -_1 sisu(1) - -_1 sisu_vim(7) - -_1 sisu(8) - diff --git a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi b/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi deleted file mode 100644 index 98f46e1f..00000000 --- a/data/doc/sisu/v3/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi +++ /dev/null @@ -1,78 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Work Needed and Wishlist - -@creator: :author: Ralph Amissah - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -@date: - :created: 2002-08-28 - :issued: 2002-08-28 - :available: 2002-08-28 - :published: 2007-09-16 - :modified: 2009-12-16 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ - { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ - -:A~? @title @creator - -:B~? Work Needed and Wishlist - -1~sisu_work_needed Work Needed - -SiSU is fairly mature and for most purposes the syntax and what it is supposed to do is clear. For the most part additions and changes are minor and backward compatible, (in particular there may be things of interest that to be able to achieve will require additions to the syntax). - -_* Amongst the most requested features is a way to represent and extract bibliographies from scholarly and other writings. This involves an extension of sisu markup syntax and a new module to extract the bibliography. - -_* Integration of postgresql tsearch2 / gin indexing, (which currently needs to be done manually, and) which has been waiting for the integration of tsearch2 / gin into Postgresql main, which is supposed to occur in Postgresql 8.3 - -_* Internationalisation always. SiSU is utf-8 and for those parts that are utf-8 friendly will work out of the box - html and postgresql for example work out of the box (and for example comfortably represent Chinese text), LaTeX and odf do not work out of the box, they need additional work for extended language sets. - -_* Refinements and improvements to output representations, some are fairly mature, others (such as manpages and info files (and even ODF) remain young. - -_* Simple extension to contain, link and share included audio and multi-media files, (including sisupod.zip) - -1~sisu_wishlist Wishlist - -SiSU provides a lot of "plumbing" and is readily usable as a tool by those comfortable with marking up documents with an editor. The syntax is fairly easy to learn, especially the subset required to start using SiSU effectively. - -SiSU might also be of interest to developers interested in: - -_* experimenting with the search implications offered - -_* producing additional output formats - -_* producing conversion tools - -_* producing input interfaces, (experimenting with additional interfaces for producing sisu source documents) - -Several tools that are of interest would come under the heading interface and conversion. Amongst others, the following are of interest: - -_* Converters from various document formats, such as Open Document Text (ODF), MS Word(TM) and Word Perfect(TM), even html. The problem here is one of the most important things for SiSU is to be able to recognise the structure of a document, and many documents prepared in other formats have not been prepared strictly with a view to representing structure, but appearance - so heading levels may be "painted" to look right rather than have the correct structural representation. Even if conversion is not perfect this may serve as a first step in assisting in conversion of documents to SiSU for those with legacy document sets that they would like to have in sisu format. (once in SiSU it is easier to get out in various other formats as this is what sisu does, within the constraints of the information that sisu uses to generate output) - -_* The possibility to save directly from from various word processors, and possibly templates within them to assist in making sure the document structure is "understood" by SiSU. - -_* Web interface/front-end, a form like front end for the writing or submission of sisu documents to a server which uses SiSU to generate output. Headers could be made available as separate small entry forms with help provided to explain where they might be used. Apart from the most important headers such as title, author, date and possibly subject the remainder of the header forms could be placed after the form for substantive content. This would offer a more Web 2.0 like approach to the use of SiSU and the possibility of using it for collaborative editing of content (possibly for documents that are to be finalised/published as the citation system is most suited to published works). [Collaborative editing is currently possible through use of a collaborative editor such as Gobby which makes use of the Obby protocol]. - -- cgit v1.2.3