aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/sisu.org
blob: d87f8cc58e2f84434e878e7af5580ad592cb2de2 (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
#+PRIORITIES: A F E
(emacs:evil mode gifts a "vim" of "alternative" powers! ;)

* General
** Finding
*** source

http://sources.sisudoc.org/gitweb/

sisu git repo:
http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=summary

sisu-markup-samples git repo:
http://sources.sisudoc.org/gitweb/?p=doc/sisu-markup-samples.git;a=summary

*** mailing list
sisu at lists.sisudoc.org

http://lists.sisudoc.org/listinfo/sisu

** irc oftc sisu

** home pages
  * <http://www.sisudoc.org/>
  * <http://search.sisudoc.org/>
  * <http://www.jus.uio.no/sisu>

** Installing sisu

*** where you take responsibility for having the correct dependencies

Provided you have *Ruby*, *SiSU* can be run.

SiSU should be run from the directory containing your sisu marked up document
set.

This works fine so long as you already have sisu external dependencies in
place. For many operations such as html, epub, odt this is likely to be fine.
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.

**** run off the source tarball without installation

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

1. Obtain the latest sisu source

2. Unpack the source

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). SiSU should be run from the directory containing your sisu
marked up document set.

This works fine so long as you already have sisu external dependencies in
place. For many operations such as html, epub, odt this is likely to be fine.
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 (with rake)

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

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

  rake gem_create_build_install

to build and install sisu v5 & sisu v6, alias gemcbi

separate gems are made/installed for sisu v5 & sisu v6 contained in source.

to build and install sisu v5, alias gem5cbi:

  rake gem_create_build_install_stable

to build and install sisu v6, alias gem6cbi:

  rake gem_create_build_install_unstable

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

  gem search sisu

  sisu _5.3.6_ --version

  sisu _6.0.6_ --version

to uninstall sisu installed via gem

  sudo gem uninstall --verbose sisu

For a list of alternative actions you may type:

  rake help

  rake -T

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

**** installation with 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:
<http://i.loveruby.net/en/projects/setup/>
<http://i.loveruby.net/en/projects/setup/doc/usage.html>

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

*** Debian install

*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 http://www.jus.uio.no/sisu/archive unstable main non-free
deb-src http://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:
  <http://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.

* Markup :sisu:markup:

** sisu

#% structure - headings, levels
  * headings (A-D, 1-3)
    * inline
      'A~ ' NOTE title level
      'B~ ' NOTE optional
      'C~ ' NOTE optional
      'D~ ' NOTE optional
      '1~ ' NOTE chapter level
      '2~ ' NOTE optional
      '3~ ' NOTE optional
      '4~ ' NOTE optional :consider:
  * node
    * parent
    * children

#% font face NOTE open & close marks, inline within paragraph
  * emphasize '*{ ... }*' NOTE configure whether bold italics or underscore, default bold
  * bold '!{ ... }!'
  * italics '/{ ... }/'
  * underscore '_{ ... }_'
  * superscript '^{ ... }^'
  * subscript ',{ ... },'
  * strike '-{ ... }-'
  * add '+{ ... }+'
  * monospace '#{ ... }#'
#% para NOTE paragraph controls are at the start of a paragraph
  * a para is a block of text separated from others by an empty line
  * indent
    * default, all '_1 ' up to '_9 '
    * first line hang '_1_0 '
    * first line indent further '_0_1 '
  * bullet
    [levels 1-6]
      '_* '
      '_1* '
      '_2* '
  * numbered list
    [levels 1-3]
      '# '

#% blocks NOTE text blocks that are not to be treated in the way that ordinary paragraphs would be
  * code
    * [type of markup if any]
  * poem
  * group
  * alt
  * tables
#% boxes
  NOTE grouped text with code block type color & possibly default image, warning, tip, red, blue etc. decide [NB N/A not implemented]

#% notes NOTE inline within paragraph at the location where the note reference is to occur
  * footnotes '~{ ... }~'
  * [bibliography] [NB N/A not implemented]

#% links, linking
  * links - external, web, url
  * links - internal

#% images [multimedia?]
  * images
  * [base64 inline] [N/A not implemented]

#% object numbers
  * ocn (object numbers)
    automatically attributed to substantive objects, paragraphs, tables, blocks, verse (unless exclude marker provided)

#% contents
  * toc (table of contents)
    autogenerated from structure/headings information
  * index (book index)
    built from hints in newline text following a paragraph and starting with ={} has identifying rules for main and subsidiary text

#% breaks
  * line break ' \\ ' inline
  * page break, column break ' -\\- ' start of line, breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.
  * page break, page new ' =\\= ' start of line, breaks the page, starts a new page.
  * horizontal '-..-' start of line, rule page (break) line across page (dividing paragraphs)

#% book type index

#% comment
  * comment

#% misc
  * term & definition

** proposals/additions

