aboutsummaryrefslogtreecommitdiffhomepage
path: root/markup/pod/sisu-manual/media/text/en/sisu_markup.sst
blob: ae87b76ce521b57c970664b241da475c5312fbb4 (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
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
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
# SiSU 8.0

title:
  main: "Spine, Doc Reform"
  subtitle: "SiSU Markup"

creator:
  author: "Amissah, Ralph"

date:
  created: "2002-08-28"
  issued: "2002-08-28"
  available: "2002-08-28"
  published: "2008-05-22"
  modified: "2012-10-03"

rights:
  copyright: "2007 Ralph Amissah"
  license: "GPL 3 (part of SiSU documentation)"

classify:
  topic_register: "electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup;SiSU markup sample:technical writing;software:program"
  subject: "ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search"

make:
  doc_type: "book"
  breaks: "new=:B; break=1"
  auto_num_top_at_level: "1"
  substitute: [
      [ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
    ]
#substitute: [ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
  bold: "Debian|SiSU"
  italics: "Linux|GPL|LaTeX|SQL"
  home_button_text: [
      "{doc-reform}https://doc-reform.org",
      "{sources / git}https://git.sisudoc.org/projects/",
      "{SiSU}https://sisudoc.org"
    ]
  footer: [
      "{SiSU}https://sisudoc.org",
      "{git}https://git.sisudoc.org/projects"
    ]

# home_button_text: "{SiSU}https://sisudoc.org; {sources / git}https://git.sisudoc.org/projects/"
# footer: "{SiSU}https://sisudoc.org; {git}https://git.sisudoc.org/projects"
# substitute: "/[$]{2}[{]sisudoc[}]/,'www.sisudoc.org'"
#  substitute: "/${sisudoc}/,'www.sisudoc.org'"
# home_button_image: "{won_benkler.png }https://cyber.law.harvard.edu/wealth_of_networks/Main_Page"

:A~ @title-author-date

:B~ SiSU Markup
={ SiSU markup:test }

1~markup Introduction to SiSU Markup~{ 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~ Summary

This is the D version of the program sisu on which the markup it uses is based.

SiSU source documents are plaintext (UTF-8)~{ files should be prepared using UTF-8 character encoding }~ files
={ SiSU markup:description }

All paragraphs are separated by an empty line.

Markup is comprised of: *~markup-summary { * }#internal-links

_* 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)

_* 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:

_1* heading levels defines document structure

_1* text basic attributes, italics, bold etc.

_1* grouped text (objects), which are to be treated differently, such as code blocks or poems.

_1* footnotes/endnotes

_1* linked text and images

_1* paragraph actions, such as indent, bulleted, numbered-lists, etc.

2~ Markup Rules, document structure and metadata requirements
={ SiSU markup:rules and requirements }

minimal content/structure requirement, minimum being:

metadata

``` code
title: "SiSU Spine"
  subtitle: "Markup"

creator:
  author: "Amissah, Ralph"
```

levels

``` code
A~ (level A [title])

1~ (at least one level 1 [segment/(chapter)])
```
={
  output:code markup example;
  SiSU markup output:code block (tic syntax);
  code block:tic syntax
}

structure rules (document heirarchy, heading levels):

there are two sets of heading levels ABCD (title & parts if any) and 123 (segment & subsegments if any)
={ SiSU markup:heading levels }

sisu has the fllowing levels (that may be described as document parts, headings and subheadings):

``` code
A~ [title (& author)]
   - document root, required once (== 1)
   - followed by part B~ or level 1~
   - often written in the form:
     A~ @title @creator
     where title and creator are taken from the document header

B~ [part]
   - part B is followed by a part C~ if there is one or level 1~

C~ [subpart]
   - part C is followed by a part D~ if there is one or level 1~

D~ [subsubpart]
   - part D is followed by level 1~

1~ [heading, segment (chapter)]
   - level 1 required at least once (>= 1)
   - is followed by level 2~ or
     by text which can then be followed
     - by more text or by levels 1~ or 2~ (or relevant part)
   - level 1 in html (and epub) is the basis of a document segment and in a book
     would correspond to a chapter

2~ [sub-heading]
   - followed by level 3~ or
   - by text which can then be followed
     by more text or by levels 1~, 2~ or 3~ (or relevant part)

3~ [sub-sub-heading]
   - followed by text which can be followed
     by more text or by levels 1~, 2~ or 3~ (or relevant part)
```

Rules:

``` code
- level A~ is mandatory, it is the (document root and) title

- there can only be one document root == level/part A~

- heading levels B,C,D, are optional and there may be several of each
  (where all three are used corresponding to e.g. Book, Part, Section)
  - sublevels that are used must follow each other sequentially
    (alphabetically),

- heading levels A~ B~ C~ D~ are followed by other heading levels rather
  than substantive text
  - which may be the subsequent sequential (alphabetic) heading part level
  - or a heading (segment) level 1~

- there must be at least one heading (segment) level 1~
  (the level on which the text is segmented, in a book would correspond
  to the Chapter level)

- additional heading levels 1~ 2~ 3~ are optional and there may be several
  of each

- heading levels 1~ 2~ 3~ are followed by text (which may be followed by
  the same heading level)
  and/or the next lower numeric heading level (followed by text)
  or indeed return to the relevant part level
  (as a corollary to the rules above substantive text/ content
  must be preceded by a level 1~ (2~ or 3~) heading)
```

2~ Markup Examples
={ SiSU markup:locating examples }

3~ Online
={ SiSU markup:examples online }

Markup examples are available in the form of prepared texts that were written
under creative commons license that permit re-publication.

There is of course this document, which is provided with the program and
provides a cursory overview of sisu markup. Running sisu spine against it gives
an overview of the output produced by the program.

1~headers Markup of Headers
={ SiSU markup:headers}

The document header is based on yaml, and is the part of the document preceeding
the document root marked by "A~ [Document title & author]"

The document header contains either: semantic meta-data about the document, or
processing instructions.

Note: the first line of a document may include information on the markup version
used in the form of a comment. Comments within the header section are the hash
symbol at the start of a line (and as the first character in a line of text)
followed by a space and the comment:

code{

# in the header section of a document, this would be a comment

}code
={ output:code markup example;SiSU markup output:code block (curly brace syntax);code block:curly brace syntax }

2~ Sample Header
={ SiSU markup:sample header}

This current document is loaded by a master document that has a header similar to this one:

``` code
# SiSU 8.0

title:
  main: "SiSU"
  subtitle: "Markup"

creator:
  author: "Amissah, Ralph"

date:
  created: "2002-08-28"
  issued: "2002-08-28"
  available: "2002-08-28"
  published: "2008-05-22"
  modified: "2020-04-11"

rights:
  copyright: "Copyright (C) Ralph Amissah 2007, 2020"
  license: "AGPL 3 (part of SiSU Spine documentation)"

classify:
  topic_register: "electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup"
  subject = "ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search"
```

Looking back a bit:

code{

# SiSU master 8.0

title:
  main: "SiSU"
  subtitle: "Markup"

creator:
  author: "Amissah, Ralph"

date:
  created: "2002-08-28"
  issued: "2002-08-28"
  available: "2002-08-28"
  published: "2008-05-22"
  modified: "2020-04-11"

rights:
  copyright: "Copyright (C) Ralph Amissah 2007, 2020"
  license: "AGPL 3 (part of SiSU Spine documentation)"

classify:
  topic_register: "electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup"
  subject: "ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search"

make:
  auto_num_top_at_level: "1"
  substitute: [
    [ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
  ]
  bold: "Debian|SiSU"
  italics: "Linux|GPL|LaTeX|SQL"
  breaks: "new=:B; break=1"
  home_button_text: "{SiSU}https://sisudoc.org; {sources / git}https://git.sisudoc.org/projects/"
  footer: "{SiSU}https://sisudoc.org; {git}https://git.sisudoc.org/projects"

}code

2~ Available Headers
={ SiSU markup:headers available }

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 the form headername:
or on the next line and indented by two spaces subheadername: All Dublin Core
meta tags are available

!_ @identifier:
information or instructions

where the "identifier" is a tag recognised by the program, and the "information"
or "instructions" belong to the tag/identifier specified

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.

This is a sample header

% (Dublin Core in fuschia, other information headers in cyan, markup instructions in red):

code{

# SiSU 8.0

}code

code{

title:
  main: "SiSU"
  subtitle: "Markup"
  language: "English"

}code

code{

creator:
  author: [Lastname, First names]
  illustrator: [Lastname, First names]
  translator: [Lastname, First names]
  prepared_by: [Lastname, First names]

}code

code{

date:
  created: [year or yyyy-mm-dd]
  issued: [year or yyyy-mm-dd]
  available: [year or yyyy-mm-dd]
  published: [year or yyyy-mm-dd]
  modified: [year or yyyy-mm-dd]
  valid: [year or yyyy-mm-dd]
  added_to_site: [year or yyyy-mm-dd]
  translated: [year or yyyy-mm-dd]

}code

code{

rights:
  copyright: "Copyright (C) [Year and Holder]"
  license: "[Use License granted]"
  text: "[Name, Year]"
  translation: "[Name, Year]"
  illustrations: "[Name, Year]"

# check rest

}code

code{

classify:
  topic_register: "electronic documents;SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup"
  subject: "ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search"
  keywords: "list"
  loc: "[Library of Congress classification]"
  dewey: "[Dewey classification]"

}code

code{

identifier:
  isbn: "[ISBN]"
  oclc: ""

}code


code{

links: [
  "{SiSU }https://www.sisudoc.org",
  "{ FSF }https://www.fsf.org",
]

}code

code{

make:
  auto_num_top_at_level: "1"
  substitute: [
    [ "[$]{2}\\{sisudoc\\}", "www.sisudoc.org" ]
  ]
  bold: "Debian|SiSU" # [regular expression of words/phrases to be made bold]
  italics: "Linux|GPL|LaTeX|SQL" # [regular expression of words/phrases to italicise]
  breaks: "new=:B; break=1"
  home_button_text: "{SiSU}https://sisudoc.org; {sources / git}https://git.sisudoc.org/gitweb/"
  footer: "{SiSU}https://sisudoc.org; {git}https://git.sisudoc.org"
  headings: text to match for each level
    (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)

}code

% [original]
% language = [language]

% [notes]
% comment:
% prefix: [prefix is placed just after table of contents]

% header ends here, NB only @title: is mandatory [this would be a comment]
% NOTE: headings/levels below refer to 0.38 expermental markup (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 and 0.38 markup simple)

1~ Markup of Substantive Text
={ SiSU markup:substantive text }

2~heading_levels Heading Levels
={ SiSU markup:heading levels }

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)

!_ :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

!_ :B~ [heading text]
Second level heading [this is a heading level divider]

!_ :C~ [heading text]
Third level heading [this is a heading level divider]

!_ 1~ [heading text]
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

!_ 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.

!_ 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

code{

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)

}code

2~ Font Attributes
={ SiSU markup:font attributes }

!_ markup example:

code{

normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#

normal text

*{emphasis}* [note: can be configured to be represented by bold, italics or underscore]

!{bold text}!

/{italics}/

_{underscore}_

"{citation}"

^{superscript}^

,{subscript},

+{inserted text}+

-{strikethrough}-

#{monospace}#

}code

!_ resulting output:

normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#

normal text

*{emphasis}* [note: can be configured to be represented by bold, italics or underscore]

!{bold text}!

/{italics}/

_{underscore}_

"{citation}"

^{superscript}^

,{subscript},

+{inserted text}+

-{strikethrough}-

#{monospace}#

2~ Indentation and bullets
={ SiSU markup:indentation and bullets }

!_ markup example:
={ SiSU markup:indentation }

code{

ordinary paragraph

_1 indent paragraph one step

_2 indent paragraph two steps

_9 indent paragraph nine steps

}code

!_ resulting output:

ordinary paragraph

_1 indent paragraph one step

_2 indent paragraph two steps

_9 indent paragraph nine steps

!_ markup example:
={ SiSU markup:bullets }

code{

_* bullet text

_1* bullet text, first indent

_2* bullet text, two step indent

}code

!_ resulting output:

_* bullet text

_1* bullet text, first indent

_2* bullet text, two step indent

Numbered List (not to be confused with headings/titles, (document structure))

!_ markup example:

code{

# numbered list                numbered list 1., 2., 3, etc.

_# numbered list numbered list indented a., b., c., d., etc.

}code

2~ Hanging Indents
={ SiSU markup:hanging indents;indented text:hanging }

!_ markup example:

code{

_0_1 first line no indent (no hang),
rest of paragraph indented one step

_1_0 first line indented,
rest of paragraph no indent

in each case level may be 0-9

}code

!_ resulting output:

_0_1 first line no indent, rest of paragraph indented one step; first line no
indent, rest of paragraph indented one step; first line no indent, rest of
paragraph indented one step; first line no indent, rest of paragraph indented
one step; first line no indent, rest of paragraph indented one step; first line
no indent, rest of paragraph indented one step; first line no indent, rest of
paragraph indented one step; first line no indent, rest of paragraph indented
one step; first line no indent, rest of paragraph indented one step;

A regular paragraph.

_1_0 first line indented, rest of paragraph no indent first line indented, rest
of paragraph no indent first line indented, rest of paragraph no indent first
line indented, rest of paragraph no indent first line indented, rest of
paragraph no indent first line indented, rest of paragraph no indent first line
indented, rest of paragraph no indent first line indented, rest of paragraph no
indent first line indented, rest of paragraph no indent first line indented,
rest of paragraph no indent first line indented, rest of paragraph no indent

in each case level may be 0-9

_0_1 *{live-build}* A collection of scripts used to build customized Debian
Livesystems. /{live-build}/ was formerly known as live-helper, and even earlier
known as live-package.

_0_1 *{live-build}* \\
A collection of scripts used to build customized Debian Livesystems.
/{live-build}/ was formerly known as live-helper, and even earlier known as
live-package.

2~ Footnotes / Endnotes
={ SiSU markup:hanging indents;footnotes;endnotes }

Footnotes and endnotes are marked up at the location where they would be
indicated within a text. They are automatically numbered. The output type
determines whether footnotes or endnotes will be produced

!_ markup example:

code{

~{ a footnote or endnote }~

}code

!_ resulting output:

~{ a footnote or endnote }~

!_ markup example:

code{

normal text~{ self contained endnote marker & endnote in one }~ continues

}code

!_ resulting output:

normal text~{ self contained endnote marker & endnote in one }~ continues

!_ markup example:

code{

normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues

normal text ~{** another unnumbered asterisk footnote/endnote }~ continues

}code

!_ resulting output:

normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues

normal text ~{** another unnumbered asterisk footnote/endnote }~ continues

!_ markup example:

code{

normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues

normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues

}code

!_ resulting output:

normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues

normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues

!_ [discontinued] Alternative binary endnote notation (endnote pair) for footnotes/endnotes:

code{

% note the endnote marker "~^"

normal text~^ continues

^~ endnote text following the paragraph in which the marker occurs

}code

standard (inline) and pair (binary) notation could not be mixed in the same
document.

The reason binary notation was provided as an option was for the conversion of
documents to sisu markup. Many documents were prepared in such a way that
endnotes had been previously marked up in a binary fashion, and this provided a
convenient and faster way to make the document conversion, just reflect those
markup practices. The reason it has been dropped is it adds a slowing step to
something that needs to be done at most once and it prove to be flakey,
unnecessarily so even when kept under version control. It is preferable to do a
two step conversion of the previously marked up document to sisu: first to the
binary/paired footnote markup, then; convert it to the proper form of inline
endnote markup with a dedicated helper conversion program, keeping the resulting
properly marked up text.

2~ Links
={ SiSU markup:links (text, images);links:images|text }

3~ Naked URLs within text, dealing with urls

urls found within text are 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).

