From 7145a299d695326f607595f7fa00c695080109fc Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 21 Dec 2009 11:23:20 -0500 Subject: documentation get paths to reflect directory structure changes --- data/doc/sisu/README | 18 ++++---- data/doc/sisu/v1/html/sisu.1.html | 53 ++++++++++------------ .../sisu_markup_samples/sisu_manual/sisu_doc.sst | 4 +- .../sisu_markup_samples/sisu_manual/sisu_help.sst | 16 +++---- .../sisu_manual/sisu_help_sources.sst | 16 +++---- .../sisu_markup_samples/sisu_manual/sisu_howto.sst | 24 +++++----- .../sisu_manual/sisu_hyperestraier.ssi | 2 - .../sisu_manual/sisu_markup.sst | 2 +- .../sisu_manual/sisu_quickstart.sst | 2 +- .../sisu_markup_samples/sisu_manual/sisu_skin.sst | 6 +-- .../sisu_manual/sisu_syntax_highlighting.sst | 6 +-- .../sisu_markup_samples/sisu_manual/sisu_vim.sst | 4 +- 12 files changed, 69 insertions(+), 84 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/README b/data/doc/sisu/README index 43f84b06..a3f29f7d 100644 --- a/data/doc/sisu/README +++ b/data/doc/sisu/README @@ -91,17 +91,17 @@ Once set up it is simple to use. Within the SiSU tarball: - ./data/doc/sisu/sisu_manual/ + ./data/doc/sisu/v1/sisu_markup_samples/sisu_manual Once installed, directory equivalent to: - + Available man pages are converted back to html using man2html: - + - ./data/doc/sisu/html/ + ./data/doc/sisu/v1/html/ %% Online Information, places to look --------------- @@ -283,7 +283,7 @@ the first document). After installation of sisu-complete, move to the document samples directory - cd /usr/share/doc/sisu/sisu_markup_samples/dfsg + cd /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg and run @@ -424,10 +424,10 @@ and Sample marked up document are provided with the download tarball in the directory: - ./data/doc/sisu/sisu_markup_samples/dfsg + ./data/doc/sisu/v1/sisu_markup_samples/dfsg These are installed on the system usually at: - /usr/share/doc/sisu/sisu_markup_samples/dfsg + /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg More markup samples are available in the package sisu-markup-samples @@ -440,11 +440,11 @@ Many more are available online off: There is syntax support for some editors provided (together with a README file) in - ./data/sisu/conf/syntax + ./data/sisu/v1/conf/editor-syntax-etc usually installed to: - /usr/share/sisu/conf/syntax + /usr/share/sisu/v1/conf/editor-syntax-etc %% License --------------- diff --git a/data/doc/sisu/v1/html/sisu.1.html b/data/doc/sisu/v1/html/sisu.1.html index 301933b2..ea0c304e 100644 --- a/data/doc/sisu/v1/html/sisu.1.html +++ b/data/doc/sisu/v1/html/sisu.1.html @@ -591,9 +591,9 @@ available at:

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/
+

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

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

/usr/share/doc/sisu/v1/sisu_markup_samples/sisu_manual/

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

sisu sisu_manual.ssm
@@ -610,15 +610,16 @@ should be available, try:

Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: -

./data/doc/sisu/sisu_manual/
+

./data/doc/sisu/v1/sisu_markup_samples/sisu_manual

Once installed, directory equivalent to: -

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

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

Available man pages are converted back to html using man2html: -

/usr/share/doc/sisu/html/
+

/usr/share/doc/sisu/v1/html/
-

./data/doc/sisu/html/
+

./data/doc/sisu/v1/html/

An online version of the sisu man page is available here:

* various @@ -659,10 +660,7 @@ see:

man sisu_help_sources

man2html -

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

sisu generated html -

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

/usr/share/doc/sisu/v1/html/sisu.1.html

<http://sisudoc.org/sisu/sisu_help_sources/index.html >
@@ -729,10 +727,10 @@ up files are available as html with syntax highlighting for viewing: < 7.2.2 INSTALLED -

With SiSU installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg +

With SiSU installed sample skins may be found in: /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg (or equivalent directory) and if sisu-markup-samples is installed also under: -

/usr/share/doc/sisu/sisu_markup_samples/non-free +

/usr/share/doc/sisu/v1/sisu_markup_samples/non-free

