From 640d12c3676ede35f52427192a56e9736ae3d1d0 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 12 Oct 2007 20:19:17 +0100 Subject: sisu manual and man page update --- data/doc/sisu/html/sisu.1.html | 375 ++++++--------------- .../sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb | 3 + .../sisu_manual/sisu_commands.sst | 2 +- 3 files changed, 116 insertions(+), 264 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index b34bac56..bea9e725 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -560,26 +560,28 @@ changed/configured in the sisurc.yml file):

verbose output

-5.0.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING -

In the -data directory run sisu -mh filename or wildcard eg. cisg.sst documents. -

-Running sisu (alone without any flags, filenames or wildcards) brings up -the interactive help, as does any sisu command that is not recognised. Enter -to escape. -

6. HELP +5.1 COMMAND LINE WITH FLAGS - BATCH PROCESSING +

In the data +directory run sisu -mh filename or wildcard eg. cisg.sst documents. +

Running +sisu (alone without any flags, filenames or wildcards) brings up the interactive +help, as does any sisu command that is not recognised. Enter to escape. +

+6. HELP

6.1 SISU MANUAL -

The most up to date information on -sisu should be contained in the sisu_manual, available at: -

<http://www.jus.uio.no/sisu/sisu_manual/ +

The most up to date information on sisu should +be contained in the sisu_manual, available at: +

<http://sisudoc.org/sisu/sisu_manual/ >
-

and (from SiSU 0.59 onwards) installed locally at: -

/usr/share/doc/sisu/sisu_manual/
+

The manual can be generated from source, found respectively, either +within the SiSU tarball or installed locally at: +

./data/doc/sisu/sisu_markup_samples/sisu_manual/
-

or equivalent directory -

Within the SiSU tarball at: -

./data/doc/sisu/sisu_manual/
+

/usr/share/doc/sisu/sisu_markup_samples/sisu_manual/
+ +

move to the respective directory and type e.g.: +

sisu sisu_manual.ssm

6.2 SISU MAN PAGES

If SiSU is installed on your system usual man commands @@ -647,10 +649,7 @@ see:

sisu generated html

/usr/share/doc/sisu/html/sisu_help_sources/index.html
-

<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html +

<http://sisudoc.org/sisu/sisu_help_sources/index.html >

7. INTRODUCTION TO SISU MARKUP[^9] @@ -690,7 +689,7 @@ as code

7.2.1 ONLINE

Online markup examples are available together with the respective outputs produced from -<http://www.jus.uio.no/sisu/SiSU/2.html +<http://www.jus.uio.no/sisu/SiSU/examples.html > or from <http://www.jus.uio.no/sisu/sisu_examples/ > @@ -756,7 +755,7 @@ documents that request them, all documents in a directory, or be site-wide. (A document is affected by a single skin) @bold: /Gnu|Debian|Ruby|SiSU/ @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html + { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/ { SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/ @@ -845,41 +844,35 @@ pg=[Project  Gutenberg  text  number]

@prefix_b:

@rcs: $Id: sisu_markup.sst,v 1.2 2007/09/08 17:12:47 ralph Exp $  [used  by  rcs  or  cvs - to  embed  version  (revision  control)  information  into under ./_sisu/skin -~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request -them, all documents in a directory, or be site-wide. (A document is affected -by a single skin) document,  rcs  or  cvs  can  usefully  provide  a  history  of -under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single -documents that request them, all documents in a directory, or be site-wide. -(A document is affected by a single skin) updates  to  a  document  ] -

@structure: -PART; CHAPTER; SECTION; ARTICLE; none; none; optional, document structure -can be defined by words to match or regular expression (the regular expression -is assumed to start at the beginning of a line of text i.e. ^) default markers -:A~ to :C~ and 1~ to 6~ can be used within text instead, without this header -tag, and may be used to supplement the instructions provided in this header -tag if provided (@structure: is a synonym for @toc:) -

@level: newpage=3; -breakpage=4  [paragraph  level,  used  by  latex  to  breakpages,  the  page  in - newpage] -

