summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst
blob: 4a23bdfef996ec9bc07a5c0fdd06d11c6bba0e9a (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
% SiSU insert 4.0

@title: SiSU
 :subtitle: Technical, Howto

@creator:
 :author: Amissah, Ralph

@date:
 :published: 2007-09-16
 :created: 2002-11-12
 :issued: 2002-11-12
 :available: 2002-11-12
 :modified: 2012-10-03

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

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

:A~? @title @creator

:B~? SiSU some technical information

:C~ HowTo

1~howto_help Getting Help

An online manual of sorts should be available at:

http://www.jus.uio.no/sisu_manual/

The manual pages provided with SiSU are also available online, and there is an interactive help, which is being superseded by the man page, and possibly some document which contains this component.

2~ SiSU "man" pages *~man

If SiSU is installed on your system usual man commands should be available, try:

man sisu

The SiSU man pages can be viewed online at:~{ generated from source using rman<br> http://polyglotman.sourceforge.net/rman.html <br>With regard to SiSU man pages the formatting generated for markup syntax is not quite right, for that you might prefer the links under:<br> http://www.jus.uio.no/sample }~

An online version of the sisu man page is available here:

_* {~^ various sisu man pages }http://www.jus.uio.no/sisu/man/

_* {~^ sisu.1 }http://www.jus.uio.no/sisu/man/sisu.1.html

_* {~^ sisu.8 }http://www.jus.uio.no/sisu/man/sisu.8.html

_* {~^ sisu_webrick.1 }http://www.jus.uio.no/sisu/man/sisu_webrick.1.html

2~ SiSU built-in help

_1 sisu --help

_1 sisu --help [subject]

_2 sisu --help env [for feedback on the way your system is setup with regard to sisu]

_2 sisu -V [same as above command]

_2 sisu --help commands

_2 sisu --help markup

2~ Command Line with Flags - Batch Processing

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

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.

1~howto_setup Setup, initialisation

2~ initialise output directory

Images, css files for a document directory are copied to their respective locations in the output directory.

while within your document markup/preparation directory, issue the following command

_1 sisu -CC

3~ Use of search functionality, an example using sqlite

SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases.

This note provides an example to get you started and will use sqlite

It is necessary to:

(1) make sure the required dependencies have been installed

(2) have a directory with sisu markup samples that is writable

(3) use sisu to create a database

(4) use sisu tp populate a database

(5) use sisu to start the webrick (httpd) server

(6) use sisu to create a search form

(7) copy the search form to the cgi directory

(8) open up the form in your browser

(9) query the database using the search form

!_ (1) make sure the required dependencies have been installed

if you use Debian, the following command will install the required dependencies

aptitude install sisu-sqlite

!_ (2) have a directory with sisu markup samples that is writable

ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable)

cp -rv /usr/share/doc/sisu/markup-samples/samples .

you are better off installing the package sisu-markup-samples which will make the following available

cp -rv /usr/share/doc/sisu/markup-samples-non-free/samples .

!_ (3) use sisu to create an sqlite database

within the sisu-examples directory

sisu -dv createall

!_ (4) use sisu tp populate a database with some text

within the sisu-examples directory

sisu -div free_*.sst

or

sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst gpl2.fsf.sst

!_ (5) use sisu to start the webrick (httpd) server (if it has not already been started):

sisu -W

!_ (6) use sisu to create a search form (for use with the webrick server, and your sample documents)

within the sisu-examples directory

sisu -F webserv=webrick

and follow the instructions provided

#here i run into a problem, you are working from a read only
#directory..., not my usual mode of operation, to complete the example
#the following is necessary
sudo touch sisu_sqlite.cgi sisu_pgsql.cgi
sudo -P chown $USER sisu_sqlite.cgi sisu_pgsql.cgi

#now this should be possible:
sisu -F webrick

!_ (7) copy the search form to the cgi directory

sisu -F webserv=webrick

and follow the instructions provided

% sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi

!_ (8) open up the form in your browser and query it

url:

http://localhost:8081/cgi-bin/sisu_sqlite.cgi

or as instructed by command sisu -F webrick

!_ (9) query the database using the search form

if there are other options in the dropdown menu select

document_samples_sisu_markup

and search for some text, e.g.:

aim OR project

_* selecting the *index* radio button gives an index of results using the object numbers

_* selecting the *text* radio button gives the content of the matched paragraphs with the match highlighted

!_ (10) to start again with a new database

to start from scratch you can drop the database with the command

sisu -dv dropall

and go to step 3

to get to step 3 in one step with a single command

sisu -dv recreate

continue subsequent steps

2~ misc

3~ url for output files -u -U

_1 sisu -uv[and other flags] [filename/wildcard]

_1 sisu -Uv [filename/wildcard]

3~ toggle screen color

_1 sisu -cv[and processing flags] [filename/wildcard]

3~ verbose mode

_1 sisu -v[and processing flags] [filename/wildcard]

_1 sisu -V[and processing flags] [filename/wildcard]

3~ quiet mode

_1 sisu -q[and processing flags] [filename/wildcard]

3~ maintenance mode
intermediate files kept -M

_1 sisu -Mv[and other flags] [filename/wildcard]

3~ start the webrick server

_1 sisu -W

2~ remote placement of output

configuration is necessary

scp

_1 sisu -vr[and processing flags] [filename/wildcard]

rsync

_1 sisu -vR[and processing flags] [filename/wildcard]

1~howto_config Configuration Files

Sample provided, on untarring the source tarball:

_1 conf/sisu/v4/sisurc.yml

_1 conf/sisu/v5/sisurc.yml

and on installation under:

_1 /etc/sisu/v4/sisurc.yml

_1 /etc/sisu/v5/sisurc.yml

The following paths are searched:

_1 ./_sisu/v4/sisurc.yml or ./_sisu/v5/sisurc.yml

_1 ./_sisu/sisurc.yml

_1 ~/.sisu/v4/sisurc.yml or ~/.sisu/v5/sisurc.yml

_1 ~/.sisu/sisurc.yml

_1 /etc/sisu/v4/sisurc.yml /etc/sisu/v5/sisurc.yml

_1 /etc/sisu/sisurc.yml

1~howto_markup Markup

See sample markup provided on

http://www.sisudoc.org/

http://www.jus.uio.no/sisu

http://www.jus.uio.no/sisu_markup

http://www.jus.uio.no/sisu/SiSU

in particular for each of the document output samples provided, the source document is provided as well

http://www.jus.uio.no/sisu/SiSU/examples.html

on untarring the source tarball:

_1 data/doc/sisu/markup-samples

or the same once source is installed (or sisu-examples) under:

_1 /usr/share/doc/sisu/markup-samples/

and if you have sisu-markup-samples installed, under

_1 data/doc/sisu/markup-samples-non-free/

_1 /usr/share/doc/sisu/markup-samples-non-free/

Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}*

