From 3d67c3ba4610cbe83a45078219a3ac61648406ef Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 25 Sep 2007 03:09:22 +0100 Subject: documentation regenerated --- .../sisu_manual/howto_setup_post_installation.html | 326 ++++++++++----------- 1 file changed, 163 insertions(+), 163 deletions(-) (limited to 'data/doc/manuals_generated/sisu_manual/sisu_manual/howto_setup_post_installation.html') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_manual/howto_setup_post_installation.html b/data/doc/manuals_generated/sisu_manual/sisu_manual/howto_setup_post_installation.html index 1a677d08..39b781ac 100644 --- a/data/doc/manuals_generated/sisu_manual/sisu_manual/howto_setup_post_installation.html +++ b/data/doc/manuals_generated/sisu_manual/sisu_manual/howto_setup_post_installation.html @@ -23,7 +23,7 @@ - + @@ -192,7 +192,7 @@  

-   1925 +   1927

@@ -205,78 +205,56 @@
-

+

43. Post Installation Setup

-   1926 +   1928

- + 43.1 Post Installation Setup - Quick start
- + 43.2 Document markup directory
- + 43.2.1 Configuration files
- + 43.2.2 Debian INSTALLATION Note
- + 43.2.3 Document Resource Configuration
- + 43.2.4 Skins
-
-

+

43.1 Post Installation Setup - Quick start

-   1927 -

-
- - -
-

- After installation of sisu-complete, move to the document samples directory, -

-		 -

-   1928 -

-
- -
-

- cd /usr/share/doc/sisu/sisu_markup_samples/dfsg -

-		 -

  1929

- [this is not where you would normally work but provides sample documents for testing, you may prefer instead to copy the contents of that directory to a local directory before proceeding] + After installation of sisu-complete, move to the document samples directory,

@@ -286,8 +264,8 @@
-

- and in that directory, initialise the output directory with the command +

+ cd /usr/share/doc/sisu/sisu_markup_samples/dfsg

@@ -297,8 +275,8 @@
-

- sisu -CC +

+ [this is not where you would normally work but provides sample documents for testing, you may prefer instead to copy the contents of that directory to a local directory before proceeding]

@@ -309,7 +287,7 @@

- then run: + and in that directory, initialise the output directory with the command

@@ -320,7 +298,7 @@

- sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst + sisu -CC

@@ -331,7 +309,7 @@

- or the same: + then run:

@@ -342,7 +320,7 @@

- sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst + sisu -1 free_as_in_freedom.rms_and_free_software.sam_williams.sst

@@ -353,7 +331,7 @@

- look at output results, see the "sisu_manifest" page created for the document + or the same:

@@ -363,8 +341,8 @@
-

- for an overview of your current sisu setup, type: +

+ sisu -NhwpoabxXyv free_as_in_freedom.rms_and_free_software.sam_williams.sst

@@ -374,8 +352,8 @@
-

- sisu --help env +

+ look at output results, see the "sisu_manifest" page created for the document

@@ -386,7 +364,7 @@

- or + for an overview of your current sisu setup, type:

@@ -397,7 +375,7 @@

- sisu -V + sisu --help env

@@ -408,7 +386,7 @@

- To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g. + or

@@ -419,7 +397,7 @@

- sisu -1 <http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst> + sisu -V

@@ -429,8 +407,8 @@
-

- sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst> +

+ To generate a document from a remote url accessible location move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g.

@@ -440,8 +418,8 @@
-

- examine source document, vim has syntax highlighting support +

+ sisu -1 <http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst>

@@ -451,8 +429,8 @@
-

- gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst +

+ sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst>

@@ -463,7 +441,7 @@

- additional markup samples in + examine source document, vim has syntax highlighting support

@@ -473,8 +451,8 @@
-

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

+ gvim free_as_in_freedom.rms_and_free_software.sam_williams.sst

@@ -485,7 +463,7 @@

- it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely. + additional markup samples in

@@ -496,7 +474,7 @@

- sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip> + <http://www.jus.uio.no/sisu/SiSU/2.html>

@@ -507,7 +485,7 @@

- there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended: + it should also be possible to run sisu against sisupods (prepared zip files, created by running the command sisu -S [filename]), whether stored locally or remotely.

@@ -518,7 +496,7 @@

- sisu -3 --trust <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip> + sisu -3 <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip>

@@ -529,7 +507,7 @@

