documentation, notes, update
[software/sisu] / README
1 SISU - README
2 =============
3
4 INTRODUCTION
5 ************
6
7 INTRODUCTION - WHAT IS SISU?
8 ----------------------------
9
10 *SiSU* is a lightweight markup based document creation and publishing framework
11 that is controlled from the command line. Prepare documents for *SiSU* using
12 your text editor of choice, then use *SiSU* to generate various output document
13 formats.
14
15 From a single lightly prepared document (plain-text /UTF-8/) sisu custom builds
16 several standard output formats which share a common (text object) numbering
17 system for citation of content within a document (that also has implications
18 for search). The sisu engine works with an abstraction of the document's
19 structure and content from which it is possible to generate different forms of
20 representation of the document. *SiSU* produces: plain-text, /HTML/, /XHTML/,
21 /XML/, /EPUB/, /ODF/: /ODT/ (Opendocument), /LaTeX/, /PDF/, and populates an
22 /SQL/ database (/PostgreSQL/ or /SQLite/) with text objects, roughly, paragraph
23 sized chunks so that document searches are done at this level of granularity.
24
25 Outputs share a common citation numbering system, associated with text objects
26 and any semantic meta-data provided about the document.
27
28 *SiSU* also provides concordance files, document content certificates and
29 manifests of generated output. Book indexes may be made.
30
31 Some document markup samples are provided in the package sisu -markup-samples.
32
33 Homepages:
34 * <http://www.sisudoc.org/>
35 * <http://www.jus.uio.no/sisu>
36
37 INSTALL OR RUN WITHOUT INSTALLATION
38 ***********************************
39
40 SOURCE TARBALL
41 --------------
42
43 RUN OFF SOURCE PACKAGE DIRECTORY TREE (WITHOUT INSTALLING)
44 ..........................................................
45
46 1. Download the latest source (information available) from:
47 <http://www.jus.uio.no/sisu/SiSU/download.html#current>
48
49 2. Unpack the source
50
51 Provided you have *Ruby*, *SiSU* can be run without installation straight from
52 the source package directory tree. Run ruby against the full path to bin/sisu
53 (in the unzipped source package directory tree)
54
55 Note however, that additional external package dependencies, such as texlive
56 (for pdfs), sqlite3 or postgresql (for search) should you desire to use them
57 are not taken care of for you.
58
59 GEM INSTALL (WITH RAKE)
60 .......................
61
62 Gem install, you need to:
63
64 (i) create the gemspec; (ii) build the gem (from the gemspec); (iii) install
65 the gem
66
67 Provided you have ruby & rake, this can be done with the single command:
68
69 rake gem_create_build_install # (to build and install sisu v5 & sisu v6,
70 alias gemcbi)
71
72 separate gems are made/installed for sisu v5 & sisu v6 contained in source:
73
74 rake gem_create_build_install_stable # (to build and install sisu v5, alias
75 gem5cbi)
76
77 rake gem_create_build_install_unstable # (to build and install sisu v6, alias
78 gem6cbi)
79
80 for individual steps (create, build, install) see rake options, rake -T to
81 specify sisu version for sisu installed via gem
82
83 gem search sisu
84
85 sisu _5.3.3_ --version
86
87 sisu _6.0.3_ --version
88
89 to uninstall sisu installed via gem
90
91 sudo gem uninstall --verbose sisu
92
93 For a list of alternative actions you may type:
94
95 rake help
96
97 rake -T
98
99 Rake: <http://rake.rubyforge.org/> <http://rubyforge.org/frs/?group_id=50>
100
101 Rant: <http://make.rubyforge.org/> <http://rubyforge.org/frs/?group_id=615>
102
103 INSTALLATION WITH SETUP.RB
104 ..........................
105
106 It should also be possible to install sisu using setup.rb
107
108 this is a three step process, in the root directory of the unpacked *SiSU* as
109 root type:
110
111 ruby setup.rb config
112 ruby setup.rb setup
113 #[as root:]
114 ruby setup.rb install
115
116
117 further information:
118 <http://i.loveruby.net/en/projects/setup/>
119 <http://i.loveruby.net/en/projects/setup/doc/usage.html>
120
121 ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install
122
123 UNIX/LINUX DISTRIBUTION
124 -----------------------
125
126 A distribution install should take care of the dependencies of sisu for
127 producing various outputs.
128
129 DEBIAN
130 ......
131
132 *SiSU* is available off the *Debian* archives. It should necessary only to run
133 as root, Using apt-get:
134
135 apt-get update
136
137 apt get install sisu-complete
138
139
140 (all sisu dependencies should be taken care of)
141
142 If there are newer versions of *SiSU* upstream, they will be available by
143 adding the following to your sources list /etc/apt/sources.list
144
145 #/etc/apt/sources.list
146
147 deb http://www.jus.uio.no/sisu/archive unstable main non-free
148 deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
149
150
151 The non-free section is for sisu markup samples provided, which contain
152 authored works the substantive text of which cannot be changed, and which as a
153 result do not meet the debian free software guidelines.
154
155 *SiSU* is developed on *Debian*, and packages are available for *Debian* that
156 take care of the dependencies encountered on installation.
157
158 The package is divided into the following components:
159
160 *sisu*, the base code, (the main package on which the others depend), without
161 any dependencies other than ruby (and for convenience the ruby webrick web
162 server), this generates a number of types of output on its own, other
163 packages provide additional functionality, and have their dependencies
164
165 *sisu-complete*, a dummy package that installs the whole of greater sisu as
166 described below, apart from sisu -examples
167
168 *sisu-pdf*, dependencies used by sisu to produce pdf from /LaTeX/ generated
169
170 *sisu-postgresql*, dependencies used by sisu to populate postgresql database
171 (further configuration is necessary)
172
173 *sisu-sqlite*, dependencies used by sisu to populate sqlite database
174
175 *sisu-markup-samples*, sisu markup samples and other miscellany (under
176 *Debian* Free Software Guidelines non-free)
177
178 *SiSU* is available off Debian Unstable and Testing [link:
179 <http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu>]
180 [^1] install it using apt-get, aptitude or alternative *Debian* install tools.
181
182 DEPENDENCIES
183 ------------
184
185 Here is a list of sisu' s current dependencies,[^2] which depend on such
186 factors as whether you want to generate pdf, whether you will be using *SiSU*
187 with or without a database, ...). sisu_markup-samples may also be of interest.
188
189 Package: sisu
190 Depends: ruby | ruby-interpreter, openssl, rsync, unzip, zip
191 Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, imagemagick |
192 graphicsmagick, keychain, openssh-client | lsh-client, po4a, qrencode, rake,
193 ruby-rmagick, tidy, tree, vim-addon-manager
194 Suggests: lv, calibre, pinfo, poedit, texinfo, trang
195
196
197 Package: sisu-complete
198 Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sisu-pdf (=
199 ${source:Version}), sisu-postgresql (= ${source:Version}), sisu-sqlite (=
200 ${source:Version})
201 Description-en: installs all SiSU related packages
202
203
204 Package: sisu-pdf
205 Depends: ruby | ruby-interpreter, sisu (= ${source:Version}),
206 texlive-latex-base, texlive-fonts-recommended, texlive-generic-recommended,
207 texlive-latex-recommended, texlive-latex-extra, texlive-math-extra,
208 texlive-xetex, fonts-liberation, lmodern, latex-cjk-all, texlive-lang-cjk
209 Suggests: evince | pdf-viewer
210
211
212 Package: sisu-postgresql
213 Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), postgresql,
214 ruby-dbd-pg, ruby-dbi, ruby-fcgi
215 Suggests: postgresql-contrib
216
217
218 Package: sisu-sqlite
219 Depends: ruby | ruby-interpreter, sisu (= ${source:Version}), sqlite3,
220 ruby-sqlite3, ruby-dbd-sqlite3, ruby-dbi, ruby-fcgi
221
222
223 Package: sisu-markup-samples
224 Depends: sisu
225
226
227 COMMANDS
228 ********
229
230 COMMANDS SUMMARY
231 ----------------
232
233 DESCRIPTION
234 ...........
235
236 *SiSU* is a document publishing system, that from a simple single marked-up
237 document, produces multiple output formats including: /plaintext/, /HTML/,
238 /XHTML/, /XML/, /EPUB/, /ODT/ (/OpenDocument/ (/ODF/) text), /LaTeX/, /PDF/,
239 info, and /SQL/ (/PostgreSQL/ and /SQLite/) , which share text object numbers
240 ("object citation numbering") and the same document structure information. For
241 more see: <http://sisudoc.org> or <http://www.jus.uio.no/sisu>
242
243 DOCUMENT PROCESSING COMMAND FLAGS
244 .................................
245
246 *-a [filename/wildcard]*
247 produces /plaintext/ with Unix linefeeds and without markup, (object numbers
248 are omitted), has footnotes at end of each paragraph that contains them [ -A
249 for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options
250 include: --endnotes for endnotes --footnotes for footnotes at the end of each
251 paragraph --unix for unix linefeed (default) --msdos for msdos linefeed)
252
253 *--ao [filename/wildcard/url]*
254 assumed for most other flags, creates new intermediate files for processing
255 (abstract objects, document abstraction) that is used in all subsequent
256 processing of other output. This step is assumed for most processing flags. To
257 skip it see -n. Alias -m.
258
259 *-b [filename/wildcard]*
260 see --xhtml
261
262 *--by-**
263 see --output-by-*
264
265 *-C*
266 configure/initialise shared output directory files initialize shared output
267 directory (config files such as css and dtd files are not updated if they
268 already exist unless modifier is used). -C --init-site configure/initialise
269 site more extensive than -C on its own, shared output directory files/force
270 update, existing shared output config files such as css and dtd files are
271 updated if this modifier is used.
272
273 *-CC*
274 see --configure
275
276 *-c [filename/wildcard]*
277 see --color-toggle
278
279 *--color*
280 see --color-on
281
282 *--color-off*
283 turn off color in output to terminal
284
285 *--color-on*
286 turn on color in output to terminal
287
288 *--color-toggle [filename/wildcard]*
289 screen toggle ansi screen colour on or off depending on default set (unless -c
290 flag is used: if sisurc colour default is set to 'true', output to screen will
291 be with colour, if sisurc colour default is set to 'false' or is undefined
292 screen output will be without colour). Alias -c
293
294 *--configure*
295 configure/initialise shared output directory files initialize shared output
296 directory (config files such as css and dtd files are not updated if they
297 already exist unless modifier is used). The equivalent of: -C --init-site
298 configure/initialise site, more extensive than -C on its own, shared output
299 directory files/force update, existing shared output config files such as css
300 and dtd files are updated if -CC is used.
301
302 *--concordance [filename/wildcard]*
303 produces concordance (wordmap) a rudimentary index of all the words in a
304 document. (Concordance files are not generated for documents of over 260,000
305 words unless this limit is increased in the file sisurc.yml). Alias -w
306
307 *-D [instruction] [filename]*
308 see --pg
309
310 *-d [--db-[database type (sqlite|pg)]] --[instruction] [filename]*
311 see --sqlite
312
313 *--dal [filename/wildcard/url]*
314 (abstract objects, document abstraction renamed abstract objects in sisu5) see
315 --ao
316
317 *--delete [filename/wildcard]*
318 see --zap
319
320 *--docbook [filename/wildcard/url]*
321 docbook smart text (not available)
322
323 *--dump[=directory_path] [filename/wildcard]*
324 places output in directory specified, if none is specified in the current
325 directory (pwd). Unlike using default settings /HTML/ files have embedded css.
326 Compare --redirect
327
328 *-e [filename/wildcard]*
329 see --epub
330
331 *--epub [filename/wildcard]*
332 produces an epub document, [sisu version >=2 ] (filename.epub). Alias -e
333
334 *--exc-**
335 exclude output feature, overrides configuration settings --exc-numbering, see
336 --exc-ocn; --exc-ocn, (exclude "object citation numbering", (switches off
337 object citation numbers), affects html (seg, scroll), epub, xhtml, xml, pdf) ;
338 --exc-toc, (exclude table of contents, affects html (scroll), epub, pdf) ;
339 --exc-links-to-manifest, --exc-manifest-links, (exclude links to manifest,
340 affects html (seg, scroll)); --exc-search-form, (exclude search form, affects
341 html (seg, scroll), manifest); --exc-minitoc, (exclude mini table of contents,
342 affects html (seg), concordance, manifest); --exc-manifest-minitoc, (exclude
343 mini table of contents, affects manifest); --exc-html-minitoc, (exclude mini
344 table of contents, affects html (seg), concordance); --exc-html-navigation,
345 (exclude navigation, affects html (seg)); --exc-html-navigation-bar, (exclude
346 navigation bar, affects html (seg)); --exc-html-search-form, (exclude search
347 form, affects html (seg, scroll)); --exc-html-right-pane, (exclude right
348 pane/column, affects html (seg, scroll)); --exc-html-top-band, (exclude top
349 band, affects html (seg, scroll), concordance (minitoc forced on to provide seg
350 navigation)); --exc-segsubtoc (exclude sub table of contents, affects html
351 (seg), epub) ; see also --inc-*
352
353 *-F [--webserv=webrick]*
354 see --sample-search-form
355
356 *-f [optional string part of filename]*
357 see --find
358
359 *--fictionbook [filename/wildcard/url]*
360 fictionbook smart text (not available)
361
362 *--find [optional string part of filename]*
363 without match string, glob all .sst .ssm files in directory (including language
364 subdirectories). With match string, find files that match given string in
365 directory (including language subdirectories). Alias -f, --glob, -G
366
367 *-G [optional string part of filename]*
368 see --find
369
370 *-g [filename/wildcard]*
371 see --git
372
373 *--git [filename/wildcard]*
374 produces or updates markup source file structure in a git repo (experimental
375 and subject to change). Alias -g
376
377 *--glob [optional string part of filename]*
378 see --find
379
380 *-h [filename/wildcard]*
381 see --html
382
383 *--harvest *.ss[tm]*
384 makes two lists of sisu output based on the sisu markup documents in a
385 directory: list of author and authors works (year and titles), and; list by
386 topic with titles and author. Makes use of header metadata fields (author,
387 title, date, topic_register). Can be used with maintenance (-M) and remote
388 placement (-R) flags.
389
390 *--help [topic]*
391 provides help on the selected topic, where topics (keywords) include: list,
392 (com)mands, short(cuts), (mod)ifiers, (env)ironment, markup, syntax, headers,
393 headings, endnotes, tables, example, customise, skin, (dir)ectories, path,
394 (lang)uage, db, install, setup, (conf)igure, convert, termsheet, search, sql,
395 features, license.
396
397 *--html [filename/wildcard]*
398 produces html output, in two forms (i) segmented text with table of contents
399 (toc.html and index.html) and (ii) the document in a single file (scroll.html).
400 Alias -h
401
402 *--html-scroll [filename/wildcard]*
403 produces html output, the document in a single file (scroll.html) only. Compare
404 --html-seg and --html
405
406 *--html-seg [filename/wildcard]*
407 produces html output, segmented text with table of contents (toc.html and
408 index.html). Compare --html-scroll and --html
409
410 *--html-strict [filename/wildcard]*
411 produces html with --strict option. see --strict
412
413 *-I [filename/wildcard]*
414 see --texinfo
415
416 *-i [filename/wildcard]*
417 see --manpage
418
419 *--i18n-**
420 these flags affect output by filetype and filename): --i18n-mono
421 (--monolingual) output filenames without language code for default language
422 ('en' or as set); --i18n-multi (--multilingual) language code provided as part
423 of the output filename, this is the default. Where output is in one language
424 only the language code may not be desired. see also --output-by-*
425
426 *--inc-**
427 include output feature, overrides configuration settings, (usually the default
428 if none set), has precedence over --exc-* (exclude output feature). Some detail
429 provided under --exc-*, see --exc-*
430
431 *-j [filename/wildcard]*
432 copies images associated with a file for use by html, xhtml & xml outputs
433 (automatically invoked by --dump & redirect).
434
435 *-k*
436 see --color-off
437
438 *--keep-processing-files [filename/wildcard/url]*
439 see --maintenance
440
441 *-M [filename/wildcard/url]*
442 see --maintenance
443
444 *-m [filename/wildcard/url]*
445 see --dal (document abstraction level/layer)
446
447 *--machine [filename/wildcard/url]*
448 see --dal (document abstraction level/layer)
449
450 *--maintenance [filename/wildcard/url]*
451 maintenance mode, interim processing files are preserved and their locations
452 indicated. (also see -V). Aliases -M and --keep-processing-files.
453
454 *--markdown [filename/wildcard/url]*
455 markdown smart text (not available)
456
457 *--manpage [filename/wildcard]*
458 produces man page of file, not suitable for all outputs. Alias -i
459
460 *--monolingual*
461 see --i18n-*
462
463 *--multilingual*
464 see --i18n-*
465
466 *-N [filename/wildcard/url]*
467 document digest or document content certificate ( DCC ) as md5 digest tree of
468 the document: the digest for the document, and digests for each object
469 contained within the document (together with information on software versions
470 that produced it) (digest.txt). -NV for verbose digest output to screen.
471
472 *-n [filename/wildcard/url]*
473 skip the creation of intermediate processing files (document abstraction) if
474 they already exist, this skips the equivalent of -m which is otherwise assumed
475 by most processing flags.
476
477 *--no-**
478 see --exc-*
479
480 *--numbering*
481 turn on "object citation numbers". See --inc-ocn and --exc-ocn
482
483 *-o [filename/wildcard/url]*
484 see --odt
485
486 *--ocn*
487 "object citation numbers". See --inc-ocn and --exc-ocn
488
489 *--odf [filename/wildcard/url]*
490 see --odt
491
492 *--odt [filename/wildcard/url]*
493 output basic document in opendocument file format (opendocument.odt). Alias -o
494
495 *--output-by-**
496 select output directory structure from 3 alternatives: --output-by-language,
497 (language directory (based on language code) with filetype (html, epub, pdf
498 etc.) subdirectories); --output-by-filetype, (filetype directories with
499 language code as part of filename); --output-by-filename, (filename directories
500 with language code as part of filename). This is configurable. Alias --by-*
501
502 *-P [language_directory/filename language_directory]*
503 see --po4a
504
505 *-p [filename/wildcard]*
506 see --pdf
507
508 *--papersize-(a4|a5|b5|letter|legal)*
509 in conjunction with --pdf set pdf papersize, overriding any configuration
510 settings, to set more than one papersize repeat the option --pdf --papersize-a4
511 --papersize-letter. See also --papersize=*
512
513 *--papersize=a4,a5,b5,letter,legal* in conjunction with --pdf set pdf
514 papersize, overriding any configuration settings, to set more than one
515 papersize list after the equal sign with a comma separator
516 --papersize=a4,letter. See also --papersize-*
517
518 *--pdf [filename/wildcard]*
519 produces /LaTeX/ pdf (portrait.pdf & landscape.pdf). Orientation and papersize
520 may be set on the command-line. Default paper size is set in config file, or
521 document header, or provided with additional command line parameter, e.g.
522 --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book
523 sizes 'A5' and 'B5' (system defaults to A4), and; --landscape or --portrait,
524 so: e.g. "sisu --pdf-a4 --pdf-letter --landscape --verbose [filename/wildcard]"
525 or "sisu --pdf --landscape --a4 --letter --verbose [filename/wildcard]". --pdf
526 defaults to both landscape & portrait output, and a4 if no other papersizes are
527 configured. Related options --pdf-landscape --pdf-portrait --pdf-papersize-*
528 --pdf-papersize=[list]. Alias -p
529
530 *--pdf-l [filename/wildcard]*
531 See --pdf-landscape
532
533 *--pdf-landscape [filename/wildcard]*
534 sets orientation, produces /LaTeX/ pdf landscape.pdf. Default paper size is set
535 in config file, or document header, or provided with additional command line
536 parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter' and
537 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related options
538 --pdf --pdf-portrait. See also --papersize-* or --papersize=[list]. Alias
539 --pdf-l or in conjunction with --pdf --landscape
540
541 *--pdf-p [filename/wildcard]*
542 See --pdf-portrait
543
544 *--pdf-portrait [filename/wildcard]*
545 sets orientation, produces /LaTeX/ pdf portrait.pdf.pdf. Default paper size is
546 set in config file, or document header, or provided with additional command
547 line parameter, e.g. --papersize-a4 preset sizes include: 'A4', U.S. 'letter'
548 and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). Related
549 options --pdf --pdf-landscape. See also --papersize-* or --papersize=[list].
550 Alias --pdf-p or in conjunction with --pdf --portrait
551
552 *--pg [instruction] [filename]*
553 database /PostgreSQL/ ( --pgsql may be used instead) possible instructions,
554 include: --createdb; --create; --dropall; --import [filename]; --update
555 [filename]; --remove [filename]; see database section below. Alias -D
556
557 *--po [language_directory/filename language_directory]*
558 see --po4a
559
560 *--po4a [language_directory/filename language_directory]*
561 produces .pot and po files for the file in the languages specified by the
562 language directory. *SiSU* markup is placed in subdirectories named with the
563 language code, e.g. en/ fr/ es/. The sisu config file must set the output
564 directory structure to multilingual. v3, experimental
565
566 *-Q [filename/wildcard]*
567 see --qrcode
568
569 *-q [filename/wildcard]*
570 see --quiet
571
572 *--qrcode [filename/wildcard]*
573 generate QR code image of metadata (used in manifest). v3 only.
574
575 *--quiet [filename/wildcard]*
576 quiet less output to screen.
577
578 *-R [filename/wildcard]*
579 see --rsync
580
581 *-r [filename/wildcard]*
582 see --scp
583
584 *--redirect[=directory_path] [filename/wildcard]*
585 places output in subdirectory under specified directory, subdirectory uses the
586 filename (without the suffix). If no output directory is specified places the
587 subdirectory under the current directory (pwd). Unlike using default settings
588 /HTML/ files have embedded css. Compare --dump
589
590 *--rst [filename/wildcard/url]*
591 ReST (rST restructured text) smart text (not available)
592
593 *--rsync [filename/wildcard]*
594 copies sisu output files to remote host using rsync. This requires that
595 sisurc.yml has been provided with information on hostname and username, and
596 that you have your "keys" and ssh agent in place. Note the behavior of rsync
597 different if -R is used with other flags from if used alone. Alone the rsync
598 --delete parameter is sent, useful for cleaning the remote directory (when -R
599 is used together with other flags, it is not). Also see --scp. Alias -R
600
601 *-S*
602 see --sisupod
603
604 *-S [filename/wildcard]*
605 see --sisupod
606
607 *-s [filename/wildcard]*
608 see --source
609
610 *--sample-search-form [--db=(pgsql|sqlite)] [--webserv=webrick]*
611 generate examples of (naive) cgi search form for /SQLite/ or PgSQL depends on
612 your already having used sisu to populate an /SQLite/ or PgSQL database, (the
613 /SQLite/ version scans the output directories for existing sisu_sqlite
614 databases, so it is first necessary to create them, before generating the
615 search form) see --sqlite & --pg and the database section below. Optional
616 additional parameters include: url location of webserver search form and db:
617 --webserv-search='[url]'; location of webserver output:
618 --webserv-output='[url]'; cgi search form link name:
619 --cgi-search-form-name='[name.cgi]'; for pgsql, database user:
620 --db-user='[username]'. If the optional parameter --webserv=webrick is passed,
621 the cgi examples created will be set up to use the default port set for use by
622 the webrick server, (otherwise the port is left blank and the system setting
623 used, usually 80). The samples are dumped in the present work directory which
624 must be writable, (with screen instructions given that they be copied to the
625 cgi-bin directory). Alias -F
626
627 *--scp [filename/wildcard]*
628 copies sisu output files to remote host using scp. This requires that
629 sisurc.yml has been provided with information on hostname and username, and
630 that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r
631
632 *--sha256*
633 set hash digest where used to sha256
634
635 *--sha512*
636 set hash digest where used to sha512
637
638 *--sqlite --[instruction] [filename]*
639 database type set to /SQLite/, this produces one of two possible databases,
640 without additional database related instructions it produces a discreet
641 /SQLite/ file for the document processed; with additional instructions it
642 produces a common /SQLite/ database of all processed documents that (come from
643 the same document preparation directory and as a result) share the same output
644 directory base path (possible instructions include: --createdb; --create;
645 --dropall; --import [filename]; --update [filename]; --remove [filename]); see
646 database section below. Alias -d
647
648 *--sisupod*
649 produces a sisupod a zipped sisu directory of markup files including sisu
650 markup source files and the directories local configuration file, images and
651 skins. Note: this only includes the configuration files or skins contained in
652 ./_sisu not those in ~/.sisu -S [filename/wildcard] option. Note: (this option
653 is tested only with zsh). Alias -S
654
655 *--sisupod [filename/wildcard]*
656 produces a zipped file of the prepared document specified along with associated
657 images, by default named sisupod.zip they may alternatively be named with the
658 filename extension .ssp This provides a quick way of gathering the relevant
659 parts of a sisu document which can then for example be emailed. A sisupod
660 includes sisu markup source file, (along with associated documents if a master
661 file, or available in multilingual versions), together with related images and
662 skin. *SiSU* commands can be run directly against a sisupod contained in a
663 local directory, or provided as a url on a remote site. As there is a security
664 issue with skins provided by other users, they are not applied unless the flag
665 --trust or --trusted is added to the command instruction, it is recommended
666 that file that are not your own are treated as untrusted. The directory
667 structure of the unzipped file is understood by sisu, and sisu commands can be
668 run within it. Note: if you wish to send multiple files, it quickly becomes
669 more space efficient to zip the sisu markup directory, rather than the
670 individual files for sending). See the -S option without [filename/wildcard].
671 Alias -S
672
673 *--source [filename/wildcard]*
674 copies sisu markup file to output directory. Alias -s
675
676 *--strict*
677 together with --html, produces more w3c compliant html, for example not having
678 purely numeric identifiers for text, the location object url#33 becomes url#o33
679
680 *-T [filename/wildcard (*.termsheet.rb)]*
681 standard form document builder, preprocessing feature
682
683 *-t [filename/wildcard]*
684 see --txt
685
686 *--texinfo [filename/wildcard]*
687 produces texinfo and info file, (view with pinfo). Alias -I
688
689 *--textile [filename/wildcard/url]*
690 textile smart text (not available)
691
692 *--txt [filename/wildcard]*
693 produces /plaintext/ with Unix linefeeds and without markup, (object numbers
694 are omitted), has footnotes at end of each paragraph that contains them [ -A
695 for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options
696 include: --endnotes for endnotes --footnotes for footnotes at the end of each
697 paragraph --unix for unix linefeed (default) --msdos for msdos linefeed). Alias
698 -t
699
700 *--txt-asciitext [filename/wildcard]*
701 see --asciitext
702
703 *--txt-markdown [filename/wildcard]*
704 see --markdown
705
706 *--txt-rst [filename/wildcard]*
707 see --rst
708
709 *--txt-textile [filename/wildcard]*
710 see --textile
711
712 *-U [filename/wildcard]*
713 see --urls
714
715 *-u [filename/wildcard]*
716 provides url mapping of output files for the flags requested for processing,
717 also see -U
718
719 *--urls [filename/wildcard]*
720 prints url output list/map for the available processing flags options and
721 resulting files that could be requested, (can be used to get a list of
722 processing options in relation to a file, together with information on the
723 output that would be produced), -u provides url output mapping for those flags
724 requested for processing. The default assumes sisu_webrick is running and
725 provides webrick url mappings where appropriate, but these can be switched to
726 file system paths in sisurc.yml. Alias -U
727
728 *-V*
729 on its own, provides *SiSU* version and environment information (sisu --help
730 env)
731
732 *-V [filename/wildcard]*
733 even more verbose than the -v flag.
734
735 *-v*
736 on its own, provides *SiSU* version information
737
738 *-v [filename/wildcard]*
739 see --verbose
740
741 *--v5 [filename/wildcard]*
742 invokes the sisu v5 document parser/generator. You may run sisu5 instead. This
743 is the current default and is normally omitted.
744
745 *--v6 [filename/wildcard]*
746 invokes the sisu v6 document parser/generator. You may run sisu6 instead.
747
748 *--verbose [filename/wildcard]*
749 provides verbose output of what is being generated, where output is placed (and
750 error messages if any), as with -u flag provides a url mapping of files created
751 for each of the processing flag requests. Alias -v
752
753 *-W*
754 see --webrick
755
756 *-w [filename/wildcard]*
757 see --concordance
758
759 *--webrick*
760 starts ruby' s webrick webserver points at sisu output directories, the default
761 port is set to 8081 and can be changed in the resource configuration files.
762 [tip: the webrick server requires link suffixes, so html output should be
763 created using the -h option rather than -H ; also, note -F webrick ]. Alias -W
764
765 *--wordmap [filename/wildcard]*
766 see --concordance
767
768 *--xhtml [filename/wildcard]*
769 produces xhtml//XML/ output for browser viewing (sax parsing). Alias -b
770
771 *--xml-dom [filename/wildcard]*
772 produces /XML/ output with deep document structure, in the nature of dom. Alias
773 -X
774
775 *--xml-sax [filename/wildcard]*
776 produces /XML/ output shallow structure (sax parsing). Alias -x
777
778 *-X [filename/wildcard]*
779 see --xml-dom
780
781 *-x [filename/wildcard]*
782 see --xml-sax
783
784 *-Y [filename/wildcard]*
785 produces a short sitemap entry for the document, based on html output and the
786 sisu_manifest. --sitemaps generates/updates the sitemap index of existing
787 sitemaps. (Experimental, [g,y,m announcement this week])
788
789 *-y [filename/wildcard]*
790 produces an html summary of output generated (hyperlinked to content) and
791 document specific metadata (sisu_manifest.html). This step is assumed for most
792 processing flags.
793
794 *-Z [filename/wildcard]*
795 see --zap
796
797 *--zap [filename/wildcard]*
798 Zap, if used with other processing flags deletes output files of the type about
799 to be processed, prior to processing. If -Z is used as the lone processing
800 related flag (or in conjunction with a combination of -[mMvVq]), will remove
801 the related document output directory. Alias -Z
802
803 COMMAND LINE MODIFIERS
804 ----------------------
805
806 *--no-ocn*
807 [with --html --pdf or --epub] switches off /object citation numbering/. Produce
808 output without identifying numbers in margins of html or /LaTeX//pdf output.
809
810 *--no-annotate*
811 strips output text of editor endnotes[^*1] denoted by asterisk or dagger/plus
812 sign
813
814 *--no-asterisk*
815 strips output text of editor endnotes[^*2] denoted by asterisk sign
816
817 *--no-dagger*
818 strips output text of editor endnotes[^+1] denoted by dagger/plus sign
819
820 DATABASE COMMANDS
821 -----------------
822
823 *dbi - database interface*
824
825 *-D or --pgsql* set for /PostgreSQL/ *-d or --sqlite* default set for /SQLite/
826 -d is modifiable with --db=[database type (PgSQL or /SQLite/) ]
827
828 *--pg -v --createall*
829 initial step, creates required relations (tables, indexes) in existing
830 /PostgreSQL/ database (a database should be created manually and given the same
831 name as working directory, as requested) (rb.dbi) [ -dv --createall /SQLite/
832 equivalent] it may be necessary to run sisu -Dv --createdb initially NOTE: at
833 the present time for /PostgreSQL/ it may be necessary to manually create the
834 database. The command would be 'createdb [database name]' where database name
835 would be SiSU_[present working directory name (without path)]. Please use only
836 alphanumerics and underscores.
837
838 *--pg -v --import*
839 [filename/wildcard] imports data specified to /PostgreSQL/ db (rb.dbi) [ -dv
840 --import /SQLite/ equivalent]
841
842 *--pg -v --update*
843 [filename/wildcard] updates/imports specified data to /PostgreSQL/ db (rb.dbi)
844 [ -dv --update /SQLite/ equivalent]
845
846 *--pg --remove*
847 [filename/wildcard] removes specified data to /PostgreSQL/ db (rb.dbi) [ -d
848 --remove /SQLite/ equivalent]
849
850 *--pg --dropall*
851 kills data" and drops (/PostgreSQL/ or /SQLite/) db, tables & indexes [ -d
852 --dropall /SQLite/ equivalent]
853
854 The -v is for verbose output.
855
856 SHORTCUTS, SHORTHAND FOR MULTIPLE FLAGS
857 ---------------------------------------
858
859 *--update [filename/wildcard]*
860 Checks existing file output and runs the flags required to update this output.
861 This means that if only html and pdf output was requested on previous runs,
862 only the -hp files will be applied, and only these will be generated this time,
863 together with the summary. This can be very convenient, if you offer different
864 outputs of different files, and just want to do the same again.
865
866 *-0 to -5 [filename or wildcard]*
867 Default shorthand mappings (for v3, note that the defaults can be
868 changed/configured in the sisurc.yml file):
869
870 *-0*
871 -NQhewpotbxXyYv [this is the default action run when no options are give, i.e.
872 on 'sisu [filename]']
873
874 *-1*
875 -Qhewpoty
876
877 *-2*
878 -NQhewpotbxXy
879
880 *-3*
881 -NQhewpotbxXyY
882
883 *-4*
884 -NQhewpotbxXDyY --update
885
886 *-5*
887 -NQhewpotbxXDyYv --update
888
889 add -v for verbose mode and -c to toggle color state, e.g. sisu -2vc [filename
890 or wildcard]
891
892 consider -u for appended url info or -v for verbose output
893
894 COMMAND LINE WITH FLAGS - BATCH PROCESSING
895 ..........................................
896
897 In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst"
898 or "sisu -h *.{sst,ssm}" to produce html version of all documents.
899
900 Running sisu (alone without any flags, filenames or wildcards) brings up the
901 interactive help, as does any sisu command that is not recognised. Enter to
902 escape.
903
904 INTRODUCTION TO SISU MARKUP[^3]
905 -------------------------------
906
907 SUMMARY
908 .......
909
910 *SiSU* source documents are /plaintext/ (/UTF-8/)[^4] files
911
912 All paragraphs are separated by an empty line.
913
914 Markup is comprised of:
915
916 * at the top of a document, the document header made up of semantic meta-data
917 about the document and if desired additional processing instructions (such an
918 instruction to automatically number headings from a particular level down)
919
920 * followed by the prepared substantive text of which the most important single
921 characteristic is the markup of different heading levels, which define the
922 primary outline of the document structure. Markup of substantive text includes:
923
924 * heading levels defines document structure
925
926 * text basic attributes, italics, bold etc.
927
928 * grouped text (objects), which are to be treated differently, such as code
929 blocks or poems.
930
931 * footnotes/endnotes
932
933 * linked text and images
934
935 * paragraph actions, such as indent, bulleted, numbered-lists, etc.
936
937 Some interactive help on markup is available, by typing sisu and selecting
938 markup or sisu --help markup
939
940 To check the markup in a file:
941
942 sisu --identify [filename].sst
943
944 For brief descriptive summary of markup history
945
946 sisu --query-history
947
948 or if for a particular version:
949
950 sisu --query-0.38
951
952 MARKUP RULES, DOCUMENT STRUCTURE AND METADATA REQUIREMENTS
953 ..........................................................
954
955 minimal content/structure requirement:
956
957 [metadata]
958
959 A~ (level A [title])
960 1~ (at least one level 1 [segment/(chapter)])
961
962
963 structure rules (document heirarchy, heading levels):
964
965 there are two sets of heading levels ABCD (title & parts if any) and 123
966 (segment & subsegments if any)
967
968 sisu has the fllowing levels:
969
970 A~ [title] .
971 required (== 1) followed by B~ or 1~
972 B~ [part] *
973 followed by C~ or 1~
974 C~ [subpart] *
975 followed by D~ or 1~
976 D~ [subsubpart] *
977 followed by 1~
978 1~ [segment (chapter)] +
979 required (>= 1) followed by text or 2~
980 text *
981 followed by more text or 1~, 2~
982 or relevant part *()
983 2~ [subsegment] *
984 followed by text or 3~
985 text *
986 followed by more text or 1~, 2~ or 3~
987 or relevant part, see *()
988 3~ [subsubsegment] *
989 followed by text
990 text *
991 followed by more text or 1~, 2~ or 3~ or relevant part, see *()
992
993 *(B~ if none other used;
994 if C~ is last used: C~ or B~;
995 if D~ is used: D~, C~ or B~)
996
997
998 * level A~ is the tile and is mandatory
999 * there can only be one level A~
1000 * heading levels BCD, are optional and there may be several of each
1001 (where all three are used corresponding to e.g. Book Part Section)
1002 * sublevels that are used must follow each other sequentially
1003 (alphabetically),
1004 * heading levels A~ B~ C~ D~ are followed by other heading levels rather
1005 than substantive text
1006 which may be the subsequent sequential (alphabetic) heading part level
1007 or a heading (segment) level 1~
1008 * there must be at least one heading (segment) level 1~
1009 (the level on which the text is segmented, in a book would correspond
1010 to the Chapter level)
1011 * additional heading levels 1~ 2~ 3~ are optional and there may be several
1012 of each
1013 * heading levels 1~ 2~ 3~ are followed by text (which may be followed by
1014 the same heading level)
1015 and/or the next lower numeric heading level (followed by text)
1016 or indeed return to the relevant part level
1017 (as a corollary to the rules above substantive text/ content
1018 must be preceded by a level 1~ (2~ or 3~) heading)
1019
1020
1021 MARKUP EXAMPLES
1022 ...............
1023
1024
1025 ----------------------------------------
1026
1027 ONLINE
1028 ......
1029
1030 Online markup examples are available together with the respective outputs
1031 produced from <http://www.jus.uio.no/sisu/SiSU/examples.html> or from
1032 <http://www.jus.uio.no/sisu/sisu_examples/>
1033
1034 There is of course this document, which provides a cursory overview of sisu
1035 markup and the respective output produced:
1036 <http://www.jus.uio.no/sisu/sisu_markup/>
1037
1038 an alternative presentation of markup syntax:
1039 /usr/share/doc/sisu/on_markup.txt.gz
1040
1041
1042 ----------------------------------------
1043
1044 INSTALLED
1045 .........
1046
1047 With *SiSU* installed sample skins may be found in:
1048 /usr/share/doc/sisu/markup-samples (or equivalent directory) and if sisu
1049 -markup-samples is installed also under:
1050 /usr/share/doc/sisu/markup-samples-non-free
1051
1052 MARKUP OF HEADERS
1053 -----------------
1054
1055 Headers contain either: semantic meta-data about a document, which can be used
1056 by any output module of the program, or; processing instructions.
1057
1058 Note: the first line of a document may include information on the markup
1059 version used in the form of a comment. Comments are a percentage mark at the
1060 start of a paragraph (and as the first character in a line of text) followed by
1061 a space and the comment:
1062
1063 % this would be a comment
1064
1065
1066 SAMPLE HEADER
1067 .............
1068
1069 This current document is loaded by a master document that has a header similar
1070 to this one:
1071
1072 % SiSU master 4.0
1073
1074 @title: SiSU
1075 :subtitle: Manual
1076
1077 @creator:
1078 :author: Amissah, Ralph
1079
1080 @publisher: [publisher name]
1081
1082 @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
1083
1084 @classify:
1085 :topic_register: SiSU:manual;electronic documents:SiSU:manual
1086 :subject: ebook, epublishing, electronic book, electronic publishing,
1087 electronic document, electronic citation, data structure,
1088 citation systems, search
1089
1090 % used_by: manual
1091
1092 @date:
1093 :published: 2008-05-22
1094 :created: 2002-08-28
1095 :issued: 2002-08-28
1096 :available: 2002-08-28
1097 :modified: 2010-03-03
1098
1099 @make:
1100 :num_top: 1
1101 :breaks: new=C; break=1
1102 :bold: /Gnu|Debian|Ruby|SiSU/
1103 :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
1104 :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
1105 :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search;
1106 synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ]
1107 . sisu [-Ddcv] [instruction]
1108 . sisu [-CcFLSVvW]
1109 . sisu --v4 [operations]
1110 . sisu --v3 [operations]
1111
1112 @links:
1113 { SiSU Homepage }http://www.sisudoc.org/
1114 { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/
1115 { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
1116 { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
1117 { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
1118 { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary
1119 { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/
1120 { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
1121 { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org
1122 { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
1123
1124
1125 AVAILABLE HEADERS
1126 .................
1127
1128 Header tags appear at the beginning of a document and provide meta information
1129 on the document (such as the /Dublin Core/) , or information as to how the
1130 document as a whole is to be processed. All header instructions take the form
1131 @headername: or on the next line and indented by once space :subheadername: All
1132 /Dublin Core/ meta tags are available
1133
1134 *@identifier:* information or instructions
1135
1136 where the "identifier" is a tag recognised by the program, and the
1137 "information" or "instructions" belong to the tag/identifier specified
1138
1139 Note: a header where used should only be used once; all headers apart from
1140 @title: are optional; the @structure: header is used to describe document
1141 structure, and can be useful to know.
1142
1143 This is a sample header
1144
1145 % SiSU 2.0 [declared file-type identifier with markup version]
1146
1147
1148 @title: [title text] [this header is the only one that is mandatory]
1149 :subtitle: [subtitle if any]
1150 :language: English
1151
1152
1153 @creator:
1154 :author: [Lastname, First names]
1155 :illustrator: [Lastname, First names]
1156 :translator: [Lastname, First names]
1157 :prepared_by: [Lastname, First names]
1158
1159
1160 @date:
1161 :published: [year or yyyy-mm-dd]
1162 :created: [year or yyyy-mm-dd]
1163 :issued: [year or yyyy-mm-dd]
1164 :available: [year or yyyy-mm-dd]
1165 :modified: [year or yyyy-mm-dd]
1166 :valid: [year or yyyy-mm-dd]
1167 :added_to_site: [year or yyyy-mm-dd]
1168 :translated: [year or yyyy-mm-dd]
1169
1170
1171 @rights:
1172 :copyright: Copyright (C) [Year and Holder]
1173 :license: [Use License granted]
1174 :text: [Year and Holder]
1175 :translation: [Name, Year]
1176 :illustrations: [Name, Year]
1177
1178
1179 @classify:
1180 :topic_register: SiSU:markup sample:book;book:novel:fantasy
1181 :type:
1182 :subject:
1183 :description:
1184 :keywords:
1185 :abstract:
1186 :loc: [Library of Congress classification]
1187 :dewey: [Dewey classification
1188
1189
1190 @identify:
1191 :isbn: [ISBN]
1192 :oclc:
1193
1194
1195 @links: { SiSU }http://www.sisudoc.org
1196 { FSF }http://www.fsf.org
1197
1198
1199 @make:
1200 :num_top: 1
1201 :headings: [text to match for each level
1202 (e.g. PART; Chapter; Section; Article; or another: none; BOOK|FIRST|SECOND; none; CHAPTER;)
1203 :breaks: new=:C; break=1
1204 :promo: sisu, ruby, sisu_search_libre, open_society
1205 :bold: [regular expression of words/phrases to be made bold]
1206 :italics: [regular expression of words/phrases to italicise]
1207 :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
1208 :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org
1209
1210
1211 @original:
1212 :language: [language]
1213
1214
1215 @notes:
1216 :comment:
1217 :prefix: [prefix is placed just after table of contents]
1218
1219
1220 MARKUP OF SUBSTANTIVE TEXT
1221 --------------------------
1222
1223 HEADING LEVELS
1224 ..............
1225
1226 Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A - :C being part / section
1227 headings, followed by other heading levels, and 1 -6 being headings followed by
1228 substantive text or sub-headings. :A~ usually the title :A~? conditional level
1229 1 heading (used where a stand-alone document may be imported into another)
1230
1231 *:A~ [heading text]* Top level heading [this usually has similar content to the
1232 title @title: ] NOTE: the heading levels described here are in 0.38 notation,
1233 see heading
1234
1235 *:B~ [heading text]* Second level heading [this is a heading level divider]
1236
1237 *:C~ [heading text]* Third level heading [this is a heading level divider]
1238
1239 *1~ [heading text]* Top level heading preceding substantive text of document or
1240 sub-heading 2, the heading level that would normally be marked 1. or 2. or 3.
1241 etc. in a document, and the level on which sisu by default would break html
1242 output into named segments, names are provided automatically if none are given
1243 (a number), otherwise takes the form 1~my_filename_for_this_segment
1244
1245 *2~ [heading text]* Second level heading preceding substantive text of document
1246 or sub-heading 3 , the heading level that would normally be marked 1.1 or 1.2
1247 or 1.3 or 2.1 etc. in a document.
1248
1249 *3~ [heading text]* Third level heading preceding substantive text of document,
1250 that would normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a
1251 document
1252
1253 1~filename level 1 heading,
1254
1255 % the primary division such as Chapter that is followed by substantive text, and may be further subdivided (this is the level on which by default html segments are made)
1256
1257
1258 FONT ATTRIBUTES
1259 ...............
1260
1261 *markup example:*
1262
1263 normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}",
1264 ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-, #{monospace}#
1265
1266 normal text
1267
1268 *{emphasis}* [note: can be configured to be represented by bold, italics or underscore]
1269
1270 !{bold text}!
1271
1272 /{italics}/
1273
1274 _{underscore}_
1275
1276 "{citation}"
1277
1278 ^{superscript}^
1279
1280 ,{subscript},
1281
1282 +{inserted text}+
1283
1284 -{strikethrough}-
1285
1286 #{monospace}#
1287
1288
1289 *resulting output:*
1290
1291 normal text, *emphasis*, *bold text*, /italics/, _underscore_, "citation",
1292 ^superscript^, [subscript], +inserted text+, -strikethrough-, #monospace#
1293
1294 normal text
1295
1296 *emphasis* [note: can be configured to be represented by bold, italics or
1297 underscore]
1298
1299 *bold text*
1300
1301 /italics/
1302
1303 _underscore_
1304
1305 "citation"
1306
1307 ^superscript^
1308
1309 [subscript]
1310
1311 +inserted text+
1312
1313 -strikethrough-
1314
1315 #monospace#
1316
1317 INDENTATION AND BULLETS
1318 .......................
1319
1320 *markup example:*
1321
1322 ordinary paragraph
1323
1324 _1 indent paragraph one step
1325
1326 _2 indent paragraph two steps
1327
1328 _9 indent paragraph nine steps
1329
1330
1331 *resulting output:*
1332
1333 ordinary paragraph
1334
1335 indent paragraph one step
1336
1337 indent paragraph two steps
1338
1339 indent paragraph nine steps
1340
1341 *markup example:*
1342
1343 _* bullet text
1344
1345 _1* bullet text, first indent
1346
1347 _2* bullet text, two step indent
1348
1349
1350 *resulting output:*
1351
1352 * bullet text
1353
1354 * bullet text, first indent
1355
1356 * bullet text, two step indent
1357
1358 Numbered List (not to be confused with headings/titles, (document structure))
1359
1360 *markup example:*
1361
1362 # numbered list numbered list 1., 2., 3, etc.
1363
1364 _# numbered list numbered list indented a., b., c., d., etc.
1365
1366
1367 HANGING INDENTS
1368 ...............
1369
1370 *markup example:*
1371
1372 _0_1 first line no indent,
1373 rest of paragraph indented one step
1374
1375 _1_0 first line indented,
1376 rest of paragraph no indent
1377
1378 in each case level may be 0-9
1379
1380
1381 *resulting output:*
1382
1383 first line no indent, rest of paragraph indented one step; first line no
1384 indent, rest of paragraph indented one step; first line no indent, rest of
1385 paragraph indented one step; first line no indent, rest of paragraph indented
1386 one step; first line no indent, rest of paragraph indented one step; first
1387 line no indent, rest of paragraph indented one step; first line no indent,
1388 rest of paragraph indented one step; first line no indent, rest of paragraph
1389 indented one step; first line no indent, rest of paragraph indented one step;
1390
1391 A regular paragraph.
1392
1393 first line indented, rest of paragraph no indent first line indented, rest of
1394 paragraph no indent first line indented, rest of paragraph no indent first line
1395 indented, rest of paragraph no indent first line indented, rest of paragraph no
1396 indent first line indented, rest of paragraph no indent first line indented,
1397 rest of paragraph no indent first line indented, rest of paragraph no indent
1398 first line indented, rest of paragraph no indent first line indented, rest of
1399 paragraph no indent first line indented, rest of paragraph no indent
1400
1401 in each case level may be 0-9
1402
1403 *live-build* A collection of scripts used to build customized *Debian*
1404 Livesystems. /live-build/ was formerly known as live-helper, and even earlier
1405 known as live-package.
1406
1407 *live-build*
1408 A collection of scripts used to build customized *Debian* Livesystems.
1409 /live-build/ was formerly known as live-helper, and even earlier known as
1410 live-package.
1411
1412 FOOTNOTES / ENDNOTES
1413 ....................
1414
1415 Footnotes and endnotes are marked up at the location where they would be
1416 indicated within a text. They are automatically numbered. The output type
1417 determines whether footnotes or endnotes will be produced
1418
1419 *markup example:*
1420
1421 ~{ a footnote or endnote }~
1422
1423
1424 *resulting output:*
1425
1426 [^5]
1427
1428 *markup example:*
1429
1430 normal text~{ self contained endnote marker & endnote in one }~ continues
1431
1432
1433 *resulting output:*
1434
1435 normal text[^6] continues
1436
1437 *markup example:*
1438
1439 normal text ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required }~ continues
1440
1441 normal text ~{** another unnumbered asterisk footnote/endnote }~ continues
1442
1443
1444 *resulting output:*
1445
1446 normal text [^*] continues
1447
1448 normal text [^**] continues
1449
1450 *markup example:*
1451
1452 normal text ~[* editors notes, numbered asterisk footnote/endnote series ]~ continues
1453
1454 normal text ~[+ editors notes, numbered plus symbol footnote/endnote series ]~ continues
1455
1456
1457 *resulting output:*
1458
1459 normal text [^*3] continues
1460
1461 normal text [^+2] continues
1462
1463 *Alternative endnote pair notation for footnotes/endnotes:*
1464
1465 % note the endnote marker "~^"
1466
1467 normal text~^ continues
1468
1469 ^~ endnote text following the paragraph in which the marker occurs
1470
1471
1472 the standard and pair notation cannot be mixed in the same document
1473
1474 LINKS
1475 .....
1476
1477
1478 ----------------------------------------
1479
1480 NAKED URLS WITHIN TEXT, DEALING WITH URLS
1481 .........................................
1482
1483 urls found within text are marked up automatically. A url within text is
1484 automatically hyperlinked to itself and by default decorated with angled
1485 braces, unless they are contained within a code block (in which case they are
1486 passed as normal text), or escaped by a preceding underscore (in which case the
1487 decoration is omitted).
1488
1489 *markup example:*
1490
1491 normal text http://www.sisudoc.org/ continues
1492
1493
1494 *resulting output:*
1495
1496 normal text <http://www.sisudoc.org/> continues
1497
1498 An escaped url without decoration
1499
1500 *markup example:*
1501
1502 normal text _http://www.sisudoc.org/ continues
1503
1504 deb _http://www.jus.uio.no/sisu/archive unstable main non-free
1505
1506
1507 *resulting output:*
1508
1509 normal text http://www.sisudoc.org/ continues
1510
1511 deb http://www.jus.uio.no/sisu/archive unstable main non-free
1512
1513 where a code block is used there is neither decoration nor hyperlinking, code
1514 blocks are discussed later in this document
1515
1516 *resulting output:*
1517
1518 deb http://www.jus.uio.no/sisu/archive unstable main non-free
1519 deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
1520
1521
1522
1523 ----------------------------------------
1524
1525 LINKING TEXT
1526 ............
1527
1528 To link text or an image to a url the markup is as follows
1529
1530 *markup example:*
1531
1532 about { SiSU }http://url.org markup
1533
1534
1535 *resulting output:*
1536
1537 about SiSU [link: <http://www.sisudoc.org/>] markup
1538
1539 A shortcut notation is available so the url link may also be provided
1540 automatically as a footnote
1541
1542 *markup example:*
1543
1544 about {~^ SiSU }http://url.org markup
1545
1546
1547 *resulting output:*
1548
1549 about SiSU [link: <http://www.sisudoc.org/>] [^7] markup
1550
1551 Internal document links to a tagged location, including an ocn
1552
1553 *markup example:*
1554
1555 about { text links }#link_text
1556
1557
1558 *resulting output:*
1559
1560 about text links
1561
1562 Shared document collection link
1563
1564 *markup example:*
1565
1566 about { SiSU book markup examples }:SiSU/examples.html
1567
1568
1569 *resulting output:*
1570
1571 about *SiSU* book markup examples
1572
1573
1574 ----------------------------------------
1575
1576 LINKING IMAGES
1577 ..............
1578
1579 *markup example:*
1580
1581 { tux.png 64x80 }image
1582
1583 % various url linked images
1584 [image: "a better way"]
1585 [image: "Way Better - with Gnu/Linux, Debian and Ruby"]
1586
1587 {~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/
1588
1589
1590 *resulting output:*
1591
1592 tux.png 64x80 [link: local image]
1593
1594 tux.png 64x80 "Gnu/Linux - a better way" [link: <http://www.sisudoc.org/>]
1595
1596 GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian
1597 and Ruby" [link: <http://www.sisudoc.org/>]
1598
1599 ruby_logo.png 70x90 "Ruby" [link: <http://www.ruby-lang.org/en/>] [^8]
1600
1601 *linked url footnote shortcut*
1602
1603 {~^ [text to link] }http://url.org
1604
1605 % maps to: { [text to link] }http://url.org ~{ http://url.org }~
1606
1607 % which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink
1608
1609
1610 text marker *~name
1611
1612
1613 note at a heading level the same is automatically achieved by providing names
1614 to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of
1615 auto-heading numbering, without further intervention.
1616
1617
1618 ----------------------------------------
1619
1620 LINK SHORTCUT FOR MULTIPLE VERSIONS OF A SISU DOCUMENT IN THE SAME DIRECTORY
1621 TREE
1622 ..............................................................................
1623
1624 *markup example:*
1625
1626 !_ /{"Viral Spiral"}/, David Bollier
1627
1628 { "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst
1629
1630
1631 */"Viral Spiral"/, David Bollier*
1632
1633 "Viral Spiral", David Bollier [link: <http://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>]
1634 document manifest [link: <http://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>]
1635 html, segmented text [link: <http://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/viral_spiral.david_bollier.toc.html>]
1636 html, scroll, document in one [link: <http://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier.html>]
1637 epub [link: <http://www.sisudoc.org/sisu/en/epub/viral_spiral.david_bollier.epub>]
1638 pdf, landscape [link: <http://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>]
1639 pdf, portrait [link: <http://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>]
1640 odf: odt, open document text [link: <http://www.sisudoc.org/sisu/en/odt/viral_spiral.david_bollier.odt>]
1641 xhtml scroll [link: <http://www.sisudoc.org/sisu/en/xhtml/viral_spiral.david_bollier.xhtml>]
1642 xml, sax [link: <http://www.sisudoc.org/sisu/en/xml_sax/viral_spiral.david_bollier.sax.xml>]
1643 xml, dom [link: <http://www.sisudoc.org/sisu/en/xml_dom/viral_spiral.david_bollier.dom.xml>]
1644 concordance [link: <http://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/concordance.html>]
1645 dcc, document content certificate (digests) [link: <http://www.sisudoc.org/sisu/en/digest/viral_spiral.david_bollier.hash_digest.txt>]
1646 markup source text [link: <http://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst>]
1647 markup source (zipped) pod [link: <http://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst.zip>]
1648
1649 GROUPED TEXT
1650 ............
1651
1652
1653 ----------------------------------------
1654
1655 TABLES
1656 ......
1657
1658 Tables may be prepared in two either of two forms
1659
1660 *markup example:*
1661
1662 table{ c3; 40; 30; 30;
1663
1664 This is a table
1665 this would become column two of row one
1666 column three of row one is here
1667
1668 And here begins another row
1669 column two of row two
1670 column three of row two, and so on
1671
1672 }table
1673
1674
1675 *resulting output:*
1676
1677 This is a table┆this would become column two of row one┆column three of row one is here』And here begins another row┆column two of row two┆column three of row two, and so on』
1678
1679 a second form may be easier to work with in cases where there is not much
1680 information in each column
1681
1682 *markup example:*[^10]
1683
1684 !_ Table 3.1: Contributors to Wikipedia, January 2001 - June 2005
1685
1686 {table~h 24; 12; 12; 12; 12; 12; 12;}
1687 |Jan. 2001|Jan. 2002|Jan. 2003|Jan. 2004|July 2004|June 2006
1688 Contributors* | 10| 472| 2,188| 9,653| 25,011| 48,721
1689 Active contributors** | 9| 212| 846| 3,228| 8,442| 16,945
1690 Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016
1691 No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000
1692 No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000
1693
1694 * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.
1695
1696
1697 *resulting output:*
1698
1699 *Table 3.1: Contributors to Wikipedia, January 2001 - June 2005*
1700
1701 ┆Jan. 2001┆Jan. 2002┆Jan. 2003┆Jan. 2004┆July 2004┆June 2006』Contributors*┆10┆472┆2,188┆9,653┆25,011┆48,721』Active contributors**┆9┆212┆846┆3,228┆8,442┆16,945』Very active contributors***┆0┆31┆190┆692┆1,639┆3,016』No. of English language articles┆25┆16,000┆101,000┆190,000┆320,000┆630,000』No. of articles, all languages┆25┆19,000┆138,000┆490,000┆862,000┆1,600,000』
1702
1703 * Contributed at least ten times; ** at least 5 times in last month; *** more
1704 than 100 times in last month.
1705
1706
1707 ----------------------------------------
1708
1709 POEM
1710 ....
1711
1712 *basic markup:*
1713
1714 poem{
1715
1716 Your poem here
1717
1718 }poem
1719
1720 Each verse in a poem is given an object number.
1721
1722
1723 *markup example:*
1724
1725 poem{
1726
1727 `Fury said to a
1728 mouse, That he
1729 met in the
1730 house,
1731 "Let us
1732 both go to
1733 law: I will
1734 prosecute
1735 YOU. --Come,
1736 I'll take no
1737 denial; We
1738 must have a
1739 trial: For
1740 really this
1741 morning I've
1742 nothing
1743 to do."
1744 Said the
1745 mouse to the
1746 cur, "Such
1747 a trial,
1748 dear Sir,
1749 With
1750 no jury
1751 or judge,
1752 would be
1753 wasting
1754 our
1755 breath."
1756 "I'll be
1757 judge, I'll
1758 be jury,"
1759 Said
1760 cunning
1761 old Fury:
1762 "I'll
1763 try the
1764 whole
1765 cause,
1766 and
1767 condemn
1768 you
1769 to
1770 death."'
1771
1772 }poem
1773
1774
1775 *resulting output:*
1776
1777 `Fury said to a
1778 mouse, That he
1779 met in the
1780 house,
1781 "Let us
1782 both go to
1783 law: I will
1784 prosecute
1785 YOU. --Come,
1786 I'll take no
1787 denial; We
1788 must have a
1789 trial: For
1790 really this
1791 morning I've
1792 nothing
1793 to do."
1794 Said the
1795 mouse to the
1796 cur, "Such
1797 a trial,
1798 dear Sir,
1799 With
1800 no jury
1801 or judge,
1802 would be
1803 wasting
1804 our
1805 breath."
1806 "I'll be
1807 judge, I'll
1808 be jury,"
1809 Said
1810 cunning
1811 old Fury:
1812 "I'll
1813 try the
1814 whole
1815 cause,
1816 and
1817 condemn
1818 you
1819 to
1820 death."'
1821
1822
1823 ----------------------------------------
1824
1825 GROUP
1826 .....
1827
1828 *basic markup:*
1829
1830 group{
1831
1832 Your grouped text here
1833
1834 }group
1835
1836 A group is treated as an object and given a single object number.
1837
1838
1839 *markup example:*
1840
1841 group{
1842
1843 `Fury said to a
1844 mouse, That he
1845 met in the
1846 house,
1847 "Let us
1848 both go to
1849 law: I will
1850 prosecute
1851 YOU. --Come,
1852 I'll take no
1853 denial; We
1854 must have a
1855 trial: For
1856 really this
1857 morning I've
1858 nothing
1859 to do."
1860 Said the
1861 mouse to the
1862 cur, "Such
1863 a trial,
1864 dear Sir,
1865 With
1866 no jury
1867 or judge,
1868 would be
1869 wasting
1870 our
1871 breath."
1872 "I'll be
1873 judge, I'll
1874 be jury,"
1875 Said
1876 cunning
1877 old Fury:
1878 "I'll
1879 try the
1880 whole
1881 cause,
1882 and
1883 condemn
1884 you
1885 to
1886 death."'
1887
1888 }group
1889
1890
1891 *resulting output:*
1892
1893 `Fury said to a
1894 mouse, That he
1895 met in the
1896 house,
1897 "Let us
1898 both go to
1899 law: I will
1900 prosecute
1901 YOU. --Come,
1902 I'll take no
1903 denial; We
1904 must have a
1905 trial: For
1906 really this
1907 morning I've
1908 nothing
1909 to do."
1910 Said the
1911 mouse to the
1912 cur, "Such
1913 a trial,
1914 dear Sir,
1915 With
1916 no jury
1917 or judge,
1918 would be
1919 wasting
1920 our
1921 breath."
1922 "I'll be
1923 judge, I'll
1924 be jury,"
1925 Said
1926 cunning
1927 old Fury:
1928 "I'll
1929 try the
1930 whole
1931 cause,
1932 and
1933 condemn
1934 you
1935 to
1936 death."'
1937
1938
1939 ----------------------------------------
1940
1941 CODE
1942 ....
1943
1944 Code tags # code{ ... }code # (used as with other group tags described above)
1945 are used to escape regular sisu markup, and have been used extensively within
1946 this document to provide examples of *SiSU* markup. You cannot however use code
1947 tags to escape code tags. They are however used in the same way as group or
1948 poem tags.
1949
1950 A code-block is treated as an object and given a single object number. [an
1951 option to number each line of code may be considered at some later time]
1952
1953 *use of code tags instead of poem compared, resulting output:*
1954
1955 `Fury said to a
1956 mouse, That he
1957 met in the
1958 house,
1959 "Let us
1960 both go to
1961 law: I will
1962 prosecute
1963 YOU. --Come,
1964 I'll take no
1965 denial; We
1966 must have a
1967 trial: For
1968 really this
1969 morning I've
1970 nothing
1971 to do."
1972 Said the
1973 mouse to the
1974 cur, "Such
1975 a trial,
1976 dear Sir,
1977 With
1978 no jury
1979 or judge,
1980 would be
1981 wasting
1982 our
1983 breath."
1984 "I'll be
1985 judge, I'll
1986 be jury,"
1987 Said
1988 cunning
1989 old Fury:
1990 "I'll
1991 try the
1992 whole
1993 cause,
1994 and
1995 condemn
1996 you
1997 to
1998 death."'
1999
2000
2001 From *SiSU* 2.7.7 on you can number codeblocks by placing a hash after the
2002 opening code tag # code{# # as demonstrated here:
2003
2004 1 ┆ `Fury said to a
2005 2 ┆ mouse, That he
2006 3 ┆ met in the
2007 4 ┆ house,
2008 5 ┆ "Let us
2009 6 ┆ both go to
2010 7 ┆ law: I will
2011 8 ┆ prosecute
2012 9 ┆ YOU. --Come,
2013 10 ┆ I'll take no
2014 11 ┆ denial; We
2015 12 ┆ must have a
2016 13 ┆ trial: For
2017 14 ┆ really this
2018 15 ┆ morning I've
2019 16 ┆ nothing
2020 17 ┆ to do."
2021 18 ┆ Said the
2022 19 ┆ mouse to the
2023 20 ┆ cur, "Such
2024 21 ┆ a trial,
2025 22 ┆ dear Sir,
2026 23 ┆ With
2027 24 ┆ no jury
2028 25 ┆ or judge,
2029 26 ┆ would be
2030 27 ┆ wasting
2031 28 ┆ our
2032 29 ┆ breath."
2033 30 ┆ "I'll be
2034 31 ┆ judge, I'll
2035 32 ┆ be jury,"
2036 33 ┆ Said
2037 34 ┆ cunning
2038 35 ┆ old Fury:
2039 36 ┆ "I'll
2040 37 ┆ try the
2041 38 ┆ whole
2042 39 ┆ cause,
2043 40 ┆ and
2044 41 ┆ condemn
2045 42 ┆ you
2046 43 ┆ to
2047 44 ┆ death."'
2048
2049 ADDITIONAL BREAKS - LINEBREAKS WITHIN OBJECTS, COLUMN AND PAGE-BREAKS
2050 .....................................................................
2051
2052
2053 ----------------------------------------
2054
2055 LINE-BREAKS
2056 ...........
2057
2058 To break a line within a "paragraph object", two backslashes \\
2059 with a space before and a space or newline after them
2060 may be used.
2061
2062 To break a line within a "paragraph object",
2063 two backslashes \\ with a space before
2064 and a space or newline after them \\
2065 may be used.
2066
2067
2068 The html break br enclosed in angle brackets (though undocumented) is available
2069 in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being,
2070 but is depreciated).
2071
2072 To draw a dividing line dividing paragraphs, see the section on page breaks.
2073
2074
2075 ----------------------------------------
2076
2077 PAGE BREAKS
2078 ...........
2079
2080 Page breaks are only relevant and honored in some output formats. A page break
2081 or a new page may be inserted manually using the following markup on a line on
2082 its own:
2083
2084 page new =\= breaks the page, starts a new page.
2085
2086 page break -\- breaks a column, starts a new column, if using columns,
2087 else breaks the page, starts a new page.
2088
2089 page break line across page -..- draws a dividing line, dividing paragraphs
2090
2091 page break:
2092
2093 -\\-
2094
2095
2096 page (break) new:
2097
2098 =\\=
2099
2100
2101 page (break) line across page (dividing paragraphs):
2102
2103 -..-
2104
2105
2106 BOOK INDEX
2107 ..........
2108
2109 To make an index append to paragraph the book index term relates to it, using
2110 an equal sign and curly braces.
2111
2112 Currently two levels are provided, a main term and if needed a sub-term.
2113 Sub-terms are separated from the main term by a colon.
2114
2115 Paragraph containing main term and sub-term.
2116 ={Main term:sub-term}
2117
2118
2119 The index syntax starts on a new line, but there should not be an empty line
2120 between paragraph and index markup.
2121
2122 The structure of the resulting index would be:
2123
2124 Main term, 1
2125 sub-term, 1
2126
2127
2128 Several terms may relate to a paragraph, they are separated by a semicolon. If
2129 the term refers to more than one paragraph, indicate the number of paragraphs.
2130
2131 Paragraph containing main term, second term and sub-term.
2132 ={first term; second term: sub-term}
2133
2134
2135 The structure of the resulting index would be:
2136
2137 First term, 1,
2138 Second term, 1,
2139 sub-term, 1
2140
2141
2142 If multiple sub-terms appear under one paragraph, they are separated under the
2143 main term heading from each other by a pipe symbol.
2144
2145 Paragraph containing main term, second term and sub-term.
2146 ={Main term:
2147 sub-term+2|second sub-term;
2148 Another term
2149 }
2150
2151 A paragraph that continues discussion of the first sub-term
2152
2153
2154 The plus one in the example provided indicates the first sub-term spans one
2155 additional paragraph. The logical structure of the resulting index would be:
2156
2157 Main term, 1,
2158 sub-term, 1-3,
2159 second sub-term, 1,
2160 Another term, 1
2161
2162
2163 COMPOSITE DOCUMENTS MARKUP
2164 --------------------------
2165
2166 It is possible to build a document by creating a master document that requires
2167 other documents. The documents required may be complete documents that could be
2168 generated independently, or they could be markup snippets, prepared so as to be
2169 easily available to be placed within another text. If the calling document is a
2170 master document (built from other documents), it should be named with the
2171 suffix *.ssm* Within this document you would provide information on the other
2172 documents that should be included within the text. These may be other documents
2173 that would be processed in a regular way, or markup bits prepared only for
2174 inclusion within a master document *.sst* regular markup file, or *.ssi*
2175 (insert/information) A secondary file of the composite document is built prior
2176 to processing with the same prefix and the suffix *._sst*
2177
2178 basic markup for importing a document into a master document
2179
2180 << filename1.sst
2181
2182 << filename2.ssi
2183
2184
2185 The form described above should be relied on. Within the /Vim/ editor it
2186 results in the text thus linked becoming hyperlinked to the document it is
2187 calling in which is convenient for editing.
2188
2189 SUBSTITUTIONS
2190 -------------
2191
2192 *markup example:*
2193
2194 The current Debian is ${debian_stable} the next debian will be ${debian_testing}
2195
2196 Configure substitution in _sisu/sisu_document_make
2197
2198 @make:
2199 :substitute: /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*'
2200
2201
2202 *resulting output:*
2203
2204 The current *Debian* is *Wheezy* the next debian will be *Jessie*
2205
2206 Configure substitution in _sisu/sisu_document_make
2207
2208
2209 ----------------------------------------
2210
2211
2212 ----------------------------------------
2213
2214
2215 [1]: <http://packages.qa.debian.org/s/sisu.html>
2216
2217 [2]: from the *Debian* control file
2218
2219 [*1]: square brackets
2220
2221 [*2]: square brackets
2222
2223 [+1]: square brackets
2224
2225 [3]: From sometime after SiSU 0.58 it should be possible to describe SiSU markup
2226 using SiSU, which though not an original design goal is useful.
2227
2228 [4]: files should be prepared using /UTF-8/ character encoding
2229
2230 [5]: a footnote or endnote
2231
2232 [6]: self contained endnote marker & endnote in one
2233
2234 [*]: unnumbered asterisk footnote/endnote, insert multiple asterisks if required
2235
2236 [**]: another unnumbered asterisk footnote/endnote
2237
2238 [*3]: editors notes, numbered asterisk footnote/endnote series
2239
2240 [+2]: editors notes, numbered plus symbol footnote/endnote series
2241
2242 [7]: <http://www.sisudoc.org/>
2243
2244 [8]: <http://www.ruby-lang.org/en/>
2245
2246 [10]: Table from the Wealth of Networks by Yochai Benkler
2247
2248 <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler>
2249
2250 ==============================================================================
2251
2252 Title: SiSU - README
2253
2254 Creator: Ralph Amissah
2255
2256 Rights: Copyright: Copyright (C) Ralph Amissah 2014 \\ License: GPL 3
2257 (part of SiSU documentation)
2258
2259 Subject: ebook, epublishing, electronic book, electronic publishing,
2260 electronic document, electronic citation, data structure,
2261 citation systems, search
2262
2263 Publisher: SiSU http://www.jus.uio.no/sisu (this copy)
2264
2265 Date created: 2014-02-02
2266
2267 Date available: 2014-02-02
2268
2269 Date modified: 2014-02-02
2270
2271 Date: 2014-02-02
2272
2273 Sourcefile: README.ssm.sst
2274
2275 Filetype: SiSU text insert 5.0,
2276
2277 Source digest: SHA256(README.ssm.sst)=
2278 e6badfab7c24f0b217e1ab3b2d8cebb70a7fa9f1a8af9f907f029aa19fca3e74
2279
2280 Generated by: Generated by: SiSU 6.0.5 of 2014w15/3 (2014-04-16)
2281
2282 Ruby version: ruby 2.1.1p76 (2014-02-24) [i386-linux-gnu]
2283
2284 Document (ao) last generated: 2014-05-08 16:40:57 -0400
2285
2286 ==============================================================================
2287
2288
2289 plaintext (plain text):
2290 README
2291
2292 * Generated by: SiSU 6.0.5 of 2014w15/3 (2014-04-16)
2293 * Ruby version: ruby 2.1.1p76 (2014-02-24) [i386-linux-gnu]
2294 * Last Generated on: 2014-05-08 16:40:59 -0400
2295 * SiSU http://www.sisudoc.org/