From 1d239f2504dffc05c39efd38a10a27dba9e9c85e Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 26 Jun 2011 21:26:07 -0400 Subject: v3: documentation, on additional breaks in document, (remove some old info) * linebreak \\ (previously undocumented
kept but depreciated) [it is intended that this should close #617298 (post mail)] * page break (breaks column if column, else breaks page) * page new (new page, breaks page) * sisurc.yml set output directory structure by language * removed section on hyperestraier, too specialised for general manpage (also section not checked recently) --- data/doc/sisu/CHANGELOG_v3 | 10 +- data/doc/sisu/html/sisu.1.html | 578 +++++++++------------ data/doc/sisu/markup-samples/sisu_manual/sisu.ssm | 2 - .../markup-samples/sisu_manual/sisu_commands.sst | 2 +- .../markup-samples/sisu_manual/sisu_markup.sst | 39 ++ 5 files changed, 308 insertions(+), 323 deletions(-) (limited to 'data') diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index 8984a2ef..7f2093b0 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -34,6 +34,14 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.13.orig.tar.gz * sisu syntax highlighting, linebreak \\ added (
kept) * colors, added cursor line & column + * documentation, on additional breaks in document + * linebreak \\ (previously undocumented
kept but depreciated) + [it is intended that this should close #617298] + * page break (breaks column if column, else breaks page) + * page new (new page, breaks page) + * removed section on hyperestraier, too specialised for general manpage + (also section not checked recently) + * texpdf * define latex \newcommands for some special characters to simplify dealing with them in sisu code \hardspace \caret \pipe \curlyopen @@ -67,7 +75,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.13.orig.tar.gz * urls (ansi screen reporting), add document language code - * sysenv, accomodate + * sysenv, accommodate * manifest * manpage * info (texinfo) diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 06fa3f15..fb74b10d 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -148,7 +148,7 @@ offers great possibilities. citation system to reliably reference its documents. SiSU works well in a complementary manner with such collaborative technologies as Wikis, which can take advantage of and be used to discuss the substance of content prepared -in SiSU +in SiSU.


<http://www.sisudoc.org/ > @@ -193,8 +193,8 @@ footnotes at end of each paragraph that contains them [  -A  for   [filename/wildcard]

screen toggle ansi screen colour on or off depending on default set (unless -c flag is used: if sisurc colour default is set -to ’true’, output to screen will be with colour, if sisurc colour default is -set to ’false’ or is undefined screen output will be without colour). Alias -c +to ’true’, output to screen will be with colour, if sisurc colour default +is set to ’false’ or is undefined screen output will be without colour). Alias -c

--concordance [filename/wildcard]
@@ -347,7 +347,8 @@ file (scroll.html). Alias -h
prints license information.

-
--machine [filename/wildcard/url]
+
--machine [filename/wildcard/url] +
see --dal (document abstraction level/layer)

@@ -361,7 +362,8 @@ indicated. (also see -V). Aliases -M and --keep-processing-files

-M [filename/wildcard/url]
-
see --maintenance +
+

see --maintenance

-m [filename/wildcard/url]
@@ -393,7 +395,7 @@ by most processing flags.
see --odt

-
--odt [filename/wildcard/url]
+
--odt [filename/wildcard/url]
output basic document in opendocument file format (opendocument.odt). Alias -o

@@ -587,8 +589,8 @@ paths in sisurc.yml. Alias -U

-u [filename/wildcard]
-
provides url mapping of output files for the flags -requested for processing, also see -U +
provides url mapping of output files for the flags requested for processing, +also see -U

--v2 [filename/wildcard]
@@ -597,9 +599,9 @@ This is the default and is normally omitted.

--v3 [filename/wildcard]
-
invokes the sisu v3 document parser/generator. Currently -under development and incomplete, v3 requires >= ruby1.9.2p180. You may run -sisu3 instead. +
invokes +the sisu v3 document parser/generator. Currently under development and incomplete, +v3 requires >= ruby1.9.2p180. You may run sisu3 instead.

--verbose [filename/wildcard]
@@ -609,7 +611,8 @@ created for each of the processing flag requests. Alias -v

-V
-
on its own, provides SiSU version and environment information (sisu --help env) +
on its own, +provides SiSU version and environment information (sisu --help env)

-V [filename/wildcard]
@@ -618,7 +621,6 @@ created for each of the processing flag requests. Alias -v
-v
on its own, provides SiSU version information -

-v [filename/wildcard]
@@ -646,11 +648,13 @@ webserver points at sisu output directories, the default port is set to

--xhtml [filename/wildcard]
-
produces xhtml/XML output for browser viewing (sax parsing). Alias -b +
produces xhtml/XML output for +browser viewing (sax parsing). Alias -b

--xml-dom [filename/wildcard]
-
produces XML output with deep document structure, in the nature of dom. Alias -X +
produces +XML output with deep document structure, in the nature of dom. Alias -X

