summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/v4/sisu_manual/sisu_filetypes.sst
blob: d36acac0b12d6349ec60079cb6f3187b7ad31f3b (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
% SiSU 4.0

@title: SiSU
 :subtitle: Filetypes

@creator:
 :author: Amissah, Ralph

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

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

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

:A~? @title @creator

1~filetypes SiSU filetypes

SiSU has plaintext and binary filetypes, and can process either type of document.

2~ .sst .ssm .ssi marked up plain text

SiSU documents are prepared as plain-text (utf-8) files with SiSU markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. SiSU 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.

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

SiSU source markup can be shared with the command:

_1 sisu -s [filename]

3~ sisu text - regular files (.sst)

The most common form of document in SiSU, see the section on SiSU markup.

3~ sisu master files (.ssm)

Composite documents which incorporate other SiSU documents which may be either regular SiSU text .sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents.

The mechanism by which master files incorporate other documents is described as one of the headings under under SiSU markup in the SiSU manual.

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.

Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst ~{ .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. }~

3~ sisu insert files (.ssi)

Inserts are documents prepared solely for the purpose of being incorporated into one or more master documents. They resemble regular SiSU text files except they are ignored by the SiSU 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.

2~ sisupod, zipped binary container (sisupod.zip, .ssp)

A sisupod is a zipped SiSU text file or set of SiSU text files and any associated images that they contain (this will be extended to include sound and multimedia-files)

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

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

The command to create a sisupod is:

_1 sisu -S [filename]

Alternatively, make a pod of the contents of a whole directory:

_1 sisu -S

SiSU processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided.

http://www.sisudoc.org/sisu/sisu_commands

http://www.sisudoc.org/sisu/sisu_manual

% 1~alt Experimental Alternative Input Representations
% 
% 2~ Alternative XML
% 
% SiSU 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.
% 
% !_ convert from sst to simple xml representations (sax, dom and node):
% 
% _1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]
% 
% _1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]
% 
% _1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]
% 
% !_ convert to sst from any sisu xml representation (sax, dom and node):
% 
% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% or the same:
% 
% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% 3~ XML SAX representation
% 
% To convert from sst to simple xml (sax) representation:
% 
% _1 sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard]
% 
% To convert from any sisu xml representation back to sst
% 
% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% or the same:
% 
% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% 3~ XML DOM representation
% 
% To convert from sst to simple xml (dom) representation:
% 
% _1 sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard]
% 
% To convert from any sisu xml representation back to sst
% 
% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% or the same:
% 
% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% 3~ XML Node representation
% 
% To convert from sst to simple xml (node) representation:
% 
% _1 sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard]
% 
% To convert from any sisu xml representation back to sst
% 
% _1 sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]
% 
% or the same:
% 
% _1 sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]]