sisu.org minor adjustment to opening description
authorRalph Amissah <ralph.amissah@gmail.com>
Fri, 10 Jul 2020 00:02:23 +0000 (20:02 -0400)
committerRalph Amissah <ralph.amissah@gmail.com>
Tue, 1 Dec 2020 00:10:54 +0000 (19:10 -0500)
data/doc/sisu/org/sisu.org

index e2933b1ba2957ca5d8efe0b2af8a55c24c749e4f..e7f3e7e94a28d466000cb5aa7efe78800fbcedc5 100644 (file)
@@ -1,7 +1,7 @@
 #+TITLE: SiSU
 #+AUTHOR: Ralph Amissah
 #+EMAIL: ralph.amissah@gmail.com
-#+STARTUP: indent content
+#+STARTUP: content
 #+LANGUAGE: en
 #+OPTIONS: H:3 num:nil toc:t \n:nil @:t ::t |:t ^:nil _:nil -:t f:t *:t <:t
 #+OPTIONS: TeX:t LaTeX:t skip:nil d:nil todo:t pri:nil tags:not-in-toc
 #+EXPORT_SELECT_TAGS: export
 #+EXPORT_EXCLUDE_TAGS: noexport
 #+FILETAGS: :sisu:notes:
-(emacs:evil mode gifts a "vim" of enticing "alternative" powers! ;)
-(vim, my _editor_ of choice also in the emacs environment :)
 
 * 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.
+SiSU is a document generator that run against (sisu) marked up documents
+produces multiple document formats with a nod to the strengths of each document
+format while making them easily citable across available formats.
 
 ** debian/control desc
 
@@ -251,6 +250,7 @@ Document structure being the document heading hierarchy (having separated out
 the document header).
 
 *** 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.
 
@@ -320,6 +320,7 @@ html, LaTeX, XML, SQL, (whatever) is also inherent in / incidental to the
 design.
 
 ** Summary
+
 SiSU information Structuring Universe
 Structured information, Serialized Units    <www.sisudoc.org>   or
 <www.jus.uio.no/sisu/> software for electronic texts, document collections,
@@ -547,23 +548,31 @@ cover a wide range of documents within its use domain have been explored.
 <http://lists.sisudoc.org/listinfo/sisu>
 2010
 w3 since October 3 1993
+
 * Finding SiSU
 ** source
+
 http://git.sisudoc.org/gitweb/
 
 *** sisu
+
 sisu git repo:
 http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary
 
 **** most recent source without repo history
+
 git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream
+
 **** full clone
+
 git clone git://git.sisudoc.org/git/code/sisu.git --branch upstream
 
 *** sisu-markup-samples git repo:
+
 http://git.sisudoc.org/gitweb/?p=doc/sisu-markup-samples.git;a=summary
 
 ** mailing list
+
 sisu at lists.sisudoc.org
 http://lists.sisudoc.org/listinfo/sisu
 
@@ -764,6 +773,7 @@ The package is divided into the following components:
 ** markup                                                            :markup:
 
 *** sisu document parts
+
 - header
   - metadata
   - make instructionS
@@ -801,6 +811,7 @@ The package is divided into the following components:
 |---------------------+-----------------------------------------------------------------------+------------------------+--------|
 
 *** structure - headings, levels
+
 - headings (A-D, 1-3)
 
 'A~ ' NOTE title level
@@ -818,6 +829,7 @@ The package is divided into the following components:
     * children
 
 ***  font face NOTE open & close marks, inline within paragraph
+
   * emphasize '*{ ... }*' NOTE configure whether bold italics or underscore, default bold
   * bold '!{ ... }!'
   * italics '/{ ... }/'
@@ -829,6 +841,7 @@ The package is divided into the following components:
   * monospace '#{ ... }#'
 
 *** para
+
 NOTE paragraph controls are at the start of a paragraph
   * a para is a block of text separated from others by an empty line
   * indent
@@ -845,6 +858,7 @@ NOTE paragraph controls are at the start of a paragraph
       '# '
 
 *** blocks
+
 NOTE text blocks that are not to be treated in the way that ordinary paragraphs would be
   * code
     * [type of markup if any]
@@ -854,23 +868,28 @@ NOTE text blocks that are not to be treated in the way that ordinary paragraphs
   * tables
 
 *** notes (footnotes/ endnotes)
+
  NOTE inline within paragraph at the location where the note reference is to occur
   * footnotes '~{ ... }~'
   * [bibliography] [NB N/A not implemented]
 
 *** links, linking
+
   * links - external, web, url
   * links - internal
 
 *** images [multimedia?]
+
   * images
   * [base64 inline] [N/A not implemented]
 
 *** object numbers
+
   * ocn (object numbers)
     automatically attributed to substantive objects, paragraphs, tables, blocks, verse (unless exclude marker provided)
 
 *** contents
+
   * toc (table of contents)
     autogenerated from structure/headings information
   * index (book index)
@@ -883,7 +902,9 @@ NOTE text blocks that are not to be treated in the way that ordinary paragraphs
   * horizontal '-..-' start of line, rule page (break) line across page (dividing paragraphs)
 
 *** book type index
-built from hints in newline text following a paragraph and starting with ={} has identifying rules for main and subsidiary text
+
+built from hints in newline text following a paragraph and starting with ={} has
+identifying rules for main and subsidiary text
 
 #% comment
   * comment
@@ -894,12 +915,15 @@ built from hints in newline text following a paragraph and starting with ={} has
 ** syntax highlighting                                  :syntax:highlighting:
 
 *** vim
+
 data/sisu/conf/editor-syntax-etc/vim/
 data/sisu/conf/editor-syntax-etc/vim/syntax/sisu.vim
 
 *** emacs
+
 data/sisu/conf/editor-syntax-etc/emacs/
 data/sisu/conf/editor-syntax-etc/emacs/sisu-mode.el
 
 * todo
+
 sisu_todo.org