From 74849f94f8ddd536ea2d2c1618d129b2dc33efc1 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Wed, 7 Jul 2010 10:54:27 -0400 Subject: documentation, minor updates --- data/doc/sisu/v2/html/sisu.1.html | 76 +++++++++++++--------- .../v2/sisu_markup_samples/sisu_manual/sisu.ssm | 2 +- .../sisu_manual/sisu_commands.sst | 7 +- .../sisu_manual/sisu_markup.sst | 12 +++- man/man1/sisu.1 | 48 +++++++++----- 5 files changed, 91 insertions(+), 54 deletions(-) diff --git a/data/doc/sisu/v2/html/sisu.1.html b/data/doc/sisu/v2/html/sisu.1.html index 207475d4..9d4b35d6 100644 --- a/data/doc/sisu/v2/html/sisu.1.html +++ b/data/doc/sisu/v2/html/sisu.1.html @@ -338,21 +338,30 @@ the individual files for sending). See the -S option without [filename/wildcard]
copies sisu markup file to output directory.

-
-t [filename/wildcard +
-T [filename/wildcard  (*.termsheet.rb)]
standard form document builder, preprocessing feature

+
-t [filename/wildcard]
+
produces plaintext with Unix linefeeds and without +markup, (object numbers are omitted), has footnotes at end of each paragraph +that contains them [  -A  for  equivalent  dos  (linefeed)  output  file] [see + -e  for (Options include: --endnotes for endnotes --footnotes for footnotes at +the end of each paragraph --unix for unix linefeed (default) --msdos for msdos +linefeed) +

+
-U [filename/wildcard]
-
prints url output list/map for the available processing -flags options and resulting files that could be requested, (can be used -to get a list of processing options in relation to a file, together with -information on the output that would be produced), -u provides url output -mapping for those flags requested for processing. The default assumes sisu_webrick -is running and provides webrick url mappings where appropriate, but these +
prints url output list/map for the available +processing flags options and resulting files that could be requested, (can +be used to get a list of processing options in relation to a file, together +with information on the output that would be produced), -u provides url +output mapping for those flags requested for processing. The default assumes +sisu_webrick is running and provides webrick url mappings where appropriate, -

can be switched to file system paths in sisurc.yml +

but these can be switched to file system paths in sisurc.yml

-u [filename/wildcard] @@ -907,7 +916,9 @@ html

markup example:


-

  normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/
+
  normal text,  *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_,
+"{citation}",
+  ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- #{monospace}#
   normal text
   !{emphasis}!
   *{bold text}*
@@ -918,25 +929,27 @@ html
   ,{subscript},
   +{inserted text}+
   -{strikethrough}-
+  #{monospace}#
 

 
  resulting output:
 
  normal text emphasis bold text underscore italics
-"citation" ^superscript^ [subscript] ++inserted text++ --strikethrough--
-
  normal
+"citation" ^superscript^ [subscript] ++inserted text++ --strikethrough-- monospace
 
-
text
-
  emphasis
+
  normal text
+
  emphasis [note:  can  be  configured  to  be  represented  by
+ bold,  italics  or  underscore]
 
  bold text
-
  underscore
 
  italics
+
  underscore
 
  "citation"
-
  ^superscript^
 
+
  ^superscript^
 
  [subscript]
 
  ++inserted text++
 
  --strikethrough--
-
 9.3 INDENTATION AND BULLETS
+
  monospace
 
+
 9.3 INDENTATION AND BULLETS
 
  markup example:
 

 
 

@@ -1017,7 +1030,6 @@ asterisks if required }~ continues
 
  normal text [^*3] continues
 
  normal text [^+2] continues
 
-

 
  Alternative endnote pair notation for footnotes/endnotes:
 

 
 

@@ -1030,11 +1042,11 @@ asterisks if required }~ continues
 
 
9.5 LINKS
 
 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS
-
  urls are found
