aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/manuals_generated/sisu_manual/sisu_filetypes/dom.xml
blob: a96f1a831ca92563b2e9050545e20bcfe384b7af (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
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<?xml-stylesheet type="text/css" href="../_sisu/css/dom.css"?>
<!-- Document processing information:
     * Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23)
     * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
     * 
     * Last Generated on: Sun Sep 23 04:12:10 +0100 2007
     * SiSU http://www.jus.uio.no/sisu
-->

<document>

<head>

	<header>
		<meta>Title:</meta>
		<title>
			SiSU - Filetypes [0.58]
		</title>
	</header>

	<header>
		<meta>Creator:</meta>
		<creator>
			Ralph Amissah
		</creator>
	</header>

	<header>
		<meta>Rights:</meta>
		<rights>
			Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
		</rights>
	</header>

	<header>
		<meta>Type:</meta>
		<type>
			information
		</type>
	</header>

	<header>
		<meta>Subject:</meta>
		<subject>
			ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
		</subject>
	</header>

	<header>
		<meta>Date created:</meta>
		<date_created>
			2002-08-28
		</date_created>
	</header>

	<header>
		<meta>Date issued:</meta>
		<date_issued>
			2002-08-28
		</date_issued>
	</header>

	<header>
		<meta>Date available:</meta>
		<date_available>
			2002-08-28
		</date_available>
	</header>

	<header>
		<meta>Date modified:</meta>
		<date_modified>
			2007-09-16
		</date_modified>
	</header>

	<header>
		<meta>Date:</meta>
		<date>
			2007-09-16
		</date>
	</header>






</head>

<body>

