diff options
Diffstat (limited to 'man/man1/sisu.1')
| -rw-r--r-- | man/man1/sisu.1 | 129 |
1 files changed, 63 insertions, 66 deletions
diff --git a/man/man1/sisu.1 b/man/man1/sisu.1 index 0f73191b..1d147195 100644 --- a/man/man1/sisu.1 +++ b/man/man1/sisu.1 @@ -1,6 +1,6 @@ -.TH "sisu" "1" "2007-08-30" "0.58.3" "SiSU - SiSU information Structuring Universe" +.TH "sisu" "1" "2007-08-30" "0.59.0" "SiSU" .SH -SISU \- SISU INFORMATION STRUCTURING UNIVERSE \- MANUAL \ [0.58], +SISU \- MANUAL, RALPH AMISSAH .BR @@ -377,7 +377,7 @@ Within the tarball at: .BR - ./data/doc/sisu/sisu_manual/ + \./data/doc/sisu/sisu_manual/ .SH 4.2 SISU MAN PAGES @@ -405,7 +405,7 @@ the sisu manual, the sources files for which are located within the tarball at: .BR - ./data/doc/sisu/sisu_manual/ + \./data/doc/sisu/sisu_manual/ .BR Once installed, directory equivalent to: @@ -420,7 +420,7 @@ Available man pages are converted back to html using man2html: /usr/share/doc/sisu/html/ .BR - ./data/doc/sisu/html/ + \./data/doc/sisu/html/ .BR The @@ -624,17 +624,17 @@ provides some information on setting up hyperestraier for sisu .TP .B \ \-H \ \ [filename/wildcard] -produces html without link suffixes (.html .pdf etc.) (\"Hide\"). Requires an -appropriately configured web server. \ [behaviour \ switched \ after \ 0.35 \ -see \ \-h]. +produces html without link suffixes (.html \.pdf etc.) (\"Hide\"). Requires +an appropriately configured web server. \ [behaviour \ switched \ after \ 0.35 +\ see \ \-h]. .TP .B \ \-h \ \ [filename/wildcard] produces html (with hardlinks i.e. with name suffixes in links/local urls). html, with internal document links that include the document suffix, i.e. -whether it is .html or .pdf (required for browsing directly off a file system, -and works with most web servers). \ [behaviour \ switched \ after \ 0.35 \ see -\ \-H]. +whether it is \.html or \.pdf (required for browsing directly off a file +system, and works with most web servers). \ [behaviour \ switched \ after \ +0.35 \ see \ \-H]. .TP .B \ \-I \ \ [filename/wildcard] @@ -702,7 +702,7 @@ that you have your \"keys\" and ssh agent in place. Also see \-R \ produces \ a \ sisupod \ a \ zipped \ sisu \ directory \ of \ markup \ files \ including \ sisu \ markup \ source \ files \ and \ the \ directories \ local \ configuration \ file, \ images \ and \ skins. \ Note: \ this \ only \ -includes \ the \ configuration \ files \ or \ skins \ contained \ in \ ./_sisu +includes \ the \ configuration \ files \ or \ skins \ contained \ in \ \./_sisu \ not \ those \ in \ ~/.sisu \ \-S \ \ [filename/wildcard] option. Note: (this option is tested only with zsh). @@ -710,7 +710,7 @@ option is tested only with zsh). .B \ \-S \ \ [filename/wildcard] produces a zipped file of the prepared document specified along with associated images, by default named sisupod.zip they may alternatively be named -with the filename extension .ssp This provides a quick way of gathering the +with the filename extension \.ssp This provides a quick way of gathering the relevant parts of a sisu document which can then for example be emailed. A sisupod includes sisu markup source file, (along with associated documents if a master file, or available in multilingual versions), together with related @@ -1067,7 +1067,7 @@ This current document has a header similar to this one (without the comments): .nf % SiSU 0.57 @title: SiSU - @subtitle: Markup \ [0.58] + @subtitle: Markup @creator: Ralph Amissah @rights: Copyright (C) Ralph Amissah 2007, part of SiSU documentation, License GPL 3 @type: information @@ -1080,7 +1080,7 @@ This current document has a header similar to this one (without the comments): @level: new=C; break=1; num_top=1 % comment: in this @level header num_top=1 starts automatic heading numbering at heading level 1 (numbering continues 3 levels down); the new and break instructions are used by the LaTeX/pdf and odf output to determine where to put page breaks (that are not used by html output or say sql database population). @skin: skin_sisu_manual - % skins modify the appearance of a document and are placed in a sub\-directory under ./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site\-wide. (A document is affected by a single skin) + % skins modify the appearance of a document and are placed in a sub\-directory under \./_sisu/skin ~/.sisu/skin or /etc/sisu/skin. A skin may affect single documents that request them, all documents in a directory, or be site\-wide. (A document is affected by a single skin) @bold: /Gnu|Debian|Ruby|SiSU/ @links: { SiSU Manual }http://www.jus.uio.no/sisu/sisu_manual/ { Book Samples and Markup Examples }http://www.jus.uio.no/sisu/SiSU/2.html @@ -1342,7 +1342,7 @@ free_as_in_freedom.richard_stallman_crusade_for_free_software.sam_williams.sst] 11.1 HEADING LEVELS .BR -Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ ... :A \- :C being part / section +Heading levels are :A~ ,:B~ ,:C~ ,1~ ,2~ ,3~ \... :A \- :C being part / section headings, followed by other heading levels, and 1 \-6 being headings followed by substantive text or sub\-headings. :A~ usually the title :A~? conditional level 1 heading (used where a stand\-alone document may be imported into @@ -1795,7 +1795,7 @@ information in each column Very active contributors*** | 0| 31| 190| 692| 1,639| 3,016 No. of English language articles| 25| 16,000| 101,000| 190,000| 320,000| 630,000 No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,000|1,600,000 - \* Contributed at least ten times; \** at least 5 times in last month; \*\** more than 100 times in last month. + \\* Contributed at least ten times; \\** at least 5 times in last month; \\*\** more than 100 times in last month. .fi .BR @@ -2207,17 +2207,17 @@ generated independently, or they could be markup snippets, prepared so as to be easily available to be placed within another text. If the calling document is a master document (built from other documents), it should be named with the suffix -.B .ssm +.B \.ssm Within this document you would provide information on the other documents that should be included within the text. These may be other documents that would be processed in a regular way, or markup bits prepared only for inclusion within a master document -.B .sst +.B \.sst regular markup file, or -.B .ssi +.B \.ssi (insert/information) A secondary file of the composite document is built prior to processing with the same prefix and the suffix -.B ._sst +.B \._sst .BR basic markup for importing a document into a master document @@ -2296,8 +2296,8 @@ variations include \' .BR .B 0.37 -(2006w09/7) introduced new file naming convention, .sst (text), .ssm -(master), .ssi (insert), markup syntax unchanged +(2006w09/7) introduced new file naming convention, \.sst (text), \.ssm +(master), \.ssi (insert), markup syntax unchanged .BR .B 0.35 @@ -2331,7 +2331,7 @@ start of a text line as comment marker has plaintext and binary filetypes, and can process either type of document. .SH -14.1 .SST .SSM .SSI MARKED UP PLAIN TEXT +14.1 \.SST \.SSM \.SSI MARKED UP PLAIN TEXT .BR .B SiSU @@ -2341,10 +2341,10 @@ markup. They may make reference to and contain images (for example), which are stored in the directory beneath them _sisu/image. .B SiSU plaintext markup files are of three types that may be distinguished by the -file extension used: regular text .sst; master documents, composite documents +file extension used: regular text \.sst; master documents, composite documents that incorporate other text, which can be any regular text or text insert; and inserts the contents of which are like regular text except these are marked -.ssi and are not processed. +\.ssi and are not processed. .BR .B SiSU @@ -2382,7 +2382,7 @@ Composite documents which incorporate other .B SiSU documents which may be either regular .B SiSU -text .sst which may be generated independently, or inserts prepared solely +text \.sst which may be generated independently, or inserts prepared solely for the purpose of being incorporated into one or more master documents. .BR @@ -2395,13 +2395,13 @@ manual. .BR Note: Master documents may be prepared in a similar way to regular documents, -and processing will occur normally if a .sst file is renamed .ssm without -requiring any other documents; the .ssm marker flags that the document may +and processing will occur normally if a \.sst file is renamed \.ssm without +requiring any other documents; the \.ssm marker flags that the document may contain other documents. .BR Note: a secondary file of the composite document is built prior to processing -with the same prefix and the suffix ._sst \ [^22] +with the same prefix and the suffix \._sst \ [^22] .BR <http://www.jus.uio.no/sisu/sisu_markup> @@ -2418,11 +2418,11 @@ into one or more master documents. They resemble regular .B SiSU text files except they are ignored by the .B SiSU -processor. Making a file a .ssi file is a quick and convenient way of +processor. Making a file a \.ssi file is a quick and convenient way of flagging that it is not intended that the file should be processed on its own. .SH -14.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, .SSP) +14.2 SISUPOD, ZIPPED BINARY CONTAINER (SISUPOD.ZIP, \.SSP) .BR A sisupod is a zipped @@ -2625,7 +2625,7 @@ resource configuration is determined by looking at the following files if they exist: .BR - ./_sisu/sisurc.yml + \./_sisu/sisurc.yml .BR ~/.sisu/sisurc.yml @@ -2658,7 +2658,7 @@ Skins modify the default appearance of document output on a document, directory, or site wide basis. Skins are looked for in the following locations: .BR - ./_sisu/skin + \./_sisu/skin .BR ~/.sisu/skin @@ -2671,13 +2671,13 @@ directory, or site wide basis. Skins are looked for in the following locations: are the following the default sub\-directories for document skins: .BR - ./skin/doc + \./skin/doc .BR - ./skin/dir + \./skin/dir .BR - ./skin/site + \./skin/site .BR A skin is placed in the appropriate directory and the file named skin_[name].rb @@ -2751,9 +2751,9 @@ list) may be found in: .BR CSS files to modify the appearance of .B SiSU -html, XHTML or XML may be placed in the configuration directory: ./_sisu/css; -~/.sisu/css or; /etc/sisu/css and these will be copied to the output -directories with the command sisu \-CC. +html, XHTML or XML may be placed in the configuration directory: +\./_sisu/css; ~/.sisu/css or; /etc/sisu/css and these will be copied to the +output directories with the command sisu \-CC. .BR The basic CSS file for html output is html.css, placing a file of that name in @@ -2795,7 +2795,7 @@ under the output directory root and the output for all documents contained in the directory of a particular name will be generated to subdirectories beneath that directory (poem or conventions). A document will be placed in a subdirectory of the same name as the document with the filetype identifier -stripped (.sst .ssm) +stripped (.sst \.ssm) .BR The last part of a directory path, representing the sub\-directory in which a @@ -2850,7 +2850,7 @@ directory structure and organisation of content. .BR Custom built pages, including the home page index.html may be placed within the configuration directory _sisu/home/ in any of the locations that is searched -for the configuration directory, namely ./_sisu; ~/_sisu; /etc/sisu From there +for the configuration directory, namely \./_sisu; ~/_sisu; /etc/sisu From there they are copied to the root of the output directory with the command: .BR @@ -3352,7 +3352,7 @@ rune along the following lines: .BR find /home/ralph/sisu_www \-type f | egrep \'/home/ralph/sisu_www/([specify \ first \ directory \ for \ inclusion]|[specify \ second \ directory \ for \ - inclusion]|[another \ directory \ for \ inclusion? \ ...])/.+?.html$\' | + inclusion]|[another \ directory \ for \ inclusion? \ \...])/.+?.html$\' | egrep \-v \'(doc|concordance).html$\' |estcmd gather \-sd /home/ralph/sisu_www/casket \- @@ -3498,11 +3498,11 @@ processing instructions can be run against remote source documents by providing the url of the documents against which the processing instructions are to be carried out. The remote .B SiSU -documents can either be sisu marked up files in plaintext .sst or .ssm or; +documents can either be sisu marked up files in plaintext \.sst or \.ssm or; zipped sisu files, sisupod.zip or filename.ssp .BR -.B .sst / .ssm \- sisu text files +.B \.sst / \.ssm \- sisu text files .BR .B SiSU @@ -3512,7 +3512,7 @@ processing instruction and the url. The source file and any associated parts .nf - sisu \-3 http://[provide \ url \ to \ valid \ .sst \ or \ .ssm \ file] + sisu \-3 http://[provide \ url \ to \ valid \ \.sst \ or \ \.ssm \ file] .fi .BR @@ -3524,7 +3524,7 @@ document. NOTE: to set up a remote machine to serve .B SiSU documents in this way, images should be in the directory relative to the -document source ../_sisu/image +document source \../_sisu/image .BR .B sisupod \- zipped sisu files @@ -3541,7 +3541,7 @@ documents it contains generated locally. .nf - sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ .ssp \ file] + sisu \-3 http://[provide \ url \ to \ valid \ sisupod.zip \ or \ \.ssp \ file] .fi .BR @@ -3988,7 +3988,7 @@ home site. The directory: .BR - ./data/sisu/conf/editor\-syntax\-etc/ + \./data/sisu/conf/editor\-syntax\-etc/ .BR /usr/share/sisu/conf/editor\-syntax\-etc @@ -4780,7 +4780,7 @@ Document Manifest @ .BR DC Title: -.I SiSU \- SiSU information Structuring Universe \- Manual \ [0.58] +.I SiSU \- Manual .BR DC Creator: @@ -4828,7 +4828,7 @@ Filetype: .BR Sourcefile Digest, MD5(sisu._sst)= -.I 850b4b4b2da877667488ddfa325b6581 +.I 4c33c586109800b635ffe667a0cf217f .BR Skin_Digest: @@ -4840,13 +4840,13 @@ MD5(/home/ralph/grotto/theatre/dbld/sisu\-dev/sisu/data/doc/sisu/sisu_markup_sam .BR Document (metaverse) last generated: -.I Sun Sep 23 01:13:56 +0100 2007 +.I Mon Sep 24 15:36:12 +0100 2007 .BR Generated by: .I SiSU -.I 0.58.3 -of 2007w36/4 (2007\-09\-06) +.I 0.59.0 +of 2007w38/0 (2007\-09\-23) .BR Ruby version: @@ -4854,8 +4854,7 @@ Ruby version: .TP .BI 1. -\" -.B SiSU +\" \.B SiSU information Structuring Universe\" or \"Structured information, Serialized Units\". also chosen for the meaning of the Finnish term "sisu". @@ -4957,14 +4956,14 @@ Table from the Wealth of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler> .TP .BI 22. -.ssc (for composite) is under consideration but ._sst makes clear that this +\.ssc (for composite) is under consideration but \._sst makes clear that this is not a regular file to be worked on, and thus less likely that people will -have \"accidents\", working on a .ssc file that is overwritten by subsequent -processing. It may be however that when the resulting file is shared .ssc is an +have \"accidents\", working on a \.ssc file that is overwritten by subsequent +processing. It may be however that when the resulting file is shared \.ssc is an appropriate suffix to use. .TP .BI 23. -.B SiSU +\.B SiSU has worked this way in the past, though this was dropped as it was thought the complexity outweighed the flexibility, however, the balance was rather fine and this behaviour could be reinstated. @@ -5007,10 +5006,8 @@ There is nothing to stop MySQL support being added in future. <http://www.jus.uio.no/sisu/man> .TP .BI 33. -the -.B Debian -Free Software guidelines require that everything distributed within -.B Debian +the \.B Debian +Free Software guidelines require that everything distributed within \.B Debian can be changed - and the documents are authors\' works that while freely distributable are not freely changeable. .TP @@ -5033,10 +5030,10 @@ pdf: <http://www.jus.uio.no/sisu/sisu/landscape.pdf> at: <http://www.jus.uio.no/sisu> .TP .TP -* Generated by: SiSU 0.58.3 of 2007w36/4 (2007-09-06) +* Generated by: SiSU 0.59.0 of 2007w38/0 (2007-09-23) .TP * Ruby version: ruby 1.8.6 (2007-06-07 patchlevel 36) [i486-linux] .TP -* Last Generated on: Sun Sep 23 01:14:04 +0100 2007 +* Last Generated on: Mon Sep 24 15:36:29 +0100 2007 .TP * SiSU http://www.jus.uio.no/sisu |