aboutsummaryrefslogtreecommitdiffhomepage
path: root/README
blob: de84b575654f10981abe7b209bd5374b09106a5b (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
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
SISU - README
=============

INTRODUCTION
************

INTRODUCTION - WHAT IS SISU?
----------------------------

*SiSU* is a lightweight markup based document creation and publishing framework
that is controlled from the command line. Prepare documents for *SiSU* using
your text editor of choice, then use *SiSU* to generate various output document
formats.

From a single lightly prepared document (plain-text /UTF-8/) sisu custom builds
several standard output formats which share a common (text object) numbering
system for citation of content within a document (that also has implications
for search). The sisu engine works with an abstraction of the document's
structure and content from which it is possible to generate different forms of
representation of the document. *SiSU* produces: plain-text, /HTML/, /XHTML/,
/XML/, /EPUB/, /ODF/: /ODT/ (Opendocument), /LaTeX/, /PDF/, and populates an
/SQL/ database (/PostgreSQL/ or /SQLite/) with text objects, roughly, paragraph
sized chunks so that document searches are done at this level of granularity.

Outputs share a common citation numbering system, associated with text objects
and any semantic meta-data provided about the document.

*SiSU* also provides concordance files, document content certificates and
manifests of generated output. Book indexes may be made.

Some document markup samples are provided in the package sisu -markup-samples.

Homepages:
- <https://www.sisudoc.org/>

INSTALL OR RUN WITHOUT INSTALLATION
***********************************

SOURCE TREE
-----------

RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING)
..........................................................

Download & unpack the latest source tarball

or

Git clone the latest source, to clone the latest source without the repo
history:

git clone --depth 1 git://git.sisudoc.org/git/code/sisu.git --branch upstream

Provided you have *Ruby*, *SiSU* can be run without installation straight from
the source package directory tree. Run ruby against the full path to bin/sisu
(in the unzipped source package directory tree)

Note however, that additional external package dependencies, such as texlive
(for pdfs), sqlite3 or postgresql (for search) should you desire to use them
are not taken care of for you.

GEM INSTALL
...........

Gem install, you need to:

(i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install
the gem


----------------------------------------

GEM INSTALL WITH QI (QUICK INSTALL) SCRIPT
..........................................

(This requires that ruby -thor is installed).

qi (quick install) can go through the steps required to install the gem:

  qi gem --create --build --install --stable

or

  qi gem --create --build --install --unstable


----------------------------------------

GEM INSTALL WITH RAKE
.....................

Provided you have ruby & rake, this can be done with the single command:

  rake gem_create_build_install # (to build and install, alias gemcbi)

for individual steps (create, build, install) see rake options, rake -T to
specify sisu version for sisu installed via gem

For a list of alternative actions you may type:

  rake help

  rake -T

Rake: <https://rake.rubyforge.org/> <https://rubyforge.org/frs/?group_id=50>


----------------------------------------

MISC GEM
........

gem search sisu

  sisu _7.0.0_ --version

  sisu _7.0.0_ --version

to uninstall sisu installed via gem

  sudo gem uninstall --verbose sisu

DIRECT INSTALLATION WITH QI (QUICK INSTALL) SCRIPT
..................................................

(This requires that ruby -thor is installed).

Root will be requested as required:

  qi setup --bin --lib --conf --data --share --man

or

  qi setup --all

You may wish to do a dryrun to see where files would be installed without
copying them, to do so add the flag --dryrun

INSTALLATION WITH SETUP.RB
..........................

It should also be possible to install sisu using setup.rb

this is a three step process, in the root directory of the unpacked *SiSU* as
root type:

ruby setup.rb config
ruby setup.rb setup
#[as root:]
ruby setup.rb install

further information:
<https://i.loveruby.net/en/projects/setup/>
<https://i.loveruby.net/en/projects/setup/doc/usage.html>

  ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install

UNIX/LINUX DISTRIBUTION
-----------------------

A distribution install should take care of the dependencies of sisu for
producing various outputs.

DEBIAN
......

*SiSU* is available off the *Debian* archives. It should necessary only to run
as root, Using apt-get:

  apt-get update

  apt get install sisu-complete

(all sisu dependencies should be taken care of)

If there are newer versions of *SiSU* upstream, they will be available by
adding the following to your sources list /etc/apt/sources.list

#/etc/apt/sources.list

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

The non-free section is for sisu markup samples provided, which contain
authored works the substantive text of which cannot be changed, and which as a
result do not meet the debian free software guidelines.

*SiSU* is developed on *Debian*, and packages are available for *Debian* that
take care of the dependencies encountered on installation.

The package is divided into the following components:

  *sisu*, the base code, (the main package on which the others depend), without
  any dependencies other than ruby (and for convenience the ruby webrick web
  server), this generates a number of types of output on its own, other
  packages provide additional functionality, and have their dependencies

  *sisu-complete*, a dummy package that installs the whole of greater sisu as
  described below, apart from sisu -examples

  *sisu-pdf*, dependencies used by sisu to produce pdf from /LaTeX/ generated

  *sisu-postgresql*, dependencies used by sisu to populate postgresql database
  (further configuration is necessary)

  *sisu-sqlite*, dependencies used by sisu to populate sqlite database

  *sisu-markup-samples*, sisu markup samples and other miscellany (under
  *Debian* Free Software Guidelines non-free)

*SiSU* is available off Debian Unstable and Testing [link:
<https://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu>]
[^1] install it using apt-get, aptitude or alternative *Debian* install tools.

DEPENDENCIES
------------

Here is a list of sisu' s current dependencies,[^2] which depend on such
factors as whether you want to generate pdf, whether you will be using *SiSU*
with or without a database, ...). sisu_markup-samples may also be of interest.

Package: sisu
Depends: ruby | ruby-interpreter, openssl, rsync, unzip, zip
Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick |
graphicsmagick, keychain, openssh-client | lsh-client, po4a, qrencode, rake,
ruby-rmagick, tidy, tree, vim-addon-manager
Suggests: lv, calibre, pinfo, poedit, texinfo, trang

Package: sisu-complete
Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sisu-pdf (=
${source:Version}), sisu-postgresql (= ${source:Version}), sisu-sqlite (=
${source:Version})
Description-en: installs all SiSU related packages

Package: sisu-pdf
Depends: ruby | ruby-interpreter, sisu (= ${source:Version}),
texlive-latex-base, texlive-fonts-recommended, texlive-generic-recommended,
texlive-latex-recommended, texlive-latex-extra, texlive-math-extra,
texlive-xetex, fonts-liberation, lmodern, latex-cjk-all, texlive-lang-cjk
Suggests: evince | pdf-viewer

Package: sisu-postgresql
Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), postgresql,
ruby-dbd-pg, ruby-dbi, ruby-fcgi
Suggests: postgresql-contrib

