From 6be61200c529f7f61a89aac6158eb63026d7a44b Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Fri, 15 Jun 2007 12:05:07 +0100 Subject: cgi search script fix, related to highlighting matches, changelog update, rest removal of hanging whitespace --- CHANGELOG | 15 +- README | 38 +- Rantfile | 4 +- bin/sisu | 2 +- bin/sisu_termsheet | 4 +- conf/sisu/sisurc.yml | 10 +- conf/sisu/skin/dir/skin_sisu.rb | 8 +- conf/sisu/skin/doc/skin_gnu.rb | 4 +- conf/sisu/skin/doc/skin_gutenberg.rb | 4 +- conf/sisu/skin/doc/skin_kdissert.rb | 4 +- conf/sisu/skin/doc/skin_sisu.rb | 8 +- conf/sisu/skin/site/skin_sisu.rb | 8 +- conf/sisu/skin/yml/skin_countries.yml | 2 +- conf/sisu/skin/yml/skin_country.yml | 2 +- conf/sisu/version.yml | 6 +- data/doc/sisu/CHANGELOG | 35 +- .../dfsg/_sisu/skin/dir/skin_sisu.rb | 8 +- .../dfsg/_sisu/skin/doc/skin_gnu.rb | 4 +- .../dfsg/_sisu/skin/doc/skin_gutenberg.rb | 4 +- .../dfsg/_sisu/skin/doc/skin_kdissert.rb | 4 +- .../dfsg/_sisu/skin/doc/skin_rms.rb | 8 +- .../dfsg/_sisu/skin/site/skin_sisu.rb | 8 +- .../dfsg/_sisu/skin/yml/skin_countries.yml | 2 +- .../dfsg/_sisu/skin/yml/skin_country.yml | 2 +- .../dfsg/sisu_output_overview.ssi | 2 +- data/sisu/conf/cgi-bin/sisu_search_pgsql.cgi | 72 +-- data/sisu/conf/cgi-bin/sisu_search_sqlite.cgi | 72 +-- data/sisu/conf/ruby/irbrc | 2 +- data/sisu/conf/syntax/README | 14 +- data/sisu/conf/syntax/diakonos.conf | 4 +- data/sisu/conf/syntax/nanorc | 2 +- data/sisu/conf/syntax/sisu-mode.el | 22 +- data/sisu/conf/syntax/sisu.lang | 6 +- data/sisu/conf/syntax/sisu.xml | 2 +- data/sisu/conf/syntax/sisu_nedit.pats | 2 +- data/sisu/conf/vim/addons/ftplugin/sisu.vim | 8 +- lib/sisu/v0/cgi_sql_common.rb | 23 +- lib/sisu/v0/db_load_tuple.rb | 4 +- lib/sisu/v0/shared_html_lite.rb | 1 + lib/sisu/v0/texpdf.rb | 12 +- man/man1/sisu.1 | 676 ++++++++++----------- man/man1/sisu_termsheet.1 | 20 +- man/man1/sisu_webrick.1 | 24 +- man/man7/sisu_vim.7 | 8 +- man/man8/sisu.8 | 24 +- setup.rb | 8 +- 46 files changed, 627 insertions(+), 575 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 2808c231..db80b9d1 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -6,11 +6,20 @@ Reverse Chronological: %% STABLE MANIFEST +%% sisu_0.54.1.orig.tar.gz (2007-06-15::24/5) +http://www.jus.uio.no/sisu/pkg/src/sisu_0.54.1.orig.tar.gz + sisu_0.54.1.orig.tar.gz + sisu_0.54.1-1.dsc + sisu_0.54.1-1.diff.gz + + * cgi script (for search matching), fix (imperfect), match highlighting is + now ignored in paragraphs with urls + %% sisu_0.54.0.orig.tar.gz (2007-06-14::24/4) http://www.jus.uio.no/sisu/pkg/src/sisu_0.54.0.orig.tar.gz - sisu_0.54.0.orig.tar.gz - sisu_0.54.0-1.dsc - sisu_0.54.0-1.diff.gz + e1a98feb15d72e669d3726dbc9cc81da 1258857 sisu_0.54.0.orig.tar.gz + 0be75fc5cdf10fdf7d8073490bec4fe6 606 sisu_0.54.0-1.dsc + d1e9622e5835641c00eb65d248535adb 149716 sisu_0.54.0-1.diff.gz * indent levels (1-9) added [previously two levels] done for plaintext, html, xml, odf, latex/pdf [minor syntax addition (_3 - _9), version number diff --git a/README b/README index a688fcb5..a44b30b0 100644 --- a/README +++ b/README @@ -8,16 +8,16 @@ homepage: http://www.jus.uio.no/sisu that is controlled from the command line. Prepare documents for SiSU using your text editor of choice, then use SiSU to generate various output document formats. - + With minimal preparation of a plain-text (UTF-8) file using its native markup-syntax, SiSU produces: plain-text, HTML, XHTML, XML, ODF:ODT (Opendocument), LaTeX, PDF, and populates an SQL database (PostgreSQL or SQLite) in paragraph sized chunks so that document searches are done at this "atomic" level of granularity. - + Outputs share a common citation numbering system, and any semantic meta-data provided about the document. - + SiSU also provides concordance files, document content certificates and manifests of generated output. @@ -28,26 +28,26 @@ homepage: http://www.jus.uio.no/sisu sciences perspective, rather than technical or scientific writing] ... focus is primarily on content and data integrity rather than appearance, (though outputs in the various formats are respectable). - + A vim syntax highlighting file and an ftplugin with folds for sisu markup is provided. Vim 7 includes syntax highlighting for SiSU. - + man pages, and interactive help are provided. - + Dependencies for various features are taken care of in sisu related packages. The package sisu-complete installs the whole of SiSU. - + 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. - + Homepage: http://www.jus.uio.no/sisu ----- SiSU - simple information structuring universe, is a publishing tool, document -generation and management, (and search enabling) tool primarily for literary, +generation and management, (and search enabling) tool primarily for literary, academic and legal works. SiSU can be used for Internet, Intranet, local filesystem or cd publishing. @@ -57,7 +57,7 @@ SiSU can be used directly off the filesystem, or from a database. SiSU's scalability, is be dependent on your hardware, and filesystem (in my case Reiserfs), and/or database Postgresql. -Amongst it's characteristics are: +Amongst it's characteristics are: * simple mnemonoic markup style, @@ -102,7 +102,7 @@ NB. Platform is Unix / Linux. %% Debian --------------- -If you use Debian use the Debian packages, +If you use Debian use the Debian packages, check the information at: http://www.jus.uio.no/sisu/SiSU/download.html#debian http://www.jus.uio.no/sisu/sisu_download/download.html#debian @@ -143,9 +143,9 @@ Otherwise to install SiSU from source, check information at: http://www.jus.uio.no/sisu/SiSU/download.html#current http://www.jus.uio.no/sisu/sisu_download/download.html#current -two alternative modes of installation from source are provided, +two alternative modes of installation from source are provided, setup.rb (by Minero Aoki) and a rant(by Stefan Lang) built install file, -in either case: the first steps are the same, download and unpack the +in either case: the first steps are the same, download and unpack the source file: 1. Download the latest source (information available) from: @@ -158,15 +158,15 @@ source file: this is a three step process, in the root directory of the unpacked SiSU as root type: - ruby setup.rb config - ruby setup.rb setup + ruby setup.rb config + ruby setup.rb setup #[as root:] ruby setup.rb install further information: http://i.loveruby.net/en/projects/setup/ http://i.loveruby.net/en/projects/setup/doc/usage.html - + %% to use install (prapared with "Rant") --------------- in the root directory of the unpacked SiSU as root type: @@ -179,7 +179,7 @@ This makes use of Rant (by Stefan Lang) and the provided Rantfile. It has been configured to do post installation setup setup configuration and generation of first test file. Note however, that additional external package dependencies, such as tetex-extra are not taken care of for you. - + further information: http://make.rubyforge.org/ http://rubyforge.org/frs/?group_id=615 @@ -283,7 +283,7 @@ The default configuration/setup is contained within the program and is altered by configuration settings in /etc/[sisu version]/sisurc.yml or in ~/.sisu/sisurc.yml -* configuration file - a yaml file +* configuration file - a yaml file /etc/sisu/[sisu version]/sisurc.yml ~/.sisu/sisurc.yml @@ -297,7 +297,7 @@ documents within ~/.sisu/skin * additional software - eg. Tex and LaTeX (tetex, tetex-base, tetex-extra on Debian), Postgresql, [sqlite], trang, tidy, makeinfo, ... none of which are -required for basic html or XML processing. +required for basic html or XML processing. * if you use Vim as editor there is a syntax highlighter and fold resource config file for SiSU. I hope more syntax highlighters follow. diff --git a/Rantfile b/Rantfile index 66567653..1b15420d 100644 --- a/Rantfile +++ b/Rantfile @@ -52,11 +52,11 @@ raise 'Please, use ruby1.8.4 or later.' if RUBY_VERSION < '1.8.4' SiSU was first released to the public on January 4th 2005 SiSU uses: - + * Standard SiSU markup syntax, * Standard SiSU meta-markup syntax, and the * Standard SiSU object citation numbering and system - + © Ralph Amissah 1997, current 2005. All Rights Reserved. diff --git a/bin/sisu b/bin/sisu index 4ee3f0f3..d1fe035f 100644 --- a/bin/sisu +++ b/bin/sisu @@ -43,7 +43,7 @@ __END__ SiSU was first released to the public on January 4th 2005 SiSU uses: - + * Standard SiSU markup syntax, * Standard SiSU meta-markup syntax, and the * Standard SiSU object citation numbering and system diff --git a/bin/sisu_termsheet b/bin/sisu_termsheet index 38d24a6f..4df4bc92 100644 --- a/bin/sisu_termsheet +++ b/bin/sisu_termsheet @@ -44,11 +44,11 @@ __END__ SiSU was first released to the public on January 4th 2005 SiSU uses: - + * Standard SiSU markup syntax, * Standard SiSU meta-markup syntax, and the * Standard SiSU object citation numbering and system - + © Ralph Amissah 1997, current 2007. All Rights Reserved. diff --git a/conf/sisu/sisurc.yml b/conf/sisu/sisurc.yml index df2f153d..753af124 100644 --- a/conf/sisu/sisurc.yml +++ b/conf/sisu/sisurc.yml @@ -1,17 +1,17 @@ # Name: SiSU - Simple information Structuring Universe - Structured information, Serialized Units # Author: Ralph@Amissah.com -# Description: Site wide envionment defaults set here +# Description: Site wide envionment defaults set here # arch-tag: system environment info / resource configuration file, for sisu # License: GPL 2 or later -# this file should be configured and live in +# this file should be configured and live in # /etc/sisu #per environment settings, overridden by: # ~/.sisu #per user settings, overridden by: # ./_sisu/config #per local directory settings # $Date$ # $Id$ -# Notes: implemented 2004w03 +# Notes: implemented 2004w03 # Site environment configuration file -# this file should be configured and live in +# this file should be configured and live in # /etc/sisu #per environment settings, overridden by: # ~/.sisu #per user settings, overridden by: # ./_sisu #per local markup directory settings @@ -86,7 +86,7 @@ default: # port: "**" #% possible values ~, true, false, or command instruction e.g. editor: 'gvim -c :R -c :S'. #will only ignore if value set to false, absence or nil will not remove program as should operate without rc file -#ie in case of ~ will ignore and use hard coded defaults within program), true, false, or command instruction e.g. editor: 'gvim -c :R -c :S' +#ie in case of ~ will ignore and use hard coded defaults within program), true, false, or command instruction e.g. editor: 'gvim -c :R -c :S' #on value true system defaults used, to change, e.g. editor specify permission_set: zap: false diff --git a/conf/sisu/skin/dir/skin_sisu.rb b/conf/sisu/skin/dir/skin_sisu.rb index 66786cea..3e27c1d2 100644 --- a/conf/sisu/skin/dir/skin_sisu.rb +++ b/conf/sisu/skin/dir/skin_sisu.rb @@ -3,7 +3,7 @@ * Author: Ralph@Amissah.com * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... + * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -35,7 +35,7 @@ module SiSU_Viz end def url_site # used in pdf header #puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' + 'http://www.jus.uio.no/sisu' end def url_txt # text to go with url usually stripped url #puts "#{__LINE__} #{__FILE__}" @@ -50,7 +50,7 @@ module SiSU_Viz #end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end def color_band2 '"#ffffff"' @@ -60,7 +60,7 @@ module SiSU_Viz ' SiSU' end def text_home - 'SiSU' + 'SiSU' end #% icon def icon_home_button diff --git a/conf/sisu/skin/doc/skin_gnu.rb b/conf/sisu/skin/doc/skin_gnu.rb index 4c35120e..62497cfd 100644 --- a/conf/sisu/skin/doc/skin_gnu.rb +++ b/conf/sisu/skin/doc/skin_gnu.rb @@ -42,14 +42,14 @@ module SiSU_Viz end # color def color_band1 - '"#000070"' + '"#000070"' end #% txt def txt_hp 'Free Software Foundation' end def txt_home # this should be the name of the site eg. Lex Mercatoria or if you prefer to see a url the url in text form copy & ... - #"www.jus.uio.no/sisu/" + #"www.jus.uio.no/sisu/" 'Free Software Foundation' end #% icon diff --git a/conf/sisu/skin/doc/skin_gutenberg.rb b/conf/sisu/skin/doc/skin_gutenberg.rb index 4014d624..bd7d9961 100644 --- a/conf/sisu/skin/doc/skin_gutenberg.rb +++ b/conf/sisu/skin/doc/skin_gutenberg.rb @@ -3,7 +3,7 @@ * Author: Ralph Amissah * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin sample prepared for Gutenberg Project (first used with "War and Peace") + * Description: Document skin sample prepared for Gutenberg Project (first used with "War and Peace") * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -13,7 +13,7 @@ module SiSU_Viz class Skin #% path def path_root # the only parameter that cannot be changed here - './sisu/' + './sisu/' end def path_rel '../' diff --git a/conf/sisu/skin/doc/skin_kdissert.rb b/conf/sisu/skin/doc/skin_kdissert.rb index 87d371f2..3d8c0485 100644 --- a/conf/sisu/skin/doc/skin_kdissert.rb +++ b/conf/sisu/skin/doc/skin_kdissert.rb @@ -37,14 +37,14 @@ module SiSU_Viz end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end #% txt def txt_hp 'Kdissert, Document Mapping' end def txt_home # this should be the name of the site eg. Lex Mercatoria or if you prefer to see a url the url in text form copy & ... - #"www.jus.uio.no/sisu/" + #"www.jus.uio.no/sisu/" 'SiSU (document prepared using Kdissert)' end #% icon diff --git a/conf/sisu/skin/doc/skin_sisu.rb b/conf/sisu/skin/doc/skin_sisu.rb index 66786cea..3e27c1d2 100644 --- a/conf/sisu/skin/doc/skin_sisu.rb +++ b/conf/sisu/skin/doc/skin_sisu.rb @@ -3,7 +3,7 @@ * Author: Ralph@Amissah.com * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... + * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -35,7 +35,7 @@ module SiSU_Viz end def url_site # used in pdf header #puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' + 'http://www.jus.uio.no/sisu' end def url_txt # text to go with url usually stripped url #puts "#{__LINE__} #{__FILE__}" @@ -50,7 +50,7 @@ module SiSU_Viz #end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end def color_band2 '"#ffffff"' @@ -60,7 +60,7 @@ module SiSU_Viz ' SiSU' end def text_home - 'SiSU' + 'SiSU' end #% icon def icon_home_button diff --git a/conf/sisu/skin/site/skin_sisu.rb b/conf/sisu/skin/site/skin_sisu.rb index 66786cea..3e27c1d2 100644 --- a/conf/sisu/skin/site/skin_sisu.rb +++ b/conf/sisu/skin/site/skin_sisu.rb @@ -3,7 +3,7 @@ * Author: Ralph@Amissah.com * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... + * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -35,7 +35,7 @@ module SiSU_Viz end def url_site # used in pdf header #puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' + 'http://www.jus.uio.no/sisu' end def url_txt # text to go with url usually stripped url #puts "#{__LINE__} #{__FILE__}" @@ -50,7 +50,7 @@ module SiSU_Viz #end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end def color_band2 '"#ffffff"' @@ -60,7 +60,7 @@ module SiSU_Viz ' SiSU' end def text_home - 'SiSU' + 'SiSU' end #% icon def icon_home_button diff --git a/conf/sisu/skin/yml/skin_countries.yml b/conf/sisu/skin/yml/skin_countries.yml index a68903e1..179b9978 100644 --- a/conf/sisu/skin/yml/skin_countries.yml +++ b/conf/sisu/skin/yml/skin_countries.yml @@ -1,4 +1,4 @@ -# arch-tag: yaml country list +# arch-tag: yaml country list # Author: Ralph@Amissah.com # License: Same as SiSU see http://www.jus.uio.no/sisu id: AF diff --git a/conf/sisu/skin/yml/skin_country.yml b/conf/sisu/skin/yml/skin_country.yml index ebaf8ace..dc835465 100644 --- a/conf/sisu/skin/yml/skin_country.yml +++ b/conf/sisu/skin/yml/skin_country.yml @@ -1,4 +1,4 @@ -# arch-tag: yaml country list array +# arch-tag: yaml country list array # Author: Ralph@Amissah.com # License: Same as SiSU see http://www.jus.uio.no/sisu - diff --git a/conf/sisu/version.yml b/conf/sisu/version.yml index 7bb8794c..20528cc6 100644 --- a/conf/sisu/version.yml +++ b/conf/sisu/version.yml @@ -1,5 +1,5 @@ --- -:date: "2007-06-02" +:date: "2007-06-14" +:version: 0.54.0 :project: SiSU -:version: 0.53.0 -:date_stamp: 2007w22/6 +:date_stamp: 2007w24/4 diff --git a/data/doc/sisu/CHANGELOG b/data/doc/sisu/CHANGELOG index 81193a07..2808c231 100644 --- a/data/doc/sisu/CHANGELOG +++ b/data/doc/sisu/CHANGELOG @@ -6,11 +6,38 @@ Reverse Chronological: %% STABLE MANIFEST +%% sisu_0.54.0.orig.tar.gz (2007-06-14::24/4) +http://www.jus.uio.no/sisu/pkg/src/sisu_0.54.0.orig.tar.gz + sisu_0.54.0.orig.tar.gz + sisu_0.54.0-1.dsc + sisu_0.54.0-1.diff.gz + + * indent levels (1-9) added [previously two levels] done for plaintext, html, + xml, odf, latex/pdf [minor syntax addition (_3 - _9), version number + change] + + * bullet indent levels (1-9) added [previously two levels] done for + plaintext, html, odf, latex/pdf [minor syntax addition (_3* - _9*), version + number change] + + * url decoration, open close, default angle brackets + + * fixes, some line-breaking for plaintext (and text groups for) odf and xml + + * css, modifications for extended indents in html and xml [sisu -CC (for + update)] + + * vim syntax highlighter updated to take account of extended indent range + + * rant installer minor changes for future ruby + + * conversion script in data/sisu/conf/convert/sisu_convert + %% sisu_0.53.0.orig.tar.gz (2007-06-02::22/6) http://www.jus.uio.no/sisu/pkg/src/sisu_0.53.0.orig.tar.gz - sisu_0.53.0.orig.tar.gz - sisu_0.53.0-1.dsc - sisu_0.53.0-1.diff.gz + b8f28c2cade1f95956f5cdaef7af7fbd 1254059 sisu_0.53.0.orig.tar.gz + 2a741d1fbe95f25a06b6d10ee709514a 606 sisu_0.53.0-1.dsc + 65b8d4638cb0df8a8d8bcd33e20482b4 182847 sisu_0.53.0-1.diff.gz * housekeeping, internal program adjustments (i.e. unrelated to output) * lib, moved lib base to v0 branch (major version preceded by a v), [from @@ -23,7 +50,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_0.53.0.orig.tar.gz * Note: dcc, several hash values change. - * moved to git for scm including git-buildpackage + * moved to git for scm including git-buildpackage (from a combination of mercurial and dars + darcs-buildpackage, [don't ask, it served me quite well though]) diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/dir/skin_sisu.rb b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/dir/skin_sisu.rb index 66786cea..3e27c1d2 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/dir/skin_sisu.rb +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/dir/skin_sisu.rb @@ -3,7 +3,7 @@ * Author: Ralph@Amissah.com * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... + * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -35,7 +35,7 @@ module SiSU_Viz end def url_site # used in pdf header #puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' + 'http://www.jus.uio.no/sisu' end def url_txt # text to go with url usually stripped url #puts "#{__LINE__} #{__FILE__}" @@ -50,7 +50,7 @@ module SiSU_Viz #end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end def color_band2 '"#ffffff"' @@ -60,7 +60,7 @@ module SiSU_Viz ' SiSU' end def text_home - 'SiSU' + 'SiSU' end #% icon def icon_home_button diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gnu.rb b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gnu.rb index 50516f85..9f12228f 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gnu.rb +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gnu.rb @@ -42,14 +42,14 @@ module SiSU_Viz end # color def color_band1 - '"#000070"' + '"#000070"' end #% txt def txt_hp 'Free Software Foundation' end def txt_home # this should be the name of the site eg. Lex Mercatoria or if you prefer to see a url the url in text form copy & ... - #"www.jus.uio.no/sisu/" + #"www.jus.uio.no/sisu/" 'Free Software Foundation' end #% icon diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gutenberg.rb b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gutenberg.rb index 0df9c7ff..261f924a 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gutenberg.rb +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_gutenberg.rb @@ -3,7 +3,7 @@ * Author: Ralph Amissah * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin sample prepared for Gutenberg Project (first used with "War and Peace") + * Description: Document skin sample prepared for Gutenberg Project (first used with "War and Peace") * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -13,7 +13,7 @@ module SiSU_Viz class Skin #% path def path_root # the only parameter that cannot be changed here - './sisu/' + './sisu/' end def path_rel '../' diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_kdissert.rb b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_kdissert.rb index 87d371f2..3d8c0485 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_kdissert.rb +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_kdissert.rb @@ -37,14 +37,14 @@ module SiSU_Viz end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end #% txt def txt_hp 'Kdissert, Document Mapping' end def txt_home # this should be the name of the site eg. Lex Mercatoria or if you prefer to see a url the url in text form copy & ... - #"www.jus.uio.no/sisu/" + #"www.jus.uio.no/sisu/" 'SiSU (document prepared using Kdissert)' end #% icon diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_rms.rb b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_rms.rb index 2ec6c841..2a87c3a5 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_rms.rb +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc/skin_rms.rb @@ -3,7 +3,7 @@ * Author: Ralph Amissah * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin used for Free as in Freedom + * Description: Document skin used for Free as in Freedom * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -45,15 +45,15 @@ module SiSU_Viz #end #% color def color_band1 - '"#cccccc"' - #'"#000070"' + '"#cccccc"' + #'"#000070"' end #% txt def txt_hp 'Free as in Freedom' end def txt_home # this should be the name of the site eg. Lex Mercatoria or if you prefer to see a url the url in text form copy & ... - #"www.jus.uio.no/sisu/" + #"www.jus.uio.no/sisu/" 'Free as in Freedom' end #% icon diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/site/skin_sisu.rb b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/site/skin_sisu.rb index 66786cea..3e27c1d2 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/site/skin_sisu.rb +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/site/skin_sisu.rb @@ -3,7 +3,7 @@ * Author: Ralph@Amissah.com * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download - * Description: Document skin for SiSU descriptive pages, ... + * Description: Document skin for SiSU descriptive pages, ... * License: Same as SiSU see http://www.jus.uio.no/sisu * Notes: Site default appearance variables set in defaults.rb Generic site wide modifications set here scribe_skin.rb, and this file required by other "scribes" instead of defaults.rb @@ -35,7 +35,7 @@ module SiSU_Viz end def url_site # used in pdf header #puts "#{__LINE__} #{__FILE__}" - 'http://www.jus.uio.no/sisu' + 'http://www.jus.uio.no/sisu' end def url_txt # text to go with url usually stripped url #puts "#{__LINE__} #{__FILE__}" @@ -50,7 +50,7 @@ module SiSU_Viz #end #% color def color_band1 - '"#ffffff"' + '"#ffffff"' end def color_band2 '"#ffffff"' @@ -60,7 +60,7 @@ module SiSU_Viz ' SiSU' end def text_home - 'SiSU' + 'SiSU' end #% icon def icon_home_button diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_countries.yml b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_countries.yml index a68903e1..179b9978 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_countries.yml +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_countries.yml @@ -1,4 +1,4 @@ -# arch-tag: yaml country list +# arch-tag: yaml country list # Author: Ralph@Amissah.com # License: Same as SiSU see http://www.jus.uio.no/sisu id: AF diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_country.yml b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_country.yml index ebaf8ace..dc835465 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_country.yml +++ b/data/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml/skin_country.yml @@ -1,4 +1,4 @@ -# arch-tag: yaml country list array +# arch-tag: yaml country list array # Author: Ralph@Amissah.com # License: Same as SiSU see http://www.jus.uio.no/sisu - diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/sisu_output_overview.ssi b/data/doc/sisu/sisu_markup_samples/dfsg/sisu_output_overview.ssi index 4cc32196..e2c90529 100644 --- a/data/doc/sisu/sisu_markup_samples/dfsg/sisu_output_overview.ssi +++ b/data/doc/sisu/sisu_markup_samples/dfsg/sisu_output_overview.ssi @@ -49,7 +49,7 @@ group{ Done * yes/done . partial - + - not available/appropriate Not Done diff --git a/data/sisu/conf/cgi-bin/sisu_search_pgsql.cgi b/data/sisu/conf/cgi-bin/sisu_search_pgsql.cgi index 0d2ed982..6ac1bac4 100644 --- a/data/sisu/conf/cgi-bin/sisu_search_pgsql.cgi +++ b/data/sisu/conf/cgi-bin/sisu_search_pgsql.cgi @@ -1,6 +1,6 @@ #!/usr/bin/env ruby =begin - * Name: SiSU information Structuring Universe + * Name: SiSU information Structuring Universe * Author: Ralph Amissah * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download @@ -39,11 +39,11 @@ SiSU was first released to the public on January 4th 2005 SiSU uses: - + * Standard SiSU markup syntax, * Standard SiSU meta-markup syntax, and the * Standard SiSU object citation numbering and system - + © Ralph Amissah 1997, current 2006. All Rights Reserved. @@ -69,7 +69,7 @@ class Form @base,@search_field,@selected_db,@checked_index,@checked_text,@checked_tip,@checked_searched,@checked_url,@checked_echo,@checked_sql,@checked_all,@checked_none,@checked_ignore,@search_note,@the_can=base,search_field,selected_db,checked_index,checked_text,checked_tip,checked_searched,checked_url,checked_echo,checked_sql,checked_all,checked_none,checked_ignore,search_note,the_can @tip=if checked_tip =~/\S/ 'text:__; keywords:__; title:__; author:__; subject:__; description:__; publisher:__; contributor:__; date:__; type:__; format:__; identifier:__; source:__; language:__; relation:__; coverage:__; rights:__; comment:__; abstract:__; ' - else '' + else '' end end def submission_form @@ -101,7 +101,7 @@ class Form #@tip - + echo searched @@ -335,10 +335,10 @@ class Dbi_search_statement %{SELECT metadata.title, metadata.creator, metadata.filename, endnotes.body, endnotes.nr, endnotes.ocn, endnotes.metadata_tid FROM metadata, endnotes WHERE (#@search_endnotes) AND metadata.tid = endnotes.metadata_tid ORDER BY metadata.title, endnotes.nr ;} end def sql_select_body_format - %{#{sql_select_body}} + %{#{sql_select_body}} end def sql_select_endnotes_format - %{#{sql_select_endnotes}} + %{#{sql_select_endnotes}} end def contents @conn.select_all(sql_select_body) @@ -670,8 +670,8 @@ FCGI.each_cgi do |cgi| @search=Hash.new @search[:text],@search[:endnotes]=Array.new,Array.new q=CGI.new - @db=if cgi['db'] =~/\S+/: - @stub=/SiSU_(\S+)/.match(cgi['db'])[1] + @db=if cgi['db'] =~/\S+/: + @stub=/SiSU_(\S+)/.match(cgi['db'])[1] cgi['db'] else @stub='sisu' @@ -681,17 +681,17 @@ FCGI.each_cgi do |cgi| if cgi['view']=~/text/: checked_index,checked_text='','checked' else checked_index,checked_text='checked','' end - checked_url='checked' if cgi['url'] =~/\S/ or cgi['u'].to_i==1 - checked_searched='checked' if cgi['searched'] =~/\S/ - checked_tip='checked' if cgi['tip'] =~/\S/ - checked_echo='checked' if cgi['echo'] =~/\S/ - checked_sql='checked' if cgi['sql'] =~/\S/ - if cgi['checks'] =~/check_all/ or cgi['check_all'] =~/\S/ or cgi['a'].to_i==1 + checked_url='checked' if cgi['url'] =~/\S/ or cgi['u'].to_i==1 + checked_searched='checked' if cgi['searched'] =~/\S/ + checked_tip='checked' if cgi['tip'] =~/\S/ + checked_echo='checked' if cgi['echo'] =~/\S/ + checked_sql='checked' if cgi['sql'] =~/\S/ + if cgi['checks'] =~/check_all/ or cgi['check_all'] =~/\S/ or cgi['a'].to_i==1 checked_all=checked_url=checked_searched=checked_tip=checked_echo=checked_sql='checked' - checked_none='' - elsif cgi['checks'] =~/check_none/ #or cgi['a'].to_i==0 + checked_none='' + elsif cgi['checks'] =~/check_none/ #or cgi['a'].to_i==0 checked_none='checked' - checked_all=checked_url=checked_searched=checked_tip=checked_echo=checked_sql='' + checked_all=checked_url=checked_searched=checked_tip=checked_echo=checked_sql='' else checked_ignore='checked' end selected_db=case cgi['db'] @@ -699,7 +699,7 @@ FCGI.each_cgi do |cgi| when /SiSU_sisu/: '' end dbi="dbi:Pg:database=#{@db};port=5432" - @conn=DBI.connect(dbi,user) + @conn=DBI.connect(dbi,user) search_field=cgi['find'] if cgi['find'] # =~/\S+/ @search_for=Search_request.new(search_field,q) #.analyze #% search_for #% searches @@ -731,7 +731,7 @@ FCGI.each_cgi do |cgi| canned_search_url=if checked_all =~/checked/ "#@base?#{s1}#{key}#{ti}#{au}#{sj}#{dsc}#{pb}#{cntr}#{dt}#{ty}#{id}#{src}#{lang}#{rel}#{cov}#{cr}#{co}#{ab}#{dtc}#{dti}#{dtm}#{dta}#{dtv}&db=#{cgi['db']}&view=#{cgi['view']}&a=1" else "#@base?#{s1}#{key}#{ti}#{au}#{sj}#{dsc}#{pb}#{cntr}#{dt}#{ty}#{id}#{src}#{lang}#{rel}#{cov}#{cr}#{co}#{ab}#{dtc}#{dti}#{dtm}#{dta}#{dtv}&db=#{cgi['db']}&view=#{cgi['view']}&u=1&e=1" - end + end @search[:text][1]=%{documents.clean~'#{@search_for.text1}'} #s1 @search[:endnotes][1]=%{endnotes.clean~'#{@search_for.text1}'} #s1 canned_note='previous search url:' @@ -750,7 +750,7 @@ FCGI.each_cgi do |cgi| af.gsub!(/%2B/,' ') analyze_format=af st=af.split(/\s*;\s*/) - search_field=st.join("\n") + search_field=st.join("\n") end green=%{} the_can=%{#{canned_note}
#{canned_search_url}
} @@ -786,7 +786,7 @@ WOK #dbi_canning @header=Form.new(@base,search_field,selected_db,checked_index,checked_text,checked_tip,checked_searched,checked_url,checked_echo,checked_sql,checked_all,checked_none,checked_ignore,search_note,the_can).submission_form #% form @tail=Tail.new.tail - unless q['s1'] =~/\S/ or q['au'] =~/\S/ or @search[:text][1] =~/\S/ + unless q['s1'] =~/\S/ or q['au'] =~/\S/ or @search[:text][1] =~/\S/ print "Content-type: text/html\n\n" puts (@header+@tail) else #% searches @@ -805,7 +805,7 @@ WOK @body_main=Array.new @endnotes=Array.new oldtid=0 - if @text_search_flag + if @text_search_flag if checked_sql =~/\S/ sql_select_body=dbi_statement.sql_select_body_format sql_select_endnotes=dbi_statement.sql_select_endnotes_format @@ -822,14 +822,14 @@ WOK #metadata_found_body if c["tid"].to_i != oldtid.to_i title=%{#{c["title"]} by #{c["creator"]} pdf portraitpdf landscape
} if file_suffix=~/s/ #hmm watch file_suffix - if @text_search_flag: title='
'+title - else title='
'+title + if @text_search_flag: title='
'+title + else title='
'+title end @counter_txt_doc+=1 oldtid=c["tid"].to_i else title='' end - if @text_search_flag + if @text_search_flag if cgi['view']=~/text/ #% txt body text=if c["suffix"] !~/1/ #seg if @search_for.text1 =~/\S+/ or q['s1'] =~/\S+/ #% only this branch is working !! @@ -848,22 +848,22 @@ WOK @search_regx=search_regex.to_s end matched_para=c["body"].gsub(/(#@search_regx)/i,%{\\1}) - %{

