From 096c8888f11c857f97ee4da9963221666de9205b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 6 Apr 2015 22:51:12 -0400 Subject: sisu packaging notes --- data/doc/sisu/org/sisu.org | 67 +++++++++++++++++++++++----------------------- 1 file changed, 34 insertions(+), 33 deletions(-) (limited to 'data/doc/sisu/org/sisu.org') diff --git a/data/doc/sisu/org/sisu.org b/data/doc/sisu/org/sisu.org index ef566d3c..3ea2f446 100644 --- a/data/doc/sisu/org/sisu.org +++ b/data/doc/sisu/org/sisu.org @@ -3,14 +3,12 @@ (emacs:evil mode gifts a "vim" of enticing "alternative" powers! ;) (vim, my _editor_ of choice also in the emacs environment :) -* General - -** what is sisu? +* What is SiSU? Multiple output formats with a nod to the strengths of each output format and the ability to cite text easily across output formats. -*** debian/control desc +** debian/control desc documents - structuring, publishing in multiple formats and search SiSU is a lightweight markup based, command line oriented, document @@ -56,7 +54,7 @@ documents - structuring, publishing in multiple formats and search SiSU works well under po4a translation management, for which an administrative sample Rakefile is provided with sisu_manual under markup-samples. j -*** take two +** take two SiSU may be regarded as an open access document publishing platform, applicable to a modest but substantial domain of documents (typically law and literature, @@ -217,7 +215,7 @@ Development work is on Linux and the easiest way to install it is through the Debian Linux package as this takes care of optional external dependencies such as XeTeX for PDF output and Postgresql or Sqlite for search. -*** multiple document formats +** multiple document formats Text can be represented in multiple output formats with different characteristics that are (or may be) regarded as strengths/advantages and @@ -232,23 +230,23 @@ formats. For citation across output formats, SiSU uses object citation numbers. -*** document structure and document objects +** document structure and document objects SiSU breaks marked up text into document structure and objects Document structure being the document heading hierarchy (having separated out the document header). -**** What are document objects? +*** What are document objects? An object is an identified meaningful unit of a document, most commonly a paragraph of text, but also for example a table, code block, verse or image. SiSU tracks these substantive document units as document objects (and their relationship to the document structure). -*** object citation numbers +** object citation numbers -**** What are object citation numbers? +*** What are object citation numbers? An object citation number is a sequential number assigned to a document object. @@ -259,7 +257,7 @@ across various digital outputs whether paper, screen, or database oriented, prepared appropriately. This numbering system can be used to reference content across output types. -**** Why might I want object citation numbering? +*** Why might I want object citation numbering? The ability to cite and quickly locate text can be invaluable if not essential. (whether for instruction or discussion). @@ -300,7 +298,7 @@ foreign language counterpart some detail of the text, or, how do I point my foreign language counterpart to the text I would like to bring to his attention. -*** "Granular" Search +** "Granular" Search Of interest is the ease of streaming documents to a relational database, at an object (roughly paragraph) level and the potential for increased precision in @@ -308,7 +306,7 @@ the presentation of matches that results thereby. The ability to serialize html, LaTeX, XML, SQL, (whatever) is also inherent in / incidental to the design. -*** Summary +** Summary SiSU information Structuring Universe Structured information, Serialized Units or software for electronic texts, document collections, @@ -317,7 +315,7 @@ system (shared text citation numbering: "ocn") outputs include: plaintext, html, XHTML, XML, ODF (OpenDocument), EPUB, LaTeX, PDF, SQL (PostgreSQL and SQLite) -*** SiSU Short Description +** SiSU Short Description SiSU is a comprehensive future-resilient electronic document management system. Built-in search capabilities allow you to search across multiple documents and @@ -344,7 +342,7 @@ SiSU is an Open Source project initiated and led by Ralph Amissah at . SiSU is licensed under the GNU General Public License. -**** notes +*** notes For less markup than the most elementary HTML you can have more. SiSU - Structured information, Serialized Units for electronic documents, is an @@ -481,7 +479,7 @@ to PDF, a LaTeX processor like tetex or texlive. as a developers tool it is flexible and extensible -*** description +** description SiSU ("SiSU information Structuring Universe" or "Structured information, Serialized Units"),1 is a Unix command line oriented framework for document @@ -536,8 +534,8 @@ cover a wide range of documents within its use domain have been explored. 2010 w3 since October 3 1993 -** Finding -*** source +* Finding SiSU +** source http://git.sisudoc.org/gitweb/ sisu git repo: @@ -546,7 +544,7 @@ http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary sisu-markup-samples git repo: http://git.sisudoc.org/gitweb/?p=doc/sisu-markup-samples.git;a=summary -*** mailing list +** mailing list sisu at lists.sisudoc.org http://lists.sisudoc.org/listinfo/sisu @@ -557,9 +555,9 @@ http://lists.sisudoc.org/listinfo/sisu -** Installing sisu +* Installation -*** where you take responsibility for having the correct dependencies +** where you take responsibility for having the correct dependencies Provided you have *Ruby*, *SiSU* can be run. @@ -572,12 +570,12 @@ 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. -**** run off the source tarball without installation +*** run off the source tarball without installation RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING) .......................................................... -***** 1. Obtain the latest sisu source +**** 1. Obtain the latest sisu source using git: @@ -614,7 +612,7 @@ or off sisu repos or dget -x http://sisudoc.org/sisu/archive/pool/main/s/sisu/sisu_5.4.5-1.dsc -***** 2. Unpack the source +**** 2. Unpack the source Provided you have *Ruby*, *SiSU* can be run without installation straight from the source package directory tree. @@ -631,7 +629,7 @@ 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 (with rake) +*** gem install (with rake) (i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install the gem @@ -673,7 +671,7 @@ For a list of alternative actions you may type: Rake: -**** installation with setup.rb +*** installation with setup.rb this is a three step process, in the root directory of the unpacked *SiSU* as root type: @@ -689,7 +687,7 @@ further information: ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install -*** Debian install +** Debian install *SiSU* is available off the *Debian* archives. It should necessary only to run as root, Using apt-get: @@ -739,9 +737,11 @@ The package is divided into the following components: ] [^1] install it using apt-get, aptitude or alternative *Debian* install tools. -** sisu markup :sisu:markup: +** Arch Linux + +* sisu markup :sisu:markup: -*** sisu markup +** sisu markup #% structure - headings, levels * headings (A-D, 1-3) @@ -829,14 +829,15 @@ The package is divided into the following components: #% misc * term & definition -*** syntax hilighting +** syntax hilighting -**** vim +*** vim data/sisu/conf/editor-syntax-etc/vim/ data/sisu/conf/editor-syntax-etc/vim/syntax/sisu.vim -**** emacs +*** emacs data/sisu/conf/editor-syntax-etc/emacs/ data/sisu/conf/editor-syntax-etc/emacs/sisu-mode.el -** todo + +* todo sisu_todo.org -- cgit v1.2.3