@markup: information on the markup used, e.g. new=1,2,3; break=4; -num_top=4  [or newpage=1,2,3;  breakpage=4;  num_top=4] newpage and breakpage, -heading level, used by LaTeX to breakpages. breakpage: starts on a new page -in single column text and on a new column in double column text; newpage: -starts on a new page for both single and double column texts. num_top=4 - [auto-number  document,  starting  at  level  4.  the new default  is  to  provide - 3  levels,  as  in  1  level  4,  1.1  1.1.1  level  6,  markup  to  be  merged  within  level] -num_extract  [take  numbering  of  headings  provided  (manually  in  and  use - for  numbering  of  Available  where  a  clear  numbering  structure  is  without - the  repetition  of  a  number in  a  header.]  [In  0.38  notation,  you  would  map - to  the equivalent  levels,  the  examples  provided  would  map  to  the following - new=A,B,C;  break=1;  num_top=1   [or  newpage=A,B,C; breakpage=1;  num_top=1] -see headings] -

@bold:  [regular  expression  of  words/phrases  to  be  made - bold] -

@italics:  [regular  expression  of  words/phrases  to  italicise] -

-@vocabulary: name of taxonomy/vocabulary/wordlist to use against document + to  embed  version  (revision  control)  information  into  rcs  or  cvs  can  usefully + provide  a  history  of +

@structure: PART; CHAPTER; SECTION; ARTICLE; none; +none; optional, document structure can be defined by words to match or +regular expression (the regular expression is assumed to start at the beginning +of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used +within text instead, without this header tag, and may be used to supplement +the instructions provided in this header tag if provided (@structure: is +a synonym for @toc:) +

@level: newpage=3; breakpage=4  [paragraph  level, + used  by  latex  to  breakpages,  the  page  in  newpage] +

@markup: information +on the markup used, e.g. new=1,2,3; break=4; num_top=4  [or newpage=1,2,3; + breakpage=4;  num_top=4] newpage and breakpage, heading level, used by LaTeX +to breakpages. breakpage: starts on a new page in single column text and +on a new column in double column text; newpage: starts on a new page for +both single and double column texts. num_top=4  [auto-number  document,  starting + at  level  4.  the new default  is  to  provide  3  levels,  as  in  1  level  4,  1.1 + 1.1.1  level  6,  markup  to  be  merged  within  level] num_extract  [take  numbering + of  headings  provided  (manually  in  and  use  for  numbering  of  Available  where + a  clear  numbering  structure  is  without  the  repetition  of  a  number in  a + header.]  [In  0.38  notation,  you  would  map  to  the equivalent  levels,  the  examples + provided  would  map  to  the following  new=A,B,C;  break=1;  num_top=1   [or  newpage=A,B,C; +breakpage=1;  num_top=1] see headings] +

@bold:  [regular  expression  of  words/phrases + to  be  made  bold] +

@italics:  [regular  expression  of  words/phrases  to  italicise] + +

@vocabulary: name of taxonomy/vocabulary/wordlist to use against document

@skin: skin_doc_[name_of_desired_document_skin] skins change default settings related to the appearance of documents generated, such as the @@ -2082,7 +2075,7 @@ index.html

19. MARKUP AND OUTPUT EXAMPLES

19.1 MARKUP EXAMPLES

Current markup examples -and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/2.html +and document output samples are provided at <http://www.jus.uio.no/sisu/SiSU/examples.html >

Some markup with syntax highlighting may be found under <http://www.jus.uio.no/sisu/sample/syntax @@ -2553,39 +2546,39 @@ parts (such as images) will be downloaded and generated locally.

  sisu -3 http://[provide  url  to  valid  .sst  or  .ssm  file]
 

Any of the source documents in the sisu examples page can be used in -this way, see <http://www.jus.uio.no/sisu/SiSU/2.html -> and use the url for the -desired document. -

NOTE: to set up a remote machine to serve SiSU documents -in this way, images should be in the directory relative to the document +this way, see <http://www.jus.uio.no/sisu/SiSU/examples.html +> and use the url +for the desired document. +

NOTE: to set up a remote machine to serve SiSU +documents in this way, images should be in the directory relative to the -

source ../_sisu/image +

document source ../_sisu/image

sisupod - zipped sisu files -

A sisupod is the zipped -content of a sisu marked up text or texts and any other associated parts -to the document such as images. -

SiSU can be run against a sisupod on a -(local or) remote machine, provide the processing instruction and the url, -the sisupod will be downloaded and the documents it contains generated +

A sisupod is +the zipped content of a sisu marked up text or texts and any other associated +parts to the document such as images. +

SiSU can be run against a sisupod +on a (local or) remote machine, provide the processing instruction and +the url, the sisupod will be downloaded and the documents it contains generated locally.


  sisu -3 http://[provide  url  to  valid  sisupod.zip  or  .ssp  file]
 

Any of the source documents in the sisu examples page can be used in -this way, see <http://www.jus.uio.no/sisu/SiSU/2.html -> and use the url for the -desired document. +this way, see <http://www.jus.uio.no/sisu/SiSU/examples.html +> and use the url +for the desired document.

REMOTE DOCUMENT OUTPUT

28. REMOTE OUTPUT -

Once properly -configured SiSU output can be automatically posted once generated to a -designated remote machine using either rsync, or scp. -

In order to do this -some ssh authentication agent and keychain or similar tool will need to -be configured. Once that is done the placement on a remote host can be done -seamlessly with the -r (for scp) or -R (for rsync) flag, which may be used -in conjunction with other processing flags, e.g. +

+Once properly configured SiSU output can be automatically posted once generated +to a designated remote machine using either rsync, or scp. +

In order to +do this some ssh authentication agent and keychain or similar tool will +need to be configured. Once that is done the placement on a remote host +can be done seamlessly with the -r (for scp) or -R (for rsync) flag, which +may be used in conjunction with other processing flags, e.g.


  sisu -3R sisu_remote.sst
@@ -2833,7 +2826,7 @@ to date as within the package itself:
 

30.4 MARKUP SAMPLES

A number of markup samples (along with output) are available off: -

<http://www.jus.uio.no/sisu/SiSU/2.html +

<http://www.jus.uio.no/sisu/SiSU/examples.html >

Additional markup samples are packaged separately in the file: @@ -3105,18 +3098,11 @@ following:

man sisu_help

man2html -

<file:///usr/share/doc/sisu/html/sisu_help.1.html>
-

<http://www.jus.uio.no/sisu/man/sisu_help.1.html >

sisu generated output - links to html -

<file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html>
- -

<http://sisudoc.org/sisu_manual/sisu_help/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html +

<http://sisudoc.org/sisu/sisu_help/index.html >

help sources lists @@ -3124,14 +3110,7 @@ following: listed here:

man sisu_help_sources
-

<file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html>
- -

<file:///usr/share/doc/sisu/html/sisu_help_sources/index.html>
- -

<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html +

<http://sisudoc.org/sisu/sisu_help_sources/index.html >

34.1 MAN PAGES @@ -3155,182 +3134,83 @@ listed here: prepared in SiSU and output is available in multiple formats including amongst others html, pdf, and odf which may be also be accessed via the html pages[^28] -

34.2.1 LOCALLY INSTALLED -

<file:///usr/share/doc/sisu/sisu_manual/sisu_manual/index.html> - -

<file:///usr/share/doc/sisu/sisu_manual/sisu_help/index.html> -

<file:///usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html> - -

/usr/share/doc/sisu/sisu_manual/sisu/index.html
- -

/usr/share/doc/sisu/sisu_manual/sisu_complete/index.html
- -

/usr/share/doc/sisu/sisu_manual/sisu_pdf/index.html
- -

/usr/share/doc/sisu/sisu_manual/sisu_postgresql/index.html
- -

/usr/share/doc/sisu/sisu_manual/sisu_sqlite/index.html
- -

/usr/share/doc/sisu/sisu_manual/sisu_termsheet/index.html
- -

/usr/share/doc/sisu/sisu_manual/sisu_webrick/index.html
- -

34.2.2 WWW.SISUDOC.ORG -

<http://sisudoc.org/sisu_manual/sisu_manual/index.html +

34.2.1 WWW.SISUDOC.ORG +

<http://sisudoc.org/sisu/sisu_manual/index.html > -

<http://sisudoc.org/sisu_manual/sisu/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_commands/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_complete/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_configuration/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_description/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_examples/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_faq/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_filetypes/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_help/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_help_sources/index.html ->
- -

<http://sisudoc.org/sisu_manual/sisu_howto/index.html +

<http://sisudoc.org/sisu/sisu_manual/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_introduction/index.html +

<http://sisudoc.org/sisu/sisu_commands/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_manual/index.html +

<http://sisudoc.org/sisu/sisu_complete/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_markup/index.html +

<http://sisudoc.org/sisu/sisu_configuration/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_output_overview/index.html +

<http://sisudoc.org/sisu/sisu_description/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_pdf/index.html +

<http://sisudoc.org/sisu/sisu_examples/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_postgresql/index.html +

<http://sisudoc.org/sisu/sisu_faq/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_quickstart/index.html +

<http://sisudoc.org/sisu/sisu_filetypes/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_remote/index.html +

<http://sisudoc.org/sisu/sisu_help/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_search/index.html +

<http://sisudoc.org/sisu/sisu_help_sources/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_skin/index.html +

<http://sisudoc.org/sisu/sisu_howto/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_sqlite/index.html +

<http://sisudoc.org/sisu/sisu_introduction/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html +

<http://sisudoc.org/sisu/sisu_manual/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_vim/index.html +

<http://sisudoc.org/sisu/sisu_markup/index.html >
-

<http://sisudoc.org/sisu_manual/sisu_webrick/index.html +

<http://sisudoc.org/sisu/sisu_output_overview/index.html >
-

34.2.3 WWW.JUS.UIO.NO/SISU -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html -> - -

<http://www.jus.uio.no/sisu/sisu_manual/sisu/index.html +

<http://sisudoc.org/sisu/sisu_pdf/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_commands/index.html +

<http://sisudoc.org/sisu/sisu_postgresql/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_complete/index.html +

<http://sisudoc.org/sisu/sisu_quickstart/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_configuration/index.html +

<http://sisudoc.org/sisu/sisu_remote/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_description/index.html +

<http://sisudoc.org/sisu/sisu_search/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_examples/index.html +

<http://sisudoc.org/sisu/sisu_skin/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_faq/index.html +

<http://sisudoc.org/sisu/sisu_sqlite/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_filetypes/index.html +

<http://sisudoc.org/sisu/sisu_syntax_highlighting/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_help/index.html +

<http://sisudoc.org/sisu/sisu_vim/index.html >
-

<http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_howto/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_introduction/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_manual/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_markup/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_output_overview/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_pdf/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_postgresql/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_quickstart/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_remote/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_search/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_skin/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_sqlite/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_vim/index.html ->
- -

<http://www.jus.uio.no/sisu/sisu_manual/sisu_webrick/index.html +

<http://sisudoc.org/sisu/sisu_webrick/index.html >

34.3 MAN2HTML @@ -3350,40 +3230,9 @@ html pages[^28]

/usr/share/doc/sisu/html/sisu_webrick.1.html
-

34.3.2 WWW.SISUDOC.ORG -

<http:///sisudoc.org/man/sisu_manual.1.html -> -

<http:///sisudoc.org/man/sisu_help.1.html -> - -

<http:///sisudoc.org/man/sisu_help_sources.1.html -> -

<http://sisudoc.org/man/sisu.1.html ->
- -

<http://sisudoc.org/man/sisu_complete.7.html ->
- -

<http://sisudoc.org/man/sisu_pdf.7.html ->
- -

<http://sisudoc.org/man/sisu_postgresql.7.html ->
- -

<http://sisudoc.org/man/sisu_sqlite.7.html ->
- -

<http://sisudoc.org/man/sisu_webrick.1.html ->
- -

34.3.3 WWW.JUS.UIO.NO/SISU +

34.3.2 WWW.JUS.UIO.NO/SISU

<http://www.jus.uio.no/sisu/man/sisu.1.html > -

<http://www.jus.uio.no/sisu/man/sisu_help.1.html -> - -

<http://www.jus.uio.no/sisu/man/sisu_help_sources.1.html ->

<http://www.jus.uio.no/sisu/man/sisu.1.html >
@@ -3428,15 +3277,15 @@ Type: information

Filetype: SiSU text insert

0.58 -

Sourcefile Digest, MD5(sisu._sst)= 7d1c79519108da1773a33367e1eba6b5 +

Sourcefile Digest, MD5(sisu._sst)= 8aad6597f7572baae4f0ef75999e5b4f -

Skin_Digest: MD5(skin_sisu_manual.rb)= 20fc43cf3eb6590bc3399a1aef65c5a9 +

Skin_Digest: MD5(skin_sisu_manual.rb)= 072b2584bedea82ea8a416587b9fa244

Generated -

Document (metaverse) last generated: Sat Sep 29 17:05:37 +

Document (metaverse) last generated: Fri Oct 12 20:14:00

+0100 2007 -

Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25) +

Generated by: SiSU 0.61.0 of 2007w41/1 (2007-10-08)

Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36)  [i486-linux]

@@ -3554,15 +3403,15 @@ distributable are not freely changeable. .

  • named index.html or mo
    -
    * Generated by: SiSU 0.59.1 of 2007w39/2 (2007-09-25)
    +
    * Generated by: SiSU 0.61.0 of 2007w41/1 (2007-10-08)
    * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux]
    -
    * Last Generated on: Sat Sep 29 -17:05:38 +0100 2007
    +
    * Last Generated on: Fri Oct 12 +20:14:00 +0100 2007
    * SiSU http://www.jus.uio.no/sisu diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb index 4a2b0011..92ee2b34 100644 --- a/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/_sisu/skin/doc/skin_sisu_manual.rb @@ -21,6 +21,9 @@ module SiSU_Viz #['sisu_manual_search','sisu_manual'] #['sisu','ruby','sisu_search_libre','ruby','open_society'] end + #def ocn_display_off + # false + #end #% path def path_root './sisu/' # the only parameter that cannot be changed here diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst index 8b339c4d..d8cd48cb 100644 --- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_commands.sst @@ -257,7 +257,7 @@ add -v for verbose mode and -c for color, e.g. sisu -2vc [filename or wildcard] consider -u for appended url info or -v for verbose output -3~ Command Line with Flags - Batch Processing +2~ Command Line with Flags - Batch Processing In the data directory run sisu -mh filename or wildcard eg. "sisu -h cisg.sst" or "sisu -h *.{sst,ssm}" to produce html version of all documents. -- cgit v1.2.3