ocn #{c["ocn"]}:

#{matched_para}} + %{

ocn #{c["ocn"]}:

#{matched_para}} elsif c["suffix"] =~/1/ #doc %{#{title}

ocn #{c["ocn"]}:#{c["body"]}} end @counter_txt_ocn+=1 output=if c["seg"] =~/\S+/: title+text - else text + else text end elsif cgi['view']=~/index/ #% idx body if c["suffix"] !~/1/ #seg - index=%{#{c["ocn"]}, } if @text_search_flag + index=%{#{c["ocn"]}, } if @text_search_flag elsif c["suffix"] =~/1/ #doc - index=%{#{c["ocn"]}, } + index=%{#{c["ocn"]}, } end - if c["seg"] =~/\S+/ - if @text_search_flag + if c["seg"] =~/\S+/ + if @text_search_flag @counter_txt_ocn+=1 output=title+index end @@ -874,8 +874,8 @@ WOK end end end - else output=title - end + else output=title + end @counters_txt=if @counter_txt_doc > 0 %{Found in the main body of #@counter_txt_doc documents, and at #@counter_txt_ocn locations within.
} else '' @@ -889,7 +889,7 @@ WOK file_suffix=e["filename"][/.+?\.(ss[ftms])/, 1] #metadata_found_endnotes if @text_search_flag - if e["metadata_tid"].to_i != oldtid.to_i + if e["metadata_tid"].to_i != oldtid.to_i title=%{

