|
|
SiSU Markup Ralph Amissah copy @ SiSU |
Rights: Copyright © Ralph Amissah 2007, part of SiSU documentation, License GPL 3
SiSU - Markup,
|
1 |
SiSU Markup |
2 |
1. Introduction to SiSU Markup 1 |
3 |
1.1 Summary |
4 |
SiSU source documents are plaintext (UTF-8) 2 files |
5 |
6 |
7 |
|
10 |
|
11 |
|
12 |
|
13 |
|
14 |
|
15 |
Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup |
16 |
1.2 Markup Examples |
17 |
1.2.1 Online |
18 |
Online markup examples are available together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/2.html> or from <http://www.jus.uio.no/sisu/sisu_examples/> |
19 |
There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/> |
20 |
Some example marked up files are available as html with syntax highlighting for viewing: <http://www.jus.uio.no/sisu/sample/syntax> |
21 |
an alternative presentation of markup syntax: <http://www.jus.uio.no/sisu/sample/on_markup.txt> |
22 |
1.2.2 Installed |
23 |
2. Markup of Headers |
25 |
Headers consist of semantic meta-data about a document, which can be used by any output module of the program; and may in addition include extra processing instructions. |
26 |
28 |
2.1 Sample Header |
29 |
This current document has a header similar to this one (without the comments): |
30 |
2.2 Available Headers |
32 |
34 |
where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified |
35 |
Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know. |
36 |
37 |
% SiSU 0.38 [declared file-type identifier with markup version] |
38 |
@title: [title text] This is the title of the document and used as such, this header is the only one that is mandatory |
39 |
40 |
41 |
42 |
43 |
44 |
45 |
46 |
47 |
48 |
@date: 2000-08-27 [ also @date.created: @date.issued: @date.available: @date.valid: @date.modified: ] |
49 |
50 |
51 |
52 |
53 |
[@language.original: original language in which the work was published] |
55 |
56 |
57 |
58 |
@rights: Copyright (c) Name of Right Holder, all rights reserved, or as granted: public domain, copyleft, creative commons variant, etc. |
59 |
60 |
@keywords: text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches] |
61 |
62 |
63 |
@catalogue: loc=[Library of Congress classification]; dewey=[Dewey classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] |
64 |
65 |
66 |
67 |
68 |
69 |
@prefix_a: [prefix is placed just before table of contents - not implemented] |
70 |
71 |
@level: newpage=3; breakpage=4 |
74 |
@bold: [regular expression of words/phrases to be made bold] |
76 |
@italics: [regular expression of words/phrases to italicise] |
77 |
@vocabulary: name of taxonomy/vocabulary/wordlist to use against document |
78 |
@links: { SiSU }http://www.jus.uio.no/sisu/; |
80 |
3. Markup of Substantive Text |
82 |
3.1 Heading Levels |
83 |
:A~ [heading text] Top level heading [this usually has similar content to the title @title: ] NOTE: the heading levels described here are in 0.38 notation, see heading |
85 |
:B~ [heading text] Second level heading [this is a heading level divider] |
86 |
:C~ [heading text] Third level heading [this is a heading level divider] |
87 |
2~ [heading text] Second level heading preceding substantive text of document or sub-heading 3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. |
89 |
3~ [heading text] Third level heading preceding substantive text of document, that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document |
90 |
3.2 Font Attributes |
92 |
93 |
95 |
normal text emphasis bold text underscore italics citation superscript subscript inserted text |
96 |
97 |
98 |
99 |
100 |
101 |
102 |
103 |
104 |
105 |
106 |
3.3 Indentation and bullets |
107 |
108 |
ordinary paragraph |
109 |
110 |
111 |
112 |
113 |
114 |
115 |
_* bullet text |
116 |
117 |
|
118 |
|
119 |
|
120 |
Numbered List (not to be confused with headings/titles, (document structure)) |
121 |
122 |
# numbered list numbered list 1., 2., 3, etc. |
123 |
3.4 Footnotes / Endnotes |
124 |
126 |
127 |
128 |
129 |
130 |
normal text~{ self contained endnote marker & endnote in one }~ continues |
131 |
132 |
normal text 4 continues |
133 |
134 |
normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues |
135 |
136 |
normal text * continues |
137 |
normal text ** continues |
138 |
139 |
normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues |
140 |
141 |
normal text *1 continues |
142 |
normal text +1 continues |
143 |
144 |
% note the endnote marker "~^" |
145 |
the standard and pair notation cannot be mixed in the same document |
146 |
3.5 Links |
147 |
3.5.1 Naked URLs within text, dealing with urls |
148 |
150 |
151 |
152 |
normal text <http://www.jus.uio.no/sisu> continues |
153 |
154 |
155 |
normal text _http://www.jus.uio.no/sisu continues |
156 |
157 |
normal text http://www.jus.uio.no/sisu continues |
158 |
deb http://www.jus.uio.no/sisu/archive unstable main non-free |
159 |
where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document |
160 |
161 |
deb http://www.jus.uio.no/sisu/archive unstable main non-free |
162 |
163 |
164 |
165 |
3.5.2 Linking Text |
166 |
167 |
about SiSU markup |
168 |
A shortcut notation is available so the url link may also be provided automatically as a footnote |
169 |
170 |
171 |
172 |
173 |
3.5.3 Linking Images |
174 |
175 |
177 |
178 |
179 |
[ ruby_logo (png missing) ] 6 |
180 |
181 |
182 |
184 |
3.6 Grouped Text |
186 |
3.6.1 Tables |
187 |
188 |
189 |
191 |
|
192 |
a second form may be easier to work with in cases where there is not much information in each column |
193 |
markup example: 7 |
194 |
196 |
Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 |
197 |
|
198 |
* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. |
199 |
3.6.2 Poem |
200 |
201 |
poem{ |
202 |
203 |
205 |
3.6.3 Group |
207 |
208 |
group{ |
209 |
210 |
212 |
3.6.4 Code |
214 |
A code-block is treated as an object and given a single object number. [an option to number each line of code may be considered at some later time] |
216 |
use of code tags instead of poem compared, resulting output: |
217 |
4. Composite documents markup |
219 |
basic markup for importing a document into a master document |
221 |
222 |
Markup Syntax History |
225 |
5. Notes related to Files-types and Markup Syntax |
226 |
0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37 |
227 |
0.52 (2007w14/6) declared document type identifier at start of text/document: |
228 |
229 |
230 |
231 |
variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' |
232 |
0.51 (2007w13/6) skins changed (simplified), markup unchanged |
233 |
0.42 (2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author |
234 |
0.38 (2006w15/7) introduced new/alternative notation for headers, e.g. @title: (instead of 0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) |
235 |
0.37 (2006w09/7) introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged |
236 |
237 |
238 |
0.22 (2005w35/3) image dimensions may be omitted if rmagick is available to be relied upon |
239 |
240 |
0.16 (2005w25/2) substantial changes introduced to make markup cleaner, header 0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start of a text line as comment marker |
241 |
Endnotes |
0 |
1. From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful. |
2. files should be prepared using UTF-8 character encoding |
3. a footnote or endnote |
4. self contained endnote marker & endnote in one |
* unnumbered asterisk footnote/endnote, insert multiple asterisks if required |
** another unnumbered asterisk footnote/endnote |
*1. editors notes, numbered asterisk footnote/endnote series |
+1. editors notes, numbered asterisk footnote/endnote series |
7. Table from the Wealth of Networks by Yochai Benkler |
Document Information (metadata) |
0 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html> |
Dublin Core (DC) |
DC tags included with this document are provided here. |
DC Title: SiSU - Markup |
DC Creator: Ralph Amissah |
DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 |
DC Type: information |
DC Date created: 2002-08-28 |
DC Date issued: 2002-08-28 |
DC Date available: 2002-08-28 |
DC Date modified: 2007-09-16 |
DC Date: 2007-09-16 |
Version Information |
Sourcefile: sisu_markup.sst |
Filetype: SiSU text 0.58 |
Sourcefile Digest, MD5(sisu_markup.sst)= 6848f40f5844e0a7d59dbb86b3ddae92 |
Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/builds/sisu/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= 20fc43cf3eb6590bc3399a1aef65c5a9 |
Generated |
Document (metaverse) last generated: Tue Sep 25 02:53:09 +0100 2007 |
Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) |
Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] |
|
|
Output generated by
SiSU
0.59.1 2007-09-25 (2007w39/2)
|
SiSU using:
| |
SiSU is released under GPLv3 or later, <http://www.gnu.org/licenses/gpl.html> |
SiSU, developed using
Ruby
on
Debian/Gnu/Linux
software infrastructure,
with the usual GPL (or OSS) suspects.
|