--xml-sax [filename/wildcard]
@@ -757,7 +761,7 @@ updates/imports specified data to postgresql db (rb.dbi) [  -dv  --upd
--pg --remove
[filename/wildcard] removes specified data to postgresql -db (rb.dbi) [  -d --remove  sqlite  equivalent] +db (rb.dbi) [  -d  --remove  sqlite  equivalent]

--pg --dropall
@@ -1270,10 +1274,9 @@ html


resulting output:


-normal text, emphasis , bold text , italics , underscore , "citation", -^superscript^, [subscript], ++inserted text++, --strikethrough--, monospace -

-
+normal text, emphasis, bold text, italics, underscore , "citation", ^superscript^, +[subscript], ++inserted text++, --strikethrough--, monospace +


normal text


@@ -2037,7 +2040,48 @@ opening code tag code{# as demonstrated here: 44 | death."’

-

9.7 Book Index

+

9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

+ +

+ +

9.7.1 Line-breaks

+ +


+To break a line within a "paragraph object", two backslashes \\ with a space +before and a space or newline after them may be used. +


+

  To break a line within a "paragraph object",
+  two backslashes \\ with a space before
+  and a space or newline after them \\
+  may be used.
+
+


+The html break br enclosed in angle brackets (though undocumented) is available +in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, +but is depreciated). +

+

9.7.2 Page Breaks

+ +


+Page breaks are only relevant and honored in some output formats. A page +break or a new page may be inserted manually using the following markup +on a line on its own: +


+

  <:pb>
+
+


+ +

or +


+

  <:pn>
+
+


+page new <:pn> breaks the page, starts a new page. +


+page break <:pb> breaks a column, starts a new column, if using columns, +else breaks the page, starts a new page. +

+

9.8 Book Index


To make an index append to paragraph the book index term relates to it, @@ -2091,7 +2135,7 @@ be: second sub-term, 1,

-

10. Composite Documents Markup

+

10. Composite Documents Markup



@@ -2127,11 +2171,11 @@ documents under consideration, and occasionally supported have been. << |filename.ssi|@|^|

-

Markup Syntax History

+

Markup Syntax History


-

11. Notes Related to Files-types and Markup Syntax

+

11. Notes Related to Files-types and Markup Syntax


2.0 introduced new headers and is therefore incompatible with 1.0 though @@ -2323,14 +2367,14 @@ in place of the 0.1 header, heading/structure notation SiSU 0.1 headers and headings structure represented by header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{

-

12. Sisu Filetypes

+

12. Sisu Filetypes



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

-

12.1 .sst .ssm .ssi Marked Up Plain Text

+

12.1 .sst .ssm .ssi Marked Up Plain Text


SiSU documents are prepared as plain-text (utf-8) files with SiSU markup. @@ -2351,7 +2395,7 @@ be located locally or on a remote server for which a url is provided. sisu -s [filename]

-

12.1.1 Sisu Text - Regular Files (.sst)

+

12.1.1 Sisu Text - Regular Files (.sst)


The most common form of document in SiSU , see the section on SiSU markup. @@ -2363,7 +2407,7 @@ The most common form of document in SiSU , see the section on SiSU <http://www.sisudoc.org/sisu/sisu_manual >

-

12.1.2 Sisu Master Files (.ssm)

+

12.1.2 Sisu Master Files (.ssm)


Composite documents which incorporate other SiSU documents which may be @@ -2388,7 +2432,7 @@ with the same prefix and the suffix ._sst [^17] <http://www.sisudoc.org/sisu/sisu_manual >

-

12.1.3 Sisu Insert Files (.ssi)

+

12.1.3 Sisu Insert Files (.ssi)


Inserts are documents prepared solely for the purpose of being incorporated @@ -2397,7 +2441,7 @@ except they are ignored by the SiSU processor. Making a file a .ssi file is a quick and convenient way of flagging that it is not intended that the file should be processed on its own.

-

12.2 Sisupod, Zipped Binary Container +

12.2 Sisupod, Zipped Binary Container (sisupod.zip, .ssp)


@@ -2437,12 +2481,12 @@ locally or on a remote server for which a url is provided. <http://www.sisudoc.org/sisu/sisu_manual >

-

13. Experimental Alternative Input +

13. Experimental Alternative Input Representations


-

13.1 Alternative Xml

+

13.1 Alternative Xml


SiSU offers alternative XML input representations of documents as a proof @@ -2470,7 +2514,7 @@ or the same: sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]]

-

13.1.1 Xml Sax Representation

+

13.1.1 Xml Sax Representation


To convert from sst to simple xml (sax) representation: @@ -2489,7 +2533,7 @@ or the same: sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]]

-

13.1.2 Xml Dom Representation

+