#{e["title"]} by #{e["creator"]} pdf portraitpdf landscape
} if file_suffix=~/s/ @counter_endn_doc+=1 oldtid=e["metadata_tid"].to_i @@ -898,7 +898,7 @@ WOK if cgi['view']=~/text/ #% txt endnotes @counter_endn_ocn+=1 matched_endnote=e["body"].gsub(/(#@search_regx)/i,%{\\1}) - output=%{#{title}
note #{e["nr"]} referred to from ocn #{e["ocn"]}: #{matched_endnote}} + output=%{#{title}
note #{e["nr"]} referred to from ocn #{e["ocn"]}: #{matched_endnote}} elsif cgi['view']=~/index/ #% idx endnotes @counter_endn_ocn+=1 output=%{#{title}#{e["nr"]} [§ #{e["ocn"]}], } diff --git a/data/sisu/conf/cgi-bin/sisu_search_sqlite.cgi b/data/sisu/conf/cgi-bin/sisu_search_sqlite.cgi index f4c5382a..5bef900e 100644 --- a/data/sisu/conf/cgi-bin/sisu_search_sqlite.cgi +++ b/data/sisu/conf/cgi-bin/sisu_search_sqlite.cgi @@ -1,6 +1,6 @@ #!/usr/bin/env ruby =begin - * Name: SiSU information Structuring Universe + * Name: SiSU information Structuring Universe * Author: Ralph Amissah * http://www.jus.uio.no/sisu * http://www.jus.uio.no/sisu/SiSU/download @@ -39,11 +39,11 @@ SiSU was first released to the public on January 4th 2005 SiSU uses: - + * Standard SiSU markup syntax, * Standard SiSU meta-markup syntax, and the * Standard SiSU object citation numbering and system - + © Ralph Amissah 1997, current 2006. All Rights Reserved. @@ -68,7 +68,7 @@ class Form @base,@search_field,@selected_db,@checked_index,@checked_text,@checked_tip,@checked_searched,@checked_url,@checked_echo,@checked_sql,@checked_all,@checked_none,@checked_ignore,@search_note,@the_can=base,search_field,selected_db,checked_index,checked_text,checked_tip,checked_searched,checked_url,checked_echo,checked_sql,checked_all,checked_none,checked_ignore,search_note,the_can @tip=if checked_tip =~/\S/ 'text:__; keywords:__; title:__; author:__; subject:__; description:__; publisher:__; contributor:__; date:__; type:__; format:__; identifier:__; source:__; language:__; relation:__; coverage:__; rights:__; comment:__; abstract:__; ' - else '' + else '' end end def submission_form @@ -105,7 +105,7 @@ class Form #@tip - + echo searched @@ -339,10 +339,10 @@ class Dbi_search_statement %{SELECT metadata.title, metadata.creator, metadata.filename, endnotes.body, endnotes.nr, endnotes.ocn, endnotes.metadata_tid FROM metadata, endnotes WHERE #{@search_endnotes} AND metadata.tid = endnotes.metadata_tid ORDER BY metadata.title, endnotes.nr ;} end def sql_select_body_format - %{#{sql_select_body}} + %{#{sql_select_body}} end def sql_select_endnotes_format - %{#{sql_select_endnotes}} + %{#{sql_select_endnotes}} end def contents @conn.select_all(sql_select_body) @@ -674,8 +674,8 @@ FCGI.each_cgi do |cgi| @search=Hash.new @search[:text],@search[:endnotes]=Array.new,Array.new q=CGI.new - @db=if cgi['db'] =~/\S+/: - @stub=/SiSU_(\S+)/.match(cgi['db'])[1] + @db=if cgi['db'] =~/\S+/: + @stub=/SiSU_(\S+)/.match(cgi['db'])[1] cgi['db'] else @stub='sisu' @@ -685,17 +685,17 @@ FCGI.each_cgi do |cgi| if cgi['view']=~/text/: checked_index,checked_text='','checked' else checked_index,checked_text='checked','' end - checked_url='checked' if cgi['url'] =~/\S/ or cgi['u'].to_i==1 - checked_searched='checked' if cgi['searched'] =~/\S/ - checked_tip='checked' if cgi['tip'] =~/\S/ - checked_echo='checked' if cgi['echo'] =~/\S/ - checked_sql='checked' if cgi['sql'] =~/\S/ - if cgi['checks'] =~/check_all/ or cgi['check_all'] =~/\S/ or cgi['a'].to_i==1 + checked_url='checked' if cgi['url'] =~/\S/ or cgi['u'].to_i==1 + checked_searched='checked' if cgi['searched'] =~/\S/ + checked_tip='checked' if cgi['tip'] =~/\S/ + checked_echo='checked' if cgi['echo'] =~/\S/ + checked_sql='checked' if cgi['sql'] =~/\S/ + if cgi['checks'] =~/check_all/ or cgi['check_all'] =~/\S/ or cgi['a'].to_i==1 checked_all=checked_url=checked_searched=checked_tip=checked_echo=checked_sql='checked' - checked_none='' - elsif cgi['checks'] =~/check_none/ #or cgi['a'].to_i==0 + checked_none='' + elsif cgi['checks'] =~/check_none/ #or cgi['a'].to_i==0 checked_none='checked' - checked_all=checked_url=checked_searched=checked_tip=checked_echo=checked_sql='' + checked_all=checked_url=checked_searched=checked_tip=checked_echo=checked_sql='' else checked_ignore='checked' end selected_db=case cgi['db'] @@ -708,7 +708,7 @@ FCGI.each_cgi do |cgi| when /SiSU_sisu/: "/home/ralph/sisu_www/sisu/sisu_sqlite.db" end @dbi="DBI:SQLite:#{db_sqlite}" #sqlite3 ? - @conn=DBI.connect(@dbi) + @conn=DBI.connect(@dbi) search_field=cgi['find'] if cgi['find'] # =~/\S+/ @search_for=Search_request.new(search_field,q) #.analyze #% search_for #% searches @@ -740,7 +740,7 @@ FCGI.each_cgi do |cgi| canned_search_url=if checked_all =~/checked/ "#@base?#{s1}#{key}#{ti}#{au}#{sj}#{dsc}#{pb}#{cntr}#{dt}#{ty}#{id}#{src}#{lang}#{rel}#{cov}#{cr}#{co}#{ab}#{dtc}#{dti}#{dtm}#{dta}#{dtv}&db=#{cgi['db']}&view=#{cgi['view']}&a=1" else "#@base?#{s1}#{key}#{ti}#{au}#{sj}#{dsc}#{pb}#{cntr}#{dt}#{ty}#{id}#{src}#{lang}#{rel}#{cov}#{cr}#{co}#{ab}#{dtc}#{dti}#{dtm}#{dta}#{dtv}&db=#{cgi['db']}&view=#{cgi['view']}&u=1&e=1" - end + end @search[:text][1]=%{documents.clean~'#{@search_for.text1}'} #s1 @search[:endnotes][1]=%{endnotes.clean~'#{@search_for.text1}'} #s1 canned_note='previous search url:' @@ -759,7 +759,7 @@ FCGI.each_cgi do |cgi| af.gsub!(/%2B/,' ') analyze_format=af st=af.split(/\s*;\s*/) - search_field=st.join("\n") + search_field=st.join("\n") end green=%{} the_can=%{#{canned_note}
#{canned_search_url}
} @@ -795,7 +795,7 @@ WOK #dbi_canning @header=Form.new(@base,search_field,selected_db,checked_index,checked_text,checked_tip,checked_searched,checked_url,checked_echo,checked_sql,checked_all,checked_none,checked_ignore,search_note,the_can).submission_form #% form @tail=Tail.new.tail - unless q['s1'] =~/\S/ or q['au'] =~/\S/ or @search[:text][1] =~/\S/ + unless q['s1'] =~/\S/ or q['au'] =~/\S/ or @search[:text][1] =~/\S/ print "Content-type: text/html\n\n" puts (@header+@tail) else #% searches @@ -814,7 +814,7 @@ WOK @body_main=Array.new @endnotes=Array.new oldtid=0 - if @text_search_flag + if @text_search_flag if checked_sql =~/\S/ sql_select_body=dbi_statement.sql_select_body_format sql_select_endnotes=dbi_statement.sql_select_endnotes_format @@ -831,14 +831,14 @@ WOK #metadata_found_body if c["tid"].to_i != oldtid.to_i title=%{#{c["title"]} by #{c["creator"]} pdf portraitpdf landscape
} if file_suffix=~/s/ #hmm watch file_suffix - if @text_search_flag: title='
'+title - else title='
'+title + if @text_search_flag: title='
'+title + else title='
'+title end @counter_txt_doc+=1 oldtid=c["tid"].to_i else title='' end - if @text_search_flag + if @text_search_flag if cgi['view']=~/text/ #% txt body text=if c["suffix"] !~/1/ #seg if @search_for.text1 =~/\S+/ or q['s1'] =~/\S+/ #% only this branch is working !! @@ -857,22 +857,22 @@ WOK @search_regx=search_regex.to_s end matched_para=c["body"].gsub(/(#@search_regx)/i,%{\\1}) - %{