Package: sisu-sqlite
Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sqlite3,
ruby-sqlite3, ruby-dbd-sqlite3, ruby-dbi, ruby-fcgi

Package: sisu-markup-samples
Depends: sisu

COMMANDS
********

COMMANDS SUMMARY
----------------

DESCRIPTION
...........

*SiSU* is a document publishing system, that from a simple single marked-up
document, produces multiple output formats including: /plaintext/, /HTML/,
/XHTML/, /XML/, /EPUB/, /ODT/ (/OpenDocument/ (/ODF/) text), /LaTeX/, /PDF/,
info, and /SQL/ (/PostgreSQL/ and /SQLite/) , which share text object numbers
("object citation numbering") and the same document structure information. For
more see: <https://sisudoc.org> or <https://git.sisudoc.org>

DOCUMENT PROCESSING COMMAND FLAGS
.................................

*-[0-9] [filename/wildcard]*
see --act

*--ao [filename/wildcard/url]*
assumed for most other flags, creates new intermediate files for processing
(abstract objects, document abstraction) that is used in all subsequent
processing of other output. This step is assumed for most processing flags. To
skip it see -n. Alias -m.

*--act[s0-9] [filename/wildcard]*
--act0 to --act9 configurable shortcuts for multiple flags, -0 to -9 synonyms,
configure in sisurc.yml; sisu default action on a specified file where no flag
is provided is --act0; --act or --acts for information on current actions
ascribed to --act0 to --act9

*--asciidoc [filename/wildcard]*
asciidoc, smart text (not available)

*-b [filename/wildcard]*
see --xhtml

*--by-**
see --output-by-*

*-C*
configure/initialise shared output directory files initialize shared output
directory (config files such as css and dtd files are not updated if they
already exist unless modifier is used). -C --init-site configure/initialise
site more extensive than -C on its own, shared output directory files/force
update, existing shared output config files such as css and dtd files are
updated if this modifier is used.

*-c [filename/wildcard]*
see --color-toggle

*--color*
see --color-on

*--color-off*
turn off color in output to terminal

*--color-on*
turn on color in output to terminal

*--color-toggle [filename/wildcard]*
screen toggle ansi screen colour on or off depending on default set (unless -c
flag is used: if sisurc colour default is set to 'true', output to screen will
be with colour, if sisurc colour default is set to 'false' or is undefined
screen output will be without colour). Alias -c

*--configure*
configure/initialise shared output directory files initialize shared output
directory (config files such as css and dtd files are not updated if they
already exist unless modifier is used). The equivalent of: -C --init-site
configure/initialise site, more extensive than -C on its own, shared output
directory files/force update, existing shared output config files such as css
and dtd files are updated if -CC is used.

*--concordance [filename/wildcard]*
produces concordance (wordmap) a rudimentary index of all the words in a
document. (Concordance files are not generated for documents of over 260,000
words unless this limit is increased in the file sisurc.yml). Alias -w

*-d [filename/wildcard/url]*
see --docbook

*--dal [filename/wildcard/url]*
(abstract objects, document abstraction renamed abstract objects in sisu5) see
--ao

*--delete [filename/wildcard]*
see --zap

*--digests [filename/wildcard/url]*
document digest or document content certificate ( DCC ) as sha digest tree of
the document: the digest for the document, and digests for each object
contained within the document (together with information on software versions
that produced it) (digest.txt). --digests -V for verbose digest output to
screen.

*--docbook [filename/wildcard/url]*
docbook xml

*--dom [filename/wildcard/url]*
see --xml-dom