13.1.2 Xml Dom Representation


To convert from sst to simple xml (dom) representation: @@ -2508,7 +2552,7 @@ or the same: sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]]

-

13.1.3 Xml Node Representation

+

13.1.3 Xml Node Representation


To convert from sst to simple xml (node) representation: @@ -2527,11 +2571,11 @@ or the same: sisu --from-sxml [filename/wildcard  [.sxs.xml,.sxd.xml,sxn.xml]]

-

14. Configuration

+

14. Configuration


-

14.1 Determining the Current Configuration

+

14.1 Determining the Current Configuration


Information on the current configuration of SiSU should be available with @@ -2548,7 +2592,7 @@ which is an alias for: Either of these should be executed from within a directory that contains sisu markup source documents.

-

14.2 Configuration Files (config.yml)

+

14.2 Configuration Files (config.yml)


SiSU configration parameters are adjusted in the configuration file, which @@ -2583,7 +2627,7 @@ database access details.

If SiSU is installed a sample sisurc.yml may be found in /etc/sisu/sisurc.yml

-

15. Skins

+

15. Skins



@@ -2618,7 +2662,7 @@ for document skins: The skin itself is a ruby file which modifies the default appearances set in the program.

-

15.1 Document Skin

+

15.1 Document Skin


Documents take on a document skin, if the header of the document specifies @@ -2627,7 +2671,7 @@ a skin to be used. 

  @skin: skin_united_nations

-

15.2 Directory Skin

+

15.2 Directory Skin


A directory may be mapped on to a particular skin, so all documents within @@ -2639,13 +2683,13 @@ specifies the use of another skin, in the skin/doc directory). 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.

-

15.3 Site +

15.3 Site Skin


A site skin, modifies the program default skin.

-

15.4 Sample Skins

+

15.4 Sample Skins


With SiSU installed sample skins may be found in: @@ -2667,7 +2711,7 @@ list) may be found in: equivalent directory)

-

16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)

+

16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)



@@ -2695,11 +2739,11 @@ 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.[^18]

-

17. Organising Content

+

17. Organising Content


-

17.1 Directory Structure and Mapping

+

17.1 Directory Structure and Mapping


The output directory root can be set in the sisurc.yml file. Under the root, @@ -2726,15 +2770,15 @@ be output to the same output directory. Skins could be associated with each institution on a directory basis and resulting documents will take on the appropriate different appearance.

-

18. Homepages

+

18. Homepages



SiSU is about the ability to auto-generate documents. Home pages are regarded -as custom built items, and are not created by SiSU SiSU has a default -home page, which will not be appropriate for use with other sites, and -the means to provide your own home page instead in one of two ways as part -of a site’s configuration, these being: +as custom built items, and are not created by SiSU. More accurately, SiSU +has a default home page, which will not be appropriate for use with other +sites, and the means to provide your own home page instead in one of two +ways as part of a site’s configuration, these being:


1. through placing your home page and other custom built documents in the subdirectory _sisu/home/ (this probably being the easier and more convenient @@ -2746,7 +2790,7 @@ Document sets are contained in directories, usually organised by site or subject. Each directory can/should have its own homepage. See the section on directory structure and organisation of content.

-

18.1 Home Page and Other +

18.1 Home Page and Other Custom Built Pages in a Sub-directory


@@ -2759,7 +2803,7 @@ command: sisu -CC

-

18.2 Home Page Within a Skin

+

18.2 Home Page Within a Skin


Skins are described in a separate section, but basically are a file written @@ -2789,11 +2833,11 @@ index.html end

-

19. Markup and Output Examples

+

19. Markup and Output Examples


-

19.1 Markup Examples

+

19.1 Markup Examples


Current markup examples and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/examples.html @@ -2804,7 +2848,7 @@ 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.

-

20. Sisu Search - Introduction

+

20. Sisu Search - Introduction



@@ -2824,11 +2868,11 @@ degree of granularity. Basically, your match criteria is met by these documents and at these locations within each document, which can be viewed within the database directly or in various output formats.

-

21. Sql

+

21. Sql


-

21.1 Populating Sql Type Databases

+

21.1 Populating Sql Type Databases


SiSU feeds sisu markupd documents into sql type databases PostgreSQL[^19] @@ -2883,18 +2927,18 @@ full contents of the database and have headings in which search content appears, or to search only headings etc. (as the Dublin Core is incorporated it is easy to make use of that as well).

-

22. Postgresql

+

22. Postgresql


-

22.1 Name

+

22.1 Name


SiSU - Structured information, Serialized Units - a document publishing system,

postgresql dependency package

-

22.2 Description

+

22.2 Description


Information related to using postgresql with sisu (and related to the sisu_postgresql @@ -2902,7 +2946,7 @@ dependency package, which is a dummy package to install dependencies needed for SiSU to populate a postgresql database, this being part of SiSU - man sisu).

-

22.3 Synopsis

+

22.3 Synopsis


sisu -D [instruction] [filename/wildcard  if  required]
@@ -2911,7 +2955,7 @@ sisu). sisu -D --pg --[instruction] [filename/wildcard  if  required]