SiSU is for literary and legal text, also for some social science material. In particular it does not do formula, and is not particularly suited to technical documentation. Despite the latter caveat, some notes will be provided here and added to over time:

2~ Headers

Headers @headername: provide information related to the document, this may relate to

# how it is to be processed, such as whether headings are to be numbered, what skin is to be used and markup instructions, such as the document structure, or words to be made bold within the document

# semantic information about the document including the dublin core

2~ Font Face

Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ...

3~ Bold

\@bold: [list of words that should be made bold within document]

!_ bold line

\!_ bold line

*{ bold word or sentence }*

!\{ bold word or sentence \}!

*\{ bold word or sentence \}*

*boldword* or !boldword!

\*boldword\* or \!boldword\!

3~ Italics

\@italics: [list of words that should be italicised within document]

/{ italicise word or sentence }/

/\{ italicise word or sentence \}/

/italicisedword/

\/italicisedword\/

3~ Underscore

_{ underscore word or sentence }_

_\{ underscore word or sentence \}_

_underscoreword_

3~ Strikethrough

-{ strikethrough word or sentence }-

-\{ strikethrough word or sentence \}-

-strikeword-

\-strikeword\-

2~ Endnotes

There are two forms of markup for endnotes, they cannot be mixed within the same document

here~{ this is an endnote }~

# preferred endnote markup

here~\{ this is an endnote \}~

# alternative markup equivalent, kept because it is possible to search and replace to get markup in existing texts such as Project Gutenberg

here\~^

^\~ this is an endote

2~ Links

{ SiSU }http://www.sisudoc.org

code{

{ SiSU }http://www.sisudoc.org

}code

{sisu.png }http://www.sisudoc.org

code{

{sisu.png }http://www.sisudoc.org

}code

{tux.png 64x80 }image

code{

{ tux.png 64x80 }image

}code

{~^ SiSU }http://www.sisudoc.org

