diff options
author | Ralph Amissah <ralph@amissah.com> | 2015-04-25 13:50:40 -0400 |
---|---|---|
committer | Ralph Amissah <ralph@amissah.com> | 2015-04-25 13:50:40 -0400 |
commit | aeb7754510ffacc207b17e5d7512ff5f14debcc3 (patch) | |
tree | e2f17e3ad2ee4e1ea81287febe5049ce6fb82147 /data/doc/sisu/org/in_progress | |
parent | added patch jessie_bugfix_767761 (diff) | |
parent | version & changelog, tag for release (diff) |
Merge tag 'sisu_5.8.0' into debian/sid
SiSU 5.8.0
Conflicts:
.gitignore
data/doc/sisu/CHANGELOG_v5
data/doc/sisu/CHANGELOG_v6
data/sisu/v5/v/version.yml
data/sisu/v6/v/version.yml
setup/sisu_version.rb
Diffstat (limited to 'data/doc/sisu/org/in_progress')
-rw-r--r-- | data/doc/sisu/org/in_progress/sisu_asciidoc.org | 140 | ||||
-rw-r--r-- | data/doc/sisu/org/in_progress/sisu_docbook.org | 77 | ||||
-rw-r--r-- | data/doc/sisu/org/in_progress/sisu_fictionbook.org | 86 | ||||
-rw-r--r-- | data/doc/sisu/org/in_progress/sisu_markdown.org | 139 | ||||
-rw-r--r-- | data/doc/sisu/org/in_progress/sisu_rst.org | 236 | ||||
-rw-r--r-- | data/doc/sisu/org/in_progress/sisu_todo.org | 192 |
6 files changed, 870 insertions, 0 deletions
diff --git a/data/doc/sisu/org/in_progress/sisu_asciidoc.org b/data/doc/sisu/org/in_progress/sisu_asciidoc.org new file mode 100644 index 00000000..bd2ec738 --- /dev/null +++ b/data/doc/sisu/org/in_progress/sisu_asciidoc.org @@ -0,0 +1,140 @@ +***** urls +#% asciidoc +<http://asciidoc.org/> +<http://asciidoctor.org/> +<http://www.methods.co.nz/asciidoc/> +<http://en.wikipedia.org/wiki/AsciiDoc> + +cheatsheets +<http://powerman.name/doc/asciidoc> +<http://powerman.name/doc/asciidoc-index> + +<http://www.methods.co.nz/asciidoc/asciidoc.txt> +<http://www.methods.co.nz/asciidoc/userguide.html> + +<http://www.methods.co.nz/asciidoc/asciidoc.css-embedded.html> +<http://www.methods.co.nz/asciidoc/asciidoc.html> +<http://www.methods.co.nz/asciidoc/chunked/index.html> + +***** rb file +lib/sisu/v6/txt_asaciidoc.rb + +***** transformations :transformations:markup_asciidoc: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-4) (decoration) + [] inline + '== ' + '=== ' + '==== ' + '===== ' + '' + '' + [] underscore + '-' + '~' + '^' + '+' + '' ['.' proposed] + '' ['.' proposed] + [] node (child, parent ...) + +#% font face + [open & close marks] + [] bold + '*' + [] italics + '_' + [] underscore + '' + [] superscript + '^' + [] subscript + '~' + [] strike + '-' + [] add + [] monospace + '+' + '`' pass markup through unchanged, monospace code + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + [levels 1-6] + '*' + '**' + '***' + '****' + '*****' + '*******' + [] numbered list + [levels 1-3] + '. ' number + '.. ' lower alpha + '... ' lower roman + '.... ' upper alpha + '..... ' upper roman + +#% blocks + [] code + [source,perl] + ---- + code here + ---- + [] [type of markup if any] + [] poem + [] group + ---- + grouped text here, actually a listing block + ---- + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + http://google.com[Google Search] + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + "+\n" + forced + + line break + [] horizontal rule + [] column break + [] page break + +#% comment + [] comment + // + +#% misc + + [] term & definition +Term 1:: Definition 1 +Term 2:: Definition 2 +[horizontal] + Term 2.1;; + Definition 2.1 + Term 2.2;; + Definition 2.2 + diff --git a/data/doc/sisu/org/in_progress/sisu_docbook.org b/data/doc/sisu/org/in_progress/sisu_docbook.org new file mode 100644 index 00000000..7b1ac29b --- /dev/null +++ b/data/doc/sisu/org/in_progress/sisu_docbook.org @@ -0,0 +1,77 @@ +***** urls +#% docbook book xml.txt +<http://www.docbook.org> +<http://www.sagehill.net/docbookxsl/index.html> +<http://wiki.docbook.org/> +<http://www.docbook.org/tdg5/en/html/> +<http://www.docbook.org/tdg5/en/html/docbook.html> +<http://www.docbook.org/tdg5/en/html/ch01.html> +<http://www.docbook.org/tdg5/en/html/ch02.html> +<http://www.sagehill.net/docbookxsl/index.html> + +<http://www.docbook.org/schemas/5x> +<http://www.docbook.org/xml/5.0/> + +<http://infohost.nmt.edu/tcc/help/pubs/docbook5/web/index.html> + +<http://docbook.org/xml/5.0/rng/docbook.rng> +<http://docbook.org/xml/5.0/rng/docbook.rnc> + +<http://www.cuddletech.com/blog/pivot/entry.php?id=509> + +***** rb file +lib/sisu/v6/xml_docbook5.rb + +***** transformations :transform:markup_docbook: +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [] node (child, parent ...) + +#% font face + [] bold + [] italics + [] underscore + [] superscript + [] subscript + [] strike + [] add + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + +#% blocks + <http://www.docbook.org/tdg5/en/html/literallayout.html> + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + <http://www.docbook.org/tdg5/en/html/toc.html> + [] index (book index) + +#% misc + diff --git a/data/doc/sisu/org/in_progress/sisu_fictionbook.org b/data/doc/sisu/org/in_progress/sisu_fictionbook.org new file mode 100644 index 00000000..f689c30a --- /dev/null +++ b/data/doc/sisu/org/in_progress/sisu_fictionbook.org @@ -0,0 +1,86 @@ + +<http://en.wikipedia.org/wiki/FictionBook> +<http://fictionbook.org/index.php/Eng:FictionBook> +<http://fictionbook.org/index.php/Eng:Articles> +<http://fictionbook.org/index.php/Eng:Documentations> +<http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1> +<http://www.fictionbook.org/index.php/Eng:FictionBook> +<http://fictionbook-lib.org/> +<http://fictionbook-lib.org/browse.php> +<http://wiki.mobileread.com/wiki/FB2> + +***** rb file +lib/sisu/v6/xml_fictionbook2.rb + +***** transformations :transformations:markup_fictionbok: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [] node (child, parent ...) + +#% font face + [] bold + [] italics + [] underscore + [] superscript + [] subscript + [] strike + [] add + [] monospace + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + +#% blocks + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + [] column break + [] page break + +#% comment + [] comment + +#% misc + +<http://en.wikipedia.org/wiki/FictionBook> +<http://fictionbook.org/index.php/Eng:FictionBook> +<http://fictionbook.org/index.php/Eng:Articles> +<http://fictionbook.org/index.php/Eng:Documentations> +<http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1> +<http://www.fictionbook.org/index.php/Eng:FictionBook> + +<http://www.fictionbook.org/index.php/%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%B2_FB2> + +<https://addons.mozilla.org/en-US/firefox/addon/fb2-reader/> + diff --git a/data/doc/sisu/org/in_progress/sisu_markdown.org b/data/doc/sisu/org/in_progress/sisu_markdown.org new file mode 100644 index 00000000..0171f236 --- /dev/null +++ b/data/doc/sisu/org/in_progress/sisu_markdown.org @@ -0,0 +1,139 @@ + +***** urls + +#% markdown +<http://daringfireball.net/projects/markdown/> +<http://daringfireball.net/projects/markdown/syntax> +<http://daringfireball.net/projects/markdown/basics> +<http://en.wikipedia.org/wiki/Markdown> +<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet> +<http://whatismarkdown.com/> + +Markdown supports two styles of headers, Setext and atx +Setext +<http://docutils.sourceforge.net/mirror/setext.html> +<http://en.wikipedia.org/wiki/Setext> +atx +<http://www.aaronsw.com/2002/atx/intro> + +<http://support.iawriter.com/help/kb/general-questions/markdown-syntax-reference-guide> +<http://bywordapp.com/markdown/syntax.html> +<http://stackoverflow.com/editing-help> + +<http://support.mashery.com/docs/customizing_your_portal/Markdown_Cheat_Sheet> +<http://warpedvisions.org/projects/markdown-cheat-sheet.md> +<http://nestacms.com/docs/creating-content/markdown-cheat-sheet> +<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet> + +<https://help.github.com/articles/github-flavored-markdown> +<http://lifehacker.com/5943320/what-is-markdown-and-why-is-it-better-for-my-to+do-lists-and-notes> + +#% pandoc markdown +<http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html> +<http://johnmacfarlane.net/pandoc/README.html> +<http://johnmacfarlane.net/pandoc/demo/example19/Pandoc_0027s-markdown.html> +<http://johnmacfarlane.net/pandoc/> +<http://johnmacfarlane.net/pandoc/epub.html> +<http://johnmacfarlane.net/pandoc/faqs.html> + +#% multimarkdown +<http://fletcher.github.io/peg-multimarkdown/> + +#% markdown pandoc v multimarkdown +<https://github.com/jgm/pandoc/wiki/Pandoc-vs-Multimarkdown> + +#% rST v markdown +<http://stackoverflow.com/questions/34276/markdown-versus-restructuredtext> + +***** rb file +lib/sisu/v6/txt_markdown.rb + +***** transformations :transformations:markup_markdown: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [inline 1-5] + '#' + '##' + '###' + '####' + '#####' + '######' + [underscore 1-5] + '=' + '-' + #'~' + #'^' + #'+' + [] node (child, parent ...) + +#% font face + [open & close marks] + [] bold + '**' + [] italics + '*' + [] underscore + '' + [] superscript + '' + [] subscript + '' + [] strike + '' + [] add + [] monospace + '`' + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + '*' + [] numbered list + '0.' + +#% blocks + [] code + ' ' #indent at least 4 spaces + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [] [bibliography?] + +#% links, linking + [] links - external, web, url + [] links - internal + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + (three or more asterisks hypens or underscores) + * * * + *** + ***** + - - - + ___ + [] column break + [] page break + +#% misc + diff --git a/data/doc/sisu/org/in_progress/sisu_rst.org b/data/doc/sisu/org/in_progress/sisu_rst.org new file mode 100644 index 00000000..27a8ec25 --- /dev/null +++ b/data/doc/sisu/org/in_progress/sisu_rst.org @@ -0,0 +1,236 @@ + +***** urls +#% rST +<http://docutils.sourceforge.net/rst.html> +<http://docutils.sourceforge.net/docs/user/rst/quickref.html> +<http://docutils.sourceforge.net/docs/user/rst/quickstart.html> +<http://en.wikipedia.org/wiki/ReStructuredText> +<http://sphinx-doc.org/rest.html> + +<http://stackoverflow.com/questions/2746692/restructuredtext-tool-support> + +#% rST v markdown +<http://stackoverflow.com/questions/34276/markdown-versus-restructuredtext> + +***** rb file +lib/sisu/v6/txt_rst.rb + +***** transformations :transformations:markup_rst: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [inline] + N/A + [underscore] + Titles are underlined (or over- and underlined) with a printing + nonalphanumeric 7-bit ASCII character. Recommended choices are + "= - ` : ' " ~ ^ _ * + # < >". The underline/overline must be at + least as long as the title text. + '=' + '-' + '`' + ':' + "'" + '"' + + [] node (child, parent ...) + +#% font face + [] bold + '**' + [] italics + '*' + [] underscore + '+' + [] superscript + '^' + [] subscript + [] strike + '-' + [] add + [] monospace + '``' + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + "-", "*" or "+" + '-' + [] numbered list + '#.' + +#% blocks + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + +#% notes + [] footnotes + [binary] + Footnote references, like [5]_. + Note that footnotes may get + rearranged, e.g., to the bottom of + the "page". + .. [5] A numerical footnote. + -- + Autonumbered footnotes are + possible, like using [#]_ and [#]_. + .. [#] This is the first one. + .. [#] This is the second one. + + [] [bibliography?] + +#% links, linking + [] links - external, web, url + Typical result + External hyperlinks, like Python_. + .. _Python: <http://www.python.org/> + or + External hyperlinks, like `Python + <http://www.python.org/>`_. + [] links - internal + Internal crossreferences, like example_. + .. _example: + + This is an example crossreference target. + -- + Titles are targets, too + ======================= + Implict references, like `Titles are + targets, too`_. + +#% images [multimedia?] + [] images + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + [] column break + [] page break + +#% misc + +**** TODO [#F] textile :feature: + +***** urls +#% textile +<http://en.wikipedia.org/wiki/Textile_(markup_language)> +v2.4 +<http://www.txstyle.org/> +v2 +<http://redcloth.org/hobix.com/textile/> + +***** rb file +lib/sisu/v6/txt_textile.rb + +***** transformations :transformations:markup_textile: #% +#% structure - headings, levels + [] sisu (A-C, 1-3) + [] collapsed (1-6) (decoration) + [inline] + h1(#id). An HTML first-level heading + h2. An HTML second-level heading + h3. An HTML third-level heading + h4. An HTML fourth-level heading + h5. An HTML fifth-level heading + h6. An HTML sixth-level heading + [underscore] + N/A + + [] node (child, parent ...) + +#% font face + [] bold + *bold text* + [] italics + _italic text_ + [] underscore + +underlined text+ + [] superscript + ^TM^ + [] subscript + ~subscript~ + [] strike + -strikethrough text- + [] add + +#% para + [] default + [] indent + [] default, all + [] first line hang or indent further + [] bullet + * bulleted list + ** 2-level + +#% blocks + [] code + [] [type of markup if any] + [] poem + [] group + [] alt + [] tables + |Table | with two columns | + |and two | rows | + +#% notes + [] footnotes + Text with a link to some reference[1] + fn1. Footnote explanation + [] [bibliography?] + +#% links, linking + [] links - external, web, url + "(classname)link text(title tooltip)":link_address + "Link to Wikipedia":http://www.wikipedia.org + [] links - internal + +#% images [multimedia?] + [] images + !http://commons.wikimedia.org/wiki/Special:Filepath/Wikipedia-logo-en.png! + !imageurl(alt text)! + [] [base 64] + +#% object numbers + [] ocn (object numbers) + +#% contents + [] toc (table of contents) + [] index (book index) + +#% breaks + [] line break + [] horizontal rule + [] column break + [] page break + +#% misc + [] *_bold italic text_* + [] *-bold strikethrough text-* + [] *_-bold italic strikethrough text-_* + [] *+bold underlined text+* + [] *_+italic underlined text+_ + [] *_+bold italic underlined text+_ + [] *_-+bold italic strikethrough underlined text+-_* + %{font-size:18pt}font size% + %{color:red}text in red% + # Chapter 1 + +#% notes +heading inline only +footnotes uses marker and endnote, check + diff --git a/data/doc/sisu/org/in_progress/sisu_todo.org b/data/doc/sisu/org/in_progress/sisu_todo.org new file mode 100644 index 00000000..2bec4987 --- /dev/null +++ b/data/doc/sisu/org/in_progress/sisu_todo.org @@ -0,0 +1,192 @@ +* things i want +- vim style folds (setup like my .org mode like folds) working in both + - vim + - emacs +- elastic search +- outputs + - docbook + - asciidoc +- odt to sisu form? +- description of the focus of sisu as a smarttext, compared to + - asciidoc --> docbook; + - markdown --> natural writing, visually meaningful + - sisu --> identify document structure & objects +* proposals/additions + +** TODO [#B] markup indicate objects language where other than document default +at end of text object mark language from language code list (SiSU_is[:language_list_regex]) ~:ja + +to mark subsequent objects as being of a particular language ^:~(SiSU_is[:language_list_regex])$ +:~ja +to return to language default ^:~-$ +:~- +** TODO [#B] markup syntax code block, indicate syntax of code block :feature: +``` code:ruby + +** TODO [#C] colored boxes round text :feature:ponder: + ``` box:red (select color of box) + ``` box:warn ``` box:tip (some default boxes? decide) + ``` box:red:"Warn" (select color and lead text of box, else instead + select color box & use regular single line bold markup ^!_ Warn$) + +** TODO [#D] blockquotes implement? :feature:ponder: + ``` quote + not sure how best to represent + +** TODO [#D] bibliography :feature:ponder: + +** TODO speaker, as e.g. play (irc?) :feature:ponder: + ``` Ophelia: + ::Ophelia + +** TODO [#F] time stamp (e.g. for irc, video text?):feature:ponder: + ``` 04:03 + ``` 04:03 ... 07:12 + ``` 04:03 + 03:09 + ``` 12:04:03 + ``` 12:04:03 ... 12:07:12 + ``` 12:04:03 + 03:09 + probably not worth the effort, as time stamp is an alternative + identifying number (to ocn, and ∴ sisu objects not ideal) + +** TODO book index, alternative based on search within text + + +* Document Abstraction :sisu:doc_abstr: + +** TODO [#D] XML middle layer? + +*** XMLda sisu + consder alternative sisu layer in XML + +*** TODO [#D] RelaxNG sisu + +* Output :sisu:output: + +** New outputs to consider +*** elasticsearch +*** JSON for elasticsearch +*** XML :xml: +%% xml, docbook.txt fictionbook.txt xldl.txt lml.txt tei.txt emacs.txt +<http://xml.silmaril.ie/> +<http://www.xml.com/> +<http://programming.oreilly.com/2012/08/shrinking-and-stretching-the-boundaries-of-markup.htmlhttp://programming.oreilly.com/2012/08/shrinking-and-stretching-the-boundaries-of-markup.html> + +<http://broadcast.oreilly.com/2012/03/xmls-dialect-problem.html> + +xml editor vim emacs +<http://chimera.labs.oreilly.com/books/1234000000058/ch01.html#which_xml_editor_should_i_use> +nXML plugin +<http://blog.tommorris.org/post/2456183251/emacs-and-nxml-survival-guide> +<http://johnbokma.com/mexit/2008/10/01/nxml-emacs-how-to.html> +<http://www.emacswiki.org/cgi-bin/wiki/NxmlModeForXHTML> +<http://www.xmlhack.com/read.php_item=2061> +<http://infohost.nmt.edu/tcc/help/pubs/nxml/index.html> +emacs.txt evil.txt + +<http://www.oreillynet.com/xml/blog/2005/10/smart_quotes_and_more_in_vim_a.html> +<http://stackoverflow.com/questions/1430164/differences-between-emacs-and-vim> + +To validate a book.xml file using xmllint, run the following command: +$ xmllint --postvalid --xinclude --noout book.xml + +The default location where xmllint will look for the catalog file is +/etc/xml/catalog. Alternatively, you can set the environment variable +XML_CATALOG_FILES to define another default location for catalog +files. Once you’ve got the DTD and catalog set up locally, you can +validate as before: +$ xmllint --postvalid --xinclude --noout book.xml + +%% Docbook +sisu_docbook.org + +%% Fictionbook +sisu_fictionbook.org + +%% XLDL +xldl.txt + +%% Literature Markup Language +lml.txt + +%% Text Encoding Initiative +tei.txt + +**** TODO [#B] docbook :feature: +sisu_docbook.org + +**** TODO [#D] fictionbook :feature: + +***** urls + +**** TODO [#B] fictionbook :feature: +sisu_fictionbook.org + +**** TODO [#D] XLDL :feature: + +***** urls +%% xml.txt xldl - novels, stories, poems +Name: XLDL - an XML doctype for novels, stories, poems, playsName: XLDL - an XML doctype for novels, stories, poems, plays +<http://www.ister.org/code/xldl/> +<http://www.ister.org/code/xldl/doc/xldl.dtd.html> +<line> <stanza> + +**** TODO [#E] Literature Markup Language - <LML /> :feature: + +***** urls +%% Literature Markup Language - <LML /> +<http://hoffmann.bplaced.net/lml/> +"It is assumed, that there are three quite different techniques to provide text, +respectively three types of text, this is prose and poetry and code (for +example source code of computer programs or from markup languages)." +Suggestions and Ideas for Literature Markup Language - <LML /> 1.1 +<http://hoffmann.bplaced.net/lml/lml1.1.php> + +**** TODO [#E] TEI Lite (Text Encoding Initiative) :feature: + +***** urls +%% TEI Lite (Text Encoding Initiative) +<http://www.tei-c.org/Guidelines/Customization/Lite/> +<http://www.tei-c.org/release/doc/tei-p5-exemplars/html/tei_lite.doc.html> + +*** Text :txt: + +sisu_markup.txt asciidoc.txt markdown.txt textile.txt rst.txt + +**** TODO [#D] asciidoc :feature: +sisu_asciidoc.org + +**** TODO [#E] markdown :feature: +sisu_markdown.org + +**** TODO [#F] rst :feature: +sisu_rst.org + +** Improvements + +*** HTML + +*** XML + +*** --strict mode (html w3c compliant ocn etc.) + +* Code (ruby) :sisu:code: + +** code enhancements :enhance: + +*** TODO [#D] directory & path, use ruby directory tools + +*** TODO [#D] document url shortcut, allow addition of alternative dir stub +(e.g. viral Spiral) + +** code refactoring :refactor: + +*** ruby 2.1 + +*** TODO [#C] refactor ruby :ongoing: + +* Reference versions +** v5 +5.6.2 +5.6.1 +5.5.6 (5.5.5) |