ocn #{c["ocn"]}:

#{matched_para}} + %{

ocn #{c["ocn"]}:

#{matched_para}} elsif c["suffix"] =~/1/ #doc %{#{title}

ocn #{c["ocn"]}:#{c["body"]}} end @counter_txt_ocn+=1 output=if c["seg"] =~/\S+/: title+text - else text + else text end elsif cgi['view']=~/index/ #% idx body if c["suffix"] !~/1/ #seg - index=%{#{c["ocn"]}, } if @text_search_flag + index=%{#{c["ocn"]}, } if @text_search_flag elsif c["suffix"] =~/1/ #doc - index=%{#{c["ocn"]}, } + index=%{#{c["ocn"]}, } end - if c["seg"] =~/\S+/ - if @text_search_flag + if c["seg"] =~/\S+/ + if @text_search_flag @counter_txt_ocn+=1 output=title+index end @@ -883,8 +883,8 @@ WOK end end end - else output=title - end + else output=title + end @counters_txt=if @counter_txt_doc > 0 %{Found in the main body of #@counter_txt_doc documents, and at #@counter_txt_ocn locations within.
} else '' @@ -898,7 +898,7 @@ WOK file_suffix=e["filename"][/.+?\.(ss[ftm])/, 1] #metadata_found_endnotes if @text_search_flag - if e["metadata_tid"].to_i != oldtid.to_i + if e["metadata_tid"].to_i != oldtid.to_i title=%{

#{e["title"]} by #{e["creator"]} pdf portraitpdf landscape
} if file_suffix=~/s/ @counter_endn_doc+=1 oldtid=e["metadata_tid"].to_i @@ -907,7 +907,7 @@ WOK if cgi['view']=~/text/ #% txt endnotes @counter_endn_ocn+=1 matched_endnote=e["body"].gsub(/(#@search_regx)/i,%{\\1}) - output=%{#{title}
note #{e["nr"]} referred to from ocn #{e["ocn"]}: #{matched_endnote}} + output=%{#{title}
note #{e["nr"]} referred to from ocn #{e["ocn"]}: #{matched_endnote}} elsif cgi['view']=~/index/ #% idx endnotes @counter_endn_ocn+=1 output=%{#{title}#{e["nr"]} [§ #{e["ocn"]}], } diff --git a/data/sisu/conf/ruby/irbrc b/data/sisu/conf/ruby/irbrc index b585faf6..cceffdfc 100644 --- a/data/sisu/conf/ruby/irbrc +++ b/data/sisu/conf/ruby/irbrc @@ -1,7 +1,7 @@ require 'irb/completion' IRB.conf[:use_readline] = true IRB.conf[:PROMPT_MODE] = :XMP -#IRB.conf[:PROMPT] = +#IRB.conf[:PROMPT] = #simple-prompt def ri arg puts `ri #{arg}` diff --git a/data/sisu/conf/syntax/README b/data/sisu/conf/syntax/README index 04c0ea09..82d5ff67 100644 --- a/data/sisu/conf/syntax/README +++ b/data/sisu/conf/syntax/README @@ -75,18 +75,18 @@ contains rudimentary sisu syntax highlighting files for: some error checking * comments: this editor features display line wrap -NOTE: +NOTE: -[SiSU parses files with long lines or line breaks, -but, display linewrap (without line-breaks) is a +[SiSU parses files with long lines or line breaks, +but, display linewrap (without line-breaks) is a convenient editor feature to have for sisu markup] kde-config --prefix -KDEDIR/share/apps/katepart/syntax/ +KDEDIR/share/apps/katepart/syntax/ KDEHOME/share/apps/katepart/syntax -[In the configure dialog in kate, go to the "Editor->highlighting" page and ->select a highlight to change the mimetype/pattern associations for it.] +[In the configure dialog in kate, go to the "Editor->highlighting" page and +>select a highlight to change the mimetype/pattern associations for it.] /etc/mime.types /usr/share/mime/text -# +# # * aeditor (an editor written in ruby) diff --git a/data/sisu/conf/syntax/diakonos.conf b/data/sisu/conf/syntax/diakonos.conf index 212ed5b8..f40547bc 100644 --- a/data/sisu/conf/syntax/diakonos.conf +++ b/data/sisu/conf/syntax/diakonos.conf @@ -30,7 +30,7 @@ bol_behaviour alternating-first-char eof_newline false # Specifies whether the cursor should be at the end (false) of found text, or the -# beginning (true). +# beginning (true). found_cursor_start false max_clips 30 @@ -920,7 +920,7 @@ lang.yaml.indent.ignore ^\s*$ #% SiSU lang.sisu.filemask \.(?:sst|ssm|ssi|[_-]sst)$ -lang.sisu.format.default white +lang.sisu.format.default white lang.sisu.tokens.comment ^%+\s+.* lang.sisu.tokens.comment.format 8 #langsisu.tokens.comments.format 8 bold diff --git a/data/sisu/conf/syntax/nanorc b/data/sisu/conf/syntax/nanorc index 82183131..213a0c26 100644 --- a/data/sisu/conf/syntax/nanorc +++ b/data/sisu/conf/syntax/nanorc @@ -165,7 +165,7 @@ ## to set the background color to black or white. ## # syntax "c-file" "\.(c|C|cc|cpp|cxx|h|H|hh|hpp|hxx)$" -# color red "\<[A-Z_]{2,}\>" +# color red "\<[A-Z_]{2,}\>" # color green "\<(float|double|bool|char|int|short|long|sizeof|enum|void|static|const|struct|union|typedef|extern|signed|unsigned|inline)\>" # color green "\<(class|namespace|template|public|protected|private|typename|this|friend|virtual|using|mutable|volatile|register|explicit)\>" # color brightyellow "\<(for|if|while|do|else|case|default|switch|goto|continue|break|return)\>" diff --git a/data/sisu/conf/syntax/sisu-mode.el b/data/sisu/conf/syntax/sisu-mode.el index 3f56de1c..c12c1a72 100644 --- a/data/sisu/conf/syntax/sisu-mode.el +++ b/data/sisu/conf/syntax/sisu-mode.el @@ -61,13 +61,13 @@ ;; ;; default variables ;; (defvar sisu-mode.el-hook nil) -;; +;; ;; (defvar sisu-mode-map ;; (let ((sisu-mode-map (make-keymap))) ;; (define-key wpdl-mode-map "\C-j" 'newline-and-indent) ;; sisu-mode-map) ;; "Keymap for SiSU major mode") -;; +;; ;; (add-to-list 'auto-mode-alist '("\\.ss[tmi]\\'" . sisu-mode)) (defvar sisu-mode-hook nil) @@ -123,7 +123,7 @@ ; select more appropriate matches )) "Additional Keywords to highlight in SiSU mode") - + (defconst sisu-font-lock-keywords-3 (append sisu-font-lock-keywords-2 (list @@ -133,7 +133,7 @@ (defvar sisu-font-lock-keywords sisu-font-lock-keywords-3 "Default highlighting expressions for SiSU mode") - + (defvar sisu-mode-syntax-table (let ((sisu-mode-syntax-table (make-syntax-table))) (modify-syntax-entry ?_ "w" sisu-mode-syntax-table) @@ -162,7 +162,7 @@ ;; (let ((map (make-sparse-keymap))) ;; ;; insert (define-key map ...) stuff here ;; (setq sisu-mode.el-map map))) -;; +;; ;; syntax highlighting: standard keywords ;; (defconst sisu-font-lock-keywords-1 ;; '( @@ -171,7 +171,7 @@ ;; ;; ("^[ \t]+\\(.*\\)$" 1 font-lock-type-face) ;; ) ;; "Minimal highlighting expressions for SiSU mode.") -;; +;; ;; ;; syntax highlighting: additional keywords ;; (defconst sisu-font-lock-keywords-2 ;; (append sisu-font-lock-keywords-1 @@ -179,7 +179,7 @@ ;; ("%+ \\(.*\\)" 2 font-lock-comment-face) ;; )) ;; "Additional Keywords to highlight in SiSU mode.") -;; +;; ;; ;; syntax highlighting: even more keywords ;; (defconst sisu-font-lock-keywords-3 ;; (append sisu-font-lock-keywords-2 @@ -193,21 +193,21 @@ ;; ("\"\\([^\"]+\\)\"" 0 font-lock-string-face) ;; )) ;; "Balls-out highlighting in SiSU mode.") -;; +;; ;; ;; default level of highlight to maximum ;; (defvar sisu-font-lock-keywords sisu-font-lock-keywords-3 ;; "Default highlighting expressions for SiSU mode") -;; +;; ;; ;; no special indenting, just pure text mode ;; (defun sisu-indent-line () ;; "Indent current line as SiSU code. Does nothing yet." ;; (interactive) ;; ) -;; +;; ;; ;; no special syntax table ;; (defvar sisu-mode.el-syntax-table nil ;; "Syntax table for sisu-mode.el.") -;; +;; ;; ;; create and activate syntax table ;; (defun sisu-create-syntax-table () ;; (if sisu-mode.el-syntax-table diff --git a/data/sisu/conf/syntax/sisu.lang b/data/sisu/conf/syntax/sisu.lang index df126b23..4fcd9b68 100644 --- a/data/sisu/conf/syntax/sisu.lang +++ b/data/sisu/conf/syntax/sisu.lang @@ -2,7 +2,7 @@ @@ -34,11 +34,11 @@ or: [/_,^+-]\{ \}[/_,^+-] - + [*]\S+[*] - + \{[^}]+\}(http:\/\/\S+|image)\s diff --git a/data/sisu/conf/syntax/sisu.xml b/data/sisu/conf/syntax/sisu.xml index d54483ac..9467ec44 100644 --- a/data/sisu/conf/syntax/sisu.xml +++ b/data/sisu/conf/syntax/sisu.xml @@ -147,7 +147,7 @@ - + diff --git a/data/sisu/conf/syntax/sisu_nedit.pats b/data/sisu/conf/syntax/sisu_nedit.pats index 8e12cd5c..e60e0bf0 100644 --- a/data/sisu/conf/syntax/sisu_nedit.pats +++ b/data/sisu/conf/syntax/sisu_nedit.pats @@ -1,4 +1,4 @@ -! Nedit Syntax highlighting patterns and commenting for SiSU +! Nedit Syntax highlighting patterns and commenting for SiSU ! Version 0.1 ! ! INSTALLATION diff --git a/data/sisu/conf/vim/addons/ftplugin/sisu.vim b/data/sisu/conf/vim/addons/ftplugin/sisu.vim index 8526206c..00ed9189 100644 --- a/data/sisu/conf/vim/addons/ftplugin/sisu.vim +++ b/data/sisu/conf/vim/addons/ftplugin/sisu.vim @@ -11,7 +11,7 @@ :endif :autocmd FileType sisu :set nonumber :set encoding=utf-8 fileencodings= -:set ff=unix +:set ff=unix :set autowrite " Automatically save before commands like :next and :make :set nocompatible :set tabstop=2 @@ -54,7 +54,7 @@ "% vimdiff q exits :if &diff : cmap q qa -:endif +:endif "% remapping lines make cursor jump a line at a time within wrapped text :nnoremap j gj :nnoremap k gk @@ -122,7 +122,7 @@ "% foldtype Fold? set foldtext :set foldtext=v:folddashes.substitute(getline(v:foldstart),'\\=','','g',) :set foldexpr=getline(v:lnum-1)!~@/&&getline(v:lnum)!~@/&&getline(v:lnum+1)!~@/ -"% foldsearch t77: Fold on search result +"% foldsearch t77: Fold on search result :function! FoldMake(search) : set fdm=manual : normal zE @@ -169,7 +169,7 @@ : command! F4 FMake ^[1-4]\~ : command! F5 FMake ^[4-5]\~ : command! F6 FMake ^[4-6]\~ -: command! Fc FMake ^[%]\+\s\+ +: command! Fc FMake ^[%]\+\s\+ : endif "% folds Fold Patterns misc ":command! Fp FMake ^\s*[A-Za-z0-9#] diff --git a/lib/sisu/v0/cgi_sql_common.rb b/lib/sisu/v0/cgi_sql_common.rb index 13f9c2a3..a71d5412 100644 --- a/lib/sisu/v0/cgi_sql_common.rb +++ b/lib/sisu/v0/cgi_sql_common.rb @@ -111,6 +111,8 @@ module SiSU_CGI_sql @@limit,@@offset=1000,0 @base="#@hosturl_db/cgi-bin/#@version.cgi" @@canned_search_url=@base + @color_heading='#DDFFAA' + @color_match='#ffff48' class Form def initialize(base,search_field,selected_db,checked_index,checked_text,checked_tip,checked_searched,checked_url,checked_echo,checked_sql,checked_all,checked_none,checked_ignore,search_note,the_can='') search_note='' if checked_searched !~/\S/ @@ -658,7 +660,7 @@ module SiSU_CGI_sql end #metadata_found_body if c['tid'].to_i != oldtid.to_i - title=%{#{c['title']} by #{c['creator']} pdf portraitpdf landscape manifest ?
} if file_suffix=~/s/ #hmm watch file_suffix + title=%{#{c['title']} by #{c['creator']} pdf portraitpdf landscape manifest ?
} if file_suffix=~/s/ #hmm watch file_suffix if @text_search_flag; title='
'+title else title='
'+title end @@ -689,7 +691,13 @@ module SiSU_CGI_sql end else nil end - matched_para=(@search_regx.to_s.class==String && @search_regx.to_s=~/\S\S+/) ? (c['body'].gsub(/(#@search_regx)/,'\1')) : c['body'] #check + matched_para=if (@search_regx.to_s.class==String && @search_regx.to_s=~/\S\S+/) + matched=if c['body'] =~/\\1})) + end + matched + else c['body'] + end %{