code{

{~^ SiSU }http://www.sisudoc.org

}code

is equivalent to:

code{

{ SiSU }http://www.sisudoc.org ~{ http://www.sisudoc.org }~

}code

the same can be done with an image:

{~^ sisu.png "SiSU" }http://www.sisudoc.org

code{

{~^ sisu.png "SiSU" }http://www.sisudoc.org

}code

2~ Number Titles

Set with the header @markup:

2~ Line operations

Line Operations (marker placed at start of line)

\!_ bold line

!_ bold line

\_1 indent paragraph one level

_1 indent paragraph one level

\_2 indent paragraph two steps

_2 indent paragraph two steps

\_* bullet paragraph

_* bullet paragraph

\# number paragraph          (see headers  for  numbering  document headings)

# number paragraph          (see headers  for  numbering  document headings)

\_#  number  paragraph level 2  (see headers for numbering document headings)

_#  number paragraph level 2 (see headers for numbering document headings)

2~ Tables

Table markup sample

code{

table{~h c3; 26; 32; 32;

This is a table, column1
this would become row one of column two
column three of row one is here

column one row 2
column two of row two
column three of row two, and so on

column one row three
and so on
here

}table

}code

Alternative form of table markup

code{

{t~h}
     |Mon|Tue|Wed|Thu|Fri|Sat|Sun
0    | * | * | * | * | * | * | *
1    | * | * | * | * |   |   |
2    | - | * | * | * | * | * |
3    | - | * | * | * | * | * | *
4    | - |   |   | * | * | * |
5    | * | * | * | * | * | * | *

}code

2~ Grouped Text

code{

  5.times { puts 'Ruby' }

}code

code\{

code{

  5.times { puts 'Ruby' }

}code

\}code

poem{

A Limerick

There was a young lady from Clyde,
who ate a green apple and died,
but the apple fermented inside the lamented,
and made cider inside her inside.

}poem

code{

poem{

There was a young lady from Clyde,
who ate a green apple and died,
but the apple fermented inside the lamented,
and made cider inside her inside.

}poem

}code

2~ Composite Document

To import another document, the master document or importing document should be named filename.r3 (r for require)

\<\< \{ filename.sst \}

\<\< \{ filename.ssi \}

1~howto_appearance Change Appearance

2~ Skins

"Skins" are gone in v4 replaced by @make: :header: within a document, and a common shared _sisu/sisu_document_make file (which uses identical parameters to the individual documents @make: :header:)

2~ CSS

The appearance of html and XML related output can be changed for an ouput collection directory by prepareing and placing a new css file in one of the sisu css directories searched in the sisu configuration path. These are located at:

_./_sisu/css

~/.sisu/css

and

/etc/sisu/css

The contents of the first directory found in the search path are copied to the corresponding sisu output directory with the commnd:

sisu -CC

The SiSU standard css files for SiSU output are:

dom.css html.css html_tables.css index.css sax.css xhtml.css

A document may specify its own/bespoke css file using the css header.

\@css:

[expand]

:C~ Extracts from the README

1~howto_readme README

SiSU 0.55 2007w27/6 2007-07-07

Homepage: http://www.sisudoc.org

old homepage: http://www.jus.uio.no/sisu

!_ Description

SiSU is 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.

With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, EPUB, XML, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) in paragraph sized chunks so that document searches are done at this "atomic" level of granularity.

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

SiSU also provides concordance files, document content certificates and manifests of generated output.

SiSU takes advantage of well established open standard ways of representing text, and provides a bridge to take advantage of the strengths of each, while remaining simple. SiSU implements across document formats a "useful common feature set" [coming from a humanities, law, and possibly social sciences perspective, rather than technical or scientific writing] ... focus is primarily on content and data integrity rather than appearance, (though outputs in the various formats are respectable).

A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU.

man pages, and interactive help are provided.

Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU.

Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher.

Homepage: http://www.sisudoc.org

old homepage: http://www.jus.uio.no/sisu

SiSU - simple information structuring universe, is a publishing tool, document generation and management, (and search enabling) tool primarily for literary, academic and legal published works.

SiSU can be used for Internet, Intranet, local filesystem or cd publishing.

SiSU can be used directly off the filesystem, or from a database.

SiSU's scalability, is dependent on your hardware, and filesystem, and/or database Postgresql.

Amongst it's characteristics are:

_* simple mnemonoic markup style,

