diff options
Diffstat (limited to 'data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst')
| -rw-r--r-- | data/doc/sisu/sisu_markup_samples/sisu_manual/sisu_markup.sst | 150 |
1 files changed, 90 insertions, 60 deletions
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 13faa7db..7b2aa7be 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 @@ -289,6 +289,13 @@ name of taxonomy/vocabulary/wordlist to use against document skin_doc_[name_of_desired_document_skin]<br> skins change default settings related to the appearance of documents generated, such as the urls of the home site, and the icon/logo for the document or site. +!_ @man: 8;<br> +name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search;<br> +synopsis=sisu [-abcDdFHhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ]<br> +sisu [-Ddcv] [instruction]<br> +sisu [-CcFLSVvW]<br> +the man page category number (default 1) and special tags used in preparing man page headings + !_ @links: \{ SiSU }http://www.jus.uio.no/sisu/;<br> \{ FSF }http://www.fsf.org @@ -1078,72 +1085,25 @@ r{filename} }code -% Composite documents - remote parts +:C~ Markup Syntax History -% Composite documents may be built from remote parts, by using the composite document syntax with a url. This makes sense using either sisu regular syntax (which is just a convenient way of marking up), or thlnk syntax, which also recognises remote urls, and permits hyperlinking ascii to the url location. +1~ Notes related to Files-types and Markup Syntax -% remote documents may be called with the thlnk syntax (or regular sisu syntax), e.g. +0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37 -% << <url:http://www.url.com/filename.ssi> -% -% -% .SH "DOCUMENT NAMING CONVENTION" -% .PP -% SiSU documents are named with the suffix -% .I ss -% followed by a third distinguishing letter, usually t for ordinary text files. -% .PP -% .I .sst -% is used by regular documents, and for most purposes is all you need to be aware of -% .PP -% .I .ssm -% suffix indicates a master or composite document, i.e. a document which requests other documents, which may have the file extension .sst or .ssi. See section on Composite Documents for information on how these are prepared. -% .PP -% .I .ssi -% indicates some prepared sisu markup information that is to be requested within master or composite document(s) and is not to be processed as a stand\-alone document. -% .PP -% .I ._sst -% and -% .I .\-sst -% suffix are reserved for SiSU processing, and indicate a secondary file. Such secondary files are created when a composite file is constructed, and when a url is provided, it is saved locally for processing, as a secondary processing file. Secondary files may be clobbered by SiSU at will, and are not a way of storing information. -% -% .I .sxs.xml -% simple xml sax, sisu markup representation -% -% .I .sxd.xml -% simple xml dom, sisu markup representation -% -% .I .sxn.xml -% simple xml node, sisu markup representation -% -% .I .sxs.xml.sst -% or -% .I .sxd.xml.sst -% or -% .I .sxn.xml.sst -% auto\-converted from a simple xml markup representation (sxs, sxd, sxn) -% .\" %% Remote Operations -% .SH "REMOTE OPERATIONS" -% .PP -% These may be of three basic types. -% .PP -% Instruction that processed files are to be copied to a remote server, using the \-r or \-R flag as part of the processing instruction. This requires previous setting up/configuration of the method to be used (eg scp assumed for \-r and rsync for \-R) and url to which these files are to be sent. * -% .PP -% The downloading of a remote file for processing using SiSU locally, which is achieved in one of two ways: -% .PP -% A processing instruction may include the url to the a remote file that is to be processed \- this will be downloaded and given a temporary file .t extension, and will be processed using SiSU locally. -% .PP -% A file may request the inclusion of a remote document within it, see comments on "Composite Documents" for the request syntax. -% .PP -% Finally SiSU may be run on a remote server, which you download marked up files to for processing. This is not really a function of the operation of SiSU, just an available possibility given that not much bandwidth is required. -% .PP -% * with regard to remote files processed locally, the \-r option, a limitation is that it is up to the user to ensure that the remote file does not have an identical filename to another, e.g. local file, that is to be processed in the same directory. So far this has not been found to happen in practice... Alternative solutions are under consideration, but it is desired that filenames be human assigned, and meaningful, so hash keys of contents for filenames are not amongst the options considered. +_* sisu --query=[sisu version [0.38] or 'history] -:C~ Markup Syntax History +provides a short history of changes to SiSU markup -1~ Notes related to Files-types and Markup Syntax +!_ 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:] -0.38 is substantially current, depreciated 0.16 supported, though file names were changed at 0.37 +code{ + +:A~ @title by @author + +}code !_ 0.52 (2007w14/6) @@ -1165,14 +1125,75 @@ skins changed (simplified), markup unchanged (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 @@ -1192,3 +1213,12 @@ 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{ |