- For help + there is a security issue associated with the running of document skins that are not your own, so these are turned of by default, and the use of the following command, which switches on the associated skin is not recommended:

@@ -540,7 +518,7 @@

- man sisu + sisu -3 --trust <http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/sisupod.zip>

@@ -550,8 +528,8 @@
-

- sisu --help +

+ For help

@@ -562,7 +540,7 @@

- sisu --help env for the way sisu "sees/maps" your system + man sisu

@@ -573,7 +551,7 @@

- sisu --help commands for list of commands and so on + sisu --help

@@ -583,20 +561,19 @@
- -

- 43.2 Document markup directory +

+ sisu --help env for the way sisu "sees/maps" your system

-

+

  1958

-

- Perhaps the easiest way to begin is to create a directory for sisu marked up documents within your home directory, and copy the file structure (and document samples) provided in the document sample directory: +

+ sisu --help commands for list of commands and so on

@@ -606,19 +583,20 @@
-

- mkdir ~/sisu_test + +

+ 43.2 Document markup directory

-

+

  1960

-

- cd ~/sisu_test +

+ Perhaps the easiest way to begin is to create a directory for sisu marked up documents within your home directory, and copy the file structure (and document samples) provided in the document sample directory:

@@ -629,7 +607,7 @@

- cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. + mkdir ~/sisu_test

@@ -639,8 +617,8 @@
-

- Tip: the markup syntax examples may be of interest +

+ cd ~/sisu_test

@@ -651,7 +629,7 @@

- <http://www.jus.uio.no/sisu/sample/> + cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/.

@@ -662,7 +640,7 @@

- Tip: + Tip: the markup syntax examples may be of interest

@@ -673,7 +651,7 @@

- sisu -U [sisu markup filename] + <http://www.jus.uio.no/sisu/sample/>

@@ -684,7 +662,7 @@

- should printout the different possible outputs and where sisu would place them. + Tip:

@@ -694,8 +672,8 @@
-

- Tip: if you want to toggle ansi color add +

+ sisu -U [sisu markup filename]

@@ -705,8 +683,8 @@
-

- c +

+ should printout the different possible outputs and where sisu would place them.

@@ -717,7 +695,7 @@

- to your flags. + Tip: if you want to toggle ansi color add

@@ -727,20 +705,19 @@
- -

- 43.2.1 Configuration files +

+ c

-

+

  1971

- SiSU configuration file search path is: + to your flags.

@@ -750,19 +727,20 @@
-

- ./_sisu/sisurc.yaml + +

+ 43.2.1 Configuration files

-

+

  1973

-

- ~/.sisu/sisurc.yaml +

+ SiSU configuration file search path is:

@@ -773,7 +751,7 @@

- /etc/sisu/sisurc.yaml + ./_sisu/sisurc.yaml

@@ -783,8 +761,8 @@
-

- .\"%% Debian Installation Note +

+ ~/.sisu/sisurc.yaml

@@ -794,20 +772,19 @@
- -

- 43.2.2 Debian INSTALLATION Note +

+ /etc/sisu/sisurc.yaml

-

+

  1977

- It is best you see + .\"%% Debian Installation Note

@@ -817,19 +794,20 @@
-

- <http://www.jus.uio.no/sisu/SiSU/download.html#debian> + +

+ 43.2.2 Debian INSTALLATION Note

-

+

  1979

- for up the most up to date information. + It is best you see

@@ -839,8 +817,8 @@
-

- notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU): +

+ <http://www.jus.uio.no/sisu/SiSU/download.html#debian>

@@ -851,7 +829,7 @@

- Package: sisu + for up the most up to date information.

@@ -862,7 +840,7 @@

- SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections. + notes taken from the Debian control file (end edited), gives an idea of additional packages that SiSU can make use of if available, (the use/requirement of some of which are interdependent for specific actions by SiSU):

@@ -873,7 +851,7 @@

- With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs also share semantic meta-data provided. + Package: sisu

@@ -884,7 +862,7 @@

- SiSU also provides concordance files, document content certificates and manifests of generated output. + SiSU is a lightweight markup based, command line oriented, document structuring, publishing and search framework for document collections.

@@ -895,7 +873,7 @@

