aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/sisu_markup_samples
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2008-12-02 23:54:23 -0500
committerRalph Amissah <ralph@amissah.com>2008-12-02 23:54:23 -0500
commit0e6fc15ada3c5d9a86b227163f35a54993b32529 (patch)
tree90ac98f2dadf8a2731fac4921fb5d9263eeedeb9 /data/doc/sisu/sisu_markup_samples
parentsha256 for 0.69.4 (diff)
sisu harvest, introduce module along with header syntax addition & modification
* sisu markup, additional header and new format rule: * @creator: / @author: header field, introduced author name format rules for more usable metadata harvesting: surname comma other names, additional authors separated by semi-colon * param added meta-tag, @topic_register: formatting topic levels are separated from sub-levels by a colon, a semi-colon separates main topics if there are multiple topics at lowest sub-level, a pipe can be used to create multiple headings * harvest module, harvests metadata from document set currently extracts: (i) authors and their writings from document set; (ii) topics and associated writings from document set (topics use topic_register header). harvest (when run against documents common to a directory of a site) extracts metadata and organises the documents on a site by author and topic information provided (there is a new "topic_register" header, with formatting rules similar to those of the book index), results are placed in [output_path]/sisu_site_metadata. sisu --harvest *.sst * by author (see change in param @creator: / @author: header field) * by topic / subject index (see addition in param of @topic_register: header field) initially there should be an example samples here: http://www.jus.uio.no/sisu/sisu_site_metadata/harvest_authors.html http://www.jus.uio.no/sisu/sisu_site_metadata/harvest_topics.html together with update markup source files The authors and their writings list will be made to take on a more biblographical form, with the use of additional fields as required. (concept example, suitable for medium sized sites [to remove size constraint: implement SQL equivalent]) make feature more robust * css, for harvest output added * remote placement of sisu_site_metadata (output produced by metadata harvest) * sisu markup, update document samples accordingly * tidy copyright marks in program headers, remove repetition of dates [version bump because formatting rule introduced to author / creator header - where new site metadata harvest feature is used, (at present changes changes should not be noticed except when using metadata harvest)]
Diffstat (limited to 'data/doc/sisu/sisu_markup_samples')
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm2
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi56
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst6
-rw-r--r--data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst10
4 files changed, 13 insertions, 61 deletions
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm
index 2fe9ed3a..676e23d7 100644
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu.ssm
@@ -76,7 +76,7 @@ sisu [-CcFLSVvW]
% :B~? SiSU Output and Markup Examples
-<< sisu_examples.ssi
+<< sisu_examples.sst
<< sisu_search_intro.ssi
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi
deleted file mode 100644
index 5a7a2eb3..00000000
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.ssi
+++ /dev/null
@@ -1,56 +0,0 @@
-% SiSU 0.57
-
-@title: SiSU
-
-@subtitle: Markup Samples, Output Examples
-
-@creator: Ralph Amissah
-
-@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
-
-@type: information
-
-@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
-
-@date.created: 2002-11-12
-
-@date.issued: 2002-11-12
-
-@date.available: 2002-11-12
-
-@date.modified: 2007-09-16
-
-@date: 2007-09-16
-
-@level: new=C; break=1; num_top=1
-
-@skin: skin_sisu_manual
-
-@bold: /Gnu|Debian|Ruby|SiSU/
-
-@links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
-{ Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
-{ SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
-{ SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
-{ SiSU @ Ruby Application Archive }http://raa.ruby-lang.org/project/sisu/
-{ SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
-{ SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
-{ SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
-{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
-{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
-
-% @rcs:+ $Id$
-
-: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
-
-Some markup with syntax highlighting may be found under http://www.jus.uio.no/sisu/sample/syntax but is not as up to date.
-
-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/sisu_markup_samples/sisu_manual/sisu_examples.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst
index dd566091..307b7107 100644
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_examples.sst
@@ -39,8 +39,6 @@
{ SiSU help }http://www.jus.uio.no/sisu/sisu_manual/sisu_help/
{ SiSU help sources }http://www.jus.uio.no/sisu/sisu_manual/sisu_help_sources/
-@rcs:+ $Id: sisu_examples.sst,v 1.25 2007/09/08 17:12:47 ralph Exp $
-
:A~? @title @creator
:B~? SiSU Markup and Output Examples
@@ -63,6 +61,10 @@ For some documents hardly any markup at all is required at all, other than a hea
{ "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
diff --git a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
index 09a8f427..292bfe13 100644
--- a/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
+++ b/data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst
@@ -103,7 +103,7 @@ With SiSU installed sample skins may be found in: /usr/share/doc/sisu/sisu_marku
1~headers Markup of Headers
-Headers consist of semantic meta-data about a document, which can be used by any output module of the program; and may in addition include extra processing instructions.
+Headers contain either: semantic meta-data about a document, which can be used by any output module of the program, or; processing instructions.
Note: the first line of a document may include information on the markup version used in the form of a comment. Comments are a percentage mark at the start of a paragraph (and as the first character in a line of text) followed by a space and the comment:
@@ -125,7 +125,9 @@ code{
@subtitle: Markup
-@creator: Ralph Amissah
+@creator: Amissah, Ralph
+
+% note formatting on author / creator field, surname comma then other names, if more than one author separate by semi-colon
@rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
@@ -133,6 +135,10 @@ code{
@subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+@topic_register: text markup language; application:text processing;output:html|xml|latex|pdf|sql
+
+% note formatting for topic_register topic levels are separated by a colon, a semi-colon separates main topics
+
@date.created: 2002-08-28
@date.issued: 2002-08-28