ocn #{c['ocn']}:

#{matched_para}} elsif c['suffix'] =~/1/ #doc %{#{title}

ocn #{c['ocn']}:#{c['body']}} @@ -738,14 +746,21 @@ module SiSU_CGI_sql #metadata_found_endnotes if @text_search_flag if e['metadata_tid'].to_i != oldtid.to_i - title=%{

#{e['title']} by #{e['creator']} pdf portraitpdf landscape manifest ?
} if file_suffix=~/s/ + title=%{
#{e['title']} by #{e['creator']} pdf portraitpdf landscape manifest ?
} if file_suffix=~/s/ @counter_endn_doc+=1 oldtid=e['metadata_tid'].to_i else title = '' end if cgi['view']=~/text/ #% txt endnotes @counter_endn_ocn+=1 - matched_endnote=(@search_regx.to_s.class==String && @search_regx.to_s=~/\S\S+/) ? (e['body'].to_s.gsub(/(#@search_regx)/,'\1')) : e['body'] #check + matched_endnote=if (@search_regx.to_s.class==String && @search_regx.to_s=~/\S\S+/) + matched=if e['body'] =~/\\1}) + #e['body'] + end + matched + else e['body'] + end output=%{#{title}
note #{e['nr']} referred to from ocn #{e['ocn']}: #{matched_endnote}} elsif cgi['view']=~/index/ #% idx endnotes @counter_endn_ocn+=1 diff --git a/lib/sisu/v0/db_load_tuple.rb b/lib/sisu/v0/db_load_tuple.rb index 9d513fda..30d8389e 100644 --- a/lib/sisu/v0/db_load_tuple.rb +++ b/lib/sisu/v0/db_load_tuple.rb @@ -60,12 +60,12 @@ module SiSU_DB_tuple def tuple #% import line begin if @col[:en_a] - #puts.inspect "#{@col[:lid]}, #{@col[:tid]}, #{@col[:lev]}, '#{@col[:plaintext]}', '#{@col[:body]}', '#{@col[:ocn]}', '#{@col[:ocnd]}', '#{@col[:ocns]}', '#{@col[:seg]}', '#{@col[:lv1]}', '#{@col[:lv2]}', '#{@col[:lv3]}', '#{@col[:lv4]}', '#{@col[:lv5]}', '#{@col[:lv6]}', '#{@col[:en_a]}', '#{@col[:en_z]}'" + #puts "#{@col[:lid]}, #{@col[:tid]}, #{@col[:lev]}, '#{@col[:plaintext]}', '#{@col[:body]}', '#{@col[:ocn]}', '#{@col[:ocnd]}', '#{@col[:ocns]}', '#{@col[:seg]}', '#{@col[:lv1]}', '#{@col[:lv2]}', '#{@col[:lv3]}', '#{@col[:lv4]}', '#{@col[:lv5]}', '#{@col[:lv6]}', '#{@col[:en_a]}', '#{@col[:en_z]}'" @conn.execute(%{ INSERT INTO documents (lid, metadata_tid, lev, clean, body, ocn, ocnd, ocns, seg, lev1, lev2, lev3, lev4, lev5, lev6, en_a, en_z, digest_clean, digest_all) VALUES (#{@col[:lid]}, #{@col[:tid]}, #{@col[:lev]}, '#{@col[:plaintext]}', '#{@col[:body]}', '#{@col[:ocn]}', '#{@col[:ocnd]}', '#{@col[:ocns]}', '#{@col[:seg]}', '#{@col[:lv1]}', '#{@col[:lv2]}', '#{@col[:lv3]}', '#{@col[:lv4]}', '#{@col[:lv5]}', '#{@col[:lv6]}', '#{@col[:en_a]}', '#{@col[:en_z]}', '#{@col[:digest_clean]}', '#{@col[:digest_all]}'); }) else - #puts.inspect "#{@col[:lid]}, #{@col[:tid]}, #{@col[:lev]}, '#{@col[:plaintext]}', '#{@col[:body]}', '#{@col[:ocn]}', '#{@col[:ocnd]}', '#{@col[:ocns]}', '#{@col[:seg]}', '#{@col[:lv1]}', '#{@col[:lv2]}', '#{@col[:lv3]}', '#{@col[:lv4]}', '#{@col[:lv5]}', '#{@col[:lv6]}'" + #puts "#{@col[:lid]}, #{@col[:tid]}, #{@col[:lev]}, '#{@col[:plaintext]}', '#{@col[:body]}', '#{@col[:ocn]}', '#{@col[:ocnd]}', '#{@col[:ocns]}', '#{@col[:seg]}', '#{@col[:lv1]}', '#{@col[:lv2]}', '#{@col[:lv3]}', '#{@col[:lv4]}', '#{@col[:lv5]}', '#{@col[:lv6]}'" @conn.execute(%{ INSERT INTO documents (lid, metadata_tid, lev, clean, body, ocn, ocnd, ocns, seg, lev1, lev2, lev3, lev4, lev5, lev6, digest_clean, digest_all) VALUES (#{@col[:lid]}, #{@col[:tid]}, #{@col[:lev]}, '#{@col[:plaintext]}', '#{@col[:body]}', '#{@col[:ocn]}', '#{@col[:ocnd]}', '#{@col[:ocns]}', '#{@col[:seg]}', '#{@col[:lv1]}', '#{@col[:lv2]}', '#{@col[:lv3]}', '#{@col[:lv4]}', '#{@col[:lv5]}', '#{@col[:lv6]}', '#{@col[:digest_clean]}', '#{@col[:digest_all]}'); }) diff --git a/lib/sisu/v0/shared_html_lite.rb b/lib/sisu/v0/shared_html_lite.rb index 3c0e9ce1..75137148 100644 --- a/lib/sisu/v0/shared_html_lite.rb +++ b/lib/sisu/v0/shared_html_lite.rb @@ -94,6 +94,7 @@ module SiSU_Format_Shared png=m.scan(/\S+/)[0].strip link=link.strip ins=%{#{link}#{d}} + #ins=%{#{link} [link]#{d}} word.gsub!(/\{.+?\}(?:https?|ftp)\S+/,ins) end word diff --git a/lib/sisu/v0/texpdf.rb b/lib/sisu/v0/texpdf.rb index aec45b58..a5db4c77 100644 --- a/lib/sisu/v0/texpdf.rb +++ b/lib/sisu/v0/texpdf.rb @@ -283,12 +283,12 @@ module SiSU_TeX else para end if para.class == String - @md.flag_tables=true if para =~// or @@flag_group==true if para =~/<:(code|alt|verse|group)>/ - @lineone=case para - when /<:(alt|verse|group)>/; para + @lineone=case para + when /<:(alt|verse|group)>/; para when /<:code>/; "#{@tex.paraskip_small} \\begin{footnotesize} \\begin{ttfamily} " + para else 'error' #should never occur end @@ -440,9 +440,9 @@ WOK elsif @@flag_group==true; @group_collect << para #<< "\n\n" end if x =~/(?:code|alt|verse|group)-end/ - regx=/(\\+marginpar\{\\+begin\{tiny\}\d+\\+end\{tiny\}\})/ + regx=/(\\+marginpar\{\\+begin\{tiny\}\d+\\+end\{tiny\}\})/ y=if para =~regx - regx.match(para)[1] + regx.match(para)[1] else '' end para.gsub!(regx,'') diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 10d38caa..4f89c852 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,14 +1,14 @@ -.\" Name: SiSU information Structuring Universe +.\" Name: SiSU information Structuring Universe .\" Author: Ralph Amissah .\" Description: sisu manpage .\" arch-tag: sisu manpage .\" License: GPL 2 or later .\" Notes: Process this file with .\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" /[^\\][-'] +.\" nroff -man sisu.1 | most +.\" /[^\\][-'] .\" :%s/\([^\\]\)\([-']\)/\1\\\2/c -.\" |sisu.1|@|^| +.\" |sisu.1|@|^| .TH "sisu" "1" "April 04, 2007" "version 0.52" "USER COMMANDS and basic Markup" .SH "NAME" .B SiSU @@ -20,60 +20,60 @@ .B ] [ .I filename/ wildcard .B ] -.PP +.PP .B sisu .B [ .I \-Ddcv .B ] [ .I instruction .B ] -.PP +.PP .B sisu .B [ .I \-CcFLSVvW .B ] -.PP +.PP Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. -.\" %% Description +.\" %% Description .SH "DESCRIPTION" .B SiSU SiSU is a document publishing system, that from a simple single marked\-up document, produces multiple of output formats including: plaintext, html, LaTeX, pdf, xhtml, XML, info, and SQL (PostgreSQL and SQLite), which share numbered text objects ("object citation numbering") and the same document structure information. For more see: .I -.PP -.\" %% Summary +.PP +.\" %% Summary .SH "Summary of man page" -.TP +.TP This man page covers a number of subjects in brief, including: document processing command flags; document markup (basic markup and headers); configuration files; directory structure; skins; document naming; interactive help and other information. -.\" %% Flags +.\" %% Flags .SH "DOCUMENT PROCESSING COMMAND FLAGS" -.TP +.TP .BI \-A \ [filename/wildcard] produces .I plaintext -with +with .I dos linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ .I \-a for equivalent Unix (linefeed) output file] [see .I \-E for endnotes]. -.TP +.TP .BI \-a \ [filename/wildcard] produces .I plaintext -with +with .I Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ .I \-A for equivalent dos (linefeed) output file] [see .I \-e for endnotes]. -.TP +.TP .BI \-b \ [filename/wildcard] -produces +produces .I xhtml/XML output for browser viewing (sax parsing). -.TP +.TP .BI \-C \ [\-\-init=site] .I configure/initialise shared output directory files initialize shared output directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). @@ -81,17 +81,17 @@ shared output directory files initialize shared output directory (config files s .I configure/initialise site more extensive than .I \-C -on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. -.TP +on its own, shared output directory files/force update, existing shared output config files such as css and dtd files are updated if this modifier is used. +.TP .BI \-c \ [filename/wildcard] -screen +screen .I toggle ansi screen colour on or off depending on default set (unless \-c flag is used: if sisurc colour default is set to \'true\', output to screen will be with colour, if sisurc colour default is set to \'false\' or is undefined screen output will be without colour). -.TP +.TP .BI \-D \ [instruction] \ [filename] database postgresql ( -.I \-\-pgsql +.I \-\-pgsql may be used instead) possible instructions, include: .I \-\-createdb; @@ -101,11 +101,11 @@ possible instructions, include: .I \-\-update \ [filename]; .I \-\-remove \ [filename]; see database section below. -.TP +.TP .BI \-d \ [\-\-db\-[database \ type \ (sqlite|pg)]] \ \-\-[instruction] \ [filename] database type default set to sqlite, (for which -.I \-\-sqlite +.I \-\-sqlite may be used instead) or to specify another database .I \-\-db\-[pgsql, sqlite] @@ -118,89 +118,89 @@ possible instructions include: .I \-\-update \ [filename]; .I \-\-remove \ [filename]; see database section below. -.TP +.TP .BI \-E \ [filename/wildcard] -produces +produces .I plaintext -with +with .I dos linefeeds, -and without markup, endnotes follow the main text (in +and without markup, endnotes follow the main text (in .I \-a -endnotes follow the paragraphs that contain them). There are no object numbers [see +endnotes follow the paragraphs that contain them). There are no object numbers [see .I \-e for Unix (linefeed) output file] [see .I \-A for footnotes]. -.TP +.TP .BI \-e \ [filename/wildcard] -produces +produces .I plaintext -with +with .I Unix linefeeds, and without markup, endnotes follow the main text. Object numbers are omitted. [ .I \-E for equivalent dos (linefeed) output file] [ .I \-a for footnotes]. -.TP +.TP .BI \-F \ [\-\-webserv=webrick] generate examples of (naive) .I cgi search form -for +for .I sqlite -and +and .I pgsql -depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -.I \-d -.I \-D -and the +depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see +.I \-d +.I \-D +and the .I database section below. If the optional parameter .I \-\-webserv=webrick -is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the +is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the .I cgi\-bin directory). -.I \-Fv +.I \-Fv (in addition to the above) provides some information on setting up .I hyperestraier for sisu .\" An alternative optional parameter .\" .I the letters pwd -.\" anticipates that the present work directory will be used to test the cgi script. -.TP +.\" anticipates that the present work directory will be used to test the cgi script. +.TP .\" .BI \-g \ [filename/wildcard] .\" produces html/css/scroll (using markup shared with db)output for browser viewing (easily modified to XML) -.\" .TP +.\" .TP .BI \-H \ [filename/wildcard] -produces +produces .I html without link suffixes (.html .pdf etc.) ("Hide"). Requires an appropriately configured web server. [behaviour switched after 0.35 see \-h]. -.TP +.TP .BI \-h \ [filename/wildcard] -produces +produces .I html (with hardlinks i.e. with name suffixes in links/local urls). html, with internal document links that include the document suffix, i.e. whether it is .html or .pdf (required for browsing directly off a file system, and works with most web servers). [behaviour switched after 0.35 see \-H]. -.TP +.TP .BI \-I \ [filename/wildcard] -produces +produces .I texinfo file. -.TP +.TP .BI \-L prints license information. -.TP +.TP .BI \-M \ [filename/wildcard/url] .I maintenance mode files created for processing preserved and their locations indicated. (also see \-V) -.TP +.TP .BI \-m \ [filename/wildcard/url] assumed for most other flags, creates new meta\-markup file, (the .I metaverse ) that is used in all subsequent processing of other output. This step is assumed for most processing flags. To skip it see .I \-n -.TP +.TP .BI \-N \ [filename/wildcard/url] document .I digest @@ -214,56 +214,56 @@ as of the document: the digest for the document, and digests for each object contained within the document (together with information on software versions that produced it) (digest.txt). .I \-NV for verbose digest output to screen. -.TP +.TP .BI \-n \ [filename/wildcard/url] -skip meta\-markup (building of "metaverse"), this skips the equivalent of +skip meta\-markup (building of "metaverse"), this skips the equivalent of .I \-m which is otherwise assumed by most processing flags. -.TP +.TP .BI \-o \ [filename/wildcard/url] output basic document in .I opendocument file format (opendocument.odt). -.TP +.TP .BI \-p \ [filename/wildcard] -produces +produces .I LaTeX pdf (portrait.pdf & landscape.pdf). Default paper size is set in config file, or document header, or provided with additional command line parameter, e.g. .I \-\-papersize\-a4 preset sizes include: 'A4', U.S. 'letter' and 'legal' and book sizes 'A5' and 'B5' (system defaults to A4). -.TP +.TP .BI \-q \ [filename/wildcard] .I quiet less output to screen. -.TP +.TP .BI \-R \ [filename/wildcard] .I copies -sisu output files to +sisu output files to .I remote host using rsync. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Note the behavior of rsync different if \-R is used with other flags from if used alone. Alone the rsync \-\-delete parameter is sent, useful for cleaning the remote directory (when \-R is used together with other flags, it is not). Also see .I \-r -.TP +.TP .BI \-r \ [filename/wildcard] .I copies -sisu output files to +sisu output files to .I remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see .I \-R -.TP +.TP .BI \-S produces a .I sisupod a zipped sisu directory of markup files -including +including .I sisu markup source files -and the directories local +and the directories local .I configuration file, .I images and .I skins. .B Note: -this only includes the configuration files or skins contained in +this only includes the configuration files or skins contained in .I ./_sisu not those in .I ~/.sisu @@ -271,425 +271,425 @@ not those in option. .B Note: (this option is tested only with zsh). -.TP +.TP .BI \-S \ [filename/wildcard] produces a zipped file of the prepared document specified along with associated images, by default named .I sisupod.zip -they may alternatively be named with the filename extension +they may alternatively be named with the filename extension .I .ssp -This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes -.I sisu markup source file, -(along with associated documents if a master file, or available in multilingual versions), +This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes +.I sisu markup source file, +(along with associated documents if a master file, or available in multilingual versions), together with related .I images and .I skin. SiSU commands can be run directly against a sisupod contained in a local directory, or provided as a url on a remote site. As there is a security issue with skins provided by other users, they are not applied unless the flag \-\-trust or \-\-trusted is added to the command instruction, it is recommended that file that are not your own are treated as untrusted. The directory structure of the unzipped file is understood by sisu, and sisu commands can be run within it. .B Note: -if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the +if you wish to send multiple files, it quickly becomes more space efficient to zip the sisu markup directory, rather than the individual files for sending). See the .I \-S option without [filename/wildcard]. -.TP +.TP .BI \-s \ [filename/wildcard] copies sisu markup file to output directory. -.TP +.TP .BI \-t \ [filename/wildcard \ (*.termsheet.rb)] standard form document builder, preprocessing feature -.TP +.TP .BI \-U \ [filename/wildcard] -prints +prints .I url output list/map -for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -.I \-u -provides +for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), +.I \-u +provides .I url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml -.TP +.TP .BI \-u \ [filename/wildcard] -provides +provides .I url mapping -of output files for the flags requested for processing, also see +of output files for the flags requested for processing, also see .I \-U -.TP +.TP .B \-V -on its own, provides SiSU +on its own, provides SiSU .I version and .I environment information (sisu \-\-help env) -.TP +.TP .BI \-V \ [filename/wildcard] -even more +even more .I verbose -than the +than the .I \-v flag. (also see \-M) -.TP +.TP .B \-v -on its own, provides SiSU +on its own, provides SiSU .I version information -.TP +.TP .BI \-v \ [filename/wildcard] -provides +provides .I verbose output -of what is being built, where it is being built (and error messages if any), as with +of what is being built, where it is being built (and error messages if any), as with .I \-u flag provides a url mapping of files created for each of the processing flag requests. See also .B \-V -.TP +.TP .BI \-W -starts ruby\'s +starts ruby\'s .I webrick webserver -points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the -.I \-h -option rather than +points at sisu output directories, the default port is set to 8081 and can be changed in the resource configuration files. [tip: the webrick server requires link suffixes, so html output should be created using the +.I \-h +option rather than .I \-H -; also, note +; also, note .I \-F webrick ]. -.\"% An alternative optional parameter +.\"% An alternative optional parameter .\" .I the letters pwd -.\" results in the cgi\-bin directory being set to the present work directory. This is offered to simplify testing the cgi test form generated by +.\" results in the cgi\-bin directory being set to the present work directory. This is offered to simplify testing the cgi test form generated by .\" .I \-S -.TP +.TP .BI \-w \ [filename/wildcard] -produces +produces .I concordance (wordmap) a rudimentary index of all the words in a document. -.TP +.TP .BI \-X \ [filename/wildcard] -produces +produces .I XML output with deep document structure, in the nature of dom. -.TP +.TP .BI \-x \ [filename/wildcard] produces .I XML output shallow structure (sax parsing). -.TP +.TP .BI \-Y \ [filename/wildcard] produces a short sitemap entry for the document, based on html output and the sisu_manifest. .I \-\-sitemaps generates/updates the sitemap index of existing sitemaps. (Experimental, [g,y,m announcement this week]) -.TP +.TP .BI \-y \ [filename/wildcard] produces an html summary of output generated (hyperlinked to content) and document specific metadata (sisu_manifest.html). This step is assumed for most processing flags. -.TP +.TP .BI \-Z \ [filename/wildcard] -Zap, if used with other processing flags +Zap, if used with other processing flags .I deletes output files -of the type about to be processed, prior to processing. -If \-Z is used as the lone processing related flag (or in conjunction with a combination of \-[mMvVq]), will remove the related document output directory. -.TP +of the type about to be processed, prior to processing. +If \-Z is used as the lone processing related flag (or in conjunction with a combination of \-[mMvVq]), will remove the related document output directory. +.TP .BI \-z \ [filename/wildcard] produces .I php (zend) [this feature is disabled for the time being] .\" %% modifiers .SH "modifiers" -.TP +.TP .BI \-\-no\-ocn [with \-h \-H or \-p] switches off object citation numbering. Produce output without identifying numbers in margins of html or LaTeX/pdf output. -.TP +.TP .BI \-\-no\-annotate strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus sign -.TP +.TP .BI \-\-no\-asterisk strips output text of editor endnotes~[* square brackets ]~ denoted by asterisk sign -.TP +.TP .BI \-\-no\-dagger strips output text of editor endnotes~[+ square brackets ]~ denoted by dagger/plus sign -.\" .TP +.\" .TP .\" .BI \-\-no\-asterisk -.\" .TP +.\" .TP .\" .BI \-\-no\-dagger -.\" .TP +.\" .TP .\" .BI \-\-no\-annotate -.\" %% Flags Database +.\" %% Flags Database .SH "databases" -.TP +.TP dbi \- database interface .B \-D or .B \-\-pgsql -set for -.I postgresql +set for +.I postgresql .B \-d or .B \-\-sqlite -default set for +default set for .I sqlite \-d is modifiable with \-\-db=[database \ type \ (pgsql \ or \ sqlite)] -.TP +.TP .B \-Dv \-\-createall initial step, creates required relations (tables, indexes) in existing postgresql database (a database should be created manually and given the same name as working directory, as requested) (rb.dbi) [ .I \-dv \-\-createall sqlite equivalent] it may be necessary to run sisu .I \-Dv \-\-createdb initially -.TP +.TP NOTE: at the present time for postgresql it may be necessary to manually create the database. The command would be .I 'createdb [database name]' where database name would be SiSU_[present working directory name (without path)]. Please use only alphanumerics and underscores. -.TP -.B \-Dv \-\-import +.TP +.B \-Dv \-\-import .I [filename/wildcard] imports data specified to postgresql db (rb.dbi) [ .I \-dv \-\-import sqlite equivalent] -.TP -.B \-Dv \-\-update +.TP +.B \-Dv \-\-update .I [filename/wildcard] updates/imports specified data to postgresql db (rb.dbi) [ .I \-dv \-\-update sqlite equivalent] -.TP +.TP .B \-D \-\-remove .I [filename/wildcard] removes specified data to postgresql db (rb.dbi) [ .I \-d \-\-remove -sqlite equivalent] -.TP +sqlite equivalent] +.TP .B \-D \-\-dropall kills data" and drops (postgresql or sqlite) db, tables & indexes [ .I \-d \-\-dropall -sqlite equivalent] -.TP +sqlite equivalent] +.TP The v in e.g. \-Dv is for verbose output. .RE .\" %% Flags Shorthand .SH "Shortcuts, Shorthand for multiple flags" -.TP +.TP .BI \-\-update \ [filename/wildcard] Checks existing file output and runs the flags required to update this output. This means that if only html and pdf output was requested on previous runs, only the \-hp files will be applied, and only these will be generated this time, together with the summary. This can be very convenient, if you offer different outputs of different files, and just want to do the same again. -.TP -\-0 to \-5 [filename or wildcard] +.TP +\-0 to \-5 [filename or wildcard] Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): -.PP +.PP .I \-0 \-mNhwpAobxXyYv .PB [this is the default action run when no options are give, i.e. on 'sisu [filename]'] -.PP +.PP .I \-1 \-mNHwpy -.PP +.PP .I \-2 \-mNHwpaoy -.PP +.PP .I \-3 \-mNhwpAobxXyY -.PP +.PP .I \-4 \-mNhwpAobxXDyY \ \-\-import -.PP +.PP .I \-5 \-mNhwpAobxXDyY \ \-\-update -.PP -add +.PP +add .I \-v for verbose mode and .I \-c for color, e.g. .I sisu \-2vc [filename or wildcard] -.PP -consider +.PP +consider .I \-u -for appended url info or +for appended url info or .I \-v for verbose output .\" %% Markup .SH "DOCUMENT MARKUP" .B SiSU Markup -an incomplete summary. -.PP +an incomplete summary. +.PP .B Note: -files should be marked up for SiSU using +files should be marked up for SiSU using .I UTF\-8 encoding. -.PP -Some interactive help on markup is available, by typing +.PP +Some interactive help on markup is available, by typing .I sisu -and selecting +and selecting .I markup or .I sisu \-\-help markup -.TP +.TP Sample markup files can be used as examples: .I -.TP +.TP actual marked up plaintext files ready for use: .I -.TP +.TP as html with syntax highlighting for viewing: .I -.TP +.TP an alternative presentation of markup syntax: .I .\" %% Markup Basic .SH "Basic Markup" Data text markup (alternative to available html subset) .\" preformatted text follows -.PP +.PP Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A \- :C being part / section headings, followed by other heading levels, and 1 \-6 being headings followed by substantive text or sub\-headings. -.BR +.BR .I :A~ usually the title -.BR +.BR .I :A~? conditional level 1 heading (used where a stand\-alone document may be imported into another) -.PP +.PP .I 1~filename level 1 heading, the primary division such as Chapter that is followed by substantive text, and may be further subdivided (this is the level on which by default html segments are made) -.PP +.PP .I !{ emphasis .I }! -.PP +.PP .I *{ bold text .I }* -.PP +.PP .I _{ underscore .I }_ -.PP +.PP .I /{ italics .I }/ -.PP +.PP .I \'"{ citation .I }" -.PP +.PP .I ^{ superscript .I }^ -.PP +.PP .I ,{ subscript .I }, -.PP +.PP .I +{ inserted text .I }+ -.PP +.PP .I \-{ strikethrough .I }\- .\" %% Markup Endnotes .SH "Footnotes/Endnotes" -.PP +.PP .I ~{ a footnote or endnote .I }~ -.PP +.PP footnote/endnote .I ~{ self contained endnote marker & endnote in one .I }~ -.PP +.PP .I ~{* unnumbered asterisk footnote/endnote, insert multiple asterisks if required .I }~ -.PP +.PP .I ~[* editors notes, numbered asterisk footnote/endnote series .I ]~ (+ the plus sign may be used as well) -.PP +.PP alternative endnote pair notation: -.PP +.PP .I ~^ endnote marker -.PP +.PP .I ^~ endnote text following the paragraph in which the marker occurs .\" %% Markup Line Operations .SH "Line Operations (marker placed at start of line)" -.PP +.PP .I !_ bold line -.PP +.PP .I _1 indent paragraph one level -.PP +.PP .I _2 indent paragraph two steps -.PP +.PP .I _* bullet paragraph -.PP +.PP .I # number paragraph (see headers for numbering document headings) -.PP +.PP .I _# number paragraph level 2 (see headers for numbering document headings) .\" %% Markup Links .SH "Links" -.PP +.PP .I { link name .I }http://url.org -.PP +.PP .I { image.png .I }http://url.org -.PP +.PP .I { image.png .I }image -.PP +.PP .I { tux.png 64x80 .I }image -.PP +.PP NOTE: (a) png and jpg support only (no gif) (b) width x height, not required if imagemagick is installed, (where provided, dimensions may be smaller than the actual image), [images should be no larger than width: 480 and height: 640] -.PP +.PP the shortcut: -.PP +.PP .I {~^ [text to link] .I }http://url.org -.PP -is equivalent to: -.PP +.PP +is equivalent to: +.PP .I { [text to link] .I }http://url.org .I ~{ http://url.org .I }~ -.PP +.PP (which produces hyper\-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink) -.PP +.PP url example: -.PP +.PP .I { SiSU Geek Writer .I }http://www.jus.uio.no/sisu/ -.PP +.PP linked image: -.PP +.PP .I { tux.png 64x80 "a better way" .I }http://www.jus.uio.no/sisu/ image example with all options -.PP +.PP note width x height -.PP +.PP the shortcut: -.PP +.PP .I { [text to link] .I [3sS]}markup_source_filename.sst -.PP +.PP if a server host name has been provided/configured, will provide a list of available output types that would be generated using the shortcut command and the markup file provided, i.e. output generated using the command (as configured): "sisu \-3sS markup_source_filename.sst", using server host, directory stub, filename to compose the link. .\" %% Markup html name tagging .SH "Adding a fixed names in html" -.PP +.PP .I *~[name] manual location marker/tagging at present only in html to produce (use sparingly) .RS @@ -697,42 +697,42 @@ note at a heading level the same is automatically achieved by providing names to .RE .\" %% Markup escape ocn .SH "Escape object citation numbering" -.PP +.PP (place marker at end of paragraph) -.PP +.PP .I ~# unnumbered paragraph -.PP +.PP .I \-# unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] -.PP -It is convenient to mention here that the +.PP +It is convenient to mention here that the .I \-0 flag generates html and latex/pdf output without visible object character numbers. -.PP +.PP .I sisu \-0 [filename.sst] .\" %% Markup latex/pdf page breaks .SH "Page breaks (LaTeX/pdf)" -.PP +.PP page breaks are introduced to pdfs either as header instructions, indicating that pages should break at given levels, and mentioned in the header section, or manually, using the following notation -.PP +.PP .I <:pb> page break, which breaks a page, starting a new page in single column text and a new column in double column text -.PP +.PP .I <:pn> page new, which starts a new page, in both single and double column text (leaving an empty column in double column text if necessary). .\" %% Markup comments .SH "Comment line" -.PP +.PP .I % ignored by sisu in processing if placed at beginning of line -.PP +.PP .I %% ignored by sisu in processing if placed at beginning of line, used for folding by vim folds .\" %% Special Characters .SH "Special characters" -special characters can be escaped with a backslash +special characters can be escaped with a backslash .I { } < > are contextual special characters, (in combination with other characters). .I ~ \- _ / % ^ @@ -743,7 +743,7 @@ see the syntax chart. [note that SiSU is not optimised for technical writing] .\" %% Markup Tables .SH "Tables" -.PP +.PP .I table{ [number of columns] [column width %];[column width %] @@ -766,7 +766,7 @@ see the syntax chart. column one row three and so on here - + .I }table whole table gets an object citation number @@ -805,7 +805,7 @@ whole group gets an object citation number .\" %% Composite Documents .SH "Composite Documents" -.PP +.PP It is possible to build a document by requiring other documents. The documents required may complete documents that could be generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built mainly from other documents), by convention it should be named with the suffix .I .ssm (master) @@ -815,13 +815,13 @@ regular markup file, or .I .ssi (insert/information) .I .sst -A secondary file of the composite document is built prior to processing with the same prefix and the suffix +A secondary file of the composite document is built prior to processing with the same prefix and the suffix .I ._sst and .I .\_sst There are a number of alternative syntaxes for requiring external documents in order to permit use of ascii hypertext linking available in the vim editor. They are as follows: -.TP +.TP basic markup for importing a document .I r{ @@ -837,7 +837,7 @@ filename.si .I } #for vim folds -.TP +.TP importing a document with textlink syntax .I |filename.si|@|^|require @@ -845,7 +845,7 @@ importing a document with textlink syntax .I << |filename.si|@|^| #for vim folds -.TP +.TP importing a document with thlnk syntax .I require @@ -853,14 +853,14 @@ importing a document with thlnk syntax .I << #for vim folds -.TP +.TP remote documents may be called with the thlnk syntax (or regular sisu syntax), e.g. .I << .\" %% Document Headers .SH "Document Headers" -Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. +Header tags appear at the beginning of a document and provide meta information on the document (such as the Dublin Core), or information as to how the document as a whole is to be processed. All header instructions may take either form: .I @headername: @@ -937,7 +937,7 @@ article .I @source: -.I @language: +.I @language: [or @language.document:] language in which current version of document is published. Some country settings result in processing adjustments, e.g. in LaTeX hyphenation, some country codes are recognized, but the language name in Engish is preferred. English is the default setting. (en \- English, fr \- French, de \- German, it \- Italian, es \- Spanish, pt \- Portuguese, sv \- Swedish, da \- Danish, fi \- Finnish, no \- Norwegian, is \- Icelandic, nl \- Dutch, ee \- Estonian, hu \- Hungarian, pl \- Polish, ro \- Romanian, ru \- Russian, gl \- Greek, uk \- Ukranian, tr \- Turkish, si \- Slovene, sk \- Slovak, hr \- Croatian, cs \- Czech, bg \- Bulgarian ) [however, encodings are not available for all of the languages listed.] @@ -988,7 +988,7 @@ Project Gutenberg text number or @prefix: [prefix is placed just after table of contents] .I @rcs: -$Id$ [or +$Id$ [or .I @cvs: used by rcs or cvs to embed version (revision control) information into document, rcs or cvs can usefully provide a history of updates to a document ] @@ -1014,7 +1014,7 @@ see headings] .I @italics: [regular expression of words/phrases to italicise] - + .I @vocabulary: name of taxonomy/vocabulary/wordlist to use against document @@ -1030,7 +1030,7 @@ sisu, ruby, search_libre_docs, open_society .I :A~ Top level heading [this usually has similar content to the title @title: ] -NOTE: the heading levels described here are in 0.38 notation, see heading +NOTE: the heading levels described here are in 0.38 notation, see heading .I :B~ Second level heading [this is a heading level divider] @@ -1061,21 +1061,21 @@ and view sample markup documents provided .\" %% Configuration files .SH "CONFIGURATION FILES" -.PP +.PP Some configuration is required for SiSU, specifying in which directory processing should be done, and where the generated output should be placed. -.PP +.PP SiSU resource configuration is determined by looking at the following files if they exist: -.PP +.PP .I ./_sisu/sisurc.yml -.PP +.PP .I ~/.sisu/sisurc.yml -.PP +.PP .I /etc/sisu/sisurc.yml -.PP +.PP In the absence of instructions in any of these it falls back to the internal program defaults. -.PP +.PP Configuration determines the output and processing directories and the database access details. -.PP +.PP A sample sisurc.yml may be found in /etc/sisu/sisurc.yml .\" %% More Help on Markup and headers @@ -1094,11 +1094,11 @@ A markup table and sample marked\-up files (also in html with syntax highlightin .\" %% Directory Structure and Document Output .SH "DIRECTORY STRUCTURE & Document Output" -.TP +.TP SiSU determines output directories by looking at the resource configuration files, and in their absence the programs internal defaults. .\" %% Directory defaults .SH "Default Directories" -.TP +.TP In the absence of other specifications in .I ~/.sisu/sisurc.yml in @@ -1107,152 +1107,152 @@ SiSU writes to the following directories, processing files are placed in sub\-di .I ./_sisu/processing and if that is not writable to .I /tmp/sisu_processing -.PP +.PP Output is written to sub\-directories within .I /var/www/ if it exists and is writable, and otherwise to .I ~/sisu_output .\" %% Directory markup and file mapping .SH "Markup Document Directories and File Mapping" -.TP +.TP Ideally documents should be placed as collections sub\-directories of their own, with a common denominator, such as subject or author. -.TP +.TP The last part of a directory path is used to create a sub\-directory into which generated documents are placed, in (sub\-sub)directories of their own. -.TP +.TP the document -.PP +.PP .RS .I ~/ebook/free_culture.sst .RE -.TP -would map to -.PP +.TP +would map to +.PP .RS .I ~[configured output path]/ebook/free_culture .RE -.TP +.TP within which would be placed all html, XML, pdf output, typically under the names: -.PP +.PP .RS .I index.html index for segmented text -.PP +.PP .I doc.html full length scrollable document -.PP +.PP .I toc.html index for segmented text -.PP +.PP html segments, as many as there may be... -.TP +.TP .I portrait.pdf -.PP +.PP .I landscape.pdf -.PP +.PP .I sax.xml XML shallow structure, sax type parsing -.PP +.PP .I dom.xml XML deeper structure, dom type parsing -.PP +.PP .I scroll.xhtml xhtml -.PP +.PP .I plain.txt plain text .\" %% Directory multi\-language document convention and file mapping .SH "Multi\-language Document File Naming and Directory Mapping" -.TP +.TP If the same document exists in different language versions, and it is desired that the published language versions should reside in the same output directory, the following filenaming convention should be observed, using Spannish as the sample language code (es) [it is very likley the use of country codes as language codes will be changed or extended in future] [filename]~[language code].sst -.TP +.TP filename~es.sst -.TP +.TP within sisurc.yml under the heading default the setting of language file: at 1, 2 or 3 determines the output filenaming convention used, as follows: -.TP +.TP (1) [output directory path]/filename/es.index.html -.TP +.TP (2) [output directory path]/filename/index.es.html -.TP +.TP (3) [output directory path]/filename/index.html.es (which Apache for example can be configured to use to automatically serve each users preference) -.TP +.TP filename~fr.sst -.TP +.TP filename~de.sst -.TP +.TP etc. would be placed in the same directory using the same convention as indeed would: -.TP +.TP filename.sst -.TP +.TP using the default convention mapping convention. -.TP +.TP Selecting this form of filename will overide other language settings including the language header within a document. .\" %% Directory db mapping .SH "Markup Document Directories and Database Mapping" -.PP +.PP Similarly there is a mapping to the database into which documents are placed. -.PP +.PP The last part of a directory path is used to create a sub\-directory into which generated documents are placed, in a database of the same name, unless overridden. -.PP -Documents within the directory -.I ~/ebook -.PP +.PP +Documents within the directory +.I ~/ebook +.PP .RS .I ~/ebook/free_culture.sst .RE -.PP +.PP would be placed in tables within the database -.PP +.PP .RS .I SiSU_ebook .RE .\" %% Skins .SH "SKINS \- document, directory and site skins" -.PP +.PP Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: -.PP +.PP .I ./_sisu/skin -.PP +.PP .I ~/.sisu/skin -.PP +.PP .I /etc/sisu/skin -.PP +.PP Within the skin directory are the following the default sub\-directories for document skins: -.PP +.PP .I ./skin/doc -.PP +.PP .I ./skin/dir -.PP +.PP .I ./skin/site -.PP +.PP Documents take on a document skin, if the header of the document specifies a skin to be used. -.PP +.PP A directory may be mapped on to a particular skin, so all documents within that directory take on a particular appearance. If a skin exists in the skin/dir with the same name as the document directory, it will automatically be used for each of the documents in that directory, (except where a document specifies the use of another skin, in the skin/doc directory). -when +when end -.PP +.PP A personal habit is to place all skins within the doc directory, and symbolic links as needed from the site, or dir directories as required. -.PP +.PP A site skin, modifies the program default skin. -.PP +.PP Sample skins may be found in /etc/sisu/skin/doc and /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/doc (or equivalent directory) -.PP +.PP Samples of list.yml and promo.yml may be found in /usr/share/doc/sisu/sisu_markup_samples/dfsg/_sisu/skin/yml (or equivalent directory) .\" %% Document Naming convention .SH "DOCUMENT NAMING CONVENTION" -.PP -SiSU documents are named with the suffix -.I ss +.PP +SiSU documents are named with the suffix +.I ss followed by a third distinguishing letter, usually t for ordinary text files. -.PP +.PP .I .sst is used by regular documents, and for most purposes is all you need to be aware of -.PP +.PP .I .ssm suffix indicates a master or composite document, i.e. a document which requests other documents, which may have the file extension .sst or .ssi. See section on Composite Documents for information on how these are prepared. -.PP +.PP .I .ssi indicates some prepared sisu markup information that is to be requested within master or composite document(s) and is not to be processed as a stand\-alone document. -.PP +.PP .I ._sst and .I .\-sst @@ -1275,25 +1275,25 @@ or auto\-converted from a simple xml markup representation (sxs, sxd, sxn) .\" %% Remote Operations .SH "REMOTE OPERATIONS" -.PP +.PP These may be of three basic types. -.PP +.PP Instruction that processed files are to be copied to a remote server, using the \-r or \-R flag as part of the processing instruction. This requires previous setting up/configuration of the method to be used (eg scp assumed for \-r and rsync for \-R) and url to which these files are to be sent. * -.PP +.PP The downloading of a remote file for processing using SiSU locally, which is achieved in one of two ways: -.PP +.PP A processing instruction may include the url to the a remote file that is to be processed \- this will be downloaded and given a temporary file .t extension, and will be processed using SiSU locally. -.PP +.PP A file may request the inclusion of a remote document within it, see comments on "Composite Documents" for the request syntax. -.PP +.PP Finally SiSU may be run on a remote server, which you download marked up files to for processing. This is not really a function of the operation of SiSU, just an available possibility given that not much bandwidth is required. -.PP +.PP * with regard to remote files processed locally, the \-r option, a limitation is that it is up to the user to ensure that the remote file does not have an identical filename to another, e.g. local file, that is to be processed in the same directory. So far this has not been found to happen in practice... Alternative solutions are under consideration, but it is desired that filenames be human assigned, and meaningful, so hash keys of contents for filenames are not amongst the options considered. .\" %% Note .SH "NOTE" -.PP +.PP For basic use only a fraction of the information provided here is required. There may be a bit of an information management problem in determining what though. -For the markup of a book see the samples provided in +For the markup of a book see the samples provided in .I and referred to in the text .I @@ -1302,90 +1302,90 @@ This does assume an ok install and setup of SiSU and the associated software it .\" %% Processing Examples .SH "PROCESSING EXAMPLES" -.PP +.PP To initialise a new directory .B sisu .I \-C -.PP +.PP Note: this create a corresponding output subdirectory and this copies css stylesheet files and basic image files to the output directory. The output directory is created in the output path/directory as a subdirectory with its name corresponding to that of the directory you are currently initialising. -.PP +.PP generate the metafile used in subsequent processing only (note changes made to the markup file will not appear in subsequently generated text unless this flag is used: .B sisu .I \-m [filename or wildcard] -.PP +.PP to create html and pdf output, with verbose output of samplefile1.sst and samplefile2.sst .B sisu .I \-mhpv samplefile1.sst samplefile2.sst .RS -Note: +Note: .I \-m -does initial processing, and +does initial processing, and .I \-H omits filename suffixes and requires a properly configured web server. .I \-h is used to include filename suffixes for file system viewing .RE -.PP +.PP generate html, a word map and pdf with verbose output for all marked up documents in a directory: .B sisu .I \-mhwpv * -.PP +.PP generate html, word map, pdf, plaintext, xhtml, xml sax and xml dom versions with verbose output for all marked up documents in a directory: .B sisu .I \-mhwpabxXv * -.PP +.PP to create html, pdf, xml, plaintext and a concordance file (wordmap) as output, with verbose output of all marked up files in a directory .B sisu .I \-mhpxXawv *.{r,s}? -.PP -generate html, word map and pdf and place on remote server with verbose output 2 named example files in a directory (assumes has been set up, and first time must be run without other flags ie sisu +.PP +generate html, word map and pdf and place on remote server with verbose output 2 named example files in a directory (assumes has been set up, and first time must be run without other flags ie sisu .I \-mrv [filenames/wildcard]): .B sisu .I \-mhwprv example_file.sst other_example_file.sst -.PP +.PP to process a remote sisu marked up file (html,pdf,concordance), provide the url(s) (works for text only files, will be downloaded and processed locally): .B sisu .I \-mhwpv http://www.jus.uio.no/sisu/sample/markup/gpl2.fsf.sst http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst -.PP +.PP one file is local the other remote process (html,pdf,concordance,plaintext and place on pre\-set remote destination): .B sisu .I \-mhwparv gpl2.fsf.sst http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst -.PP +.PP initialize database, create relations (first manually create database with same name as working directory): .B sisu .I \-Dv createall -.PP +.PP it may be necessary to first run .B sisu .I \-Dv createdb -.PP +.PP import all marked up files first time into a database: .B sisu .I \-Dv import * -.PP +.PP .I \-c toggles color .\" %% Interactive help .SH "INTERACTIVE HELP OPTIONS" -.PP +.PP SiSU has an interactive help, which is accessed by typing just "sisu" at the command line, or as described below: .B sisu commands, document preparation, customisation, installation etc. .\" preformatted text follows -.nf +.nf try: .I sisu \-\-help - + sisu help help sisu \-\-help commands sisu \-\-help commands @@ -1416,10 +1416,10 @@ try: directories, path, language, db, install, setup, configure, external_programs, dublincore, termsheet, search, features, external_programs, license, exit -.fi +.fi .SH "SiSU VERSION CONVERSION" -.PP +.PP .I sisu \-\-to\-current [filename/wildcard] converts from 0.37 markup to current markup (0.38) @@ -1463,7 +1463,7 @@ or the same: .I sisu \-\-from\-kdi [kdissert filename] attempts to convert a kdissert file (.kdi) to sisu markup -.I sisu \-\-identify [filename/wildcard] +.I sisu \-\-identify [filename/wildcard] attempts to identify the markup version of the file .I sisu \-\-query=[version number] @@ -1472,13 +1472,13 @@ and provides a brief summary of changes to SiSU markup .SH "SAMPLE MARKUP DOCUMENTS" -.PP +.PP Sample markup documents are provided in sisu\-examples and are available online. .\" %% Further Information .SH "HOME PAGE" -.PP +.PP .I .SH "AUTHOR" diff --git a/man/man1/sisu_termsheet.1 b/man/man1/sisu_termsheet.1 index 48044296..5f513197 100644 --- a/man/man1/sisu_termsheet.1 +++ b/man/man1/sisu_termsheet.1 @@ -1,12 +1,12 @@ -.\" Name: SiSU information Structuring Universe +.\" Name: SiSU information Structuring Universe .\" Author: Ralph Amissah .\" Description: sisu termsheet (preprocessing) manpage .\" arch-tag: sisu manpage .\" License: GPL 2 or later .\" Notes: Process this file with .\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" |sisu.1|@|^| +.\" nroff -man sisu.1 | most +.\" |sisu.1|@|^| .TH sisu_termsheet 1 "December 17, 2005" "version 0.34" "SiSU termsheet merge (sisu \-t [termsheet\-name])" .SH NAME .B SiSU @@ -16,24 +16,24 @@ .B sisu .B \-t .I [termsheet\-name(s)] -.\"%% Description +.\"%% Description .SH DESCRIPTION .B sisu_termsheet -.I is part of SiSU is +.I is part of SiSU is .B invoked .I through the sisu command (man sisu) .PP -.\"%% Summary +.\"%% Summary .SH Summary of man page .PP sisu_termsheet, is started with the command: -.B sisu \-t +.B sisu \-t .I [termsheet\-name(s)] -.\"%% Flags +.\"%% Flags .SH DOCUMENT PROCESSING COMMAND FLAGS .PP .BI sisu \ \-t \ [termsheet\-name(s)] -(runs sisu_termsheet) merges the termsheet(s) specified on the commandline with the documents it is instructed to merge in the termsheet(s), and produces regular +(runs sisu_termsheet) merges the termsheet(s) specified on the commandline with the documents it is instructed to merge in the termsheet(s), and produces regular .I SiSU output documents from the merged results. .PP @@ -41,7 +41,7 @@ output documents from the merged results. .\"%% Further Information .SH FURTHER INFORMATION .PP -For more information on +For more information on .I SiSU see: .I diff --git a/man/man1/sisu_webrick.1 b/man/man1/sisu_webrick.1 index ecdcb9b4..7f631e55 100644 --- a/man/man1/sisu_webrick.1 +++ b/man/man1/sisu_webrick.1 @@ -1,12 +1,12 @@ -.\" Name: SiSU information Structuring Universe +.\" Name: SiSU information Structuring Universe .\" Author: Ralph Amissah .\" Description: sisu webrick manpage .\" arch-tag: sisu manpage .\" License: GPL 2 or later .\" Notes: Process this file with .\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" |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 @@ -20,14 +20,14 @@ or .B sisu .B \-W .I [port] -.\"%% Description +.\"%% 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 +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 -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: @@ -35,30 +35,30 @@ The default port for sisu_webrick is set to 8081, this may be modified in the ya a sample of which is provided as .I /etc/sisu/sisurc.yaml (or in the equivalent directory on your system). -.\"%% Summary +.\"%% 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 +.B sisu \-W .I [port] .PP where no port is given and settings are unchanged the default port is 8081 -.\"%% Flags +.\"%% 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 +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 +For more information on .I SiSU see: .I diff --git a/man/man7/sisu_vim.7 b/man/man7/sisu_vim.7 index af4f8135..aa8ddb44 100644 --- a/man/man7/sisu_vim.7 +++ b/man/man7/sisu_vim.7 @@ -1,12 +1,12 @@ -.\" Name: SiSU information Structuring Universe +.\" Name: SiSU information Structuring Universe .\" Author: Ralph Amissah .\" Description: vim sisu package manpage .\" arch-tag: sisu manpage .\" License: GPL 2 or later .\" Notes: Process this file with .\" groff -man -Tascii vim_sisu.1 -.\" nroff -man vim_sisu.1 | most -.\" |sisu.1|@|^| +.\" nroff -man vim_sisu.1 | most +.\" |sisu.1|@|^| .TH vim_sisu 7 "July 7, 2006" "version 0.42" "vim syntax and filetype plugin with folds for SiSU markup" .SH NAME .B SiSU @@ -41,7 +41,7 @@ which is provided .\"%% Further Information .SH FURTHER INFORMATION .PP -For more information on +For more information on .I SiSU see: .I diff --git a/man/man8/sisu.8 b/man/man8/sisu.8 index c55847d4..2303bece 100644 --- a/man/man8/sisu.8 +++ b/man/man8/sisu.8 @@ -1,11 +1,11 @@ -.\" Name: SiSU information Structuring Universe +.\" Name: SiSU information Structuring Universe .\" Author: Ralph Amissah .\" Description: sisu manpage .\" License: GPL 2 or later .\" Notes: Process this file with .\" groff -man -Tascii sisu.1 -.\" nroff -man sisu.1 | most -.\" /[^\\][-'] +.\" nroff -man sisu.1 | most +.\" /[^\\][-'] .\" :%s/\([^\\]\)\([-']\)/\1\\\2/c .TH sisu 8 "October 26, 2006" "version 0.48" "CONFIGURATION and SETUP" .SH NAME @@ -26,9 +26,9 @@ simple syntax; the semantic identification of documents using the Dublin Core; document management; built to be associated with a revision control system; text object numbering for the identification of a texts location in any of the output formats, easy skinning on a site wide, or per document basis, ... for -more see +more see .I man 1 sisu -or +or .I .PP .B SiSU is an alternative way of publishing and managing documents. @@ -51,7 +51,7 @@ or equivalent directory, or online at or for viewing in html with syntax highlighting from .I .PP -A syntax table is provided at +A syntax table is provided at .I /usr/share/doc/sisu/on_markup.txt or equivalent, and online at .I @@ -59,7 +59,7 @@ or equivalent, and online at .I man 1 sisu has a syntax table along with processing commands. .PP -SiSU also provides some help via the command: +SiSU also provides some help via the command: .I sisu \-\-help and selecting an appropriate subject, e.g. .PP @@ -136,16 +136,16 @@ samples) provided in the document sample directory: .PP .B \-\-\-\-\-\-\-\-\-\- .PP -.B Tip: -the markup syntax examples may be of interest +.B Tip: +the markup syntax examples may be of interest .I .PP .B Tip: .I sisu \-U [sisu markup filename] should printout the different possible outputs and where sisu would place them. .PP -.B Tip: -if you want to toggle ansi color add +.B Tip: +if you want to toggle ansi color add .I c to your flags. .PP @@ -253,7 +253,7 @@ with softlinks being made to the skins contained there from other skin directori .\"%% Further Information .SH FURTHER INFORMATION .PP -For more information on +For more information on .I SiSU see: .I diff --git a/setup.rb b/setup.rb index 424a5f37..9f0c8267 100644 --- a/setup.rb +++ b/setup.rb @@ -659,7 +659,7 @@ module FileOperations def ruby(*args) command config('rubyprog'), *args end - + def make(task = nil) command(*[config('makeprog'), task].compact) end @@ -722,7 +722,7 @@ module HookScriptAPI def srcdirectory?(path) File.dir?(srcfile(path)) end - + def srcfile?(path) File.file?(srcfile(path)) end @@ -826,7 +826,7 @@ class ToplevelInstaller __send__ "exec_#{task}" end end - + def run_metaconfigs @config.load_script "#{@ardir}/metaconfig" end @@ -1404,7 +1404,7 @@ class Installer end # picked up many entries from cvs-1.11.1/src/ignore.c - JUNK_FILES = %w( + JUNK_FILES = %w( core RCSLOG tags TAGS .make.state .nse_depinfo #* .#* cvslog.* ,* .del-* *.olb *~ *.old *.bak *.BAK *.orig *.rej _$* *$ -- cgit v1.2.3