!_ markup example:

code{

normal text https://www.sisudoc.org/ continues

}code

!_ resulting output:

normal text https://www.sisudoc.org/ continues

An escaped url without decoration

!_ markup example:

code{

normal text _https://www.sisudoc.org/ continues

deb _https://www.jus.uio.no/sisu/archive unstable main non-free

}code

!_ resulting output:

normal text _https://www.sisudoc.org/ continues

deb _https://www.jus.uio.no/sisu/archive unstable main non-free

where a code block is used there is neither decoration nor hyperlinking, code
blocks are discussed later in this document

!_ resulting output:

code{

deb https://www.jus.uio.no/sisu/archive unstable main non-free
deb-src https://www.jus.uio.no/sisu/archive unstable main non-free

}code

3~link_text Linking Text
={ SiSU markup:links (text);links:text }

To link text or an image to a url the markup is as follows

!_ markup example:

code{

about { SiSU }https://url.org markup

}code

!_ resulting output:

about { SiSU }https://www.sisudoc.org/ markup

a couple of test urls

https://example.com/Alice&Bob

{ programs I use }https://qa.debian.org/developer.php?packages=zsh+tilix+sakura+tmux+screen+i3-wm+vim+emacs+mosh+ldc

A shortcut notation is available so the url link may also be provided
automatically as a footnote

