aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/v2/html
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2010-07-07 10:54:27 -0400
committerRalph Amissah <ralph@amissah.com>2010-07-07 10:54:27 -0400
commit74849f94f8ddd536ea2d2c1618d129b2dc33efc1 (patch)
treecf9e1d98631341f5d65e6bd908ac8d4c5eb1f339 /data/doc/sisu/v2/html
parentmanpage, remove monospace tag (diff)
documentation, minor updates
Diffstat (limited to 'data/doc/sisu/v2/html')
-rw-r--r--data/doc/sisu/v2/html/sisu.1.html76
1 files changed, 44 insertions, 32 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]
<dd>copies sisu markup file to output directory.
<p> </dd>
-<dt><b>-t [filename/wildcard
+<dt><b>-T [filename/wildcard
&nbsp;(*.termsheet.rb)]</b> </dt>
<dd>standard form document builder, preprocessing feature
<p>
</dd>
+<dt><b>-t [filename/wildcard]</b> </dt>
+<dd>produces plaintext with Unix linefeeds and without
+markup, (object numbers are omitted), has footnotes at end of each paragraph
+that contains them [ &nbsp;-A &nbsp;for &nbsp;equivalent &nbsp;dos &nbsp;(linefeed) &nbsp;output &nbsp;file] [see
+&nbsp;-e &nbsp;for (Options include: --endnotes for endnotes --footnotes for footnotes at
+the end of each paragraph --unix for unix linefeed (default) --msdos for msdos
+linefeed)
+<p> </dd>
+
<dt><b>-U [filename/wildcard]</b> </dt>
-<dd>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
+<dd>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,
-<p>can be switched to file system paths in sisurc.yml
+<p>but these can be switched to file system paths in sisurc.yml
<p> </dd>
<dt><b>-u [filename/wildcard]</b>
@@ -907,7 +916,9 @@ html
<p> <b>markup example:</b>
<p>
<p> <br>
-<pre> normal text !{emphasis}! *{bold text}* _{underscore}_ /{italics}/
+<pre> 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}#
</pre>
<p> <b>resulting output:</b>
<p> normal text <b>emphasis</b> <b>bold text</b> <i>underscore</i> <i>italics</i>
-"citation" ^superscript^ [subscript] ++inserted text++ --strikethrough--
-<p> normal
+"citation" ^superscript^ [subscript] ++inserted text++ --strikethrough-- monospace
-<p>text
-<p> <b>emphasis</b>
+<p> normal text
+<p> <b>emphasis</b> [note: &nbsp;can &nbsp;be &nbsp;configured &nbsp;to &nbsp;be &nbsp;represented &nbsp;by
+&nbsp;bold, &nbsp;italics &nbsp;or &nbsp;underscore]
<p> <b>bold text</b>
-<p> <i>underscore</i>
<p> <i>italics</i>
+<p> <i>underscore</i>
<p> "citation"
-<p> ^superscript^
+<p> ^superscript^
<p> [subscript]
<p> ++inserted text++
<p> --strikethrough--
-<p> 9.3 INDENTATION AND BULLETS
+<p> monospace
+<p> 9.3 INDENTATION AND BULLETS
<p> <b>markup example:</b>
<p>
<p> <br>
@@ -1017,7 +1030,6 @@ asterisks if required }~ continues
<p> normal text [^*3] continues
<p> normal text [^+2] continues
-<p>
<p> <b>Alternative endnote pair notation for footnotes/endnotes:</b>
<p>
<p> <br>
@@ -1030,11 +1042,11 @@ asterisks if required }~ continues
<p>9.5 LINKS
<p> 9.5.1 NAKED URLS WITHIN TEXT, DEALING WITH URLS
-<p> 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
+<p> 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).
<p> <b>markup example:</b>
<p>
@@ -1091,11 +1103,11 @@ block is used there is neither decoration nor hyperlinking, code blocks
<pre> about {~^ SiSU }http://url.org markup
</pre>
<p> <b>resulting output:</b>
-<p> aboutSiSU &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
+<p> abou tSiSU &lt;<a href='http://www.jus.uio.no/sisu/'>http://www.jus.uio.no/sisu/</a>
&gt; [^14] markup
-<p> 9.5.3
+<p>
-<p>LINKING IMAGES
+<p>9.5.3 LINKING IMAGES
<p> <b>markup example:</b>
<p>
<p> <br>
@@ -3305,23 +3317,23 @@ are authors&rsquo; works that while freely distributable are not freely changeab
<p> </dd>
<dt>Source digest: </dt>
-<dd><i>MD5(sisu.ssm.sst)=</i> fd741a3ccf160aa55b942d76bd4e3f2a
+<dd><i>SHA256(sisu.ssm.sst)=</i> a704e4b934fba753bf594990673cdd43a974d405702b78a12788ba80b5021850
<p> </dd>
<dt>Generated by: </dt>
-<dd><i>Generated</i> by: SiSU 2.0.0 of 2010w09/6 (2010-03-06)
+<dd><i>Generated</i> by: SiSU 2.6.0 of 2010w27/3 (2010-07-07)
<p> </dd>
<dt>Ruby version:
</dt>
-<dd><i>ruby</i> 1.8.7 (2010-01-10 patchlevel 249) [i486-linux]
+<dd><i>ruby</i> 1.8.7 (2010-06-23 patchlevel 299) [i486-linux]
<p> </dd>
<dt>Document (dal) last generated:
</dt>
<dd>
-<p><i>Wed</i> Mar 17 13:34:15 -0400 2010
+<p><i>Wed</i> Jul 07 09:33:25 -0400 2010
<p> </dd>
<dt>Other versions of this document: </dt>
@@ -3361,14 +3373,14 @@ are authors&rsquo; works that while freely distributable are not freely changeab
</dt>
<dd></dd>
-<dt>* Generated by: SiSU 2.0.0 of 2010w09/6 (2010-03-06) </dt>
+<dt>* Generated by: SiSU 2.6.0 of 2010w27/3 (2010-07-07) </dt>
<dd></dd>
<dt>* Ruby version: ruby 1.8.7
-(2010-01-10 patchlevel 249) [i486-linux] </dt>
+(2010-06-23 patchlevel 299) [i486-linux] </dt>
<dd></dd>
-<dt>* Last Generated on: Wed Mar 17 13:34:17
+<dt>* Last Generated on: Wed Jul 07 09:33:28
-0400 2010 </dt>
<dd></dd>