From a6042b05a924c8794fa44e67b9702db63615848d Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 10 Mar 2011 09:05:55 -0500 Subject: documentation more link fixes (remove redundant), remove repeated skin --- data/doc/sisu/CHANGELOG_v2 | 2 ++ data/doc/sisu/CHANGELOG_v3 | 2 ++ .../sisu_manual/_sisu/skin/dir/skin_sisu.rb | 1 - data/doc/sisu/markup-samples/sisu_manual/sisu.ssm | 2 +- .../markup-samples/sisu_manual/sisu_download.ssi | 4 --- .../sisu/markup-samples/sisu_manual/sisu_help.sst | 16 ----------- .../sisu_manual/sisu_help_sources.sst | 32 +++------------------- .../sisu/markup-samples/sisu_manual/sisu_howto.sst | 14 +++++----- .../sisu_manual/sisu_hyperestraier.ssi | 2 +- .../markup-samples/sisu_manual/sisu_markup.sst | 28 +++++++++---------- .../markup-samples/sisu_manual/sisu_quickstart.sst | 2 +- 11 files changed, 31 insertions(+), 74 deletions(-) delete mode 120000 data/doc/sisu/markup-samples/sisu_manual/_sisu/skin/dir/skin_sisu.rb (limited to 'data/doc') diff --git a/data/doc/sisu/CHANGELOG_v2 b/data/doc/sisu/CHANGELOG_v2 index 330a1cbc..3751d9dc 100644 --- a/data/doc/sisu/CHANGELOG_v2 +++ b/data/doc/sisu/CHANGELOG_v2 @@ -46,6 +46,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.2.orig.tar.gz * help (markup): correct path to markup-samples + * documentation more link fixes + %% 2.8.1.orig.tar.gz (2011-03-05:09/6) http://www.jus.uio.no/sisu/pkg/src/sisu_2.8.1.orig.tar.gz sisu_2.8.1.orig.tar.gz diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index bd0cca64..e60a8ec3 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -51,6 +51,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.3.orig.tar.gz * help (markup): correct path to markup-samples + * documentation more link fixes + %% 3.0.2.orig.tar.gz (2011-03-05:09/6) http://git.sisudoc.org/?p=code/sisu.git;a=shortlog;h=refs/tags/debian/3.0.2-1 http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.2.orig.tar.gz diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/skin/dir/skin_sisu.rb b/data/doc/sisu/markup-samples/sisu_manual/_sisu/skin/dir/skin_sisu.rb deleted file mode 120000 index 77ee1e13..00000000 --- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/skin/dir/skin_sisu.rb +++ /dev/null @@ -1 +0,0 @@ -../doc/skin_sisu.rb \ No newline at end of file diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm index 64debc90..c26aeabd 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm @@ -19,7 +19,7 @@ :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 - :modified: 2011-03-04 + :modified: 2011-03-09 @make: :num_top: 1 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi index 2dc2462c..e028a3cf 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi @@ -116,8 +116,6 @@ For changelogs see: _1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html -_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html - 3~rpm- RPM The RPM is generated from the source file using Alien.~{ http://www.kitenet.net/programs/alien/ }~ Dependencies are not handled, not even that of the essential Ruby. @@ -131,5 +129,3 @@ _* {~^ sisu-markup-samples_2.0.3.orig-2.noarch.rpm }http://www.jus.uio.no/sisu/p For changelogs see: _1 http://www.jus.uio.no/sisu/SiSU/changelog_markup_samples.html - -_1 http://www.jus.uio.no/sisu/sisu_markup_samples_changelog/changelog_markup_samples.html diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst index 4f273f4a..6c824da8 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst @@ -72,10 +72,6 @@ If SiSU is installed on your system usual man commands should be available, try: _1 man sisu -_1 man sisu_markup - -_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/markup-samples/sisu_manual @@ -117,15 +113,3 @@ _1 sisu (on its own provides version and some help information) Apart from real-time information on your current configuration the SiSU manual and man pages are likely to contain more up-to-date information than the sisu interactive help (for example on commands and markup). NOTE: Running the command 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. - -2~ Help Sources - -For lists of alternative help sources, see: - -!_ man page - -_1 man sisu_help_sources - -!_ man2html - -_1 /usr/share/doc/sisu/html/sisu.1.html diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst index 2cf2ba10..69a905f2 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst @@ -47,32 +47,8 @@ 1~help_sources Help Sources -For a summary of alternative ways to get help on SiSU try one of the following: - -!_ man page - -_1 man sisu_help - -!_ man2html - -_1 http://www.jus.uio.no/sisu/man/sisu_help.1.html - -!_ sisu generated output - links to html - -_1 http://sisudoc.org/sisu/sisu_help/index.html - -!_ help sources lists - -Alternative sources for this help sources page listed here: - -_1 man sisu_help_sources - -_1 http://sisudoc.org/sisu/sisu_help_sources/index.html - 2~ man pages -3~ man - _1 man sisu _1 man sisu-concordance @@ -127,13 +103,13 @@ file:///usr/share/doc/sisu/html/sisu.1.html _1 file:///usr/share/doc/sisu/html/sisu.1.html -_1 file:///usr/share/doc/sisu/html/sisu_pdf.7.html +_1 /usr/share/doc/sisu/html/sisu_pdf.7.html -_1 file:///usr/share/doc/sisu/html/sisu_postgresql.7.html +_1 /usr/share/doc/sisu/html/sisu_postgresql.7.html -_1 file:///usr/share/doc/sisu/html/sisu_sqlite.7.html +_1 /usr/share/doc/sisu/html/sisu_sqlite.7.html -_1 file:///usr/share/doc/sisu/html/sisu_webrick.1.html +_1 /usr/share/doc/sisu/html/sisu_webrick.1.html 3~ www.jus.uio.no/sisu diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst index 34a4eab1..9464ce64 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst @@ -590,7 +590,7 @@ There are a few examples provided, on untarring the source tarball: _1 conf/sisu/skin/doc/ -_1 data/sisu-examples/sample/document_samples_sisu_markup/_sisu/skin/doc +_1 data/doc/sisu/markup-samples/samples/_sisu/skin/doc/ and on installation under: @@ -842,7 +842,7 @@ _1 ruby ./sisu-install -T 2~ Dependencies -Once installed see 'man 8 sisu' for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) 'man sisu_markup-samples' may also be of interest if the sisu-markup-samples package has also been installed. +Once installed see 'man 8 sisu' for some information on additional programs that sisu makes use of, and that you may need or wish to install. (this will depend on such factors as whether you want to generate pdf, whether you will be using SiSU with or without a database, ...) 'man sisu-markup-samples' may also be of interest if the sisu-markup-samples package has also been installed. The information in man 8 may not be most up to date, and it is possible that more useful information can be gleaned from the following 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). @@ -1018,7 +1018,7 @@ the first document). After installation of sisu-complete, move to the document samples directory -_1 cd /usr/share/doc/sisu/v2/sisu_markup_samples/samples +_1 cd /usr/share/doc/sisu/markup-samples/samples and run @@ -1169,15 +1169,15 @@ _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/markup-samples/ These are installed on the system usually at: -_1 /usr/share/doc/sisu/markup-samples/samples +_1 /usr/share/doc/sisu/markup-samples/ More markup samples are available in the package sisu-markup-samples, which if installed should be available at: -_1 /usr/share/doc/sisu/markup-samples-non-free/samples +_1 /usr/share/doc/sisu/markup-samples-non-free/ Many more are available online off: @@ -1235,7 +1235,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/v2/sisu_markup_samples/samples +_1 cd /usr/share/doc/sisu/markup-samples/samples [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 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi index d1a902e7..8cef8faa 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_hyperestraier.ssi @@ -38,7 +38,7 @@ on sisu_hyperestraier: _1 man sisu_hyperestraier -_1 /usr/share/doc/sisu/sisu_markup/sisu_hyperestraier/index.html +_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 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 90cce5ca..65dc4e91 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -94,13 +94,11 @@ Online markup examples are available together with the respective outputs produc There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: http://www.jus.uio.no/sisu/sisu_markup/ -Some example marked up files are available as html with syntax highlighting for viewing: http://www.jus.uio.no/sisu/sample/syntax - -an alternative presentation of markup syntax: http://www.jus.uio.no/sisu/sample/on_markup.txt +an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz 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/markup-samples (or equivalent directory) and if sisu-markup-samples is installed also under: /usr/share/doc/sisu/markup-samples-non-free 1~headers Markup of Headers @@ -155,19 +153,19 @@ code{ . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] . sisu --v2 [operations] - . sisu --v1 [operations] + . sisu --v3 [operations] @links: - { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ - { 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/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/ - { SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/ + { SiSU Homepage }http://www.sisudoc.org/ + { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ + { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html + { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html + { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html + { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary + { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ + { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU }code diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst index 6557a0cd..1d4b2ce1 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst @@ -193,7 +193,7 @@ or change directory to the appropriate one: -cd /usr/share/doc/sisu/sisu_markup_samples/dfsg +cd /usr/share/doc/sisu/markup-samples/samples 3~ basic text, plaintext, html, XML, ODF, EPUB -- cgit v1.2.3