|
|
SiSU Manual Ralph Amissah copy @ SiSU |
Rights: Copyright © Ralph Amissah 2007, part of SiSU documentation, License GPL 3
SiSU - Manual,
|
1 |
What is SiSU? |
2 |
1. Introduction - What is SiSU? |
3 |
SiSU is a system for document markup, publishing (in multiple open standard formats) and search |
4 |
SiSU 1 is a 2 framework for document structuring, publishing and search, comprising of (a) a lightweight document structure and presentation markup syntax and (b) an accompanying engine for generating standard document format outputs from documents prepared in sisu markup syntax, which is able to produce multiple standard outputs that (can) share a common numbering system for the citation of text within a document. |
5 |
Source document preparation and output generation is a two step process: (i) document source is prepared, that is, marked up in sisu markup syntax and (ii) the desired output subsequently generated by running the sisu engine against document source. Output representations if updated (in the sisu engine) can be generated by re-running the engine against the prepared source. Using SiSU markup applied to a document, SiSU custom builds various standard open output formats including plain text, HTML, XHTML, XML, OpenDocument, LaTeX or PDF files, and populate an SQL database with objects 3 (equating generally to paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity ( e.g. your search criteria is met by these documents and at these locations within each document). Document output formats share a common object numbering system for locating content. This 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. |
8 |
In preparing a SiSU document you optionally provide semantic information related to the document in a document header, and in marking up the substantive text provide information on the structure of the document, primarily indicating heading levels and footnotes. You also provide information on basic text attributes where used. The rest is automatic, sisu from this information custom builds 4 the different forms of output requested. |
9 |
SiSU works with an abstraction of the document based on its structure which is comprised of its frame 5 and the objects 6 it contains, which enables SiSU to represent the document in many different ways, and to take advantage of the strengths of different ways of presenting documents. The objects are numbered, and these numbers can be used to provide a common base for citing material within a document across the different output format types. This is significant as page numbers are not suited to the digital age, in web publishing, changing a browser's default font or using a different browser means that text appears on different pages; and in publishing in different formats, html, landscape and portrait pdf etc. again page numbers are of no use to cite text in a manner that is relevant against the different output types. Dealing with documents at an object level together with object numbering also has implications for search. |
10 |
One of the challenges of maintaining documents is to keep them in a format that would allow users to use them without depending on a proprietary software popular at the time. Consider the ease of dealing with legacy proprietary formats today and what guarantee you have that old proprietary formats will remain (or can be read without proprietary software/equipment) in 15 years time, or the way the way in which html has evolved over its relatively short span of existence. SiSU provides the flexibility of outputing documents in multiple non-proprietary open formats including html, pdf 7 and the ISO standard ODF. 8 Whilst SiSU relies on software, the markup is uncomplicated and minimalistic which guarantees that future engines can be written to run against it. It is also easily converted to other formats, which means documents prepared in SiSU can be migrated to other document formats. Further security is provided by the fact that the software itself, SiSU is available under GPL3 a licence that guarantees that the source code will always be open, and free as in libre which means that that code base can be used updated and further developed as required under the terms of its license. Another challenge is to keep up with a moving target. SiSU permits new forms of output to be added as they become important, (Open Document Format text was added in 2006), and existing output to be updated (html has evolved and the related module has been updated repeatedly over the years, presumably when the World Wide Web Consortium (w3c) finalises html 5 which is currently under development, the html module will again be updated allowing all existing documents to be regenerated as html 5). |
11 |
15 |
2. How does sisu work? |
16 |
3. Summary of features |
18 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 |
|
28 |
|
29 |
|
34 |
|
36 |
|
38 |
|
40 |
Syntax highlighting for SiSU markup is available for a number of text editors. |
41 |
4. Help |
45 |
4.1 SiSU Manual |
46 |
The most up to date information on sisu should be contained in the sisu_manual, available at: |
47 |
48 |
49 |
50 |
51 |
52 |
53 |
4.2 SiSU man pages |
54 |
If SiSU is installed on your system usual man commands should be available, try: |
55 |
56 |
57 |
58 |
Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: |
59 |
60 |
61 |
62 |
Available man pages are converted back to html using man2html: |
63 |
64 |
65 |
The SiSU man pages can be viewed online at: 9 |
66 |
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
4.3 SiSU built-in interactive help |
73 |
This is particularly useful when current installation information is obtained as the interactive help is able to provide information on your sisu configuration and setup. |
74 |
75 |
76 |
sisu --help env [for feedback on the way your system is setup with regard to sisu] |
77 |
78 |
79 |
80 |
NOTE: Running the command sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. |
82 |
4.4 Help Sources |
83 |
84 |
85 |
86 |
87 |
/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html |
88 |
89 |
90 |
<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> |
91 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html> |
92 |
5. Commands Summary |
93 |
5.1 Synopsis |
94 |
SiSU - Structured information, Serialized Units - a document publishing system |
95 |
sisu [ -abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9 ] [ filename/ wildcard ] |
96 |
97 |
98 |
Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. |
99 |
5.2 Description |
100 |
SiSU SiSU is a document publishing system, that from a simple single marked-up document, produces multiple of output formats including: plaintext, html, LaTeX, pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: <http://www.jus.uio.no/sisu> |
101 |
5.3 Document Processing Command Flags |
102 |
-b [filename/wildcard] |
104 |
-H [filename/wildcard] |
111 |
-I [filename/wildcard] |
113 |
114 |
-M [filename/wildcard/url] |
115 |
-n [filename/wildcard/url] |
118 |
-o [filename/wildcard/url] |
119 |
121 |
-s [filename/wildcard] |
126 |
-t [filename/wildcard (*.termsheet.rb)] |
127 |
-u [filename/wildcard] |
129 |
-V |
130 |
-V [filename/wildcard] |
131 |
132 |
-X [filename/wildcard] |
136 |
-x [filename/wildcard] |
137 |
-y [filename/wildcard] |
139 |
-z [filename/wildcard] |
141 |
6. command line modifiers |
142 |
--no-ocn |
143 |
--no-annotate |
144 |
--no-asterisk |
145 |
--no-dagger |
146 |
7. database commands |
147 |
148 |
-D or --pgsql set for postgresql -d or --sqlite default set for sqlite -d is modifiable with --db=[database type (pgsql or sqlite)] |
149 |
-Dv --import |
151 |
-Dv --update |
152 |
-D --remove |
153 |
-D --dropall |
154 |
155 |
8. Shortcuts, Shorthand for multiple flags |
156 |
-0 to -5 [filename or wildcard] |
158 |
-0 |
159 |
160 |
161 |
162 |
163 |
164 |
add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] |
165 |
166 |
8.0.1 Command Line with Flags - Batch Processing |
167 |
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. |
168 |
Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. Enter to escape. |
169 |
9. Introduction to SiSU Markup 15 |
170 |
9.1 Summary |
171 |
SiSU source documents are plaintext (UTF-8) 16 files |
172 |
173 |
174 |
|
177 |
|
178 |
|
179 |
|
180 |
|
181 |
|
182 |
Some interactive help on markup is available, by typing sisu and selecting markup or sisu --help markup |
183 |
9.2 Markup Examples |
184 |
9.2.1 Online |
185 |
Online markup examples are available together with the respective outputs produced from <http://www.jus.uio.no/sisu/SiSU/2.html> or from <http://www.jus.uio.no/sisu/sisu_examples/> |
186 |
There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: <http://www.jus.uio.no/sisu/sisu_markup/> |
187 |
Some example marked up files are available as html with syntax highlighting for viewing: <http://www.jus.uio.no/sisu/sample/syntax> |
188 |
an alternative presentation of markup syntax: <http://www.jus.uio.no/sisu/sample/on_markup.txt> |
189 |
9.2.2 Installed |
190 |
10. Markup of Headers |
192 |
Headers consist of semantic meta-data about a document, which can be used by any output module of the program; and may in addition include extra processing instructions. |
193 |
195 |
10.1 Sample Header |
196 |
This current document has a header similar to this one (without the comments): |
197 |
10.2 Available Headers |
199 |
201 |
where the "identifier" is a tag recognised by the program, and the "information" or "instructions" belong to the tag/indentifier specified |
202 |
Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: header is used to describe document structure, and can be useful to know. |
203 |
204 |
% SiSU 0.38 [declared file-type identifier with markup version] |
205 |
@title: [title text] This is the title of the document and used as such, this header is the only one that is mandatory |
206 |
207 |
208 |
209 |
210 |
211 |
212 |
213 |
214 |
215 |
@date: 2000-08-27 [ also @date.created: @date.issued: @date.available: @date.valid: @date.modified: ] |
216 |
217 |
218 |
219 |
220 |
[@language.original: original language in which the work was published] |
222 |
223 |
224 |
225 |
@rights: Copyright (c) Name of Right Holder, all rights reserved, or as granted: public domain, copyleft, creative commons variant, etc. |
226 |
227 |
@keywords: text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches] |
228 |
229 |
230 |
@catalogue: loc=[Library of Congress classification]; dewey=[Dewey classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] |
231 |
232 |
233 |
234 |
235 |
236 |
@prefix_a: [prefix is placed just before table of contents - not implemented] |
237 |
238 |
@level: newpage=3; breakpage=4 |
241 |
@bold: [regular expression of words/phrases to be made bold] |
243 |
@italics: [regular expression of words/phrases to italicise] |
244 |
@vocabulary: name of taxonomy/vocabulary/wordlist to use against document |
245 |
@links: { SiSU }http://www.jus.uio.no/sisu/; |
247 |
11. Markup of Substantive Text |
249 |
11.1 Heading Levels |
250 |
:A~ [heading text] Top level heading [this usually has similar content to the title @title: ] NOTE: the heading levels described here are in 0.38 notation, see heading |
252 |
:B~ [heading text] Second level heading [this is a heading level divider] |
253 |
:C~ [heading text] Third level heading [this is a heading level divider] |
254 |
2~ [heading text] Second level heading preceding substantive text of document or sub-heading 3, the heading level that would normally be marked 1.1 or 1.2 or 1.3 or 2.1 etc. in a document. |
256 |
3~ [heading text] Third level heading preceding substantive text of document, that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document |
257 |
11.2 Font Attributes |
259 |
260 |
262 |
normal text emphasis bold text underscore italics citation superscript subscript inserted text |
263 |
264 |
265 |
266 |
267 |
268 |
269 |
270 |
271 |
272 |
273 |
11.3 Indentation and bullets |
274 |
275 |
ordinary paragraph |
276 |
277 |
278 |
279 |
280 |
281 |
282 |
_* bullet text |
283 |
284 |
|
285 |
|
286 |
|
287 |
Numbered List (not to be confused with headings/titles, (document structure)) |
288 |
289 |
# numbered list numbered list 1., 2., 3, etc. |
290 |
11.4 Footnotes / Endnotes |
291 |
293 |
294 |
295 |
296 |
297 |
normal text~{ self contained endnote marker & endnote in one }~ continues |
298 |
299 |
normal text 18 continues |
300 |
301 |
normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues |
302 |
303 |
normal text * continues |
304 |
normal text ** continues |
305 |
306 |
normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues |
307 |
308 |
normal text *3 continues |
309 |
normal text +2 continues |
310 |
311 |
% note the endnote marker "~^" |
312 |
the standard and pair notation cannot be mixed in the same document |
313 |
11.5 Links |
314 |
11.5.1 Naked URLs within text, dealing with urls |
315 |
317 |
318 |
319 |
normal text <http://www.jus.uio.no/sisu> continues |
320 |
321 |
322 |
normal text _http://www.jus.uio.no/sisu continues |
323 |
324 |
normal text http://www.jus.uio.no/sisu continues |
325 |
deb http://www.jus.uio.no/sisu/archive unstable main non-free |
326 |
where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document |
327 |
328 |
deb http://www.jus.uio.no/sisu/archive unstable main non-free |
329 |
330 |
331 |
332 |
11.5.2 Linking Text |
333 |
334 |
about SiSU markup |
335 |
A shortcut notation is available so the url link may also be provided automatically as a footnote |
336 |
337 |
338 |
339 |
340 |
11.5.3 Linking Images |
341 |
342 |
344 |
345 |
346 |
[ ruby_logo (png missing) ] 20 |
347 |
348 |
349 |
351 |
11.6 Grouped Text |
353 |
11.6.1 Tables |
354 |
355 |
356 |
358 |
|
359 |
a second form may be easier to work with in cases where there is not much information in each column |
360 |
markup example: 21 |
361 |
363 |
Table 3.1: Contributors to Wikipedia, January 2001 - June 2005 |
364 |
|
365 |
* Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. |
366 |
11.6.2 Poem |
367 |
368 |
poem{ |
369 |
370 |
372 |
11.6.3 Group |
374 |
375 |
group{ |
376 |
377 |
379 |
11.6.4 Code |
381 |
A code-block is treated as an object and given a single object number. [an option to number each line of code may be considered at some later time] |
383 |
use of code tags instead of poem compared, resulting output: |
384 |
12. Composite documents markup |
386 |
basic markup for importing a document into a master document |
388 |
389 |
Markup Syntax History |
392 |
13. Notes related to Files-types and Markup Syntax |
393 |
0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37 |
394 |
0.52 (2007w14/6) declared document type identifier at start of text/document: |
395 |
396 |
397 |
398 |
variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]' |
399 |
0.51 (2007w13/6) skins changed (simplified), markup unchanged |
400 |
0.42 (2006w27/4) * (asterisk) type endnotes, used e.g. in relation to author |
401 |
0.38 (2006w15/7) introduced new/alternative notation for headers, e.g. @title: (instead of 0~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6) |
402 |
0.37 (2006w09/7) introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged |
403 |
404 |
405 |
0.22 (2005w35/3) image dimensions may be omitted if rmagick is available to be relied upon |
406 |
407 |
0.16 (2005w25/2) substantial changes introduced to make markup cleaner, header 0~title type, and headings [1-6]~ introduced, also percentage sign (%) at start of a text line as comment marker |
408 |
14. SiSU filetypes |
409 |
SiSU has plaintext and binary filetypes, and can process either type of document. |
410 |
14.1 .sst .ssm .ssi marked up plain text |
411 |
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. |
413 |
414 |
415 |
14.1.1 sisu text - regular files (.sst) |
416 |
The most common form of document in SiSU, see the section on SiSU markup. |
417 |
418 |
419 |
14.1.2 sisu master files (.ssm) |
420 |
The mechanism by which master files incorporate other documents is described as one of the headings under under SiSU markup in the SiSU manual. |
422 |
Note: a secondary file of the composite document is built prior to processing with the same prefix and the suffix ._sst 22 |
424 |
425 |
426 |
14.1.3 sisu insert files (.ssi) |
427 |
14.2 sisupod, zipped binary container (sisupod.zip, .ssp) |
429 |
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) |
430 |
433 |
434 |
Alternatively, make a pod of the contents of a whole directory: |
435 |
436 |
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. |
437 |
438 |
439 |
15. Experimental Alternative Input Representations |
440 |
15.1 Alternative XML |
441 |
convert from sst to simple xml representations (sax, dom and node): |
443 |
sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] |
444 |
sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] |
445 |
sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] |
446 |
convert to sst from any sisu xml representation (sax, dom and node): |
447 |
sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
448 |
449 |
sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
450 |
15.1.1 XML SAX representation |
451 |
452 |
sisu --to-sax [filename/wildcard] or sisu --to-sxs [filename/wildcard] |
453 |
454 |
sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
455 |
456 |
sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
457 |
15.1.2 XML DOM representation |
458 |
459 |
sisu --to-dom [filename/wildcard] or sisu --to-sxd [filename/wildcard] |
460 |
461 |
sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
462 |
463 |
sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
464 |
15.1.3 XML Node representation |
465 |
466 |
sisu --to-node [filename/wildcard] or sisu --to-sxn [filename/wildcard] |
467 |
468 |
sisu --from-xml2sst [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
469 |
470 |
sisu --from-sxml [filename/wildcard [.sxs.xml,.sxd.xml,sxn.xml]] |
471 |
16. Configuration |
472 |
16.1 Determining the Current Configuration |
473 |
Information on the current configuration of SiSU should be available with the help command: |
474 |
475 |
476 |
477 |
Either of these should be executed from within a directory that contains sisu markup source documents. |
478 |
16.2 Configuration files (config.yml) |
479 |
The SiSU configuration file is a yaml file, which means indentation is significant. |
481 |
SiSU resource configuration is determined by looking at the following files if they exist: |
482 |
483 |
484 |
485 |
The search is in the order listed, and the first one found is used. |
486 |
In the absence of instructions in any of these it falls back to the internal program defaults. |
487 |
Configuration determines the output and processing directories and the database access details. |
488 |
If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml |
489 |
17. Skins |
490 |
Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: |
491 |
492 |
493 |
494 |
Within the skin directory are the following the default sub-directories for document skins: |
495 |
496 |
497 |
498 |
A skin is placed in the appropriate directory and the file named skin_[name].rb |
499 |
The skin itself is a ruby file which modifies the default appearances set in the program. |
500 |
17.1 Document Skin |
501 |
Documents take on a document skin, if the header of the document specifies a skin to be used. |
502 |
503 |
17.2 Directory Skin |
504 |
A personal habit is to place all skins within the doc directory, and symbolic links as needed from the site, or dir directories as required. |
506 |
17.3 Site Skin |
507 |
508 |
17.4 Sample Skins |
509 |
510 |
/etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc |
511 |
(or equivalent directory) and if sisu-markup-samples is installed also under: |
512 |
/usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc |
513 |
Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: |
514 |
/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) |
515 |
18. CSS - Cascading Style Sheets (for html, XHTML and XML) |
516 |
The basic CSS file for html output is html.css, placing a file of that name in directory _sisu/css or equivalent will result in the default file of that name being overwritten. |
518 |
519 |
520 |
521 |
522 |
523 |
Under consideration is to permit the placement of a CSS file with a different name in directory _sisu/css directory or equivalent, and change the default CSS file that is looked for in a skin. 23 |
524 |
19. Organising Content |
525 |
19.1 Directory Structure and Mapping |
526 |
19.2 Organising Content |
529 |
20. Homepages |
530 |
1. through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient option) |
532 |
2. through providing what you want as the home page in a skin, |
533 |
20.1 Home page and other custom built pages in a sub-directory |
535 |
537 |
20.2 Home page within a skin |
538 |
class Home |
541 |
21. Markup and Output Examples |
542 |
21.1 Markup examples |
543 |
Current markup examples and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/2.html> |
544 |
Some markup with syntax highlighting may be found under <http://www.jus.uio.no/sisu/sample/syntax> but is not as up to date. |
545 |
For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. |
546 |
21.2 A few book (and other) examples |
547 |
24 |
548 |
"The Wealth of Networks", Yochai Benkler |
549 |
550 |
551 |
552 |
553 |
554 |
555 |
556 |
557 |
558 |
559 |
560 |
561 |
562 |
563 |
564 |
"Free Culture", Lawrence Lessig |
565 |
566 |
567 |
568 |
569 |
570 |
571 |
572 |
573 |
574 |
575 |
576 |
577 |
578 |
579 |
580 |
"Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams |
581 |
"Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams |
582 |
583 |
584 |
585 |
586 |
587 |
588 |
589 |
590 |
591 |
592 |
593 |
594 |
595 |
596 |
"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner |
597 |
"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner |
598 |
599 |
600 |
601 |
602 |
603 |
604 |
605 |
606 |
607 |
608 |
609 |
610 |
611 |
612 |
"The Cathedral and the Bazaar", by Eric S. Raymond |
613 |
614 |
615 |
616 |
617 |
618 |
619 |
620 |
621 |
622 |
623 |
624 |
625 |
626 |
627 |
628 |
"Accelerando", Charles Stross |
629 |
630 |
631 |
632 |
633 |
634 |
635 |
636 |
637 |
638 |
639 |
640 |
641 |
642 |
643 |
644 |
"Tainaron", Leena Krohn |
645 |
646 |
647 |
648 |
649 |
650 |
651 |
652 |
653 |
654 |
655 |
656 |
657 |
658 |
659 |
660 |
"Sphinx or Robot", Leena Krohn |
661 |
662 |
663 |
664 |
665 |
666 |
667 |
668 |
669 |
670 |
671 |
672 |
673 |
674 |
675 |
676 |
677 |
"War and Peace", Leo Tolstoy, PG Etext 2600 |
678 |
679 |
680 |
681 |
682 |
683 |
684 |
685 |
686 |
687 |
688 |
689 |
690 |
691 |
692 |
693 |
"Don Quixote", Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996 |
694 |
695 |
696 |
697 |
698 |
699 |
700 |
701 |
702 |
703 |
704 |
705 |
706 |
707 |
708 |
709 |
"Gulliver's Travels", Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829 |
710 |
711 |
712 |
713 |
714 |
715 |
716 |
717 |
718 |
719 |
720 |
721 |
722 |
723 |
724 |
725 |
"Alice's Adventures in Wonderland", Lewis Carroll, PG Etext 11 |
726 |
727 |
728 |
729 |
730 |
731 |
732 |
733 |
734 |
735 |
736 |
737 |
738 |
739 |
740 |
741 |
"Through The Looking-Glass", Lewis Carroll, PG Etext 12 |
742 |
743 |
744 |
745 |
746 |
747 |
748 |
749 |
750 |
751 |
752 |
753 |
754 |
755 |
756 |
757 |
"Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll, PG Etexts 11 and 12 |
758 |
"Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll |
759 |
760 |
761 |
762 |
763 |
764 |
765 |
766 |
767 |
768 |
769 |
770 |
771 |
772 |
773 |
"Gnu Public License 2", (GPL 2) Free Software Foundation |
774 |
775 |
776 |
777 |
778 |
779 |
780 |
781 |
782 |
783 |
784 |
785 |
786 |
787 |
788 |
789 |
"Gnu Public License v3 - Third discussion draft", (GPLv3) Free Software Foundation |
790 |
"Gnu Public License 3 - Third discussion draft", (GPL v3 draft3) Free Software Foundation |
791 |
792 |
793 |
794 |
795 |
796 |
797 |
798 |
799 |
800 |
801 |
802 |
803 |
804 |
805 |
"Debian Social Contract" |
806 |
807 |
808 |
809 |
810 |
811 |
812 |
813 |
814 |
815 |
816 |
817 |
818 |
819 |
820 |
821 |
"Debian Constitution v1.3", (simple/default markup) |
822 |
823 |
824 |
825 |
826 |
827 |
828 |
829 |
830 |
831 |
832 |
833 |
834 |
835 |
836 |
837 |
"Debian Constitution v1.3", (markup adjusted for output to more closely match the original) |
838 |
"Debian Constitution v1.3", (markup adjusted for output to more closely match the original) |
839 |
840 |
841 |
842 |
843 |
844 |
845 |
846 |
847 |
848 |
849 |
850 |
851 |
852 |
853 |
"Debian Constitution v1.2", (simple/default markup) |
854 |
855 |
856 |
857 |
858 |
859 |
860 |
861 |
862 |
863 |
864 |
865 |
866 |
867 |
868 |
869 |
"Debian Constitution v1.2", (markup adjusted for output to more closely match the original) |
870 |
"Debian Constitution (more translations)", (markup adjusted for output to more closely match the original) |
871 |
872 |
873 |
874 |
875 |
876 |
877 |
878 |
879 |
880 |
881 |
882 |
883 |
884 |
885 |
"A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer |
886 |
"A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer |
887 |
888 |
889 |
890 |
891 |
892 |
893 |
894 |
895 |
896 |
897 |
898 |
899 |
900 |
901 |
"The Autonomous Contract" 1997 - markup sample |
902 |
903 |
904 |
905 |
906 |
907 |
908 |
909 |
910 |
911 |
912 |
913 |
914 |
915 |
916 |
917 |
"The Autonomous Contract Revisited" - markup sample |
918 |
919 |
920 |
921 |
922 |
923 |
924 |
925 |
926 |
927 |
928 |
929 |
930 |
931 |
932 |
933 |
"United Nations Convention on Contracts for the International Sale of Goods" |
934 |
"United Nations Convention on Contracts for the International Sale of Goods" 51 |
935 |
936 |
937 |
938 |
939 |
940 |
941 |
942 |
943 |
944 |
945 |
946 |
947 |
948 |
949 |
PECL the "Principles of European Contract Law" |
950 |
951 |
952 |
953 |
954 |
955 |
956 |
957 |
958 |
959 |
960 |
961 |
962 |
963 |
964 |
965 |
21.3 SQL - PostgreSQL, SQLite |
966 |
A Sample search form is available at <http://search.sisudoc.org> |
967 |
968 |
969 |
970 |
971 |
972 |
Note that the searches done in this form are case sensitive. |
973 |
Expand those same searches, showing the matching text in each document: |
974 |
975 |
976 |
977 |
978 |
Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria. 54 |
979 |
21.4 Lex Mercatoria as an example |
980 |
There is quite a bit to peruse if you explore the site Lex Mercatoria: |
981 |
982 |
983 |
<http://lexmercatoria.org/treaties.and.organisations/lm.chronological> 56 |
984 |
21.5 For good measure the markup for a document with lots of (simple) tables |
985 |
SiSU is not optimised for table making, but does handle simple tables. |
986 |
|
987 |
|
988 |
21.6 And a link to the output of a reported case |
989 |
<http://www.jus.uio.no/lm/england.fothergill.v.monarch.airlines.hl.1980/toc.html> |
990 |
22. A Checklist of Output Features |
991 |
This table gives an indication of the features that are available for various forms of output of SiSU. 59 |
992 |
|
993 |
Done |
994 |
23. SiSU Search - Introduction |
995 |
SiSU output can easily and conveniently be indexed by a number of standalone indexing tools, such as Lucene, Hyperestraier. |
996 |
24. SQL |
999 |
24.1 populating SQL type databases |
1000 |
SiSU feeds sisu markupd documents into sql type databases PostgreSQL 60 and/or SQLite 61 database together with information related to document structure. |
1001 |
|
1003 |
|
1005 |
|
1006 |
There is of course the possibility to add further structures. |
1007 |
25. Postgresql |
1010 |
25.1 Name |
1011 |
SiSU - Structured information, Serialized Units - a document publishing system, postgresql dependency package |
1012 |
25.2 Description |
1013 |
25.3 Synopsis |
1015 |
1016 |
sisu -D --pg --[instruction] [filename/wildcard if required] |
1017 |
25.4 Commands |
1018 |
1020 |
25.4.1 create and destroy database |
1021 |
sisu -D --createdb |
1023 |
sisu -D --create |
1024 |
sisu -D --Dropall |
1025 |
sisu -D --recreate |
1026 |
25.4.2 import and remove documents |
1027 |
sisu -D --import -v [filename/wildcard] |
1028 |
sisu -D --update -v [filename/wildcard] |
1029 |
sisu -D --remove -v [filename/wildcard] |
1030 |
26. Sqlite |
1031 |
26.1 Name |
1032 |
SiSU - Structured information, Serialized Units - a document publishing system. |
1033 |
26.2 Description |
1034 |
26.3 Synopsis |
1036 |
1037 |
sisu -d --(sqlite|pg) --[instruction] [filename/wildcard if required] |
1038 |
26.4 Commands |
1039 |
1041 |
26.4.1 create and destroy database |
1042 |
sisu -d --createdb |
1044 |
sisu -d --create |
1045 |
sisu -d --dropall |
1046 |
sisu -d --recreate |
1047 |
26.4.2 import and remove documents |
1048 |
sisu -d --import -v [filename/wildcard] |
1049 |
sisu -d --update -v [filename/wildcard] |
1050 |
sisu -d --remove -v [filename/wildcard] |
1051 |
27. Introduction |
1052 |
27.1 Search - database frontend sample, utilising database and SiSU features, including object citation numbering (backend currently PostgreSQL) |
1053 |
Sample search frontend 62 A small database and sample query front-end (search from) that makes use of the citation system, object citation numbering to demonstrates functionality. 63 |
1054 |
Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria. 64 |
1056 |
sisu -F --webserv-webrick |
1057 |
The following is feedback on the setup on a machine provided by the help command: |
1058 |
1059 |
1061 |
27.2 Search Form |
1063 |
sisu -F |
1064 |
sisu -F --webserv-webrick |
1065 |
sisu -Fv |
1066 |
sisu -W |
1067 |
The generated search form must be copied manually to the webserver directory as instructed |
1068 |
28. Hyperestraier |
1069 |
1070 |
1071 |
1072 |
1073 |
1074 |
1075 |
/usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html |
1076 |
NOTE: the examples that follow assume that sisu output is placed in the directory /home/ralph/sisu_www |
1077 |
(A) to generate the index within the webserver directory to be indexed: |
1078 |
1079 |
the following are examples that will need to be tailored according to your needs: |
1080 |
1081 |
1082 |
you may use the 'find' command together with 'egrep' to limit indexing to particular document collection directories within the web server directory: |
1083 |
find /home/ralph/sisu_www -type f | egrep '/home/ralph/sisu_www/sisu/.+?.html$' |estcmd gather -sd casket - |
1084 |
Check which directories in the webserver/output directory (~/sisu_www or elsewhere depending on configuration) you wish to include in the search index. |
1085 |
find /home/ralph/sisu_www -type f | egrep '/sisu_www/(sisu|bookmarks)/.+?.html$' | egrep -v '(doc|concordance).html$' |estcmd gather -sd casket - |
1087 |
from your current document preparation/markup directory, you would construct a rune along the following lines: |
1088 |
1090 |
(i) copy estseek.cgi to your cgi directory and set file permissions to 755: |
1091 |
1092 |
1093 |
sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin |
1094 |
1095 |
(ii) edit estseek.conf, with attention to the lines starting 'indexname:' and 'replace:': |
1096 |
1097 |
replace: ^file:///home/ralph/sisu_www{!} |
1098 |
1099 |
1100 |
1101 |
and try open the url: <http://localhost:8081/cgi-bin/estseek.cgi> |
1102 |
29. sisu_webrick |
1103 |
29.1 Name |
1104 |
SiSU - Structured information, Serialized Units - a document publishing system |
1105 |
29.2 Synopsis |
1106 |
1107 |
1108 |
1109 |
29.3 Description |
1110 |
29.4 Summary of man page |
1113 |
sisu_webrick, may be started on it's own with the command: sisu_webrick [port] or using the sisu command with the -W flag: sisu -W [port] |
1114 |
where no port is given and settings are unchanged the default port is 8081 |
1115 |
29.5 Document processing command flags |
1116 |
29.6 Further information |
1118 |
For more information on SiSU see: <http://www.jus.uio.no/sisu> |
1119 |
1120 |
29.7 Author |
1121 |
Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com> |
1122 |
29.8 SEE ALSO |
1123 |
1124 |
1125 |
1126 |
30. Remote Source Documents |
1127 |
1129 |
1131 |
Any of the source documents in the sisu examples page can be used in this way, see <http://www.jus.uio.no/sisu/SiSU/2.html> and use the url for the desired document. |
1132 |
NOTE: to set up a remote machine to serve SiSU documents in this way, images should be in the directory relative to the document source ../_sisu/image |
1133 |
1134 |
A sisupod is the zipped content of a sisu marked up text or texts and any other associated parts to the document such as images. |
1135 |
SiSU can be run against a sisupod on a (local or) remote machine, provide the processing instruction and the url, the sisupod will be downloaded and the documents it contains generated locally. |
1136 |
sisu -3 http://[provide url to valid sisupod.zip or .ssp file] |
1137 |
Any of the source documents in the sisu examples page can be used in this way, see <http://www.jus.uio.no/sisu/SiSU/2.html> and use the url for the desired document. |
1138 |
Remote Document Output |
1139 |
31. Remote Output |
1140 |
Once properly configured SiSU output can be automatically posted once generated to a designated remote machine using either rsync, or scp. |
1141 |
1143 |
31.1 commands |
1144 |
31.2 configuration |
1147 |
1148 |
32. Remote Servers |
1149 |
Download |
1151 |
33. Download SiSU - Linux/Unix |
1152 |
SiSU Current Version - Linux/Unix |
1153 |
Source (tarball tar.gz) |
1154 |
Download the latest version of SiSU (and SiSU markup samples): 65 |
1155 |
|
1156 |
1157 |
order results on files of the same title, in multiple files (with different filenames) |
1158 |
1159 |
1160 |
texinfo/info (pinfo) module starts to do something vaguely useful again [not a much used module, testing required] |
1161 |
1162 |
1163 |
sisurc.yml default, color set to true [apologies if this causes anyone any inconvenience, it is configurable in sisurc.yml] |
1164 |
1165 |
sisu-install (install ruby rant script renamed) and permissions set to executable |
1166 |
|
1167 |
For installation notes see <http://www.jus.uio.no/sisu/SiSU/download.html> |
1168 |
For changelogs see <http://www.jus.uio.no/sisu/SiSU/changelog.html> |
1169 |
68 |
1170 |
Git (source control management) |
1171 |
1172 |
|
1173 |
|
1174 |
Debian |
1175 |
This section contains information on the latest SiSU release. For installation notes see <http://www.jus.uio.no/sisu/sisu_download/installation.html> |
1176 |
SiSU is updated fairly regularly in Debian testing and unstable, and should be available therefrom. |
1177 |
To add this archive, should you still choose to do so, add the following lines to your /etc/apt/sources.list |
1178 |
deb http://www.jus.uio.no/sisu/archive unstable main non-free |
1179 |
1180 |
|
1181 |
|
1182 |
|
1183 |
1184 |
|
1185 |
|
1186 |
|
1187 |
|
1188 |
|
1189 |
1190 |
1191 |
1192 |
1193 |
|
1195 |
|
1196 |
1197 |
<http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html> |
1198 |
<http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html> |
1199 |
RPM |
1200 |
The RPM is generated Alien 79 from two deb packages (sisu and sisu-doc). Dependencies are not handled, not even that of the essential Ruby. |
1201 |
|
1202 |
|
1203 |
|
1204 |
1205 |
Installation |
1206 |
34. Installation |
1207 |
See the download pages 83 for information related to installation. |
1208 |
34.1 Debian |
1209 |
SiSU is developed on Debian, and packages are available for Debian that take care of the dependencies encountered on installation. |
1210 |
1211 |
sisu-complete, a dummy package that installs the whole of greater sisu as described below, apart from sisu-examples |
1213 |
sisu-pdf, dependencies used by sisu to produce pdf from LaTeX generated |
1214 |
sisu-postgresql, dependencies used by sisu to populate postgresql database (further configuration is necessary) |
1215 |
sisu-remote, dependencies used to place sisu output on a remote server (further configuration is necessary) |
1216 |
sisu-sqlite, dependencies used by sisu to populate sqlite database |
1217 |
sisu-markup-samples, sisu markup samples and other miscellany (under Debian Free Software Guidelines non-free) |
1218 |
SiSU is available off Debian Unstable and Testing 84 install it using apt-get, aptitude or alternative Debian install tools. SiSU is currently comprised of eight packages. |
1219 |
Initial packaging is done here and to get the latest version of SiSU available you may add the following line(s) to your sources list: |
1220 |
#/etc/apt/sources.list |
1221 |
On Debian there is little more to know beyond how to install software on Debian using apt, aptitude or synaptic. |
1223 |
#Using aptitude: |
1224 |
Using apt-get |
1225 |
34.2 Other Unix / Linux |
1226 |
A source tarball or an rpms built using alien are available, (however dependencies have not been tested). SiSU is first packaged and tested with dependency handling for Debian. 85 Information on dependencies configured for Debian is provided as this may be of assistance. |
1227 |
34.2.1 source tarball |
1228 |
1229 |
To install SiSU, in the root directory of the unpacked SiSU as root type: 86 |
1230 |
1231 |
Once installed see man 8 sisu for information on additional programs that sisu makes use of. |
1232 |
1233 |
The install script is prepared using Rant, and a Rantfile is provided, 87 with more comprehensive install options, and post install and setup configuration and generation of first test file, if you have installed Stefan Lang's Rant 88 installed. While in the package directory, type: rant help, or rant -T, or to install SiSU as root, type: |
1234 |
install is an install script prepared using Stefan Lang's Rant 89 It should work whether you have previously installed Rant or not. It has fairly comprehensive install options, and can do some post install and setup configuration and generation of first test file. For options type: |
1235 |
1236 |
1237 |
1238 |
1239 |
1240 |
1241 |
setup.rb 90 is provided the package and will install SiSU 91 installation is a 3 step process 92 the following string assumes you are in the package directory and that you have root as sudo: |
1242 |
ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install |
1243 |
1244 |
The RPM is generated from the source file using Alien. 93 Dependencies are not handled, not even that of the essential Ruby. |
1245 |
35. SiSU Components, Dependencies and Notes |
1246 |
The dependency lists are from the Debian control file for SiSU version 0.36, and may assist in building SiSU on other distributions. |
1247 |
35.1 sisu |
1248 |
1250 |
Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, sisu-examples, librmagick-ruby, trang, tidy, libtidy, librexml-ruby, zip, unzip, openssl |
1251 |
1252 |
1253 |
1254 |
1255 |
1256 |
LaTeX (but sisu-pdf dependencies required to convert that to pdf) |
1257 |
1258 |
1259 |
1260 |
1261 |
1262 |
1263 |
1264 |
1265 |
1266 |
1267 |
1268 |
1269 |
1270 |
1271 |
1272 |
1273 |
1274 |
1275 |
1276 |
1277 |
1278 |
1279 |
1280 |
creation of source tarball with images, and placement of source tarball in ouput directory |
1281 |
1282 |
manifest of output produced (polls output directory and provides links to existing output) |
1283 |
1284 |
1285 |
1286 |
1287 |
1288 |
1289 |
1290 |
1291 |
1292 |
1293 |
1294 |
1295 |
1296 |
1297 |
1298 |
1299 |
35.2 sisu-complete |
1300 |
|
1301 |
Depends: ruby (>=1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-remote, sisu-sqlite |
1302 |
1303 |
35.3 sisu-examples |
1304 |
|
1305 |
1306 |
35.4 sisu-pdf |
1307 |
|
1308 |
1309 |
1310 |
1311 |
1312 |
1313 |
35.5 sisu-postgresql |
1314 |
|
1315 |
Depends: sisu, postgresql-8.1, libdbi-ruby, libdbm-ruby, libdbd-pg-ruby |
1316 |
1317 |
installs dependencies for sisu to work with and populate postgresql database |
1318 |
1319 |
1320 |
1321 |
1322 |
1323 |
1324 |
1325 |
1326 |
1327 |
1328 |
1329 |
The following are available without installation of the sisu-postgresql component, but are of interest in this context |
1330 |
generate a sample database query form for use with webserver on port 80 |
1331 |
1332 |
1333 |
1334 |
1335 |
1336 |
35.6 sisu-remote |
1337 |
|
1338 |
1339 |
1340 |
1341 |
1342 |
1343 |
1344 |
35.7 sisu-sqlite |
1345 |
|
1346 |
Depends: sisu, sqlite, libdbi-ruby, libdbm-ruby, libdbd-sqlite-ruby |
1347 |
1348 |
installs dependencies for sisu to work with and populate sqlite database |
1349 |
1350 |
1351 |
1352 |
1353 |
1354 |
1355 |
1356 |
1357 |
1358 |
1359 |
1360 |
The following are available without installation of the sisu-sqlite component, but are of interest in this context |
1361 |
generate a sample database query form for use with webserver on port 80 |
1362 |
1363 |
1364 |
1365 |
1366 |
1367 |
36. Quickstart - Getting Started Howto |
1368 |
36.1 Installation |
1369 |
Installation is currently most straightforward and tested on the Debian platform, as there are packages for the installation of sisu and all requirements for what it does. |
1370 |
36.1.1 Debian Installation |
1371 |
SiSU is available directly from the Debian Sid and testing archives (and possibly Ubuntu), assuming your /etc/apt/sources.list is set accordingly: |
1372 |
1373 |
The following /etc/apt/sources.list setting permits the download of additional markup samples: |
1374 |
#/etc/apt/sources.list |
1375 |
1376 |
aptitude update |
1377 |
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 |
1378 |
#/etc/apt/sources.list |
1379 |
1380 |
aptitude update |
1381 |
Note however that it is not necessary to install sisu-complete if not all components of sisu are to be used. Installing just the package sisu will provide basic functionality. |
1382 |
36.1.2 RPM Installation |
1383 |
RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. |
1384 |
1385 |
1386 |
1387 |
1388 |
36.1.3 Installation from source |
1389 |
1390 |
1391 |
|
1392 |
|
1393 |
For basic use SiSU is only dependent on the programming language in which it is written Ruby, and SiSU will be able to generate html, various XMLs, including ODF (and will also produce LaTeX). Dependencies required for further actions, though it relies on the installation of additional dependencies which the source tarball does not take care of, for things like using a database (postgresql or sqlite) 94 or converting LaTeX to pdf. |
1395 |
1396 |
This is a standard ruby installer, using setup.rb is a three step process. In the root directory of the unpacked SiSU as root type: |
1397 |
ruby setup.rb config |
1398 |
1399 |
1400 |
1401 |
1402 |
The "install" file provided is an installer prepared using "rant". In the root directory of the unpacked SiSU as root type: |
1403 |
1404 |
1405 |
1406 |
1407 |
1408 |
1410 |
1411 |
1412 |
1413 |
1414 |
1415 |
36.2 Testing SiSU, generating output |
1416 |
1417 |
1418 |
Depending on your mode of installation one or a number of markup sample files may be found either in the directory: |
1419 |
1420 |
1421 |
1422 |
1423 |
1424 |
36.2.1 basic text, plaintext, html, XML, ODF |
1425 |
Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it |
1426 |
sisu -NhwoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1427 |
this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text |
1428 |
36.2.2 LaTeX / pdf |
1429 |
Assuming a LaTeX engine such as tetex or texlive is installed with the required modules (done automatically on selection of sisu-pdf in Debian) |
1430 |
Having moved to the directory that contains the markup samples (see instructions above if necessary), choose a file and run sisu against it |
1431 |
sisu -pv free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1432 |
sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1433 |
should generate most available output formats: html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text and pdf |
1434 |
36.2.3 relational database - postgresql, sqlite |
1435 |
Relational databases need some setting up - you must have permission to create the database and write to it when you run sisu. |
1436 |
Assuming you have the database installed and the requisite permissions |
1437 |
1438 |
sisu --sqlite -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1439 |
1440 |
sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1441 |
36.3 Getting Help |
1442 |
36.3.1 The man pages |
1443 |
1444 |
1445 |
The man pages are also available online, though not always kept as up to date as within the package itself: |
1446 |
|
1447 |
|
1448 |
|
1449 |
36.3.2 Built in help |
1450 |
1451 |
1452 |
1453 |
1454 |
36.3.3 The home page |
1455 |
1456 |
1457 |
36.4 Markup Samples |
1458 |
A number of markup samples (along with output) are available off: |
1459 |
1460 |
Additional markup samples are packaged separately in the file: |
1461 |
1462 |
On Debian they are available in non-free 98 to include them it is necessary to include non-free in your /etc/apt/source.list or obtain them from the sisu home site. |
1463 |
HowTo |
1464 |
37. Getting Help |
1465 |
1466 |
1467 |
37.1 SiSU "man" pages |
1469 |
If SiSU is installed on your system usual man commands should be available, try: |
1470 |
1471 |
The SiSU man pages can be viewed online at: 99 |
1472 |
1473 |
|
1474 |
|
1475 |
|
1476 |
|
1477 |
|
1478 |
37.2 SiSU built-in help |
1479 |
1480 |
1481 |
sisu --help env [for feedback on the way your system is setup with regard to sisu] |
1482 |
1483 |
1484 |
1485 |
37.3 Command Line with Flags - Batch Processing |
1486 |
Running sisu (alone without any flags, filenames or wildcards) brings up the interactive help, as does any sisu command that is not recognised. |
1487 |
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. |
1488 |
38. Setup, initialisation |
1489 |
38.1 initialise output directory |
1490 |
Images, css files for a document directory are copied to their respective locations in the output directory. |
1491 |
while within your document markup/preparation directory, issue the following command |
1492 |
1493 |
38.1.1 Use of search functionality, an example using sqlite |
1494 |
SiSU can populate PostgreSQL and Sqlite databases and provides a sample search form for querying these databases. |
1495 |
This note provides an example to get you started and will use sqlite |
1496 |
1497 |
1498 |
(2) have a directory with sisu markup samples that is writable |
1499 |
1500 |
1501 |
1502 |
1503 |
1504 |
1505 |
1506 |
1507 |
if you use Debian, the following command will install the required dependencies |
1508 |
1509 |
(2) have a directory with sisu markup samples that is writable |
1510 |
ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) |
1511 |
cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup ~/. |
1512 |
1513 |
1514 |
1515 |
1516 |
1517 |
1518 |
1519 |
sisu -dv import free_*.sst debian_constitution_v1.2.sst debian_social_contract_v1.1.sst gpl2.fsf.sst |
1520 |
(5) use sisu to start the webrick (httpd) server (if it has not already been started): |
1521 |
1522 |
(6) use sisu to create a search form (for use with the webrick server, and your sample documents) |
1523 |
1524 |
1525 |
1527 |
1528 |
the string should be provided as output from the previous command |
1529 |
sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi /usr/lib/cgi-bin |
1530 |
1531 |
1532 |
1533 |
1534 |
1535 |
1536 |
1537 |
1538 |
1539 |
1540 |
|
1541 |
|
1542 |
1543 |
to start from scratch you can drop the database with the command |
1544 |
1545 |
1546 |
1547 |
1548 |
1549 |
38.2 misc |
1550 |
38.2.1 url for output files -u -U |
1551 |
1552 |
1553 |
38.2.2 toggle screen color |
1554 |
1555 |
38.2.3 verbose mode |
1556 |
1557 |
1558 |
38.2.4 quiet mode |
1559 |
1560 |
38.2.5 maintenance mode intermediate files kept -M |
1561 |
1562 |
38.2.6 start the webrick server |
1563 |
1564 |
38.3 remote placement of output |
1565 |
1566 |
1567 |
1568 |
1569 |
1570 |
39. Configuration Files |
1571 |
1572 |
1573 |
1574 |
1575 |
1576 |
1577 |
1578 |
1579 |
40. Markup |
1580 |
1581 |
1582 |
1583 |
1584 |
in particular for each of the document output samples provided, the source document is provided as well |
1585 |
1586 |
1587 |
1588 |
or the same once source is installed (or sisu-examples) under: |
1589 |
/usr/share/sisu-examples/sample/document_samples_sisu_markup/ |
1590 |
Some notes are contained within the man page, man sisu and within sisu help via the commands sisu help markup and sisu help headers |
1591 |
40.1 Headers |
1593 |
Headers @headername: provide information related to the document, this may relate to |
1594 |
2. semantic information about the document including the dublin core |
1596 |
40.2 Font Face |
1597 |
Defaults are set. You may change the face to: bold, italics, underscore, strikethrough, ... |
1598 |
40.2.1 Bold |
1599 |
\@bold: [list of words that should be made bold within document] |
1600 |
1601 |
1602 |
1603 |
1604 |
1605 |
1606 |
1607 |
40.2.2 Italics |
1608 |
\@italics: [list of words that should be italicised within document] |
1609 |
1610 |
1611 |
1612 |
1613 |
40.2.3 Underscore |
1614 |
1615 |
1616 |
1617 |
40.2.4 Strikethrough |
1618 |
1619 |
1620 |
1621 |
1622 |
40.3 Endnotes |
1623 |
There are two forms of markup for endnotes, they cannot be mixed within the same document |
1624 |
here 105 |
1625 |
1626 |
1627 |
2. alternative markup equivalent, kept because it is possible to search and replace to get markup in existing texts such as Project Gutenberg |
1628 |
1629 |
1630 |
40.4 Links |
1631 |
1632 |
1633 |
1634 |
1635 |
1636 |
1637 |
1638 |
1639 |
1640 |
{ SiSU }http://sisudoc.org ~{ <http://sisudoc.org> }~ |
1641 |
1642 |
108 |
1643 |
1644 |
40.5 Number Titles |
1645 |
1646 |
40.6 Line operations |
1647 |
1648 |
1649 |
1650 |
1651 |
1652 |
1653 |
1654 |
1655 |
|
1656 |
# number paragraph (see headers for numbering document headings) |
1657 |
1. number paragraph (see headers for numbering document headings) |
1658 |
_# number paragraph level 2 (see headers for numbering document headings) |
1659 |
a. number paragraph level 2 (see headers for numbering document headings) |
1660 |
40.7 Tables |
1661 |
1662 |
1663 |
This is a table, column1 |
1664 |
column one row 2 |
1665 |
1666 |
1667 |
1668 |
40.8 Grouped Text |
1670 |
1671 |
1672 |
1673 |
1674 |
1675 |
There was a young lady from Clyde, |
1676 |
1677 |
There was a young lady from Clyde, |
1678 |
1679 |
40.9 Composite Document |
1680 |
To import another document, the master document or importing document should be named filename.r3 (r for require) |
1681 |
1682 |
1683 |
41. Change Appearance |
1684 |
41.1 Skins |
1685 |
There are a few examples provided, on untarring the source tarball: |
1687 |
1688 |
data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc |
1689 |
1690 |
1691 |
/usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc |
1692 |
1693 |
1694 |
1695 |
1696 |
Skins under the searched paths in a per document directory, a per directory directory, or a site directory, named: |
1697 |
1698 |
dir [used if identifier part of name matches markup directory name] |
1699 |
1700 |
It is usual to place all skins in the document directory, with symbolic links as required from dir or site directories. |
1701 |
41.2 CSS |
1702 |
1704 |
1705 |
1706 |
1707 |
The contents of the first directory found in the search path are copied to the corresponding sisu output directory with the commnd: |
1708 |
1709 |
1710 |
dom.css html.css html_tables.css index.css sax.css xhtml.css |
1711 |
A document may specify its own/bespoke css file using the css header. |
1712 |
1713 |
1714 |
Extracts from the README |
1715 |
42. README |
1716 |
1717 |
Homepage: <http://www.jus.uio.no/sisu> |
1718 |
1719 |
Outputs share a common citation numbering system, and any semantic meta-data provided about the document. |
1722 |
SiSU also provides concordance files, document content certificates and manifests of generated output. |
1723 |
A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU. |
1725 |
1726 |
Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. |
1727 |
Homepage: <http://www.jus.uio.no/sisu> |
1729 |
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. |
1730 |
SiSU can be used for Internet, Intranet, local filesystem or cd publishing. |
1731 |
SiSU can be used directly off the filesystem, or from a database. |
1732 |
SiSU's scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql. |
1733 |
1734 |
|
1735 |
|
1738 |
1740 |
1741 |
42.1 Online Information, places to look |
1742 |
1743 |
1744 |
1745 |
1746 |
42.2 Installation |
1747 |
1748 |
42.2.1 Debian |
1749 |
If you use Debian use the Debian packages, check the information at: |
1750 |
1751 |
(A) SiSU is available directly off the Debian archives for Sid and testing. It should necessary only to run as root: |
1752 |
1753 |
1754 |
(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 |
1755 |
deb <http://www.jus.uio.no/sisu/archive> unstable main non-free |
1756 |
deb-src <http://www.jus.uio.no/sisu/archive> unstable main non-free |
1757 |
1759 |
1760 |
1761 |
42.2.2 RPM |
1762 |
RPMs are provided though untested, they are prepared by running alien against the source package, and against the debs. |
1763 |
1764 |
1765 |
42.2.3 Source package .tgz |
1766 |
Otherwise to install SiSU from source, check information at: |
1767 |
1768 |
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, |
1769 |
Ruby is the essential dependency for the basic operation of SiSU |
1770 |
1771 |
1772 |
1773 |
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. |
1774 |
42.2.4 to use setup.rb |
1775 |
this is a three step process, in the root directory of the unpacked SiSU as root type: |
1776 |
1777 |
1778 |
1779 |
1780 |
1781 |
1782 |
1783 |
42.2.5 to use install (prapared with "Rake") |
1784 |
1785 |
1786 |
1787 |
1788 |
1789 |
1790 |
1791 |
This makes use of Rake (by Jim Weirich) and the provided Rakefile |
1792 |
1793 |
1794 |
1795 |
42.2.6 to use install (prapared with "Rant") |
1796 |
(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:) |
1797 |
1798 |
1799 |
1800 |
1801 |
1803 |
1804 |
1805 |
1806 |
1807 |
1808 |
42.3 Dependencies |
1809 |
The following is from the debian/control file of sisu-0.58.2, which amongst other things provides the dependencies of sisu within Debian. |
1812 |
42.4 Quick start |
1820 |
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). |
1821 |
After installation of sisu-complete, move to the document samples directory |
1822 |
1823 |
1824 |
sisu -3 free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1825 |
1826 |
sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1827 |
look at output results, see the "sisu_manifest" page created for the document |
1828 |
or to generate an online document move to a writable directory, as the file will be downloaded there and e.g. |
1829 |
sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst> |
1830 |
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 |
1831 |
1832 |
gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1833 |
1834 |
1835 |
1836 |
1837 |
1838 |
1839 |
1840 |
1841 |
1842 |
1843 |
1844 |
42.5 Configuration files |
1845 |
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 |
1846 |
|
1847 |
1848 |
1849 |
|
1850 |
* skins - changing the appearance of a project, directory or individual documents within ~/.sisu/skin |
1851 |
~/.sisu/skin/doc contains individual skins, with symbolic links from |
1852 |
~/.sisu/skin/dir if the contents of a directory are to take a particular document skin. |
1853 |
|
1854 |
|
1855 |
There are post installation steps (which are really part of the overall installation) |
1856 |
42.6 Use General Overview |
1858 |
Documents are marked up in SiSU syntax and kept in an ordinary text editable file, named with the suffix .sst, or .ssm |
1859 |
Marked up SiSU documents are usually kept in a sub-directory of your choosing |
1860 |
1861 |
1862 |
1863 |
42.7 Help |
1864 |
1865 |
1866 |
1867 |
'man sisu_markup-samples' [if the sisu-markup-samples package is also installed] |
1868 |
Once installed an interactive help is available typing 'sisu' (without) any flags, and select an option: |
1869 |
1870 |
1871 |
1872 |
1873 |
1874 |
1875 |
1876 |
1877 |
1878 |
1879 |
1880 |
1881 |
42.8 Directory Structure |
1882 |
1883 |
1884 |
1885 |
1886 |
42.9 Configuration File |
1887 |
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) |
1888 |
42.10 Markup |
1889 |
1890 |
1891 |
1892 |
Once installed there is some information on SiSU Markup in its help: |
1893 |
1894 |
1895 |
1896 |
Sample marked up document are provided with the download tarball in the directory: |
1897 |
1898 |
1899 |
1900 |
More markup samples are available in the package sisu-markup-samples |
1901 |
<http://www.jus.uio.no/sisu/SiSU/download.html#sisu-markup-samples> |
1902 |
1903 |
1904 |
42.11 Additional Things |
1905 |
There is syntax support for some editors provided (together with a README file) in |
1906 |
1907 |
1908 |
1909 |
42.12 License |
1910 |
1911 |
1912 |
1913 |
1914 |
42.13 SiSU Standard |
1915 |
1916 |
|
1917 |
|
1918 |
|
1919 |
1920 |
|
1921 |
1922 |
1923 |
1924 |
1925 |
<http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html> |
1926 |
Extracts from man 8 sisu |
1927 |
43. Post Installation Setup |
1928 |
43.1 Post Installation Setup - Quick start |
1929 |
After installation of sisu-complete, move to the document samples directory, |
1930 |
1931 |
[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] |
1932 |
and in that directory, initialise the output directory with the command |
1933 |
1934 |
1935 |
sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1936 |
1937 |
sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1938 |
look at output results, see the "sisu_manifest" page created for the document |
1939 |
1940 |
1941 |
1942 |
1943 |
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. |
1944 |
1945 |
sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst> |
1946 |
examine source document, vim has syntax highlighting support |
1947 |
gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst |
1948 |
1949 |
1950 |
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. |
1951 |
sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip> |
1952 |
sisu -3 --trust <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip> |
1954 |
1955 |
1956 |
1957 |
1958 |
1959 |
43.2 Document markup directory |
1960 |
1962 |
1963 |
cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. |
1964 |
1965 |
1966 |
1967 |
1968 |
should printout the different possible outputs and where sisu would place them. |
1969 |
1970 |
1971 |
1972 |
43.2.1 Configuration files |
1973 |
1974 |
1975 |
1976 |
1977 |
1978 |
43.2.2 Debian INSTALLATION Note |
1979 |
1980 |
1981 |
1982 |
1984 |
SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. |
1985 |
SiSU also provides concordance files, document content certificates and manifests of generated output. |
1987 |
1989 |
Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. |
1990 |
Homepage: <http://www.jus.uio.no/sisu> |
1992 |
43.2.3 Document Resource Configuration |
1993 |
sisu resource configuration information is obtained from sources (where they exist): |
1994 |
1995 |
1996 |
1997 |
43.2.4 Skins |
1998 |
Skins default document appearance may be modified using skins contained in sub-directories located at the following paths: |
1999 |
2000 |
2001 |
2002 |
more specifically, the following locations (or their /etc/sisu equivalent) should be used: |
2003 |
2004 |
2005 |
2006 |
2007 |
2008 |
site-wide skin modifying the site-wide appearance of documents. |
2009 |
Usually all skin files are placed in the document skin directory: |
2010 |
2011 |
with softlinks being made to the skins contained there from other skin directories as required. |
2012 |
44. FAQ - Frequently Asked/Answered Questions |
2013 |
44.1 Why are urls produced with the -v (and -u) flag that point to a web server on port 8081? |
2014 |
2015 |
|
2016 |
This should start the ruby webserver. It should be done after having produced some output as it scans the output directory for what to serve. |
2017 |
44.2 I cannot find my output, where is it? |
2018 |
2019 |
|
2020 |
|
2021 |
|
2022 |
|
2023 |
|
2024 |
|
2025 |
44.3 I do not get any pdf output, why? |
2026 |
SiSU produces LaTeX and pdflatex is run against that to generate pdf files. |
2027 |
If you use Debian the following will install the required dependencies |
2028 |
|
2029 |
the following packages are required: tetex-bin, tetex-extra, latex-ucs |
2030 |
44.4 Where is the latex (or some other interim) output? |
2031 |
Try adding -M (for maintenance) to your command flags, e.g.: |
2032 |
|
2033 |
this should result in the interim processing output being retained, and information being provided on where to find it. |
2034 |
|
2035 |
|
2036 |
should also provide some relevant information as to where it is placed. |
2037 |
44.5 Why isn't SiSU markup XML |
2038 |
I worked with text and (though I find XML immensely valuable) disliked noise ... better to sidestep the question and say: |
2039 |
2041 |
2042 |
2043 |
2045 |
44.6 LaTeX claims to be a document preparation system for high-quality typesetting. Can the same be said about SiSU? |
2046 |
2047 |
LaTeX is the ultimate computer instruction type-setting language for paper based publication. |
2048 |
LaTeX is able to control just about everything that happens on page and pixel, position letters kerning, space variation between characters, words, paragraphs etc. formula. |
2049 |
Where there are large document sets, it provides consistency in appearance in each output format for the documents. |
2053 |
44.7 How do I create GIN or GiST index in Postgresql for use in SiSU |
2055 |
"I have tsearch2 slides which introduces tsearch2 <http://www.sai.msu.su/~megera/wiki/tsearch2slides> |
2057 |
FTS in PostgreSQL is provided by tsearch2, which should works without any indices (GiST or GIN) ! Indices provide performance, not functionality. |
2058 |
2059 |
0. compile, install tsearch2 and load tsearch2 into your database |
2060 |
cd contrib/tsearch2; make&&make&&install&&make installcheck; psql DB < tsearch2.sql |
2061 |
2062 |
2063 |
2064 |
2065 |
2066 |
2067 |
2068 |
2069 |
2070 |
2071 |
select lid, metadata_tid, rank_cd(fts, q,2)as rank from document, plainto_tsquery('markup syntax') q where q @@ fts order by rank desc limit 10; |
2072 |
44.8 Where is version 1.0? |
2073 |
SiSU works pretty well as it is supposed to. Version 1.0 will have the current markup, and directory structure. At this point it is largely a matter of choice as to when the name change is made. |
2074 |
The feature set for html, 110 LaTeX/pdf and opendocument is in place. XML, and plaintext are in order. |
2075 |
html and LaTeX/pdf may be regarded as reference copy outputs |
2076 |
With regard to the populating of sql databases (postgresql and sqlite), there is a bit to be done. |
2077 |
2078 |
45. Editor Files, Syntax Highlighting |
2079 |
2080 |
2081 |
2082 |
2083 |
|
2084 |
2085 |
2086 |
2087 |
|
2088 |
|
2089 |
2090 |
2091 |
2092 |
2093 |
2094 |
2095 |
comments: this editor features display line wrap and is used by Goby! |
2096 |
|
2097 |
2098 |
2099 |
2100 |
2101 |
comments: assumes dark background; no display line-wrap; does line breaks |
2102 |
|
2103 |
2104 |
2105 |
2106 |
2107 |
2108 |
2109 |
|
2110 |
2111 |
2112 |
2113 |
2114 |
2115 |
2116 |
2117 |
|
2118 |
2119 |
2120 |
2121 |
2122 |
|
2123 |
2124 |
2125 |
(add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") |
2126 |
2127 |
2128 |
|
2129 |
2130 |
package is the most comprehensive sisu syntax highlighting and editor environment provided to date (is for vim/ gvim, and is separate from the contents of this directory) |
2131 |
status: this includes: syntax highlighting; vim folds; some error checking |
2132 |
2133 |
2134 |
[SiSU parses files with long lines or line breaks, but, display linewrap (without line-breaks) is a convenient editor feature to have for sisu markup] |
2135 |
46. Help Sources |
2136 |
For a summary of alternative ways to get help on SiSU try one of the following: |
2137 |
2138 |
2139 |
2140 |
2141 |
2142 |
2143 |
<file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html> |
2144 |
2145 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html> |
2146 |
2147 |
2148 |
2149 |
<file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html> |
2150 |
<file:///usr/share/doc/sisu/html/sisu_help_sources/index.html> |
2151 |
<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> |
2152 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html> |
2153 |
46.1 man pages |
2154 |
46.1.1 man |
2155 |
2156 |
2157 |
2158 |
2159 |
2160 |
2161 |
2162 |
2163 |
2164 |
2165 |
2166 |
2167 |
2168 |
2169 |
2170 |
2171 |
2172 |
2173 |
2174 |
2175 |
2176 |
2177 |
46.2 sisu generated output - links to html |
2178 |
Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, and odf which may be also be accessed via the html pages 111 |
2179 |
46.2.1 locally installed |
2180 |
<file:///usr/share/doc/sisu/sisu_manual/sisu_manual/index.html> |
2181 |
<file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html> |
2182 |
<file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html> |
2183 |
2184 |
2185 |
2186 |
/usr/share/doc/sisu/sisu_manual/sisu_configuration/index.html |
2187 |
2188 |
2189 |
2190 |
2191 |
2192 |
/usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html |
2193 |
2194 |
/usr/share/doc/sisu/sisu_manual/sisu_introduction/index.html |
2195 |
2196 |
2197 |
/usr/share/doc/sisu/sisu_manual/sisu_output_overview/index.html |
2198 |
2199 |
2200 |
2201 |
2202 |
2203 |
2204 |
2205 |
/usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html |
2206 |
2207 |
2208 |
46.2.2 www.sisudoc.org |
2209 |
2210 |
2211 |
2212 |
2213 |
<http://sisudoc.org/sisu_manual/sisu_configuration/index.html> |
2214 |
<http://sisudoc.org/sisu_manual/sisu_description/index.html> |
2215 |
2216 |
2217 |
2218 |
2219 |
<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html> |
2220 |
2221 |
<http://sisudoc.org/sisu_manual/sisu_introduction/index.html> |
2222 |
2223 |
2224 |
<http://sisudoc.org/sisu_manual/sisu_output_overview/index.html> |
2225 |
2226 |
2227 |
2228 |
2229 |
2230 |
2231 |
2232 |
<http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html> |
2233 |
2234 |
2235 |
46.2.3 www.jus.uio.no/sisu |
2236 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html> |
2237 |
2238 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html> |
2239 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html> |
2240 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html> |
2241 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html> |
2242 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html> |
2243 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html> |
2244 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html> |
2245 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html> |
2246 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html> |
2247 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html> |
2248 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html> |
2249 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html> |
2250 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html> |
2251 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html> |
2252 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html> |
2253 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html> |
2254 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html> |
2255 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html> |
2256 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html> |
2257 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html> |
2258 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html> |
2259 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html> |
2260 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html> |
2261 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html> |
2262 |
46.2.4 man2html |
2263 |
46.2.5 locally installed |
2264 |
2265 |
2266 |
2267 |
2268 |
2269 |
2270 |
2271 |
2272 |
2273 |
2274 |
2275 |
2276 |
2277 |
2278 |
2279 |
2280 |
2281 |
2282 |
2283 |
2284 |
2285 |
2286 |
46.2.6 www.sisudoc.org |
2287 |
2288 |
2289 |
2290 |
2291 |
2292 |
2293 |
2294 |
2295 |
2296 |
2297 |
2298 |
2299 |
2300 |
2301 |
2302 |
2303 |
2304 |
2305 |
2306 |
2307 |
2308 |
2309 |
46.2.7 www.jus.uio.no/sisu |
2310 |
2311 |
2312 |
2313 |
2314 |
2315 |
2316 |
2317 |
2318 |
2319 |
2320 |
2321 |
2322 |
2323 |
2324 |
2325 |
2326 |
2327 |
2328 |
2329 |
<http://www.jus.uio.no/sisu/man/sisu_syntax_highlighting.8.html> |
2330 |
2331 |
2332 |
Endnotes |
0 |
1. "SiSU information Structuring Universe" or "Structured information, Serialized Units". |
2. Unix command line oriented |
3. objects include: headings, paragraphs, verse, tables, images, but not footnotes/endnotes which are numbered separately and tied to the object from which they are referenced. |
4. i.e. the html, pdf, odf outputs are each built individually and optimised for that form of presentation, rather than for example the html being a saved version of the odf, or the pdf being a saved version of the html. |
5. the different heading levels |
6. units of text, primarily paragraphs and headings, also any tables, poems, code-blocks |
7. Specification submitted by Adobe to ISO to become a full open ISO specification |
8. ISO/IEC 26300:2006 |
9. generated from source using rman |
*1. square brackets |
*2. square brackets |
+1. square brackets |
15. From sometime after SiSU 0.58 it should be possible to describe SiSU markup using SiSU, which though not an original design goal is useful. |
16. files should be prepared using UTF-8 character encoding |
17. a footnote or endnote |
18. self contained endnote marker & endnote in one |
* unnumbered asterisk footnote/endnote, insert multiple asterisks if required |
** another unnumbered asterisk footnote/endnote |
*3. editors notes, numbered asterisk footnote/endnote series |
+2. editors notes, numbered asterisk footnote/endnote series |
21. Table from the Wealth of Networks by Yochai Benkler |
22. .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. |
23. SiSU has worked this way in the past, though this was dropped as it was thought the complexity outweighed the flexibility, however, the balance was rather fine and this behaviour could be reinstated. |
24. Reproduced with the kind permission of author and artist Leena Krohn, <http://www.kaapeli.fi/krohn> "Aukio" is from the work "Sphinx or Robot" <http://www.jus.uio.no/sisu/sphinx_or_robot.leena_krohn.1996> which is included as a book example in this section, together with another of the author's works, "Tainaron" <http://www.jus.uio.no/sisu/tainaron.leena_krohn.1998> |
25. <http://www.jus.uio.no/sisu/sisu_manual/the_wealth_of_networks.yochai_benkler/sisu_manifest.html> |
26. <http://www.jus.uio.no/sisu/sisu_manual/free_culture.lawrence_lessig/sisu_manifest.html> |
27. <http://www.jus.uio.no/sisu/sisu_manual/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams/sisu_manifest.html> |
28. <http://www.jus.uio.no/sisu/sisu_manual/free_for_all.peter_wayner/sisu_manifest.html> |
29. <http://www.jus.uio.no/sisu/sisu_manual/the_cathedral_and_the_bazaar.eric_s_raymond/sisu_manifest.html> |
30. <http://www.jus.uio.no/sisu/sisu_manual/accelerando.charles_stross/sisu_manifest.html> |
31. <http://www.jus.uio.no/sisu/sisu_manual/tainaron.leena_krohn.1998/sisu_manifest.html> |
32. <http://www.jus.uio.no/sisu/sisu_manual/sphinx_or_robot.leena_krohn.1996/sisu_manifest.html> |
33. <http://www.jus.uio.no/sisu/war_and_peace.leo_tolstoy/toc.html> |
34. <http://www.jus.uio.no/sisu/sisu_manual/war_and_peace.leo_tolstoy/sisu_manifest.html> |
35. <http://www.jus.uio.no/sisu/sisu_manual/don_quixote.miguel_de_cervantes/sisu_manifest.html> |
36. <http://www.jus.uio.no/sisu/sisu_manual/gullivers_travels.jonathan_swift/sisu_manifest.html> |
37. <http://www.jus.uio.no/sisu/sisu_manual/alices_adventures_in_wonderland.lewis_carroll/sisu_manifest.html> |
38. <http://www.jus.uio.no/sisu/sisu_manual/through_the_looking_glass.lewis_carroll/sisu_manifest.html> |
39. <http://www.jus.uio.no/sisu/sisu_manual/alices_adventures_in_wonderland_and_through_the_looking_glass.lewis_carroll/sisu_manifest.html> |
40. <http://www.jus.uio.no/sisu/sisu_manual/gpl2.fsf/sisu_manifest.html> |
41. <http://www.jus.uio.no/sisu/sisu_manual/gpl3_draft3.fsf/sisu_manifest.html> |
42. <http://www.jus.uio.no/sisu/sisu_manual/debian_social_contract_v1.1/sisu_manifest.html> |
43. <http://www.jus.uio.no/sisu/sisu_manual/debian_constitution_v1.3/sisu_manifest.html> |
44. <http://www.jus.uio.no/sisu/sisu_manual/debian_constitution_v1.3.adjusted/sisu_manifest.html> |
45. <http://www.jus.uio.no/sisu/sisu_manual/debian_constitution_v1.2/sisu_manifest.html> |
46. <http://www.jus.uio.no/sisu/sisu_manual/debian_constitution_v1.2.adjusted/sisu_manifest.html> |
47. <http://www.jus.uio.no/sisu/sisu_manual/a_uniform_international_sales_terminology.vikki_rogers.and.albert_kritzer/sisu_manifest.html> |
48. <http://www.jus.uio.no/sisu/sisu_manual/the_autonomous_contract.amissah.19970710/sisu_manifest.html> |
49. <http://www.jus.uio.no/sisu/autonomy_markup0/toc.html> |
50. <http://www.jus.uio.no/sisu/sisu_manual/autonomy_markup0/sisu_manifest.html> |
51. <http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html> |
52. <http://www.jus.uio.no/sisu/sisu_manual/un_contracts_international_sale_of_goods_convention_1980/sisu_manifest.html> |
53. <http://www.jus.uio.no/sisu/sisu_manual/eu_contract_principles_parts_1_to_3_2002/sisu_manifest.html> |
54. of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. |
56. <http://www.jus.uio.no/lm/treaties.and.organisations/lm.chronological> |
57. <http://www.jus.uio.no/sisu/sample/syntax/un_conventions_membership_status.sst.html> |
58. <http://www.jus.uio.no/lm/un_conventions_membership_status/toc.html> |
59. updated for sisu-0.36.6 on 2006-01-23 |
60. <http://www.postgresql.org/> |
61. <http://www.hwaci.com/sw/sqlite/> |
63. (which could be extended further with current back-end). As regards scaling of the database, it is as scalable as the database (here Postgresql) and hardware allow. |
64. of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. |
65. Breakage and Fixes Report |
66. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.59.1.orig.tar.gz> |
67. <http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.7.orig.tar.gz> |
68. Reproduced with the kind permission of author and artist Leena Krohn, <http://www.kaapeli.fi/krohn> Tulva is from the work Sphinx or Robot <http://www.jus.uio.no/sisu/sphinx_or_robot.leena_krohn.1996> other works available online include Tainaron <http://www.jus.uio.no/sisu/tainaron.leena_krohn.1998>, these two works can be found in the book sample section <http://www.jus.uio.no/sisu/SiSU/2.html#sample> |
69. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.59.1.orig.tar.gz> |
70. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.59.1-1.diff.gz> |
71. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.59.1-1.dsc> |
72. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu_0.59.1-1_all.deb> |
73. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-complete_0.59.1-1_all.deb> |
74. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-pdf_0.59.1-1_all.deb> |
75. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-postgresql_0.59.1-1_all.deb> |
76. <http://www.jus.uio.no/sisu/archive/pool/main/s/sisu/sisu-sqlite_0.59.1-1_all.deb> |
77. <http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.8-1_all.deb> |
78. <http://www.jus.uio.no/sisu/archive/pool/non-free/s/sisu-markup-samples/sisu-markup-samples_1.0.8-1.dsc> |
80. <http://www.jus.uio.no/sisu/pkg/rpm/sisu-0.59.1-2.noarch.rpm> |
81. <http://www.jus.uio.no/sisu/pkg/rpm/sisu-doc-0.59.1-2.noarch.rpm> |
82. <http://www.jus.uio.no/sisu/pkg/rpm/sisu-markup-samples_1.0.6.orig-2.noarch.rpm> |
83. <http://www.jus.uio.no/sisu/SiSU/download> |
85. Notes on dependencies are provided in the section that follows |
86. This makes use of rant and the provided Rantfile. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. |
87. a Rantfile has been configured to do post installation setup |
88. <http://make.rubyforge.org/> <http://make.rubyforge.org/> |
89. <http://make.rubyforge.org/> <http://make.rubyforge.org/> |
91. Minero Aoki |
92. Installation instructions |
94. There is nothing to stop MySQL support being added in future. |
98. the Debian Free Software guidelines require that everything distributed within Debian can be changed - and the documents are authors' works that while freely distributable are not freely changeable. |
99. generated from source using rman |
105. this is an endnote |
110. html w3c compliance has been largely met. |
111. named index.html or more extensively through sisu_manifest.html |
Document Information (metadata) |
0 |
<http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/sisu_manifest.html> |
Dublin Core (DC) |
DC tags included with this document are provided here. |
DC Title: SiSU - Manual |
DC Creator: Ralph Amissah |
DC Rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 |
DC Type: information |
DC Date created: 2002-08-28 |
DC Date issued: 2002-08-28 |
DC Date available: 2002-08-28 |
DC Date modified: 2007-08-30 |
DC Date: 2007-08-30 |
Version Information |
Sourcefile: sisu_manual._sst |
Filetype: SiSU text insert 0.58 |
Sourcefile Digest, MD5(sisu_manual._sst)= 978fcebd89bd099b135fc44be7e8073e |
Skin_Digest: MD5(/home/ralph/grotto/theatre/dbld/builds/sisu/sisu/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb)= 20fc43cf3eb6590bc3399a1aef65c5a9 |
Generated |
Document (metaverse) last generated: Tue Sep 25 02:51:58 +0100 2007 |
Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) |
Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] |
|
|
Output generated by
SiSU
0.59.1 2007-09-25 (2007w39/2)
|
SiSU using:
| |
SiSU is released under GPLv3 or later, <http://www.gnu.org/licenses/gpl.html> |
SiSU, developed using
Ruby
on
Debian/Gnu/Linux
software infrastructure,
with the usual GPL (or OSS) suspects.
|