aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2015-06-02 13:58:05 -0400
committerRalph Amissah <ralph@amissah.com>2015-06-02 13:58:05 -0400
commitbaaf3d3690b7af306a793bde53c11d8c80fe3d44 (patch)
tree0d1bff8f1bfb20ca0d4e09bdbc6d522c9df701d7
parentdebian/changelog (7.1.4-1) (diff)
parentversion & changelog, tag for release (diff)
Merge tag 'sisu_7.1.5' into debian/sid
SiSU 7.1.5
-rw-r--r--README.txt2421
-rw-r--r--data/doc/sisu/CHANGELOG_v75
-rw-r--r--data/sisu/version.yml6
-rw-r--r--setup/sisu_version.rb2
4 files changed, 9 insertions, 2425 deletions
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 6c5fe255..00000000
--- a/README.txt
+++ /dev/null
@@ -1,2421 +0,0 @@
-SISU - README
-=============
-
-INTRODUCTION
-************
-
-INTRODUCTION - WHAT IS SISU?
-----------------------------
-
-*SiSU* is a 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.
-
-From a single lightly prepared document (plain-text /UTF-8/) 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. *SiSU* produces: plain-text, /HTML/, /XHTML/,
-/XML/, /EPUB/, /ODF/: /ODT/ (Opendocument), /LaTeX/, /PDF/, and populates an
-/SQL/ database (/PostgreSQL/ or /SQLite/) with text objects, roughly, paragraph
-sized chunks so that document searches are done at this level of granularity.
-
-Outputs share a common citation numbering system, associated with text objects
-and any semantic meta-data provided about the document.
-
-*SiSU* also provides concordance files, document content certificates and
-manifests of generated output. Book indexes may be made.
-
-Some document markup samples are provided in the package sisu -markup-samples.
-
-Homepages:
-* <http://www.sisudoc.org/>
-* <http://www.jus.uio.no/sisu>
-
-INSTALL OR RUN WITHOUT INSTALLATION
-***********************************
-
-SOURCE TREE
------------
-
-RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING)
-..........................................................
-
-Download & unpack the latest source tarball
-
-or
-
-Git clone the latest source, to clone the latest source without the repo
-history:
-
-git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream
-
-Provided you have *Ruby*, *SiSU* can be run without installation straight from
-the source package directory tree. Run ruby against the full path to bin/sisu
-(in the unzipped source package directory tree)
-
-Note however, that additional external package dependencies, such as texlive
-(for pdfs), sqlite3 or postgresql (for search) should you desire to use them
-are not taken care of for you.
-
-GEM INSTALL
-...........
-
-Gem install, you need to:
-
-(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install
-the gem
-
-
-----------------------------------------
-
-GEM INSTALL WITH QI (QUICK INSTALL) SCRIPT
-..........................................
-
-(This requires that ruby -thor is installed).
-
-qi (quick install) can go through the steps required to install the gem:
-
- qi gem --create --build --install --stable
-
-or
-
- qi gem --create --build --install --unstable
-
-
-----------------------------------------
-
-GEM INSTALL WITH RAKE
-.....................
-
-Provided you have ruby & rake, this can be done with the single command:
-
- rake gem_create_build_install # (to build and install, alias gemcbi)
-
-for individual steps (create, build, install) see rake options, rake -T to
-specify sisu version for sisu installed via gem
-
-For a list of alternative actions you may type:
-
- rake help
-
- rake -T
-
-Rake: <http://rake.rubyforge.org/> <http://rubyforge.org/frs/?group_id=50>
-
-
-----------------------------------------
-
-MISC GEM
-........
-
-gem search sisu
-
- sisu _7.0.0_ --version
-
- sisu _7.0.0_ --version
-
-to uninstall sisu installed via gem
-
- sudo gem uninstall --verbose sisu
-
-DIRECT INSTALLATION WITH QI (QUICK INSTALL) SCRIPT
-..................................................
-
-(This requires that ruby -thor is installed).
-
-Root will be requested as required:
-
- qi setup --bin --lib --conf --data --share --man
-
-or
-
- qi setup --all
-
-You may wish to do a dryrun to see where files would be installed without
-copying them, to do so add the flag --dryrun
-
-INSTALLATION WITH SETUP.RB
-..........................
-
-It should also be possible to install sisu using setup.rb
-
-this is a three step process, in the root directory of the unpacked *SiSU* as
-root type:
-
-ruby setup.rb config
-ruby setup.rb setup
-#[as root:]
-ruby setup.rb install
-
-further information:
-<http://i.loveruby.net/en/projects/setup/>
-<http://i.loveruby.net/en/projects/setup/doc/usage.html>
-
- ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install
-
-UNIX/LINUX DISTRIBUTION
------------------------
-
-A distribution install should take care of the dependencies of sisu for
-producing various outputs.
-
-DEBIAN
-......
-
-*SiSU* is available off the *Debian* archives. It should necessary only to run
-as root, Using apt-get:
-
- apt-get update
-
- apt get install sisu-complete
-
-(all sisu dependencies should be taken care of)
-
-If there are newer versions of *SiSU* upstream, they will be available by
-adding the following to your sources list /etc/apt/sources.list
-
-#/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
-
-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.
-
-*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:
-
- *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
-
- *sisu-complete*, a dummy package that installs the whole of greater sisu as
- described below, apart from sisu -examples
-
- *sisu-pdf*, dependencies used by sisu to produce pdf from /LaTeX/ generated
-
- *sisu-postgresql*, dependencies used by sisu to populate postgresql database
- (further configuration is necessary)
-
- *sisu-sqlite*, dependencies used by sisu to populate sqlite database
-
- *sisu-markup-samples*, sisu markup samples and other miscellany (under
- *Debian* Free Software Guidelines non-free)
-
-*SiSU* is available off Debian Unstable and Testing [link:
-<http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu>]
-[^1] install it using apt-get, aptitude or alternative *Debian* install tools.
-
-DEPENDENCIES
-------------
-
-Here is a list of sisu' s current dependencies,[^2] which depend on such
-factors as whether you want to generate pdf, whether you will be using *SiSU*
-with or without a database, ...). sisu_markup-samples may also be of interest.
-
-Package: sisu
-Depends: ruby | ruby-interpreter, openssl, rsync, unzip, zip