aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/org/in_progress/sisu_todo.org
blob: 2bec49879275ab1576fedbd407db6358cc2b72ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
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)