From 4a660c929a7871767966749e2a93035b2eb0d3f7 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Thu, 11 Dec 2008 21:53:41 -0500 Subject: help and changelog update --- CHANGELOG | 31 +++++++++++++ data/doc/sisu/html/sisu.1.html | 37 ++++++++------- .../sisu_manual/sisu_markup.sst | 2 +- lib/sisu/v0/help.rb | 4 +- man/man1/sisu.1 | 53 +++++++++++++++++----- 5 files changed, 98 insertions(+), 29 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 8932621d..e8978f2f 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -9,6 +9,37 @@ Reverse Chronological: %% STABLE MANIFEST +%% sisu_0.70.1.orig.tar.gz (2008-12-11:49/4) +http://www.jus.uio.no/sisu/pkg/src/sisu_0.70.1.orig.tar.gz + sisu_0.70.1.orig.tar.gz + sisu_0.70.1-1.dsc + sisu_0.70.1-1.diff.gz + + * harvest + * improved integration with sisu + * close output files before remote posting + * ensure html output is read by browser as utf-8 + [integration not quite complete as not added to sql, reason, each addition + of a field requires users recreating database, and there are other metadata + header additions under consideration, though unavoidable reduce the number + by grouping] + + * manifest + * show topic register metadata for each document + + * css main html modified + * left margin changed, affects html generally + * table th and td elements text top aligned + * additions for manifest display of topic_register + sisu -CC + + * html tables + * html structure, fix + * column width, fix + + * latex/pdf bullet mark (bug in texlive, missing (at this instant) provide + workaround) + %% sisu_0.70.0.orig.tar.gz (2008-12-03:48/3) http://www.jus.uio.no/sisu/pkg/src/sisu_0.70.0.orig.tar.gz 51e4d5c2ac3c490332d8468de2400abcf454b55ac1e21ec625680a346fb41e4a 1540091 sisu_0.70.0.orig.tar.gz diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index 1848611b..c17fecc6 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -723,13 +723,13 @@ up files are available as html with syntax highlighting for viewing: </usr/share/doc/sisu/sisu_markup_samples/non-free

8. 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. -

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: + 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: 


  % this would be a comment
@@ -742,13 +742,18 @@ one (without the comments):
 
  % SiSU 0.57
   @title: SiSU
   @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
   @type: information
   @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
   @date.available: 2002-08-28
@@ -1147,17 +1152,17 @@ is used there is neither decoration nor hyperlinking, code blocks are discussed
 
  markup example: 
 
 
 
 

-
      [ tux.png ]
+
  { tux.png 64x80 }image
   % various url linked images
