aboutsummaryrefslogtreecommitdiffhomepage
path: root/data/doc/sisu/v2/sisu_markup_samples
diff options
context:
space:
mode:
authorRalph Amissah <ralph@amissah.com>2010-05-26 13:20:33 -0400
committerRalph Amissah <ralph@amissah.com>2010-05-26 13:20:33 -0400
commitfc32ec3c46258e32374fea0b4fe53c54ee0260e0 (patch)
treefce04c291fb19d7e460e500cede84de97cb9ccbb /data/doc/sisu/v2/sisu_markup_samples
parentoutput formats internal document (and relative) linking as possible (diff)
sisu documentation related mostly on markup
Diffstat (limited to 'data/doc/sisu/v2/sisu_markup_samples')
-rw-r--r--data/doc/sisu/v2/sisu_markup_samples/sisu_manual/sisu_markup.sst52
1 files changed, 40 insertions, 12 deletions
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 f69b2e02..0ab118aa 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
@@ -7,7 +7,8 @@
:author: Amissah, Ralph
@rights:
- :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3
+ :copyright: Copyright (C) Ralph Amissah 2007, part of SiSU documentation
+ :license: GPL 3 or later
@classify:
:type: information
@@ -21,7 +22,7 @@
:issued: 2002-08-28
:available: 2002-08-28
:published: 2008-05-22
- :modified: 2010-05-14
+ :modified: 2010-05-25
@make:
:num_top: 1
@@ -329,11 +330,11 @@ code{
code{
-normal text *{emphasis}* !{bold text}! /{italics}/ _{underscore}_ "{citation}" ^{superscript}^ ,{subscript}, +{inserted text}+
+normal text, *{emphasis}*, !{bold text}!, /{italics}/, _{underscore}_, "{citation}", ^{superscript}^, ,{subscript},, +{inserted text}+, -{strikethrough}-
normal text
-*{emphasis}*
+*{emphasis}* [note: can be configured to be represented by bold, italics or underscore]
!{bold text}!
@@ -355,12 +356,11 @@ _{underscore}_
!_ 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}-
normal text
-*{emphasis}*
+*{emphasis}* [note: can be configured to be represented by bold, italics or underscore]
!{bold text}!
@@ -438,7 +438,7 @@ _# numbered list numbered list indented a., b., c., d., etc.
2~ Footnotes / Endnotes
-Footnotes and endnotes not distinguished in markup. They are automatically numbered. Depending on the output file format (html, EPUB, odf, pdf etc.), the document output selected will have either footnotes or endnotes.
+Footnotes and endnotes are marked up at the location where they would be indicated within a text. They are automatically numbered. The output type determines whether footnotes or endnotes will be produced
!_ markup example:
@@ -514,7 +514,7 @@ the standard and pair notation cannot be mixed in the same document
3~ 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 is omitted).
+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:
@@ -557,6 +557,8 @@ deb-src http://www.jus.uio.no/sisu/archive unstable main non-free
}code
+3~link_text Linking Text
+
To link text or an image to a url the markup is as follows
!_ markup example:
@@ -567,8 +569,6 @@ about { SiSU }http://url.org markup
}code
-3~ Linking Text
-
!_ resulting output:
about { SiSU }http://www.jus.uio.no/sisu/ markup
@@ -587,6 +587,34 @@ about {~^ SiSU }http://url.org markup
about {~^ SiSU }http://www.jus.uio.no/sisu/ markup
+Internal document links to a tagged location, including an ocn
+
+!_ markup example:
+
+code{
+
+about { text links }#link_text
+
+}code
+
+!_ resulting output:
+
+about { text links }#link_text
+
+Shared document collection link
+
+!_ markup example:
+
+code{
+
+about { SiSU book markup examples }../SiSU/examples.html
+
+}code
+
+!_ resulting output:
+
+about { SiSU book markup examples }../SiSU/examples.html
+
3~ Linking Images
!_ markup example:
@@ -739,7 +767,7 @@ poem{
}poem
-Each verse in a poem is given a separate object number.
+Each verse in a poem is given an object number.
}code