- A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided, as are syntax highlighting files for kate, kwrite, gedit and diakonos. Vim 7 includes syntax highlighting for SiSU. + With minimal preparation of a plain-text, (UTF-8) file, using its native markup syntax in your text editor of choice, SiSU can generate various document formats (most of which share a common object numbering system for locating content), including plain text, HTML, XHTML, XML, OpenDocument text (ODF:ODT), LaTeX, PDF files, and populate an SQL database with objects (roughly paragraph-sized chunks) so searches may be performed and matches returned with that degree of granularity: your search criteria is met by these documents and at these locations within each document. Object numbering is particularly suitable for "published" works (finalized texts as opposed to works that are frequently changed or updated) for which it provides a fixed means of reference of content. Document outputs also share semantic meta-data provided.

@@ -906,7 +884,7 @@

- man pages, and interactive help are provided. + SiSU also provides concordance files, document content certificates and manifests of generated output.

@@ -917,7 +895,7 @@

- Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. + A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided, as are syntax highlighting files for kate, kwrite, gedit and diakonos. Vim 7 includes syntax highlighting for SiSU.

@@ -928,7 +906,7 @@

- Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher. + man pages, and interactive help are provided.

@@ -939,7 +917,7 @@

- Homepage: <http://www.jus.uio.no/sisu> + Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU.

@@ -949,20 +927,19 @@
- -

- 43.2.3 Document Resource Configuration +

+ Additional document markup samples are provided in the package sisu-markup-samples which is found in the non-free archive the licenses for the substantive content of the marked up documents provided is that provided by the author or original publisher.

-

+

  1991

- sisu resource configuration information is obtained from sources (where they exist): + Homepage: <http://www.jus.uio.no/sisu>

@@ -972,19 +949,20 @@
-

- ~/.sisu/sisurc.yaml + +

+ 43.2.3 Document Resource Configuration

-

+

  1993

-

- /etc/sisu/[sisu version]/sisurc.yaml +

+ sisu resource configuration information is obtained from sources (where they exist):

@@ -995,7 +973,7 @@

- sisu program defaults + ~/.sisu/sisurc.yaml

@@ -1005,20 +983,19 @@
- -

- 43.2.4 Skins +

+ /etc/sisu/[sisu version]/sisurc.yaml

-

+

  1996

-

- Skins default document appearance may be modified using skins contained in sub-directories located at the following paths: +

+ sisu program defaults

@@ -1028,19 +1005,20 @@
-

- ./_sisu/skin + +

+ 43.2.4 Skins

-

+

  1998

-

- ~/.sisu/skin +

+ Skins default document appearance may be modified using skins contained in sub-directories located at the following paths:

@@ -1051,7 +1029,7 @@

- /etc/sisu/skin + ./_sisu/skin

@@ -1061,8 +1039,8 @@
-

- more specifically, the following locations (or their /etc/sisu equivalent) should be used: +

+ ~/.sisu/skin

@@ -1073,7 +1051,7 @@

- ~/.sisu/skin/doc + /etc/sisu/skin

@@ -1084,7 +1062,7 @@

- skins for individual documents; + more specifically, the following locations (or their /etc/sisu equivalent) should be used:

@@ -1095,7 +1073,7 @@

- ~/.sisu/skin/dir + ~/.sisu/skin/doc

@@ -1106,7 +1084,7 @@

- skins for directories of matching names; + skins for individual documents;

@@ -1117,7 +1095,7 @@

- ~/.sisu/skin/site + ~/.sisu/skin/dir

@@ -1128,7 +1106,7 @@

- site-wide skin modifying the site-wide appearance of documents. + skins for directories of matching names;

@@ -1138,8 +1116,8 @@
-

- Usually all skin files are placed in the document skin directory: +

+ ~/.sisu/skin/site

@@ -1149,8 +1127,8 @@
-

- ~/.sisu/skin/doc +

+ site-wide skin modifying the site-wide appearance of documents.

@@ -1161,7 +1139,7 @@
+

- with softlinks being made to the skins contained there from other skin directories as required. + Usually all skin files are placed in the document skin directory:

@@ -1169,6 +1147,28 @@   2010

+ + +
+

+ ~/.sisu/skin/doc +

+		 +

+   2011 +

+
+ +
+

+ with softlinks being made to the skins contained there from other skin directories as required. +

+		 +

+   2012 +

+

^

 
@@ -1301,7 +1301,7 @@ SiSU - 0.59.0 2007-09-23 (2007w38/0) + 0.59.1 2007-09-25 (2007w39/2)
SiSU -- cgit v1.2.3