-      [ tux.png ]
-      [ GnuDebianLinuxRubyBetterWay.png ]
+  {tux.png 64x80
+  {GnuDebianLinuxRubyBetterWay.png 100x101
   {~^ ruby_logo.png
 

 
  resulting output: 
 
  [ tux.png ] 
 
  tux.png 64x80 
 
  [  ruby_logo  (png  missing)
- ]  [^14] 
+ ] [^14] 
 
  GnuDebianLinuxRubyBetterWay.png 100x101 and Ruby 
 
  linked url footnote
 
@@ -3378,15 +3383,15 @@ of this document: 
 
 

 
-
* Generated by: SiSU 0.68.0 of 2008w29/1 (2008-07-21) 

+
* Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03) 

 

 
 
* Ruby version: ruby
-1.8.7 (2008-06-20 patchlevel 22) [i486-linux] 

+1.8.7 (2008-08-11 patchlevel 72) [i486-linux] 
 

 
-
* Last Generated on: Mon Jul 21
-02:54:35 -0400 2008 

+
* Last Generated on: Tue Dec 09
+12:24:07 -0500 2008 

 

 
 
* SiSU http://www.jus.uio.no/sisu
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 292bfe13..853b4124 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
@@ -127,7 +127,7 @@ code{
 
 @creator: Amissah, Ralph
 
-% note formatting on author / creator field, surname comma then other names, if more than one author separate by semi-colon
+% note formatting rules on author / creator field, "Surname, Other names", if more than one author separate by semi-colon (if name is of an institution just write name or the name contains a comma enclose in quotation marks)
 
 @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
 
diff --git a/lib/sisu/v0/help.rb b/lib/sisu/v0/help.rb
index 6b819f95..67263b68 100644
--- a/lib/sisu/v0/help.rb
+++ b/lib/sisu/v0/help.rb
@@ -600,7 +600,9 @@ This is a sample header (#{@cX.fuschia}Dublin Core in fuschia,#{@cX.off} #{@cX.c
 
 #{@cX.cyan}@subtitle:#{@cX.off} The Subtitle if any
 
-#{@cX.fuschia}@creator:#{@cX.off} [or @author:] Name of Author
+#{@cX.fuschia}@creator:#{@cX.off} [or @author:] 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}@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)
 
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1
index e8d68e2d..a65a3f3e 100644
--- a/man/man1/sisu.1
+++ b/man/man1/sisu.1
@@ -858,9 +858,8 @@ sisu\-markup\-samples is installed also under:
 .BR
 
 .BR
-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.
 
 .BR
 Note: the first line of a document may include information on the markup
@@ -882,30 +881,62 @@ This current document has a header similar to this one (without the comments):
 
 .nf
   % SiSU 0.57
+.BR
   @title: SiSU
+.BR
   @subtitle: Markup
-  @creator: Ralph Amissah
+.BR
+  @creator: Amissah, Ralph
+.BR
+  % note formatting on author / creator field, surname comma then other names, if more than one author separate by semi\-colon
+.BR
   @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+.BR
   @type: information
+.BR
   @subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+.BR
+  @topic_register: text markup language; application:text processing;output:html|xml|latex|pdf|sql
+.BR
+  % note formatting for topic_register topic levels are separated by a colon, a semi\-colon separates main topics
+.BR
   @date.created: 2002\-08\-28
+.BR
   @date.issued: 2002\-08\-28
+.BR
   @date.available: 2002\-08\-28
+.BR
   @date.modified: 2007\-09\-16
+.BR
   @date: 2007\-09\-16
+.BR
   @level: new=C; break=1; num_top=1
+.BR
   % comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population).
+.BR
   @skin: skin_sisu_manual
+.BR
   % skins modify the appearance of a document and are placed in a sub\-directory under \./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site\-wide. (A document is affected by a single skin)
+.BR
   @bold: /Gnu|Debian|Ruby|SiSU/
+.BR
   @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/
+.BR
   { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html
+.BR
   { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU
+.BR
   { SiSU @ Freshmeat }http://freshmeat.net/projects/sisu/
+.BR
   { SiSU @ Ruby Application Archive }http://raa.ruby\-lang.org/project/sisu/
+.BR
   { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html
+.BR
   { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html
+.BR
   { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html
+.BR
+.BR
 .fi
 
 .SH
@@ -1556,14 +1587,14 @@ about SiSU  [^13] markup
 
 
 .nf
-     \ [ tux.png ]
+  { tux.png 64x80 }image
 .BR
   % various url linked images
 .BR
-     \ [ tux.png ]
+  {tux.png 64x80 \"a better way\" }http://www.jus.uio.no/sisu/
 .BR
 .BR
-     \ [ GnuDebianLinuxRubyBetterWay.png ]
+  {GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian and Ruby\" }http://www.jus.uio.no/sisu/
 .BR
 .BR
   {~^ ruby_logo.png \"Ruby\" }http://www.ruby\-lang.org/en/
@@ -1581,7 +1612,7 @@ about SiSU  [^13] markup
 tux.png 64x80 \"Gnu/Linux \- a better way\" 
 
 .BR
-[ \ ruby_logo \ (png \ missing) \ ] \ [^14]
+[ \ ruby_logo \ (png \ missing) \ ] [^14]
 
 .BR
 GnuDebianLinuxRubyBetterWay.png 100x101 \"Way Better \- with Gnu/Linux, Debian
@@ -5033,10 +5064,10 @@ pdf: 
 at: 
 .TP
 .TP
-* Generated by: SiSU 0.68.0 of 2008w29/1 (2008-07-21)
+* Generated by: SiSU 0.70.0 of 2008w48/3 (2008-12-03)
 .TP
-* Ruby version: ruby 1.8.7 (2008-06-20 patchlevel 22) [i486-linux]
+* Ruby version: ruby 1.8.7 (2008-08-11 patchlevel 72) [i486-linux]
 .TP
-* Last Generated on: Mon Jul 21 02:54:35 -0400 2008
+* Last Generated on: Tue Dec 09 12:24:07 -0500 2008
 .TP
 * SiSU http://www.jus.uio.no/sisu
-- 
cgit v1.2.3