_* the ability to produce multiple output formats, including html, structured XML, LaTeX, pdf (via LaTeX), stream to a relational database whilst retaining document structure - Postgresql and Sqlite,

_* that all share a common citation system (a simple idea from which much good), possibly most exciting, the following: if fed into a relational database (as it can be automatically), the document set is searchable, with results displayed at a paragraph level, or the possibility of an indexed display of documents in which the match is found together with a hyperlinked listing for each of each paragraph in which the match is found. In any event citations using this system (with or without the relational database) are relevant for all output formats.

_* it is command line driven, and can be set up on a remote server

_* Documents are marked up in SiSU syntax in your favourite editor. SiSU syntax may be regarded as a type of smart ascii - which in its basic form is simpler than the most elementary html. There is currently a syntax highlighter, and folding for Vim. Syntax highlighters for other editors are welcome.

Input files should be UTF-8

Once set up it is simple to use.

2~ Online Information, places to look

http://www.sisudoc.org

http://www.jus.uio.no/sisu

Download Sources:

_1 http://www.jus.uio.no/sisu/SiSU/download.html#current

_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian

2~ Installation

NB. Platform is Unix / Linux.

3~ Debian

If you use Debian use the Debian packages, check the information at:

_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian

(A) SiSU is available directly off the Debian archives for Sid and testing. It
should necessary only to run as root:

_1 aptitude update

_1 aptitude install sisu-complete

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

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

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

[the non-free line is for document markup samples, for which the substantive text is provided under the author or original publisher's license and which in most cases will not be debian free software guideline compliant]

Then as root run:

_1 aptitude update

_1 aptitude install sisu-complete

3~ RPM

RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs.

They may be downloaded from:

_1 http://www.jus.uio.no/sisu/SiSU/download.html#rpm

3~ Source package .tgz

Otherwise to install SiSU from source, check information at:

_1 http://www.jus.uio.no/sisu/SiSU/download.html#current

alternative modes of installation from source are provided, setup.rb (by Minero Aoki), rake (by Jim Weirich) built install file, rant (by Stefan Lang) built install file,

Ruby is the essential dependency for the basic operation of SiSU

1. Download the latest source (information available) from:

_1 http://www.jus.uio.no/sisu/SiSU/download.html#current

2. Unpack the source

Note however, that additional external package dependencies, such as texlive or postgresql should you desire to use it are not taken care of for you.

3~ to use setup.rb

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

_1 ruby setup.rb config

_1 ruby setup.rb setup

as root:

_1 ruby setup.rb install

further information:

_1 http://i.loveruby.net/en/projects/setup/

_1 http://i.loveruby.net/en/projects/setup/doc/usage.html

3~ to use install (prapared with "Rake")

Rake must be installed on your system:

_1 http://rake.rubyforge.org/

_1 http://rubyforge.org/frs/?group_id=50

in the root directory of the unpacked SiSU as root type:

_1 rake

or

_1 rake base

This makes use of Rake (by Jim Weirich) and the provided Rakefile

For a list of alternative actions you may type:

_1 rake help

_1 rake -T

3~ to use install (prapared with "Rant")

(you may use the instructions above for rake substituting rant if rant is
installed on your system, or you may use an independent installer created using
rant as follows:)

in the root directory of the unpacked SiSU as root type:

_1 ruby ./sisu-install

or

_1 ruby ./sisu-install base

This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you.

further information:

_1 http://make.rubyforge.org/

_1 http://rubyforge.org/frs/?group_id=615

For a list of alternative actions you may type:

_1 ruby ./sisu-install help

_1 ruby ./sisu-install -T

2~ Dependencies

Once installed see 'man 8 sisu' for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) 'man sisu-markup-samples' may also be of interest if the sisu-markup-samples package has also been installed.

The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU).

The following is from the debian/control file of sisu-3.0.2, which amongst other things provides the dependencies of sisu within Debian.

code{

Source: sisu
Section: text
Priority: optional
Maintainer: SiSU Project <sisu@lists.sisudoc.org>
Uploaders: Ralph Amissah <ralph@amissah.com>
Build-Depends: debhelper (>= 8)
Standards-Version: 3.9.1
Homepage: http://www.sisudoc.org/
Vcs-Browser: http://git.sisudoc.org/?p=code/sisu.git
Vcs-Git: git://git.sisudoc.org/git/code/sisu.git
XS-Dm-Upload-Allowed: yes

}code