*** TODO [#B] markup syntax code block, indicate syntax of code :feature:
    ``` code:ruby

*** TODO [#C] colored boxes round text :feature:ponder:
    ``` box:red              (select color of box)
    ``` box:warn ``` box:tip (some default boxes? decide)
    ``` box:red:"Warn"       (select color and lead text of box, else instead
          select color box & use regular single line bold markup ^!_ Warn$)

*** TODO [#D] bibliography            :feature:ponder:

*** TODO speaker, as e.g. play (irc?) :feature:ponder:
    ``` Ophelia:
    ::Ophelia

*** TODO [#F] time stamp (e.g. for irc, video text?):feature:ponder:
    ``` 04:03
    ``` 04:03 ... 07:12
    ``` 04:03 + 03:09
    ``` 12:04:03
    ``` 12:04:03 ... 12:07:12
    ``` 12:04:03 + 03:09
    probably not worth the effort, as time stamp is an alternative
    identifying number (to ocn, and ∴ sisu objects not ideal)

*** TODO book index, alternative based on search within text

** syntax hilighting

*** vim
data/sisu/conf/editor-syntax-etc/vim/
data/sisu/conf/editor-syntax-etc/vim/syntax/sisu.vim

*** emacs
data/sisu/conf/editor-syntax-etc/emacs/
data/sisu/conf/editor-syntax-etc/emacs/sisu-mode.el

* Document Abstraction :sisu:doc_abstr:

** TODO [#D] XML middle layer?

*** XMLda sisu
  consder alternative sisu layer in XML

*** TODO [#D] RelaxNG sisu

* Output :sisu:output:

** New outputs to consider

*** XML :xml:
%% xml, docbook.txt fictionbook.txt xldl.txt lml.txt tei.txt emacs.txt
<http://xml.silmaril.ie/>
<http://www.xml.com/>
<http://programming.oreilly.com/2012/08/shrinking-and-stretching-the-boundaries-of-markup.htmlhttp://programming.oreilly.com/2012/08/shrinking-and-stretching-the-boundaries-of-markup.html>

<http://broadcast.oreilly.com/2012/03/xmls-dialect-problem.html>

xml editor vim emacs
<http://chimera.labs.oreilly.com/books/1234000000058/ch01.html#which_xml_editor_should_i_use>
nXML plugin
<http://blog.tommorris.org/post/2456183251/emacs-and-nxml-survival-guide>
<http://johnbokma.com/mexit/2008/10/01/nxml-emacs-how-to.html>
<http://www.emacswiki.org/cgi-bin/wiki/NxmlModeForXHTML>
<http://www.xmlhack.com/read.php_item=2061>
<http://infohost.nmt.edu/tcc/help/pubs/nxml/index.html>
emacs.txt evil.txt

<http://www.oreillynet.com/xml/blog/2005/10/smart_quotes_and_more_in_vim_a.html>
<http://stackoverflow.com/questions/1430164/differences-between-emacs-and-vim>

To validate a book.xml file using xmllint, run the following command:
$ xmllint --postvalid --xinclude --noout book.xml

The default location where xmllint will look for the catalog file is
/etc/xml/catalog. Alternatively, you can set the environment variable
XML_CATALOG_FILES to define another default location for catalog
files. Once you’ve got the DTD and catalog set up locally, you can
validate as before:
$ xmllint --postvalid --xinclude --noout book.xml

%% Docbook
docbook.txt

%% Fictionbook
fictionbook.txt

%% XLDL
xldl.txt

%% Literature Markup Language
lml.txt

%% Text Encoding Initiative
tei.txt

**** TODO [#B] docbook :feature:

***** urls
#% docbook book xml.txt
<http://www.docbook.org>
<http://www.sagehill.net/docbookxsl/index.html>
<http://wiki.docbook.org/>
<http://www.docbook.org/tdg5/en/html/>
<http://www.docbook.org/tdg5/en/html/docbook.html>
<http://www.docbook.org/tdg5/en/html/ch01.html>
<http://www.docbook.org/tdg5/en/html/ch02.html>
<http://www.sagehill.net/docbookxsl/index.html>

<http://www.docbook.org/schemas/5x>
<http://www.docbook.org/xml/5.0/>

<http://infohost.nmt.edu/tcc/help/pubs/docbook5/web/index.html>

<http://docbook.org/xml/5.0/rng/docbook.rng>
<http://docbook.org/xml/5.0/rng/docbook.rnc>

<http://www.cuddletech.com/blog/pivot/entry.php?id=509>

***** rb file
lib/sisu/v6/xml_docbook5.rb

***** transformations :transform:markup_docbook:
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-6) (decoration)
  [] node (child, parent ...)

#% font face
  [] bold
  [] italics
  [] underscore
  [] superscript
  [] subscript
  [] strike
  [] add

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet

#% blocks
  <http://www.docbook.org/tdg5/en/html/literallayout.html>
  [] code
    [] [type of markup if any]
  [] poem
  [] group
  [] alt
  [] tables

#% notes
  [] footnotes
    [] [bibliography?]

#% links, linking
  [] links - external, web, url
  [] links - internal

#% images [multimedia?]
  [] images
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
    <http://www.docbook.org/tdg5/en/html/toc.html>
  [] index (book index)

#% misc

**** TODO [#D] fictionbook :feature:

***** urls
#% fictionbook xml.txt
<http://en.wikipedia.org/wiki/FictionBook>
<http://fictionbook.org/index.php/Eng:FictionBook>
<http://fictionbook.org/index.php/Eng:Articles>
<http://fictionbook.org/index.php/Eng:Documentations>
<http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1>
<http://www.fictionbook.org/index.php/Eng:FictionBook>
<http://fictionbook-lib.org/>
<http://fictionbook-lib.org/browse.php>
<http://wiki.mobileread.com/wiki/FB2>

***** rb file
lib/sisu/v6/xml_fictionbook2.rb

***** transformations :transformations:markup_fictionbok: #%
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-6) (decoration)
  [] node (child, parent ...)

#% font face
  [] bold
  [] italics
  [] underscore
  [] superscript
  [] subscript
  [] strike
  [] add
  [] monospace

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet

#% blocks
  [] code
    [] [type of markup if any]
  [] poem
  [] group
  [] alt
  [] tables

#% notes
  [] footnotes
    [] [bibliography?]

#% links, linking
  [] links - external, web, url
  [] links - internal

#% images [multimedia?]
  [] images
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
  [] index (book index)

#% breaks
  [] line break
  [] horizontal rule
  [] column break
  [] page break

#% comment
  [] comment

#% misc

<http://en.wikipedia.org/wiki/FictionBook>
<http://fictionbook.org/index.php/Eng:FictionBook>
<http://fictionbook.org/index.php/Eng:Articles>
<http://fictionbook.org/index.php/Eng:Documentations>
<http://www.fictionbook.org/index.php/Eng:XML_Schema_Fictionbook_2.1>
<http://www.fictionbook.org/index.php/Eng:FictionBook>

<http://www.fictionbook.org/index.php/%D0%9F%D1%80%D0%B8%D0%BC%D0%B5%D1%80_%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0_%D0%B2_FB2>

<https://addons.mozilla.org/en-US/firefox/addon/fb2-reader/>

**** TODO [#D] XLDL :feature:

***** urls
%% xml.txt xldl - novels, stories, poems
Name: XLDL - an XML doctype for novels, stories, poems, playsName: XLDL - an XML doctype for novels, stories, poems, plays
<http://www.ister.org/code/xldl/>
<http://www.ister.org/code/xldl/doc/xldl.dtd.html>
<line> <stanza>

**** TODO [#E] Literature Markup Language - <LML /> :feature:

***** urls
%% Literature Markup Language - <LML />
<http://hoffmann.bplaced.net/lml/>
"It is assumed, that there are three quite different techniques to provide text,
respectively three types of text, this is prose and poetry and code (for
example source code of computer programs or from markup languages)."
Suggestions and Ideas for Literature Markup Language - <LML /> 1.1
<http://hoffmann.bplaced.net/lml/lml1.1.php>

**** TODO [#E] TEI Lite (Text Encoding Initiative) :feature:

***** urls
%% TEI Lite (Text Encoding Initiative)
<http://www.tei-c.org/Guidelines/Customization/Lite/>
<http://www.tei-c.org/release/doc/tei-p5-exemplars/html/tei_lite.doc.html>

*** Text :txt:

sisu_markup.txt asciidoc.txt markdown.txt textile.txt rst.txt

**** TODO [#D] asciidoc :feature:

***** urls
#% asciidoc
<http://asciidoc.org/>
<http://asciidoctor.org/>
<http://www.methods.co.nz/asciidoc/>
<http://en.wikipedia.org/wiki/AsciiDoc>

cheatsheets
<http://powerman.name/doc/asciidoc>
<http://powerman.name/doc/asciidoc-index>

<http://www.methods.co.nz/asciidoc/asciidoc.txt>
<http://www.methods.co.nz/asciidoc/userguide.html>

<http://www.methods.co.nz/asciidoc/asciidoc.css-embedded.html>
<http://www.methods.co.nz/asciidoc/asciidoc.html>
<http://www.methods.co.nz/asciidoc/chunked/index.html>

***** rb file
lib/sisu/v6/txt_asaciidoc.rb

***** transformations :transformations:markup_asciidoc: #%
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-4) (decoration)
    [] inline
      '== '
      '=== '
      '==== '
      '===== '
      ''
      ''
    [] underscore
      '-'
      '~'
      '^'
      '+'
      '' ['.' proposed]
      '' ['.' proposed]
  [] node (child, parent ...)

#% font face
  [open & close marks]
  [] bold
      '*'
  [] italics
      '_'
  [] underscore
      ''
  [] superscript
      '^'
  [] subscript
      '~'
  [] strike
      '-'
  [] add
  [] monospace
      '+'
      '`' pass markup through unchanged, monospace code

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet
    [levels 1-6]
      '*'
      '**'
      '***'
      '****'
      '*****'
      '*******'
  [] numbered list
    [levels 1-3]
      '. '     number
      '.. '    lower alpha
      '... '   lower roman
      '.... '  upper alpha
      '..... ' upper roman

#% blocks
  [] code
      [source,perl]
      ----
      code here
      ----
    [] [type of markup if any]
  [] poem
  [] group
      ----
      grouped text here, actually a listing block
      ----
  [] alt
  [] tables

#% notes
  [] footnotes
    [] [bibliography?]

#% links, linking
  [] links - external, web, url
       http://google.com[Google Search]
  [] links - internal

#% images [multimedia?]
  [] images
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
  [] index (book index)

#% breaks
  [] line break
      "+\n"
      forced +
      line break
  [] horizontal rule
  [] column break
  [] page break

#% comment
  [] comment
      //

#% misc

  [] term & definition
Term 1:: Definition 1
Term 2:: Definition 2
[horizontal]
    Term 2.1;;
        Definition 2.1
    Term 2.2;;
        Definition 2.2

**** TODO [#E] markdown :feature:

***** urls
#% markdown
<http://daringfireball.net/projects/markdown/>
<http://daringfireball.net/projects/markdown/syntax>
<http://daringfireball.net/projects/markdown/basics>
<http://en.wikipedia.org/wiki/Markdown>
<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>
<http://whatismarkdown.com/>

Markdown supports two styles of headers, Setext and atx
Setext
<http://docutils.sourceforge.net/mirror/setext.html>
<http://en.wikipedia.org/wiki/Setext>
atx
<http://www.aaronsw.com/2002/atx/intro>

<http://support.iawriter.com/help/kb/general-questions/markdown-syntax-reference-guide>
<http://bywordapp.com/markdown/syntax.html>
<http://stackoverflow.com/editing-help>

<http://support.mashery.com/docs/customizing_your_portal/Markdown_Cheat_Sheet>
<http://warpedvisions.org/projects/markdown-cheat-sheet.md>
<http://nestacms.com/docs/creating-content/markdown-cheat-sheet>
<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet>

<https://help.github.com/articles/github-flavored-markdown>
<http://lifehacker.com/5943320/what-is-markdown-and-why-is-it-better-for-my-to+do-lists-and-notes>

#% pandoc markdown
<http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html>
<http://johnmacfarlane.net/pandoc/README.html>
<http://johnmacfarlane.net/pandoc/demo/example19/Pandoc_0027s-markdown.html>
<http://johnmacfarlane.net/pandoc/>
<http://johnmacfarlane.net/pandoc/epub.html>
<http://johnmacfarlane.net/pandoc/faqs.html>

#% multimarkdown
<http://fletcher.github.io/peg-multimarkdown/>

#% markdown pandoc v multimarkdown
<https://github.com/jgm/pandoc/wiki/Pandoc-vs-Multimarkdown>

#% rST v markdown
<http://stackoverflow.com/questions/34276/markdown-versus-restructuredtext>

***** rb file
lib/sisu/v6/txt_markdown.rb

***** transformations :transformations:markup_markdown: #%
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-6) (decoration)
    [inline 1-5]
      '#'
      '##'
      '###'
      '####'
      '#####'
      '######'
    [underscore 1-5]
      '='
      '-'
      #'~'
      #'^'
      #'+'
  [] node (child, parent ...)

#% font face
  [open & close marks]
  [] bold
      '**'
  [] italics
      '*'
  [] underscore
      ''
  [] superscript
      ''
  [] subscript
      ''
  [] strike
      ''
  [] add
  [] monospace
      '`'

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet
      '*'
  [] numbered list
      '0.'

#% blocks
  [] code
    '    ' #indent at least 4 spaces
    [] [type of markup if any]
  [] poem
  [] group
  [] alt
  [] tables

#% notes
  [] footnotes
    [] [bibliography?]

#% links, linking
  [] links - external, web, url
  [] links - internal

#% images [multimedia?]
  [] images
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
  [] index (book index)

#% breaks
  [] line break
  [] horizontal rule
      (three or more asterisks hypens or underscores)
      * * *
      ***
      *****
      - - -
    ___
  [] column break
  [] page break

#% misc

**** TODO [#F] rst :feature:

***** urls
#% rST
<http://docutils.sourceforge.net/rst.html>
<http://docutils.sourceforge.net/docs/user/rst/quickref.html>
<http://docutils.sourceforge.net/docs/user/rst/quickstart.html>
<http://en.wikipedia.org/wiki/ReStructuredText>
<http://sphinx-doc.org/rest.html>

<http://stackoverflow.com/questions/2746692/restructuredtext-tool-support>

#% rST v markdown
<http://stackoverflow.com/questions/34276/markdown-versus-restructuredtext>

***** rb file
lib/sisu/v6/txt_rst.rb

***** transformations :transformations:markup_rst: #%
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-6) (decoration)
    [inline]
      N/A
    [underscore]
       Titles are underlined (or over- and underlined) with a printing
       nonalphanumeric 7-bit ASCII character. Recommended choices are
       "= - ` : ' " ~ ^ _ * + # < >". The underline/overline must be at
       least as long as the title text.
      '='
      '-'
      '`'
      ':'
      "'"
      '"'

  [] node (child, parent ...)

#% font face
  [] bold
      '**'
  [] italics
      '*'
  [] underscore
      '+'
  [] superscript
      '^'
  [] subscript
  [] strike
      '-'
  [] add
  [] monospace
      '``'

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet
      "-", "*" or "+"
      '-'
  [] numbered list
      '#.'

#% blocks
  [] code
    [] [type of markup if any]
  [] poem
  [] group
  [] alt
  [] tables

#% notes
  [] footnotes
    [binary]
      Footnote references, like [5]_.
      Note that footnotes may get
      rearranged, e.g., to the bottom of
      the "page".
      .. [5] A numerical footnote.
  --
       Autonumbered footnotes are
       possible, like using [#]_ and [#]_.
       .. [#] This is the first one.
       .. [#] This is the second one.

    [] [bibliography?]

#% links, linking
  [] links - external, web, url
    	Typical result
      External hyperlinks, like Python_.
      .. _Python: <http://www.python.org/>
      or
      External hyperlinks, like `Python
      <http://www.python.org/>`_.
  [] links - internal
      Internal crossreferences, like example_.
      .. _example:

      This is an example crossreference target.
  --
      Titles are targets, too
      =======================
      Implict references, like `Titles are
      targets, too`_.

#% images [multimedia?]
  [] images
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
  [] index (book index)

#% breaks
  [] line break
  [] horizontal rule
  [] column break
  [] page break

#% misc

**** TODO [#F] textile :feature:

***** urls
#% textile
<http://en.wikipedia.org/wiki/Textile_(markup_language)>
v2.4
<http://www.txstyle.org/>
v2
<http://redcloth.org/hobix.com/textile/>

***** rb file
lib/sisu/v6/txt_textile.rb

***** transformations :transformations:markup_textile: #%
#% structure - headings, levels
  [] sisu (A-C, 1-3)
  [] collapsed (1-6) (decoration)
    [inline]
      h1(#id). An HTML first-level heading
      h2. An HTML second-level heading
      h3. An HTML third-level heading
      h4. An HTML fourth-level heading
      h5. An HTML fifth-level heading
      h6. An HTML sixth-level heading
    [underscore]
      N/A

  [] node (child, parent ...)

#% font face
  [] bold
      *bold text*
  [] italics
      _italic text_
  [] underscore
      +underlined text+
  [] superscript
      ^TM^
  [] subscript
     ~subscript~
  [] strike
     -strikethrough text-
  [] add

#% para
  [] default
  [] indent
    [] default, all
    [] first line hang or indent further
  [] bullet
      * bulleted list
      ** 2-level

#% blocks
  [] code
    [] [type of markup if any]
  [] poem
  [] group
  [] alt
  [] tables
      |Table | with two columns |
      |and two | rows |

#% notes
  [] footnotes
      Text with a link to some reference[1]
      fn1. Footnote explanation
    [] [bibliography?]

#% links, linking
  [] links - external, web, url
      "(classname)link text(title tooltip)":link_address
      "Link to Wikipedia":http://www.wikipedia.org
  [] links - internal

#% images [multimedia?]
  [] images
      !http://commons.wikimedia.org/wiki/Special:Filepath/Wikipedia-logo-en.png!
      !imageurl(alt text)!
    [] [base 64]

#% object numbers
  [] ocn (object numbers)

#% contents
  [] toc (table of contents)
  [] index (book index)

#% breaks
  [] line break
  [] horizontal rule
  [] column break
  [] page break

#% misc
    [] *_bold italic text_*
    [] *-bold strikethrough text-*
    [] *_-bold italic strikethrough text-_*
    [] *+bold underlined text+*
    [] *_+italic underlined text+_
    [] *_+bold italic underlined text+_
    [] *_-+bold italic strikethrough underlined text+-_*
    %{font-size:18pt}font size%
    %{color:red}text in red%
    # Chapter 1

#% notes
heading inline only
footnotes uses marker and endnote, check

** Improvements

*** HTML

*** XML

*** --strict mode (html w3c compliant ocn etc.)

* Code (ruby) :sisu:code:

** code enhancements :enhance:

*** TODO [#D] directory & path, use ruby directory tools

*** TODO [#D] document url shortcut, allow addition of alternative dir stub
(e.g. viral Spiral)

** code refactoring :refactor:

*** ruby 2.1

**** DONE make sure sisu works

*** TODO [#C] refactor ruby :ongoing:

** bugs :bug:

*** misc, unclassified

**** DONE (6.0.5) [#B] sisu should give warning when part of minimal essential structure is missing :processing:fix:

work through testing for as many of these as possible

minimal content/structure requirement:
[metadata]
  @title:
  @creator:
[levels]
  A~ (level A [title])
  1~ (at least one level 1 [segment/(chapter)])
test what happens in the absence of each

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 *(B~ if none other used; if C~ is last used: C~ or B~; if D~ is used: D~, C~ or B~)
            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 *()

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

there must be a title, level A
creator field absent: crash, no warnings given
title missing:
level A missing:
no level 1:

***** NOTES/COMMENTS

revisit,
  * check logic, add to if possible
  * tidy, inelegant solution

**** DONE (5.3.5::6.0.5) [#B] victory chals discussed parsing problem caused by use of open-close markers around url

**** TODO UNDERWAY (6.0.5) [#B] exclude heading where possible marker '-#' not distinguished from unnumbered heading '~#'

  * ~# is general & means no ocn (for any object to which it is applied)
  * -# is relevant only for 1~ dummy headings & instructs that they should be
    removed from output where possible
  * where -# is used on any other objects, it is treated the same way as ~#

**** TODO [#B] collapsed level work out logic where dummy lev1 heading

  * exclude heading where lev1 '-#'
  * means subsequent headings & text belong to parent heading (of lev1 -#) 1 level up
  * ponder

*** DBT Outstanding bugs -- sisu caught by removal of ruby-dbi

**** TODO [#B] sisu 5.3.4-1 marked for autoremoval from debian testing on 2014-06-10, for depending on ruby-dbi

sisu 5.3.4-1 is marked for autoremoval from testing on 2014-06-10
It (build-)depends on packages with these RC bugs:
746081: ruby-dbi: FTBFS: ERROR: Test "ruby2.1" failed: wrong number
of arguments (3 for 1..2)

The current status of use of ruby-dbi in sisu.

from:
http://lists.sisudoc.org/pipermail/sisu/2014-May/000818.html

***** sisu
  SiSU does not depend on an sql database to be useful and most users do
  not use the database (population and resulting search) possibilities.

***** TODO [#B] sisu-sqlite
  5.3.4 uses ruby-sqlite3 directly. There has been a
  dependency within debian/control on ruby-dbi for sisu-sqlite, this can
  safely be removed, without affecting its operation.
  (it is used rather by the sample sqlite3 search form)

  >Solution Proposed: remove debian/control dependency on ruby-dbi

  Solution Implemented:
  (pending)

***** TODO [#B] sisu-postgresql
  sisu-postgresql 5.3.4 uses ruby-pg through ruby-dbi.

  >Solution Proposed:
  >* attempt now to fix by migrating to use ruby-pg directly
  >  * remove dependency on ruby-dbi in debian/control
  >  * rewrite code within sisu to work directly with ruby-pg
  >failing to do this within the autoremoval time:
  >  * remove dependency on ruby-dbi in debian/control
  >  * replace ruby-dbi with ruby-pg
  >    this breaks the postgresql functionality of sisu
  >  * file a serious bug against sisu-postgresql (which is contained
  >    within sisu package) and take more time to repair.  and/or *
  >    request an extension of time on auto-removal

  Solution Implemented:
  (pending)

***** TODO [#B] sample cgi search forms
  there is a sample cgi search form facility within sisu that uses
  ruby-dbi to query sqlite3 or pg databases.

  >Solution Proposed:
  >* file a wishlist bug against sisu. No action needed immediately
  >  (other perhaps than to remove references to ruby-dbi). This offering
  >  in sisu would be classified as "wishlist" as these are samples only
  >  and need not be provided at all as populating the database (at an
  >  object level) in this case is the challenge (so you could say these
  >  documents meet your search criteria at these locations within them
  >  (relevant to almost all output formats html, epub, pdf etc.) (and
  >  may be looked up in these languages if they are available)) and is
  >  independent from search, once you have an sql database you can query
  >  it as you wish. (the cgi sample forms will be provided again
  >  eventually using ruby-sqlite3 and ruby-pg directly).

  Solution Implemented:
  (pending)

***** NOTES/COMMENTS

debian/control, remove dependency on ruby-dbi, contained in sisu-postgresql and sisu-sqlite

Current status
 * sisu-sqlite works fine, depends on ruby-sqlite3
 * sisu-postgresql is broken till fixed to work with ruby-pg (or ruby-dbi fixed)
 * sample cgi search froms (cgi database query forms) are broken till they work
   off ruby-pg & ruby-sqlite3 respectively instead of ruby-dbi

*** DBT Outstanding bugs -- Normal bugs; Unclassified (2 bugs) :debian:dbt:normal:
    <https://bugs.debian.org/cgi-bin/pkgreport.cgi?src=sisu>

**** DONE (5.3.5::6.0.5) [#B] #744360 [n|u] sisu: includes do not work properly :processing:fix:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744360>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: includes do not work properly
Date: Sun, 13 Apr 2014 12:38:59 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

using this in foo.ssm:

  :A~ foo

  :B~ bar

  << bar/baz.ssi

and this in baz.ssi:

  1~ foo bar baz

then everything works.

using the more natural foo.ssm:

  :A~ foo

  << bar/baz.ssi

and baz.ssi:

  :B~ bar

  1~ foo bar baz

makes ':B~ bar' being ignored in the output (pdf) entirely.

Regards,
Daniel

***** NOTES/COMMENTS

it appears both give faulty text, though in different ways

fixed

**** DONE (5.3.5::6.0.5) [#B] #744378 [n|u] sisu: --no-manifest not working anymore :check:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744378>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: --no-manifest not working anymore
Date: Sun, 13 Apr 2014 16:12:13 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when running sisu-pdf with --no-manifest, the output (pdf) still
contains the sisu manifest at the end of the document.

Regards,
Daniel

***** NOTES/COMMENTS

fix, metadata page in pdf should not contain link to manifest where --no-manifest flag is used

**** TODO ONGOING #746740 [n|u] manpages incomplete

Date: Sat, 03 May 2014 08:45:49 +0200
From: Daniel Baumann <daniel.baumann@progress-technologies.net>
Subject: manpages incomplete
Package: sisu
Version: 5.3.4-1
Tag: upstream
Severity: normal

sisu supports options like --verbose or --no-manifest, but they are not
listed in the sisu manpage.

***** NOTES/COMMENTS

documentation for sisu does lag a bit and has omissions, but I think you will
find that --verbose is documented, and --no-* options are listed under --exc-*
to which there is a pointer --no-manifest works but is actually
--no-links-to-manifest and is listed under aliases --exc-links-to-manifest and
--exc-manifest-links

Will leave bug open as a reminder that updating is necessary and as there are
no doubt numerous issues for which this could be (re)opened

**** TODO #746742 [n|u] please implement --no-metadata similar to --no-manifest

Date: Sun, 13 Apr 2014 16:12:13 +0200
From: Daniel Baumann <daniel.baumann@progress-technologies.net>
Subject: --no-manifest not working anymore
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when running sisu-pdf with --no-manifest, the output (pdf) still
contains the sisu manifest at the end of the document.

Regards,
Daniel

*** DBT Outstanding bugs -- Wishlist items; Unclassified (24 bugs) :debian:dbt:wishlist:

**** TODO [#D] #744352 [w|u] sisu output: aligning margin numbers when using 'code'
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744352>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: 744352@bugs.debian.org
Subject: Re: sisu output: too many margin numbers
Date: Sun, 13 Apr 2014 17:27:10 +0200
retitle 744352 sisu output: aligning margin numbers when using 'code'
severity 744352 wishlist
thanks

sorry, i've looked wrongly at the output, the problem is simply an
aligning issue. it looks like that:

  foo bar.          [1]
                    [2]
  baz

  foo bar baz.      [3]

rather than:

  foo bar.          [1]

  baz               [2]

  foo bar baz.      [3]

Regards,
Daniel

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: too many margin numbers
Date: Sun, 13 Apr 2014 12:28:14 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using the following code:

foo bar.

code{

  baz

}code

foo bar baz.

the result in the output (pdf) is:

foo bar.          [1]
                  [2]
baz               [3]
                  [4]
foo bar baz.      [5]

the '[n]' designates the margin number at the right site of the page.

the problem is that sisu gives margin numbers to *empty* lines, which is
wrong. margin numbers should only be assigned to actual content.

Regards,
Daniel

***** NOTES/COMMENTS

issue with pdf, look again, consider, this is cosmetic, a fix should be found,
but is not striaghtforward alignment issue for code blocks not so easy to fix
in some outputs, have so far ignored this is an issue with other types of text
block as well

reason why this has not been addressed especially with code blocks:
the easiest fix would be to place the numbering at the end of the first line of
a code block however, as it is now, if you copy & paste a block of code you
should get the code if numbering is moved down to the first line, a copy of the
code block will inlcude the extraneous (to the code) object number which is to
my mind a bigger problem

That said re pdf, LaTeX XeTeX are flexible, it may be possible to drop the ocn
at the start of a code block lower on its line so that it is closer to the code
that follows

**** DONE (6.0.5) [#D] #744353 [w|u] sisu output: please do not use typewriter for urls :output:consider:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744353>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: please do not use typewriter for urls
Date: Sun, 13 Apr 2014 12:28:27 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using urls in sisu like this:

  http://example.org

sisu then creates in the output (pdf) links like this:

  <http://example.org>

where as '<http://example.org>' is written in typewriter font
(monospace). please don't do that automagically since it's desturbing
the visual flow when reading. If the users wants that, he should be able
to configure it.

Regards,
Daniel

***** NOTES/COMMENTS

monospace for url outputs in pdf

this is default behavior of the latex url package (it uses tt typewriter font)
it is possible to modify the font to sf class or tm/rm class, & I now default to sf
this means when the sisu default sf is used there will be no difference in typeface,
but when times roman or other is used, urls will be in sf instead of that font,
(instead of the latex default typewriter)

it provides a visual cue even when output is monochrome, without color
(and is in some way related to #744391 sisu output: no color on a4 portrait)
however, it is worth noting here that urls are printed in a smaller font so as
to fit more on a line of text

**** TODO [#C] #744354 [w|u] sisu output: please do not add '<' and '>' around urls

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: please do not add '<' and '>' around links
Date: Sun, 13 Apr 2014 12:28:37 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using urls in sisu like this:

  http://example.org

sisu then creates in the output (pdf) links like this:

  <http://example.org>

Please do not automagically add a '<' and '>' around urls. If the user
wants them, he would add one.

Regards,
Daniel

***** NOTES/COMMENTS

is sisu default behavior,
would need to make configurable
url_visual_delimiters: '<>'
look into later

**** DONE (5.3.5::6.0.5) [#C] #744355 [w|u] vim syntaxhighlighting: includes and directories :syntaxhi:fix:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744355>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: vim syntaxhighlighting: includes and directories
Date: Sun, 13 Apr 2014 12:28:46 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

When using includes like this:

  << foo.ssi

then vim correctly displays the line in blue.

However, when using includes in a subdirectory like this:

  << bar/foo.ssi

then vim doesn't use any colors at all.

Regards,
Daniel

***** NOTES/COMMENTS

done

**** DONE PASS [#C] #744356 [w|u] vim syntaxhighlighting: urls and tags :discuss:close:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744356>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: vim syntaxhighlighting: urls and tags
Date: Sun, 13 Apr 2014 12:28:56 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

When using an URL at the end of a sentence like this:

  Foo bar baz http://example.org.

then vim properly highlights the url in blue.

this also works properly when a second sentence after it, like:

  Foo bar baz http://example.org. Foo bar baz http://example.org.

it works with html tag as well, like this:

  Foo bar baz http://example.org. <br />Foo bar baz http://example.org.

but it doesn't work if there's no space:

  Foo bar baz http://example.org.<br />Foo bar baz http://example.org.

then, the string 'http://www.gnu.org/licenses/.<' is shown red.

Regards,
Daniel

***** NOTES/COMMENTS

this is meant to be flagged as an error,
(red indicates error, and is an error will not parse correctly)
even if the sisu parser works in the flagged case there is no promise that it will in future

use of angle bracket markers (html markers) in sisu markup is depreciated.
for line-break use \\ instead,
for which there should be surrounding spaces or a preceding space and end of line;
if <br /> is still used there should be a space after the url - which sisu should remove in output.

would like to close without further action
re-open if necessary

**** DONE (6.0.5) [#C] #744357 [w|u] sisu output: please create mailto links automatically
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744357>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: please create mailto links automatically
Date: Sun, 13 Apr 2014 12:29:12 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

When using urls like:

  http://example.org

in sisu, the output (pdf) contains a hyperlink to http://example.org
automatically, which is nice.

please also create mailto links when using email adresses like:

  john.doe@example.org

Regards,
Daniel

***** NOTES/COMMENTS

for pdf fix/implement mailto links
done but requires further testing & possibly refinement

**** DONE (6.0.5) [#C] #744358 [w|u] sisu output: please do not add ';' after \:copyright: :output:fix:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744358>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: please do not add ';' after :copyright:
Date: Sun, 13 Apr 2014 12:29:20 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

When using:

  :copyright: foo bar baz.

sisu generates the following in the output format (pdf):

  foo bar baz.;

Please do not automagically add a semicolon (;). If the user wants a
semicolon, he would add one.

Regards,
Daniel

***** NOTES/COMMENTS

fix copyright, remove trailing semi-colon

**** DONE (5.3.5::6.0.5) [#B] #744379 [w|u] sisu: missing includes doesn't give an error :processing:fix:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744379>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: missing includes doesn't give an error
Date: Sun, 13 Apr 2014 16:14:46 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

When using includes (*.ssi) in a sisu master document (*.ssm) like:

  << foo.ssi

and that to be included file foo.ssi (for whatever reason) doesn't
exist, sisu doesn't error out but include '<< foo.ssi' literally as a
string in the output (pdf).

Regards,
Daniel

***** NOTES/COMMENTS

5.3.4-1 writes the following to the screen:
"ERROR test.ssm.sst requires invalid or non-existent file: foo.ssi"

and unsatisfactorily within the text output it writes no error message but the include instruction:

"<< foo.ssi"

5.3.5, the current "fix"/ solution, is to add an error message within the text rather than to stop processing with an error.
In addition to (i) slightly modified (you could say corrected) to the following:

"ERROR test.ssm requires an invalid or non-existent file: foo.ssi"

the following is written within the text output:

"<< foo.ssi [ERROR test.ssm requires an invalid or non-existent file: foo.ssi]"

**** DONE (5.3.5::6.0.5) [#D] #744381 [w|u] sisu syntax: inconsistency \:copyright: and \:license: :metadata:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744381https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744381>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: inconsistency between :copyright: and :license:
Date: Sun, 13 Apr 2014 16:26:55 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using ':copyright: foo', then the output contains 'foo'.

when using ':license: foo', then the output contains 'License: foo'.

this is inconsistent. either both should have a 'prefix' in the output,
or neither should have one (i'd prefere the latter).

Regards,
Daniel

***** NOTES/COMMENTS

Under rights there are a series of sub-categories starting with copyright, that
need to be distinguished. Until now started distinguishing after after
Copyright. For consistency have add the prefix 'Copyright' to the output.
Preference to omit noted, but this solution is consistent with options
provided. Bug closed, re-open if necessary.

**** DONE (6.0.5) [#B] #744383 [w|u] sisu syntax: :B and :C result in the same formatting :output:fix: (partial solution)
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744383>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu syntax: :B and :C result in the same formatting
Date: Sun, 13 Apr 2014 16:32:07 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

when using :A, :B, and :C in sisu, in the output (pdf) both :B and :C
are formatted identically.

imho :C should be 'smaller' than :B.

or, as an analogy with html: i would expect that :A equals <h1>, :B
equals <h2>, and :C equals <h3>. currently, (in that analogy), :B and :C
both equal <h2>.

Regards,
Daniel

***** NOTES/COMMENTS

this is in part an artifact of LaTeX not having as many document heading levels
and trying to take advantage of the behavior of existing levels rather than
customizing further

look for a solution, possibly overriding the default font sizes for each

The current settings were chosen because, there are not enough levels and I
find too many different font sizes disconcerting, especially running sisu over
a wide variety of document types

the following levels are available in LaTeX

\part
\chapter
\section
\subsection
\subsubsection

the levels in sisu are

A [title]
B [part]
C [subpart]
D [subsubpart]
1 [segment (chapter)]
2 [subsegment]
3 [subsubsegment]

sisu current mapping:

level A        [title]
level B C D    \part            (it is up to the user to make part levels visually distinguishable e.g. Book Part Section)
[skipped       \chapter]
[skipped       \section]
level 1        \subsection
level 2        \subsubsection
level 3        \subsubsection

the reason for skipping section was the default configuration and resulting
fact that it made for a table of contents that takes more space

sisu new mapping:

level A        [title]
level B C D    \part             (it is up to the user to make part levels visually distinguishable e.g. Book Part Section)
[skipped       \chapter]
level 1        \section
level 2        \subsection
level 3        \subsubsection

levels B C & D are the same size,
  it is up to the user to make part levels visually distinguishable
  e.g. Book Part Section
levels 1 2 & 3 are now distinguished

(Closes #744386) sisu syntax: 1~ and 2~ result in the same formatting
(under consideration & yet to be done #744383) sisu syntax: :B and :C result in the same formatting
(touches )
override part font size settings for different levels (B C D)

**** TODO [#C] #744384 [w|u] sisu syntax: relies on empty lines
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744384>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu syntax: relies on empty lines
Date: Sun, 13 Apr 2014 16:34:46 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

the following snipped:

  :C~ foo bar
  << foo-bar.ssi

means that the include is ignored entirely. apparently sisu relies on
having an empty line in between like this:

  :C~ foo bar

  << foo-bar.ssi

Regards,
Daniel

***** NOTES/COMMENTS

consider,

(i) as a general observation, sisu relies on emptly lines to identify separate objects
 such as headings, paragraphs (and indeed insertions)

(ii) a heading need not be on a single line (so << would be part of that heading)
this means sisu should be able to work identifying headings in wrapped texts
(e.g. where the text is wrapped at 80 and the heading is longer than that)

there has been no rule to the contrary (i.e. that headings should be on a single text line)

consider, should there be such a rule?

**** DONE (6.0.5) [#B] #744386 [w|u] sisu syntax: 1~ and 2~ result in the same formatting :output:pdf:fix: (see #744383)
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744386>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu syntax: 1~ and 2~ result in the same formatting
Date: Sun, 13 Apr 2014 16:43:51 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

similar as with #744383, the same also applies for 1~ and 2~ - they
should be different in the output format (pdf here).

Regards,
Daniel

***** NOTES/COMMENTS

1~ 2~ 3~ are now differentiated

deal with under #744383

**** TODO [#B] #744390 [w|u] sisu: empty sections are ignored
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744390>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: empty sections are ignored
Date: Sun, 13 Apr 2014 17:09:32 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist

if you have the following sisu syntax:

  :B~ foo

  1~ foo1

  foo1.

  1~ foo2

  foo2.

  :B~ bar

  1~ bar1

  1~ bar2

  :B~ baz

  1~ baz1

  1~ baz2

then anything (including and) after ':B~ bar' is ignored entirely.

***** NOTES/COMMENTS

further info, have not yet been able to duplicate,
seemed to work (checked pdf & html (scroll & seg))
was not able to reproduce
will look again

**** DONE (6.0.5) [#C] #744391 [w|u] sisu output: no color on a4 portrait :output:pdf:contemplate:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744391>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: please use (blue) color for links
Date: Sun, 13 Apr 2014 17:23:37 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

it would be nice if links (urls and emails) would be colored blue to
mark them visually as links. this behaviour is somewhat the lowest
common denominator in browsers (if you use html without any css that is).

Regards,
Daniel

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: 744391@bugs.debian.org
Subject: Re: sisu output: please use (blue) color for links
Date: Sun, 13 Apr 2014 17:35:33 +0200
retitle 744391 sisu output: no color on a4 portrait
thanks

now this is strange.. turns out that (yes, i have colors enabled in
sisurc) the portrait a4 pdf has no colors at all, while the landscape a4
pdf does indeed have colors (red for toc, blue for links).

Regards,
Daniel

***** NOTES/COMMENTS

background:
portrait was provided for print/paper copy and is great for that in monochrome
(without grays for colored links),
landscape better matching a screen for visual presentations, color affecting the landscape only

solution:
make configurable by cli & rc file
make both (portrait & landscape colors) configurable
either as hyperlinks monochrome or colored
overriding existing default which remains as described

document
cli:
--pdf-hyperlinks-no-color or --pdf-hyperlinks-mono
--pdf-hyperlinks-color

rc:

default:
  pdf_hyperlinks: *[possible values]
  pdf_hyperlinks_portrait: *[possible values]
  pdf_hyperlinks_landscape: *[possible values]

  * 'color' or ('mono' or 'no-color' or 'color-off')

**** TODO [#D] #744395 [w|u] sisu output: half-page title page in landscape output
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744395>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: half-page title page in landscape output
Date: Sun, 13 Apr 2014 17:38:03 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

in a4 landscape output, there's always two pages on one page, which is
nice; except for the title page which spans over the whole page.

it would be nice if the first page would be consistent to the same
scheme like the rest of the document - spanning only over the half of
the page.

Regards,
Daniel

***** NOTES/COMMENTS

think about, should be fairly easily done, but am reluctant

note the page numbering in landscape, the two landscape columns are given a single page number
it is really a landscape two column per-page text, provided primarily for screen viewing or
other convenience if found

(many viewers provide two page per screen presentations, which would result in an effect similar to the one requested
the issue I guess might arise in that they are not printable on a single page? ...
but then the current settings are arguably justified)

**** TODO [#C] #744396 [w|u] sisu output: "european" toc indenting
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744396>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: "european" toc indenting
Date: Sun, 13 Apr 2014 17:40:53 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

by default, latex uses the following indenting in the TOC:

  1. foo
      1.1 bar1
           1.1.1 baz
      1.2 bar2

there's a latex option that i don't remember off-hand to have the
indenting like it's common in europe:

  1. foo
  1.1 bar1
  1.1.1 baz
  1.2 bar2

it would be nice if sisu could let the used decide which indenting style
to use for TOCs.

Regards,
Daniel

***** NOTES/COMMENTS

will look at: should be possible; requires a configuration option

**** DONE (6.0.5) [#B] #744399 [w|u] sisu syntax: :A smaller formatted than :B :output:fix: (see #744383) (partial solution)
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744399>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu syntax: :A smaller formatted than :B
Date: Sun, 13 Apr 2014 17:49:26 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

in a document like this:

:A~ foo

:B~ bar

the :A~ 'title' is formated 'smaller' (not bold, smaller font size) than
the :B~ 'title' on the first page of the actual document (means, first
page after TOC).

Regards,
Daniel

***** NOTES/COMMENTS

for pdf

now is same size see #744383

\part          (level A B C D)
\chapter       (skipped)
\section       (level 1)
\subsection    (level 2)
\subsubsection (level 3)

**** DONE (6.0.5) [#C] #744402 [w|u] sisu: support sha512 :implement:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744402>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: support sha512
Date: Sun, 13 Apr 2014 18:06:56 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

sisu uses sha256 when using sha as digest, please support sha512.

it would be even nicer if you could specify the actual digest like
'sha512', 'sha256', etc. rather than just 'sha'.

Regards,
Daniel

***** NOTES/COMMENTS

implemented
document command line option --sha512

**** DONE (6.0.5) [#C] #744405 [w|u] sisu: set default font size :configuration:pdf:implement:
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744405>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: set default font size
Date: Sun, 13 Apr 2014 18:29:46 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

in sisurc, one can set the default fonts. it would be nice to be also
able to set the default font size.

Regards,
Daniel

***** NOTES/COMMENTS

for pdf make configurable

yaml.rc

default:
  texpdf_fontsize: 12

command-line

--pdf-fontsize-12
--pdf-fontsize-8
etc.

**** TODO [#C] #744407 [w|u] sisu: possibility to influence content/formating of the title page
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744407>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: possibility to influence content/formating of the title page
Date: Sun, 13 Apr 2014 18:32:14 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

by default, the title page (in the pdf output) shows @title and @creator.

it would be nice if there would be a possibility to influence the
formatting (e.g. to have the title written in bold), and to have
additional possibilities to influence the content on the title page
(like the date or version, an url, or other text strings).

Regards,
Daniel

***** NOTES/COMMENTS

consider, work on possibly, later

**** TODO [#C] #744408 [w|u] sisu: support more than one level of includes/nested includes
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744408>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: support more than one level of includes/nested includes
Date: Sun, 13 Apr 2014 18:39:23 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

currently, it's possible to use only one ssm file which itself includes
one or more ssi files.

it would be nice if the ssm could include an 'intermediate' ssi, which
then includes further ssi files. this is very handy for larger documents.

Regards,
Daniel

***** NOTES/COMMENTS

consider,
I have to date deliberately tried to keep it easy to follow documents & not have too much depth ...
The idea of recursive includes is un-attractive (messy for a document)

.ssm currently can contain .sst or .ssi
.sst files can be processed independently,
.ssi files are only insertions & cannot

allowing .ssi to also include other .ssi or .sst could lead to recursive .ssi
allowing .ssm to also include other .ssm .ssi or .sst could lead to recursive .ssm

stopping after an additional level of includes seems arbitrary, and possibly prone to error if you are dealing with many documents

a possibility would be to have another file extension to flag the role of the file,
.ssmi (not very attractive) might do it
(providing visual cue signalling its role as both a master file and an insertion/included file that cannot be processed independently)
a .ssmi file must be included in a .ssm file
a .ssmi file (like .ssm) permits the inclusion only of .sst or .ssi files

will work on eventually

**** TODO [#C] #744409 [w|u] sisu output: urls in code blocks are not linkified
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744409>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: urls in code blocks are not linkified
Date: Sun, 13 Apr 2014 18:41:09 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

it would be nice if urls written withiin code{...}code blocks would also
be automatically transformed into a link within the output (html).

Regards,
Daniel

***** NOTES/COMMENTS

consider, so far code blocks are pretty much untouched ... not tampered with,
this could be done though

**** DONE (6.0.5) [#C] #744541 [w|u] sisu: urls in @creator broken
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744541>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu: urls in @creator broken
Date: Sun, 13 Apr 2014 18:45:35 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

first, if you have an url within @creator, like:

  @creator: foo bar http://example.org

the generation fails (pdf output).

as a workaround, i put the url into parenthesis, like:

  @creator: foo bar (http://example.org)

but then, it would be nice if that url would be automatically
transformed into a link in the output format (pdf).

Regards,
Daniel

***** NOTES/COMMENTS

pdf, fix

**** TODO [#C] #744685 [w|u] sisu output: copy&past-able wrapped code blocks
      <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=744685>

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: copy&past-able wrapped code blocks
Date: Sun, 13 Apr 2014 19:04:01 +0200
Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

if a line within a 'code{...}code' block is longer and needs to be
wrapped, sisu indicates the wrapping with an 'arrow' (←) symbol, which
is nice.

it would be even nicer if the arrow would not 'selectable', so that when
you mark the line spanning over two lines with your mouse, the arrow is
not selected and thus not copy&pasted.

i don't know how to do this, but it's possible within pdfs, as can be
seen in lots of pdfs in the internet.

Regards,
Daniel

***** NOTES/COMMENTS

find out how and implement, further feedback on appropriate xetex tools welcome

[Note: if can be applied to random characters, use may be of interest for
object numbers as well!]

**** TODO [#C] #744734 [w|u] sisu output: replace all occurences of (C) rather than the first only

From: Daniel Baumann <daniel.baumann@progress-technologies.net>
To: Debian Bug Tracking System <submit@bugs.debian.org>
Subject: sisu output: replace all occurences of (C) rather than the first only
Date: Mon, 14 Apr 2014 06:11:13 +0200

Package: sisu
Version: 5.3.4-1
Severity: wishlist
Tags: upstream

if you have a '(C)' in :copyright:, it is automatically replaced with a
copyright symbol, which is nice, however, it sisu does that with the
first occurence only.

so if you use:

 :copyright: (C) john doe<br />(C) jane doe

then the second occurence is not replaced and that combination looks
very ugly. i suggest you replace all occurences of '(C)' to the
copyright symbol automatically.

Regards,
Daniel