8. MARKUP OF HEADERS

Headers contain either: semantic meta-data about a document, which can @@ -1951,15 +1949,15 @@ and symbolic links as needed from the site, or dir directories as required.

With SiSU installed sample skins may be found in:

/etc/sisu/skin/doc and
- /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc
+ /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/doc

(or equivalent directory) and if sisu-markup-samples is installed also under: -

/usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc
+

/usr/share/doc/sisu/v1/sisu_markup_samples/non-free/_sisu/skin/doc

Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -

/usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml +

/usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent
directory)
@@ -2399,11 +2397,6 @@ a sample search form for use with the webrick server, which must be copied

man estcmd
-

on sisu_hyperestraier: -

man sisu_hyperestraier
- -

/usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html
-

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

the directory /home/ralph/sisu_www @@ -2745,7 +2738,7 @@ a number of markup sample files may be found either in the directory:

or

change directory to the appropriate one: -

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

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

30.2.1 BASIC TEXT, PLAINTEXT, HTML, XML, ODF

Having moved to the directory @@ -2832,7 +2825,7 @@ sisu home site.

31. EDITOR FILES, SYNTAX HIGHLIGHTING

The directory: -

./data/sisu/conf/editor-syntax-etc/
+

./data/sisu/v1/conf/editor-syntax-etc/

/usr/share/sisu/conf/editor-syntax-etc
@@ -3208,20 +3201,20 @@ html pages[^28]

34.3 MAN2HTML

34.3.1 LOCALLY INSTALLED -

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

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

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

<file:///usr/share/doc/sisu/html/sisu_help_sources.1.html> +

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

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

/usr/share/doc/sisu/html/sisu.1.html
+

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

/usr/share/doc/sisu/html/sisu_pdf.7.html
+

/usr/share/doc/sisu/v1/html/sisu_pdf.7.html
-

/usr/share/doc/sisu/html/sisu_postgresql.7.html
+

/usr/share/doc/sisu/v1/html/sisu_postgresql.7.html
-

/usr/share/doc/sisu/html/sisu_sqlite.7.html
+

/usr/share/doc/sisu/v1/html/sisu_sqlite.7.html
-

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

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

34.3.2 WWW.JUS.UIO.NO/SISU