-

22.4 Commands

+

22.4 Commands


Mappings to two databases are provided by default, postgresql and sqlite, @@ -2922,7 +2966,7 @@ however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql,


-D or --pgsql may be used interchangeably.

-

22.4.1 Create and Destroy Database

+

22.4.1 Create and Destroy Database

@@ -2959,7 +3003,7 @@ of the same name).

-

22.4.2 Import and Remove Documents

+

22.4.2 Import and Remove Documents

@@ -2982,17 +3026,17 @@ database.

-

23. Sqlite

+

23. Sqlite


-

23.1 Name

+

23.1 Name


SiSU - Structured information, Serialized Units - a document publishing system.

-

23.2 Description

+

23.2 Description


Information related to using sqlite with sisu (and related to the sisu_sqlite @@ -3000,7 +3044,7 @@ dependency package, which is a dummy package to install dependencies needed for SiSU to populate an sqlite database, this being part of SiSU - man sisu).

-

23.3 Synopsis

+

23.3 Synopsis


sisu -d [instruction] [filename/wildcard  if  required]
@@ -3009,7 +3053,7 @@ for SiSU to populate an sqlite database, this being part of SiSU - sisu -d --(sqlite|pg) --[instruction] [filename/wildcard  if  required]

-

23.4 Commands

+

23.4 Commands


Mappings to two databases are provided by default, postgresql and sqlite, @@ -3020,7 +3064,7 @@ however -d (lowercase) denotes sqlite and -D (uppercase) denotes postgresql,


-d or --sqlite may be used interchangeably.

-

23.4.1 Create and Destroy Database

+

23.4.1 Create and Destroy Database

@@ -3057,7 +3101,7 @@ of the same name).

-

23.4.2 Import and Remove Documents

+

23.4.2 Import and Remove Documents

@@ -3080,11 +3124,11 @@ database.

-

24. Introduction

+

24. Introduction


-

24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,

+

24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,

INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL)


@@ -3139,7 +3183,7 @@ SiSU_ebook is used. [otherwise  a  manual  mapping  for &nbs

-

24.2 +

24.2 Search Form

@@ -3176,122 +3220,17 @@ search form for use with the webrick server, which must be copied to the

-

25. Hyperestraier

+

25. Sisu_webrick


-


-See the documentation for hyperestraier: -


- <http://hyperestraier.sourceforge.net/ ->
- -


- /usr/share/doc/hyperestraier/index.html
- -


- man estcmd
- -


-NOTE: the examples that follow assume that sisu output is placed in the - -

directory /home/ralph/sisu_www -


-(A) to generate the index within the webserver directory to be indexed: - -


- estcmd gather -sd [index  name] [directory  path  to  index]
- -


-the following are examples that will need to be tailored according to your -needs: -


- cd /home/ralph/sisu_www
- -


- estcmd gather -sd casket /home/ralph/sisu_www
- -


-you may use the ’find’ command together with ’egrep’ to limit indexing to particular -document collection directories within the web server directory: -


- find /home/ralph/sisu_www -type f | egrep
- ’/home/ralph/sisu_www/sisu/.+?.html$’ |estcmd gather -sd casket -
- -


-Check which directories in the webserver/output directory (~/sisu_www or -elsewhere depending on configuration) you wish to include in the search -index. -


-As sisu duplicates output in multiple file formats, it it is probably preferable -to limit the estraier index to html output, and as it may also be desirable -to exclude files ’plain.txt’, ’toc.html’ and ’concordance.html’, as these duplicate -information held in other html output e.g. -


- find /home/ralph/sisu_www -type f | egrep
- ’/sisu_www/(sisu|bookmarks)/.+?.html$’ | egrep -v ’(doc|concordance).html$’
- |estcmd gather -sd casket -
- -


-from your current document preparation/markup directory, you would construct -a rune along the following lines: -


- find /home/ralph/sisu_www -type f | egrep ’/home/ralph/sisu_www/([specify -
- first  directory  for  inclusion]|[specify  second  directory  for
- inclusion]|[another  directory  for  inclusion?  ...])/.+?.html$’ |
- egrep -v ’(doc|concordance).html$’ |estcmd gather -sd
- /home/ralph/sisu_www/casket -
- -


-(B) to set up the search form -


-(i) copy estseek.cgi to your cgi directory and set file permissions to 755: - -


- sudo cp -vi /usr/lib/estraier/estseek.cgi /usr/lib/cgi-bin
- -


- sudo chmod -v 755 /usr/lib/cgi-bin/estseek.cgi
- -


- sudo cp -v /usr/share/hyperestraier/estseek.* /usr/lib/cgi-bin
- -


- [see  estraier  documentation  for  paths]
- -


-(ii) edit estseek.conf, with attention to the lines starting ’indexname:’ -and -


- indexname: /home/ralph/sisu_www/casket
- -


- replace: ^file:///home/ralph/sisu_www{{!}}http://localhost -
- -


- replace: /index.html?${{!}}/
- -


-(C) to test using webrick, start webrick: -


- sisu -W
- -


-and try open the url: <http://localhost:8081/cgi-bin/estseek.cgi ->

-

26. Sisu_webrick

-
- -

-

26.1 Name

+

25.1 Name


SiSU - Structured information, Serialized Units - a document publishing system

-

26.2 Synopsis

+

25.2 Synopsis


sisu_webrick [port] @@ -3301,7 +3240,7 @@ sisu_webrick [port]


sisu -W [port]

-

26.3 Description

+

25.3 Description


sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby SiSU @@ -3312,7 +3251,7 @@ The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system).