-within text and marked up automatically. A url within text is automatically
-hyperlinked to itself and by default decorated with angled braces, unless
-they are contained within a code block (in which case they are passed as
-normal text), or escaped by a preceding underscore (in which case the decoration
+
  urls found within
+text are marked up automatically. A url within text is automatically hyperlinked
+to itself and by default decorated with angled braces, unless they are
+contained within a code block (in which case they are passed as normal
+text), or escaped by a preceding underscore (in which case the decoration
 is omitted).
 
  markup example:
 

@@ -1091,11 +1103,11 @@ block is used there is neither decoration nor hyperlinking, code blocks
 
  about {~^ SiSU }http://url.org markup
 

 
  resulting output:
-
  aboutSiSU <http://www.jus.uio.no/sisu/
+
  abou tSiSU <http://www.jus.uio.no/sisu/
 > [^14] markup
-
 9.5.3
+

 
-
LINKING IMAGES
+
9.5.3 LINKING IMAGES
 
  markup example:
 

 
 

@@ -3305,23 +3317,23 @@ are authors’ works that while freely distributable are not freely changeab
 
 
 
 
Source digest: 

-
MD5(sisu.ssm.sst)= fd741a3ccf160aa55b942d76bd4e3f2a
+
SHA256(sisu.ssm.sst)= a704e4b934fba753bf594990673cdd43a974d405702b78a12788ba80b5021850
 
 
 

 
 
Generated by: 

-
Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06)
+
Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07)
 
 

 
 
Ruby version:
 

-
ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux]
+
ruby 1.8.7 (2010-06-23 patchlevel 299) [i486-linux]
 
 

 
 
Document (dal) last generated:
 

 

-
Wed Mar 17 13:34:15 -0400 2010
+
Wed Jul 07 09:33:25 -0400 2010
 
 

 
 
Other versions of this document: 