*--dump[=directory_path] [filename/wildcard]*
places output in directory specified, if none is specified in the current
directory (pwd). Unlike using default settings /HTML/ files have embedded css.
Compare --redirect

*-e [filename/wildcard]*
see --epub

*--epub [filename/wildcard]*
produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e

*--errors-as-warnings*
override stop processing on error. Alias --no-stop

*--exc-**
exclude output feature, overrides configuration settings --exc-numbering, see
--exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off
object citation numbers), affects html (seg, scroll), epub, xhtml, xml, pdf) ;
--exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) ;
--exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest,
affects html (seg, scroll)); --exc-search-form, (exclude search form, affects
html (seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents,
affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude
mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini
table of contents, affects html (seg), concordance); --exc-html-navigation,
(exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude
navigation bar, affects html (seg)); --exc-html-search-form, (exclude search
form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right
pane/column, affects html (seg, scroll)); --exc-html-top-band, (exclude top
band, affects html (seg, scroll), concordance (minitoc forced on to provide seg
navigation)); --exc-segsubtoc (exclude sub table of contents, affects html
(seg), epub) ; see also --inc-*

*-F [--webserv=webrick]*
see --sample-search-form

*-f [optional string part of filename]*
see --find

*--fictionbook [filename/wildcard/url]*
fictionbook xml (not available)

*--find [optional string part of filename]*
see --glob

*-G [optional string part of filename]*
see --glob

*-g [filename/wildcard]*
see --git

*--git [filename/wildcard]*
produces or updates markup source file structure in a git repo (experimental
and subject to change). Alias -g

*--glob [optional string part of filename]*
without match string, glob all .sst .ssm files in directory (including language
subdirectories). With match string, find files that match given string in
directory (including language subdirectories). Alias -G, -f, --find

*-h [filename/wildcard]*
see --html

*--harvest *.ss[tm]*
makes two lists of sisu output based on the sisu markup documents in a
directory: list of author and authors works (year and titles), and; list by
topic with titles and author. Makes use of header metadata fields (author,
title, date, topic_register). Can be used with maintenance (-M) and remote
placement (-R) flags.

*--html [filename/wildcard]*
produces html output, in two forms (i) segmented text with table of contents
(toc.html and index.html) and (ii) the document in a single file (scroll.html).
Alias -h

*--html-scroll [filename/wildcard]*
produces html output, the document in a single file (scroll.html) only. Compare
--html-seg and --html

*--html-seg [filename/wildcard]*
produces html output, segmented text with table of contents (toc.html and
index.html). Compare --html-scroll and --html

*--html-strict [filename/wildcard]*
produces html with --strict option. see --strict

*-I [filename/wildcard]*
see --texinfo

*-i [filename/wildcard]*
see --manpage

*--i18n-**
these flags affect output by filetype and filename): --i18n-mono
(--monolingual) output filenames without language code for default language
('en' or as set); --i18n-multi (--multilingual) language code provided as part
of the output filename, this is the default. Where output is in one language
only the language code may not be desired. see also --output-by-*

*--inc-**
include output feature, overrides configuration settings, (usually the default
if none set), has precedence over --exc-* (exclude output feature). Some detail
provided under --exc-*, see --exc-*

*-j [filename/wildcard]*
copies images associated with a file for use by html, xhtml & xml outputs
(automatically invoked by --dump & redirect).

*-k*
see --color-off

*--keep-processing-files [filename/wildcard/url]*
see --maintenance

*-M [filename/wildcard/url]*
see --maintenance

*-m [filename/wildcard/url]*
see --dal (document abstraction level/layer)

*--machine [filename/wildcard/url]*
see --dal (document abstraction level/layer)

*--maintenance [filename/wildcard/url]*
maintenance mode, interim processing files are preserved and their locations
indicated. (also see -V). Aliases -M and --keep-processing-files.

*--manifest [filename/wildcard]*
produces an html summary of output generated (hyperlinked to content) and
document specific metadata (sisu_manifest.html). This step is assumed for most
processing flags.

*--manpage [filename/wildcard]*
produces man page of file, not suitable for all outputs. Alias -i

*--markdown [filename/wildcard/url]*
markdown smart text (not available)

*--monolingual*
see --i18n-*

*--multilingual*
see --i18n-*

*-N [filename/wildcard/url]*
see --digests

*-n [filename/wildcard/url]*
skip the creation of intermediate processing files (document abstraction) if
they already exist, this skips the equivalent of -m which is otherwise assumed
by most processing flags.

*--no-**
see --exc-*

*--no-stop*
override stop processing on error. Alias --erros-as-warnings

*--numbering*
turn on "object citation numbers". See --inc-ocn and --exc-ocn

*-o [filename/wildcard/url]*
see --odt

*--ocn*
"object citation numbers". See --inc-ocn and --exc-ocn

*--odf [filename/wildcard/url]*
see --odt

*--odt [filename/wildcard/url]*
output basic document in opendocument file format (opendocument.odt). Alias -o

*--output-by-**
select output directory structure from 3 alternatives: --output-by-language,
(language directory (based on language code) with filetype (html, epub, pdf
etc.) subdirectories); --output-by-filetype, (filetype directories with
language code as part of filename); --output-by-filename, (filename directories
with language code as part of filename). This is configurable. Alias --by-*

