summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--data/doc/sisu/CHANGELOG_v72
-rw-r--r--data/doc/sisu/org/sisu.org110
2 files changed, 83 insertions, 29 deletions
diff --git a/data/doc/sisu/CHANGELOG_v7 b/data/doc/sisu/CHANGELOG_v7
index 9fe6592..9890367 100644
--- a/data/doc/sisu/CHANGELOG_v7
+++ b/data/doc/sisu/CHANGELOG_v7
@@ -28,6 +28,8 @@ Reverse Chronological:
* sisu-mode.el as committed to Gnu elpa
* re-submitted after feedback (on 7.1.7) from Stefan Monnier
+ * sisu.org add to header and minor update
+
* sisu_7.1.7.orig.tar.xz (Open commit window: 2015-12-29; Pre-Release)
http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=log;h=refs/tags/sisu_7.1.7
diff --git a/data/doc/sisu/org/sisu.org b/data/doc/sisu/org/sisu.org
index 38dd3b3..e2933b1 100644
--- a/data/doc/sisu/org/sisu.org
+++ b/data/doc/sisu/org/sisu.org
@@ -1,5 +1,15 @@
-#+OPTIONS: ^:nil _:nil
+#+TITLE: SiSU
+#+AUTHOR: Ralph Amissah
+#+EMAIL: ralph.amissah@gmail.com
+#+STARTUP: indent 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
+#+OPTIONS: author:nil email:nil creator:nil timestamp:nil
#+PRIORITIES: A F E
+#+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 :)
@@ -749,26 +759,65 @@ The package is divided into the following components:
** Arch Linux
-* sisu markup :sisu:markup:
-
-** sisu markup
-
-#% structure - headings, levels
- * headings (A-D, 1-3)
- * inline
- 'A~ ' NOTE title level
- 'B~ ' NOTE optional
- 'C~ ' NOTE optional
- 'D~ ' NOTE optional
- '1~ ' NOTE chapter level
- '2~ ' NOTE optional
- '3~ ' NOTE optional
- '4~ ' NOTE optional :consider:
+* sisu markup :sisu:
+
+** markup :markup:
+
+*** sisu document parts
+- header
+ - metadata
+ - make instructionS
+- substantive (& other) content
+ (sisu markup)
+- endnotes
+ (markup within substantive content)
+- glossary
+ (section, special markup)
+- bibliography
+ (section, special markup)
+- book index
+ (markup attached to substantive content objects)
+
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| header | sisu /header markup/ | markup | |
+| - metadata | | | |
+| - make instructions | | | |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| substantive content | sisu /content markup/ | markup | output |
+| | headings (providing document structure), paragraphs, | (regular content) | |
+| | blocks (code, poem, group, table) | | |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| endnotes | markup within substantive content | markup | output |
+| | (extracted from sisu /content markup/) | (from regular content) | |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| glossary | identify special section, regular /content markup/ | markup | output |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| bibliography | identify section, special /bibliography markup/ | markup | output |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| book index | extracted from markup attached to related substantive content objects | markup | output |
+| | (special tags in sisu /content markup/) | (from regular content) | |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+| metadata | | (from regular header) | output |
+|---------------------+-----------------------------------------------------------------------+------------------------+--------|
+
+*** structure - headings, levels
+- headings (A-D, 1-3)
+
+'A~ ' NOTE title level
+
+'B~ ' NOTE optional
+'C~ ' NOTE optional
+'D~ ' NOTE optional
+
+'1~ ' NOTE chapter level
+'2~ ' NOTE optional
+'3~ ' NOTE optional
+
* node
* parent
* children
-#% font face NOTE open & close marks, inline within paragraph
+*** font face NOTE open & close marks, inline within paragraph
* emphasize '*{ ... }*' NOTE configure whether bold italics or underscore, default bold
* bold '!{ ... }!'
* italics '/{ ... }/'
@@ -778,7 +827,9 @@ The package is divided into the following components:
* strike '-{ ... }-'
* add '+{ ... }+'
* monospace '#{ ... }#'
-#% para NOTE paragraph controls are at the start of a paragraph
+
+*** 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
* default, all '_1 ' up to '_9 '
@@ -793,45 +844,46 @@ The package is divided into the following components:
[levels 1-3]
'# '
-#% blocks NOTE text blocks that are not to be treated in the way that ordinary paragraphs would be
+*** blocks
+NOTE text blocks that are not to be treated in the way that ordinary paragraphs would be
* code
* [type of markup if any]
* poem
* group
* alt
* tables
-#% boxes
- NOTE grouped text with code block type color & possibly default image, warning, tip, red, blue etc. decide [NB N/A not implemented]
-#% notes NOTE inline within paragraph at the location where the note reference is to occur
+*** 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, linking
* links - external, web, url
* links - internal
-#% images [multimedia?]
+*** images [multimedia?]
* images
* [base64 inline] [N/A not implemented]
-#% object numbers
+*** object numbers
* ocn (object numbers)
automatically attributed to substantive objects, paragraphs, tables, blocks, verse (unless exclude marker provided)
-#% contents
+*** contents
* toc (table of contents)
autogenerated from structure/headings information
* index (book index)
built from hints in newline text following a paragraph and starting with ={} has identifying rules for main and subsidiary text
-#% breaks
+*** breaks
* line break ' \\ ' inline
* page break, column break ' -\\- ' start of line, breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.
* page break, page new ' =\\= ' start of line, breaks the page, starts a new page.
* horizontal '-..-' start of line, rule page (break) line across page (dividing paragraphs)
-#% book type index
+*** book type index
+built from hints in newline text following a paragraph and starting with ={} has identifying rules for main and subsidiary text
#% comment
* comment
@@ -839,7 +891,7 @@ The package is divided into the following components:
#% misc
* term & definition
-** syntax hilighting
+** syntax highlighting :syntax:highlighting:
*** vim
data/sisu/conf/editor-syntax-etc/vim/