!_ markup example:

code{

about {~^ SiSU }https://url.org markup

}code

!_ resulting output:

about {~^ SiSU }https://www.sisudoc.org/ markup

Internal document links to a named (anchor) tagged location, including named
headings named inline anchor tags *~an-inline-anchor-tag or an ocn the heading:

code{

1~markup Markup

}code

can be linked to as follows:

code{

to find out more see { Markup }#markup

}code

to find out more see { Markup }#markup

an inline anchor tag is made with the following markup *~internal-links

code{

named inline anchor tags *~an-inline-anchor-tag

}code

and linked to the same way

code{

the link { an inline anchor tag }#an-inline-anchor-tag

}code

the link { an inline anchor tag }#an-inline-anchor-tag or to another part of the
document: { markup summary }#markup-summary

!_ markup example:

code{

about { text links }#link_text

}code

!_ resulting output:

about { text links }#link_text

Shared document collection link

!_ markup example:

code{

about { SiSU book markup examples }:SiSU/examples.html

}code

!_ resulting output:

about { SiSU book markup examples }:SiSU/examples.html

3~ Linking Images
={ SiSU markup:links (images);links:images }

!_ markup example:

code{

{ sm_tux.png 64x80 }image

% various url linked images

{sm_tux.png 64x80 "a better way" }https://www.sisudoc.org/

{sm_GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }https://www.sisudoc.org/

{~^ sm_ruby_logo.png "Ruby" }https://www.ruby-lang.org/en/

}code

