diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual')
6 files changed, 309 insertions, 175 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/sisurc.yml b/data/doc/sisu/markup-samples/sisu_manual/_sisu/sisurc.yml deleted file mode 100644 index 2b3df4db..00000000 --- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/sisurc.yml +++ /dev/null @@ -1,172 +0,0 @@ -# Name: SiSU - Simple information Structuring Universe -# Author: Ralph@Amissah.com -# Description: Site wide envionment defaults set here -# system environment info / resource configuration file, for sisu -# License: GPL v3 or later -# this file should be configured and live in -# /etc/sisu #per environment settings, overridden by: -# ~/.sisu #per user settings, overridden by: -# ./_sisu/config #per local directory settings -# $Date$ -# $Id$ -# Notes: implemented 2004w03 -# Site environment configuration file -# this file should be configured and live in -# /etc/sisu #per environment settings, overridden by: -# ~/.sisu #per user settings, overridden by: -# ./_sisu #per local markup directory settings -#% #image source directory, main path and subdirectories -#image: -## path: 'grotto/theatre/working' -# path: 'sisu_working' -# public: 'sisu_image' -# #all: 'image' -#% presentation/web directory, main path and subdirectories (most subdirectories are created automatically based on markup directory name) -webserv: - url_root: 'http://www.jus.uio.no' #without dir stub, e.g. this dir would map to http://www.jus.uio.no/sisu - path: '/var/www' #either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home - #images: 'sisu/image' - #man: 'man' - #php: 'php' - #cgi: '/usr/local/lib/sisu-cgi' - feed: 'feed' - sqlite: 'sisu/sqlite' -# webrick_url: true -#show_output_on: 'filesystem' #for -v and -u url information, alternatives: 'filesystem','webserver','remote_webserver','local:8111','localhost','localhost:8080','webrick','path' -#show_output_on: 'local:8111' -webserv_cgi: -# host: localhost -# base_path: ~ -# port: '8081' -# user: ~ - file_links: webserv -# file_links: www.jus.uio.no -show_output_on: 'filesystem_url' -#texinfo display output -#texinfo: -# stub: 'texinfo' -#% processing directories, main path and subdirectories -processing: -# path: 'sisu_processing' -# metaverse: 'metaverse' -# tune: 'tune' -# latex: 'tex' -# texinfo: 'texinfo' -# concord_max: 400000 -#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default) -flag: - color: true # making colour default -c is toggle, and will now toggle colour off - default: '-NhewpoabxXyYv' # includes verbose; -m would in any event be run by default - i: '-Nhewpoayv' # includes verbose; -m run by default - ii: '-NhewpoabxXyv' # includes verbose; -m run by default - iii: '-NhewpoabxXyYv' # includes verbose; -m run by default - iv: '-NhewpoabxXYDyv --import' # includes verbose; -m run by default - v: '-NhewpoabxXYDyv --update' # includes verbose; -m run by default -#flag: -# color: false # colour off default -c is toggle, and will toggle colour on -# i: '-mhwpcyv' # adding colour and verbosity to defaults (note: another -c won't toggle off) -# ii: '-mhwpaocyv' # adding colour and verbosity to defaults (note: another -c won't toggle off) -# iii: '-mhwpaobxXcyv' # adding colour and verbosity to defaults (note: another -c won't toggle off) -# iv: '-mhwpaobxXDcyv --import' # adding colour and verbosity to defaults (note: another -c won't toggle off) -# v: '-mhwpaobxXDcyv --update' # adding colour and verbosity to defaults (note: another -c won't toggle off) -#% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal, easily extensible -default: - #papersize: 'a4,letter' - papersize: 'A4' - language_file: 2 - #digest: 'sha' #sha is sha256, default is md5 - #multilingual: false - #language: 'English' -#% settings used by ssh scp -remote: - user: 'ralpha' - host: 'ulrik.uio.no' - #host: 'klodrik.uio.no' - path: '.' #no trailing slash eg 'sisu/www' -#% webrick information -#sql database info, postgresql and sqlite -db: - postgresql: - port: '5432' # '5432' - #user: 'tst' # '[provide username]' - #host: 'sisudoc.org' - #password: 'alternate1' - #user: 'ralph' - ##port: '5433' - #port: '5432' - sqlite: - user: 'ralph' - path: ~ # './sisu_sqlite.db' - port: "**" - multi: true -# single: true -#% possible values ~, true, false, or command instruction e.g. editor: 'gvim -c :R -c :S'. -#will only ignore if value set to false, absence or nil will not remove program as should operate without rc file -#ie in case of ~ will ignore and use hard coded defaults within program), true, false, or command instruction e.g. editor: 'gvim -c :R -c :S' -#on value true system defaults used, to change, e.g. editor specify -permission_set: - zap: true - css_modify: true - remote_base_site: true -program_set: - rmagick: true - wc: true - editor: true - postgresql: true - sqlite: true - tidy: true - rexml: true - pdflatex: true -program_select: - editor: 'gvim -c :R' - pdf_viewer: 'evince' - web_browser: 'kazehakase' - console_web_browser: 'links2' - odf_viewer: 'oowriter' - xml_viewer: 'xml-viewer' -search: - sisu: - flag: true -# action: http://localhost:8081/cgi-bin/sisu_pgsql.cgi - action: http://search.sisudoc.org - db: sisu - title: sample search form - hyperestraier: - flag: true - action: http://search.sisudoc.org/cgi-bin/estseek.cgi? -promo: sisu_search_libre, sisu_icon, sisu, open_society, fsf, ruby -#promo: sisu_search_libre, ad, sisu_icon, sisu, open_society, fsf, ruby -#promo: ad, sisu_icon, sisu, sisu_search_libre, open_society, fsf, ruby -## on (unless file says off); off (unless file says on); off regardless of file status -#promo: -# default_status: true -# switch_off: false -# list: -# ad: -# adsense: -# sisu: -# site: -# - sisu -# open_society: -# site: -# - twon -# - fc -# - faif -# - twobits -# # - ffa -# - catb -# sisu_icon: -# site: -# - sisu_icon -# ruby: -# site: -# - ruby_logo -# fsf: -# site: -# - fsf -# gpl: -# site: -# - gpl -# sisu_search_libre: -# search: -# - sisu_books_libre_sisusearch diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v2/sisurc.yml b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v2/sisurc.yml new file mode 100644 index 00000000..433c6967 --- /dev/null +++ b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v2/sisurc.yml @@ -0,0 +1,132 @@ +# Name: SiSU - Simple information Structuring Universe +# Author: Ralph@Amissah.com +# Description: Site wide envionment defaults set here +# system environment info / resource configuration file, for sisu +# License: GPL v3 or later +# site environment configuration file +# this file should be configured and live in +# /etc/sisu #per environment settings, overridden by: +# ~/.sisu #per user settings, overridden by: +# ./_sisu #per local markup directory settings +#% #image source directory, main path and subdirectories +#image: +# path: 'sisu_working' +# public: '_sisu/image' +# #all: 'image' +#% presentation/web directory, main path and subdirectories (most subdirectories are created automatically based on markup directory name) +#webserv: +# url_root: 'http://www.your.url' #without dir stub +# path: '/var/www' #either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home +# images: '_sisu/image' +# man: 'man' +# cgi: '/usr/local/lib/sisu-cgi' +# feed: 'feed' +# sqlite: 'sisu/sqlite' +# webrick_url: true +#show_output_on: 'filesystem' #for -v and -u url information, alternatives: 'filesystem','webserver','remote_webserver','local:8111','localhost','localhost:8080','webrick','path' +#show_output_on: 'local:8111' +#webserv_cgi: +# host: localhost +# base_path: ~ +# port: '8081' +# user: ~ +# file_links: webserv + +show_output_on: 'filesystem_url' +#texinfo display output +#texinfo: +# stub: 'texinfo' + +#% processing directories, main path and subdirectories +#processing: +# path: 'sisu_processing' +# metaverse: 'metaverse' +# tune: 'tune' +# latex: 'tex' +# texinfo: 'texinfo' +# concord_max: 400000 + +#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default) +flag: + color: true # making colour default -c is toggle, and will now toggle colour off + default: '-NhewpotbxXyYv' # -m run by default; includes verbose + i: '-Nhewpoty' # -m run by default + ii: '-NhewpotbxX' # -m run by default + iii: '-NhewpotbxXY' # -m run by default + iv: '-NhewpotbxXiIY' # -m run by default + v: '-NhewpotbxXYDv --update' # -m run by default; includes verbose + +#% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal, easily extensible +default: + papersize: 'a4,letter' + language_file: 2 + #digest: 'sha' #sha is sha256, default is md5 + #language: 'English' + #emphasis: 'italics' + +#% settings used by ssh scp +#remote: +# - +# user: '[usrname]' +# host: '[remote.hostname]' +# path: '.' #no trailing slash eg 'sisu/www' +# - +# user: '[usrname]' +# host: '[remote.hostname]' +# path: '.' #no trailing slash eg 'sisu/www' + +#% webrick information +#webrick: +# port: '8081' + +#sql database info, postgresql and sqlite +db: + postgresql: + port: '5432' # '5432' + #user: 'tst' # '[provide username]' + #host: 'sisudoc.org' + #user: 'ralph' + ##port: '5433' + #port: '5432' + sqlite: + user: 'ralph' + path: ~ # './sisu_sqlite.db' + port: "**" + multi: true +# single: true + +permission_set: + zap: true + css_modify: true + remote_base_site: true + +program_set: + rmagick: false +# wc: true +# editor: true +# postgresql: true +# sqlite: true +# tidy: true +# rexml: true +# pdflatex: true + +#program_select: +# editor: 'vim' +# pdf_viewer: 'evince' +# web_browser: 'iceweasel' +# console_web_browser: 'links2' #'elinks' #'w3m' #'lynx' #'links' +# odf_viewer: 'lowriter' #'oowriter' #'abiword' +# xml_viewer: 'xml-viewer' +# epub_viewer: 'ebook-viewer' #'calibre' #'fbreader' #'okular' +# info_viewer: 'pinfo -f' +# man: 'man' #'groff -man -Tascii' # 'nroff -man' + +#search: +# sisu: +# flag: true +## action: http://localhost:8081/cgi-bin/sisu_pgsql.cgi +# action: http://search.sisudoc.org +# db: sisu +# title: sample search form + +#promo: sisu_search_libre, sisu_icon, sisu, open_society, fsf, ruby diff --git a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml new file mode 100644 index 00000000..ed452402 --- /dev/null +++ b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml @@ -0,0 +1,137 @@ +# Name: SiSU - Simple information Structuring Universe +# Author: Ralph@Amissah.com +# Description: Site wide envionment defaults set here +# system environment info / resource configuration file, for sisu +# License: GPL v3 or later +# site environment configuration file +# this file should be configured and live in +# /etc/sisu #per environment settings, overridden by: +# ~/.sisu #per user settings, overridden by: +# ./_sisu #per local markup directory settings +#% #image source directory, main path and subdirectories +#image: +# path: 'sisu_working' +# public: '_sisu/image' +# #all: 'image' +#% presentation/web directory, main path and subdirectories (most subdirectories are created automatically based on markup directory name) +#webserv: +# url_root: 'http://www.your.url' #without dir stub +# path: '/var/www' #either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home +# images: '_sisu/image' +# man: 'man' +# cgi: '/usr/local/lib/sisu-cgi' +# feed: 'feed' +# sqlite: 'sisu/sqlite' +# webrick_url: true +#show_output_on: 'filesystem' #for -v and -u url information, alternatives: 'filesystem','webserver','remote_webserver','local:8111','localhost','localhost:8080','webrick','path' +#show_output_on: 'local:8111' +#webserv_cgi: +# host: localhost +# base_path: ~ +# port: '8081' +# user: ~ +# file_links: webserv + +show_output_on: 'filesystem_url' +#texinfo display output +#texinfo: +# stub: 'texinfo' + +#% processing directories, main path and subdirectories +#processing: +# path: 'sisu_processing' +# metaverse: 'metaverse' +# tune: 'tune' +# latex: 'tex' +# texinfo: 'texinfo' +# concord_max: 400000 + +#% flag - set (non-default) processing flag shortcuts -1, -2 etc. (here adding colour and verbosity as default) +flag: + color: true # making colour default -c is toggle, and will now toggle colour off + default: '-NhewpotbxXyYv' # -m run by default; includes verbose + i: '-Nhewpoty' # -m run by default + ii: '-NhewpotbxX' # -m run by default + iii: '-NhewpotbxXY' # -m run by default + iv: '-NhewpotbxXiIY' # -m run by default + v: '-NhewpotbxXYDv --update' # -m run by default; includes verbose + +#% papersize, (LaTeX/pdf) current values A4, US_letter, book_b5, book_a5, US_legal, easily extensible +default: + papersize: 'a4,letter' + language_file: 2 + #digest: 'sha' #sha is sha256, default is md5 + #language: 'English' + #emphasis: 'italics' + +#% settings used by ssh scp +#remote: +# - +# user: '[usrname]' +# host: '[remote.hostname]' +# path: '.' #no trailing slash eg 'sisu/www' +# - +# user: '[usrname]' +# host: '[remote.hostname]' +# path: '.' #no trailing slash eg 'sisu/www' + +#% webrick information +#webrick: +# port: '8081' + +#sql database info, postgresql and sqlite +db: + postgresql: + port: '5432' # '5432' + #user: 'tst' # '[provide username]' + #host: 'sisudoc.org' + #user: 'ralph' + ##port: '5433' + #port: '5432' + sqlite: + user: 'ralph' + path: ~ # './sisu_sqlite.db' + port: "**" + multi: true +# single: true + +#% output_dir_structure_by: language (language_and_filetype); filetype; or filename (original v1 & v2) +#output_dir_structure_by: filename +#output_dir_structure_by: filetype +output_dir_structure_by: language + +permission_set: + zap: true + css_modify: true + remote_base_site: true + +program_set: + rmagick: true +# wc: true +# editor: true +# postgresql: true +# sqlite: true +# tidy: true +# rexml: true +# pdflatex: true + +#program_select: +# editor: 'vim' +# pdf_viewer: 'evince' +# web_browser: 'iceweasel' +# console_web_browser: 'links2' #'elinks' #'w3m' #'lynx' #'links' +# odf_viewer: 'lowriter' #'oowriter' #'abiword' +# xml_viewer: 'xml-viewer' +# epub_viewer: 'ebook-viewer' #'calibre' #'fbreader' #'okular' +# info_viewer: 'pinfo -f' +# man: 'man' #'groff -man -Tascii' # 'nroff -man' + +#search: +# sisu: +# flag: true +## action: http://localhost:8081/cgi-bin/sisu_pgsql.cgi +# action: http://search.sisudoc.org +# db: sisu +# title: sample search form + +#promo: sisu_search_libre, sisu_icon, sisu, open_society, fsf, ruby diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm index c26aeabd..89d8556a 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm @@ -86,8 +86,6 @@ << sisu_search_cgi.ssi -<< sisu_hyperestraier.ssi - << sisu_webrick.sst << sisu_remote.sst diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst index 36e1bb9c..a5f380a9 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -208,7 +208,7 @@ see --rsync see --scp !_ --sample-search-form [--webserv=webrick] <br> -generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). -Fv (in addition to the above) provides some information on setting up hyperestraier for sisu. Alias -F +generate examples of (naive) cgi search form for sqlite and pgsql depends on your already having used sisu to populate an sqlite and/or pgsql database, (the sqlite version scans the output directories for existing sisu_sqlite databases, so it is first necessary to create them, before generating the search form) see -d -D and the database section below. If the optional parameter --webserv=webrick is passed, the cgi examples created will be set up to use the default port set for use by the webrick server, (otherwise the port is left blank and the system setting used, usually 80). The samples are dumped in the present work directory which must be writable, (with screen instructions given that they be copied to the cgi-bin directory). Alias -F !_ --scp [filename/wildcard] <br> copies sisu output files to remote host using scp. This requires that sisurc.yml has been provided with information on hostname and username, and that you have your "keys" and ssh agent in place. Also see --rsync. Alias -r diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst index 65dc4e91..a246d160 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -1108,6 +1108,45 @@ code{# }code +2~ Additional breaks - linebreaks within objects, column and page-breaks + +3~ line-breaks + +To break a line within a "paragraph object", two backslashes \\\\ \\ with a space before and a space or newline after them \\ may be used. + +code{ + +To break a line within a "paragraph object", +two backslashes \\ with a space before +and a space or newline after them \\ +may be used. + +}code + +The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated). + +3~ page breaks + +Page breaks are only relevant and honored in some output formats. A page break or a new page may be inserted manually using the following markup on a line on its own: + +code{ + +<:pb> + +}code + +or + +code{ + +<:pn> + +}code + +page new <:pn> breaks the page, starts a new page. + +page break <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page. + 2~ Book index To make an index append to paragraph the book index term relates to it, using an equal sign and curly braces. |