From 52f8b9c0b1e1606a4260ef2e0df4d525497691b1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sat, 7 Jul 2007 09:21:47 +0100 Subject: cgi-sample search form; texinfo fix; xml scaffold; help, man pages etc. visited; screen output, color set to true; docbook entries removed * cgi generated sample search form * order results on files of the same title, in multiple files (with different filenames) * postgresql, character case sensitivity, control, on/off * tail decoration, gplv3 & sisu info * texinfo/info (pinfo) module starts to do something vaguely useful again [not a much used module, testing required] * print XML rendition of document structure to screen -T * sisurc.yml default, color set to true [apologies if this causes anyone any inconvenience, it is configurable in sisurc.yml] * help, man pages, README (man(8) related and env, 'sisu -V') * docbook entries removed for the present time * sisu-install (install ruby rant script renamed) and permissions set to executable --- data/doc/sisu/copyright | 46 +++++----- data/doc/sisu/html/sisu.1.html | 58 ++++++------ data/doc/sisu/html/sisu.8.html | 195 +++++++++++++++++++++++++---------------- 3 files changed, 171 insertions(+), 128 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/copyright b/data/doc/sisu/copyright index c15699c4..6b129a77 100644 --- a/data/doc/sisu/copyright +++ b/data/doc/sisu/copyright @@ -8,33 +8,31 @@ The original source can always be found at: -Copyright (C) 1997, 1998, 1999, 2000, 20001, 2002, 2003, 2004, 2005 -Ralph Amissah +License: GPL 3 or later: -License: GPL v3 or later + SiSU, a framework for document structuring, publishing and search - GPL3 summary: + Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, + 2007 Ralph Amissah - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. + This program is free software: you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the Free + Software Foundation, either version 3 of the License, or (at your option) + any later version. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for + more details. - You should have received a copy of the GNU General Public License - along with this package; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, - MA 02110-1301, USA + You should have received a copy of the GNU General Public License along with + this program. If not, see . If you have Internet connection, the latest version of the GPL should be - available from these locations: - - - + available at these locations: + + + On Debian systems, the complete text of the GNU General Public License can be found in `/usr/share/common-licenses/GPL'. @@ -42,7 +40,7 @@ License: GPL v3 or later The Free Software Foundation: -For installation purposes the SiSU tarball includes +For installation purposes the SiSU tarball includes: setup.rb by Minero Aoki @@ -52,9 +50,9 @@ Hompepage: License: LGPL -and +and -install, an installer generated by +sisu-install, an installer generated by Rant which is by Stefan Lang Homepage: @@ -64,4 +62,4 @@ License: LGPL NB: Rant is not included in the SiSU tarball, and is not itself required for - the Rant generated install file to work + the Rant generated install file to work, (ruby will suffice) diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 61d0ab0d..968f8eb1 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -12,7 +12,7 @@ SiSU - Structured information, Serialized Units - a document publishing system

Synopsis

-sisu [ -AabcDdEeFHhIMmNnopqrRSstUuVvwXxYyZz0-9 +sisu [ -AabcDdEeFHhIMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ]

sisu [ -Ddcv ] [ instruction ]

sisu [ -CcFLSVvW @@ -130,37 +130,37 @@ most web servers). [behaviour switched after 0.35 see -H].

-I [filename/wildcard]
-
produces texinfo file.
+
produces texinfo and info file, (view with pinfo).
-L
-
prints license information.
+
prints license information. +
+ +
-M [filename/wildcard/url]
+
maintenance mode files created for processing +preserved and their locations indicated. (also see -V)
+ +
-m [filename/wildcard/url] +
+
assumed for most other flags, creates new meta-markup file, (the metaverse +) that is used in all subsequent processing of other output. This step is +assumed for most processing flags. To skip it see -n
+ +
-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 meta-markup (building of "metaverse"), this skips the equivalent of +-m which is otherwise assumed by most processing flags.
-
-M [filename/wildcard/url] +
-o [filename/wildcard/url]
-
maintenance mode files created for processing preserved and their locations -indicated. (also see -V)
- -
-m [filename/wildcard/url]
-
assumed for most other -flags, creates new meta-markup file, (the metaverse ) that is used in all -subsequent processing of other output. This step is assumed for most processing -flags. To skip it see -n
- -
-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 meta-markup -(building of "metaverse"), this skips the equivalent of -m which is otherwise -assumed by most processing flags.
- -
-o [filename/wildcard/url]
-
output basic -document in opendocument file format (opendocument.odt).
+
output basic document in opendocument file format (opendocument.odt).
-p [filename/wildcard]
@@ -1161,7 +1161,7 @@ set up, and first time must be run without other flags ie sisu -mrv [file sisu -mhwprv example_file.sst other_example_file.sst

to process a remote sisu marked up file (html,pdf,concordance), provide the url(s) (works for text -only files, will be downloaded and processed locally): sisu -mhwpv http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst +only files, will be downloaded and processed locally): sisu -mhwpv http://www.jus.uio.no/sisu/sample/markup/gpl3.fsf.sst http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst

one file is local diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html index b79b71b1..c6134b33 100644 --- a/data/doc/sisu/html/sisu.8.html +++ b/data/doc/sisu/html/sisu.8.html @@ -19,65 +19,72 @@ document publishing system, that from a simple single marked-up document, produces a multitude of output formats including: html, latex, pdf, info, and sql output, which can be cross referenced as having the same document structure and text object numbering, "object citation numbering". Features -include its’ simple syntax; the semantic identification of documents using -the Dublin Core; document management; built to be associated with a revision -control system; text object numbering for the identification of a texts -location in any of the output formats, easy skinning on a site wide, or -per document basis, ... for more see man 1 sisu or <http://www.jus.uio.no/sisu +include its’ simple syntax; the semantic tagging of documents; document +management; built to be associated with a revision control system; text +object numbering for the identification of a texts location in any of the +output formats, easy skinning on a site wide, or per document basis; granular +search; a degree of future proofing ... for more see man 1 sisu or <http://www.jus.uio.no/sisu >

-SiSU is an alternative way of publishing and managing documents. +SiSU is a way of preparing, publishing, managing and searching documents. +

Installation

-Up -to date information on SiSU downloads, and their installation should be -available from: <http://www.jus.uio.no/sisu/SiSU/download.html -> or at: <http://www.jus.uio.no/sisu/sisu_download/download.html +Up to date information on SiSU downloads, and their installation +should be available from: <http://www.jus.uio.no/sisu/SiSU/download.html +> or +at: <http://www.jus.uio.no/sisu/sisu_download/download.html +>

+There you should +find links to the latest source tarball, and instructions on how to install +SiSU.

+Sample marked up documents are are available at /usr/share/doc/sisu/sisu_markup_samples/dfsg +or equivalent directory, or online, see <http://www.jus.uio.no/sisu/SiSU/2.html >

-There you should find links to the latest source tarball, and instructions -on how to install SiSU.

-Sample marked up documents are are available at -/usr/share/doc/sisu/sisu_markup_samples/dfsg or equivalent directory, or -online at <http://www.jus.uio.no/sisu/sample/markup.html -> or for viewing in html -with syntax highlighting from <http://www.jus.uio.no/sisu/sample/syntax ->

-A syntax -table is provided at /usr/share/doc/sisu/on_markup.txt or equivalent, and -online at <http://www.jus.uio.no/sisu/sample/on_markup.txt ->

-man 1 sisu has a -syntax table along with processing commands.

-SiSU also provides some help -via the command: sisu --help and selecting an appropriate subject, e.g.

-sisu ---help commands

+man 1 sisu has a syntax table along with processing commands.

+SiSU also +provides some help via the command: sisu --help and selecting an appropriate +subject, e.g.

+sisu --help commands

sisu --help markup

sisu --help headers

-sisu --help env

-The rest -of this note is on post installation setup -

Post Installation Setup - Quick -start

-

-After installation of sisu-complete, move to the document samples directory +sisu +--help env

+The rest of this note is on post installation setup +

Post Installation +Setup - Quick start

+ +

After installation of sisu-complete, move to the document +samples directory,

cd /usr/share/doc/sisu/sisu_markup_samples/dfsg

-and run

- sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst
-

+[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

+sisu -CC

+then run:

+sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst +

or the same:

- sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst
-

+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

-To generate an online document move to a writable directory, (create a -work directory and cd into it) as the file will be downloaded there and -e.g.

+for an overview of your current sisu setup, type:

+sisu --help env

+or

+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.

sisu -1 http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst -

+ +

sisu -3 http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst

@@ -140,39 +147,76 @@ 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

-Depends: ruby (>= 1.8.4), libwebrick-ruby

+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, -zip, unzip, openssl, rsync, openssh-client lsh-client,
- keychain, hyperestraier, kdissert
-

-Suggests: libfcgi-ruby1.8, rcs cvs, lv, texinfo, pinfo, rename

-Package: -sisu-complete

-Depends: ruby (>= 1.8.4), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +sisu-pdf, sisu-sqlite, sisu-postgresql, librmagick-ruby, trang, tidy, librexml-ruby, +openssl, rsync, openssh-client lsh-client, keychain, hyperestraier, kdissert +Suggests: rcs cvs, lv, texinfo, pinfo

+Package: sisu-complete

+Depends: ruby +(>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite

+Recommends: hyperestraier

-Recommends: hyperestraier

Package: sisu-pdf

-Depends: sisu, tetex-bin texlive-base-bin, -tetex-extra texlive-latex-extra, texlive-latex-extra, latex-ucs
-

+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-postgresql

+Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql

+Recommends: libfcgi-ruby

Package: sisu-sqlite

-Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby +Depends: sisu, sqlite, libdbd-sqlite-ruby, +libdbi-ruby, libdbm-ruby

+Recommends: libfcgi-ruby

+Package: sisu-markup-samples

-Suggests: libdbd-sqlite

-Package: sisu-markup-samples

Depends: sisu

+ +

Package Description

+sisu

+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, 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: <http://www.jus.uio.no/sisu +> -

Document -Resource Configuration

-sisu resource configuration information is obtained -from sources (where they exist):
+

Document Resource Configuration

+sisu resource configuration information +is obtained from sources (where they exist): 
~/.sisu/sisurc.yaml/etc/sisu/[sisu version]/sisurc.yamlsisu program defaults

Skins

@@ -190,16 +234,16 @@ of documents.

Usually all skin files are placed in the document skin directory: ~/.sisu/skin/doc with softlinks being made to the skins contained there from other skin directories as required. -

Further Information

+

Further Information

For more information on SiSU see: <http://www.jus.uio.no/sisu >

or man sisu -

Author

+

Author

Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> -

See Also

+

See Also

sisu(1) , sisu_examples(1) , sisu_webrick(1) @@ -219,10 +263,11 @@ or <ralph.amissah@gmail.com>
  • Installation
  • Post Installation Setup - Quick start
  • Debian INSTALLATION Note
    • -
  • Document Resource Configuration
    • -
  • Further Information
    • -
  • Author
    • -
  • See Also
    • +
  • Package Description
    • +
  • Document Resource Configuration
    • +
  • Further Information
    • +
  • Author
    • +
  • See Also
    • -- cgit v1.2.3