<http://www.jus.uio.no/sisu/man/sisu.1.html diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_doc.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_doc.sst index e8a6e29e..abfdd514 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_doc.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_doc.sst @@ -53,9 +53,9 @@ Information related to sisu documentation 2~ Description -sisu documentation is installed in /usr/share/doc/sisu/sisu_manual or equivalent directory +sisu documentation is installed in /usr/share/doc/sisu/v1/sisu_markup_samples/sisu_manual or equivalent directory -file:///usr/share/doc/sisu/sisu_manual +file:///usr/share/doc/sisu/v1/sisu_markup_sample/sisu_manual http://www.jus.uio.no/sisu/sisu_manual diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help.sst index 77bab0ad..f6b84ae2 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help.sst @@ -54,9 +54,9 @@ _1 http://sisudoc.org/sisu/sisu_manual/ The manual can be generated from source, found respectively, either within the SiSU tarball or installed locally at: -_1 ./data/doc/sisu/sisu_markup_samples/sisu_manual/ +_1 ./data/doc/sisu/v1/sisu_markup_samples/sisu_manual/ -_1 /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ +_1 /usr/share/doc/sisu/v1/sisu_markup_samples/sisu_manual/ move to the respective directory and type e.g.: @@ -76,7 +76,7 @@ _1 man sisu_commands Most SiSU man pages are generated directly from sisu documents that are used to prepare the sisu manual, the sources files for which are located within the SiSU tarball at: -_1 ./data/doc/sisu/sisu_manual/ +_1 ./data/doc/sisu/v1/sisu_markup_samples/sisu_manual/ Once installed, directory equivalent to: @@ -84,9 +84,9 @@ _1 /usr/share/doc/sisu/sisu_manual/ Available man pages are converted back to html using man2html: -_1 /usr/share/doc/sisu/html/ +_1 /usr/share/doc/sisu/v1/html/ -_1 ./data/doc/sisu/html/ +_1 ./data/doc/sisu/v1/html/ An online version of the sisu man page is available here: @@ -126,10 +126,6 @@ _1 man sisu_help_sources !_ man2html -_1 /usr/share/doc/sisu/sisu_manual/sisu_help_sources/index.html - -!_ sisu generated html - -_1 /usr/share/doc/sisu/html/sisu_help_sources/index.html +_1 /usr/share/doc/sisu/v1/html/sisu.1.html _1 http://sisudoc.org/sisu/sisu_help_sources/index.html diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help_sources.sst index 99b8d492..50368475 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help_sources.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_help_sources.sst @@ -147,21 +147,21 @@ _1 http://sisudoc.org/sisu/sisu_webrick/index.html 3~ locally installed -file:///usr/share/doc/sisu/html/sisu.1.html +file:///usr/share/doc/sisu/v1/html/sisu.1.html -file:///usr/share/doc/sisu/html/sisu_help.1.html +file:///usr/share/doc/sisu/v1/html/sisu_help.1.html -file:///usr/share/doc/sisu/html/sisu_help_sources.1.html +file:///usr/share/doc/sisu/v1/html/sisu_help_sources.1.html -_1 /usr/share/doc/sisu/html/sisu.1.html +_1 /usr/share/doc/sisu/v1/html/sisu.1.html -_1 /usr/share/doc/sisu/html/sisu_pdf.7.html +_1 /usr/share/doc/sisu/v1/html/sisu_pdf.7.html -_1 /usr/share/doc/sisu/html/sisu_postgresql.7.html +_1 /usr/share/doc/sisu/v1/html/sisu_postgresql.7.html -_1 /usr/share/doc/sisu/html/sisu_sqlite.7.html +_1 /usr/share/doc/sisu/v1/html/sisu_sqlite.7.html -_1 /usr/share/doc/sisu/html/sisu_webrick.1.html +_1 /usr/share/doc/sisu/v1/html/sisu_webrick.1.html 3~ www.jus.uio.no/sisu diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_howto.sst index c67208d6..86a0df24 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_howto.sst @@ -139,7 +139,7 @@ aptitude install sisu-sqlite ideally copy the sisu-examples directory to your home directory (because the directory in which you run this example should be writable) -cp -rv /usr/share/sisu-examples/sample/document_samples_sisu_markup ~/. +cp -rv /usr/share/doc/sisu/v1/sisu_markup_samples ~/. !_ (3) use sisu to create an sqlite database @@ -180,7 +180,7 @@ sisu -F webrick the string should be provided as output from the previous command -sudo cp -vi /usr/share/sisu-examples/sample/document_samples_sisu_markup/sisu_sqlite.cgi /usr/lib/cgi-bin +sudo cp -vi /usr/share/sisu/v1/conf/cgi-bin/sisu_sqlite.cgi /usr/lib/cgi-bin sudo chmod -v 755 /usr/lib/cgi-bin/sisu_sqlite.cgi @@ -297,11 +297,11 @@ http://www.jus.uio.no/sisu/SiSU/2#books on untarring the source tarball: -_1 data/sisu-examples/sample/document_samples_sisu_markup/ +_1 data/doc/sisu/v1/sisu_markup_samples or the same once source is installed (or sisu-examples) under: -_1 /usr/share/sisu-examples/sample/document_samples_sisu_markup/ +_1 /usr/share/doc/sisu/v1/sisu_markup_samples Some notes are contained within the man page, *{man sisu}* and within sisu help via the commands *{sisu help markup}* and *{sisu help headers}* @@ -572,7 +572,7 @@ and on installation under: _1 /etc/sisu/skin/doc/ -_1 /usr/share/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc +_1 /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/doc The following paths are searched: @@ -1014,7 +1014,7 @@ the first document). After installation of sisu-complete, move to the document samples directory -_1 cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +_1 cd /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg and run @@ -1165,11 +1165,11 @@ _1 sisu --help headers Sample marked up document are provided with the download tarball in the directory: -_1 ./data/doc/sisu/sisu_markup_samples/dfsg +_1 ./data/doc/sisu/v1/sisu_markup_samples/dfsg These are installed on the system usually at: -_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg +_1 /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg More markup samples are available in the package sisu-markup-samples @@ -1183,11 +1183,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html There is syntax support for some editors provided (together with a README file) in -_1 ./data/sisu/conf/syntax +_1 ./data/sisu/v1/conf/editor-syntax-etc usually installed to: -_1 /usr/share/sisu/conf/syntax +_1 /usr/share/sisu/v1/conf/editor-syntax-etc 2~ License @@ -1231,7 +1231,7 @@ _1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html After installation of sisu-complete, move to the document samples directory, -_1 cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +_1 cd /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg [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 @@ -1303,7 +1303,7 @@ _1 mkdir ~/sisu_test _1 cd ~/sisu_test -_1 cp -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. +_1 cp -a /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/* ~/sisu_test/. !_ Tip: the markup syntax examples may be of interest diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi index 1b97904c..6d8fd33d 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_hyperestraier.ssi @@ -59,8 +59,6 @@ on sisu_hyperestraier: _1 man sisu_hyperestraier -_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html - 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: diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_markup.sst index 053174eb..62c50334 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_markup.sst @@ -99,7 +99,7 @@ an alternative presentation of markup syntax: http://www.jus.uio.no/sisu/sample/ 3~ Installed -With SiSU installed sample skins may be found in: /usr/share/doc/sisu/sisu_markup_samples/dfsg (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/sisu_markup_samples/non-free +With SiSU installed sample skins may be found in: /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/v1/sisu_markup_samples/non-free 1~headers Markup of Headers diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_quickstart.sst index 64a9d690..e9f6372d 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_quickstart.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_quickstart.sst @@ -191,7 +191,7 @@ or change directory to the appropriate one: -cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +cd /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg 3~ basic text, plaintext, html, XML, ODF diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_skin.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_skin.sst index 7c154c4b..b4256039 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_skin.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_skin.sst @@ -92,13 +92,13 @@ A site skin, modifies the program default skin. With SiSU installed sample skins may be found in: -_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc +_1 /etc/sisu/skin/doc and /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/doc (or equivalent directory) and if sisu-markup-samples is installed also under: -_1 /usr/share/doc/sisu/sisu_markup_samples/non-free/_sisu/skin/doc +_1 /usr/share/doc/sisu/v1/sisu_markup_samples/non-free/_sisu/skin/doc Samples of list.yml and promo.yml (which are used to create the right column list) may be found in: -_1 /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) +_1 /usr/share/doc/sisu/v1/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst index 62a16573..5197761c 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_syntax_highlighting.sst @@ -47,9 +47,9 @@ The directory: -_1 ./data/sisu/conf/editor-syntax-etc/ +_1 ./data/sisu/v1/conf/editor-syntax-etc/ -_1 /usr/share/sisu/conf/editor-syntax-etc +_1 /usr/share/sisu/v1/conf/editor-syntax-etc contains rudimentary sisu syntax highlighting files for: @@ -145,7 +145,7 @@ _1 files: sisu-mode.el _1 to file ~/.emacs add the following 2 lines: -_2 (add-to-list 'load-path "/usr/share/sisu-examples/config/syntax_hi") +_2 (add-to-list 'load-path "/usr/share/sisu/v1/conf/editor-syntax-etc/emacs") _2 (require 'sisu-mode.el) diff --git a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_vim.sst b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_vim.sst index 16cbe6af..14257e76 100644 --- a/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_vim.sst +++ b/data/doc/sisu/v1/sisu_markup_samples/sisu_manual/sisu_vim.sst @@ -53,8 +53,6 @@ SiSU has syntax highlighting for a number of editors including vim which are doc _1 man sisu_syntax_highlighting -_1 /usr/share/doc/sisu/sisu_manual/sisu_syntax_highlighting/index.html - _1 http://sisudoc.org/sisu_manual/sisu_syntax_highlighting/index.html _1 http://www.jus.uio.no/sisu/sisu_manual/sisu_syntax_highlighting/index.html @@ -64,7 +62,7 @@ SiSU also provides an ftplugin to provide vim folds for SiSU markup, and to set Vim 7 includes sisu markup syntax highlighting. Vim related files are included in: -/usr/share/sisu/conf/editor-syntax-etc/vim +/usr/share/sisu/v1/conf/editor-syntax-etc/vim (including the syntax highlighter, together with an ftplugin which may be sourced if so desired from your vimrc). sisu-vim actions are activated on files with the suffix .sst .ssm .ssi .-sst ._sst (and the same with a further .meta extension) -- cgit v1.2.3