From 78b703344df880ea5dc0a7e0bdb482fc118161b0 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Mon, 1 Oct 2012 16:58:53 -0400 Subject: v3: markup samples, and help, minor updates --- data/doc/sisu/CHANGELOG_v3 | 2 + data/doc/sisu/markup-samples/README | 150 ++++++++++--- ...lman_crusade_for_free_software.sam_williams.sst | 25 +-- ...re_revolution.sam_williams.richard_stallman.sst | 28 +-- .../markup-samples/sisu_manual/_sisu/v3/sisurc.yml | 9 +- data/doc/sisu/markup-samples/sisu_manual/sisu.ssm | 33 +-- .../markup-samples/sisu_manual/sisu_commands.sst | 29 ++- .../markup-samples/sisu_manual/sisu_config.ssi | 7 +- .../sisu_manual/sisu_content_directories.ssi | 9 +- .../sisu/markup-samples/sisu_manual/sisu_css.ssi | 9 +- .../sisu_manual/sisu_description.sst | 31 ++- .../markup-samples/sisu_manual/sisu_download.ssi | 4 + .../markup-samples/sisu_manual/sisu_examples.ssi | 12 +- .../markup-samples/sisu_manual/sisu_examples.sst | 238 --------------------- .../sisu/markup-samples/sisu_manual/sisu_faq.sst | 29 ++- .../markup-samples/sisu_manual/sisu_filetypes.sst | 29 ++- .../sisu/markup-samples/sisu_manual/sisu_help.sst | 29 ++- .../sisu_manual/sisu_help_sources.sst | 29 ++- .../markup-samples/sisu_manual/sisu_homepages.ssi | 9 +- .../sisu/markup-samples/sisu_manual/sisu_how.ssi | 9 +- .../sisu/markup-samples/sisu_manual/sisu_howto.sst | 29 ++- .../sisu_manual/sisu_installation.ssi | 9 +- .../sisu_manual/sisu_interesting_to_whom.ssi | 9 +- .../sisu_manual/sisu_introduction.sst | 27 ++- .../markup-samples/sisu_manual/sisu_manual.ssm | 31 ++- .../markup-samples/sisu_manual/sisu_markup.sst | 30 ++- .../sisu_manual/sisu_output_overview.sst | 29 ++- .../markup-samples/sisu_manual/sisu_postgresql.sst | 31 ++- .../markup-samples/sisu_manual/sisu_quickstart.sst | 29 ++- .../markup-samples/sisu_manual/sisu_remote.sst | 29 ++- .../markup-samples/sisu_manual/sisu_search.ssm | 25 +-- .../markup-samples/sisu_manual/sisu_search_cgi.ssi | 9 +- .../sisu_manual/sisu_search_intro.ssi | 9 +- .../sisu_manual/sisu_short_feature_summary.ssi | 9 +- .../sisu/markup-samples/sisu_manual/sisu_sql.ssi | 17 +- .../markup-samples/sisu_manual/sisu_sqlite.sst | 31 ++- .../markup-samples/sisu_manual/sisu_synopsis.ssi | 11 +- .../sisu_manual/sisu_syntax_highlighting.sst | 29 ++- .../markup-samples/sisu_manual/sisu_webrick.sst | 31 ++- .../sisu_manual/sisu_work_needed_and_wishlist.ssi | 7 +- lib/sisu/v3/help.rb | 203 +++++++++--------- 41 files changed, 581 insertions(+), 773 deletions(-) delete mode 100644 data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index ad0e7d08..a773cf3a 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -90,6 +90,8 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.3.3.orig.tar.xz * v3: vim syntax sisu.vim, =\\= page new & -\\- page break +* v3: markup samples, and help, minor updates + * v3: vim ftplugin sisu.vim * linenumbering: on; relative; off, nn * cursor line & column: on; off, cu (existing cu+ & cu-) diff --git a/data/doc/sisu/markup-samples/README b/data/doc/sisu/markup-samples/README index 0b78f4ab..ac71cc50 100644 --- a/data/doc/sisu/markup-samples/README +++ b/data/doc/sisu/markup-samples/README @@ -1,64 +1,121 @@ -A few sample books prepared as sisu markup samples, output formats to be -generated using SiSU are contained in a separate package sisu_markup_samples +The package sisu contains a few documents published under the GPL or that are +Debian Free Software Guideline license compatible, noteably: + + Text: Free as in Freedom - Richard Stallman's Crusade for Free Software + URL: + Author: Sam Williams + Copyright: Sam Williams 2002 + License: Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Document License, Version 1.1 or + any later version published by the Free Software Foundation; with the + Invariant Sections being no invariant sections, with the Front-Cover Texts + being no invariant sections, and with the Back-Cover Texts being no + invariant sections URL: + Markup: free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst + + Text: Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution + URL: + Author: Sam Williams, Richard M. Stallman + Copyright: Sam Williams, Richard Stallman 2010 + License: Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Document License, Version 1.1 or + any later version published by the Free Software Foundation; with the + Invariant Sections being no invariant sections, with the Front-Cover Texts + being no invariant sections, and with the Back-Cover Texts being no + invariant sections URL: + Markup: free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst + +Output in multiple formats can be generated running SiSU against the markup +samples, e.g.: + +sisu --html filename.sst +sisu --html --epub --pdf filename.sst Online a few sample marked up documents, and their resulting outputs, can be found at: -The package sisu contains fewer sample documents, that are published under the -GPL or that are Debian Free Software Guideline license compatible, notably: +A few additional sample books prepared as sisu markup samples, output formats +to be generated using SiSU are contained in a separate package +sisu-markup-samples - Text: Free as in Freedom - Richard Stallman's Crusade for Free Software - URL: - Author: Sam Williams - Copyright: Sam Williams 2002 - License: Permission is granted to copy, distribute and/or modify this - document under the terms of the GNU Free Document License, Version 1.1 or any - later version published by the Free Software Foundation; with the Invariant - Sections being no invariant sections, with the Front-Cover Texts being no - invariant sections, and with the Back-Cover Texts being no invariant sections - URL: +sisu-markup-samples contains books (prepared using sisu markup), that were +released by their authors various licenses mostly different Creative Commons +licences that do not permit inclusion in the Debian Project as they have +requirements that do not meet the Debian Free Software Guidelines for various +reasons, most commonly that they require that the original substantive text +remain unchanged, and sometimes that the works be used only non-commercially. -sisu_markup_samples contains gpl content and additional material released under -various licenses mostly different Creative Commons licences that do not permit -inclusion in the Debian Project as they do not meet the DFSG for various -reasons, most commonly in that they require the original substantive text me -maintained and often that the works be used only non-commercially + Free as in Freedom - Richard Stallman's Crusade for Free Software, Sam + Williams, [as above] - Free as in Freedom - Richard Stallman's Crusade for Free Software, Sam Williams, [as above] + Free as in Freedom 2.0 - Richard Stallman and the Free Software Revolution, + Sam Williams, Richard M. Stallman [as above] Text: Free Culture - How Big Media Uses Technology and the Law to Lock Down Culture and Control Creativity URL: Author: Lawrence Lessig URL: Copyright: Lawrence Lessig, 2004 - License: + License: Attribution-Noncommercial (CC-BY-NC) 1.0 URL: + Markup: free_culture.lawrence_lessig.sst Text: The Wealth of Networks - How Social Production Transforms Markets and Freedom URL: Author: Yochai Benkler URL: Copyright: 2006 Yochai Benkler - License: + License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 2.5 URL: + Markup: the_wealth_of_networks.yochai_benkler.sst + + Text: Democratizing Innovation + URL: + Author: Eric von Hippel + URL: + Copyright: 2005 Eric von Hippel + License: Attribution-Noncommercial-No Derivative Works (CC-BY-NC-ND) 2.0 + URL: + Markup: democratizing_innovation.eric_von_hippel.sst + + Text: Viral Spiral + URL: + Author: David Bollier + URL: + Copyright: 2008 David Bollier + License: Attribution-Noncommercial (CC-BY-NC) 3.0 + URL: + Markup: viral_spiral.david_bollier.sst Text: Two Bits - The Cultural Significance of Free Software URL: Author: Christopher Kelty URL: Copyright: Duke University Press, 2008 - License: + License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 3.0 URL: + Markup: two_bits.christopher_kelty.sst + + Text: The Public Domain - Enclosing the Commons of the Mind + URL: + Author: James Boyle + URL: + Copyright: James Boyle, 2008 + License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 3.0 + URL: + Markup: the_public_domain.james_boyle.sst + Note: the book index has not yet been included Text: Free For All - How Linux and the Free Software Movement Undercut the High Tech Titans URL: Author: Peter Wayner URL: Copyright: Peter Wayner, 2000 - License: + License: Attribution-Noncommercial (CC-BY-NC) 1.0 URL: + Markup: free_for_all.peter_wayner.sst Text: The Cathederal and the Bazaar URL: @@ -67,35 +124,72 @@ maintained and often that the works be used only non-commercially Copyright: Eric S Raymond, 2000 License: Open Publication License, v 2.0 URL: + Markup: the_cathedral_and_the_bazaar.eric_s_raymond.sst + + Text: CONTENT - Selected Essays on Technology, Creativity, Copyright and the Future of the Future + URL: + Author: Cory Doctorow + URL: + Copyright: Cory Doctorow, 2008 + License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 3.0 + URL: + Markup: content.cory_doctorow.sst + + Text: Down and Out in the Magic Kingdom + URL: + Author: Cory Doctorow + URL: + Copyright: Cory Doctorow, 2003 + License: Attribution-NonCommercial-ShareAlike (CC-BY-NC-SA) 1.0 + URL: + Markup: down_and_out_in_the_magic_kingdom.cory_doctorow.sst Text: Little Brother URL: Author: Cory Doctorow URL: Copyright: Cory Doctorow, 2008 - License: + License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 3.0 URL: + Markup: little_brother.cory_doctorow.sst + Illustration: little_brother_doctorow.png + URL: + Copyright: Richard Wilkinson + License: Attribution United States (CC BY) 3.0 + URL: + + Text: For the Win + URL: + Author: Cory Doctorow + URL: + Copyright: Cory Doctorow, 2010 + License: Attribution-Noncommercial-Share Alike (CC-BY-NC-SA) 3.0 + URL: + Markup: for_the_win.cory_doctorow.sst Text: Accelerando URL: Author: Charles Stross URL: Copyright: Charles Stross, 2005 - License: + License: Attribution-Noncommercial-No Derivative Works (CC-BY-NC-ND) 2.0 URL: - Note: The SiSU preparation (presentations) of Accelerando are done with the kind permission of the author Charles Stross + Markup: accelerando.charles_stross.sst + Note: The SiSU preparation (presentations) of Accelerando are done with the kind permission of the author Charles Stross Text: UN Contracts for International Sale of Goods Author: UN, UNCITRAL URL: Copyright: License: + Markup: un_contracts_international_sale_of_goods_convention_1980.sst -Most additional material contained in sisu_markup_samples were published under +Most additional material contained in sisu-markup-samples were published under various Creative Commons licenses, check the rights section of each document for the copyright and license, or the COPYRIGHT file associated with the package for a listing of material and their associated licenses. A few document more markup samples can be found at + diff --git a/data/doc/sisu/markup-samples/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst b/data/doc/sisu/markup-samples/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst index 213c76e7..d19efafa 100644 --- a/data/doc/sisu/markup-samples/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst +++ b/data/doc/sisu/markup-samples/samples/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst @@ -3,7 +3,11 @@ @title: Free as in Freedom :subtitle: Richard Stallman's Crusade for Free Software -@creator: Williams, Sam +@creator: + :author: Williams, Sam + +@date: + :published: 2002 @rights: :copyright: Copyright (C) Sam Williams 2002. @@ -14,26 +18,13 @@ :oclc: 49044520 :isbn: 9780596002879 -@date: - :published: 2002 - -@notes: March 2002 - @links: - { Home and Source }http://faifzilla.org/ - {Free as in Freedom (on Richard Stallman), Sam Williams @ SiSU}http://www.jus.uio.no/sisu/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams + {Home and Source}http://faifzilla.org/ {@ Wikipedia}http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software {@ Amazon.com}http://www.amazon.com/gp/product/0596002874 {@ Barnes & Noble}http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 - {Viral Spiral, David Bollier@ SiSU}http://www.jus.uio.no/sisu/viral_spiral.david_bollier - {Democratizing Innovation, Eric von Hippel @ SiSU}http://www.jus.uio.no/sisu/democratizing_innovation.eric_von_hippel - {The Wealth of Networks, Yochai Benkler @ SiSU}http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler - {Two Bits, Christopher Kelty @ SiSU}http://www.jus.uio.no/sisu/two_bits.christopher_kelty - {Free For All, Peter Wayner @ SiSU}http://www.jus.uio.no/sisu/free_for_all.peter_wayner - {The Cathedral and the Bazaar, Eric S. Raymond @ SiSU }http://www.jus.uio.no/sisu/the_cathedral_and_the_bazaar.eric_s_raymond - {Free Culture, Lawrence Lessig @ SiSU}http://www.jus.uio.no/sisu/free_culture.lawrence_lessig - {CONTENT, Cory Doctorow @ SiSU}http://www.jus.uio.no/sisu/content.cory_doctorow - {Little Brother, Cory Doctorow @ SiSU}http://www.jus.uio.no/sisu/little_brother.cory_doctorow + {SiSU}http://sisudoc.org/ + {sources / git}http://sources.sisudoc.org/ @make: :skin: skin_rms diff --git a/data/doc/sisu/markup-samples/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst b/data/doc/sisu/markup-samples/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst index 0ad90382..43d64ab4 100644 --- a/data/doc/sisu/markup-samples/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst +++ b/data/doc/sisu/markup-samples/samples/free_as_in_freedom_2.richard_stallman_and_the_free_software_revolution.sam_williams.richard_stallman.sst @@ -6,6 +6,9 @@ @creator: :author: Williams, Sam; Stallman, Richard M. +@date: + :published: 2010 + @rights: :copyright: Copyright (C) Sam Williams 2002; Copyright 2010 Richard M. Stallman :license: Published under the GNU Free Documentation License. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License." @@ -13,28 +16,17 @@ @classify: :topic_register: SiSU:markup sample:book;copyright;GNU/Linux:GPL|copyleft|free software;free software;Software:Software Libré;GPL;Linux:GNU|Software Libré;book:biography;programming -@date: - :published: 2010 - -@make: - :skin: skin_rms2 - :breaks: new=:A,:B,:C,1 - @links: - { Home and Source }http://faifzilla.org/ - {Free as in Freedom (on Richard Stallman), Sam Williams @ SiSU}http://www.jus.uio.no/sisu/free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams + {Home and Source}http://faifzilla.org/ {@ Wikipedia}http://en.wikipedia.org/wiki/Free_as_in_Freedom:_Richard_Stallman%27s_Crusade_for_Free_Software {@ Amazon.com}http://www.amazon.com/gp/product/0596002874 {@ Barnes & Noble}http://search.barnesandnoble.com/booksearch/isbnInquiry.asp?isbn=0596002874 - {Viral Spiral, David Bollier@ SiSU}http://www.jus.uio.no/sisu/viral_spiral.david_bollier - {Democratizing Innovation, Eric von Hippel @ SiSU}http://www.jus.uio.no/sisu/democratizing_innovation.eric_von_hippel - {The Wealth of Networks, Yochai Benkler @ SiSU}http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler - {Two Bits, Christopher Kelty @ SiSU}http://www.jus.uio.no/sisu/two_bits.christopher_kelty - {Free For All, Peter Wayner @ SiSU}http://www.jus.uio.no/sisu/free_for_all.peter_wayner - {The Cathedral and the Bazaar, Eric S. Raymond @ SiSU }http://www.jus.uio.no/sisu/the_cathedral_and_the_bazaar.eric_s_raymond - {Free Culture, Lawrence Lessig @ SiSU}http://www.jus.uio.no/sisu/free_culture.lawrence_lessig - {CONTENT, Cory Doctorow @ SiSU}http://www.jus.uio.no/sisu/content.cory_doctorow - {Little Brother, Cory Doctorow @ SiSU}http://www.jus.uio.no/sisu/little_brother.cory_doctorow + {SiSU}http://sisudoc.org/ + {sources / git}http://sources.sisudoc.org/ + +@make: + :skin: skin_rms2 + :breaks: new=:A,:B,:C,1 % http://static.fsf.org/nosvn/faif-2.0.pdf % http://www.scribd.com/doc/55232810/Free-as-in-Freedom-Richard-Stallman 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 index 3ef1a6db..6d11656d 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml +++ b/data/doc/sisu/markup-samples/sisu_manual/_sisu/v3/sisurc.yml @@ -83,11 +83,9 @@ default: db: postgresql: port: '5432' # '5432' - #user: 'tst' # '[provide username]' - #host: 'sisudoc.org' - #user: 'ralph' - ##port: '5433' - #port: '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: user: 'ralph' path: ~ # './sisu_sqlite.db' @@ -133,5 +131,4 @@ program_set: # 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 aed55649..666b2575 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu.ssm @@ -3,16 +3,8 @@ @title: SiSU :subtitle: Manual -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2011, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual +@creator: + :author: Amissah, Ralph @date: :published: 2008-05-22 @@ -21,12 +13,14 @@ :available: 2002-08-28 :modified: 2011-09-18 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu [operations] . sisu --v3 [operations] . sisu --v2 [operations] . sisu2 [operations] +@rights: + :copyright: Copyright (C) Ralph Amissah 2012 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -40,6 +34,13 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abCcDdeFGghIikLMmNnoPpQqRrSsTtUuVvWwXxYyZ_0-9] [filename/wildcard] . sisu [-Ddcv] [instruction] [filename/wildcard] . sisu [-CcFLSVvW] . sisu [operations] . sisu --v3 [operations] . sisu --v2 [operations] . sisu2 [operations] + :A~ @title @creator :B~ What is SiSU? 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 ff3b6a41..6a86aabb 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_commands.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual SiSU.ssm - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -23,11 +13,14 @@ :published: 2007-09-16 :modified: 2012-05-25 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2012 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:commands;SiSU:manual:commands;electronic documents:SiSU:manual:commands;SiSU:document:commands;SiSU:document:commands + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU Commands diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi index 5fe582cd..853580b3 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_config.ssi @@ -6,9 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -16,6 +13,10 @@ :available: 2002-08-28 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? Configuration :B~? Configure Environment diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi index 5784c03d..514e0439 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_content_directories.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -18,6 +13,10 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? Organisation of Content :B~? Content Directories diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi index 05f940dd..9eb680ed 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_css.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual - @date: :created: 2007-08-28 :issued: 2007-08-28 @@ -18,6 +13,10 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? CSS 1~css CSS - Cascading Style Sheets (for html, XHTML and XML) diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst index 9f8c1691..840d6338 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_description.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:description;sisu:document:description - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% SiSU.ssm - -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - @date: :created: 2002-11-12 :issued: 2002-11-12 @@ -23,12 +13,14 @@ :published: 2007-08-30 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu - :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|rant|utf-?8|WARNING/ - :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents;SiSU:document:description;sisu:document:description + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -42,6 +34,13 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu + :bold: /Debian|Ruby|SiSU|ocn|object citation numbering|granular search|rant|utf-?8|WARNING/ + :italics: /Linux|FreeBSD|Dragonfly|Perl|LaTeX|Postgresql|PostgreSQL|Postgres|sqlite|SQL|Reiserfs|PHP|xml|XML|Ion|g?vim|ascii|pdf|xhtml|pdflatex|pgsql|Postscript|texinfo|metadata|metatags|metaverse|rant|rake|YAML|object citation system|ocn|object citation numbering|granular search|Dublin Core|Lex Mercatoria|Project Gutenberg|Slashdot/i + :A~? @title @creator :B~? SiSU an attempt to describe diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi index 98000627..25bcd93b 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_download.ssi @@ -15,6 +15,10 @@ :published: 2009-01-18 :modified: 2011-03-11 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? SiSU Downloads, Stable and Development Branches diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi index 72939421..ebe4c1ea 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.ssi @@ -6,16 +6,16 @@ @creator: :author: Amissah, Ralph -% used_by: SiSU.ssm - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - @date: :created: 2002-11-12 :issued: 2002-11-12 :available: 2002-11-12 :published: 2007-09-16 - :modified: 2011-02-07 + :modified: 2012-10-03 + +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) :A~? @title @creator @@ -25,6 +25,6 @@ 2~ Markup examples *~markup -Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html +Current markup examples and document output samples are provided off http://sisudoc.org or http://www.jus.uio.no/sisu and in the sisu-markup-sample package available off http://sources.sisudoc.org For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst deleted file mode 100644 index 2fe64318..00000000 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_examples.sst +++ /dev/null @@ -1,238 +0,0 @@ -% SiSU 2.0 - -@title: SiSU - :subtitle: Markup Samples, Output Examples - -@creator: - :author: Amissah, Ralph - -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:examples;sisu:document:examples - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm - -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@date: - :created: 2002-11-12 - :issued: 2002-11-12 - :available: 2002-11-12 - :published: 2007-09-16 - :modified: 2011-02-07 - -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual -% :bold: /Gnu|Debian|Ruby|SiSU/ - -@links: - { SiSU Homepage }http://www.sisudoc.org/ - { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ - { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU Git repo }http://git.sisudoc.org/?p=code/sisu.git;a=summary - { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU - -:A~? @title @creator - -:B~? SiSU Markup and Output Examples - -1~examples Markup and Output Examples - -2~ Markup examples *~markup - -Current markup examples and document output samples are provided at http://www.jus.uio.no/sisu/SiSU/examples.html - -For some documents hardly any markup at all is required at all, other than a header, and an indication that the levels to be taken into account by the program in generating its output are. - -<:pb> - -2~ A few book (and other) examples *~books *~sample *~example *~output - -3~viral_spiral /{"Viral Spiral"}/, David Bollier - -{ "Viral Spiral", David Bollier [3sS]}viral_spiral.david_bollier.sst - -3~wealth_of_networks- /{"The Wealth of Networks"}/, Yochai Benkler - -{ "The Wealth of Networks", Yochai Benkler [3sS]}the_wealth_of_networks.yochai_benkler.sst - -3~two_bits- /{"Two Bits"}/, Christopher Kelty - -{ "Two Bits", Christopher Kelty [3sS]}two_bits.christopher_kelty.sst - -3~freeculture- /{"Free Culture"}/, Lawrence Lessig - -{ "Free Culture", Lawrence Lessig [3sS]}free_culture.lawrence_lessig.sst - -3~content- /{"CONTENT"}/, Cory Doctorow *~doctorow - -{ "CONTENT", Cory Doctorow [3sS]}content.cory_doctorow.sst *~content - -3~democratizing_innovation- /{"Democratizing Innovation"}/, by Eric von Hippel - -{ "Democratizing Innovation", by Eric von Hippel [3sS]}democratizing_innovation.eric_von_hippel.sst - -3~free_as_in_freedom- /{"Free as in Freedom: Richard Stallman's Crusade for Free Software"}/, by Sam Williams - -{ "Free as in Freedom: Richard Stallman's Crusade for Free Software", by Sam Williams [3sS]}free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst - -3~free_for_all- /{"Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans"}/, by Peter Wayner - -{ "Free For All: How Linux and the Free Software Movement Undercut the High Tech Titans", by Peter Wayner [3sS]}free_for_all.peter_wayner.sst - -3~catb- /{"The Cathedral and the Bazaar"}/, by Eric S. Raymond - -{ "The Cathedral and the Bazaar", by Eric S. Raymond [3sS]}the_cathedral_and_the_bazaar.eric_s_raymond.sst - -3~magickingdom- /{"Down and out in the Magic Kingdom"}/, Cory Doctorow *~doctorow - -{ "Down and out in the Magic Kingdom", Cory Doctorow [3sS]}down_and_out_in_the_magic_kingdom.cory_doctorow.sst *~magickingdom - -3~littlebrother- /{"Little Brother"}/, Cory Doctorow - -{ "Little Brother", Cory Doctorow [3sS]}little_brother.cory_doctorow.sst *~littlebrother - -3~ftw- /{"For the Win"}/, Cory Doctorow - -{ "For the Win", Cory Doctorow [3sS]}for_the_win.cory_doctorow.sst *~ftw - -3~accelerando- /{"Accelerando"}/, Charles Stross *~stross - -{ "Accelerando", Charles Stross [3sS]}accelerando.charles_stross.sst *~accelerando - -3~tainaron- /{"Tainaron"}/, Leena Krohn *~krohn - -{ "Tainaron", Leena Krohn [3sS]}tainaron.leena_krohn.1998.sst *~tainaron - -3~sphinx- /{"Sphinx or Robot"}/, Leena Krohn *~sor - -{ "Sphinx or Robot", Leena Krohn [3sS]}sphinx_or_robot.leena_krohn.1996.sst - -3~war_and_peace- /{"War and Peace"}/, Leo Tolstoy, PG Etext 2600 *~wap *~gutenberg - -{ "War and Peace", Leo Tolstoy [3sS]}war_and_peace.leo_tolstoy.sst ~{ http://www.jus.uio.no/sisu/war_and_peace.leo_tolstoy/toc.html
The ascii text was taken from Project Gutenberg. The markup transforms required are trivial. Of interest, in this instance I am saved by having alternative syntaxes/(structural modes) for marking up endnotes... as it was possible to do a simple search and replace to make the Project Gutenberg ascii presentation suitable for SiSU, using the older endnote markup style. This example instructs the program to use regular expressions, in this example the words: none; none; BOOK|FIRST|SECOND; CHAPTER; occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). Note that there was _{very little markup required}_ after the document headers and Project Gutenberg legal notices. As I presume the legal notices are similar in Project Gutenberg documents, (and I could not bear to think of preparing the same legal notices twice), I moved those to the "skin" for the Project, and these are now represented in the markup by \<:insert1\> and \<:insert2\> and the legal notices are available for similar insertion into the next Project Gutenberg text prepared for SiSU, should there be one.
I did a stylesheet/skin for the Gutenberg Project, ... I may have to remove. }~ - -3~quixote- /{"Don Quixote"}/, Miguel de Cervantes [Saavedra], translated by John Ormsby, PG Etext 996 - -{ "Don Quixote", Miguel de Cervantes [Saavedra] [3sS]}don_quixote.miguel_de_cervantes.sst - -3~gulliver- /{"Gulliver's Travels"}/, Jonathan Swift, transcribed from the 1892 George Bell and Sons edition by David Price, PG Etext 829 *~swift - -{ "Gulliver's Travels", Jonathan Swift [3sS]}gullivers_travels.jonathan_swift.sst - -3~alice- /{"Alice's Adventures in Wonderland"}/, Lewis Carroll, PG Etext 11 - -{ "Alice's Adventures in Wonderland", Lewis Carroll [3sS]}alices_adventures_in_wonderland.lewis_carroll.sst - -3~glass- /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etext 12 - -{ "Through The Looking-Glass", Lewis Carroll [3sS]}through_the_looking_glass.lewis_carroll.sst - -3~alice- /{"Alice's Adventures in Wonderland"}/ and /{"Through The Looking-Glass"}/, Lewis Carroll, PG Etexts 11 and 12 - -{ "Alice's Adventures in Wonderland" and "Through The Looking-Glass", Lewis Carroll [3sS]}alices_adventures_in_wonderland_and_through_the_looking_glass.lewis_carroll.ssm - -3~gpl- /{"Gnu Public License 2"}/, (GPL 2) Free Software Foundation - -{ "Gnu Public License 2", (GPL 2) Free Software Foundation [3sS]}gpl2.fsf.sst - -3~gpl- /{"Gnu Public License v3 - Third discussion draft"}/, (GPLv3) Free Software Foundation - -{ "Gnu Public License 3 - Third discussion draft", (GPL v3 draft3) Free Software Foundation [3sS]}gpl3_draft3.fsf.sst - -3~dsc- /{"Debian Social Contract"}/ - -{ "Debian Social Contract" [3sS]}debian_social_contract_v1.1.sst - -3~dc- /{"Debian Constitution v1.3"}/, (simple/default markup) - -{ "Debian Constitution v1.3" [3sS]}debian_constitution_v1.3.sst - -3~dc- /{"Debian Constitution v1.3"}/, (markup adjusted for output to more closely match the original) - -{ "Debian Constitution v1.3", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.3.adjusted.sst - -3~dc- /{"Debian Constitution v1.2"}/, (simple/default markup) - -{ "Debian Constitution v1.2 (more translations)" [3sS]}debian_constitution_v1.2.sst - -3~dc- /{"Debian Constitution v1.2"}/, (markup adjusted for output to more closely match the original) - -{ "Debian Constitution (more translations)", (markup adjusted for output to more closely match the original) [3sS]}debian_constitution_v1.2.adjusted.sst - -3~terminology- /{"A Uniform Sales Terminology"}/, Vikki Rogers and Albert Kritzer - -{ "A Uniform Sales Terminology", Vikki Rogers and Albert Kritzer [3sS]}a_uniform_international_sales_terminology.vikki_rogers.and.albert_kritzer.sst - -3~autonomous- /{"The Autonomous Contract" 1997 }/ - markup sample - -{ "The Autonomous Contract" 1997 - markup sample [3sS]}the_autonomous_contract.amissah.19970710.sst - -3~autonomous- /{"The Autonomous Contract Revisited"}/ - markup sample - -{ "The Autonomous Contract Revisited" - markup sample [3sS]}autonomy_markup0.sst ~{ http://www.jus.uio.no/sisu/autonomy_markup0/toc.html
alternative markup variations revolving around endnotes
(i) as above, markup with embedded endnotes, and header list of words/phrases to emphasise
http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup0.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup0.sst
(ii) Again markup with embedded endnotes, but font faces changed within paragraphs rather than in header as in i
http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup1.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup1.sst
(iii) Markup with endnote placemarks within paragraphs, the endnotes following the paragraph that contains them http://www.jus.uio.no/sisu/sample/syntax/autonomy_markup2.sst.html
http://www.jus.uio.no/sisu/sample/markup/autonomy_markup2.sst
(iv) Another alternative is to place the marked up endnotes sequentially and at the end of the text. This also works. The paragraph variant iii is perhaps easier to visually check should there be missing endnotes; but this variant iv may better suit the conversion of alternatively pre-prepared documents. }~ - -3~cisg- /{"United Nations Convention on Contracts for the International Sale of Goods"}/ - -{ "United Nations Convention on Contracts for the International Sale of Goods" [3sS]}un_contracts_international_sale_of_goods_convention_1980.sst ~{ http://www.jus.uio.no/sisu/un_contracts_international_sale_of_goods_convention_1980/toc.html
This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents).
This example instructs the program to use regular expressions, in this example the words: Part, Chapter, Section, Article occurring at the beginning of a line, to identify what should be treated as different levels of heading in a document (and used to make the table of contents). }~ - -3~pecl- /PECL/ the "Principles of European Contract Law" - -{ "Principles of European Contract Law" [3sS]}eu_contract_principles_parts_1_to_3_2002.sst - -2~sql SQL - PostgreSQL, SQLite - -A Sample search form is available at http://search.sisudoc.org - -A few canned searches, showing object numbers. Search for: - -_1 { English documents matching Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=index - -_1 { GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=index - -_1 { invention OR innovation }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=index - -_1 { copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=index - -Note that the searches done in this form are case sensitive. - -Expand those same searches, showing the matching text in each document: - -_1 { Linux OR Debian }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=Linux%2BOR%2BDebian&db=SiSUv2c_sisu&view=text - -_1 { GPL OR Stallman }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=GPL%2BOR%2BStallman&db=SiSUv2c_sisu&view=text - -_1 { invention OR innovation in English language }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=invention%2BOR%2Binnovation&db=SiSUv2c_sisu&view=text - -_1 { copyright in English language documents }http://search.sisudoc.org/cgi-bin/sisu_pgsql.cgi?s1=copyright&db=SiSUv2c_sisu&view=text - -Note you may set results either for documents matched and object number locations within each matched document meeting the search criteria; or display the names of the documents matched along with the objects (paragraphs) that meet the search criteria.~{ of this feature when demonstrated to an IBM software innovations evaluator in 2004 he said to paraphrase: this could be of interest to us. We have large document management systems, you can search hundreds of thousands of documents and we can tell you which documents meet your search criteria, but there is no way we can tell you without opening each document where within each your matches are found. }~ - -2~ Lex Mercatoria as an example - -There is quite a bit to peruse if you explore the site Lex Mercatoria: - -http://www.lexmercatoria.org/ ~{ http://www.jus.uio.no/lm/index }~ - -or perhaps: - -http://lexmercatoria.org/treaties.and.organisations/lm.chronological ~{ http://www.jus.uio.no/lm/treaties.and.organisations/lm.chronological }~ - -2~ For good measure the markup for a document with lots of (simple) tables - -SiSU is not optimised for table making, but does handle simple tables. - -_* {~^ Output of table file example }http://www.jus.uio.no/lm/un.conventions.membership.status/toc.html - -2~ And a link to the output of a reported case - -http://www.jus.uio.no/lm/england.fothergill.v.monarch.airlines.hl.1980/toc.html diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst index 76a594ac..bfc6023c 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_faq.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@classify: - :type: information - :topic_register: electronic documents;SiSU:document:FAQ;sisu:document:FAQ;SiSU:manual:FAQ;electronic documents:SiSU:manual:FAQ - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual SiSU.ssm - -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - @date: :published: 2008-03-12 :created: 2006-09-06 @@ -23,11 +13,14 @@ :issued: 2006-09-06 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents;SiSU:document:FAQ;sisu:document:FAQ;SiSU:manual:FAQ;electronic documents:SiSU:manual:FAQ + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator 1~faq FAQ - Frequently Asked/Answered Questions diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst index acf09499..f8378e9d 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_filetypes.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:filetypes;electronic documents:SiSU:manual:filetypes - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -23,11 +13,14 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: SiSU:manual:filetypes;electronic documents:SiSU:manual:filetypes + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator 1~filetypes SiSU filetypes diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst index 6c824da8..b2938efb 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:help;electronic documents:manual:SiSU:help - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -23,11 +13,14 @@ :published: 2007-08-30 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: SiSU:manual:help;electronic documents:manual:SiSU:help + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU Help diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst index 69a905f2..cf94b763 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_help_sources.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:help sources;electronic documents:SiSU:manual:help sources - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual - @date: :created: 2002-11-12 :issued: 2002-11-12 @@ -23,11 +13,14 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: SiSU:manual:help sources;electronic documents:SiSU:manual:help sources + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU Help Sources diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi index c7bb119a..58dc0937 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_homepages.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm sisu.ssm - @date: :published: 2007-09-16 :created: 2007-08-28 @@ -18,6 +13,10 @@ :available: 2007-08-28 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? Setting up of homepages diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi index d59a8bc5..3372bcd4 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_how.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -18,6 +13,10 @@ :available: 2002-08-28 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? Description diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst index 9464ce64..ef6cc674 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_howto.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual:howto;electronic documents:SiSU:manual:howto;SiSU:document:howto;sisu:document:howto - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual SiSU.ssm document - @date: :published: 2007-09-16 :created: 2002-11-12 @@ -23,11 +13,14 @@ :available: 2002-11-12 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: SiSU:manual:howto;electronic documents:SiSU:manual:howto;SiSU:document:howto;sisu:document:howto + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU some technical information diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi index acffb07e..f908bb6e 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_installation.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm SiSU.ssm - @date: :published: 2007-09-16 :created: 2002-11-12 @@ -18,6 +13,10 @@ :available: 2002-11-12 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? SiSU Installation notes :C~ Installation diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi index 304046f8..750c46ea 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_interesting_to_whom.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -18,6 +13,10 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? Who might SiSU interest? diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst index 4908b68f..28fc83c3 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_introduction.sst @@ -6,15 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2011, part of SiSU documentation, License GPL 3 - -% used_by: manual - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -22,11 +13,13 @@ :available: 2002-08-28 :modified: 2011-09-18 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2011 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -40,6 +33,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? What is SiSU? diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm index ca96daa1..a1879767 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_manual.ssm @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: SiSU:manual;electronic documents:SiSU:manual - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual - @date: :published: 2008-07-21 :created: 2002-08-28 @@ -23,11 +13,14 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: SiSU:manual;electronic documents:SiSU:manual + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~ @title @creator :B~ What is SiSU? @@ -77,7 +76,7 @@ % :B~? SiSU Output and Markup Examples -<< sisu_examples.sst +<< sisu_examples.ssi << sisu_output_overview.sst 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 000d3e4c..b99ccaa6 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup.sst @@ -6,17 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation - :license: GPL 3 or later - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm sisu.ssm - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -24,11 +13,14 @@ :published: 2008-05-22 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/i +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -42,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/i + :A~? @title @creator :B~? SiSU Markup diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst index 0ecbd692..2fc6cb3f 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_output_overview.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:markup table;SiSU:manual:output overview;electronic documents:SiSU:manual:output overview;SiSU:document:output overview;SiSU:document:output overview - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: manual, document - @date: :published: 2007-09-16 :created: 2005-10-31 @@ -23,11 +13,14 @@ :issued: 2006-10-31 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual -% :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:markup table;SiSU:manual:output overview;electronic documents:SiSU:manual:output overview;SiSU:document:output overview;SiSU:document:output overview + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual +% :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU overview of status of features available in various outputs diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst index 9b3f075f..7987296d 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_postgresql.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :topic_register: electronic documents:SiSU:document:postgresql;SiSU:manual:postgresql;electronic documents:SiSU:manual:postgresql;SiSU:document:postgresql;SiSU:document:postgresql; - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -23,12 +13,14 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -Dv [filename/wildcard ]\n sisu -Dv [instruction] +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :topic_register: electronic documents:SiSU:document:postgresql;SiSU:manual:postgresql;electronic documents:SiSU:manual:postgresql;SiSU:document:postgresql;SiSU:document:postgresql; + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -42,6 +34,13 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -Dv [filename/wildcard ]\n sisu -Dv [instruction] + :A~? @title @creator % :B~? SiSU Postgresql diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst index 1d4b2ce1..7f78e645 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_quickstart.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:quickstart;SiSU:manual:quickstart;electronic documents:SiSU:manual:quickstart;SiSU:document:quickstart;SiSU:document:quickstart - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: SiSU.ssm sisu_manual.ssm - @date: :created: 2006-09-06 :available: 2006-09-06 @@ -23,11 +13,14 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:quickstart;SiSU:manual:quickstart;electronic documents:SiSU:manual:quickstart;SiSU:document:quickstart;SiSU:document:quickstart + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? Quickstart - SiSU installation and use diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst index b9f1b1a8..042fd506 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_remote.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:remote;SiSU:manual:remote;electronic documents:SiSU:manual:remote;SiSU:document:remote;SiSU:document:remote - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -23,11 +13,14 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:remote;SiSU:manual:remote;electronic documents:SiSU:manual:remote;SiSU:document:remote;SiSU:document:remote + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU Remote Operations diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm b/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm index 406c8c1d..4c764f5b 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_search.ssm @@ -6,13 +6,6 @@ @creator: :author: Ralph Amissah -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -20,11 +13,13 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -38,6 +33,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :bold: /Gnu|Debian|Ruby|SiSU/ + :skin: skin_sisu_manual + :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi index fde97254..49a87ade 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_cgi.ssi @@ -6,11 +6,6 @@ @creator: :author: Ralph Amissah -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm sisu.ssm - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -18,6 +13,10 @@ :available: 2002-08-28 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi index cd9e241c..7cb096f5 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_search_intro.ssi @@ -6,11 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -18,6 +13,10 @@ :available: 2002-08-28 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + @make: :num_top: 1 :breaks: new=C; break=1 diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi index 063d5caa..c8099fb0 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_short_feature_summary.ssi @@ -6,11 +6,6 @@ @creator: :author: Ralph Amissah -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: manual - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -18,6 +13,10 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? What is SiSU? diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi index 818ed871..902a4a3b 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_sql.ssi @@ -6,15 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual.ssm - -@classify: - :type: information - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -22,6 +13,14 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search + :A~? @title @creator :B~? SiSU Search diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst index 45d51f06..3bb2e278 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_sqlite.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:sqlite;SiSU:manual:sqlite;electronic documents:SiSU:manual:sqlite;SiSU:document:sqlite;SiSU:document:sqlite - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - @date: :published: 2007-09-16 :created: 2002-08-28 @@ -23,12 +13,14 @@ :available: 2002-08-28 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -dv [filename/wildcard ]\n sisu -dv [instruction] +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:sqlite;SiSU:manual:sqlite;electronic documents:SiSU:manual:sqlite;SiSU:document:sqlite;SiSU:document:sqlite + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -42,6 +34,13 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: section=7; name=sisu - package to install what sisu needs to to populate a postgresql database (postgresql dependency component); synopsis=sisu -dv [filename/wildcard ]\n sisu -dv [instruction] + :A~? @title @creator % :B~? SiSU Sqlite diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi index fda4dc22..0c165f72 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_synopsis.ssi @@ -3,11 +3,8 @@ @title: SiSU :subtitle: Commands -@creator: :author: Amissah, Ralph - -@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -% used_by: sisu_manual SiSU.ssm +@creator: + :author: Amissah, Ralph @date: :created: 2002-08-28 @@ -16,6 +13,10 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? SiSU Commands diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst index 2cbd26f4..ddca75ee 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_syntax_highlighting.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:syntax highlighting;SiSU:manual:syntax highlighting;electronic documents:SiSU:manual:syntax highlighting;SiSU:document:syntax highlighting;SiSU:document:syntax highlighting - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - @date: :published: 2007-09-16 :created: 2002-11-12 @@ -23,11 +13,14 @@ :available: 2002-11-12 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu_manual - :bold: /Gnu|Debian|Ruby|SiSU/ +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:syntax highlighting;SiSU:manual:syntax highlighting;electronic documents:SiSU:manual:syntax highlighting;SiSU:document:syntax highlighting;SiSU:document:syntax highlighting + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -41,6 +34,12 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu_manual + :bold: /Gnu|Debian|Ruby|SiSU/ + :A~? @title @creator :B~? SiSU Syntax Highlighting diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst index e6239d02..81401189 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_webrick.sst @@ -6,16 +6,6 @@ @creator: :author: Amissah, Ralph -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - -@classify: - :type: information - :topic_register: electronic documents:SiSU:document:webrick;SiSU:manual:webrick;electronic documents:SiSU:manual:webrick;SiSU:document:webrick;SiSU:document:webrick - :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search - -% used_by: sisu_manual.ssm SiSU.ssm - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -23,12 +13,14 @@ :published: 2007-09-16 :modified: 2011-02-07 -@make: - :num_top: 1 - :breaks: new=C; break=1 - :skin: skin_sisu - :bold: /Gnu|Debian|Ruby|SiSU/ - :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + +@classify: + :type: information + :topic_register: electronic documents:SiSU:document:webrick;SiSU:manual:webrick;electronic documents:SiSU:manual:webrick;SiSU:document:webrick;SiSU:document:webrick + :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search @links: { SiSU Homepage }http://www.sisudoc.org/ @@ -42,6 +34,13 @@ { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU +@make: + :num_top: 1 + :breaks: new=C; break=1 + :skin: skin_sisu + :bold: /Gnu|Debian|Ruby|SiSU/ + :manpage: section=7; name=sisu - documents: structuring, publishing in multiple formats, and search; synopsis=sisu -W + :A~? @title @creator :B~? SiSU Webrick diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi b/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi index 4ef78580..20e774ac 100644 --- a/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi +++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_work_needed_and_wishlist.ssi @@ -6,9 +6,6 @@ @creator: :author: Ralph Amissah -@rights: - :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 - @date: :created: 2002-08-28 :issued: 2002-08-28 @@ -16,6 +13,10 @@ :published: 2007-09-16 :modified: 2011-02-07 +@rights: + :copyright: Copyright (C) Ralph Amissah 2007 + :license: GPL 3 (part of SiSU documentation) + :A~? @title @creator :B~? Work Needed and Wishlist diff --git a/lib/sisu/v3/help.rb b/lib/sisu/v3/help.rb index 980380c3..0ab87fdd 100644 --- a/lib/sisu/v3/help.rb +++ b/lib/sisu/v3/help.rb @@ -397,9 +397,12 @@ sisu Note: files for SiSU should be in UTF-8 character encoding. #{@cX.cyan}Data text markup#{@cX.off} (alternative to available html subset) - #{@cX.green}% SiSU 0.38#{@cX.off} [statement on first line of document, declared file-type identifier, SiSU markup document, markup used is version 0.38] - #{@cX.green}:A~#{@cX.off} heading/title [levels :A to :C available (and beneath that 1 to 6)] + #{@cX.green}% SiSU 2.00#{@cX.off} [statement on first line of document, declared file-type identifier, SiSU markup document, markup used is version 0.38] + + #{@cX.green}A~#{@cX.off} heading/title [levels A to C available (and beneath that 1 to 6)] + #{@cX.green}1~#{@cX.off}filename heading [segmentation level, levels 1 to 6 available] + #{@cX.green}!{#{@cX.off}emphasis#{@cX.green}}!#{@cX.off} #{@cX.green}*{#{@cX.off}bold text#{@cX.green}}*#{@cX.off} #{@cX.green}_{#{@cX.off}underscore#{@cX.green}}_#{@cX.off} @@ -409,18 +412,28 @@ sisu #{@cX.green},{#{@cX.off}subscript#{@cX.green}},#{@cX.off} #{@cX.green}+{#{@cX.off}inserted text#{@cX.green}}+#{@cX.off} #{@cX.green}-{#{@cX.off}strikethrough#{@cX.green}}-#{@cX.off} + ------------------------------------------ #{@cX.cyan}Indentation and bullets#{@cX.off} + #{@cX.green}_1#{@cX.off} indent paragraph one level + #{@cX.green}_2#{@cX.off} indent paragraph two steps + #{@cX.green}_*#{@cX.off} bullet text + #{@cX.green}_1*#{@cX.off} bullet text, first indent + ------------------------------------------ #{@cX.cyan}Numbered List#{@cX.off} (not to be confused with headings/titles, (document structure)) + #{@cX.green}##{@cX.off} numbered list numbered list 1., 2., 3, etc. + #{@cX.green}_##{@cX.off} numbered list numbered list indented second level a., b., c., d., etc. + ------------------------------------------ #{@cX.cyan}Endnotes#{@cX.off} + #{@cX.green}~{#{@cX.off}footnote/endnote#{@cX.green}}~#{@cX.off} endnote#{@cX.green}~{#{@cX.off}self contained endnote marker & endnote in one#{@cX.green}}~#{@cX.off} #{@cX.green}~{*#{@cX.off}asterisk footnote/endnote#{@cX.green}}~#{@cX.off} editor's annotations, square bracket notes @@ -430,8 +443,10 @@ sisu alternative endnote pair notation #{@cX.green}~^#{@cX.off} endnote marker #{@cX.green}^~#{@cX.off} endnote text following the paragraph in which the marker occurs + ------------------------------------------ #{@cX.cyan}Links#{@cX.off} + http://url.org on its own would be automatically marked up and hyperlinked to itself #{@cX.green}{#{@cX.off} [text to link] #{@cX.green}}#{@cX.off}http://url.org #{@cX.green}{#{@cX.off}image.png#{@cX.green}}#{@cX.off}http://url.org @@ -450,19 +465,24 @@ sisu if a server host name has been provided/configured, will provide a list of available output types that would be generated using the shortcut command and the markup file provided, i.e. output generated using the command (as configured): "sisu -3sS markup_source_filename.sst" using server host, directory stub, filename to compose the link. + ------------------------------------------ adding fixed names in html, manual location marker/tagging #{@cX.green}*~[name]#{@cX.off} + ------------------------------------------ #{@cX.green}~##{@cX.off} unnumbered paragraph (place marker at end of paragraph) #{@cX.green}-##{@cX.off} unnumbered paragraph, delete when not required (place marker at end of paragraph) [used in dummy headings, eg. for segmented html] + ------------------------------------------ manual page breaks (LaTeX/pdf) #{@cX.green}<:pb>#{@cX.off} page break, which breaks a page, starting a new page in single column text and a new column in double column text #{@cX.green}<:pn>#{@cX.off} page new, which starts a new page, in both single and double column text (leaving an empty column in double column text if necessary). Note: page breaks are usually introduced to pdfs either as header instructions, indicating that pages should break at given levels + ------------------------------------------ #{@cX.cyan}Composite documents#{@cX.off} + It is possible to build a document by creating a master document that requires other documents. The documents required may complete documents that could be generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built mainly from other documents), it should be named with the suffix #{@cX.blue}.ssm#{@cX.off} Within this document you would provide information on the other documents that should be included within the text. These may be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document #{@cX.blue}.sst#{@cX.off} regular markup file, or #{@cX.blue}.ssi#{@cX.off} (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix #{@cX.blue}.ssm.sst#{@cX.off} #{@cX.cyan}#basic sisu markup alternatives#{@cX.off} @@ -522,9 +542,9 @@ WOK @links: { SiSU }http://www.jus.uio.no/sisu { FSF }http://www.fsf.org -:A~ A Sample Document +A~ A Sample Document -:B~ just for fun +B~ just for fun 1~ This is Chapter One or Article One @@ -570,9 +590,9 @@ WOK @links: { SiSU }http://www.jus.uio.no/sisu { FSF }http://www.fsf.org -:A~ @title @author +A~ @title @author -:B~ just for fun +B~ just for fun 1~ This is Chapter One or Article One @@ -600,109 +620,79 @@ Header tags appear at the beginning of a document and provide meta information o All header instructions take either the form #{@cX.green}@headername:#{@cX.off} followed on the next line by an indented sub-category header if any #{@cX.green}:sub-headername:#{@cX.off}. #{@cX.green}@indentifier:#{@cX.off} information or instructions where the #{@cX.green}"identifier"#{@cX.off} is a tag recognised by the program, and the #{@cX.green}"information"#{@cX.off} or #{@cX.green}"instructions"#{@cX.off} belong to the tag/indentifier specified - Note: a header where used should only be used once; all headers apart from @title: are optional; the @structure: or 0~toc header is used to describe document structure, and can be useful to know. -This is a sample header (#{@cX.fuschia}Dublin Core in fuschia,#{@cX.off} #{@cX.cyan}other information headers in cyan,#{@cX.off} #{@cX.ruby}markup instructions in red#{@cX.off}): - -#{@cX.fuschia}@title:#{@cX.off} My Title - This is now the Title of the Document and used as such - #{@cX.cyan}:subtitle:#{@cX.off} The Subtitle if any - -#{@cX.fuschia}@creator:#{@cX.off} - #{@cX.fuschia}:author:#{@cX.off} Surname, Other names (if more than one author separate author names with a semi colon, if name is of an institution just write name or the name contains a comma enclose in quotation marks) - -#{@cX.fuschia}@classify:#{@cX.off} - #{@cX.fuschia}:topic_register:#{@cX.off} [e.g.:] text markup language; application:text processing;output:html|xml|latex|pdf|sql - -#{@cX.fuschia}@subject:#{@cX.off} (whatever your subject) - -#{@cX.fuschia}@description:#{@cX.off} - -#{@cX.fuschia}@publisher:#{@cX.off} - -#{@cX.fuschia}@contributor:#{@cX.off} - -#{@cX.fuschia}@translator:#{@cX.off} [or @translated_by:] - -#{@cX.fuschia}@illustrator:#{@cX.off} [or @illustrated_by:] - -#{@cX.fuschia}@prepared_by:#{@cX.off} [or @digitized_by:] - -#{@cX.fuschia}@date:#{@cX.off} 2000-08-27 -\t[ also #{@cX.fuschia}@date.created:#{@cX.off} #{@cX.fuschia}@date.issued:#{@cX.off} #{@cX.fuschia}@date.available:#{@cX.off} #{@cX.fuschia}@date.valid:#{@cX.off} #{@cX.fuschia}@date.modified:#{@cX.off} ] - -#{@cX.fuschia}@type:#{@cX.off} article - -#{@cX.fuschia}@format:#{@cX.off} - -#{@cX.fuschia}@identifier:#{@cX.off} - -#{@cX.fuschia}@source:#{@cX.off} - -#{@cX.fuschia}@language:#{@cX.off} [or @language.document:] [country code for language if available, or language, English, en 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, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian, hr - Croatian, cs - Czech, bg - Bulgarian ) [however, encodings are not available for all of the languages listed.] - -#{@cX.fuschia}@language.original:#{@cX.off} + Note: a header where used should only be used once; all headers apart from #{@cX.ruby}@title:#{@cX.off} are optional. + +#{@cX.ruby}@title:#{@cX.off} My Title - This is now the Title of the Document and used as such + #{@cX.cyan}:subtitle:#{@cX.off} The Subtitle if any + +#{@cX.ruby}@creator:#{@cX.off} + #{@cX.cyan}:author:#{@cX.off} Surname, Other names (if more than one author separate author names with a semi colon, if name is of an institution just write name or the name contains a comma enclose in quotation marks) + #{@cX.cyan}:contributor:#{@cX.off} + #{@cX.cyan}:translator:#{@cX.off} [or :translated_by:] + #{@cX.cyan}:illustrator:#{@cX.off} [or :illustrated_by:] + #{@cX.cyan}:prepared_by:#{@cX.off} [or :digitized_by:] + +#{@cX.ruby}@date:#{@cX.off} + #{@cX.cyan}:published:#{@cX.off} + #{@cX.cyan}:created:#{@cX.off} + #{@cX.cyan}:issued:#{@cX.off} + #{@cX.cyan}:available:#{@cX.off} + #{@cX.cyan}:valid:#{@cX.off} + #{@cX.cyan}:modified:#{@cX.off} + +#{@cX.ruby}@rights:#{@cX.off} + #{@cX.cyan}:copyright:#{@cX.off} Author's name, all rights reserved + #{@cX.cyan}:license:#{@cX.off} public domain, copyleft, creative commons variant, etc. + +#{@cX.ruby}@classify:#{@cX.off} + #{@cX.cyan}:topic_register:#{@cX.off} [e.g.:] text markup language; application:text processing;output:html|xml|latex|pdf|sql + #{@cX.cyan}:subject:#{@cX.off} (whatever your subject) + #{@cX.cyan}:keywords:#{@cX.off} + #{@cX.cyan}:coverage:#{@cX.off} + #{@cX.cyan}:relation:#{@cX.off} + #{@cX.cyan}:type:#{@cX.off} + #{@cX.cyan}:identifier:#{@cX.off} + #{@cX.cyan}:loc:#{@cX.off} [Library of Congress classification] + #{@cX.cyan}:dewey:#{@cX.off} [Dewey classification] + #{@cX.cyan}:isbn:#{@cX.off} + #{@cX.cyan}:oclc:#{@cX.off} + +#{@cX.ruby}@notes:#{@cX.off} + #{@cX.cyan}:description:#{@cX.off} + #{@cX.cyan}:abstract:#{@cX.off} + #{@cX.cyan}:comment:#{@cX.off} + #{@cX.cyan}:history:#{@cX.off} + #{@cX.cyan}:prefix:#{@cX.off} + #{@cX.cyan}:suffix:#{@cX.off} + +#{@cX.ruby}@publisher:#{@cX.off} + +#{@cX.ruby}@language:#{@cX.off} [or @language.document:] [country code for language if available, or language, English, en 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, et - Estonian, hu - Hungarian, pl - Polish, ro - Romanian, ru - Russian, el - Greek, uk - Ukranian, tr - Turkish, sk - Slovak, sl - Slovenian, hr - Croatian, cs - Czech, bg - Bulgarian ) [however, encodings are not available for all of the languages listed.] + +#{@cX.ruby}@language.original:#{@cX.off} original language in which the work was published -#{@cX.fuschia}@papersize:#{@cX.off} -(A4|US_letter|book_B5|book_A5|US_legal) - -#{@cX.fuschia}@relation:#{@cX.off} - -#{@cX.fuschia}@coverage:#{@cX.off} - -#{@cX.fuschia}@rights:#{@cX.off} copyright, all rights reserved, public domain, copyleft, creative commons variant, etc. - -#{@cX.cyan}@owner:#{@cX.off} - -#{@cX.cyan}@keywords:#{@cX.off} text document generation processing management latex pdf structured xml citation [your keywords here, used for example by rss feeds, and in sql searches] - -#{@cX.cyan}@abstract:#{@cX.off} [paper abstract, placed after table of contents] - -#{@cX.cyan}@comment:#{@cX.off} [...] - -#{@cX.cyan}@catalogue:#{@cX.off} #{@cX.green}loc=#{@cX.off}[Library of Congress classification]; #{@cX.green}dewey=#{@cX.off}[Dewey classification]; #{@cX.green}isbn=#{@cX.off}[ISBN]; #{@cX.green}pg=#{@cX.off}[Project Gutenberg text number] - -#{@cX.cyan}@classify_loc:#{@cX.off} [Library of Congress classification] - -#{@cX.cyan}@classify_dewey:#{@cX.off} [Dewey classification] - -#{@cX.cyan}@classify_isbn:#{@cX.off} [ISBN] - -#{@cX.cyan}@classify_pg:#{@cX.off} [Project Gutenberg text number] - -#{@cX.cyan}@prefix_a:#{@cX.off} [prefix is placed just before table of contents - not implemented] - -#{@cX.cyan}@prefix_b:#{@cX.off} or #{@cX.cyan}@prefix:#{@cX.off} [prefix is placed just after table of contents] - -#{@cX.cyan}@rcs:#{@cX.off} $Id$ [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 ] - -#{@cX.ruby}@structure:#{@cX.off} PART; CHAPTER; SECTION; ARTICLE; none; none; -optional, document structure can be defined by words to match or regular expression (the regular expression is assumed to start at the beginning of a line of text i.e. ^) default markers :A~ to :C~ and 1~ to 6~ can be used within text instead, without this header tag, and may be used to supplement the instructions provided in this header tag if provided (@structure: is a synonym for @toc:) - -#{@cX.ruby}@level:#{@cX.off} newpage=3; breakpage=4 [paragraph level, used by latex to breakpages, the page is optional eg. in newpage] - -#{@cX.ruby}@markup:#{@cX.off} num_top=4 [various markup instructions, eg: num_top=4 headings tobe numbered, starting at heading level 4... the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level] - -#{@cX.ruby}@bold:#{@cX.off} [regular expression of words/phrases to be made bold] - -#{@cX.ruby}@italics:#{@cX.off} [regular expression of words/phrases to italize] - -#{@cX.ruby}@vocabulary:#{@cX.off} name of taxonomy/vocabulary/wordlist to use against document - -#{@cX.ruby}@skin:#{@cX.off} skin_doc_[name_of_desired_document_skin] - -#{@cX.ruby}@links:#{@cX.off} { SiSU }http://www.jus.uio.no/sisu/; { FSF }http://www.fsf.org +#{@cX.ruby}@links:#{@cX.off} + { SiSU }http://www.jus.uio.no/sisu/ + { FSF }http://www.fsf.org -#{@cX.ruby}@@promo:#{@cX.off} 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] +#{@cX.ruby}@make:#{@cX.off} + #{@cX.cyan}:breaks:#{@cX.off} new=:B; break=1 + #{@cX.cyan}:bold:#{@cX.off} [regular expression of words/phrases to be made bold] + #{@cX.cyan}:italics:#{@cX.off} [regular expression of words/phrases to italize] + #{@cX.cyan}:headings:#{@cX.off} PART; CHAPTER; Section; Article; + #{@cX.grey}% optional, document structure can be defined by words to match or regular expression (the regular expression is assumed to start at the beginning of a line of text i.e. ^) default markers A~ to C~ and 1~ to 6~ can be used within text instead, without this header tag, and may be used to supplement the instructions provided in this header tag if provided#{@cX.off} + #{@cX.cyan}:papersize:#{@cX.off} (A4|US_letter|book_B5|book_A5|US_legal) + #{@cX.cyan}:markup:#{@cX.off} num_top=4 [various markup instructions, eg: num_top=4 headings tobe numbered, starting at heading level 4... the default is to provide 3 levels, as in 1 level 4, 1.1 level 5, 1.1.1 level 6, markup to be merged within level] + #{@cX.cyan}:promo:#{@cX.off} 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] #{@cX.grey}% header ends here, NB only @title: is mandatory [this would be a comment]#{@cX.off} -#{@cX.grey}% NOTE: headings/levels below refer to 0.38 expermental markup - (a conversion script provided in sisu-examples, modify.rb makes conversion between 0.37 and 0.38 markup simple)#{@cX.off} -#{@cX.blue}:A~#{@cX.off} Top level heading [this is usually the same as the title @title: ] +#{@cX.blue}A~#{@cX.off} Top level heading [this is usually the same as the title @title: ] -#{@cX.blue}:B~#{@cX.off} Second level heading [this is a heading level divider] +#{@cX.blue}B~#{@cX.off} Second level heading [this is a heading level divider] -#{@cX.blue}:C~#{@cX.off} Third level heading [this is a heading level divider] +#{@cX.blue}C~#{@cX.off} Third level heading [this is a heading level divider] #{@cX.blue}1~#{@cX.off} Top level heading preceding substantive text of document or sub-heading 5, the heading level that would normally be marked 1. or 2. or 3. etc. in a document @@ -1082,7 +1072,7 @@ The following heading or level (structuring) defaults are available (for use ins or, [0.38] - :A~ :B~ :C~ 1~ 2~ 3~ + A~ B~ C~ 1~ 2~ 3~ Heading tags take either of the forms above, ranging from 1-6 @@ -1114,11 +1104,11 @@ in the 0.38 notation this maps to: % SiSU 0.38 -:A~ Document Title +A~ Document Title -:B~ Document Subtitle whatever it is +B~ Document Subtitle whatever it is -:C~ Part +C~ Part 1~ Chapter @@ -1291,8 +1281,7 @@ WOK WOK end - def install - #% system configuration + def install #% system configuration print <