*-P [language_directory/filename language_directory]*
see --po4a

*-p [filename/wildcard]*
see --pdf

*--papersize-(a4|a5|b5|letter|legal)*
in conjunction with --pdf set pdf papersize, overriding any configuration
settings, to set more than one papersize repeat the option --pdf --papersize-a4
--papersize-letter. See also --papersize=*

*--papersize=a4,a5,b5,letter,legal* in conjunction with --pdf set pdf
papersize, overriding any configuration settings, to set more than one
papersize list after the equal sign with a comma separator
--papersize=a4,letter. See also --papersize-*

*--pdf [filename/wildcard]*
produces /LaTeX/ pdf (portrait.pdf & landscape.pdf). Orientation and papersize
may be set on the command-line. Default paper size is set in config file, or
document header, or provided with additional command line parameter, e.g.
--papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book
sizes 'A5' and 'B5' (system defaults to A4), and; --landscape or --portrait,
so: e.g. "sisu --pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]"
or "sisu --pdf --landscape --a4 --letter --verbose [filename/wildcard]". --pdf
defaults to both landscape & portrait output, and a4 if no other papersizes are
configured. Related options --pdf-landscape --pdf-portrait --pdf-papersize-*
--pdf-papersize=[list]. Alias -p

*--pdf-l [filename/wildcard]*
See --pdf-landscape

*--pdf-landscape [filename/wildcard]*
sets orientation, produces /LaTeX/ pdf landscape.pdf. Default paper size is set
in config file, or document header, or provided with additional command line
parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and
'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options
--pdf --pdf-portrait. See also --papersize-* or --papersize=[list]. Alias
--pdf-l or in conjunction with --pdf --landscape

*--pdf-p [filename/wildcard]*
See --pdf-portrait

*--pdf-portrait [filename/wildcard]*
sets orientation, produces /LaTeX/ pdf portrait.pdf.pdf. Default paper size is
set in config file, or document header, or provided with additional command
line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter'
and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related
options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list].
Alias --pdf-p or in conjunction with --pdf --portrait

*--pg-[instruction] [filename]*
database /PostgreSQL/ ( --pgsql may be used instead) possible instructions,
include: --pg-createdb; --pg-create; --pg-dropall; --pg-import [filename];
--pg-update [filename]; --pg-remove [filename]; see database section below.

*--po [language_directory/filename language_directory]*
see --po4a

*--po4a [language_directory/filename language_directory]*
produces .pot and po files for the file in the languages specified by the
language directory. *SiSU* markup is placed in subdirectories named with the
language code, e.g. en/ fr/ es/. The sisu config file must set the output
directory structure to multilingual. v3, experimental

*-Q [filename/wildcard]*
see --qrcode

*-q [filename/wildcard]*
see --quiet

*--qrcode [filename/wildcard]*
generate QR code image of metadata (used in manifest).

*--quiet [filename/wildcard]*
quiet less output to screen.

*-R [filename/wildcard]*
see --rsync

*-r [filename/wildcard]*
see --scp

*--redirect[=directory_path] [filename/wildcard]*
places output in subdirectory under specified directory, subdirectory uses the
filename (without the suffix). If no output directory is specified places the
subdirectory under the current directory (pwd). Unlike using default settings
/HTML/ files have embedded css. Compare --dump

*--rst [filename/wildcard/url]*
ReST (rST restructured text) smart text (not available)

*--rsync [filename/wildcard]*
copies sisu output files to remote host using rsync. This requires that
sisurc.yml has been provided with information on hostname and username, and
that you have your "keys" and ssh agent in place. Note the behavior of rsync
different if -R is used with other flags from if used alone. Alone the rsync
--delete parameter is sent, useful for cleaning the remote directory (when -R
is used together with other flags, it is not). Also see --scp. Alias -R

*-S*
see --sisupod

*-S [filename/wildcard]*
see --sisupod

*-s [filename/wildcard]*
see --source

*--sample-search-form [--db-(pg|sqlite)]*
generate examples of (naive) cgi search form for /SQLite/ or PgSQL depends on
your already having used sisu to populate an /SQLite/ or PgSQL database, (the
/SQLite/ version scans the output directories for existing sisu_sqlite
databases, so it is first necessary to create them, before generating the
search form) see --sqlite & --pg and the database section below. Optional
additional parameters: --db-user='www-data'. The samples are dumped in the
present work directory which must be writable, (with screen instructions given
that they be copied to the cgi-bin directory). Alias -F

*--sax [filename/wildcard/url]*
see --xml-sax

*--scp [filename/wildcard]*
copies sisu output files to remote host using scp. This requires that
sisurc.yml has been provided with information on hostname and username, and
that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r

*--sha256*
set hash digest where used to sha256

*--sha512*
set hash digest where used to sha512

*--sqlite-[instruction] [filename]*
database type set to /SQLite/, this produces one of two possible databases,
without additional database related instructions it produces a discreet
/SQLite/ file for the document processed; with additional instructions it
produces a common /SQLite/ database of all processed documents that (come from
the same document preparation directory and as a result) share the same output
directory base path (possible instructions include: --sqlite-createdb;
--sqlite-create; --sqlite-dropall; --sqlite-import [filename]; --sqlite-update
[filename]; --sqlite-remove [filename]); see database section below.