@@ -3361,14 +3373,14 @@ are authors’ works that while freely distributable are not freely changeab
-
* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06)
+
* Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07)
* Ruby version: ruby 1.8.7 -(2010-01-10 patchlevel 249) [i486-linux]
+(2010-06-23 patchlevel 299) [i486-linux]
-
* Last Generated on: Wed Mar 17 13:34:17 +
* Last Generated on: Wed Jul 07 09:33:28 -0400 2010
diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm index 230c247c..c162db3f 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu.ssm @@ -19,7 +19,7 @@ :created: 2002-08-28 :issued: 2002-08-28 :available: 2002-08-28 - :modified: 2010-03-03 + :modified: 2010-07-07 @make: :num_top: 1 diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst index 9e4417ea..a406dc57 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_commands.sst @@ -19,7 +19,7 @@ :issued: 2002-08-28 :available: 2002-08-28 :published: 2007-09-16 - :modified: 2009-12-16 + :modified: 2010-07-07 @make: :num_top: 1 @@ -130,9 +130,12 @@ produces a zipped file of the prepared document specified along with associated !_ -s [filename/wildcard]
copies sisu markup file to output directory. -!_ -t [filename/wildcard (*.termsheet.rb)]
+!_ -T [filename/wildcard (*.termsheet.rb)]
standard form document builder, preprocessing feature +!_ -t [filename/wildcard]
+produces plaintext with Unix linefeeds and without markup, (object numbers are omitted), has footnotes at end of each paragraph that contains them [ -A for equivalent dos (linefeed) output file] [see -e for endnotes]. (Options include: --endnotes for endnotes --footnotes for footnotes at the end of each paragraph --unix for unix linefeed (default) --msdos for msdos linefeed) + !_ -U [filename/wildcard]
prints url output list/map for the available processing flags options and resulting files that could be requested, (can be used to get a list of processing options in relation to a file, together with information on the output that would be produced), -u provides url output mapping for those flags requested for processing. The default assumes sisu_webrick is running and provides webrick url mappings where appropriate, but these can be switched to file system paths in sisurc.yml diff --git a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst index baae0855..331e6af5 100644 --- a/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst +++ b/data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst @@ -22,7 +22,7 @@ :issued: 2002-08-28 :available: 2002-08-28 :published: 2008-05-22 - :modified: 2010-05-25 + :modified: 2010-07-07 @make: :num_top: 1 @@ -330,7 +330,8 @@ code{ code{ -normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- #{monospace}# normal text @@ -352,11 +353,14 @@ _{underscore}_ -{strikethrough}- +#{monospace}# + }code !_ resulting output: -normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- +normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", +^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}- #{monospace}# normal text @@ -378,6 +382,8 @@ _{underscore}_ -{strikethrough}- +#{monospace}# + 2~ Indentation and bullets !_ markup example: diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index ef5edb98..79d1f4ef 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,4 +1,4 @@ -.TH "sisu" "1" "2010-03-03" "2.0.0" "SiSU" +.TH "sisu" "1" "2010-07-07" "2.6.0" "SiSU" .SH NAME sisu \- documents: markup, structuring, publishing in multiple standard formats, and search .SH SYNOPSIS @@ -370,9 +370,18 @@ individual files for sending). See the \-S option without [filename/wildcard]. copies sisu markup file to output directory. .TP -.B \-t [filename/wildcard \ (*.termsheet.rb)] +.B \-T [filename/wildcard \ (*.termsheet.rb)] standard form document builder, preprocessing feature +.TP +.B \-t [filename/wildcard] +produces plaintext with Unix linefeeds and without markup, (object numbers +are omitted), has footnotes at end of each paragraph that contains them [ \ \-A +\ for \ equivalent \ dos \ (linefeed) \ output \ file] [see \ \-e \ for \ +endnotes]. (Options include: \-\-endnotes for endnotes \-\-footnotes for +footnotes at the end of each paragraph \-\-unix for unix linefeed (default) +\-\-msdos for msdos linefeed) + .TP .B \-U [filename/wildcard] prints url output list/map for the available processing flags options and @@ -1074,7 +1083,8 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document .nf - normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/ \"{citation}\" ^{superscript}^ ,{subscript}, +{inserted text}+ + normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", + ^{superscript}^, ,{subscript},, +{inserted text}+, \-{strikethrough}\- #{monospace}# .BR normal text .BR @@ -1095,6 +1105,8 @@ normally be marked 1.1.1 or 1.1.2 or 1.2.1 or 2.1.1 etc. in a document +{inserted text}+ .BR \-{strikethrough}\- +.BR + #{monospace}# .fi .BR @@ -1106,22 +1118,24 @@ normal text .B bold text .I underscore .I italics -"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- +"citation" ^superscript^ [subscript] ++inserted text++ \-\-strikethrough\-\- monospace .BR normal text .BR .B emphasis +[note: \ can \ be \ configured \ to \ be \ represented \ by \ bold, \ italics +\ or \ underscore] .BR .B bold text .BR -.I underscore +.I italics .BR -.I italics +.I underscore .BR "citation" @@ -1138,6 +1152,9 @@ normal text .BR \-\-strikethrough\-\- +.BR +monospace + .SH 9.3 INDENTATION AND BULLETS @@ -1281,7 +1298,6 @@ normal text [^*3] continues .BR normal text [^+2] continues - .BR .B Alternative endnote pair notation for footnotes/endnotes: @@ -1304,7 +1320,7 @@ the standard and pair notation cannot be mixed in the same document 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS .BR -urls are found within text and marked up automatically. A url within text is +urls found within text are marked up automatically. A url within text is automatically hyperlinked to itself and by default decorated with angled braces, unless they are contained within a code block (in which case they are passed as normal text), or escaped by a preceding underscore (in which case the @@ -1395,7 +1411,7 @@ automatically as a footnote .B resulting output: .BR -aboutSiSU [^14] markup +abou tSiSU [^14] markup .SH 9.5.3 LINKING IMAGES @@ -4630,19 +4646,19 @@ Filetype: .TP Source digest: -.I MD5(sisu.ssm.sst)= fd741a3ccf160aa55b942d76bd4e3f2a +.I SHA256(sisu.ssm.sst)= a704e4b934fba753bf594990673cdd43a974d405702b78a12788ba80b5021850 .TP Generated by: -.I Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) +.I Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07) .TP Ruby version: -.I ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux] +.I ruby 1.8.7 (2010-06-23 patchlevel 299) [i486-linux] .TP Document (dal) last generated: -.I Wed Mar 17 13:34:15 -0400 2010 +.I Wed Jul 07 09:33:25 -0400 2010 .TP Other versions of this document: @@ -4662,10 +4678,10 @@ pdf: at: .TP .TP -* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) +* Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07) .TP -* Ruby version: ruby 1.8.7 (2010-01-10 patchlevel 249) [i486-linux] +* Ruby version: ruby 1.8.7 (2010-06-23 patchlevel 299) [i486-linux] .TP -* Last Generated on: Wed Mar 17 13:34:17 -0400 2010 +* Last Generated on: Wed Jul 07 09:33:28 -0400 2010 .TP * SiSU http://www.jus.uio.no/sisu -- cgit v1.2.3