diff options
Diffstat (limited to 'data/doc/sisu/markup-samples/manual')
11 files changed, 168 insertions, 54 deletions
diff --git a/data/doc/sisu/markup-samples/manual/README b/data/doc/sisu/markup-samples/manual/README index dab91438..7d2481c7 100644 --- a/data/doc/sisu/markup-samples/manual/README +++ b/data/doc/sisu/markup-samples/manual/README @@ -1,5 +1,5 @@ -ruby ../../../../../bin/sisu6 --txt --no-ocn -v en/README.ssm -ruby ../../../../../bin/sisu6 --txt --no-ocn -v --no-manifest --dump='../../../../../..' en/README.ssm +ruby ../../../../../bin/sisu --txt --no-ocn -v en/README.ssm +ruby ../../../../../bin/sisu --txt --no-ocn -v --no-manifest --dump='../../../../../..' en/README.ssm -ruby ../../../../../bin/sisu6 --manpage -v en/sisu.ssm -ruby ../../../../../bin/sisu6 --manpage -v --no-manifest --dump='../../../../../../man/man1' en/sisu.ssm +ruby ../../../../../bin/sisu --manpage -v en/sisu.ssm +ruby ../../../../../bin/sisu --manpage -v --no-manifest --dump='../../../../../../man/man1' en/sisu.ssm diff --git a/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make b/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make index 5ffd7d14..7c377f4c 100644 --- a/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make +++ b/data/doc/sisu/markup-samples/manual/_sisu/sisu_document_make @@ -3,7 +3,7 @@ :breaks: new=C; break=1 :bold: /Debian|Ruby|SiSU/ :italics: /Linux|GPL|GPLv3|LaTeX|PostgreSQL|SQLite|SQL|Vim|ascii|plaintext|UTF-?8|HTML|XHTML|XML|EPUB|OpenDocument|ODF|ODT|PDF|pgSQL|TeXinfo|YAML|YML|OCN|object citation system|object citation numbering|granular search|Dublin Core/ - :substitute: /${sisu_stable}/,'5.6.2' /${sisu_dev}/,'6.2.3' /${debian_stable}/,'*{Wheezy}*' /${debian_testing}/,'*{Jessie}*' + :substitute: /${sisu_stable}/,'7.0.0' /${sisu_dev}/,'7.0.0' /${vn}/,'v7' /${debian_stable}/,'*{Jessie}*' /${debian_testing}/,'*{Stretch}*' :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org diff --git a/data/doc/sisu/markup-samples/manual/_sisu/sisurc.yml b/data/doc/sisu/markup-samples/manual/_sisu/sisurc.yml new file mode 100644 index 00000000..3cb49894 --- /dev/null +++ b/data/doc/sisu/markup-samples/manual/_sisu/sisurc.yml @@ -0,0 +1,148 @@ +# Name: SiSU - Simple information Structuring Universe +# Author: ralph@amissah.com +# Description: Site wide environment 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' #url to document root, without dir stub +# path: '/srv/www' #'/var/www' '/srv/www.sisudoc.org/web' #either (i) / [full path from root] or (ii) ~/ [home] or (iii) ./ [pwd] or (iv) will be made from home +# url_root: 'http://www.sisudoc.org' #without dir stub, e.g. this dir would map to http://www.sisudoc.org/samples +# 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: www.sisudoc.org + +#show_output_on: 'filesystem_url' +#texinfo display output +#texinfo: +# stub: 'texinfo' + +#% output_dir_structure_by: +# language (language and filetype directories); +# filetype (filetype directories, language code added to filename includes language code); +# filetype_mono or monolingual (filetype drectories, no language codes in filenames) +# filename (directory output similar to original v1 v2, filename includes language code); +# filename_mono (directory output similar to original v1 v2, filename without language code); +output_dir_structure_by: language # language filetype filetype_mono filename filename_mono +#% language_default: lng_lst: %w[am bg bn br ca cs cy da de el en eo es et eu fi fr ga gl he hi hr hy ia is it ja ko la lo lt lv ml mr nl nn no oc pl pt pt_BR ro ru sa se sk sl sq sr sv ta te th tk tr uk ur us vi zh] ('en' default) +#language_default: 'en' + +##% processing directories, main path and subdirectories (appended to $HOME), using defaults set in sysenv +#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 +# act0: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --verbose' +# act1: '--manifest --text --html' +# act2: '--manifest --text --html --epub --pdf' +# act3: '--manifest --qrcode --text --html --epub --concordance --pdf' +# act4: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook' +# act5: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --sqlite' +# act6: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite' +# act7: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --sqlite --source --sisupod' +# act8: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --pg --update' +# act9: '--manifest --digest --qrcode --text --html --epub --concordance --pdf --odf --docbook --xhtml --xml-sax --xml-dom --pg --update --source --sisupod' + +#% papersize, (LaTeX/pdf) available values: A4, US_letter, book_b5, book_a5, US_legal +default: + papersize: 'a4,letter' #'a4,letter,b5,a5,legal' + #language: 'en' + #texpdf_font: 'Liberation Sans' # 'Liberation Sans' 'Liberation Serif' + #texpdf_font_mono: 'Liberation Mono' #'Inconsolata' + #text_wrap: 78 + #emphasis: 'bold' #make *{emphasis}* 'bold', 'italics' or 'underscore', default if not configured is 'bold' + #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' + #host: # '[if not localhost, provide host tcp/ip address or domain name]'' + #user: # '[(if different from user) provide username]' + #password: # '[password if required]' +# sqlite: +# path: ~ # './sisu_sqlite.db' +# port: "**" + +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' #'gvim -c :R' +# pdf_viewer: 'evince' +# web_browser: 'iceweasel' +# console_web_browser: 'w3m' #'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://www.sisudoc.org/cgi-bin/sisu_v6c_sqlite.cgi +# action: http://search.sisudoc.org +# db: manual +# title: 'SiSU search form (sample)' + +#promo: sisu_search_libre, sisu_icon, sisu, open_society, fsf, ruby + +#omit: minitoc diff --git a/data/doc/sisu/markup-samples/manual/_sisu/v5/sisurc.yml b/data/doc/sisu/markup-samples/manual/_sisu/v5/sisurc.yml deleted file mode 120000 index 53d85905..00000000 --- a/data/doc/sisu/markup-samples/manual/_sisu/v5/sisurc.yml +++ /dev/null @@ -1 +0,0 @@ -../rc/sisurc_default.yml
\ No newline at end of file diff --git a/data/doc/sisu/markup-samples/manual/_sisu/v6/sisurc.yml b/data/doc/sisu/markup-samples/manual/_sisu/v6/sisurc.yml deleted file mode 120000 index 53d85905..00000000 --- a/data/doc/sisu/markup-samples/manual/_sisu/v6/sisurc.yml +++ /dev/null @@ -1 +0,0 @@ -../rc/sisurc_default.yml
\ No newline at end of file diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst index 3bf24cad..6fd5912e 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_commands.sst @@ -1,4 +1,4 @@ -% SiSU 5.0 +% SiSU 7.0 @title: SiSU :subtitle: Commands @@ -451,14 +451,6 @@ on its own, provides SiSU version information !_ -v [filename/wildcard] \\ see --verbose -!_ --v5 [filename/wildcard] \\ -invokes the sisu v5 document parser/generator. You may run sisu5 instead. This is the current default and is normally omitted. -={ SiSU command:sisu5|sisu version 5|--v5 } - -!_ --v6 [filename/wildcard] \\ -invokes the sisu v6 document parser/generator. You may run sisu6 instead. -={ SiSU command:sisu6|sisu version 6|--v6 } - !_ --verbose [filename/wildcard] \\ provides verbose output of what is being generated, where output is placed (and error messages if any), as with -u flag provides a url mapping of files created for each of the processing flag requests. Alias -v ={ SiSU command:verbose|--verbose|-v (verbose) } diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi index a4e5d3b1..e7e108ae 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi +++ b/data/doc/sisu/markup-samples/manual/en/sisu_config.ssi @@ -35,15 +35,15 @@ The SiSU configuration file is a yaml file, which means indentation is significa SiSU resource configuration is determined by looking at the following files if they exist: -_1 ./_sisu/v5/sisurc.yml +_1 ./_sisu/${vn}/sisurc.yml _1 ./_sisu/sisurc.yml -_1 ~/.sisu/v5/sisurc.yml +_1 ~/.sisu/${vn}/sisurc.yml _1 ~/.sisu/sisurc.yml -_1 /etc/sisu/v5/sisurc.yml +_1 /etc/sisu/${vn}/sisurc.yml _1 /etc/sisu/sisurc.yml @@ -62,15 +62,15 @@ Most sisu document headers relate to metadata, the exception is the @make: heade The search order is as for resource configuration: -_1 ./_sisu/v5/sisu_document_make +_1 ./_sisu/${vn}/sisu_document_make _1 ./_sisu/sisu_document_make -_1 ~/.sisu/v5/sisu_document_make +_1 ~/.sisu/${vn}/sisu_document_make _1 ~/.sisu/sisu_document_make -_1 /etc/sisu/v5/sisu_document_make +_1 /etc/sisu/${vn}/sisu_document_make _1 /etc/sisu/sisu_document_make diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst b/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst index 6fffb29e..f40d5329 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_howto.sst @@ -235,27 +235,23 @@ _1 sisu -vR[and processing flags] [filename/wildcard] Sample provided, on untarring the source tarball: -_1 conf/sisu/v5/sisurc.yml - -_1 conf/sisu/v6/sisurc.yml +_1 conf/sisu/sisurc.yml and on installation under: -_1 /etc/sisu/v5/sisurc.yml - -_1 /etc/sisu/v6/sisurc.yml +_1 /etc/sisu/sisurc.yml The following paths are searched: -_1 ./_sisu/v5/sisurc.yml or ./_sisu/v6/sisurc.yml +_1 ./_sisu/${vn}/sisurc.yml _1 ./_sisu/sisurc.yml -_1 ~/.sisu/v5/sisurc.yml or ~/.sisu/v6/sisurc.yml +_1 ~/.sisu/${vn}/sisurc.yml _1 ~/.sisu/sisurc.yml -_1 /etc/sisu/v5/sisurc.yml /etc/sisu/v6/sisurc.yml +_1 /etc/sisu/${vn}/sisurc.yml _1 /etc/sisu/sisurc.yml @@ -1112,11 +1108,11 @@ _1 http://www.jus.uio.no/sisu/SiSU/examples.html There is syntax support for some editors provided (together with a README file) in -_1 ./data/sisu/v5/conf/editor-syntax-etc +_1 ./data/sisu/${vn}/conf/editor-syntax-etc usually installed to: -_1 /usr/share/sisu/v5/conf/editor-syntax-etc +_1 /usr/share/sisu/${vn}/conf/editor-syntax-etc 2~ License diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst b/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst index 97fdbd28..6f69abc3 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_install_run.sst @@ -61,13 +61,7 @@ _1 qi gem --create --build --install --unstable Provided you have ruby & rake, this can be done with the single command: -_1 rake gem_create_build_install # (to build and install sisu v5 & sisu v6, alias gemcbi) - -separate gems are made/installed for sisu v5 & sisu v6 contained in source: - -_1 rake gem_create_build_install_stable # (to build and install sisu v5, alias gem5cbi) - -_1 rake gem_create_build_install_unstable # (to build and install sisu v6, alias gem6cbi) +_1 rake gem_create_build_install # (to build and install, alias gemcbi) for individual steps (create, build, install) see rake options, rake -T to specify sisu version for sisu installed via gem diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst index 43c161d1..d94f9a7a 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/manual/en/sisu_markup.sst @@ -207,8 +207,6 @@ code{ synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] - . sisu --v5 [operations] - . sisu --v6 [operations] @links: { SiSU Homepage }http://www.sisudoc.org/ diff --git a/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi b/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi index 81644d76..9ca2a260 100644 --- a/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi +++ b/data/doc/sisu/markup-samples/manual/en/sisu_synopsis.ssi @@ -33,16 +33,4 @@ sisu [ -CcFLSVvW ] Note: commands should be issued from within the directory that contains the marked up files, cd to markup directory. -sisu ships with version5 and version 6 (which is under development). - -sisu --v6 [and options/operations as above] - -or - -sisu6 [and options/operations as above] - -sisu version 1 has been discontinued. - -for settings see sisu --help env - sisu [ filename/ wildcard] == sisu -0 [filename/wildcard] |