*--sisupod*
produces a sisupod a zipped sisu directory of markup files including sisu
markup source files and the directories local configuration file, images and
skins. Note: this only includes the configuration files or skins contained in
./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option
is tested only with zsh). Alias -S

*--sisupod [filename/wildcard]*
produces a zipped file of the prepared document specified along with associated
images, by default named sisupod.zip they may alternatively be named with the
filename extension .ssp This provides a quick way of gathering the relevant
parts of a sisu document which can then for example be emailed. A sisupod
includes sisu markup source file, (along with associated documents if a master
file, or available in multilingual versions), together with related images and
skin. *SiSU* commands can be run directly against a sisupod contained in a
local directory, or provided as a url on a remote site. As there is a security
issue with skins provided by other users, they are not applied unless the flag
--trust or --trusted is added to the command instruction, it is recommended
that file that are not your own are treated as untrusted. The directory
structure of the unzipped file is understood by sisu, and sisu commands can be
run within it. Note: if you wish to send multiple files, it quickly becomes
more space efficient to zip the sisu markup directory, rather than the
individual files for sending). See the -S option without [filename/wildcard].
Alias -S

*--source [filename/wildcard]*
copies sisu markup file to output directory. Alias -s

*--strict*
together with --html, produces more w3c compliant html, for example not having
purely numeric identifiers for text, the location object url#33 becomes url#o33

*-T [filename/wildcard (*.termsheet.rb)]*
standard form document builder, preprocessing feature

*-t [filename/wildcard]*
see --txt

*--texinfo [filename/wildcard]*
produces texinfo and info file, (view with pinfo). Alias -I

*--textile [filename/wildcard/url]*
textile smart text (not available)