-

26.4 Summary of Man Page

+

25.4 Summary of Man Page


@@ -3323,7 +3262,7 @@ sisu_webrick, may be started on it’s own with the command: sisu_webrick

where no port is given and settings are unchanged the default port is 8081

-

26.5 Document Processing Command Flags

+

25.5 Document Processing Command Flags


sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, @@ -3331,7 +3270,7 @@ on the port provided, or if no port is provided and the defaults have not

been changed in ~/.sisu/sisurc.yaml then on port 8081

-

26.6 Further Information

+

25.6 Further Information


@@ -3343,12 +3282,12 @@ For more information on SiSU see: <h

or man sisu

-

26.7 Author

+

25.7 Author


Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com>

-

26.8 See Also

+

25.8 See Also


sisu(1) @@ -3359,7 +3298,7 @@ Ralph Amissah <ralph@amissah.com> or <ralph.amissah@gmail.com>

-

27. Remote Source Documents

+

26. Remote Source Documents



@@ -3406,11 +3345,11 @@ way, see <http://www. > and use the url for the desired document.

-

Remote Document Output

+

Remote Document Output


-

28. Remote Output

+

27. Remote Output



@@ -3425,7 +3364,7 @@ which may be used in conjunction with other processing flags, e.g. 

  sisu -3R sisu_remote.sst

-

28.1 Commands

+

27.1 Commands

@@ -3448,12 +3387,12 @@ ssh agent in place. Also see -R

-

28.2 Configuration

+

27.2 Configuration


[expand  on  the  setting  up  of  an  ssh-agent  /  keychain]

-

29. Remote Servers

+

28. Remote Servers



@@ -3463,18 +3402,18 @@ easily be on a remote server, to which you are logged on using a terminal, and commands and operations would be pretty much the same as they would be on your local machine.

-

30. Quickstart - Getting Started Howto

+

29. Quickstart - Getting Started Howto


-

30.1 Installation

+

29.1 Installation


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.

-

30.1.1 Debian Installation

+

29.1.1 Debian Installation


SiSU is available directly from the Debian Sid and testing archives (and @@ -3524,7 +3463,7 @@ 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.

-

30.1.2 Rpm Installation

+

29.1.2 Rpm Installation


RPMs are provided though untested, they are prepared by running alien against @@ -3541,7 +3480,7 @@ as root type: rpm -i [rpm  package  name]

-

30.1.3 Installation from Source

+

29.1.3 Installation from Source


To install SiSU from source check information at: @@ -3560,7 +3499,7 @@ case: the first steps are the same, download and unpack the source file:


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, EPUB, various +it is written Ruby, and SiSU will be able to generate html, EPUB, 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 @@ -3632,7 +3571,7 @@ For a list of alternative actions you may type: ruby install -T

-

30.2 Testing Sisu, Generating Output

+

29.2 Testing Sisu, Generating Output


To check which version of sisu is installed: @@ -3655,7 +3594,7 @@ change directory to the appropriate one:

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

-

30.2.1 Basic Text, Plaintext, +

29.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub


@@ -3670,7 +3609,7 @@ this will generate html including a concordance file, opendocument text format, plaintext, XHTML and various forms of XML, and OpenDocument text

-

30.2.2 LaTeX / Pdf

+

29.2.2 LaTeX / Pdf


Assuming a LaTeX engine such as tetex or texlive is installed with the @@ -3691,7 +3630,7 @@ file, opendocument text format, plaintext, XHTML and various forms of XML,

and OpenDocument text and pdf

-

30.2.3 Relational Database - Postgresql, Sqlite

+

29.2.3 Relational Database - Postgresql, Sqlite


@@ -3716,10 +3655,10 @@ create the database and write to it when you run sisu.

sisu --pgsql -v --import free_as_in_freedom.rms_and_free_software.sam_williams.sst

-

30.3 Getting Help

+

29.3 Getting Help

-

30.3.1 the Man Pages

+

29.3.1 the Man Pages


Type: @@ -3739,7 +3678,7 @@ date as within the package itself: * man directory <http://www.jus.uio.no/sisu/man > [^27]

-

30.3.2 Built in Help

+

29.3.2 Built in Help


@@ -3754,7 +3693,7 @@ date as within the package itself:

sisu --help --markup

-

30.3.3 the Home Page

+

29.3.3 the Home Page


<http://www.sisudoc.org/ @@ -3766,7 +3705,7 @@ date as within the package itself: <http://www.jus.uio.no/sisu/SiSU >

-

30.4 Markup Samples

+

29.4 Markup Samples


A number of markup samples (along with output) are available off: @@ -3782,7 +3721,7 @@ On Debian they are available in non-free[^28] to include them it is neces to include non-free in your /etc/apt/source.list or obtain them from the sisu home site.

-

31. Editor Files, Syntax Highlighting

+

30. Editor Files, Syntax Highlighting



@@ -3952,10 +3891,9 @@ the
NOTE:


[  .B  SiSU  parses  files  with  long  lines  or  line  breaks,  display  linewrap - (without  line-breaks)  is  a  convenient editor  feature  to  have  for  sisu  markup] - + (without  line-breaks)  is  a  convenient

-

32. How Does Sisu Work?

+

31. How Does Sisu Work?



@@ -3977,7 +3915,7 @@ layout, publishing, content certification, concordance etc.), and makes it possible to take advantage of some of the strengths of established ways of representing documents, (or indeed to create new ones).

