From 50d45c6deb0afd2e4222d2e33a45487a9d1fa676 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 23 Sep 2007 05:16:21 +0100 Subject: primarily todo with sisu documentation, changelog reproduced below: * start documenting sisu using sisu * sisu markup source files in data/doc/sisu/sisu_markup_samples/sisu_manual/ /usr/share/doc/sisu/sisu_markup_samples/sisu_manual/ * default output [sisu -3] in data/doc/manuals_generated/sisu_manual/ /usr/share/doc/manuals_generated/sisu_manual/ (adds substantially to the size of sisu package!) * help related edits * manpage, work on ability to generate manpages, improved * param, exclude footnote mark count when occurs within code block * plaintext changes made * shared_txt, line wrap visited * file:// link option introduced (in addition to existing https?:// and ftp://) a bit arbitrarily, diff here, [double check changes in sysenv and hub] * minor adjustments * html url match refinement * css added tiny_center * plaintext * endnotes fix * footnote adjustment to make more easily distinguishable from substantive text * flag -a only [flags -A -e -E dropped] controlled by modifiers --unix/msdos --footnote/endnote * defaults, homepage * renamed homepage (instead of index) implications for modifying skins, which need likewise to have any homepage entry renamed * added link to sisu_manual in homepage * css the css for the default homepage is renamed homepage.css (instead of index.css) [consider removing this and relying on html.css] * ruby version < ruby1.9 * place stop on installation and working with for now [ruby String.strip broken in ruby 1.9.0 (2007-09-10 patchlevel 0) [i486-linux], 2007-09-18:38/2] * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * debian * debian/control restrict use to ruby > 1.8.4 and ruby < 1.9 * sisu-doc new sub-package for sisu documentation debian/control and sisu-doc.install --- .../sisu_manual/sisu_webrick/sisu_webrick.sst | 215 +++++++++++++++++++++ 1 file changed, 215 insertions(+) create mode 100644 data/doc/manuals_generated/sisu_manual/sisu_webrick/sisu_webrick.sst (limited to 'data/doc/manuals_generated/sisu_manual/sisu_webrick/sisu_webrick.sst') diff --git a/data/doc/manuals_generated/sisu_manual/sisu_webrick/sisu_webrick.sst b/data/doc/manuals_generated/sisu_manual/sisu_webrick/sisu_webrick.sst new file mode 100644 index 00000000..2e90bef2 --- /dev/null +++ b/data/doc/manuals_generated/sisu_manual/sisu_webrick/sisu_webrick.sst @@ -0,0 +1,215 @@ +% SiSU 0.58 + +@title: SiSU + +@subtitle: sisu_webrick [0.58] + +@creator: Ralph Amissah + +@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 + +@type: information + +@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + +@date.created: 2002-08-28 + +@date.issued: 2002-08-28 + +@date.available: 2007-08-28 + +@date.modified: 2007-09-16 + +@date: 2007-09-16 + +@level: new=C; break=1; num_top=1 + +@skin: skin_sisu + +@bold: /Gnu|Debian|Ruby|SiSU/ + +@links: { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.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/ + +% @prefix: + +:A~? @title @creator + +:B~? SiSU Webrick + +1~webrick sisu_webrick + +2~ Name + +SiSU - Structured information, Serialized Units - a document publishing system + +2~ Synopsis + +sisu_webrick [port] + +or + +sisu -W [port] + +2~ Description + +sisu_webrick is part of SiSU (man sisu) sisu_webrick starts Ruby's Webrick web-server and points it to the directories 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.yml a sample of which is provided as /etc/sisu/sisurc.yml (or in the equivalent directory on your system). + +2~ 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 + +2~ 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 + +2~ Further information + +For more information on SiSU see: http://www.jus.uio.no/sisu + +or man sisu + +2~ Author + +Ralph Amissah or + +2~ SEE ALSO + +_1 sisu(1) + +_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