diff options
Diffstat (limited to 'data/doc/sisu')
20 files changed, 601 insertions, 643 deletions
diff --git a/data/doc/sisu/README b/data/doc/sisu/README index a44b30b0..b2f8a69f 100644 --- a/data/doc/sisu/README +++ b/data/doc/sisu/README @@ -397,7 +397,7 @@ usually installed to: %% License --------------- -License: GPL 2 or later see the copyright file in +License: GPL 3 or later see the copyright file in ./data/doc/sisu diff --git a/data/doc/sisu/copyright b/data/doc/sisu/copyright index 06b9f0e1..c15699c4 100644 --- a/data/doc/sisu/copyright +++ b/data/doc/sisu/copyright @@ -11,13 +11,13 @@ The original source can always be found at: Copyright (C) 1997, 1998, 1999, 2000, 20001, 2002, 2003, 2004, 2005 Ralph Amissah -License: GPL 2 or later +License: GPL v3 or later - GPL2 summary: + GPL3 summary: This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or + the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -34,7 +34,7 @@ License: GPL 2 or later available from these locations: <http://www.fsf.org/licenses/gpl.html> <http://www.gnu.org/copyleft/gpl.html> - <http://www.jus.uio.no/sisu/gpl2.fsf> + <http://www.jus.uio.no/sisu/gpl3.fsf> On Debian systems, the complete text of the GNU General Public License can be found in `/usr/share/common-licenses/GPL'. diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 4922bab1..61d0ab0d 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -46,19 +46,19 @@ other information. </dt> <dt><b>-A</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>plaintext</i> with <i>dos</i> linefeeds and without markup, (object numbers +<dd>produces <i>plaintext</i> with <i>dos</i> linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ <i>-a</i> for equivalent Unix (linefeed) output file] [see <i>-E</i> for endnotes]. </dd> <dt><b>-a</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>plaintext</i> with <i>Unix</i> linefeeds and without markup, (object numbers +<dd>produces <i>plaintext</i> with <i>Unix</i> linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ <i>-A</i> for equivalent dos (linefeed) output file] [see <i>-e</i> for endnotes]. </dd> <dt><b>-b</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>xhtml/XML</i> output for browser viewing (sax parsing). </dd> +<dd>produces <i>xhtml/XML</i> output for browser viewing (sax parsing). </dd> <dt><b>-C</b><i> [--init=site]</i> </dt> @@ -67,10 +67,10 @@ directory (config files such as css and dtd files are not updated if they already exist unless modifier is used). <b>-C</b><i> --init=site</i> <i>configure/initialise</i> site more extensive than <i>-C</i> 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. </dd> +updated if this modifier is used. </dd> <dt><b>-c</b><i> [filename/wildcard]</i> </dt> -<dd>screen <i>toggle</i> ansi +<dd>screen <i>toggle</i> 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 @@ -78,59 +78,59 @@ output will be without colour). </dd> <dt><b>-D</b><i> [instruction]</i><b> [filename]</b> </dt> <dd>database postgresql -( <i>--pgsql</i> may be used instead) possible instructions, include: <i>--createdb;</i> +( <i>--pgsql</i> may be used instead) possible instructions, include: <i>--createdb;</i> <i>--create;</i> <i>--dropall;</i> <i>--import</i> [filename]; <i>--update</i> [filename]; <i>--remove</i> [filename]; see database section below. </dd> <dt><b>-d</b><i> [--db-[database</i><b> type</b><i> (sqlite|pg)]]</i><b> --[instruction]</b><i> [filename]</i> </dt> -<dd>database type default set to sqlite, (for which <i>--sqlite</i> may be used instead) +<dd>database type default set to sqlite, (for which <i>--sqlite</i> may be used instead) or to specify another database <i>--db-[pgsql,</i> sqlite] (however see -D) possible instructions include: <i>--createdb;</i> <i>--create;</i> <i>--dropall;</i> <i>--import</i> [filename]; <i>--update</i> [filename]; <i>--remove</i> [filename]; see database section below. </dd> <dt><b>-E</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>plaintext</i> with <i>dos</i> linefeeds, and without markup, endnotes follow -the main text (in <i>-a</i> endnotes follow the paragraphs that contain them). -There are no object numbers [see <i>-e</i> for Unix (linefeed) output file] [see -<i>-A</i> for footnotes]. </dd> +<dd>produces <i>plaintext</i> with <i>dos</i> linefeeds, and without markup, endnotes follow +the main text (in <i>-a</i> endnotes follow the paragraphs that contain them). There +are no object numbers [see <i>-e</i> for Unix (linefeed) output file] [see <i>-A</i> for +footnotes]. </dd> <dt><b>-e</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>plaintext</i> with <i>Unix</i> linefeeds, +<dd>produces <i>plaintext</i> with <i>Unix</i> linefeeds, and without markup, endnotes follow the main text. Object numbers are omitted. [ <i>-E</i> for equivalent dos (linefeed) output file] [ <i>-a</i> for footnotes]. </dd> <dt><b>-F</b><i> [--webserv=webrick]</i> </dt> -<dd>generate examples of (naive) <i>cgi</i> search form for <i>sqlite</i> and <i>pgsql</i> depends +<dd>generate examples of (naive) <i>cgi</i> search form for <i>sqlite</i> and <i>pgsql</i> 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> <i>-D</i> and the <i>database</i> section below. If the optional -parameter <i>--webserv=webrick</i> 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</i> directory). -<i>-Fv</i> (in addition to the above) provides some information on setting up -<i>hyperestraier</i> for sisu </dd> +search form) see <i>-d</i> <i>-D</i> and the <i>database</i> section below. If the optional parameter +<i>--webserv=webrick</i> 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</i> directory). <i>-Fv</i> (in +addition to the above) provides some information on setting up <i>hyperestraier</i> +for sisu </dd> <dt> <b>-H</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>html</i> without -link suffixes (.html .pdf etc.) ("Hide"). Requires an appropriately configured -web server. [behaviour switched after 0.35 see -h]. </dd> +<dd>produces <i>html</i> without link suffixes +(.html .pdf etc.) ("Hide"). Requires an appropriately configured web server. +[behaviour switched after 0.35 see -h]. </dd> <dt><b>-h</b><i> [filename/wildcard]</i> </dt> -<dd>produces - <i>html</i> (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]. </dd> +<dd>produces <i>html</i> +(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]. </dd> <dt><b>-I</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>texinfo</i> file. </dd> +<dd>produces <i>texinfo</i> file. </dd> <dt><b>-L</b> </dt> <dd>prints license information. </dd> @@ -155,7 +155,7 @@ for the document, and digests for each object contained within the document <dt><b>-n</b><i> [filename/wildcard/url]</i> </dt> <dd>skip meta-markup -(building of "metaverse"), this skips the equivalent of <i>-m</i> which is otherwise +(building of "metaverse"), this skips the equivalent of <i>-m</i> which is otherwise assumed by most processing flags. </dd> <dt><b>-o</b><i> [filename/wildcard/url]</i> </dt> @@ -164,7 +164,7 @@ document in <i>opendocument</i> file format (opendocument.odt). </dd> <dt><b>-p</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>LaTeX</i> pdf (portrait.pdf & landscape.pdf). Default paper size is set +<dd>produces <i>LaTeX</i> 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</i> preset sizes include: ’A4’, U.S. ’letter’ and ’legal’ and book sizes ’A5’ and ’B5’ (system defaults to A4). </dd> @@ -175,7 +175,7 @@ line parameter, e.g. <i>--papersize-a4</i> preset sizes include: ’A4&rsquo <dt><b>-R</b><i> [filename/wildcard]</i> </dt> <dd><i>copies</i> sisu output files -to <i>remote</i> host using rsync. This requires that sisurc.yml has been provided +to <i>remote</i> 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 @@ -184,27 +184,27 @@ with other flags, it is not). Also see <i>-r</i> </dd> <dt><b>-r</b><i> [filename/wildcard]</i> </dt> <dd><i>copies</i> sisu -output files to <i>remote</i> host using scp. This requires that sisurc.yml has +output files to <i>remote</i> 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</i> </dd> <dt><b>-S</b> </dt> <dd>produces a <i>sisupod</i> a zipped -sisu directory of markup files including <i>sisu</i> markup source files and -the directories local <i>configuration</i> file, <i>images</i> and <i>skins.</i> <b>Note:</b> this -only includes the configuration files or skins contained in <i>./_sisu</i> not -those in <i>~/.sisu</i> <i>-S</i> [filename/wildcard] option. <b>Note:</b> (this option is tested -only with zsh). </dd> +sisu directory of markup files including <i>sisu</i> markup source files and the +directories local <i>configuration</i> file, <i>images</i> and <i>skins.</i> <b>Note:</b> this only +includes the configuration files or skins contained in <i>./_sisu</i> not those +in <i>~/.sisu</i> <i>-S</i> [filename/wildcard] option. <b>Note:</b> (this option is tested only +with zsh). </dd> <dt><b>-S</b><i> [filename/wildcard]</i> </dt> -<dd>produces a zipped file of the prepared -document specified along with associated images, by default named <i>sisupod.zip</i> -they may alternatively be named with the filename extension <i>.ssp</i> This provides +<dd>produces a zipped file of the prepared document +specified along with associated images, by default named <i>sisupod.zip</i> they +may alternatively be named with the filename extension <i>.ssp</i> 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</i> markup source file, - (along with associated documents if a master file, or available in multilingual -versions), together with related <i>images</i> and <i>skin.</i> SiSU commands can be -run directly against a sisupod contained in a local directory, or provided +then for example be emailed. A sisupod includes <i>sisu</i> markup source file, +(along with associated documents if a master file, or available in multilingual +versions), together with related <i>images</i> and <i>skin.</i> 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 @@ -212,7 +212,7 @@ 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:</b> 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</i> option without [filename/wildcard]. </dd> +sending). See the <i>-S</i> option without [filename/wildcard]. </dd> <dt><b>-s</b><i> [filename/wildcard]</i> </dt> @@ -224,78 +224,79 @@ sending). See the <i>-S</i> option without [filename/wildcard]. </dd> <dt><b>-U</b><i> [filename/wildcard]</i> </dt> -<dd>prints <i>url</i> 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</i> provides <i>url</i> 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 </dd> - -<dt><b>-u</b><i> [filename/wildcard]</i> -</dt> -<dd>provides <i>url</i> mapping of output files for the flags requested for processing, -also see <i>-U</i> </dd> +<dd>prints <i>url</i> 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</i> provides <i>url</i> 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 </dd> + +<dt><b>-u</b><i> [filename/wildcard]</i> </dt> +<dd>provides <i>url</i> mapping +of output files for the flags requested for processing, also see <i>-U</i> </dd> <dt><b>-V</b> </dt> -<dd>on its own, provides SiSU <i>version</i> and <i>environment</i> information -(sisu --help env) </dd> +<dd>on +its own, provides SiSU <i>version</i> and <i>environment</i> information (sisu --help env) +</dd> <dt><b>-V</b><i> [filename/wildcard]</i> </dt> -<dd>even more <i>verbose</i> than the <i>-v</i> flag. -(also see -M) </dd> +<dd>even more <i>verbose</i> than the <i>-v</i> flag. (also see -M) </dd> <dt><b>-v</b> </dt> -<dd>on its own, provides SiSU <i>version</i> information </dd> +<dd>on +its own, provides SiSU <i>version</i> information </dd> -<dt><b>-v</b><i> [filename/wildcard]</i> -</dt> -<dd>provides <i>verbose</i> output of what is being built, where it is being built -(and error messages if any), as with <i>-u</i> flag provides a url mapping of -files created for each of the processing flag requests. See also <b>-V</b> </dd> +<dt><b>-v</b><i> [filename/wildcard]</i> </dt> +<dd>provides +<i>verbose</i> output of what is being built, where it is being built (and error +messages if any), as with <i>-u</i> flag provides a url mapping of files created +for each of the processing flag requests. See also <b>-V</b> </dd> <dt><b>-W</b> </dt> -<dd>starts -ruby’s <i>webrick</i> 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</i> option rather than <i>-H</i> ; also, note <i>-F</i> webrick -]. </dd> - -<dt><b>-w</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>concordance</i> (wordmap) a rudimentary -index of all the words in a document. </dd> - -<dt><b>-X</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>XML</i> -output with deep document structure, in the nature of dom. </dd> - -<dt><b>-x</b><i> [filename/wildcard]</i> -</dt> -<dd>produces <i>XML</i> output shallow structure (sax parsing). </dd> +<dd>starts ruby’s <i>webrick</i> +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</i> option rather than <i>-H</i> ; also, note <i>-F</i> webrick ]. </dd> -<dt><b>-Y</b><i> [filename/wildcard]</i> +<dt><b>-w</b><i> [filename/wildcard]</i> </dt> -<dd>produces a short sitemap entry for the document, based on html output and -the sisu_manifest. <i>--sitemaps</i> generates/updates the sitemap index of existing -sitemaps. (Experimental, [g,y,m announcement this week]) </dd> +<dd>produces <i>concordance</i> (wordmap) a rudimentary index of all the words in +a document. (Concordance files are not generated for documents of over 260,000 +words unless this limit is increased in the file sisurc.yml) </dd> -<dt><b>-y</b><i> [filename/wildcard]</i> +<dt><b>-X</b><i> [filename/wildcard]</i> </dt> -<dd>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. </dd> +<dd>produces <i>XML</i> output with deep document structure, in the nature of dom. +</dd> + +<dt><b>-x</b><i> [filename/wildcard]</i> </dt> +<dd>produces <i>XML</i> output shallow structure (sax parsing). +</dd> + +<dt><b>-Y</b><i> [filename/wildcard]</i> </dt> +<dd>produces a short sitemap entry for the document, based +on html output and the sisu_manifest. <i>--sitemaps</i> generates/updates the sitemap +index of existing sitemaps. (Experimental, [g,y,m announcement this week]) +</dd> + +<dt><b>-y</b><i> [filename/wildcard]</i> </dt> +<dd>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. </dd> <dt><b>-Z</b><i> [filename/wildcard]</i> </dt> -<dd>Zap, if used with other processing -flags <i>deletes</i> 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. </dd> +<dd>Zap, if used +with other processing flags <i>deletes</i> 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. </dd> <dt><b>-z</b><i> [filename/wildcard]</i> </dt> -<dd>produces <i>php</i> (zend) [this feature is disabled -for the time being] </dd> +<dd>produces <i>php</i> (zend) +[this feature is disabled for the time being] </dd> </dl> <h2><a name='sect5' href='#toc5'>modifiers</a></h2> @@ -303,85 +304,85 @@ for the time being] </dd> <dl> <dt><b>--no-ocn</b> </dt> -<dd>[with -h -H or -p] switches off object -citation numbering. Produce output without identifying numbers in margins -of html or LaTeX/pdf output. </dd> +<dd>[with -h -H +or -p] switches off object citation numbering. Produce output without identifying +numbers in margins of html or LaTeX/pdf output. </dd> <dt><b>--no-annotate</b> </dt> -<dd>strips output text of editor endnotes~[* -square brackets ]~ denoted by asterisk or dagger/plus sign </dd> +<dd>strips output +text of editor endnotes~[* square brackets ]~ denoted by asterisk or dagger/plus +sign </dd> <dt><b>--no-asterisk</b> </dt> -<dd>strips -output text of editor endnotes~[* square brackets ]~ denoted by asterisk -sign </dd> +<dd>strips output text of editor endnotes~[* square brackets +]~ denoted by asterisk sign </dd> <dt><b>--no-dagger</b> </dt> -<dd>strips output text of editor endnotes~[+ square brackets -]~ denoted by dagger/plus sign </dd> +<dd>strips output text of editor endnotes~[+ +square brackets ]~ denoted by dagger/plus sign </dd> </dl> <h2><a name='sect6' href='#toc6'>databases</a></h2> <dl> -<dt>dbi - database interface +<dt>dbi - database +interface </dt> +<dd><b>-D</b> or <b>--pgsql</b> set for <i>postgresql</i> <b>-d</b> or <b>--sqlite</b> default set for <i>sqlite</i> +-d is modifiable with --db=[database type (pgsql or sqlite)] </dd> + +<dt><b>-Dv --createall</b> </dt> -<dd><b>-D</b> or <b>--pgsql</b> set for <i>postgresql</i> <b>-d</b> or <b>--sqlite</b> default set for <i>sqlite</i> -d is -modifiable with --db=[database type (pgsql or sqlite)] </dd> - -<dt><b>-Dv --createall</b> </dt> -<dd>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</i> --createall sqlite equivalent] -it may be necessary to run sisu <i>-Dv</i> --createdb initially </dd> - -<dt>NOTE: at the present -time for postgresql it may be necessary to manually create the database. -The command would be </dt> -<dd><i>’createdb</i> [database name]’ where database name would -be SiSU_[present working directory name (without path)]. Please use only -alphanumerics and underscores. </dd> - -<dt><b>-Dv --import </b> </dt> -<dd><i>[filename/wildcard]</i> imports data -specified to postgresql db (rb.dbi) [ <i>-dv</i> --import sqlite equivalent] </dd> - -<dt><b>-Dv --update -</b> </dt> -<dd><i>[filename/wildcard]</i> updates/imports specified data to postgresql db (rb.dbi) -[ <i>-dv</i> --update sqlite equivalent] </dd> +<dd>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</i> --createall sqlite +equivalent] it may be necessary to run sisu <i>-Dv</i> --createdb initially </dd> + +<dt>NOTE: +at the present time for postgresql it may be necessary to manually create +the database. The command would be </dt> +<dd><i>’createdb</i> [database name]’ where database +name would be SiSU_[present working directory name (without path)]. Please +use only alphanumerics and underscores. </dd> + +<dt><b>-Dv --import</b> </dt> +<dd><i>[filename/wildcard]</i> imports +data specified to postgresql db (rb.dbi) [ <i>-dv</i> --import sqlite equivalent] +</dd> + +<dt><b>-Dv --update</b> </dt> +<dd><i>[filename/wildcard]</i> updates/imports specified data to postgresql +db (rb.dbi) [ <i>-dv</i> --update sqlite equivalent] </dd> <dt><b>-D --remove</b> </dt> -<dd><i>[filename/wildcard]</i> removes specified -data to postgresql db (rb.dbi) [ <i>-d</i> --remove sqlite equivalent] </dd> +<dd><i>[filename/wildcard]</i> +removes specified data to postgresql db (rb.dbi) [ <i>-d</i> --remove sqlite equivalent] +</dd> -<dt><b>-D --dropall</b> -</dt> -<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes [ <i>-d</i> --dropall -sqlite equivalent] </dd> +<dt><b>-D --dropall</b> </dt> +<dd>kills data" and drops (postgresql or sqlite) db, tables & indexes +[ <i>-d</i> --dropall sqlite equivalent] </dd> <dt>The v in e.g. -Dv is for verbose output. </dt> <dd></dd> </dl> </blockquote> -<h2><a name='sect7' href='#toc7'>Shortcuts, Shorthand -for multiple flags</a></h2> +<h2><a name='sect7' href='#toc7'>Shortcuts, +Shorthand for multiple flags</a></h2> <dl> <dt><b>--update</b><i> [filename/wildcard]</i> </dt> -<dd>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. </dd> - -<dt>-0 to -5 [filename or -wildcard] </dt> +<dd>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. </dd> + +<dt>-0 to -5 [filename +or wildcard] </dt> <dd>Default shorthand mappings (note that the defaults can be changed/configured in the sisurc.yml file): </dd> </dl> @@ -395,20 +396,20 @@ default action run when no options are give, i.e. on ’sisu [filename]&rsqu <i>-4</i> -mNhwpAobxXDyY --import <p> <i>-5</i> -mNhwpAobxXDyY --update <p> -add <i>-v</i> for verbose mode and <i>-c</i> for color, e.g. <i>sisu</i> -2vc [filename or wildcard] +add <i>-v</i> for verbose mode and <i>-c</i> for color, e.g. <i>sisu</i> -2vc [filename or wildcard] <p> -consider <i>-u</i> for appended url info or <i>-v</i> for verbose output +consider <i>-u</i> for appended url info or <i>-v</i> for verbose output <h2><a name='sect8' href='#toc8'>Document Markup</a></h2> <b>SiSU -Markup</b> an incomplete summary. <p> -<b>Note:</b> files should be marked up for SiSU -using <i>UTF-8</i> encoding. <p> -Some interactive help on markup is available, by typing - <i>sisu</i> and selecting <i>markup</i> or <i>sisu</i> --help markup +Markup</b> an incomplete summary. <p> +<b>Note:</b> files should be marked up for SiSU using +<i>UTF-8</i> encoding. <p> +Some interactive help on markup is available, by typing <i>sisu</i> +and selecting <i>markup</i> or <i>sisu</i> --help markup <dl> -<dt>Sample markup files can -be used as examples: </dt> +<dt>Sample markup files can be used +as examples: </dt> <dd><i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> ></i> </dd> @@ -495,12 +496,12 @@ the shortcut: <p> <i>{~^</i> [text to link] <i>}<a href='http://url.org'>http://url.org</i></a> <p> -is equivalent to: <p> +is equivalent to: <p> <i>{</i> [text to link] <i>}<a href='http://url.org'>http://url.org</i></a> <i>~{</i> <a href='http://url.org'>http://url.org</a> - <i>}~</i> -<p> -(which produces hyper-linked text within a document/paragraph, with an endnote + <i>}~</i> <p> +(which +produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink) <p> url example: <p> @@ -537,7 +538,7 @@ citation numbering</a></h2> <i>-#</i> unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] <p> It is convenient -to mention here that the <i>-0</i> flag generates html and latex/pdf output without +to mention here that the <i>-0</i> flag generates html and latex/pdf output without visible object character numbers. <p> <i>sisu</i> -0 [filename.sst] <h2><a name='sect15' href='#toc15'>Page breaks (LaTeX/pdf)</a></h2> @@ -560,7 +561,7 @@ line <p> for folding by vim folds <h2><a name='sect17' href='#toc17'>Special characters</a></h2> special characters can be escaped -with a backslash <i>{</i> } < > are contextual special characters, (in combination +with a backslash <i>{</i> } < > are contextual special characters, (in combination with other characters). <i>~</i> - _ / % ^ and occasionally <i>!</i> # + , are special characters in particular circumstances, see the syntax chart. [note that SiSU is not optimised for technical writing] @@ -586,8 +587,8 @@ see example below]<br> <p> column one row three<br> and so on<br> here<br> - <br> - <i>}table</i> + +<p> <i>}table</i> <p> whole table gets an object citation number <p> <h2><a name='sect19' href='#toc19'>Other Grouped or @@ -628,7 +629,7 @@ be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document <i>.sst</i> regular markup file, or <i>.ssi</i> (insert/information) <i>.sst</i> A secondary file of the composite document is built prior to processing with the same prefix and the suffix - <i>._sst</i> and <i>._sst</i> There are a number of alternative syntaxes for requiring +<i>._sst</i> and <i>._sst</i> 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: <p> @@ -670,29 +671,29 @@ thlnk syntax (or regular sisu syntax), e.g. </dt> <h2><a name='sect21' href='#toc21'>Document Headers</a></h2> 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. -<p> All -header instructions may take either form: <i>@headername:</i> [introduced in 0.38] +information as to how the document as a whole is to be processed. +<p> All header +instructions may take either form: <i>@headername:</i> [introduced in 0.38] or -<p>or <i>0~headername</i> All Dublin Core meta tags are available -<p> <i>@indentifier:</i> -information or instructions [introduced in 0.38] +<p><i>0~headername</i> All Dublin Core meta tags are available +<p> <i>@indentifier:</i> information +or instructions [introduced in 0.38] <p> or -<p> <i>0~indentifier</i> information -or instructions, old equivalent, depreciated -<p> where the "identifier" is -a tag recognised by the program, and the "information" or "instructions" -belong to the tag/indentifier specified. -<p> Note: a header where used should -only be used once; all headers apart from @title: (0~title) are optional; -the @structure: (0~toc) header is used to describe document structure, -and can be useful to know. -<p> @structure: PART; CHAPTER; SECTION; ARTICLE; -none; none; -<p> structure can be defined by a match words or regular expression -(the regular expression is assumed to start at the beginning of a line -of text i.e. ^) -<p> For help see one of the following (and markup samples):<br> +<p> <i>0~indentifier</i> information or instructions, +old equivalent, depreciated +<p> where the "identifier" is a tag recognised +by the program, and the "information" or "instructions" belong to the tag/indentifier +specified. +<p> Note: a header where used should only be used once; all headers +apart from @title: (0~title) are optional; the @structure: (0~toc) header +is used to describe document structure, and can be useful to know. +<p> @structure: +PART; CHAPTER; SECTION; ARTICLE; none; none; +<p> structure can be defined +by a match words or regular expression (the regular expression is assumed +to start at the beginning of a line of text i.e. ^) +<p> For help see one of +the following (and markup samples):<br> <p> * interactive help - type ’sisu --help headers’<br> @@ -728,16 +729,16 @@ markup version] <p> <i>@format:</i> <p> <i>@identifier:</i> <p> <i>@source:</i> -<p> <i>@language:</i> [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.] +<p> <i>@language:</i> [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.] <p> <i>@language.original:</i> <p>original language in which the work was published @@ -769,7 +770,7 @@ classification]; isbn=[ISBN]; pg=[Project Gutenberg text number] <p> <i>@prefix_b:</i> or @prefix: [prefix is placed just after table of contents] <p> <i>@rcs:</i> $Id$ -[or <i>@cvs:</i> used by rcs or cvs to embed version (revision control) information +[or <i>@cvs:</i> 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 ] <p> <i>@structure:</i> PART; CHAPTER; SECTION; ARTICLE; none; none; @@ -795,21 +796,23 @@ new=A,B,C; break=1; num_top=1 [or newpage=A,B,C; breakpage=1; num_top=1] see headings] <p> <i>@bold:</i> [regular expression of words/phrases to be made bold] -<p> <i>@italics:</i> [regular expression of words/phrases to italicise] <br> - <i>@vocabulary:</i> name of taxonomy/vocabulary/wordlist to use against document +<p> <i>@italics:</i> [regular expression of words/phrases to italicise] +<p> <i>@vocabulary:</i> -<p> <i>@skin:</i> skin_doc_[name_of_desired_document_skin] -<p> <i>@links:</i> { SiSU }<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> +<p>name of taxonomy/vocabulary/wordlist to use against document +<p> <i>@skin:</i> skin_doc_[name_of_desired_document_skin] -{ FSF }<a href='http://www.fsf.org'>http://www.fsf.org</a> +<p> <i>@links:</i> { SiSU }<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a> + { FSF }<a href='http://www.fsf.org'>http://www.fsf.org</a> -<p> <i>@promo:</i> sisu, ruby, search_libre_docs, open_society -[places content in right pane in html, makes use of list.yml and promo.yml, -commented out sample in document sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] +<p> <i>@promo:</i> +sisu, ruby, search_libre_docs, open_society [places content in right pane +in html, makes use of list.yml and promo.yml, commented out sample in document +sample: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] <p> <i>:A~</i> 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 - + <p> <i>:B~</i> Second level heading [this is a heading level divider] <p> <i>:C~</i> Third level heading [this is a heading level divider] @@ -916,7 +919,7 @@ of their own. </dt> <dl> -<dt>would map to </dt> +<dt>would map to </dt> <dd></dd> </dl> <p> @@ -1015,7 +1018,7 @@ 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. <p> Documents within -the directory <i>~/ebook</i> <p> +the directory <i>~/ebook</i> <p> <blockquote><i>~/ebook/free_culture.sst</i> </blockquote> <p> would be placed in tables @@ -1044,9 +1047,9 @@ 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 end <p> -A personal habit is to place all skins within the -doc directory, and symbolic links as needed from the site, or dir directories +directory). when end <p> +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. <p> A site skin, modifies the program default skin. <p> Sample skins @@ -1058,7 +1061,7 @@ directory) <h2><a name='sect31' href='#toc31'>Document Naming Convention</a></h2> <p> SiSU documents are named with the -suffix <i>ss</i> followed by a third distinguishing letter, usually t for ordinary +suffix <i>ss</i> followed by a third distinguishing letter, usually t for ordinary text files. <p> <i>.sst</i> is used by regular documents, and for most purposes is all you need to be aware of <p> @@ -1117,7 +1120,7 @@ are not amongst the options considered. 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 <i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> +see the samples provided in <i><<a href='http://www.jus.uio.no/sisu/sample'>http://www.jus.uio.no/sisu/sample</a> ></i> and referred to in the text <i><<a href='http://www.jus.uio.no/sisu/SiSU'>http://www.jus.uio.no/sisu/SiSU</a> ></i> The flags to generate html @@ -1139,31 +1142,31 @@ markup file will not appear in subsequently generated text unless this flag is used: <b>sisu</b> <i>-m</i> [filename or wildcard] <p> to create html and pdf output, with verbose output of samplefile1.sst and samplefile2.sst <b>sisu</b> <i>-mhpv</i> samplefile1.sst -samplefile2.sst <blockquote>Note: <i>-m</i> does initial processing, and <i>-H</i> omits filename -suffixes and requires a properly configured web server. <i>-h</i> is used to include -filename suffixes for file system viewing </blockquote> -<p> -generate html, a word map and -pdf with verbose output for all marked up documents in a directory: <b>sisu</b> -<i>-mhwpv</i> * <p> -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</b> <i>-mhwpabxXv</i> * <p> -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</b> <i>-mhpxXawv</i> *.{r,s}? <p> -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</i> [filenames/wildcard]): <b>sisu</b> <i>-mhwprv</i> example_file.sst other_example_file.sst +samplefile2.sst <blockquote>Note: <i>-m</i> does initial processing, and <i>-H</i> omits filename suffixes +and requires a properly configured web server. <i>-h</i> is used to include filename +suffixes for file system viewing </blockquote> <p> -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</b> <i>-mhwpv</i> <a href='http://www.jus.uio.no/sisu/sample/markup/gpl2.fsf.sst'>http://www.jus.uio.no/sisu/sample/markup/gpl2.fsf.sst</a> - http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst +generate html, a word map and pdf with +verbose output for all marked up documents in a directory: <b>sisu</b> <i>-mhwpv</i> * <p> -one file is local the other remote process (html,pdf,concordance,plaintext -and place on pre-set remote destination): <b>sisu</b> <i>-mhwparv</i> gpl2.fsf.sst <a href='http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst'>http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst</a> +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</b> <i>-mhwpabxXv</i> +* <p> +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</b> +<i>-mhpxXawv</i> *.{r,s}? <p> +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</i> [filenames/wildcard]): +<b>sisu</b> <i>-mhwprv</i> example_file.sst other_example_file.sst <p> +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</b> <i>-mhwpv</i> <a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a> + +http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst <p> +one file is local +the other remote process (html,pdf,concordance,plaintext and place on pre-set +remote destination): <b>sisu</b> <i>-mhwparv</i> gpl3.fsf.sst <a href='http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst'>http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst</a> <p> initialize database, create relations (first manually create database with @@ -1180,8 +1183,7 @@ has an interactive help, which is accessed by typing just "sisu" at the command line, or as described below: <b>sisu</b> commands, document preparation, customisation, installation etc. <br> <pre>try: -sisu --help - sisu help +sisu --help sisu help help sisu --help commands sisu --help commands environment sisu --help env @@ -1252,7 +1254,7 @@ dom and node): <p> <i>sisu</i> --from-kdi [kdissert filename] attempts to convert a kdissert file (.kdi) <p>to sisu markup -<p> <i>sisu</i> --identify [filename/wildcard] attempts to identify +<p> <i>sisu</i> --identify [filename/wildcard] attempts to identify <p>the markup version of the file <p> <i>sisu</i> --query=[version number] and <i>sisu</i> --query=history diff --git a/data/doc/sisu/html/sisu.8.html b/data/doc/sisu/html/sisu.8.html index 755d1d32..b79b71b1 100644 --- a/data/doc/sisu/html/sisu.8.html +++ b/data/doc/sisu/html/sisu.8.html @@ -23,7 +23,7 @@ include its’ 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 <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +per document basis, ... for more see <i>man</i> 1 sisu or <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> <b>SiSU is an alternative way of publishing and managing documents.</b> @@ -44,13 +44,13 @@ online at <i><<a href='http://www.jus.uio.no/sisu/sample/markup.html'>http:// with syntax highlighting from <i><<a href='http://www.jus.uio.no/sisu/sample/syntax'>http://www.jus.uio.no/sisu/sample/syntax</a> ></i> <p> A syntax -table is provided at <i>/usr/share/doc/sisu/on_markup.txt</i> or equivalent, and +table is provided at <i>/usr/share/doc/sisu/on_markup.txt</i> or equivalent, and online at <i><<a href='http://www.jus.uio.no/sisu/sample/on_markup.txt'>http://www.jus.uio.no/sisu/sample/on_markup.txt</a> ></i> <p> <i>man</i> 1 sisu has a syntax table along with processing commands. <p> SiSU also provides some help -via the command: <i>sisu</i> --help and selecting an appropriate subject, e.g. <p> +via the command: <i>sisu</i> --help and selecting an appropriate subject, e.g. <p> <i>sisu</i> --help commands <p> <i>sisu</i> --help markup <p> @@ -76,7 +76,7 @@ look at output results, see the "sisu_manifest" page created for the document To generate an online document move to a writable directory, (create a work directory and cd into it) as the file will be downloaded there and e.g. <p> -<i>sisu</i> -1 <a href='http://www.jus.uio.no/sisu/gpl2.fsf/gpl2.fsf.sst'>http://www.jus.uio.no/sisu/gpl2.fsf/gpl2.fsf.sst</a> +<i>sisu</i> -1 <a href='http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst'>http://www.jus.uio.no/sisu/gpl3.fsf/gpl3.fsf.sst</a> <p> <i>sisu</i> -3 <a href='http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst'>http://www.jus.uio.no/sisu/free_culture.lawrence_lessig/free_culture.lawrence_lessig.sst</a> @@ -115,13 +115,13 @@ structure (and document samples) provided in the document sample directory: <i>cp</i> -a /usr/share/doc/sisu/sisu_markup_samples/dfsg/* ~/sisu_test/. <p> <b>----------</b> <p> -<b>Tip: </b> the markup syntax examples may be of interest <i><<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a> +<b>Tip:</b> the markup syntax examples may be of interest <i><<a href='http://www.jus.uio.no/sisu/sample/'>http://www.jus.uio.no/sisu/sample/</a> ></i> <p> <b>Tip:</b> <i>sisu</i> -U [sisu markup filename] should printout the different possible outputs and where sisu would place them. <p> -<b>Tip: </b> if you want to toggle ansi -color add <i>c</i> to your flags. <p> +<b>Tip:</b> if you want to toggle ansi +color add <i>c</i> to your flags. <p> <b>----------</b> <p> <b>SiSU configuration file search path is:</b> <p> <i>./_sisu/sisurc.yaml</i> @@ -193,23 +193,22 @@ from other skin directories as required. <h2><a name='sect7' href='#toc7'>Further Information</a></h2> <p> For more information -on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> or <i>man</i> sisu <h2><a name='sect8' href='#toc8'>Author</a></h2> -Ralph Amissah -<i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> +Ralph Amissah <i><ralph@amissah.com></i> +or <i><ralph.amissah@gmail.com></i> <h2><a name='sect9' href='#toc9'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> ,</b> <a href='http:~/bin/man2html?sisu_examples:1'><b>sisu_examples(1)</a> +,</b> <a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> ,</b> -<a href='http:~/bin/man2html?sisu_webrick:1'><b>sisu_webrick(1)</a> -,</b> <a href='http:~/bin/man2html?sisu_pdf:1'><b>sisu_pdf(1)</b></a> +<a href='http:~/bin/man2html?sisu_pdf:1'><b>sisu_pdf(1)</b></a> <a href='http:~/bin/man2html?sisu_sqlite:1'><b>sisu_sqlite(1)</b></a> <a href='http:~/bin/man2html?sisu_postgresql:1'><b>sisu_postgresql(1)</b></a> <a href='http:~/bin/man2html?sisu_termsheet:1'><b>sisu_termsheet(1)</a> -,</b> -<p> +,</b> <p> <hr><p> <a name='toc'><b>Table of Contents</b></a><p> diff --git a/data/doc/sisu/html/sisu_termsheet.1.html b/data/doc/sisu/html/sisu_termsheet.1.html index 14a904d3..e91cd9d7 100644 --- a/data/doc/sisu/html/sisu_termsheet.1.html +++ b/data/doc/sisu/html/sisu_termsheet.1.html @@ -16,24 +16,24 @@ publishing system <b>sisu</b> <b>-t</b> <i>[termsheet-name(s)]</i> <h2><a name='sect2' href='#toc2'>Description</a></h2> <b>sisu_termsheet</b> -<i>is</i> part of SiSU is <b>invoked</b> <i>through</i> the sisu command (man sisu) <p> +<i>is</i> part of SiSU is <b>invoked</b> <i>through</i> the sisu command (man sisu) <p> <h2><a name='sect3' href='#toc3'>Summary of man page</a></h2> <p> -sisu_termsheet, is started with the command: <b>sisu -t </b> <i>[termsheet-name(s)]</i> +sisu_termsheet, is started with the command: <b>sisu -t</b> <i>[termsheet-name(s)]</i> <h2><a name='sect4' href='#toc4'>Document Processing Command Flags</a></h2> <p> <b>sisu</b><i> -t</i><b> [termsheet-name(s)]</b> (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</i> +it is instructed to merge in the termsheet(s), and produces regular <i>SiSU</i> output documents from the merged results. <p> [further documentation on termsheets required] <h2><a name='sect5' href='#toc5'>Further Information</a></h2> <p> -For more information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +For more information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> or <i>man</i> sisu diff --git a/data/doc/sisu/html/sisu_vim.7.html b/data/doc/sisu/html/sisu_vim.7.html index 0909ce6a..f0c475c5 100644 --- a/data/doc/sisu/html/sisu_vim.7.html +++ b/data/doc/sisu/html/sisu_vim.7.html @@ -34,7 +34,7 @@ set color scheme to <b>slate</b> which is provided <h2><a name='sect2' href='#toc2'>Further Information</a></h2> <p> For more -information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> or <i>man</i> sisu <h2><a name='sect3' href='#toc3'>Author</a></h2> diff --git a/data/doc/sisu/html/sisu_webrick.1.html b/data/doc/sisu/html/sisu_webrick.1.html index f82412e2..917c176d 100644 --- a/data/doc/sisu/html/sisu_webrick.1.html +++ b/data/doc/sisu/html/sisu_webrick.1.html @@ -18,17 +18,17 @@ or <p> <h2><a name='sect2' href='#toc2'>Description</a></h2> <b>sisu_webrick</b> <i>is</i> part of SiSU (man sisu) sisu_webrick starts Ruby’s Webrick web-server -and points it to the directories to which <i>SiSU</i> output is written, providing -a list of these directories (assuming <i>SiSU</i> is in use and they exist). -<p> -The default port for sisu_webrick is set to 8081, this may be modified -in the yaml file: <i>~/.sisu/sisurc.yaml</i> a sample of which is provided as <i>/etc/sisu/sisurc.yaml</i> +and points it to the directories to which <i>SiSU</i> output is written, providing +a list of these directories (assuming <i>SiSU</i> is in use and they exist). <p> +The +default port for sisu_webrick is set to 8081, this may be modified in the +yaml file: <i>~/.sisu/sisurc.yaml</i> a sample of which is provided as <i>/etc/sisu/sisurc.yaml</i> (or in the equivalent directory on your system). <h2><a name='sect3' href='#toc3'>Summary of man page</a></h2> <p> sisu_webrick, may be started on it’s own with the command: <b>sisu_webrick</b> <i>[port]</i> or using -the sisu command with the -W flag: <b>sisu -W </b> <i>[port]</i> <p> +the sisu command with the -W flag: <b>sisu -W</b> <i>[port]</i> <p> where no port is given and settings are unchanged the default port is 8081 <h2><a name='sect4' href='#toc4'>Document Processing @@ -36,21 +36,21 @@ Command Flags</a></h2> <p> <b>sisu</b><i> -W</i><b> [port]</b> starts Ruby Webrick web-server, serving <i>SiSU</i> output directories, on the port provided, or if no port is provided and the defaults -have not been changed in <i>~/.sisu/sisurc.yaml</i> then on port 8081 -<h2><a name='sect5' href='#toc5'>Further -Information</a></h2> +have not been changed in <i>~/.sisu/sisurc.yaml</i> then on port 8081 +<h2><a name='sect5' href='#toc5'>Further Information</a></h2> <p> -For more information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> +For +more information on <i>SiSU</i> see: <i><<a href='http://www.jus.uio.no/sisu'>http://www.jus.uio.no/sisu</a> ></i> <p> -or -<i>man</i> sisu +or <i>man</i> sisu <h2><a name='sect6' href='#toc6'>Author</a></h2> -Ralph Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> - +Ralph +Amissah <i><ralph@amissah.com></i> or <i><ralph.amissah@gmail.com></i> <h2><a name='sect7' href='#toc7'>See Also</a></h2> <a href='http:~/bin/man2html?sisu:1'><b>sisu(1)</a> ,</b> <a href='http:~/bin/man2html?sisu_vim:7'><b>sisu_vim(7)</b></a> - <a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a> + +<a href='http:~/bin/man2html?sisu:8'><b>sisu(8)</a> ,</b> <p> <hr><p> diff --git a/data/doc/sisu/model/relaxng/sisu_object_model_dom.rnc b/data/doc/sisu/model/relaxng/sisu_object_model_dom.rnc index 2ab5cf79..fddacbb8 100644 --- a/data/doc/sisu/model/relaxng/sisu_object_model_dom.rnc +++ b/data/doc/sisu/model/relaxng/sisu_object_model_dom.rnc @@ -9,13 +9,13 @@ # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Ralph Amissah -# License: GPL 2 or later +# License: GPL 3 or later -# Summary of GPL 2 +# Summary of GPL 3 # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by the Free -# Software Foundation; either version 2 of the License, or (at your option) +# Software Foundation; either version 3 of the License, or (at your option) # any later version. # This program is distributed in the hope that it will be useful, but WITHOUT @@ -31,7 +31,7 @@ # available at these locations: # http://www.fsf.org/licenses/gpl.html # http://www.gnu.org/copyleft/gpl.html -# http://www.jus.uio.no/sisu/gpl2.fsf +# http://www.jus.uio.no/sisu/gpl3.fsf # SiSU was first released to the public on January 4th 2005 diff --git a/data/doc/sisu/model/relaxng/sisu_object_model_input.rnc b/data/doc/sisu/model/relaxng/sisu_object_model_input.rnc index 56c2606c..ad221da7 100644 --- a/data/doc/sisu/model/relaxng/sisu_object_model_input.rnc +++ b/data/doc/sisu/model/relaxng/sisu_object_model_input.rnc @@ -9,13 +9,13 @@ # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Ralph Amissah -# License: GPL 2 or later +# License: GPL 3 or later -# Summary of GPL 2 +# Summary of GPL 3 # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by the Free -# Software Foundation; either version 2 of the License, or (at your option) +# Software Foundation; either version 3 of the License, or (at your option) # any later version. # This program is distributed in the hope that it will be useful, but WITHOUT @@ -31,7 +31,7 @@ # available at these locations: # http://www.fsf.org/licenses/gpl.html # http://www.gnu.org/copyleft/gpl.html -# http://www.jus.uio.no/sisu/gpl2.fsf +# http://www.jus.uio.no/sisu/gpl3.fsf # SiSU was first released to the public on January 4th 2005 diff --git a/data/doc/sisu/model/relaxng/sisu_object_model_metaverse.rnc b/data/doc/sisu/model/relaxng/sisu_object_model_metaverse.rnc index 913aee90..b00ca480 100644 --- a/data/doc/sisu/model/relaxng/sisu_object_model_metaverse.rnc +++ b/data/doc/sisu/model/relaxng/sisu_object_model_metaverse.rnc @@ -9,13 +9,13 @@ # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Ralph Amissah -# License: GPL 2 or later +# License: GPL 3 or later -# Summary of GPL 2 +# Summary of GPL 3 # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by the Free -# Software Foundation; either version 2 of the License, or (at your option) +# Software Foundation; either version 3 of the License, or (at your option) # any later version. # This program is distributed in the hope that it will be useful, but WITHOUT @@ -31,7 +31,7 @@ # available at these locations: # http://www.fsf.org/licenses/gpl.html # http://www.gnu.org/copyleft/gpl.html -# http://www.jus.uio.no/sisu/gpl2.fsf +# http://www.jus.uio.no/sisu/gpl3.fsf # SiSU was first released to the public on January 4th 2005 diff --git a/data/doc/sisu/model/relaxng/sisu_object_model_sax.rnc b/data/doc/sisu/model/relaxng/sisu_object_model_sax.rnc index 0c82dae1..02507881 100644 --- a/data/doc/sisu/model/relaxng/sisu_object_model_sax.rnc +++ b/data/doc/sisu/model/relaxng/sisu_object_model_sax.rnc @@ -9,13 +9,13 @@ # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Ralph Amissah -# License: GPL 2 or later +# License: GPL 3 or later -# Summary of GPL 2 +# Summary of GPL 3 # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by the Free -# Software Foundation; either version 2 of the License, or (at your option) +# Software Foundation; either version 3 of the License, or (at your option) # any later version. # This program is distributed in the hope that it will be useful, but WITHOUT @@ -31,7 +31,7 @@ # available at these locations: # http://www.fsf.org/licenses/gpl.html # http://www.gnu.org/copyleft/gpl.html -# http://www.jus.uio.no/sisu/gpl2.fsf +# http://www.jus.uio.no/sisu/gpl3.fsf # SiSU was first released to the public on January 4th 2005 diff --git a/data/doc/sisu/model/relaxng/sisu_object_model_xhtml.rnc b/data/doc/sisu/model/relaxng/sisu_object_model_xhtml.rnc index c4930a40..740642fa 100644 --- a/data/doc/sisu/model/relaxng/sisu_object_model_xhtml.rnc +++ b/data/doc/sisu/model/relaxng/sisu_object_model_xhtml.rnc @@ -9,13 +9,13 @@ # Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Ralph Amissah -# License: GPL 2 or later +# License: GPL 3 or later -# Summary of GPL 2 +# Summary of GPL 3 # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU General Public License as published by the Free -# Software Foundation; either version 2 of the License, or (at your option) +# Software Foundation; either version 3 of the License, or (at your option) # any later version. # This program is distributed in the hope that it will be useful, but WITHOUT @@ -31,7 +31,7 @@ # available at these locations: # http://www.fsf.org/licenses/gpl.html # http://www.gnu.org/copyleft/gpl.html -# http://www.jus.uio.no/sisu/gpl2.fsf +# http://www.jus.uio.no/sisu/gpl3.fsf # SiSU was first released to the public on January 4th 2005 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 3e27c1d2..5bf3532b 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 @@ -79,14 +79,6 @@ module SiSU_Viz def banner_band %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}} end - #% credits - def credits_splash - %{<center><table summary="credits" align="center"bgcolor="#ffffff"><tr><td>#{widget_sisu}#{widget_wayBetter}#{widget_browsers}#{widget_pdfviewers}</td></tr></table></center>} - end - #% stamp - def stamp_stmp - "\\copyright Ralph Amissah, released under the GPL \\\\\n ralph@amissah.com \\\\\n www.jus.uio.no/sisu/" - end end class TeX def header_center @@ -103,3 +95,4 @@ module SiSU_Viz end end end +__END__ 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 9f12228f..a5ea67ec 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 @@ -69,10 +69,6 @@ module SiSU_Viz def banner_band %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#000070"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}} end - #% credits - def credits_splash - %{<center><table summary="credits" align="center"bgcolor="#ffffff"><tr><td>#{widget_sisu}#{widget_wayBetter}#{widget_browsers}#{widget_pdfviewers}#{table_close}</center>} - end end class TeX def header_center @@ -88,9 +84,4 @@ module SiSU_Viz "Document owner details" end end - class Stamp - def stmp - "\\copyright Ralph Amissah to be released under the GPL (or QT License equivalent as to be decided) \\\\\n ralph@amissah.com \\\\\n www.jus.uio.no/sisu/" - end - end end 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 261f924a..379fccee 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 @@ -51,7 +51,7 @@ module SiSU_Viz end #% credits def credits_splash - %{<table summary="credits" align="center"bgcolor="#ffffff"><tr><td><font color="black"><center><a href="http://www.gutenberg.net/"><img border="0" align="center" src="../_sisu/image_local/gutenberg_icon.png" alt="Gutenberg Project"><br />Courtesy of The Gutenberg Project</a><br />#{widget_sisu}</center></font></td></tr></table>} + %{<table summary="credits" align="center"bgcolor="#ffffff"><tr><td><font color="black"><center><a href="http://www.gutenberg.net/"><img border="0" align="center" src="../_sisu/image_local/gutenberg_icon.png" alt="Gutenberg Project"><br />Courtesy of The Gutenberg Project</a></center></font></td></tr></table>} end end class TeX @@ -67,9 +67,6 @@ module SiSU_Viz def owner_chapter "Document owner details" end - def stmp - "\\copyright Ralph Amissah, licence GPL \\\\\n www.jus.uio.no/sisu/" - end end class Inserts def insert1 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 3d8c0485..f4a7223f 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 @@ -66,10 +66,6 @@ module SiSU_Viz end def banner_home_guide end - #% credits - def credits_splash - %{<center><table summary="credits" align="center"bgcolor="#ffffff"><tr><td>#{widget_sisu}#{widget_wayBetter}#{widget_browsers}#{widget_pdfviewers}#{table_close}</center>} - end end class TeX def header_center @@ -85,9 +81,4 @@ module SiSU_Viz "Document owner details" end end - class Stamp - def stmp - "\\copyright Ralph Amissah to be released under the GPL (or QT License equivalent as to be decided) \\\\\n ralph@amissah.com \\\\\n www.jus.uio.no/sisu/" - end - end end 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 2a87c3a5..593a2d45 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 @@ -80,7 +80,7 @@ module SiSU_Viz %{<center><a href="http://www.fsf.org/"><img border="0" height="133" width="135" src="#{url_path_image_base}/levitating_gnu.png" alt="RMS/FSF - Levitating Gnu -->" /></a></center>} end def credits_splash - %{<center><table summary="credits" align="center"bgcolor="#ffffff"><tr><td><font color="#666666">#{insert_levitating_gnu}#{widget_sisu}#{widget_wayBetter}#{widget_browsers}#{widget_pdfviewers}</font></center></td></tr></table></center>} + %{<center><table summary="credits" align="center"bgcolor="#ffffff"><tr><td><font color="#666666">#{insert_levitating_gnu}</font></center></td></tr></table></center>} end end class TeX @@ -97,9 +97,4 @@ module SiSU_Viz "Document owner details" end end - class Stamp - def stmp - "\\copyright Ralph Amissah to be released under the GPL (or QT License equivalent as to be decided) \\\\\n ralph@amissah.com \\\\\n www.jus.uio.no/sisu/" - end - end end 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 3e27c1d2..5bf3532b 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 @@ -79,14 +79,6 @@ module SiSU_Viz def banner_band %{<table summary="band" border="0" cellpadding="3" cellspacing="0"><tr><td align="left" bgcolor="#ffffff"><a href="#{url_site}/" target="_top">#{png_home}</a>#{table_close}} end - #% credits - def credits_splash - %{<center><table summary="credits" align="center"bgcolor="#ffffff"><tr><td>#{widget_sisu}#{widget_wayBetter}#{widget_browsers}#{widget_pdfviewers}</td></tr></table></center>} - end - #% stamp - def stamp_stmp - "\\copyright Ralph Amissah, released under the GPL \\\\\n ralph@amissah.com \\\\\n www.jus.uio.no/sisu/" - end end class TeX def header_center @@ -103,3 +95,4 @@ module SiSU_Viz end end end +__END__ diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/gpl3.fsf.sst b/data/doc/sisu/sisu_markup_samples/dfsg/gpl3.fsf.sst new file mode 100644 index 00000000..edf4e303 --- /dev/null +++ b/data/doc/sisu/sisu_markup_samples/dfsg/gpl3.fsf.sst @@ -0,0 +1,290 @@ +SiSU 0.52 + +@title: GNU GENERAL PUBLIC LICENSE + +@author: Free Software Foundation + +@rights: Copyright (C) 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +@date: 2007-06-29 + +@date.available: 2007-06-29 + +@date.valid: 2007-06-29 + +@publisher: SiSU on behalf of the Free Software Foundation + +@links: {Free Software Foundation}http://www.fsf.org +{GPL3 @ FSF}http://gplv3.fsf.org/ +{GPL @ SiSU}http://www.jus.uio.no/sisu/gpl3.fsf +{GPL3 source text}http://www.gnu.org/licenses/gpl-3.0.txt +{ Free as In Freedom - Richard Stallman's Crusade for Free Software }http://www.jus.uio.no/sisu/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams + +@skin: skin_gnu + +% @promo: sisu_icon, fsf, open_society, sisu + +:A~ GNU GENERAL PUBLIC LICENSE + +:B~ Version 3, 29 June 2007 + +:C~ Copyright (C) 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +1~ Preamble + +The GNU General Public License is a free, copyleft license for software and other kinds of works. + +The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. + +Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. + +Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and modification follow. + +:C~ TERMS AND CONDITIONS + +1~0 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based on the Program. + +To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. + +An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. + +1~1 1. Source Code. + +The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. + +A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same work. + +1~2 2. Basic Permissions. + +All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. + +1~3 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. + +When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. + +1~4 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. + +1~5 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: + +_1 a) The work must carry prominent notices stating that you modified it, and giving a relevant date. + +_1 b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". + +_1 c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. + +_1 d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. + +A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. + +1~6 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: + +_1 a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. + +_1 b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. + +_1 c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. + +_1 d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. + +_1 e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. + +"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. + +If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). + +The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. + +Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. + +1~7 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: + +_1 a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or + +_1 b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or + +_1 c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or + +_1 d) Limiting the use for publicity purposes of names of licensors or authors of the material; or + +_1 e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or + +_1 f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. + +All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. + +1~8 8. Termination. + +You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). + +However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. + +Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. + +Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. + +1~9 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. + +1~10 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. + +1~11 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. + +If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. + +A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. + +1~12 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. + +1~13 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. + +1~14 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. + +Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. + +1~15 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +1~16 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +1~17 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +1~ How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. + +poem{ + + \<one line to give the program's name and a brief idea of what it does.\> + Copyright (C) \<year\> \<name of author\> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see http://www.gnu.org/licenses/. + +}poem + +Also add information on how to contact you by electronic and paper mail. + +If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: + +poem{ + + \<program\> Copyright (C) \<year\> \<name of author\> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type 'show c' for details. + +}poem + +The hypothetical commands 'show w' and 'show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". + +You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see http://www.gnu.org/licenses/. + +The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read http://www.gnu.org/philosophy/why-not-lgpl.html. diff --git a/data/doc/sisu/sisu_markup_samples/dfsg/gpl3_draft3.fsf.sst b/data/doc/sisu/sisu_markup_samples/dfsg/gpl3_draft3.fsf.sst deleted file mode 100644 index 160a6058..00000000 --- a/data/doc/sisu/sisu_markup_samples/dfsg/gpl3_draft3.fsf.sst +++ /dev/null @@ -1,293 +0,0 @@ -SiSU 0.52 - -@title: GNU GENERAL PUBLIC LICENSE - -@author: Free Software Foundation - -@rights: THIS IS A DRAFT, NOT A PUBLISHED VERSION OF THE GNU GENERAL PUBLIC LICENSE.<br>Copyright (C) 2007 Free Software Foundation, Inc. (http://fsf.org) 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA<br>Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - -% @rights: THIS IS A DRAFT, NOT A PUBLISHED VERSION OF THE GNU GENERAL PUBLIC LICENSE.<br>Copyright (C) 2007 Free Software Foundation, Inc. (http://fsf.org) 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA<br>Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - -@links: {Free Software Foundation}http://www.fsf.org -{GPL @ SiSU}http://www.jus.uio.no/sisu/gpl2.fsf -{Markup}http://www.jus.uio.no/sisu/sample/markup/gpl2.fsf.sst -{Syntax}http://www.jus.uio.no/sisu/sample/syntax/gpl2.fsf.sst.html -{ Free as In Freedom - Richard Stallman's Crusade for Free Software }http://www.jus.uio.no/sisu/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams - -@skin: skin_gnu - -% @promo: sisu_icon, fsf, open_society, sisu - -:A~ GPLv3 - Third discussion draft - -% by brett — last modified 2007-03-28 09:51 - -:B~ GNU GENERAL PUBLIC LICENSE - -:C~ Discussion Draft 3 of Version 3, 28 March 2007 - -1~ [note] -# - -THIS IS A DRAFT, NOT A PUBLISHED VERSION OF THE GNU GENERAL PUBLIC LICENSE. - -poem{ - -Copyright (C) 2007 Free Software Foundation, Inc. ( http://fsf.org ) -51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -}poem - -Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. - -1~ Preamble - -The GNU General Public License is a free, copyleft license for software and other kinds of works. - -The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other program whose authors commit to using it. You can apply it to your programs, too. - -When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. - -To protect your rights, we need to make requirements that forbid anyone to deny you these rights or to ask you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it. - -For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. - -Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. - -For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be associated erroneously with the previous versions. - -Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the purpose of the GPL, which is to protect users' freedom to change the software where changes are possible. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. - -Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in places where they do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. - -The precise terms and conditions for copying, distribution and modification follow. - -:C~ TERMS AND CONDITIONS - -1~0 0. Definitions. - -"This License" refers to version 3 of the GNU General Public License. - -"Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. - -"The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you." "Licensees" and "recipients" may be individuals or organizations. - -To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of a verbatim copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. - -A "contributor" is a party who licenses under this License a work on which the Program is based. Such a work is called the party's "contribution." - -To "propagate" a work means to do (or cause others to do) anything with it that requires permission under applicable copyright law, except executing it on a computer or making modifications that you do not share. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies, excluding sublicensing. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. - -A party's "essential patent claims" in a work are all patent claims owned or controlled by the party, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling the work, but do not include claims that would be infringed only as a consequence of further modification of the work. For purposes of this definition, "control" includes the right to grant sublicenses in a manner consistent with the requirements of this License. - -1~1 1. Source Code. - -The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. - -A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. - -The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is normally included in the distribution of a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. - -The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. - -The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. - -The Corresponding Source for a work in source code form is that same work. - -1~2 2. Basic Permissions. - -All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. - -Propagation of covered works that you do not convey, and making modified versions of the Program that you do not convey, are permitted without conditions, so long as your license otherwise remains in force. Conveying is permitted under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. - -1~3 3. No Denying Users' Rights through Technical Measures. - -No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. - -When you convey a covered work, you waive any legal power to forbid circumvention of technical measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technical measures. - -1~4 4.[1] Conveying Verbatim Copies. - -You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. - -You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. - -1~5 5.[2] Conveying Modified Source Versions. - -You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4 above, provided that you also meet all of these conditions: - -_1* a) The work must carry prominent notices stating that you modified it, and giving a relevant date. - -_1* b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". - -_1* c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, unmodified except as permitted by section 7, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. - -_1* d) If the work has interactive user interfaces, each must include a convenient feature that displays an appropriate copyright notice, and tells the user that there is no warranty for the work (unless you provide a warranty), that licensees may convey the work under this License, and how to view a copy of this License. Specifically, if the interface presents a list of user commands or options, such as a menu, a command to display this information must be prominent in the list; otherwise, the work must display this information at startup. However, if the Program has interactive interfaces that do not comply with this subsection, your work need not make them comply. - -A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. - -1~6 6.[3] Conveying Non-Source Forms. - -You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: - -_1* a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. - -_1* b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, either (1) to give anyone who possesses the object code a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) to provide access to copy the Corresponding Source from a network server at no charge. - -_1* c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. - -_1* d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. - -_1* e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. - -A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. - -A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. [In cases of doubt concerning whether an item is a "consumer product", the interpretation of the Magnuson-Moss Warranty Act, 15 U.S.C. 2301 et seq., shall provide the basis for interpretation, regardless of the choice of law determination for this License as a whole.] - -"Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. - -If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). - -The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient. Network access may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. - -Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented, with an implementation available to the public in source code form, and must require no special password or key for unpacking, reading or copying. - -1~7 7. Additional Terms. - -"Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. - -When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. - -Notwithstanding any other provision of this License, you may supplement the terms of this License with terms effective under, or drafted for compatibility with, local law: - -_1* a. disclaiming warranty or limiting liability differently from the terms of section 15 of this License; or - -_1* b. requiring preservation of specified reasonable legal notices or author attributions in source or object code forms of material added by you to a covered work; or - -_1* c. prohibiting misrepresentation of the origin of material added by you to a covered work, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or - -_1* d. limiting the use for publicity purposes of specified names of licensors or authors, or of specified trade names, trademarks, or service marks, to the extent otherwise permitted by law. - -All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, purports to be governed by this License, supplemented by a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. - -If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. - -1~8 8.[4] Termination. - -You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void. If you violate this License, any copyright holder may put you on notice by notifying you of the violation, by any reasonable means, provided 60 days have not elapsed since the most recent violation. Having put you on notice, the copyright holder may, at any time, terminate the rights (including any patent rights) that the copyright holder has granted to you under this License. - -However, if this is your first violation of this License with respect to a given copyright holder, and you cure the violation within 30 days following your receipt of the notice, then your license is automatically reinstated. - -In the event that your rights are terminated under this section, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as they remain in full compliance. - -1~9 9.[5] Acceptance Not Required for Having Copies. - -You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. - -1~10 10.[6] Automatic Licensing of Downstream Recipients. - -Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. - -An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest. - -You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program (or the contribution of any contributor). - -1~11 11. Patents. - -Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims in its contribution, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contribution. - -For purposes of the following three paragraphs, a "patent license" means a patent license, a covenant not to bring suit for patent infringement, or any other express agreement or commitment, however denominated, not to enforce a patent. - -If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) disclaim the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. - -If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license providing freedom to use, propagate, modify or convey a specific copy of the covered work to any of the parties receiving the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. - -You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a patent license (a) in connection with copies of the covered work conveyed by you, and/or copies made from those, or (b) primarily for and in connection with specific products or compilations that contain the covered work, which license does not cover, prohibits the exercise of, or is conditioned on the non-exercise of any of the rights that are specifically granted to recipients of the covered work under this License[, unless you entered into that arrangement, or that patent license was granted, prior to March 28, 2007]. - -Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. - -1~12 12.[7] No Surrender of Others' Freedom. - -If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey the Program, or other covered work, so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. - -1~13 13. Use with the Affero General Public License. - -Notwithstanding any other provision of this License, you have permission to link any covered work with a work licensed under version 2 of the Affero General Public License, and to convey the resulting combination. The terms of this License will continue to apply to your covered work but will not apply to the work with which it is linked, which will remain governed by the Affero General Public License. - -1~14 14.[9] Revised Versions of this License. - -The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. - -If the Program specifies that a proxy can decide whether future versions of the GNU General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Program. - -1~15 15.[11, 12] Disclaimer of Warranty and Limitation of Liability. - -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. - -If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. - -END OF TERMS AND CONDITIONS - -1~ How to Apply These Terms to Your New Programs - -How to Apply These Terms to Your New Programs - -If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. - -To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - -poem{ - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, see http://www.gnu.org/licenses - or write to the Free Software Foundation,Inc., 51 Franklin Street, - Fifth Floor, Boston, MA 02110-1301 USA - -}poem - -Also add information on how to contact you by electronic and paper mail. - -If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - -poem{ - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type 'show c' for details. - -}poem - -The hypothetical commands 'show w' and 'show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than 'show w' and 'show c'; for a GUI interface, you would use an "About box" instead. - -You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: - -poem{ - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - 'Gnomovision' (which makes passes at compilers) written by James Hacker. - - <signature of Ty Coon>, 1 April 1989 - Ty Coon, President of Vice - -}poem - -For more information on how to apply and follow the GNU GPL, see http://www.gnu.org/licenses. - -The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. |