aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst
blob: 2fe64318a17a0cb9ffad4544427062425aee6544 (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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
% SiSU 2.0

@title: SiSU
 :subtitle: Markup Samples, Output Examples

@creator:
 :author: Amissah, Ralph

@classify:
 :type: information
 :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples
 :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search

% used_by: SiSU.ssm

@rights:
 :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3

@date:
 :created: 2002-11-12
 :issued: 2002-11-12
 :available: 2002-11-12
 :published: 2007-09-16
 :modified: 2011-02-07

@make:
 :num_top: 1
 :breaks: new=C; break=1
 :skin: skin_sisu_manual
% :bold: /Gnu|Debian|Ruby|SiSU/

@links:
 { SiSU Homepage }http://www.sisudoc.org/
 { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
 { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
 { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
 { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
 { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary
 { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/
 { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
 { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
 { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU

:A~? @title @creator

:B~? SiSU Markup and Output Examples

1~examples Markup and Output Examples

2~ Markup examples *~markup

Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html

For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are.

<:pb>

2~ A few book (and other) examples *~books *~sample *~example *~output

3~viral_spiral /{"Viral Spiral"}/, David Bollier

{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst

3~wealth_of_networks- /{"The Wealth of Networks"}/, Yochai Benkler

{ "The Wealth of Networks", Yochai Benkler [3sS]}the_wealth_of_networks.yochai_benkler.sst

3~two_bits- /{"Two Bits"}/, Christopher Kelty

{ "Two Bits", Christopher Kelty [3sS]}two_bits.christopher_kelty.sst

3~freeculture- /{"Free Culture"}/, Lawrence Lessig

{ "Free Culture", Lawrence Lessig [3sS]}free_culture.lawrence_lessig.sst

3~content- /{"CONTENT"}/, Cory Doctorow *~doctorow

{ "CONTENT", Cory Doctorow [3sS]}content.cory_doctorow.sst *~content

3~democratizing_innovation- /{"Democratizing Innovation"}/, by Eric von Hippel

{ "Democratizing Innovation", by Eric von Hippel [3sS]}democratizing_innovation.eric_von_hippel.sst

3~free_as_in_freedom- /{"Free as in Freedom: Richard Stallman's Crusade for Free Software"}/, by Sam Williams

{ "Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams [3sS]}free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst

3~free_for_all- /{"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans"}/, by Peter Wayner

{ "Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner [3sS]}free_for_all.peter_wayner.sst

3~catb- /{"The Cathedral and the Bazaar"}/, by Eric S. Raymond

{ "The Cathedral and the Bazaar", by Eric S. Raymond [3sS]}the_cathedral_and_the_bazaar.eric_s_raymond.sst

3~magickingdom- /{"Down and out in the Magic Kingdom"}/, Cory Doctorow *~doctorow

{ "Down and out in the Magic Kingdom", Cory Doctorow [3sS]}down_and_out_in_the_magic_kingdom.cory_doctorow.sst *~magickingdom

3~littlebrother- /{"Little Brother"}/, Cory Doctorow

{ "Little Brother", Cory Doctorow [3sS]}little_brother.cory_doctorow.sst *~littlebrother

3~ftw- /{"For the Win"}/, Cory Doctorow

{ "For the Win", Cory Doctorow [3sS]}for_the_win.cory_doctorow.sst *~ftw

3~accelerando- /{"Accelerando"}/, Charles Stross *~stross

{ "Accelerando", Charles Stross [3sS]}accelerando.charles_stross.sst *~accelerando

3~tainaron- /{"Tainaron"}/, Leena Krohn *~krohn

{ "Tainaron", Leena Krohn [3sS]}tainaron.leena_krohn.1998.sst *~tainaron

3~sphinx- /{"Sphinx or Robot"}/, Leena Krohn *~sor

{ "Sphinx or Robot", Leena Krohn [3sS]}sphinx_or_robot.leena_krohn.1996.sst

3~war_and_peace- /{"War and Peace"}/, Leo Tolstoy, PG Etext 2600 *~wap *~gutenberg

{ "War and Peace", Leo Tolstoy [3sS]}war_and_peace.leo_tolstoy.sst ~{ http://www.jus.uio.no/sisu/war_and_peace.leo_tolstoy/toc.html <br> The ascii text was taken from Project Gutenberg. The markup transforms required are trivial. Of interest, in this instance I am saved by having alternative syntaxes/(structural modes) for marking up endnotes... as it was possible to do a simple search and replace to make the Project Gutenberg ascii presentation suitable for SiSU, using the older endnote markup style. This example instructs the program to use regular expressions, in this example the words: none; none; BOOK|FIRST|SECOND; CHAPTER; occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). Note that there was _{very little markup required}_ after the document headers and Project Gutenberg legal notices. As I presume the legal notices are similar in Project Gutenberg documents, (and I could not bear to think of preparing the same legal notices twice), I moved those to the "skin" for the Project, and these are now represented in the markup by \<:insert1\> and \<:insert2\> and the legal notices are available for similar insertion into the next Project Gutenberg text prepared for SiSU, should there be one. <br> I did a stylesheet/skin for the Gutenberg Project, ... I may have to remove. }~

3~quixote- /{"Don Quixote"}/, Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996

{ "Don Quixote", Miguel de Cervantes [Saavedra] [3sS]}don_quixote.miguel_de_cervantes.sst

3~gulliver- /{"Gulliver's Travels"}/, Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829 *~swift

{ "Gulliver's Travels", Jonathan Swift [3sS]}gullivers_travels.jonathan_swift.sst

3~alice- /{"Alice's Adventures in Wonderland"}/, Lewis Carroll, PG Etext 11

{ "Alice's Adventures in Wonderland", Lewis Carroll [3sS]}alices_adventures_in_wonderland.lewis_carroll.sst

3~glass- /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etext 12

{ "Through The Looking-Glass", Lewis Carroll [3sS]}through_the_looking_glass.lewis_carroll.sst

3~alice- /{"Alice's Adventures in Wonderland"}/ and /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etexts 11 and 12

{ "Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll [3sS]}alices_adventures_in_wonderland_and_through_the_looking_glass.lewis_carroll.ssm

3~gpl- /{"Gnu Public License 2"}/, (GPL 2) Free Software Foundation

{ "Gnu Public License 2", (GPL 2) Free Software Foundation [3sS]}gpl2.fsf.sst

3~gpl- /{"Gnu Public License v3 - Third discussion draft"}/, (GPLv3) Free Software Foundation

{ "Gnu Public License 3 - Third discussion draft", (GPL v3 draft3) Free Software Foundation [3sS]}gpl3_draft3.fsf.sst

3~dsc- /{"Debian Social Contract"}/

{ "Debian Social Contract" [3sS]}debian_social_contract_v1.1.sst

3~dc- /{"Debian Constitution v1.3"}/, (simple/default markup)

{ "Debian Constitution v1.3" [3sS]}debian_constitution_v1.3.sst

3~dc- /{"Debian Constitution v1.3"}/, (markup adjusted for output to more closely match the original)

{ "Debian Constitution v1.3", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.3.adjusted.sst

3~dc- /{"Debian Constitution v1.2"}/, (simple/default markup)

{ "Debian Constitution v1.2 (more translations)" [3sS]}debian_constitution_v1.2.sst

3~dc- /{"Debian Constitution v1.2"}/, (markup adjusted for output to more closely match the original)

{ "Debian Constitution (more translations)", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.2.adjusted.sst

3~terminology- /{"A Uniform Sales Terminology"}/, Vikki Rogers and Albert Kritzer

{ "A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer [3sS]}a_uniform_international_sales_terminology.vikki_rogers.and.albert_kritzer.sst

3~autonomous- /{"The Autonomous Contract" 1997 }/ - markup sample

{ "The Autonomous Contract" 1997 - markup sample [3sS]}the_autonomous_contract.amissah.19970710.sst

3~autonomous- /{"The Autonomous Contract Revisited"}/ - markup sample

{ "The Autonomous Contract Revisited" - markup sample [3sS]}autonomy_markup0.sst ~{ http://www.jus.uio.no/sisu/autonomy_markup0/toc.html <br> alternative markup variations revolving around endnotes<br> (i) as above, markup with embedded endnotes, and header list of words/phrases to emphasise<br> http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup0.sst.html <br> http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst <br>(ii) Again markup with embedded endnotes, but font faces changed within paragraphs rather than in header as in i <br> http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup1.sst.html <br> http://www.jus.uio.no/sisu/sample/markup/autonomy_markup1.sst <br> (iii) Markup with endnote placemarks within paragraphs, the endnotes following the paragraph that contains them http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup2.sst.html <br> http://www.jus.uio.no/sisu/sample/markup/autonomy_markup2.sst <br>(iv) Another alternative is to place the marked up endnotes sequentially and at the end of the text. This also works. The paragraph variant iii is perhaps easier to visually check should there be missing endnotes; but this variant iv may better suit the conversion of alternatively pre-prepared documents. }~

3~cisg- /{"United Nations Convention on Contracts for the International Sale of Goods"}/

{ "United Nations Convention on Contracts for the International Sale of Goods" [3sS]}un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html <br>This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). <br>This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). }~

3~pecl- /PECL/ the "Principles of European Contract Law"

{ "Principles of European Contract Law" [3sS]}eu_contract_principles_parts_1_to_3_2002.sst

2~sql SQL - PostgreSQL, SQLite

A Sample search form is available at http://search.sisudoc.org

A few canned searches, showing object numbers. Search for:

_1 { English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=index

_1 { GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=index

_1 { invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=index

_1 { copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=index

Note that the searches done in this form are case sensitive.

Expand those same searches, showing the matching text in each document:

_1 { Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=text

_1 { GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=text

_1 { invention OR innovation in English language }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=text

_1 { copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=text

Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~

2~ Lex Mercatoria as an example

There is quite a bit to peruse if you explore the site Lex Mercatoria:

http://www.lexmercatoria.org/ ~{ http://www.jus.uio.no/lm/index }~

or perhaps:

http://lexmercatoria.org/treaties.and.organisations/lm.chronological ~{ http://www.jus.uio.no/lm/treaties.and.organisations/lm.chronological }~

2~ For good measure the markup for a document with lots of (simple) tables

SiSU is not optimised for table making, but does handle simple tables.

_* {~^ Output of table file example }http://www.jus.uio.no/lm/un.conventions.membership.status/toc.html

2~ And a link to the output of a reported case

http://www.jus.uio.no/lm/england.fothergill.v.monarch.airlines.hl.1980/toc.html