!_ resulting output:

{ sm_tux.png }image

{ sm_tux.png 64x80 }image

{ sm_tux.png 64x80 "test" }image

{ sm_tux.png }https://www.sisudoc.org/

{ sm_tux.png 64x80 }https://www.sisudoc.org/

{ sm_tux.png 64x80 "Gnu/Linux - a better way" }https://www.sisudoc.org/

{ sm_GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }https://www.sisudoc.org/

{~^ sm_ruby_logo.png "Ruby" }https://www.ruby-lang.org/en/

{ sm_d_image.jpg 82x128 "D for me" }https://github.com/dlang-community/d-mans

{~^ sm_d_strip.png "D, hey no fair" }https://github.com/dlang-community/d-mans

!_ linked url footnote shortcut

code{

{~^ [text to link] }https://url.org

% maps to: { [text to link] }https://url.org ~{ https://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

}code

code{

text marker *~name

}code

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.

3~ Link shortcut for multiple versions of a sisu document in the same directory tree

!_ markup example:

code{

!_ /{"Viral Spiral"}/, David Bollier

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

}code


!_ /{"Viral Spiral"}/, David Bollier

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

2~ Grouped Text / blocked text
={ SiSU markup:grouped text;grouped text;blocked text;text blocks }

There are two markup syntaxes for blocked text, using curly braces or using tics

3~ blocked text curly brace syntax
={ SiSU markup:grouped text;grouped text:curly brace syntax;blocked text:curly brace syntax;text blocks:curly brace syntax }

at the start of a line on its own use name of block type with an opening curly
brace, follow with the content of the block, and close with a closing curly
brace and the name of the block type, e.g.

``` code
code{

this is a code block

}code
```

``` code
poem{

this here is a poem

}poem
```

3~ blocked text tic syntax
={ SiSU markup:grouped text;grouped text:tic syntax;blocked text:tic syntax;text blocks:tic syntax }

code{

``` code
this is a code block
```

``` poem
this here is a poem
```

}code

start a line with three backtics, a space followed by the name of the name of
block type, follow with the content of the block, and close with three back
ticks on a line of their own, e.g.

3~ Group
={ SiSU markup:group text;group text }

The "group" is different from the "block" mark in that "group" does not preserve
whitespace, the "block" mark does. The text falling within the block is a single
object.

!_ basic markup:

code{

group{

  Your grouped text here

}group

A group is treated as an object and given a single object number.

}code

!_ resulting group text output:

group{

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              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, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."~{ endnote test }~
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole~{ stress test }~
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}group
={ output:group block markup example;SiSU markup output:group block (curly brace syntax) }

!_ resulting group text output:

group{

The Road Not Taken Related Poem Content Details

BY ROBERT FROST

Two roads diverged in a yellow wood,
And sorry I could not travel both
And be one traveler, long I stood
And looked down one as far as I could
To where it bent in the undergrowth;

Then took the other, as just as fair,
And having perhaps the better claim,
Because it was grassy and wanted wear;
Though as for that the passing there
Had worn them really about the same,

And both that morning equally lay
In leaves no step had trodden black.
Oh, I kept the first for another day!
Yet knowing how way leads on to way,
I doubted if I should ever come back.

I shall be telling this with a sigh
Somewhere ages and ages hence:
Two roads diverged in a wood, and I—
I took the one less traveled by,
And that has made all the difference.

}group
={ output:group block markup example;SiSU markup output:group block (curly brace syntax) }

3~ Block
={ SiSU markup:block text;block text }

The "block" is different from the "group" mark in that the "block" mark (like
the "poem" mark) preserves whitespace, the "group" mark does not. The text
falling within the "block" is a single object, which is different from the
"poem" mark where each identified verse is an object.

!_ basic markup:

code{

block{

  Your block text here

}block

A block is treated as an object and given a single object number.

}code

!_ resulting block text output:

block{

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              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, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."~{ endnote test }~
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole~{ stress test }~
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}block
={ output:block block markup example;SiSU markup output:block block (curly brace syntax) }

!_ curly brace delimiter, resulting block text output:

block{

The Road Not Taken Related Poem Content Details

BY ROBERT FROST

Two roads diverged in a yellow wood,
And sorry I could not travel both
And be one traveler, long I stood
And looked down one as far as I could
To where it bent in the undergrowth;

Then took the other, as just as fair,
And having perhaps the better claim,
Because it was grassy and wanted wear;
Though as for that the passing there
Had worn them really about the same,

And both that morning equally lay
In leaves no step had trodden black.
Oh, I kept the first for another day!
Yet knowing how way leads on to way,
I doubted if I should ever come back.

I shall be telling this with a sigh
Somewhere ages and ages hence:
Two roads diverged in a wood, and I—
I took the one less traveled by,
And that has made all the difference.

}block
={ output:group block markup example;SiSU markup output:group block (curly brace syntax) }