*--txt [filename/wildcard]*
produces /plaintext/ with Unix linefeeds and without markup, (object numbers
are omitted), has footnotes at end of each paragraph that contains them [ -A
for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options
include: --endnotes for endnotes --footnotes for footnotes at the end of each
paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias
-t

*--txt-asciidoc [filename/wildcard]*
see --asciidoc

*--txt-markdown [filename/wildcard]*
see --markdown

*--txt-rst [filename/wildcard]*
see --rst

*--txt-textile [filename/wildcard]*
see --textile

*-U [filename/wildcard]*
see --urls

*-u [filename/wildcard]*
provides url mapping of output files for the flags requested for processing,
also see -U

*--urls [filename/wildcard]*
prints url output list/map for the available processing flags options and
resulting files that could be requested, (can be used to get a list of
processing options in relation to a file, together with information on the
output that would be produced), -u provides url output mapping for those flags
requested for processing. The default assumes sisu_webrick is running and
provides webrick url mappings where appropriate, but these can be switched to
file system paths in sisurc.yml. Alias -U

*-V*
on its own, provides *SiSU* version and environment information (sisu --help
env)

*-V [filename/wildcard]*
even more verbose than the -v flag.

*-v*
on its own, provides *SiSU* version information

*-v [filename/wildcard]*
see --verbose

*--verbose [filename/wildcard]*
provides verbose output of what is being generated, where output is placed (and
error messages if any), as with -u flag provides a url mapping of files created
for each of the processing flag requests. Alias -v

*--very-verbose [filename/wildcard]*
provides more verbose output of what is being generated. See --verbose. Alias
-V

*--version*
sisu version

*-W*
see --webrick

*-w [filename/wildcard]*
see --concordance

*--webrick*
starts ruby' s webrick webserver points at sisu output directories, the default
port is set to 8081 and can be changed in the resource configuration files.
[tip: the webrick server requires link suffixes, so html output should be
created using the -h option rather than -H ; also, note -F webrick ]. Alias -W

*--wordmap [filename/wildcard]*
see --concordance

*--xhtml [filename/wildcard]*
produces xhtml//XML/ output for browser viewing (sax parsing). Alias -b

*--xml-dom [filename/wildcard]*
produces /XML/ output with deep document structure, in the nature of dom. Alias
-X

*--xml-sax [filename/wildcard]*
produces /XML/ output shallow structure (sax parsing). Alias -x

*-X [filename/wildcard]*
see --xml-dom

*-x [filename/wildcard]*
see --xml-sax

*-Y [filename/wildcard]*
produces a short sitemap entry for the document, based on html output and the
sisu_manifest. --sitemaps generates/updates the sitemap index of existing
sitemaps. (Experimental, [g,y,m announcement this week])

*-y [filename/wildcard]*
see --manifest

*-Z [filename/wildcard]*
see --zap

*--zap [filename/wildcard]*
Zap, if used with other processing flags deletes output files of the type about
to be processed, prior to processing. If -Z is used as the lone processing
related flag (or in conjunction with a combination of -[mMvVq]), will remove
the related document output directory. Alias -Z

COMMAND LINE MODIFIERS
----------------------

*--no-ocn*
[with --html --pdf or --epub] switches off /object citation numbering/. Produce
output without identifying numbers in margins of html or /LaTeX//pdf output.

*--no-annotate*
strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus
sign

*--no-asterisk*
strips output text of editor endnotes[^*2] denoted by asterisk sign

*--no-dagger*
strips output text of editor endnotes[^+1] denoted by dagger/plus sign

DATABASE COMMANDS
-----------------

*dbi - database interface*

*--pg or --pgsql* set for /PostgreSQL/ *--sqlite* default set for /SQLite/ -d
is modifiable with --db=[database type (PgSQL or /SQLite/) ]

*--pg -v --createall*
initial step, creates required relations (tables, indexes) in existing
/PostgreSQL/ database (a database should be created manually and given the same
name as working directory, as requested) (rb.dbi) [ -dv --createall /SQLite/
equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at
the present time for /PostgreSQL/ it may be necessary to manually create the
database. The command would be 'createdb [database name]' where database name
would be SiSU_[present working directory name (without path)]. Please use only
alphanumerics and underscores.

*--pg -v --import*
[filename/wildcard] imports data specified to /PostgreSQL/ db (rb.dbi) [ -dv
--import /SQLite/ equivalent]

*--pg -v --update*
[filename/wildcard] updates/imports specified data to /PostgreSQL/ db (rb.dbi)
[ -dv --update /SQLite/ equivalent]

*--pg --remove*
[filename/wildcard] removes specified data to /PostgreSQL/ db (rb.dbi) [ -d
--remove /SQLite/ equivalent]

*--pg --dropall*
kills data" and drops (/PostgreSQL/ or /SQLite/) db, tables & indexes [ -d
--dropall /SQLite/ equivalent]

The -v is for verbose output.

COMMAND LINE WITH FLAGS - BATCH PROCESSING
..........................................

In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst"
or "sisu -h *.{sst,ssm}" to produce html version of all documents.

Running sisu (alone without any flags, filenames or wildcards) brings up the
interactive help, as does any sisu command that is not recognised. Enter to
escape.

INTRODUCTION TO SISU MARKUP[^3]
-------------------------------

SUMMARY
.......

*SiSU* source documents are /plaintext/ (/UTF-8/)[^4] files

All paragraphs are separated by an empty line.

Markup is comprised of:

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

  * heading levels defines document structure

  * text basic attributes, italics, bold etc.

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

  * footnotes/endnotes

  * linked text and images

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

MARKUP RULES, DOCUMENT STRUCTURE AND METADATA REQUIREMENTS
..........................................................

minimal content/structure requirement:

[metadata]

A~ (level A [title])

1~ (at least one level 1 [segment/(chapter)])

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 has the fllowing levels:

A~ [title]              .
   required (== 1)   followed by B~ or 1~
B~ [part]               *
   followed by C~ or 1~
C~ [subpart]            *
   followed by D~ or 1~
D~ [subsubpart]         *
   followed by 1~
1~ [segment (chapter)]  +
   required (>= 1)   followed by text or 2~
text                    *
   followed by more text or 1~, 2~
   or relevant part *()
2~ [subsegment]         *
   followed by text or 3~
text                    *
   followed by more text or 1~, 2~ or 3~
   or relevant part, see *()
3~ [subsubsegment]      *
   followed by text
text                    *
   followed by more text or 1~, 2~ or 3~ or relevant part, see *()

*(B~ if none other used;
  if C~ is last used: C~ or B~;
  if D~ is used: D~, C~ or B~)

- level A~ is the tile and is mandatory
- there can only be one level A~
- heading levels BCD, 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)

MARKUP EXAMPLES
...............


----------------------------------------

ONLINE
......

Online markup examples are available together with the respective outputs
produced from <https://git.sisudoc.org/sisu-markup> or from

There is of course this document, which provides a cursory overview of sisu
markup and the respective output produced:

an alternative presentation of markup syntax:
/usr/share/doc/sisu/on_markup.txt.gz


----------------------------------------

INSTALLED
.........

With *SiSU* installed sample skins may be found in:
/usr/share/doc/sisu/markup-samples (or equivalent directory) and if sisu
-markup-samples is installed also under:
/usr/share/doc/sisu/markup-samples-non-free

MARKUP OF HEADERS
-----------------

Headers contain either: semantic meta-data about a document, which can be used
by any output module of the program, 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 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:

% this would be a comment

SAMPLE HEADER
.............

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

% SiSU master 4.0

@title: SiSU
  :subtitle: Manual

@creator:
  :author: Amissah, Ralph

@publisher: [publisher name]

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

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

% used_by: manual

@date:
  :published: 2008-05-22
  :created: 2002-08-28
  :issued: 2002-08-28
  :available: 2002-08-28
  :modified: 2010-03-03

@make:
  :num_top: 1
  :breaks: new=C; break=1
  :bold: /Gnu|Debian|Ruby|SiSU/
  :home_button_text: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org
  :footer: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org
  :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search;
     synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ]
     . sisu [-Ddcv] [instruction]
     . sisu [-CcFLSVvW]

