summaryrefslogtreecommitdiffstats
path: root/data/doc/sisu/markup-samples/sisu_manual/sisu_markup_syntax_history.sst
diff options
context:
space:
mode:
Diffstat (limited to 'data/doc/sisu/markup-samples/sisu_manual/sisu_markup_syntax_history.sst')
-rw-r--r--data/doc/sisu/markup-samples/sisu_manual/sisu_markup_syntax_history.sst244
1 files changed, 244 insertions, 0 deletions
diff --git a/data/doc/sisu/markup-samples/sisu_manual/sisu_markup_syntax_history.sst b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup_syntax_history.sst
new file mode 100644
index 0000000..c6da0a1
--- /dev/null
+++ b/data/doc/sisu/markup-samples/sisu_manual/sisu_markup_syntax_history.sst
@@ -0,0 +1,244 @@
+% SiSU 4.0
+
+@title: SiSU
+ :subtitle: Markup
+
+@creator:
+ :author: Amissah, Ralph
+
+@date:
+ :created: 2002-08-28
+ :issued: 2002-08-28
+ :available: 2002-08-28
+ :published: 2008-05-22
+ :modified: 2012-10-03
+
+@rights:
+ :copyright: Copyright (C) Ralph Amissah 2007
+ :license: GPL 3 (part of SiSU documentation)
+
+@classify:
+ :topic_register: electronic documents:SiSU:document:markup;SiSU:document:markup;SiSU:document:markup;SiSU:manual:markup;electronic documents:SiSU:manual:markup
+ :subject: ebook, epublishing, electronic book, electronic publishing, electronic document, electronic citation, data structure, citation systems, search
+
+:A~? @title @creator
+
+:B~? SiSU Markup Syntax History
+
+1~syntax_history Markup Syntax History
+
+2~ Notes related to Files-types and Markup Syntax
+
+4.0 introduced additional headers and drops the use of skins replacing them with additions to the @make: header, and having a common _sisu/sisu_document_make file that uses @make: header syntax to provide a default @make: (it will parse 2.0 but igore skins, markup is otherwise the same as version 2.0 with version 3.0's minor additions)
+
+3.0 very minor additions to markup added, substantially the same as version 2.0
+
+2.0 introduced new headers and is therefore incompatible with 1.0 though otherwise the same with the addition of a couple of tags (i.e. a superset)
+
+0.38 is substantially current for version 1.0
+
+depreciated 0.16 supported, though file names were changed at 0.37
+
+_* sisu --query=[sisu version [0.38] or 'history]
+
+provides a short history of changes to SiSU markup
+
+!_ SiSU 2.0
+(2010-03-06:09/6)
+same as 1.0, apart from the changing of headers and the addition of a monospace tag related headers now grouped, e.g.
+
+code{
+
+@title:
+ :subtitle:
+
+@creator:
+ :author:
+ :translator:
+ :illustrator:
+
+@rights:
+ :text:
+ :illustrations:
+
+}code
+
+see document markup samples, and sisu --help headers
+
+the monospace tag takes the form of a hash '#'
+
+code{
+
+#{ this enclosed text would be monospaced }#
+
+}code
+
+!_ 1.0
+(2009-12-19:50/6)
+same as 0.69
+
+!_ 0.69
+(2008-09-16:37/2)
+(same as 1.0) and as previous (0.57) with the addition of book index tags
+
+code{
+
+/^={.+?}$/
+
+}code
+
+e.g. appended to a paragraph, on a new-line (without a blank line in between) logical structure produced assuming this is the first text "object"
+
+code{
+
+ ={GNU/Linux community distribution:Debian+2|Fedora|Gentoo;Free Software Foundation+5}
+
+}code
+
+code{
+
+Free Software Foundation, 1-6
+GNU/Linux community distribution, 1
+ Debian, 1-3
+ Fedora, 1
+ Gentoo,
+
+}code
+
+!_ 0.66
+(2008-02-24:07/7)
+same as previous, adds semantic tags, [experimental and not-used]
+
+code{
+
+/[:;]{.+?}[:;][a-z+]/
+
+}code
+
+!_ 0.57
+(2007w34/4)
+SiSU 0.57 is the same as 0.42 with the introduction of some a shortcut to use the headers @title and @creator in the first heading [expanded using the contents of the headers @title: and @author:]
+
+code{
+
+:A~ @title by @author
+
+}code
+
+!_ 0.52
+(2007w14/6)
+declared document type identifier at start of text/document:
+
+_1 SiSU 0.52
+
+or, backward compatible using the comment marker:
+
+_1 % SiSU 0.38
+
+variations include 'SiSU (text|master|insert) [version]' and 'sisu-[version]'
+
+!_ 0.51
+(2007w13/6)
+skins changed (simplified), markup unchanged
+
+!_ 0.42
+(2006w27/4)
+* (asterisk) type endnotes, used e.g. in relation to author
+
+SiSU 0.42 is the same as 0.38 with the introduction of some additional endnote types,
+
+Introduces some variations on endnotes, in particular the use of the asterisk
+
+code{
+
+~{* for example for describing an author }~ and ~{** for describing a second author }~
+
+}code
+
+* for example for describing an author
+
+** for describing a second author
+
+and
+
+code{
+
+~[* my note ]~ or ~[+ another note ]~
+
+}code
+
+which numerically increments an asterisk and plus respectively
+
+*1 my note
++1 another note
+
+!_ 0.38
+(2006w15/7)
+introduced new/alternative notation for headers, e.g. @title: (instead of 0\~title), and accompanying document structure markup, :A,:B,:C,1,2,3 (maps to previous 1,2,3,4,5,6)
+
+SiSU 0.38 introduced alternative experimental header and heading/structure markers,
+
+code{
+
+@headername: and headers :A~ :B~ :C~ 1~ 2~ 3~
+
+}code
+
+as the equivalent of:
+
+code{
+
+0~headername and headers 1~ 2~ 3~ 4~ 5~ 6~
+
+}code
+
+The internal document markup of SiSU 0.16 remains valid and standard Though note that SiSU 0.37 introduced a new file naming convention
+
+SiSU has in effect two sets of levels to be considered, using 0.38 notation A-C headings/levels, pre-ordinary paragraphs /pre-substantive text, and 1-3 headings/levels, levels which are followed by ordinary text. This may be conceptualised as levels A,B,C, 1,2,3, and using such letter number notation, in effect: A must exist, optional B and C may follow in sequence (not strict) 1 must exist, optional 2 and 3 may follow in sequence i.e. there are two independent heading level sequences A,B,C and 1,2,3 (using the 0.16 standard notation 1,2,3 and 4,5,6) on the positive side: the 0.38 A,B,C,1,2,3 alternative makes explicit an aspect of structuring documents in SiSU that is not otherwise obvious to the newcomer (though it appears more complicated, is more in your face and likely to be understood fairly quickly); the substantive text follows levels 1,2,3 and it is 'nice' to do most work in those levels
+
+!_ 0.37
+(2006w09/7)
+introduced new file naming convention, .sst (text), .ssm (master), .ssi (insert), markup syntax unchanged
+
+SiSU 0.37 introduced new file naming convention, using the file extensions .sst .ssm and .ssi to replace .s1 .s2 .s3 .r1 .r2 .r3 and .si
+
+this is captured by the following file 'rename' instruction:
+
+code{
+
+rename 's/\.s[123]$/\.sst/' *.s{1,2,3}
+rename 's/\.r[123]$/\.ssm/' *.r{1,2,3}
+rename 's/\.si$/\.ssi/' *.si
+
+}code
+
+The internal document markup remains unchanged, from SiSU 0.16
+
+!_ 0.35
+(2005w52/3)
+sisupod, zipped content file introduced
+
+!_ 0.23
+(2005w36/2)
+utf-8 for markup file
+
+!_ 0.22
+(2005w35/3)
+image dimensions may be omitted if rmagick is available to be relied upon
+
+!_ 0.20.4
+(2005w33/4)
+header 0~links
+
+!_ 0.16
+(2005w25/2)
+substantial changes introduced to make markup cleaner, header 0\~title type, and headings [1-6]\~ introduced, also percentage sign (%) at start of a text line as comment marker
+
+SiSU 0.16 (0.15 development branch) introduced the use of
+
+the header 0~ and headings/structure 1~ 2~ 3~ 4~ 5~ 6~
+
+in place of the 0.1 header, heading/structure notation
+
+SiSU 0.1 headers and headings structure represented by
+header 0{~ and headings/structure 1{ 2{ 3{ 4{~ 5{ 6{