code{

Package: sisu
Architecture: all
Depends: ${misc:Depends}, ruby (>= 1.8.2), libwebrick-ruby, rsync, unzip, zip
Recommends:
 sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick, keychain, librmagick-ruby,
 librexml-ruby, openssl, openssh-client | lsh-client, tidy, vim-addon-manager
Suggests: lv, calibre, pinfo, texinfo, trang
Conflicts: sisu-markup-samples (<= 1.0.11)
Replaces: sisu-markup-samples (<= 1.0.11)
Description: documents - structuring, publishing in multiple formats and search
 SiSU is a lightweight markup based, command line oriented, document
 structuring, publishing and search framework for document collections.
 .
 With minimal preparation of a plain-text, (UTF-8) file, using its native
 markup syntax in your text editor of choice, SiSU can generate various
 document formats (most of which share a common object numbering system for
 locating content), including plain text, HTML, XHTML, XML, EPUB, OpenDocument
 text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects
 (roughly paragraph-sized chunks) so searches may be performed and matches
 returned with that degree of granularity: your search criteria is met by these
 documents and at these locations within each document. Object numbering is
 particularly suitable for "published" works (finalized texts as opposed to
 works that are frequently changed or updated) for which it provides a fixed
 means of reference of content. Document outputs also share semantic meta-data
 provided.
 .
 SiSU also provides concordance files, document content certificates and
 manifests of generated output.
 .
 A vim syntax highlighting file and an ftplugin with folds for sisu markup is
 provided, as are syntax highlighting files for kate, kwrite, gedit and
 diakonos. Vim 7 includes syntax highlighting for SiSU.
 .
 man pages, and interactive help are provided.
 .
 Dependencies for various features are taken care of in sisu related packages.
 The package sisu-complete installs the whole of SiSU.
 .
 Additional document markup samples are provided in the package
 sisu-markup-samples which is found in the non-free archive the licenses for
 the substantive content of the marked up documents provided is that provided
 by the author or original publisher.

}code

code{

Package: sisu-complete
Architecture: all
Depends:
 ${misc:Depends}, ruby (>= 1.8.2), sisu (= ${source:Version}), 
 sisu-pdf (= ${source:Version}), sisu-postgresql (= ${source:Version}), 
 sisu-sqlite (= ${source:Version})
Description: installs all SiSU related packages
 SiSU is a lightweight markup based document structuring, publishing and search
 framework for document collections.
 .
 This package installs SiSU and related packages that enable sisu to produce
 pdf and to populate PostgreSQL and sqlite databases.
 .
 See sisu for a description of the package.

}code

code{

Package: sisu-pdf
Architecture: all
Depends:
 ${misc:Depends}, sisu, texlive-latex-base, texlive-fonts-recommended,
 texlive-latex-recommended, texlive-latex-extra, texlive-xetex, lmodern,
 ttf-liberation
Suggests: evince | pdf-viewer
Description: dependencies to convert SiSU LaTeX output to pdf
 SiSU is a lightweight markup based document structuring, publishing and search
 framework for document collections.
 .
 This package enables the conversion of SiSU LaTeX output to pdf.

}code

code{

Package: sisu-pdf
Architecture: all
Depends:
 ${misc:Depends}, sisu, texlive-latex-base, texlive-fonts-recommended,
 texlive-latex-recommended, texlive-latex-extra, texlive-xetex, lmodern,
 ttf-liberation
Suggests: evince | pdf-viewer
Description: dependencies to convert SiSU LaTeX output to pdf
 SiSU is a lightweight markup based document structuring, publishing and search
 framework for document collections.
 .
 This package enables the conversion of SiSU LaTeX output to pdf.

}code

code{

Package: sisu-postgresql
Architecture: all
Depends:
 ${misc:Depends}, sisu, libdbd-pg-ruby, libdbd-pg-ruby1.8, libdbi-ruby,
 libdbi-ruby1.8, libdbm-ruby, postgresql, libfcgi-ruby1.8 | libfcgi-ruby1.9.1
Suggests: postgresql-contrib
Description: SiSU dependencies for use with PostgreSQL database
 SiSU is a lightweight markup based document structuring, publishing and search
 framework for document collections.
 .
 This package enables SiSU to populate a PostgreSQL database. This is done at
 an object/paragraph level, making granular searches of documents possible.
 .
 This relational database feature of SiSU is not required but provides
 interesting possibilities, including that of granular searches of documents
 for matching units of text, primarily paragraphs that can be displayed or
 identified by object citation number, from which an index of documents
 matched and each matched paragraph within them can be displayed.

}code

