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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
|
<!-- manual page source format generated by PolyglotMan v3.2, -->
<!-- available at http://polyglotman.sourceforge.net/ -->
<html>
<head>
<title>"sisu_markup"("1") manual page</title>
</head>
<body bgcolor='white'>
<a href='#toc'>Table of Contents</a><p>
SISU - MARKUP [0.58], RALPH AMISSAH
<p> SISU MARKUP
<p> 1. INTRODUCTION TO SISU
MARKUP[^1]
<p> 1.1 SUMMARY
<p> <b>SiSU</b> source documents are plaintext (UTF-8)[^2]
<p>files
<p> All paragraphs are separated by an empty line.
<p> Markup is comprised
of:
<p> * at the top of a document, the document header made up of semantic
meta-data about the document and if desired additional processing instructions
(such an instruction to automatically number headings from a particular
level down)
<p> * followed by the prepared substantive text of which the
most important single characteristic is the markup of different heading
levels, which define the primary outline of the document structure. Markup
of substantive text includes:
<p> * heading levels defines document structure<br>
<p> * text basic attributes, italics, bold etc.<br>
<p> * grouped text (objects), which are to be treated differently, such
as code<br>
blocks or poems.<br>
<p> * footnotes/endnotes<br>
<p> * linked text and images<br>
<p> * paragraph actions, such as indent, bulleted, numbered-lists, etc.<br>
<p> Some interactive help on markup is available, by typing sisu and selecting
<p>markup or sisu --help markup
<p> 1.2 MARKUP EXAMPLES
<p> 1.2.1 ONLINE
<p> Online markup
examples are available together with the respective outputs produced from
<<a href='http://www.jus.uio.no/sisu/SiSU/2.html'>http://www.jus.uio.no/sisu/SiSU/2.html</a>
> or from <<a href='http://www.jus.uio.no/sisu/sisu_examples/'>http://www.jus.uio.no/sisu/sisu_examples/</a>
>
<p> There is of course this document, which provides a cursory overview of
sisu markup and the respective output produced: <<a href='http://www.jus.uio.no/sisu/sisu_markup/'>http://www.jus.uio.no/sisu/sisu_markup/</a>
>
<p> Some example marked up files are available as html with syntax highlighting
for viewing: <<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a>
>
<p> an alternative presentation
of markup syntax: <<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a>
>
<p> 1.2.2 INSTALLED
<p> With <b>SiSU</b> installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg
(or equivalent directory) and if sisu-markup-samples is installed also under:
<p>/usr/share/doc/sisu/sisu_markup_samples/non-free
<p> 2. MARKUP OF HEADERS
<p>
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.
<p> Note: the first line of a document may include
information on the markup version used in the form of a comment. Comments
are a percentage mark at the start of a paragraph (and as the first character
in a line of text) followed by a space and the comment:
<p>
<p> <br>
<pre> % this would be a comment
</pre>
<p> 2.1 SAMPLE HEADER
<p> This current document has a header similar to this
one (without the comments):
<p>
<p> <br>
<pre> % SiSU 0.57
@title: SiSU
@subtitle: Markup [0.58]
@creator: Ralph Amissah
@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation,
License GPL 3
@type: information
@subject: ebook, epublishing, electronic book, electronic publishing,
electronic document, electronic citation, data structure, citation systems,
search
@date.created: 2002-08-28
@date.issued: 2002-08-28
@date.available: 2002-08-28
@date.modified: 2007-09-16
@date: 2007-09-16
@level: new=C; break=1; num_top=1
% comment: in this @level header num_top=1 starts automatic heading numbering
at heading level 1 (numbering continues 3 levels down); the new and break
instructions are used by the LaTeX/pdf and odf output to determine where
to put page breaks (that are not used by html output or say sql database
population).
@skin: skin_sisu_manual
% skins modify the appearance of a document and are placed in a sub-directory
under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single
documents that request them, all documents in a directory, or be site-wide.
(A document is affected by a single skin)
@bold: /Gnu|Debian|Ruby|SiSU/
@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html
{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
</pre>
<p> 2.2 AVAILABLE HEADERS
<p> Header tags appear at the beginning of a document
and provide meta information on the document (such as the Dublin Core),
or information as to how the document as a whole is to be processed. All
header instructions take either the form @headername: or 0~headername. All
<p>Dublin Core meta tags are available
<p> <b>@indentifier:</b> information or instructions
<p> where the information
<p> 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.
<p> This
<p>is a sample header
<p> <b>% SiSU 0.38</b> [declared file-type identifier with markup
version]
<p> <b>@title:</b> [title text] This is the title of the document and used
as such, this header is the only one that is <i>mandatory</i>
<p> <b>@subtitle:</b> The
<p>Subtitle if any
<p> <b>@creator:</b> [or @author:] Name of Author
<p> <b>@subject:</b> (whatever
your subject)
<p> <b>@description:</b>
<p> <b>@publisher:</b>
<p> <b>@contributor:</b>
<p> <b>@translator:</b>
[or @translated_by:]
<p> <b>@illustrator:</b> [or @illustrated_by:]
<p> <b>@prepared_by:</b>
[or @digitized_by:]
<p> <b>@date: 2000-08-27</b> [ also @date.created: @date.issued:
@date.available: @date.valid: @date.modified: ]
<p> <b>@type: article</b>
<p> <b>@format:</b>
<p> <b>@identifier:</b>
<p> <b>@source:</b>
<p> <b>@language:</b> [or @language.document:] [country
code for language if available, or language, English, en is the default
setting] (en - English, fr - French, de - German, it - Italian, es - Spanish,
pt - Portuguese, sv - Swedish, da - Danish, fi - Finnish, no - Norwegian, is
- Icelandic, nl - Dutch, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian,
ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian,
hr - Croatian, cs - Czech, bg - Bul garian ) [however, encodings are not available
for all of the languages listed.]
<p> [@language.original: original language
in which the work was published]
<p> <b>@papersize:</b> (A4|US_letter|book_B5|book_A5|US_legal)
<p> <b>@relation:</b>
<p> <b>@coverage:</b>
<p> <b>@rights:</b> Copyright (c) Name of Right Holder,
all rights reserved, or as granted: public domain, copyleft, creative commons
variant, etc.
<p> <b>@owner:</b>
<p> <b>@keywords:</b> text document generation processing
management latex pdf structured xml citation [your keywords here, used
for example by rss feeds, and in sql searches]
<p> <b>@abstract:</b> [paper abstract,
placed after table of contents]
<p> <b>@comment:</b> [...]
<p> <b>@catalogue:</b> loc=[Library
of Congress classification]; dewey=[Dewey rss feeds, classification]; isbn=[ISBN];
pg=[Project Gutenberg text number]
<p> <b>@classify_loc:</b> [Library of Congress
classification]
<p> <b>@classify_dewey:</b> [Dewey classification]
<p> <b>@classify_isbn:</b>
[ISBN]
<p> <b>@classify_pg:</b> [Project Gutenberg text number]
<p> <b>@prefix:</b> [prefix
is placed just after table of contents]
<p> <b>@prefix_a:</b> [prefix is placed
just before table of contents - not implemented]
<p> <b>@prefix_b:</b>
<p> <b>@rcs:</b> $Id:
sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $ [used by rcs or cvs
to embed version (revision control) information into under ./_sisu/skin
~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request
them, all documents in a directory, or be site-wide. (A document is affected
by a single skin) document, rcs or cvs can usefully provide a history of
under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single
documents that request them, all documents in a directory, or be site-wide.
(A document is affected by a single skin) updates to a document ]
<p> <b>@structure:</b>
PART; CHAPTER; SECTION; ARTICLE; none; none; optional, document structure
can be defined by words to match or regular expression (the regular expression
is assumed to start at the beginning of a line of text i.e. ^) default markers
:A~ to :C~ and 1~ to 6~ can be used within text instead, without this header
tag, and may be used to supplement the instructions provided in this header
tag if provided (@structure: is a synonym for @toc:)
<p> <b>@level:</b> newpage=3;
breakpage=4 [paragraph level, used by latex to breakpages, the page in
newpage]
<p> <b>@markup:</b> information on the markup used, e.g. new=1,2,3; break=4;
num_top=4 [or newpage=1,2,3; breakpage=4; num_top=4] newpage and breakpage,
heading level, used by LaTeX to breakpages. breakpage: starts on a new page
in single column text and on a new column in double column text; newpage:
starts on a new page for both single and double column texts. num_top=4
[auto-number document, starting at level 4. the new default is to provide
3 levels, as in 1 level 4, 1.1 1.1.1 level 6, markup to be merged within level]
num_extract [take numbering of headings provided (manually in and use
for numbering of Available where a clear numbering structure is without
the repetition of a number in a header.] [In 0.38 notation, you would map
to the equivalent levels, the examples provided would map to the following
new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1]
see headings]
<p> <b>@bold:</b> [regular expression of words/phrases to be made
bold]
<p> <b>@italics:</b> [regular expression of words/phrases to italicise]
<p>
<b>@vocabulary:</b> name of taxonomy/vocabulary/wordlist to use against document
<p> <b>@skin:</b> skin_doc_[name_of_desired_document_skin] skins change default
settings related to the appearance of documents generated, such as the
urls of the home site, and the icon/logo for the document or site.
<p> <b>@links:</b>
{ <b>SiSU</b> }<a href='http://www.jus.uio.no/sisu/;'>http://www.jus.uio.no/sisu/;</a>
{ FSF }<a href='http://www.fsf.org'>http://www.fsf.org</a>
<p> <b>@promo:</b> sisu,
ruby, search_libre_docs, open_society [places content in right pane in
html, makes use of list.yml and promo.yml, commented out sample in document
sample: and promo.yml, commented out sample in document free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst]
<p> 3. MARKUP OF SUBSTANTIVE TEXT
<p> 3.1 HEADING LEVELS
<p> Heading levels are
:A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section headings, followed
by other heading levels, and 1 -6 being headings followed by substantive
text or sub-headings. :A~ usually the title :A~? conditional level 1 heading
(used where a stand-alone document may be imported into another)
<p> <b>:A~ [heading
text]</b> Top level heading [this usually has similar content to the ] NOTE:
the heading levels described here are in 0.38 notation, see heading
<p> <b>:B~
[heading text]</b> Second level heading [this is a heading level divider]
<p>
<b>:C~ [heading text]</b> Third level heading [this is a heading level divider]
<p> <b>1~ [heading text]</b> Top level heading preceding substantive text of document
or sub-heading 2, the heading level that would normally be marked 1. or 2.
or 3. etc. in a document, and the level on which sisu by default would break
html output into named segments, names are provided automatically if none
are given (a number), otherwise takes the form 1~my_filename_for_this_segment
<p> <b>2~ [heading text]</b> 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.
<p> <b>3~ [heading text]</b> 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
<p>
<p> <br>
<pre> 1~filename level 1 heading,
% the primary division such as Chapter that is followed by substantive
text, and may be further subdivided (this is the level on which by default
html segments are made)
</pre>
<p> 3.2 FONT ATTRIBUTES
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/
normal text
!{emphasis}!
*{bold text}*
_{underscore}
/{italics}/
^{superscript}^
,{subscript},
+{inserted text}+
-{strikethrough}-
</pre>
<p> <b>resulting output:</b>
<p> normal text <em>emphasis</em> <b>bold text</b> <i>underscore</i> <i>italics</i>
<cite>citation</cite> ^superscript^ [subscript] <ins>inserted text</ins> <del>strikethrough</del>
<p> normal text
<p> <em>emphasis</em>
<p> <b>bold text</b>
<p> <i>underscore</i>
<p> <i>italics</i>
<p> <cite>citation</cite>
<p> ^superscript^
<p> [subscript]
<p> <ins>inserted text</ins>
<p> <del>strikethrough</del>
<p> 3.3 INDENTATION AND BULLETS
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> ordinary paragraph
_1 indent paragraph one step
_2 indent paragraph two steps
_9 indent paragraph nine steps
</pre>
<p> <b>resulting output:</b>
<p> ordinary paragraph
<p> indent paragraph one step<br>
<p> indent paragraph two steps<br>
<p> indent paragraph nine steps<br>
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> * bullet text
_1* bullet text, first indent
_2* bullet text, two step indent
</pre>
<p> <b>resulting output:</b>
<p> * bullet text
<p> * bullet text, first indent<br>
<p> * bullet text, two step indent<br>
<p> Numbered List (not to be confused with headings/titles, (document structure))
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> # numbered list numbered list 1., 2., 3, etc.
_# numbered list numbered list indented a., b., c., d., etc.
</pre>
<p> 3.4 FOOTNOTES / ENDNOTES
<p> Footnotes and endnotes not distinguished in
markup. They are automatically numbered. Depending on the output file format
(html, odf, pdf etc.), the document output selected will have either footnotes
or endnotes.
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> ~{ a footnote or endnote }~
</pre>
<p> <b>resulting output:</b>
<p> [^3]
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text~{ self contained endnote marker & endnote in one }~ continues
</pre>
<p> <b>resulting output:</b>
<p> normal text[^4] continues
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text ~{* unnumbered asterisk footnote/endnote, insert multiple
asterisks if required }~ continues
normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
</pre>
<p> <b>resulting output:</b>
<p> normal text [^*] continues
<p> normal text [^**] continues
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text ~[* editors notes, numbered asterisk footnote/endnote series
]~ continues
normal text ~[+ editors notes, numbered asterisk footnote/endnote series
]~ continues
</pre>
<p> <b>resulting output:</b>
<p> normal text [^*1] continues
<p> normal text [^+1] continues
<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b>
<p>
<p> <br>
<pre>
% note the endnote marker
normal text~^ continues
^~ endnote text following the paragraph in which the marker occurs
</pre>
<p> the standard and pair notation cannot be mixed in the same document
<p>
<p>3.5 LINKS
<p> 3.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS
<p> urls are found
within text and marked up automatically. A url within text is automatically
hyperlinked to itself and by default decorated with angled braces, unless
they are contained within a code block (in which case they are passed as
normal text), or escaped by a preceding underscore (in which case the decoration
is omitted).
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text http://www.jus.uio.no/sisu continues
</pre>
<p> <b>resulting output:</b>
<p> normal text <<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
> continues
<p> An
<p>escaped url without decoration
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> normal text http://www.jus.uio.no/sisu continues
deb http://www.jus.uio.no/sisu/archive unstable main non-free
</pre>
<p> <b>resulting output:</b>
<p> normal text <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
continues
<p> deb
<p><a href='http://www.jus.uio.no/sisu/archive'>http://www.jus.uio.no/sisu/archive</a>
unstable main non-free
<p> where a code block
is used there is neither decoration nor hyperlinking, code blocks are discussed
<p>later in this document
<p> <b>resulting output:</b>
<p>
<p> <br>
<pre> deb http://www.jus.uio.no/sisu/archive unstable main non-free
deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
</pre>
<p> To link text or an image to a url the markup is as follows
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> about { SiSU }http://url.org markup
</pre>
<p> 3.5.2 LINKING TEXT
<p> <b>resulting output:</b>
<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
>
<p>markup
<p> A shortcut notation is available so the url link may also be provided
<p>automatically as a footnote
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> about {~^ SiSU }http://url.org markup
</pre>
<p> <b>resulting output:</b>
<p> about SiSU <<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
> [^5] markup
<p> 3.5.3
<p>LINKING IMAGES
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> [ tux.png ]
% various url linked images
[ tux.png ]
[ GnuDebianLinuxRubyBetterWay.png ]
{~^ ruby_logo.png
</pre>
<p> <b>resulting output:</b>
<p> [ tux.png ]
<p> tux.png 64x80
<p> [ ruby_logo (png missing)
] [^6]
<p> GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby
<p> <b>linked url footnote
<p>shortcut</b>
<p>
<p> <br>
<pre> {~^ [text to link] }http://url.org
% maps to: { [text to link] }http://url.org ~{ http://url.org }~
% which produces hyper-linked text within a document/paragraph, with an
endnote providing the url for the text location used in the hyperlink
</pre>
<p>
<p> <br>
<pre> text marker *~name
</pre>
<p> note at a heading level the same is automatically achieved by providing
names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of
auto-heading numbering, without further intervention.
<p> 3.6 GROUPED TEXT
<p> 3.6.1
<p>TABLES
<p> Tables may be prepared in two either of two forms
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> table{ c3; 40; 30; 30;
This is a table
this would become column two of row one
column three of row one is here
And here begins another row
column two of row two
column three of row two, and so on
}table
</pre>
<p> <b>resulting output:</b>
<p> [table omitted, see other document formats]<br>
<p> a second form may be easier to work with in cases where there is not
<p>much information in each column
<p> <b>markup example:</b> [^7]
<p>
<p> <br>
<pre> !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
{table~h 24; 12; 12; 12; 12; 12; 12;}
|Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July
2004|June 2006
Contributors* | 10| 472| 2,188| 9,653|
25,011| 48,721
Active contributors** | 9| 212| 846| 3,228|
8,442| 16,945
Very active contributors*** | 0| 31| 190| 692|
1,639| 3,016
No. of English language articles| 25| 16,000| 101,000| 190,000|
320,000| 630,000
No. of articles, all languages | 25| 19,000| 138,000| 490,000|
862,000|1,600,000
Contributed at least ten times; at least 5 times in last month; ** more
than 100 times in last month.
</pre>
<p> <b>resulting output:</b>
<p> <b>Table 3.1: Contributors to Wikipedia, January 2001
- June 2005</b>
<p> [table omitted, see other document formats]<br>
<p> * Contributed at least ten times; ** at least 5 times in last month;
*** more than 100 times in last month.
<p> 3.6.2 POEM
<p> <b>basic markup:</b>
<p>
<p> <br>
<pre> poem{
Your poem here
}poem
Each verse in a poem is given a separate object number.
</pre>
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> poem{
’Fury said to a
mouse, That he
met in the
house,
both go to
law: I will
prosecute
YOU. --Come,
I’ll take no
denial; We
must have a
trial: For
really this
morning I’ve
nothing
to do.
Said the
mouse to the
cur,
a trial,
dear Sir,
With
no jury
or judge,
would be
wasting
our
breath.
judge, I’ll
be jury,
Said
cunning
old Fury:
try the
whole
cause,
and
condemn
you
to
death.
}poem
</pre>
<p> <b>resulting output:</b>
<p>
<p> ’Fury said to a<br>
<p>
mouse, That he<br>
<p>
met in the<br>
<p>
house,<br>
<p>
<br>
<p>
both go to<br>
<p>
law: I will<br>
<p>
prosecute<br>
<p>
YOU. --Come,<br>
<p>
I’ll take no<br>
<p>
denial; We<br>
<p>
must have a<br>
<p>
trial: For<br>
<p>
really this<br>
<p>
morning I’ve<br>
<p>
nothing<br>
<p>
to do.<br>
<p>
Said the<br>
<p>
mouse to the<br>
<p>
cur,<br>
<p>
a trial,<br>
<p>
dear Sir,<br>
<p>
With<br>
<p>
no jury<br>
<p>
or judge,<br>
<p>
would be<br>
<p>
wasting<br>
<p>
our<br>
<p>
breath.<br>
<p>
<br>
<p>
judge, I’ll<br>
<p>
be jury,<br>
<p>
Said<br>
<p>
cunning<br>
<p>
old Fury:<br>
<p>
<br>
<p>
try the<br>
<p>
whole<br>
<p>
cause,<br>
<p>
and<br>
<p>
condemn<br>
<p>
you<br>
<p>
to<br>
<p>
death.<br>
<p>
<p> 3.6.3 GROUP
<p> <b>basic markup:</b>
<p>
<p> <br>
<pre> group{
Your grouped text here
}group
A group is treated as an object and given a single object number.
</pre>
<p> <b>markup example:</b>
<p>
<p> <br>
<pre> group{
’Fury said to a
mouse, That he
met in the
house,
both go to
law: I will
prosecute
YOU. --Come,
I’ll take no
denial; We
must have a
trial: For
really this
morning I’ve
nothing
to do.
Said the
mouse to the
cur,
a trial,
dear Sir,
With
no jury
or judge,
would be
wasting
our
breath.
judge, I’ll
be jury,
Said
cunning
old Fury:
try the
whole
cause,
and
condemn
you
to
death.
}group
</pre>
<p> <b>resulting output:</b>
<p>
<p> ’Fury said to a<br>
<p>
mouse, That he<br>
<p>
met in the<br>
<p>
house,<br>
<p>
<br>
<p>
both go to<br>
<p>
law: I will<br>
<p>
prosecute<br>
<p>
YOU. --Come,<br>
<p>
I’ll take no<br>
<p>
denial; We<br>
<p>
must have a<br>
<p>
trial: For<br>
<p>
really this<br>
<p>
morning I’ve<br>
<p>
nothing<br>
<p>
to do.<br>
<p>
Said the<br>
<p>
mouse to the<br>
<p>
cur,<br>
<p>
a trial,<br>
<p>
dear Sir,<br>
<p>
With<br>
<p>
no jury<br>
<p>
or judge,<br>
<p>
would be<br>
<p>
wasting<br>
<p>
our<br>
<p>
breath.<br>
<p>
<br>
<p>
judge, I’ll<br>
<p>
be jury,<br>
<p>
Said<br>
<p>
cunning<br>
<p>
old Fury:<br>
<p>
<br>
<p>
try the<br>
<p>
whole<br>
<p>
cause,<br>
<p>
and<br>
<p>
condemn<br>
<p>
you<br>
<p>
to<br>
<p>
death.<br>
<p>
<p> 3.6.4 CODE
<p> Code tags are used to escape regular sisu markup, and have
been used extensively within this document to provide examples of <b>SiSU</b>
markup. You cannot however use code tags to escape code tags. They are however
used in the same way as group or poem tags.
<p> 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]
<p> <b>use of code tags instead
of poem compared, resulting output:</b>
<p>
<p> <br>
<pre> ’Fury said to a
mouse, That he
met in the
house,
both go to
law: I will
prosecute
YOU. --Come,
I’ll take no
denial; We
must have a
trial: For
really this
morning I’ve
nothing
to do.
Said the
mouse to the
cur,
a trial,
dear Sir,
With
no jury
or judge,
would be
wasting
our
breath.
judge, I’ll
be jury,
Said
cunning
old Fury:
try the
whole
cause,
and
condemn
you
to
death.
</pre>
<p> 4. COMPOSITE DOCUMENTS MARKUP
<p> It is possible to build a document by
creating a master document that requires other documents. The documents
required may be complete documents that could be generated independently,
or they could be markup snippets, prepared so as to be easily available
to be placed within another text. If the calling document is a master document
(built from other documents), it should be named with the suffix <b>.ssm</b> Within
this document you would provide information on the other documents that
should be included within the text. These may be other documents that would
be processed in a regular way, or markup bits prepared only for inclusion
within a master document <b>.sst</b> regular markup file, or <b>.ssi</b> (insert/information)
<p>A secondary file of the composite document is built prior to processing
<p>with the same prefix and the suffix <b>._sst</b>
<p> basic markup for importing a
<p>document into a master document
<p>
<p> <br>
<pre> << |filename1.sst|@|^|
<< |filename2.ssi|@|^|
</pre>
<p> The form described above should be relied on. Within the Vim editor it
results in the text thus linked becoming hyperlinked to the document it
is calling in which is convenient for editing. Alternative markup for importation
of documents under consideration, and occasionally supported have been.
<p>
<p> <br>
<pre> r{filename}
{filename.ssi}require
<< {filename.ssi}
% using textlink alternatives
|filename.ssi|@|^|require
<< |filename.ssi|@|^|
% using thlnk alternatives
<url:filename.ssi>require
<< <url:filename.ssi>
</pre>
<p> MARKUP SYNTAX HISTORY
<p> 5. NOTES RELATED TO FILES-TYPES AND MARKUP SYNTAX
<p> 0.38 is substantially current, depreciated 0.16 supported, though file
<p>names were changed at 0.37
<p> <b>0.52</b> (2007w14/6) declared document type identifier
at start of text/document:
<p> .B SiSU<br>
0.52
<p> or, backward compatible using the comment marker:
<p> %<br>
<b>SiSU</b> 0.38
<p> variations include ’ <b>SiSU</b> (text|master|insert) [version]’ and ’sisu-[version]’
<p> <b>0.51</b> (2007w13/6) skins changed (simplified), markup unchanged
<p> <b>0.42</b> (2006w27/4)
* (asterisk) type endnotes, used e.g. in relation to author
<p> <b>0.38</b> (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)
<p> <b>0.37</b> (2006w09/7) introduced new file naming convention,
.sst (text), .ssm (master), .ssi (insert), markup syntax unchanged
<p> <b>0.35</b> (2005w52/3)
sisupod, zipped content file introduced
<p> <b>0.23</b> (2005w36/2) utf-8 for markup
<p>file
<p> <b>0.22</b> (2005w35/3) image dimensions may be omitted if rmagick is available
<p>to be relied upon
<p> <b>0.20.4</b> (2005w33/4) header 0~links
<p> <b>0.16</b> (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
<p>marker
<p> DOCUMENT INFORMATION (METADATA)
<p> METADATA
<p> Document Manifest
@ <<a href='http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/sisu_manifest.html</a>
>
<p> <b>Dublin
Core</b> (DC)
<p> <i>DC</i> tags included with this document are provided here.
<p> DC
Title: <i>SiSU</i> - Markup [0.58]
<p> DC Creator: <i>Ralph</i> Amissah
<p> DC Rights: <i>Copyright</i>
(C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
<p> DC
Type: <i>information</i>
<p> DC Date created: <i>2002-08-28</i>
<p> DC Date issued: <i>2002-08-28</i>
<p> DC Date available: <i>2002-08-28</i>
<p> DC Date modified: <i>2007-09-16</i>
<p> DC Date: <i>2007-09-16</i>
<p> <b>Version Information</b>
<p> Sourcefile: <i>sisu_markup.sst</i>
<p> Filetype: <i>SiSU</i> text
<p>0.58
<p> Sourcefile Digest, MD5(sisu_markup.sst)= <i>643738c4b96d001d107e3ea72ba17a97</i>
<p> Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/sisu-dev/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)=
<p><i>20fc43cf3eb6590bc3399a1aef65c5a9</i>
<p> <b>Generated</b>
<p> Document (metaverse) last
generated: <i>Sun</i> Sep 23 01:13:59 +0100 2007
<p> Generated by: <i>SiSU</i> <i>0.58.3</i> of
2007w36/4 (2007-09-06)
<p> Ruby version: <i>ruby</i> 1.8.6 (2007-06-07 patchlevel 36)
[i486-linux]
<p>
<ol>
<b>.</b><li>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.
</li><b>.</b><li>files should be prepared using UTF-8 character encoding </li><b>.</b><li>a footnote or endnote
</li><b>.</b><li>self contained endnote marker & endnote in one </dd>
<dt><b>*.</b> </dt>
<dd>unnumbered asterisk footnote/endnote,
insert multiple asterisks if required </dd>
<dt><b>**.</b> </dt>
<dd>another unnumbered asterisk footnote/endnote
</dd>
<dt><b>*1.</b> </dt>
<dd>editors notes, numbered asterisk footnote/endnote series </dd>
<dt><b>+1.</b> </dt>
<dd>editors
notes, numbered asterisk footnote/endnote series </li><b>.</b><li><<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
>
</li><b>.</b><li><<a href='http://www.ruby-lang.org/en/'>http://www.ruby-lang.org/en/</a>
> </li><b>.</b><li>Table from the Wealth of Networks by Yochai Benkler
<<a href='http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler'>http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler</a>
><br>
<p> </dd>
<dt>Other versions of this document: </dt>
<dd></dd>
<dt>manifest: <<a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html'>http://www.jus.uio.no/sisu/sisu_markup/sisu_manifest.html</a>
</a>
>
</dt>
<dd></dd>
<dt>html: <<a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'><a href='http://www.jus.uio.no/sisu/sisu_markup/toc.html'>http://www.jus.uio.no/sisu/sisu_markup/toc.html</a>
</a>
> </dt>
<dd></dd>
<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf'>http://www.jus.uio.no/sisu/sisu_markup/portrait.pdf</a>
</a>
>
</dt>
<dd></dd>
<dt>pdf: <<a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'><a href='http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf'>http://www.jus.uio.no/sisu/sisu_markup/landscape.pdf</a>
</a>
> </dt>
<dd> </dd>
<dt>at: <<a href='http://www.jus.uio.no/sisu'><a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
</a>
>
</dt>
<dd></dd>
<dt>* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) </dt>
<dd></dd>
<dt>* Ruby version: ruby
1.8.6 (2007-06-07 patchlevel 36) [i486-linux] </dt>
<dd></dd>
<dt>* Last Generated on: Sun Sep 23
01:14:06 +0100 2007 </dt>
<dd></dd>
<dt>* SiSU <a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a>
</dt>
<dd></dd>
</dl>
<p>
</body>
</html>
|
