aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2014-12-04 16:54:07 -0500
committerRalph Amissah <ralph@amissah.com>2014-12-08 00:18:14 -0500
commit17c8e964519c0b50a74777d53ad64084d837a1f1 (patch)
treee45427a0349df4cebfdb699a46281e1457f76e8a /data/doc
parentorg files related to sisu, break up and place in own subdir (diff)
org files, minor editing
Diffstat (limited to 'data/doc')
-rw-r--r--data/doc/sisu/CHANGELOG_v54
-rw-r--r--data/doc/sisu/CHANGELOG_v64
-rw-r--r--data/doc/sisu/org/sisu.org40
3 files changed, 25 insertions, 23 deletions
diff --git a/data/doc/sisu/CHANGELOG_v5 b/data/doc/sisu/CHANGELOG_v5
index 2f3b7265..659c54a0 100644
--- a/data/doc/sisu/CHANGELOG_v5
+++ b/data/doc/sisu/CHANGELOG_v5
@@ -49,7 +49,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_5.8.0.orig.tar.xz
* CHANGELOGS formatted for viewing as org-mode files
indentation, line-breaking, and formatting characters only changes made
- * org files related to sisu, break up and place in own subdir
+ * org files related to sisu
+ * break up and place in own subdir
+ * org files, minor editing
** SiSU "UnFrozen" - prior to end of Debian Freeze
(upstream bugfix 5.7.2 intended for Jessie (packaged for Debian as 5.7.1-2)
diff --git a/data/doc/sisu/CHANGELOG_v6 b/data/doc/sisu/CHANGELOG_v6
index 07a9e838..2c213b8a 100644
--- a/data/doc/sisu/CHANGELOG_v6
+++ b/data/doc/sisu/CHANGELOG_v6
@@ -39,7 +39,9 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_6.4.0.orig.tar.xz
* CHANGELOGS formatted for viewing as org-mode files
indentation, line-breaking, and formatting characters only changes made
- * org files related to sisu, break up and place in own subdir
+ * org files related to sisu
+ * break up and place in own subdir
+ * org files, minor editing
** SiSU "UnFrozen" - prior to end of Debian Freeze
(upstream bugfix 6.3.2 (5.7.2) intended for Jessie (packaged for Debian as
diff --git a/data/doc/sisu/org/sisu.org b/data/doc/sisu/org/sisu.org
index 125cf9ae..56a3fe62 100644
--- a/data/doc/sisu/org/sisu.org
+++ b/data/doc/sisu/org/sisu.org
@@ -14,30 +14,28 @@ 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 sisu 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, EPUB, 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. Think being able to finely match
- text in documents, using common object numbers, across different output
- formats and across languages if you have translations of the same document.
- For search, your criteria is met by these documents at these locations within
- each document (equally relevant across different output formats and
- languages). To be clear (if obvious) page numbers provide none of this
- functionality. 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
- can also share provided semantic meta-data.
+ With minimal preparation of a plain-text (UTF-8) file, using sisu 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, EPUB, 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. Think of being able to finely match text in documents, using
+ common object numbers, across different output formats and across languages if
+ you have translations of the same document. For search, your criteria is met
+ by these documents at these locations within each document (equally relevant
+ across different output formats and languages). To be clear (if obvious) page
+ numbers provide none of this functionality. 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 can also share provided semantic meta-data.
.
SiSU also provides concordance files, document content certificates and
- manifests of generated output. SiSU provides the means to make book indexes
- that make use of its object numbering.
+ manifests of generated output and the means to make book indexes that make use
+ of its object numbering.
.
- A vim syntax highlighting file and an ftplugin with folds for sisu markup is
- provided. Vim 7 includes syntax highlighting for SiSU. Some syntax hilighting
- is also available for Emacs and a few other editors.
+ Syntax highlighting and folding (outlining) files are provided for the Vim and
+ Emacs editors.
.
Dependencies for various features are taken care of in sisu related packages.
The package sisu-complete installs the whole of SiSU.