@links:
  { SiSU Homepage }https://www.sisudoc.org/
  { SiSU Manual }https://www.sisudoc.org/sisu/sisu_manual/
  { SiSU Git repo }https://git.sisudoc.org/sisu/
  { SiSU @ Debian }https://packages.qa.debian.org/s/sisu.html
  { SiSU Project @ Debian }https://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
  { SiSU @ Wikipedia }https://en.wikipedia.org/wiki/SiSU

AVAILABLE HEADERS
.................

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 once space :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

% SiSU 2.0 [declared file-type identifier with markup version]

@title: [title text] [this header is the only one that is mandatory]
  :subtitle: [subtitle if any]
  :language: English

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

@date:
  :published: [year or yyyy-mm-dd]
  :created: [year or yyyy-mm-dd]
  :issued: [year or yyyy-mm-dd]
  :available: [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]

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

@classify:
  :topic_register: SiSU:markup sample:book;book:novel:fantasy
  :type:
  :subject:
  :description:
  :keywords:
  :abstract:
  :loc: [Library of Congress classification]
  :dewey: [Dewey classification

@identify:
  :isbn: [ISBN]
  :oclc:

@links: { SiSU }https://www.sisudoc.org
  { FSF }https://www.fsf.org

@make:
  :num_top: 1
  :headings: [text to match for each level
    (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)
  :breaks: new=:C; break=1
  :promo: sisu, ruby, sisu_search_libre, open_society
  :bold: [regular expression of words/phrases to be made bold]
  :italics: [regular expression of words/phrases to italicise]
  :home_button_text: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org
  :footer: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org

@original:
  :language: [language]

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

MARKUP OF SUBSTANTIVE TEXT
--------------------------

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

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)

FONT ATTRIBUTES
...............

*markup example:*

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}#

*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#

INDENTATION AND BULLETS
.......................

*markup example:*

ordinary paragraph

_1 indent paragraph one step

_2 indent paragraph two steps

_9 indent paragraph nine steps

*resulting output:*

ordinary paragraph

  indent paragraph one step

    indent paragraph two steps

                  indent paragraph nine steps

*markup example:*

_* bullet text

_1* bullet text, first indent

_2* bullet text, two step indent

*resulting output:*

- bullet text

  * bullet text, first indent

    * bullet text, two step indent

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

*markup example:*

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

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

HANGING INDENTS
...............

*markup example:*

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

_1_0 first line indented,
rest of paragraph no indent

in each case level may be 0-9

*resulting output:*

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.

  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

*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.

*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.

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

~{ a footnote or endnote }~

*resulting output:*

[^5]

*markup example:*

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

*resulting output:*

normal text[^6] continues

*markup example:*

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

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

*resulting output:*

normal text [^*] continues

normal text [^**] continues

*markup example:*

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

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

*resulting output:*

normal text [^*3] continues

normal text [^+2] continues

*Alternative endnote pair notation for footnotes/endnotes:*

% note the endnote marker "~^"

normal text~^ continues

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

the standard and pair notation cannot be mixed in the same document

LINKS
.....


----------------------------------------

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

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

*resulting output:*

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

An escaped url without decoration

*markup example:*

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

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

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

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


----------------------------------------

LINKING TEXT
............

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

*markup example:*

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

*resulting output:*