3~ Poem
={ SiSU markup:poem;poems }

The "poem" mark like the "block" preserves whitespace. Text followed by two
newlines are identified as verse and each verse is an object i.e. a poem may
consist of multiple verse each of which is identified as an object, unlike a
text "block" which is identified as a single object.

!_ basic markup:

code{

poem{

  Your poem here

}poem

Each verse in a poem is given an object number.

}code

!_ curly brace delimiter, resulting poem text output (broken into verse):

poem{

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              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, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'
}poem

% ={ output:poem markup example;SiSU markup output:poem (curly brace syntax) }

!_ curly brace delimiter, resulting poem text output (broken into verse):

poem{

*{The Road Not Taken}*~{ published in 1916 as the first poem in the collection Mountain Interval. }~

by Robert Frost

Two roads diverged in a yellow wood,
And sorry I could not travel both
And be one traveler, long I stood
And looked down one as far as I could
To where it bent in the undergrowth;

Then took the other, as just as fair,
And having perhaps the better claim,
Because it was grassy and wanted wear;
Though as for that the passing there
Had worn them really about the same,

And both that morning equally lay
In leaves no step had trodden black.
Oh, I kept the first for another day!
Yet knowing how way leads on to way,
I doubted if I should ever come back.

I shall be telling this with a sigh
Somewhere ages and ages hence:
Two roads diverged in a wood, and I—
I took the one less traveled by,
And that has made all the difference.

}poem
={ output:group block markup example;SiSU markup output:group block (curly brace syntax) }

!_ tics delimiter, resulting group text output:

``` poem
!{The Road Not Taken}!~{ published in 1916 as the first poem in the collection Mountain Interval. }~

by Robert Frost

Two roads diverged in a yellow wood,
And sorry I could not travel both
And be one traveler, long I stood
And looked down one as far as I could
To where it bent in the undergrowth;

Then took the other, as just as fair,
And having perhaps the better claim,
Because it was grassy and wanted wear;
Though as for that the passing there
Had worn them really about the same,

And both that morning equally lay
In leaves no step had trodden black.
Oh, I kept the first for another day!
Yet knowing how way leads on to way,
I doubted if I should ever come back.

I shall be telling this with a sigh
Somewhere ages and ages hence:
Two roads diverged in a wood, and I—
I took the one less traveled by,
And that has made all the difference.
```
={ output:group block markup example;SiSU markup output:group block (curly brace syntax) }

3~ Code
={ SiSU markup:code block;code block }

"Code" blocks are a single text object, in which the original text is preserved.

Code tags #{ code{ ... }code }# (used as with other group tags described above)
are used to escape regular sisu markup, and have been used extensively within
this document to provide examples of SiSU markup. You cannot however use code
tags to escape code tags. They are however used in the same way as group or poem
tags.

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]

!_ use of code tags instead of poem compared, resulting output:

code{

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              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, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}code

From SiSU 2.7.7 on you can number codeblocks by placing a hash after the opening code tag #{ code{# }# as demonstrated here:

code(number){

                    `Fury said to a
                   mouse, That he
                 met in the
               house,
            "Let us
              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, "Such
                 a trial,
                   dear Sir,
                         With
                     no jury
                  or judge,
                would be
              wasting
             our
              breath."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}code
={ output:code markup example;SiSU markup output:code block (curly brace syntax);code block:curly brace syntax }

3~ Tables
={ SiSU markup:tables;tables }

Tables may be prepared in two either of two forms

!_ markup example:

code{

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

}code

!_ resulting output:

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

% ={ output:table markup example;SiSU markup output:table (curly brace syntax) }

Same as a tic table

``` 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
```

Without instruction

``` table
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
```

a second form may be easier to work with in cases where there is not much
information in each column

*{markup example:}*~{ Table from the Wealth of Networks by Yochai Benkler \\ https://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler }~

code{

!_ 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.

}code

!_ resulting output:


!_ 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.

2~ Additional breaks - linebreaks within objects, column and page-breaks
={ SiSU markup:breaks (page and line);breaks }

3~ line-breaks
={ SiSU markup:line break;line break }

To break a line within a "paragraph object", two backslashes \\\\ \\ with a space before and a space or newline after them \\ may be used.

code{

To break a line within a "paragraph object",
two backslashes \\ with a space before
and a space or newline after them \\
may be used.

}code

The html break br enclosed in angle brackets (though undocumented) is available
in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being,
but is depreciated).

To draw a dividing line dividing paragraphs, see the section on page breaks.

3~ page breaks
={ SiSU markup:page break;page break }

Page breaks are only relevant and honored in some output formats. A page break
or a new page may be inserted manually using the following markup on a line on
its own:

page new =\\= breaks the page, starts a new page.

page break -\\- breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.

page break line across page -..- draws a dividing line, dividing paragraphs

page break:

code{

-\\-

}code

page (break) new:

code{

=\\=

}code

page (break) line across page (dividing paragraphs):

code{

-..-

}code


2~ Excluding Object Numbers

Object numbers can be switched off by adding a ~# to the end of a text object.

Sometimes it is wished to switch off object numbers for a larger group of text.
In this case it is possible before the group, body of text to be without object
numbers on a new line with nothing else on it to open the un-numbered object
block with --~# and to close the un-numbered block, and restart object numbering
with on a similarly otherwise empty new-line with --+#

code{

--~#

un-numbered object block of text contained here

still un-numbered

--+#

object numbering returns here and for subsequent text objects

to switch of object numbering for a single objct, to the end of the object add ~# like so:~#

}code

2~ Bibliography / References
={ SiSU markup:references|bibliography|citations;references }

There are three ways to prepare a bibliography using sisu (which are mutually
exclusive): (i) manually preparing and marking up as regular text in sisu a list
of references, this is treated as a regular document segment (and placed before
endnotes if any); (ii) preparing a bibliography, marking a heading level
#{1~!biblio}# (note the exclamation mark) and preparing a bibliography using
various metadata tags including for author: title: year: a list of which is
provided below, or; (iii) as an assistance in preparing a bibliography, marking
a heading level #{1~!biblio}# and tagging citations within footnotes for
inclusion, identifying citations and having a parser attempt to extract them and
build a bibliography of the citations provided.

For the heading/section sequence: endnotes, bibliography then book index to
occur, the name biblio or bibliography must be given to the bibliography
section, like so:

code{

1~!biblio

}code

3~ a markup tagged metadata bibliography section

Here instead of writing your full citations directly in footnotes, each time you
have new material to cite, you add it to your bibliography section (if it has
not been added yet) providing the information you need against an available list
of tags (provided below).

The required tags are au: ti: and year: ~{for which you may alternatively use
the full form author: title: and year: }~ an short quick example might be as
follows:

code{

1~!biblio

au: von Hippel, E.
ti: Perspective: User Toolkits for Innovation
lng: (language)
jo: Journal of Product Innovation Management
vo: 18
ed: (editor)
yr: 2001
note:
sn: Hippel, /{User Toolkits}/ (2001)
id: vHippel_2001
% form:

au: Benkler, Yochai
ti: The Wealth of Networks
st: How Social Production Transforms Markets and Freedom
lng: (language)
pb: Harvard University Press
edn: (edition)
yr: 2006
pl: U.S.
url: https://cyber.law.harvard.edu/wealth_of_networks/Main_Page
note:
sn: Benkler, /{Wealth of Networks}/ (2006)
id: Benkler2006

au: Quixote, Don; Panza, Sancho
ti: Taming Windmills, Keeping True
jo: Imaginary Journal
yr: 1605
url: https://en.wikipedia.org/wiki/Don_Quixote
note: made up to provide an example of author markup for an article with two authors
sn: Quixote & Panza, /{Taming Windmills}/ (1605)
id: quixote1605

}code

Note that the section name !biblio (or !bibliography) is required for the
bibliography to be treated specially as such, and placed after the
auto-generated endnote section.

Using this method, work goes into preparing the bibliography, the tags author or
editor, year and title are required and will be used to sort the bibliography
that is placed under the Bibliography section

The metadata tags may include shortname (sn:) and id, if provided, which are
used for substitution within text. Every time the given id is found within the
text it will be replaced by the given short title of the work (it is for this
reason the short title has sisu markup to italicize the title), it should work
with any page numbers to be added, the short title should be one that can easily
be used to look up the full description in the bibliography.

code{

The following footnote~{ quixote1605, pp 1000 - 1001, also Benkler2006 p 1. }~

}code

would be presented as:

Quixote and Panza, /{Taming Windmills}/ (1605), pp 1000 - 1001 also, Benkler,
/{Wealth of Networks}/, (2006) p 1 or rather~{ Quixote and Panza, /{Taming
Windmills}/ (1605), pp 1000 - 1001 also, Benkler, /{Wealth of Networks}/ (2006),
p 1 }~

code{

au: author Surname, FirstNames (if multiple semi-colon separator)
    (required unless editor to be used instead)
ti: title  (required)
st: subtitle
jo: journal
vo: volume
ed: editor (required if author not provided)
tr: translator
src: source (generic field where others are not appropriate)
in: in (like src)
pl: place/location (state, country)
pb: publisher
edn: edition
yr: year (yyyy or yyyy-mm or yyyy-mm-dd) (required)
pg: pages
url: https://url
note: note
id: create_short_identifier e.g. authorSurnameYear
    (used in substitutions: when found within text will be
    replaced by the short name provided)
sn: short name e.g. Author, /{short title}/, Year
    (used in substitutions: when an id is found within text
    the short name will be used to replace it)

}code

3~ Tagging citations for inclusion in the Bibliography

Here whenever you make a citation that you wish be included in the bibliography,
you tag the citation as such using special delimiters (which are subsequently
removed from the final text produced by sisu)

Here you would write something like the following, either in regular text or a footnote

code{

See .: Quixote, Don; Panza, Sancho /{Taming Windmills, Keeping True}/ (1605) :.

}code

SiSU will parse for a number of patterns within the delimiters to try make out
the authors, title, date etc. and from that create a Bibliography. This is more
limited than the previously described method of preparing a tagged bibliography,
and using an id within text to identify the work, which also lends itself to
greater consistency.

2~ Glossary
={ SiSU markup:glossary|Glossary }

Using the section name #{1~!glossary}# results in the Glossary being treated
specially as such, and placed after the auto-generated endnote section (before
the bibliography/list of references if there is one).

The Glossary is ordinary text marked up in a manner deemed suitable for that
purpose. e.g. with the term in bold, possibly with a hanging indent.

code{

1~!glossary

_0_1 *{GPL}* An abbreviation that stands for "General Purpose License." ...

_0_1 [provide your list of terms and definitions]

}code

In the given example the first line is not indented subsequent lines are by one level, and the term to be defined is in bold text.

2~ Book index
={ SiSU markup:book index;book index }

To make an index append to paragraph the book index term relates to it, using an
equal sign and curly braces.

Currently two levels are provided, a main term and if needed a sub-term.
Sub-terms are separated from the main term by a colon.

code{

  Paragraph containing main term and sub-term.
  ={Main term:sub-term}

}code

The index syntax starts on a new line, but there should not be an empty line
between paragraph and index markup.

The structure of the resulting index would be:

code{

  Main term, 1
    sub-term, 1

}code

Several terms may relate to a paragraph, they are separated by a semicolon. If
the term refers to more than one paragraph, indicate the number of paragraphs.

code{

  Paragraph containing main term, second term and sub-term.
  ={first term; second term: sub-term}

}code

The structure of the resulting index would be:

code{

  First term, 1,
  Second term, 1,
    sub-term, 1

}code

If multiple sub-terms appear under one paragraph, they are separated under the
main term heading from each other by a pipe symbol.

code{

  Paragraph containing main term, second term and sub-term.
  ={Main term:
      sub-term+2|second sub-term;
    Another term
   }

  A paragraph that continues discussion of the first sub-term

}code

The plus one in the example provided indicates the first sub-term spans one
additional paragraph. The logical structure of the resulting index would be:

code{

  Main term, 1,
    sub-term, 1-3,
    second sub-term, 1,
  Another term, 1

}code

1~ Composite documents markup
={ SiSU markup:composite documents;composite documents }

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
*{.ssm}* 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 *{.sst}* regular markup file, or *{.ssi}*
(insert/information) A secondary file of the composite document is built prior
to processing with the same prefix and the suffix *{._sst}*

basic markup for importing a document into a master document

code{

<< filename1.sst

<< filename2.ssi

}code

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.

1~ Substitutions
={ SiSU markup:substitutions;substitutions }

!_ markup example:

code{

The current Debian is ${debian_stable} the next debian will be ${debian_testing}

Configure substitution in _sisu/sisu_document_make

@make:
 :substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'

}code

!_ resulting output:

The current Debian is ${debian_stable} the next debian will be ${debian_testing}

Another test ${sisudoc} ok?

Configure substitution in _sisu/sisu_document_make

1~ Footnote, endnote stress test

Globalisation is to be observed as a trend intrinsic to the world economy.~{ As
Maria Cattaui Livanos suggests in /{The global economy - an opportunity to be
seized}/ in /{Business World}/ the Electronic magazine of the International
Chamber of Commerce (Paris, July 1997) at
https://www.iccwbo.org/html/globalec.htm \\ "Globalization is unstoppable. Even
though it may be only in its early stages, it is already intrinsic to the world
economy. We have to live with it, recognize its advantages and learn to manage
it. \\ That imperative applies to governments, who would be unwise to attempt to
stem the tide for reasons of political expediency. It also goes for companies of
all sizes, who must now compete on global markets and learn to adjust their
strategies accordingly, seizing the opportunities that globalization offers."}~
Rudimentary economics explains this runaway process, as being driven by
competition within the business community to achieve efficient production, and
to reach and extend available markets.~{To remain successful, being in
competition, the business community is compelled to take advantage of the
opportunities provided by globalisation.}~ Technological advancement
particularly in transport and communications has historically played a
fundamental role in the furtherance of international commerce, with the Net,
technology's latest spatio-temporally transforming offering, linchpin of the
"new-economy", extending exponentially the global reach of the business
community. The Net covers much of the essence of international commerce
providing an instantaneous, low cost, convergent, global and borderless:
information centre, marketplace and channel for communications, payments and the
delivery of services and intellectual property. The sale of goods, however,
involves the separate element of their physical delivery. The Net has raised a
plethora of questions and has frequently offered solutions. The increased
transparency of borders arising from the Net's ubiquitous nature results in an
increased demand for the transparency of operation. As economic activities
become increasingly global, to reduce transaction costs, there is a strong
incentive for the "law" that provides for them, to do so in a similar dimension.
The appeal of transnational legal solutions lies in the potential reduction in
complexity, more widely dispersed expertise, and resulting increased transaction
efficiency. The Net reflexively offers possibilities for the development of
transnational legal solutions, having in a similar vein transformed the
possibilities for the promulgation of texts, the sharing of ideas and
collaborative ventures. There are however, likely to be tensions within the
legal community protecting entrenched practices against that which is new, (both
in law and technology) and the business community's goal to reduce transaction
costs. This here https://sisudoc.org/now is a test and repeat { does this work?
}https://www.sisudoc.com/ok.html

Within commercial law an analysis of law and economics may assist in
developing a better understanding of the relationship between commercial
law and the commercial sector it serves.~{ Realists would contend that law
is contextual and best understood by exploring the interrelationships
between law and the other social sciences, such as sociology, psychology,
political science, and economics.}~ "...[T]he importance of the
interrelations between law and economics can be seen in the twin facts
that legal change is often a function of economic ideas and conditions,
which necessitate and/or generate demands for legal change, and that
economic change is often governed by legal change."~{ Part of a section
cited in Mercuro and Steven G. Medema, /{Economics and the Law: from
Posner to Post-Modernism}/ (Princeton, 1997) p. 11, with reference to Karl
N. Llewellyn The Effect of Legal Institutions upon Economics, American
Economic Review 15 (December 1925) pp 655-683, Mark M. Litchman Economics,
the Basis of Law, American Law Review 61 (May-June 1927) pp 357-387, and
W. S. Holdsworth A Neglected Aspect of the Relations between Economic and
Legal History, Economic History Review 1 (January 1927-1928) pp 114-123.}~
In doing so, however, it is important to be aware that there are several
competing schools of law and economics, with different perspectives,
levels of abstraction, and analytical consequences of and for the world
that they model.~{ For a good introduction see Nicholas Mercuro and Steven
G. Medema, /{Economics and the Law: from Posner to Post-Modernism}/
(Princeton, 1997). These include: Chicago law and economics (New law and
economics); New Haven School of law and economics; Public Choice Theory;
Institutional law and economics; Neoinstitutional law and economics;
Critical Legal Studies.}~ This sentence trails test endnote.
$$$

$$$

Difference?~{ puzzle away }~

* !glossary

head

!_ header
document header, containing document specific (i) metadata information or (ii)
make instructions

!_ (document) structure
relationship between headings and sub-headings, and the objects they contain.
Document structure is extracted from heading levels, which are either:
explicitly marked up, or; determined from a make regex provided in the document
header. Use of document structure allow for the meaningful representation of
documents in alternative ways and the use of ocn permits easy reference across
different output formats.

!_ heading
document heading, each heading is marked indicating its level (in relation to
other headings), and this is used as basis for determininge document structure.
There are 8 levels, which are can be distinguesed as being one of three types:
(i) 1 title level (marked up A or numeric 0); (ii) 3 optional document division
levels, above text separating headings (marked up B - D, or numeric 1 to 3);
(iii) 4 text headings (marked up 1 - 4, or numeric 4 to 7)

!_ levels == heading levels
document heading level, see heading and structure

marked up headings / mark up level

collapsed headings / collapsed levels

numeric levels

!_ dummy heading
a markup level 1 / dummy level 4 that does not exist in the original text that
is manually inserted to maintain the documents structure rule that text follows
a heading of markup level 1 (rather than A to D) (numeric level 4 rather than 0
to 3)

relatives? see ancestors and descendants

document ...

!_ ancestors
heading levels above the current heading level which it logically falls under
and to which it belongs (headings preceding current level under which it occurs)

!_ decendants
decendant headings are sub-headings beneath the current heading level, heading
levels below the current heading level which are derived from it and belong to
it (sub-headings contained beneath current level); decendant objects are the
range of objects contained by a heading (ocn ranges for each heading in document
body)

!_ (document) sections
a document can be divided into 3 parts: front; body and; back. Front matter
includes the table of contents (which is generated from headings) and any parts
of the document that are presented before the document body (this might include
a copyright notice for example). The document body, the substantive part of the
document, all its substantive objects, including: headings, paragraphs, tables,
verse etc. This is followed by optional backmatter: endnotes, generated from
inline markup; glossary, from section using a subset of regular markup, with an
indication that section is to be treated as glossary. Note two things glossary
might do that it does not, there is: no automatic (sorting) alphabetisation of
listing; no creation of term anchor tags (perhaps it should); bibliography,
created from a specially marked up section, with indication that section is to
be treated as bibliography; bookindex generated from dedicated markup appended
to objects providing index terms and the relevant range; blurb made up of
ordinary markup, with indication that section is to be treated as blurb

!_ segment, segmented text
certain forms of output are conveniently segmented, e.g. epub and segmented
html. The document is broken into chunks indicated by markup level 1 heading
(numeric level 4 headings) as the significant level at which the document should
be segmented, and including all decendant objects of that level. For a longer
text/book this will usually the chapter level. (this is significant in e.g. for
epub and segmented html, which are broken by segment, usually chosen to be
chapter)

!_ scroll
the document as a "scroll", e.g. as a single text file, or continuous html
document

!_ object
a unit of text. Objects include: headings; paragraphs; code blocks; grouped
text; verse of poems; tables. Each substantive object is given an object number,
that should make it citable.

!_ ocn (object citation number / citation number)
numbers assigned sequentially to each substantive object of a document. An ocn
has the characteristic of remaining identical across output formats.
Translations should be prepared so number remains identical across objects in
different languages

unnumbered paragraph (place marker at end of paragraph)

% ~#

unnumbered paragraph, delete when not required (place marker at end of
paragraph) [used in dummy headings, eg. sometimes used for segmented html, e.g.
to mark a prologue that is not otherwise identified as such as belonging to its
own segment, segment will be created as such an placed in toc, but will not be
found in scroll versions of the document]

% -#

citation number (see ocn / object citation number)

!_ heading auto-numbering
set in header, switched off in markup level 1~ with an appended minus 1~- or 1~given_segname-


% % add a comment to text, that will be removed prior to processing (place marker at beginning of line)

!_ document abstraction (== internal representation) intermediate step,
preprocessing of document, into abstraction / representation that is used by all
downstream processing, i.e. for all output formats. This allows normalisation,
reducing alternative markup options to common representations, e.g. code blocks
(open and close), tables, ways of instructing that text be bold, shortuct way of
providing and endnote reference to a link

(document) internal representation (== document abstraction)
see document abstraction

node representation

!_ attribute (object attributes)
when the document is abstracted attributes associated with an object, for
example for a: paragraph, indent (hang ... check & add), bulleted, for a: code
block, the language syntax, whether the block is numbered

!_ inline markup
when the document is abstracted, markup that remains embedded in the text, such
as its font face (bold, italic, emphasis, underscore, strike, superscript,
subscript), links, endnotes

sequential all objects backkeeping number?

1~commands Sample Commands

2~ general

~sdp/bin/sdp-ldc -v --epub --html --sqlite-update --output-dir=tmp/program-output data/sisupod/sisu-manual

time ( ~sdp/bin/sdp-ldc -v --epub --html --sqlite-update --output-dir=tmp/program-output data/sisupod/* )

2~ source & sisupod

~sdp/bin/sdp-ldc -v --source --sisupod --output-dir=tmp/program-output data/sisudir/media/text/sisu-manual.sst

~sdp/bin/sdp-ldc -v --source --sisupod --output-dir=tmp/program-output data/sisupod/sisu-manual

~sdp/bin/sdp-ldc -v --source --sisupod --output-dir=tmp/program-output data/sisupod/*

2~ sqlite

~sdp/bin/sdp-ldc -v --sqlite-db-drop --output-dir=tmp/program-output

~sdp/bin/sdp-ldc -v --sqlite-db-create --output-dir=tmp/program-output

~sdp/bin/sdp-ldc -v --sqlite-db-recreate --output-dir=tmp/program-output

~sdp/bin/sdp-ldc -v --sqlite-db-recreate --sqlite-insert --output-dir=tmp/program-output data/sisupod/*

~sdp/bin/sdp-ldc -v --sqlite-db-recreate --sqlite-update --output-dir=tmp/program-output data/sisupod/*

~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/*

~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/*

~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/sisu-manual

~sdp/bin/sdp-ldc -v --sqlite-db-drop --sqlite-db-create --sqlite-update --epub --html --output-dir=tmp/program-output data/sisupod/sisu-manual

~sdp/bin/sdp-dmd -v --epub --html --output-dir=tmp/program-output data/sisudir/media/text/sisu_markup.sst

1~!blurb On SiSU

SiSU was started in 1997, open-sourced in 2005.