-

33. Summary of +

32. Summary of Features


@@ -4122,11 +4060,11 @@ present. For example objects could be saved individually and identified by their hashes, with an index of how the objects relate to each other to form a document.

-

34. Help Sources

+

33. Help Sources


-

34.1 Man Pages

+

33.1 Man Pages


man sisu
@@ -4183,14 +4121,14 @@ to form a document. man sisu_webrick

-

34.2 Sisu Generated Output - Links to HTML

+

33.2 Sisu Generated Output - Links to HTML


Note SiSU documentation is prepared in SiSU and output is available in multiple formats including amongst others html, pdf, odf and epub, which may be also be accessed via the html pages[^29]

-

34.2.1 Www.sisudoc.org

+

33.2.1 Www.sisudoc.org


<http://sisudoc.org/sisu/sisu_manual/index.html @@ -4200,10 +4138,10 @@ may be also be accessed via the html pages[^29] >

-

34.3 Man2html

+

33.3 Man2html

-

34.3.1 Locally Installed

+

33.3.1 Locally Installed


@@ -4224,7 +4162,7 @@ may be also be accessed via the html pages[^29] /usr/share/doc/sisu/html/sisu_webrick.1.html

-

34.3.2 WWW.jus.uio.no/sisu

+

33.3.2 Www.jus.uio.no/Sisu


<http://www.jus.uio.no/sisu/man/sisu.1.html @@ -4364,7 +4302,7 @@ while freely distributable are not freely changeable. 29. named index.html or more extensively through sisu_manifest.html

-

See Also

+

See Also


sisu(1) ,
@@ -4387,14 +4325,14 @@ while freely distributable are not freely changeable. sisu_vim(7)

-

Homepage

+

Homepage


More information about SiSU can be found at <http://www.sisudoc.org/ > or <http://www.jus.uio.no/sisu/ >.

-

Author

+

Author

SiSU is written by Ralph Amissah <ralph@amissah.com>.