<heading1>
	<heading>
		<object id="1">
			<ocn>1</ocn>
			<text>SiSU - Filetypes [0.58],<br /> Ralph Amissah</text>
		</object>
	</heading>

			<contents1>
				<heading>
					<object id="2">
						<ocn>2</ocn>
						<nametag>filetypes</nametag>

						<text>1. SiSU filetypes </text>
					</object>
				</heading>
					<content>

						<object id="3">


							<ocn>3</ocn>


							<text class="norm"><b>SiSU</b> has plaintext and binary filetypes, and can process either type of document.</text>

						</object>


					</content>

				<contents2>
					<heading>
						<object id="4">
							<ocn>4</ocn>
							<nametag>1.1</nametag>

							<text>1.1 .sst .ssm .ssi marked up plain text</text>
						</object>
					</heading>
					<content>

						<object id="5">


							<ocn>5</ocn>


							<text class="norm"><b>SiSU</b> documents are prepared as plain-text (utf-8) files with <b>SiSU</b> markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. <b>SiSU</b> plaintext markup files are of three types that may be distinguished by the file extension used: regular text .sst; master documents, composite documents that incorporate other text, which can be any regular text or text insert; and inserts the contents of which are like regular text except these are marked .ssi and are not processed.</text>

						</object>


						<object id="6">


							<ocn>6</ocn>


							<text class="norm"><b>SiSU</b> processing can be done directly against a sisu documents; which may be located locally or on a remote server for which a url is provided.</text>

						</object>


						<object id="7">


							<ocn>7</ocn>


							<text class="norm"><b>SiSU</b> source markup can be shared with the command:</text>

						</object>


						<object id="8">


							<ocn>8</ocn>


							<text class="indent1"> sisu -s [filename]</text>

						</object>


					</content>

					<contents3>
						<heading>
							<object id="9">
								<ocn>9</ocn>
								<nametag>1.1.1</nametag>

								<text>1.1.1 sisu text - regular files (.sst)</text>
							</object>
						</heading>
					<content>

						<object id="10">


							<ocn>10</ocn>


							<text class="norm">The most common form of document in <b>SiSU</b>, see the section on <b>SiSU</b> markup.</text>

						</object>


						<object id="11">


							<ocn>11</ocn>


							<text class="norm">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_markup">http://www.jus.uio.no/sisu/sisu_markup</link>&gt;</text>

						</object>


						<object id="12">


							<ocn>12</ocn>


							<text class="norm">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_manual">http://www.jus.uio.no/sisu/sisu_manual</link>&gt;</text>

						</object>


					</content>

					</contents3>

					<contents3>
						<heading>
							<object id="13">
								<ocn>13</ocn>
								<nametag>1.1.2</nametag>

								<text>1.1.2 sisu master files (.ssm)</text>
							</object>
						</heading>
					<content>

						<object id="14">


							<ocn>14</ocn>


							<text class="norm">Composite documents which incorporate other <b>SiSU</b> documents which may be either regular <b>SiSU</b> text .sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents.</text>

						</object>


						<object id="15">


							<ocn>15</ocn>


							<text class="norm">The mechanism by which master files incorporate other documents is described as one of the headings under under <b>SiSU</b> markup in the <b>SiSU</b> manual.</text>

						</object>


						<object id="16">


							<ocn>16</ocn>


							<text class="norm">Note: Master documents may be prepared in a similar way to regular documents, and processing will occur normally if a .sst file is renamed .ssm without requiring any other documents; the .ssm marker flags that the document may contain other documents.</text>

						</object>


						<object id="17">


							<ocn>17</ocn>


							<text class="norm">Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst <endnote><number>1</number><note>.ssc (for composite) is under consideration but ._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will have "accidents", working on a .ssc file that is overwritten by subsequent processing. It may be however that when the resulting file is shared .ssc is an appropriate suffix to use.</note></endnote></text>

						</object>


						<object id="18">


							<ocn>18</ocn>


							<text class="norm">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_markup">http://www.jus.uio.no/sisu/sisu_markup</link>&gt;</text>

						</object>


						<object id="19">


							<ocn>19</ocn>


							<text class="norm">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_manual">http://www.jus.uio.no/sisu/sisu_manual</link>&gt;</text>

						</object>


					</content>

					</contents3>

					<contents3>
						<heading>
							<object id="20">
								<ocn>20</ocn>
								<nametag>1.1.3</nametag>

								<text>1.1.3 sisu insert files (.ssi)</text>
							</object>
						</heading>
					<content>

						<object id="21">


							<ocn>21</ocn>


							<text class="norm">Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular <b>SiSU</b> text files except they are ignored by the <b>SiSU</b> processor. Making a file a .ssi file is a quick and convenient way of flagging that it is not intended that the file should be processed on its own.</text>

						</object>


					</content>

				</contents3>

				</contents2>

				<contents2>
					<heading>
						<object id="22">
							<ocn>22</ocn>
							<nametag>1.2</nametag>

							<text>1.2 sisupod, zipped binary container (sisupod.zip, .ssp)</text>
						</object>
					</heading>
					<content>

						<object id="23">


							<ocn>23</ocn>


							<text class="norm">A sisupod is a zipped <b>SiSU</b> text file or set of <b>SiSU</b> text files and any associated images that they contain (this will be extended to include sound and multimedia-files)</text>

						</object>


						<object id="24">


							<ocn>24</ocn>


							<text class="norm"><b>SiSU</b> plaintext files rely on a recognised directory structure to find contents such as images associated with documents, but all images for example for all documents contained in a directory are located in the sub-directory _sisu/image. Without the ability to create a sisupod it can be inconvenient to manually identify all other files associated with a document. A sisupod automatically bundles all associated files with the document that is turned into a pod.</text>

						</object>


						<object id="25">


							<ocn>25</ocn>


							<text class="norm">The structure of the sisupod is such that it may for example contain a single document and its associated images; a master document and its associated documents and anything else; or the zipped contents of a whole directory of prepared <b>SiSU</b> documents.</text>

						</object>


						<object id="26">


							<ocn>26</ocn>


							<text class="norm">The command to create a sisupod is:</text>

						</object>


						<object id="27">


							<ocn>27</ocn>


							<text class="indent1"> sisu -S [filename]</text>

						</object>


						<object id="28">


							<ocn>28</ocn>


							<text class="norm">Alternatively, make a pod of the contents of a whole directory:</text>

						</object>


						<object id="29">


							<ocn>29</ocn>


							<text class="indent1"> sisu -S</text>

						</object>


						<object id="30">


							<ocn>30</ocn>


							<text class="norm"><b>SiSU</b> processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided.</text>

						</object>


						<object id="31">


							<ocn>31</ocn>


							<text class="norm">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_commands">http://www.jus.uio.no/sisu/sisu_commands</link>&gt;</text>

						</object>


						<object id="32">


							<ocn>32</ocn>


							<text class="norm">&lt;<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:type="simple" xlink:href="http://www.jus.uio.no/sisu/sisu_manual">http://www.jus.uio.no/sisu/sisu_manual</link>&gt;</text>

						</object>


					</content>

			</contents2>

			</contents1>

			<contents1>
				<heading>
					<object id="33">
						<ocn>33</ocn>
						<nametag>alt</nametag>

						<text>2. Experimental Alternative Input Representations </text>
					</object>
				</heading>
					<content>

					</content>

				<contents2>
					<heading>
						<object id="34">
							<ocn>34</ocn>
							<nametag>2.1</nametag>

							<text>2.1 Alternative XML</text>
						</object>
					</heading>
					<content>

						<object id="35">


							<ocn>35</ocn>


							<text class="norm"><b>SiSU</b> offers alternative XML input representations of documents as a proof of concept, experimental feature. They are however not strictly maintained, and incomplete and should be handled with care.</text>

						</object>


						<object id="36">


							<ocn>36</ocn>


							<text class="norm"><b>convert from sst to simple xml representations (sax, dom and node):</b></text>

						</object>


						<object id="37">


							<ocn>37</ocn>


							<text class="indent1"> sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]</text>

						</object>


						<object id="38">


							<ocn>38</ocn>


							<text class="indent1"> sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]</text>

						</object>


						<object id="39">


							<ocn>39</ocn>


							<text class="indent1"> sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]</text>

						</object>


						<object id="40">


							<ocn>40</ocn>


							<text class="norm"><b>convert to sst from any sisu xml representation (sax, dom and node):</b></text>

						</object>


						<object id="41">


							<ocn>41</ocn>


							<text class="indent1"> sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


						<object id="42">


							<ocn>42</ocn>


							<text class="norm">or the same:</text>

						</object>


						<object id="43">


							<ocn>43</ocn>


							<text class="indent1"> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


					</content>

					<contents3>
						<heading>
							<object id="44">
								<ocn>44</ocn>
								<nametag>2.1.1</nametag>

								<text>2.1.1 XML SAX representation</text>
							</object>
						</heading>
					<content>

						<object id="45">


							<ocn>45</ocn>


							<text class="norm">To convert from sst to simple xml (sax) representation:</text>

						</object>


						<object id="46">


							<ocn>46</ocn>


							<text class="indent1"> sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]</text>

						</object>


						<object id="47">


							<ocn>47</ocn>


							<text class="norm">To convert from any sisu xml representation back to sst</text>

						</object>


						<object id="48">


							<ocn>48</ocn>


							<text class="indent1"> sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


						<object id="49">


							<ocn>49</ocn>


							<text class="norm">or the same:</text>

						</object>


						<object id="50">


							<ocn>50</ocn>


							<text class="indent1"> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


					</content>

					</contents3>

					<contents3>
						<heading>
							<object id="51">
								<ocn>51</ocn>
								<nametag>2.1.2</nametag>

								<text>2.1.2 XML DOM representation</text>
							</object>
						</heading>
					<content>

						<object id="52">


							<ocn>52</ocn>


							<text class="norm">To convert from sst to simple xml (dom) representation:</text>

						</object>


						<object id="53">


							<ocn>53</ocn>


							<text class="indent1"> sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]</text>

						</object>


						<object id="54">


							<ocn>54</ocn>


							<text class="norm">To convert from any sisu xml representation back to sst</text>

						</object>


						<object id="55">


							<ocn>55</ocn>


							<text class="indent1"> sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


						<object id="56">


							<ocn>56</ocn>


							<text class="norm">or the same:</text>

						</object>


						<object id="57">


							<ocn>57</ocn>


							<text class="indent1"> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


					</content>

					</contents3>

					<contents3>
						<heading>
							<object id="58">
								<ocn>58</ocn>
								<nametag>2.1.3</nametag>

								<text>2.1.3 XML Node representation</text>
							</object>
						</heading>
					<content>

						<object id="59">


							<ocn>59</ocn>


							<text class="norm">To convert from sst to simple xml (node) representation:</text>

						</object>


						<object id="60">


							<ocn>60</ocn>


							<text class="indent1"> sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]</text>

						</object>


						<object id="61">


							<ocn>61</ocn>


							<text class="norm">To convert from any sisu xml representation back to sst</text>

						</object>


						<object id="62">


							<ocn>62</ocn>


							<text class="indent1"> sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


						<object id="63">


							<ocn>63</ocn>


							<text class="norm">or the same:</text>

						</object>


						<object id="64">


							<ocn>64</ocn>


							<text class="indent1"> sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]</text>

						</object>


					</content>

			</contents3>

			</contents2>

			</contents1>

			<contents1>
				<heading>
					<object id="0">
						<ocn>0</ocn>
						<nametag>endnotes</nametag>

						<text>Endnotes</text>
					</object>
				</heading>
					<content>

					</content>
			</contents1>

</heading1>

</body>

</document>