code{

Package: sisu-sqlite
Architecture: all
Depends:
 ${misc:Depends}, sisu, sqlite3, libsqlite3-ruby, libdbd-sqlite3-ruby,
 libdbd-sqlite3-ruby1.8, libdbi-ruby, libdbi-ruby1.8, libdbm-ruby,
 libfcgi-ruby1.8 | libfcgi-ruby1.9.1
Description: SiSU dependencies for use with SQLite database
 SiSU is a lightweight markup based document structuring, publishing and search
 framework for document collections.
 .
 This package enables SiSU to populate an SQLite database. This is done at an
 object/paragraph level, making granular searches of documents possible.
 .
 This relational database feature of SiSU is not required but provides
 interesting possibilities, including that of granular searches of documents
 for matching units of text, primarily paragraphs that can be displayed or
 identified by object citation number, from which an index of documents
 matched and each matched paragraph within them can be displayed.

}code

2~ Quick start

Most of the installation should be taken care of by the aptitude or rant
install. (The rant install if run in full will also test run the generation of
the first document).

After installation of sisu-complete, move to the document samples directory

_1 cd /usr/share/doc/sisu/markup-samples/samples

and run

_1 sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst

or the same:

_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

look at output results, see the "sisu_manifest" page created for the document

or to generate an online document move to a writable directory, as the file will be downloaded there and e.g.

sisu -3 http://www.jus.uio.no/sisu/src/free_culture.lawrence_lessig.sst

the database stuff is extra perhaps, the latex stuff could be considered extra perhaps but neither needs to be installed for most of sisu output to work

examine source document, vim has syntax support

gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst

additional markup samples in

_1 http://www.jus.uio.no/sisu/SiSU/examples.html

For help

_1 man sisu

or

_1 sisu --help

e.g.

for the way sisu "sees/maps" your system

_1 sisu --help env

for list of commands and so on

_1 sisu --help commands

2~ Configuration files

The default configuration/setup is contained within the program and is altered by configuration settings in /etc/[sisu version]/sisurc.yml or in ~/.sisu/sisurc.yml

_* configuration file - a yaml file

_1 /etc/sisu/[sisu version]/sisurc.yml

_1 ~/.sisu/sisurc.yml

_* directory structure - setting up of output and working directory.

_* additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on Debian), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are required for basic html or XML processing.

_* if you use Vim as editor there is a syntax highlighter and fold resource config file for SiSU. I hope more syntax highlighters follow.

There are post installation steps (which are really part of the overall installation)

sisu -C in your marked up document directory, should do some auto-configuring provided you have the right permissions for the output directories. (and provided the output directories have already been specified if you are not using the defaults).

2~ Use General Overview

Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm

Marked up SiSU documents are usually kept in a sub-directory of your choosing

use the interactive help and man pages

_1 sisu --help

_1 man sisu

2~ Help

interactive help described below, or man page:

_1 man sisu

_1 man 8 sisu

'man sisu_markup-samples' [if the sisu-markup-samples package is also installed]

Once installed an interactive help is available typing 'sisu' (without) any flags, and select an option:

_1 sisu

alternatively, you could type e.g.

_1 sisu --help commands

_1 sisu --help env

_1 sisu --help headers

_1 sisu --help markup

_1 sisu --help headings

etc.

for questions about mappings, output paths etc.

_1 sisu --help env

_1 sisu --help path

_1 sisu --help directory

2~ Directory Structure

Once installed, type:

_1  sisu --help env

or

_1  sisu -V

2~ Configuration File

The defaults can be changed via SiSU's configure file sisurc.yml which the program expects to find in ./_sisu ~/.sisu or /etc/sisu (searched in that order, stopping on the first one found)

2~ Markup

See man pages.

_1 man sisu

_1 man 8 sisu

Once installed there is some information on SiSU Markup in its help:

_1 sisu --help markup

and

_1 sisu --help headers

Sample marked up document are provided with the download tarball in the directory:

_1 ./data/doc/sisu/markup-samples/

These are installed on the system usually at:

_1 /usr/share/doc/sisu/markup-samples/

More markup samples are available in the package sisu-markup-samples, which if installed should be available at:

_1 /usr/share/doc/sisu/markup-samples-non-free/

Many more are available online off:

_1 http://www.jus.uio.no/sisu/SiSU/examples.html

2~ Additional Things

There is syntax support for some editors provided (together with a README file) in

_1 ./data/sisu/v4/conf/editor-syntax-etc

usually installed to:

_1 /usr/share/sisu/v4/conf/editor-syntax-etc

2~ License

License: GPL 3 or later see the copyright file in

_1 ./data/doc/sisu

usually installed to:

_1 /usr/share/doc/sisu

2~ SiSU Standard

SiSU uses:

_* Standard SiSU markup syntax,

_* Standard SiSU meta-markup syntax, and the

_* Standard SiSU object citation numbering and system

© Ralph Amissah 1997, current 2006 All Rights Reserved.

_* however note the License section

CHANGELOG

_1 ./CHANGELOG

and see

_1 http://www.jus.uio.no/sisu/SiSU/changelog.html

_1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html

:C~ Extracts from man 8 sisu

1~howto_setup_post_installation Post Installation Setup

2~ Post Installation Setup - Quick start

After installation of sisu-complete, move to the document samples directory,

_1 cd /usr/share/doc/sisu/markup-samples/samples

[this is not where you would normally work but provides sample documents for
testing, you may prefer instead to copy the contents of that directory to a local
directory before proceeding]

and in that directory, initialise the output directory with the command

_1 sisu -CC

then run:

_1 sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst

or the same:

_1 sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

look at output results, see the "sisu_manifest" page created for the document

for an overview of your current sisu setup, type:

_1 sisu --help env

or

_1 sisu -V

To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g.

_1 sisu -1 http://www.jus.uio.no/sisu/src/gpl.fsf.sst

_1 sisu -3 http://www.jus.uio.no/sisu/src/free_culture.lawrence_lessig.sst

examine source document, vim has syntax highlighting support

gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst

additional markup samples in

_1 http://www.jus.uio.no/sisu/SiSU/examples.html

it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely.

_1 sisu -3 http://www.jus.uio.no/sisu/pod/free_culture.lawrence_lessig.sst.zip

_1 sisu -3 --trust http://www.jus.uio.no/sisu/pod/free_culture.lawrence_lessig.sst.zip

For help

_1 man sisu

_1 sisu --help

_1 sisu --help env
for the way sisu "sees/maps" your system

_1 sisu --help commands
for list of commands and so on

2~ Document markup directory

% B. Generate a (local) document from a markup/work directory.

Perhaps the easiest way to begin is to create a directory for sisu marked up documents within your home directory, and copy the file structure (and document samples) provided in the document sample directory:

_1 mkdir ~/sisu_test

_1 cd ~/sisu_test

_1 cp -a /usr/share/doc/sisu/markup-samples/samples/* ~/sisu_test/.

better if you have installed sisu-markup-samples

_1 cp -a /usr/share/doc/sisu/markup-samples-non-free/samples/* ~/sisu_test/.

% !_ Tip:
% the markup syntax examples may be of interest
% 
% _1 http://www.jus.uio.no/sisu/sample/

!_ Tip:

_1 sisu -U [sisu markup filename]

should printout the different possible outputs and where sisu would place them.

!_ Tip:
if you want to toggle ansi color add

_1 c

to your flags.

3~ Configuration files

SiSU configuration file search path is:

_1 ./_sisu/sisurc.yaml

_1 ~/.sisu/sisurc.yaml

_1 /etc/sisu/sisurc.yaml

.\"%% Debian Installation Note

3~ Debian INSTALLATION Note

It is best you see

_1 http://www.jus.uio.no/sisu/SiSU/download.html#debian

for up the most up to date information.

notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU):

Package: sisu

SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections.

With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), EPUB, LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs also share semantic meta-data provided.

SiSU also provides concordance files, document content certificates and manifests of generated output.

A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided, as are syntax highlighting files for kate, kwrite, gedit and diakonos. Vim 7 includes syntax highlighting for SiSU.

man pages, and interactive help are provided.

Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU.

Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher.

Homepage: http://www.sisudoc.org

old homepage: http://www.jus.uio.no/sisu

3~ Document Resource Configuration

!_ sisu
resource configuration information is obtained from sources (where they exist):

_1 ~/.sisu/sisurc.yaml

_1 /etc/sisu/[sisu version]/sisurc.yaml

_1 sisu program defaults