@@ -4438,100 +4376,102 @@ More information about SiSU can be found at <9.6.2 Poem

  • 9.6.3 Group
  • 9.6.4 Code
    • -
  • 9.7 Book Index
    • -
  • 10. Composite Documents Markup
    • -
  • Markup Syntax History
    • -
  • 11. Notes Related to Files-types and Markup Syntax
    • -
  • 12. Sisu Filetypes
    • -
  • 12.1 .sst .ssm .ssi Marked Up Plain Text
    • -
  • 12.1.1 Sisu Text - Regular Files (.sst)
    • -
  • 12.1.2 Sisu Master Files (.ssm)
    • -
  • 12.1.3 Sisu Insert Files (.ssi)
    • -
  • 12.2 Sisupod, Zipped Binary Container (sisupod.zip, .ssp)
    • -
  • 13. Experimental Alternative Input Representations
    • -
  • 13.1 Alternative Xml
    • -
  • 13.1.1 Xml Sax Representation
    • -
  • 13.1.2 Xml Dom Representation
    • -
  • 13.1.3 Xml Node Representation
    • -
  • 14. Configuration
    • -
  • 14.1 Determining the Current Configuration
    • -
  • 14.2 Configuration Files (config.yml)
    • -
  • 15. Skins
    • -
  • 15.1 Document Skin
    • -
  • 15.2 Directory Skin
    • -
  • 15.3 Site Skin
    • -
  • 15.4 Sample Skins
    • -
  • 16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)
    • -
  • 17. Organising Content
    • -
  • 17.1 Directory Structure and Mapping
    • -
  • 18. Homepages
    • -
  • 18.1 Home Page and Other Custom Built Pages in a Sub-directory
    • -
  • 18.2 Home Page Within a Skin
    • -
  • 19. Markup and Output Examples
    • -
  • 19.1 Markup Examples
    • -
  • 20. Sisu Search - Introduction
    • -
  • 21. Sql
    • -
  • 21.1 Populating Sql Type Databases
    • -
  • 22. Postgresql
    • -
  • 22.1 Name
    • -
  • 22.2 Description
    • -
  • 22.3 Synopsis
    • -
  • 22.4 Commands
    • -
  • 22.4.1 Create and Destroy Database
    • -
  • 22.4.2 Import and Remove Documents
    • -
  • 23. Sqlite
    • -
  • 23.1 Name
    • -
  • 23.2 Description
    • -
  • 23.3 Synopsis
    • -
  • 23.4 Commands
    • -
  • 23.4.1 Create and Destroy Database
    • -
  • 23.4.2 Import and Remove Documents
    • -
  • 24. Introduction
    • -
  • 24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,
    • -
  • 24.2 Search Form
    • -
  • 25. Hyperestraier
    • -
  • 26. Sisu_webrick
    • -
  • 26.1 Name
    • -
  • 26.2 Synopsis
    • -
  • 26.3 Description
    • -
  • 26.4 Summary of Man Page
    • -
  • 26.5 Document Processing Command Flags
    • -
  • 26.6 Further Information
    • -
  • 26.7 Author
    • -
  • 26.8 See Also
    • -
  • 27. Remote Source Documents
    • -
  • Remote Document Output
    • -
  • 28. Remote Output
    • -
  • 28.1 Commands
    • -
  • 28.2 Configuration
    • -
  • 29. Remote Servers
    • -
  • 30. Quickstart - Getting Started Howto
    • -
  • 30.1 Installation
    • -
  • 30.1.1 Debian Installation
    • -
  • 30.1.2 Rpm Installation
    • -
  • 30.1.3 Installation from Source
    • -
  • 30.2 Testing Sisu, Generating Output
    • -
  • 30.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub
    • -
  • 30.2.2 LaTeX / Pdf
    • -
  • 30.2.3 Relational Database - Postgresql, Sqlite
    • -
  • 30.3 Getting Help
    • -
  • 30.3.1 the Man Pages
    • -
  • 30.3.2 Built in Help
    • -
  • 30.3.3 the Home Page
    • -
  • 30.4 Markup Samples
    • -
  • 31. Editor Files, Syntax Highlighting
    • -
  • 32. How Does Sisu Work?
    • -
  • 33. Summary of Features
    • -
  • 34. Help Sources
    • -
  • 34.1 Man Pages
    • -
  • 34.2 Sisu Generated Output - Links to HTML
    • -
  • 34.2.1 Www.sisudoc.org
    • -
  • 34.3 Man2html
    • -
  • 34.3.1 Locally Installed
    • -
  • 34.3.2 WWW.jus.uio.no/sisu
    • -
  • See Also
    • -
  • Homepage
    • -
  • Author
    • +
  • 9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks
    • +
  • 9.7.1 Line-breaks
    • +
  • 9.7.2 Page Breaks
    • +
  • 9.8 Book Index
    • +
  • 10. Composite Documents Markup
    • +
  • Markup Syntax History
    • +
  • 11. Notes Related to Files-types and Markup Syntax
    • +
  • 12. Sisu Filetypes
    • +
  • 12.1 .sst .ssm .ssi Marked Up Plain Text
    • +
  • 12.1.1 Sisu Text - Regular Files (.sst)
    • +
  • 12.1.2 Sisu Master Files (.ssm)
    • +
  • 12.1.3 Sisu Insert Files (.ssi)
    • +
  • 12.2 Sisupod, Zipped Binary Container (sisupod.zip, .ssp)
    • +
  • 13. Experimental Alternative Input Representations
    • +
  • 13.1 Alternative Xml
    • +
  • 13.1.1 Xml Sax Representation
    • +
  • 13.1.2 Xml Dom Representation
    • +
  • 13.1.3 Xml Node Representation
    • +
  • 14. Configuration
    • +
  • 14.1 Determining the Current Configuration
    • +
  • 14.2 Configuration Files (config.yml)
    • +
  • 15. Skins
    • +
  • 15.1 Document Skin
    • +
  • 15.2 Directory Skin
    • +
  • 15.3 Site Skin
    • +
  • 15.4 Sample Skins
    • +
  • 16. Css - Cascading Style Sheets (for Html, Xhtml and Xml)
    • +
  • 17. Organising Content
    • +
  • 17.1 Directory Structure and Mapping
    • +
  • 18. Homepages
    • +
  • 18.1 Home Page and Other Custom Built Pages in a Sub-directory
    • +
  • 18.2 Home Page Within a Skin
    • +
  • 19. Markup and Output Examples
    • +
  • 19.1 Markup Examples
    • +
  • 20. Sisu Search - Introduction
    • +
  • 21. Sql
    • +
  • 21.1 Populating Sql Type Databases
    • +
  • 22. Postgresql
    • +
  • 22.1 Name
    • +
  • 22.2 Description
    • +
  • 22.3 Synopsis
    • +
  • 22.4 Commands
    • +
  • 22.4.1 Create and Destroy Database
    • +
  • 22.4.2 Import and Remove Documents
    • +
  • 23. Sqlite
    • +
  • 23.1 Name
    • +
  • 23.2 Description
    • +
  • 23.3 Synopsis
    • +
  • 23.4 Commands
    • +
  • 23.4.1 Create and Destroy Database
    • +
  • 23.4.2 Import and Remove Documents
    • +
  • 24. Introduction
    • +
  • 24.1 Search - Database Frontend Sample, Utilising Database and Sisu Features,
    • +
  • 24.2 Search Form
    • +
  • 25. Sisu_webrick
    • +
  • 25.1 Name
    • +
  • 25.2 Synopsis
    • +
  • 25.3 Description
    • +
  • 25.4 Summary of Man Page
    • +
  • 25.5 Document Processing Command Flags
    • +
  • 25.6 Further Information
    • +
  • 25.7 Author
    • +
  • 25.8 See Also
    • +
  • 26. Remote Source Documents
    • +
  • Remote Document Output
    • +
  • 27. Remote Output
    • +
  • 27.1 Commands
    • +
  • 27.2 Configuration
    • +
  • 28. Remote Servers
    • +
  • 29. Quickstart - Getting Started Howto
    • +
  • 29.1 Installation
    • +
  • 29.1.1 Debian Installation
    • +
  • 29.1.2 Rpm Installation
    • +
  • 29.1.3 Installation from Source
    • +
  • 29.2 Testing Sisu, Generating Output
    • +
  • 29.2.1 Basic Text, Plaintext, Html, Xml, Odf, Epub
    • +
  • 29.2.2 LaTeX / Pdf
    • +
  • 29.2.3 Relational Database - Postgresql, Sqlite
    • +
  • 29.3 Getting Help
    • +
  • 29.3.1 the Man Pages
    • +
  • 29.3.2 Built in Help
    • +
  • 29.3.3 the Home Page
    • +
  • 29.4 Markup Samples
    • +
  • 30. Editor Files, Syntax Highlighting
    • +
  • 31. How Does Sisu Work?
    • +
  • 32. Summary of Features
    • +
  • 33. Help Sources
    • +
  • 33.1 Man Pages
    • +
  • 33.2 Sisu Generated Output - Links to HTML
    • +
  • 33.2.1 Www.sisudoc.org
    • +
  • 33.3 Man2html
    • +
  • 33.3.1 Locally Installed
    • +
  • 33.3.2 Www.jus.uio.no/Sisu
    • +
  • See Also
    • +
  • Homepage
    • +
  • Author
    • diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm index c26aeabd..89d8556a 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm @@ -86,8 +86,6 @@ << sisu_search_cgi.ssi -<< sisu_hyperestraier.ssi - << sisu_webrick.sst << sisu_remote.sst diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index 36e1bb9c..a5f380a9 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -208,7 +208,7 @@ see --rsync see --scp !_ --sample-search-form [--webserv=webrick]
    -generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). -Fv (in addition to the above) provides some information on setting up hyperestraier for sisu. Alias -F +generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F !_ --scp [filename/wildcard]
    copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index 65dc4e91..a246d160 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -1108,6 +1108,45 @@ code{# }code +2~ Additional breaks - linebreaks within objects, column and page-breaks + +3~ line-breaks + +To break a line within a "paragraph object", two backslashes \\\\ \\ with a space before and a space or newline after them \\ may be used. + +code{ + +To break a line within a "paragraph object", +two backslashes \\ with a space before +and a space or newline after them \\ +may be used. + +}code + +The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated). + +3~ page breaks + +Page breaks are only relevant and honored in some output formats. A page break or a new page may be inserted manually using the following markup on a line on its own: + +code{ + +<:pb> + +}code + +or + +code{ + +<:pn> + +}code + +page new <:pn> breaks the page, starts a new page. + +page break <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. + 2~ Book index To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. -- cgit v1.2.3