From 2c9d947281986771ce162d219cd00bd71ea57331 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 25 Sep 2007 02:37:12 +0100 Subject: sisu documentation minor updates --- .../sisu_manual/sisu_download.ssi | 4 +- .../sisu_markup_samples/sisu_manual/sisu_howto.sst | 41 +++++-- .../sisu_manual/sisu_webrick.sst | 123 +-------------------- 3 files changed, 34 insertions(+), 134 deletions(-) (limited to 'data/doc') diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi index acae3741..b248496a 100644 --- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_download.ssi @@ -18,9 +18,9 @@ @date.available: 2007-08-28 -@date.modified: 2007-09-23 +@date.modified: 2007-09-25 -@date: 2007-09-23 +@date: 2007-09-25 @level: new=C; break=1; num_top=1 diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst index 80ad314d..d4a892c1 100644 --- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_howto.sst @@ -842,10 +842,10 @@ Standards-Version: 3.7.2 Package: sisu Architecture: all -Depends: ruby (>= 1.8.2), libwebrick-ruby, unzip, zip +Depends: ruby (>= 1.8.2), ruby (<< 1.9), libwebrick-ruby, unzip, zip Conflicts: vim-sisu, sisu-vim, sisu-remote Replaces: vim-sisu, sisu-vim -Recommends: sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager +Recommends: sisu-doc, sisu-pdf, sisu-sqlite, sisu-postgresql, hyperestraier, keychain, librmagick-ruby, librexml-ruby, openssl, openssh-client | lsh-client, rsync, tidy, vim-addon-manager Suggests: kdissert, lv, rcs | cvs, pinfo, texinfo, trang Description: documents - structuring, publishing in multiple formats and search SiSU is a lightweight markup based, command line oriented, document @@ -889,13 +889,14 @@ code{ Package: sisu-complete Architecture: all -Depends: ruby (>= 1.8.2), sisu, sisu-pdf, sisu-postgresql, sisu-sqlite +Depends: ruby (>= 1.8.2), ruby (<< 1.9), sisu, sisu-doc, sisu-pdf, sisu-postgresql, sisu-sqlite Recommends: hyperestraier Description: installs all SiSU related packages This package installs SiSU and related packages that enable sisu to produce pdf and to populate postgresql and sqlite databases. . - SiSU is a lightweight markup based document publishing framework. + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. . See sisu for a description of the package. . @@ -905,14 +906,32 @@ Description: installs all SiSU related packages code{ +Package: sisu-doc +Architecture: all +Depends: sisu +Recommends: sisu-pdf, sisu-postgresql, sisu-sqlite +Description: sisu manual and other documentation for sisu + Multiple file formats generated output of sisu documentation generated from + sisu markup source documents included in the main package + . + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. + . + Homepage: + +}code + +code{ + Package: sisu-pdf Architecture: all Depends: sisu, texlive-latex-base, texlive-fonts-recommended, texlive-latex-recommended, texlive-latex-extra -#Suggests: evince, xpdf +Recommends: sisu-doc Description: dependencies to convert SiSU LaTeX output to pdf This package enables the conversion of SiSU LaTeX output to pdf. . - SiSU is a lightweight markup based document publishing framework. + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. . Homepage: @@ -923,7 +942,7 @@ code{ Package: sisu-postgresql Architecture: all Depends: sisu, libdbd-pg-ruby, libdbi-ruby, libdbm-ruby, postgresql -Recommends: libfcgi-ruby +Recommends: sisu-doc, libfcgi-ruby Suggests: postgresql-contrib Description: SiSU dependencies for use with postgresql database This package enables SiSU to populate a postgresql database. This is done at @@ -935,7 +954,8 @@ Description: SiSU dependencies for use with postgresql database identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. . - SiSU is a lightweight markup based document publishing framework. + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. . Homepage: @@ -946,7 +966,7 @@ code{ Package: sisu-sqlite Architecture: all Depends: sisu, sqlite, libdbd-sqlite-ruby, libdbi-ruby, libdbm-ruby -Recommends: libfcgi-ruby +Recommends: sisu-doc, libfcgi-ruby Description: SiSU dependencies for use with sqlite database This package enables SiSU to populate an sqlite database. This is done at an object/paragraph level, making granular searches of documents possible. @@ -957,7 +977,8 @@ Description: SiSU dependencies for use with sqlite database identified by object citation number, from which an index of documents matched and each matched paragraph within them can be displayed. . - SiSU is a lightweight markup based document publishing framework. + SiSU is a lightweight markup based document structuring, publishing and search + framework for document collections. . Homepage: diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst index bd8a074c..c7d450f2 100644 --- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst +++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_webrick.sst @@ -82,7 +82,7 @@ or man sisu 2~ Author -Ralph Amissah or +Ralph Amissah ralph@amissah.com or ralph.amissah@gmail.com 2~ SEE ALSO @@ -92,124 +92,3 @@ _1 sisu_vim(7) _1 sisu(8) - - -% .\" Name: SiSU information Structuring Universe -% .\" Author: Ralph Amissah -% .\" Description: sisu webrick manpage -% .\" arch-tag: sisu manpage -% .\" License: GPL 3 or later -% .\" Notes: Process this file with -% .\" groff -man -Tascii sisu.1 -% .\" nroff -man sisu.1 | most -% .\" |sisu.1|@|^| -% .TH sisu_webrick 1 "December 17, 2005" "version 0.34" "sisu \-W" -% .SH NAME -% .B SiSU -% \- Structured information, Serialized Units \- a document publishing system -% .SH SYNOPSIS -% .B sisu_webrick -% .I [port] -% .PP -% or -% .PP -% .B sisu -% .B \-W -% .I [port] -% .\"%% Description -% .SH DESCRIPTION -% .B sisu_webrick -% .I is part of SiSU (man sisu) -% sisu_webrick starts Ruby\'s Webrick web\-server and points it to the directories to which -% .I SiSU -% output is written, providing a list of these directories (assuming -% .I SiSU -% is in use and they exist). -% .PP -% The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: -% .I ~/.sisu/sisurc.yaml -% a sample of which is provided as -% .I /etc/sisu/sisurc.yaml -% (or in the equivalent directory on your system). -% .\"%% Summary -% .SH Summary of man page -% .PP -% sisu_webrick, may be started on it\'s own with the command: -% .B sisu_webrick -% .I [port] -% or using the sisu command with the \-W flag: -% .B sisu \-W -% .I [port] -% .PP -% where no port is given and settings are unchanged the default port is 8081 -% .\"%% Flags -% .SH DOCUMENT PROCESSING COMMAND FLAGS -% .PP -% .BI sisu \ \-W \ [port] -% starts Ruby Webrick web\-server, serving -% .I SiSU -% output directories, on the port provided, or if no port is provided and the defaults have not been changed in -% .I ~/.sisu/sisurc.yaml -% then on port 8081 -% .\"%% Further Information -% .SH FURTHER INFORMATION -% .PP -% For more information on -% .I SiSU -% see: -% .I -% .PP -% or -% .I man sisu -% .SH AUTHOR -% Ralph Amissah -% .I -% or -% .I -% .SH SEE ALSO -% .BR sisu(1), -% .BR sisu_vim(7), -% .BR sisu(8) - -% sisu_webrick(1) sisu -W sisu_webrick(1) -% -% NAME -% SiSU - Structured information, Serialized Units - a document publishing system -% -% SYNOPSIS -% sisu_webrick [port] -% -% or -% -% sisu -W [port] -% -% DESCRIPTION -% sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby´s Webrick web-server and points it to the direc- -% tories to which SiSU output is written, providing a list of these directories (assuming SiSU is in use and they -% exist). -% -% The default port for sisu_webrick is set to 8081, this may be modified in the yaml file: ~/.sisu/sisurc.yaml a -% sample of which is provided as /etc/sisu/sisurc.yaml (or in the equivalent directory on your system). -% -% Summary of man page -% sisu_webrick, may be started on it´s own with the command: sisu_webrick [port] or using the sisu command with the -% -W flag: sisu -W [port] -% -% where no port is given and settings are unchanged the default port is 8081 -% -% DOCUMENT PROCESSING COMMAND FLAGS -% sisu -W [port] starts Ruby Webrick web-server, serving SiSU output directories, 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 -% -% FURTHER INFORMATION -% For more information on SiSU see: -% -% or man sisu -% -% AUTHOR -% Ralph Amissah or -% -% SEE ALSO -% sisu(1), sisu_vim(7) sisu(8), -% -% version 0.34 December 17, 2005 sisu_webrick(1) -- cgit v1.2.3