about SiSU [link: <https://www.sisudoc.org/>] markup

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

*markup example:*

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

*resulting output:*

about SiSU [link: <https://www.sisudoc.org/>] [^7] markup

Internal document links to a tagged location, including an ocn

*markup example:*

about { text links }#link_text

*resulting output:*

about text links

Shared document collection link

*markup example:*

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

*resulting output:*

about *SiSU* book markup examples


----------------------------------------

LINKING IMAGES
..............

*markup example:*

{ tux.png 64x80 }image

% various url linked images
[image: "a better way"]
 [image: "Way Better - with Gnu/Linux, Debian and Ruby"]

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

*resulting output:*

tux.png 64x80 [link: local image]

tux.png 64x80 "Gnu/Linux - a better way" [link: <https://www.sisudoc.org/>]

GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian
and Ruby" [link: <https://www.sisudoc.org/>]

ruby_logo.png 70x90 "Ruby" [link: <https://www.ruby-lang.org/en/>] [^8]

*linked url footnote shortcut*

{~^ [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

text marker *~name

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.


----------------------------------------

LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY
TREE
..............................................................................

*markup example:*

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

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

*/"Viral Spiral"/, David Bollier*

"Viral Spiral", David Bollier [link: <https://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>]
      document manifest [link: <https://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>]
      html, segmented text [link: <https://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/viral_spiral.david_bollier.toc.html>]
      html, scroll, document in one [link: <https://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier.html>]
      epub [link: <https://www.sisudoc.org/sisu/en/epub/viral_spiral.david_bollier.epub>]
      pdf, landscape [link: <https://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>]
      pdf, portrait [link: <https://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>]
      odf: odt, open document text [link: <https://www.sisudoc.org/sisu/en/odt/viral_spiral.david_bollier.odt>]
      xhtml scroll [link: <https://www.sisudoc.org/sisu/en/xhtml/viral_spiral.david_bollier.xhtml>]
      xml, sax [link: <https://www.sisudoc.org/sisu/en/xml_sax/viral_spiral.david_bollier.sax.xml>]
      xml, dom [link: <https://www.sisudoc.org/sisu/en/xml_dom/viral_spiral.david_bollier.dom.xml>]
      concordance [link: <https://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/concordance.html>]
      dcc, document content certificate (digests) [link: <https://www.sisudoc.org/sisu/en/digest/viral_spiral.david_bollier.hash_digest.txt>]
      markup source text [link: <https://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst>]
      markup source (zipped) pod [link: <https://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst.zip>]

GROUPED TEXT / BLOCKED TEXT
...........................

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


----------------------------------------

BLOCKED TEXT 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{
this is a code block

}code

poem{

this here is a poem

}poem


----------------------------------------

BLOCKED TEXT TIC SYNTAX
.......................

``` code
this is a code block

```

``` poem

this here is a poem

```

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.


----------------------------------------

TABLES
......

Tables may be prepared in two either of two forms

*markup example:*

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

*resulting output:*

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:*[^9]

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

*resulting output:*

*Table 3.1: Contributors to Wikipedia, January 2001 - June 2005*

┆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.


----------------------------------------

POEM
....

*basic markup:*

poem{

  Your poem here

}poem

Each verse in a poem is given an object number.

*markup example:*

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

*resulting output:*

                    `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."'


----------------------------------------

GROUP
.....

*basic markup:*

group{

  Your grouped text here

}group

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

*markup example:*

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."
               "I'll be
                 judge, I'll
                   be jury,"
                         Said
                    cunning
                      old Fury:
                     "I'll
                      try the
                         whole
                          cause,
                             and
                        condemn
                       you
                      to
                       death."'

}group

*resulting output:*

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

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

                    `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."'

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

1  ┆                    `Fury said to a
2  ┆                   mouse, That he
3  ┆                 met in the
4  ┆               house,
5  ┆            "Let us
6  ┆              both go to
7  ┆                law:  I will
8  ┆                  prosecute
9  ┆                    YOU.  --Come,
10 ┆                       I'll take no
11 ┆                        denial; We
12 ┆                     must have a
13 ┆                 trial:  For
14 ┆              really this
15 ┆           morning I've
16 ┆          nothing
17 ┆         to do."
18 ┆           Said the
19 ┆             mouse to the
20 ┆               cur, "Such
21 ┆                 a trial,
22 ┆                   dear Sir,
23 ┆                         With
24 ┆                     no jury
25 ┆                  or judge,
26 ┆                would be
27 ┆              wasting
28 ┆             our
29 ┆              breath."
30 ┆               "I'll be
31 ┆                 judge, I'll
32 ┆                   be jury,"
33 ┆                         Said
34 ┆                    cunning
35 ┆                      old Fury:
36 ┆                     "I'll
37 ┆                      try the
38 ┆                         whole
39 ┆                          cause,
40 ┆                             and
41 ┆                        condemn
42 ┆                       you
43 ┆                      to
44 ┆                       death."'

ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS
.....................................................................


----------------------------------------

LINE-BREAKS
...........

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

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

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.


----------------------------------------

PAGE BREAKS
...........

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:

-\\-

page (break) new:

=\\=

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

-..-

BIBLIOGRAPHY / 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:

1~!biblio


----------------------------------------

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: [^10] an short quick example might be
as follows:

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

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.

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

would be presented as:

Quixote and Panza, /Taming Windmills/ (1605), pp 1000 - 1001 also, Benkler,
/Wealth of Networks/, (2006) p 1 or rather[^11]

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)


----------------------------------------

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

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

*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.

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.

1~!glossary

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

_0_1 [provide your list of terms and definitions]

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.

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.

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

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:

  Main term, 1
    sub-term, 1

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.

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

The structure of the resulting index would be:

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

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

  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

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:

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

COMPOSITE DOCUMENTS MARKUP
--------------------------

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

<< filename1.sst

<< filename2.ssi

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.

SUBSTITUTIONS
-------------

*markup example:*

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}*'

*resulting output:*

The current *Debian* is *Jessie* the next debian will be *Stretch*

Configure substitution in _sisu/sisu_document_make


----------------------------------------

 [1]: <https://packages.qa.debian.org/s/sisu.html>

 [2]: from the *Debian* control file

 [*1]: square brackets

 [*2]: square brackets

 [+1]: square brackets

 [3]: 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.

 [4]: files should be prepared using /UTF-8/ character encoding

 [5]: a footnote or endnote

 [6]: self contained endnote marker & endnote in one

 [*]: unnumbered asterisk footnote/endnote, insert multiple asterisks if required

 [**]: another unnumbered asterisk footnote/endnote

 [*3]: editors notes, numbered asterisk footnote/endnote series

 [+2]: editors notes, numbered plus symbol footnote/endnote series

 [7]: <https://www.sisudoc.org/>

 [8]: <https://www.ruby-lang.org/en/>

 [9]: Table from the Wealth of Networks by Yochai Benkler

 <https://sisudoc.org/spine/en/html/the_wealth_of_networks.yochai_benkler/toc.html>

 [10]: for which you may alternatively use the full form author: title: and year:

 [11]: Quixote and Panza, /Taming Windmills/ (1605), pp 1000 - 1001 also, Benkler,
 /Wealth of Networks/ (2006), p 1