From 3c0b56d9b72b3fbc1a482b1da1dcca23b5676a24 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Tue, 26 Jul 2011 20:37:49 -0400 Subject: v2 v3: manpage html (man2html) * commands: --qrcode -Q; update shortcut options * markup.sst: indent update; publisher --- data/doc/sisu/CHANGELOG_v3 | 2 +- data/doc/sisu/html/sisu.1.html | 515 +++++++++++++++++++++++------------------ 2 files changed, 290 insertions(+), 227 deletions(-) diff --git a/data/doc/sisu/CHANGELOG_v3 b/data/doc/sisu/CHANGELOG_v3 index a27a7070..7978dc09 100644 --- a/data/doc/sisu/CHANGELOG_v3 +++ b/data/doc/sisu/CHANGELOG_v3 @@ -43,7 +43,7 @@ http://www.jus.uio.no/sisu/pkg/src/sisu_3.0.14.orig.tar.gz * sql db, constants, cgi-sql, structure changed, creator editor field added - * sisu_manual, manpage + * sisu_manual, manpage, manpage html (man2html) * sisu_commands: --qrcode -Q; update shortcut options; line-breaks use \\ * sisu_markup.sst: indent update; publisher diff --git a/data/doc/sisu/html/sisu.1.html b/data/doc/sisu/html/sisu.1.html index fb74b10d..33529bfc 100644 --- a/data/doc/sisu/html/sisu.1.html +++ b/data/doc/sisu/html/sisu.1.html @@ -179,39 +179,39 @@ and the same document structure information. For more see: <9.4 Footnotes / Endnotes +

9.4 Hanging Indents

+ +


+markup example: +


+

  _0_1 first line no indent,
+  rest of paragraph indented one step
+  _1_0 first line indented,
+  rest of paragraph no indent
+  in each case level may be 0-9
+
+


+resulting output: +


+ first line no indent, rest of paragraph indented one step
+ +


+first line indented, rest of paragraph no indent +


+ +

in each case level may be 0-9 +

+

9.5 Footnotes / Endnotes


Footnotes and endnotes are marked up at the location where they would be @@ -1428,11 +1454,11 @@ normal text [^+2] continues

the standard and pair notation cannot be mixed in the same document

-

9.5 +

9.6 Links

-

9.5.1 Naked Urls Within Text, Dealing with Urls

+

9.6.1 Naked Urls Within Text, Dealing with Urls


urls found within text are marked up automatically. A url within text is @@ -1479,7 +1505,7 @@ where a code block is used there is neither decoration nor hyperlinking, deb-src http://www.jus.uio.no/sisu/archive unstable main non-free

-

9.5.2 Linking Text

+

9.6.2 Linking Text


@@ -1509,9 +1535,6 @@ aboutSiSU <http://www.sisudoc.org/


about SiSU <http://www.sisudoc.org/ > [^14] markup -

-

9.5.3 Linking Images

-


markup example:


@@ -1561,10 +1584,10 @@ note at a heading level the same is automatically achieved by providing names to headings 1, 2 and 3 i.e. 2~[name] and 3~[name] or in the case of auto-heading numbering, without further intervention.

-

9.6 Grouped Text

+

9.7 Grouped Text

-

9.6.1 +

9.7.1 Tables


@@ -1609,7 +1632,7 @@ Tables

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. +\*\** more than 100 times in last month.


resulting output: @@ -1622,7 +1645,7 @@ Tables * Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month.

-

9.6.2 Poem

+

9.7.2 Poem


basic markup: @@ -1774,7 +1797,7 @@ more than 100 times in last month.

-

9.6.3 Group

+

9.7.3 Group


basic markup: @@ -1930,7 +1953,7 @@ more than 100 times in last month.

-

9.6.4 Code

+

9.7.4 Code


Code tags code{ ... }code (used as with other group tags described above) @@ -2040,11 +2063,11 @@ opening code tag code{# as demonstrated here: 44 | death."’

-

9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

+

9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks

-

9.7.1 Line-breaks

+

9.8.1 Line-breaks


To break a line within a "paragraph object", two backslashes \\ with a space @@ -2060,7 +2083,7 @@ The html break br enclosed in angle brackets (though undocumented) is available in versions prior to 3.0.13 and 2.9.7 (it remains available for the time being, but is depreciated).

-

9.7.2 Page Breaks

+

9.8.2 Page Breaks


Page breaks are only relevant and honored in some output formats. A page @@ -2081,7 +2104,7 @@ page new <:pn> breaks the page, starts a new page. page break <:pb> breaks a column, starts a new column, if using columns, else breaks the page, starts a new page.

-

9.8 Book Index

+

9.9 Book Index


To make an index append to paragraph the book index term relates to it, @@ -2337,9 +2360,9 @@ text follows levels 1,2,3 and it is ’nice’ to do most work in those


this is captured by the following file ’rename’ instruction:


-

  rename ’s/.s[123]$/.sst/’ *.s{1,2,3}
-  rename ’s/.r[123]$/.ssm/’ *.r{1,2,3}
-  rename ’s/.si$/.ssi/’ *.si
+
  rename ’s/\.s[123]$/\.sst/’ *.s{1,2,3}
+  rename ’s/\.r[123]$/\.ssm/’ *.r{1,2,3}
+  rename ’s/\.si$/\.ssi/’ *.si
 

 
 

 The internal document markup remains unchanged, from SiSU 0.16
@@ -2398,7 +2421,7 @@ be located locally or on a remote server for which a url is provided.
 
12.1.1 Sisu Text - Regular Files (.sst)

 
 
 

-The most common form of document in SiSU , see the section on SiSU markup.
+The most common form of document in SiSU, see the section on SiSU markup.
 
 
 

 <http://www.sisudoc.org/sisu/sisu_markup
@@ -2716,7 +2739,7 @@ list) may be found in:
 
 
 

 CSS files to modify the appearance of SiSU html, XHTML or XML may be placed
-in the configuration directory: ./_sisu/css ; ~/.sisu/css or; /etc/sisu/css
+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.
 
 

@@ -2889,8 +2912,9 @@ streamed to four tables:
 
 
 

   * another the substantive texts by individual "paragraph" (or object)
-- along

-   with structural information, each paragraph being identifiable by its

+-

+   along with structural information, each paragraph being identifiable
+by its

    paragraph number (if it has one which almost all of them do), and the

    substantive text of each paragraph quite naturally being searchable
 (both in

@@ -2918,14 +2942,15 @@ so as to facilitate ease of searching.
 
 

 Being able to search a relational database at an object level with the
 SiSU citation system is an effective way of locating content generated
-by SiSU  object numbers, and all versions of the document have the same
-numbering, complex searches can be tailored to return just the locations
-of the search results relevant for all available output formats, with live
-links to the precise locations in the database or in html/xml documents;
-or, the structural information provided makes it possible to search the
-full contents of the database and have headings in which search content
-appears, or to search only headings etc. (as the Dublin Core is incorporated
-it is easy to make use of that as well).
+by SiSU. As individual text objects of a document stored (and indexed) together
+with object numbers, and all versions of the document have the same numbering,
+complex searches can be tailored to return just the locations of the search
+results relevant for all available output formats, with live links to the
+precise locations in the database or in html/xml documents; or, the structural
+information provided makes it possible to search the full contents of the
+database and have headings in which search content appears, or to search
+only headings etc. (as the Dublin Core is incorporated it is easy to make
+use of that as well).
 

 
22. Postgresql

 

@@ -3050,7 +3075,8 @@ for SiSU to populate an sqlite database, this being part of SiSU -
   sisu -d [instruction] [filename/wildcard  if  required]

 
 
 

-  sisu -d --(sqlite|pg) --[instruction] [filename/wildcard  if  required]

+  sisu -d --(sqlite|pg) --[instruction] [filename/wildcard  if 

+   required]

 
 

 
23.4 Commands

@@ -3890,8 +3916,9 @@ the

 
 

 NOTE:
 
 

-[  .B  SiSU  parses  files  with  long  lines  or  line  breaks,  display  linewrap
- (without  line-breaks)  is  a  convenient
+[  .B  SiSU  parses  files  with  long  lines  or  line  breaks, but,  display  linewrap
+ (without  line-breaks)  is  a  convenient editor  feature  to  have  for  sisu  markup]
+
 

 
31. How Does Sisu Work?

 

@@ -3937,8 +3964,8 @@ beyond the Dublin core and easily further extended as required); the headers
 may also contain processing instructions. SiSU markup is primarily an abstraction
 of document structure and document metadata to permit taking advantage
 of the basic strengths of existing alternative practical standard ways
-of representing documents [be  that  paper  publication,  sql  search  etc.] (html,
-epub, xml, odf, latex, pdf, sql)
+of representing documents [be  that  browser viewing,  paper  publication,
+ sql  search  etc.] (html, epub, xml, odf, latex, pdf, sql)
 
 

 * for output produces reasonably elegant output of established industry
 and institutionally accepted open standard formats.[3] takes advantage of
@@ -3969,8 +3996,7 @@ as

 
 
 

   * sql - population of an sql database, (at the same object level that
-is used

-   to cite text within a document)

+is used to cite text within a document)

 
 
 

 Also produces: concordance files; document content certificates (md5 or
@@ -4029,7 +4055,7 @@ and images and sent as a zip file called a sisupod, if shared on the net
 * generated document outputs may automatically be posted to remote sites.
 
 
 

-* for basic document generation, the only software dependency is Ruby ,
+* for basic document generation, the only software dependency is Ruby,
 and a few standard Unix tools (this covers plaintext, HTML, EPUB, XML,
 ODF, LaTeX). To use a database you of course need that, and to convert the
 LaTeX generated to pdf, a latex processor like tetex or texlive.
@@ -4191,108 +4217,143 @@ may be also be accessed via the html pages[^29]
   <http://www.jus.uio.no/sisu/man/sisu_webrick.1.html
 >

 
-
 1. objects include: headings, paragraphs, verse, tables, images, but not
+

+
    
+.
  1. objects include: headings, paragraphs, verse, tables, images, but not
 footnotes/endnotes which are numbered separately and tied to the object
 from which they are referenced.
 
     
    
-2. i.e. the html, pdf, epub, odf outputs are each built individually and optimised
+
    2. .
  2. i.e. the html, pdf, epub, odf outputs are each built individually and optimised
 for that form of presentation, rather than for example the html being a
 saved version of the odf, or the pdf being a saved version of the html.
 
 
     
    
-3. the different heading levels
+
    3. .
  3. 
+
    the different heading levels
 
     
    
-4. units of text, primarily paragraphs and headings, also any tables, poems,
+
    4. .
  4. units of text, primarily paragraphs and headings, also any tables, poems,
 
 
    code-blocks
 
     
    
-5. Specification submitted by Adobe to ISO to become a full open ISO specification
+
    5. .
  5. 
+
    Specification submitted by Adobe to ISO to become a full open ISO specification
+
+
     
    
 <http://www.linux-watch.com/news/NS7542722606.html
 >
 
     
    
-6. ISO standard ISO/IEC 26300:2006
+
    6. .
  6. 
+
    ISO standard ISO/IEC 26300:2006
 
     
    
-7. An open standard format for e-books
+
    7. .
  7. 
+
    An open standard format for e-books
 
     
    
-*1. square brackets
+
+
+
    *1. 
    
+
    square brackets
 
     
    
-*2. square brackets
+
    
+
+
    *2. 
    
+
    square brackets
 
     
    
-+1. square brackets
+
    
+
+
    +1. 
    
+
    square brackets
 
     
    
-8. <http://www.jus.uio.no/sisu/man/
+
    8. .
  8. <http://www.jus.uio.no/sisu/man/
 >
 
     
    
-9. <http://www.jus.uio.no/sisu/man/sisu.1.html
+
    9. .
  9. <http://www.jus.uio.no/sisu/man/sisu.1.html
 >
 
     
    
-10. From sometime after SiSU 0.58 it should be possible to describe SiSU
-markup using SiSU, which though not an original design goal is useful.
-
    
-
    
-11. files should be prepared using UTF-8 character encoding
+
    10. .
  10. From sometime after SiSU 0.58 it should be possible to describe SiSU markup
+using SiSU, which though not an original design goal is useful.
 
     
    
-12. a footnote or endnote
+
    11. .
  11. 
+
    files should be prepared using UTF-8 character encoding
 
     
    
-13. self contained endnote marker & endnote in one
+
    12. .
  12. 
+
    a footnote or endnote
 
     
    
-* unnumbered asterisk footnote/endnote, insert multiple asterisks if required
+
    13. .
  13. self contained endnote marker & endnote in one
+
     
    
+
+
+
    *. 
    
+
    unnumbered asterisk footnote/endnote, insert multiple asterisks if required
 
 
     
    
-** another unnumbered asterisk footnote/endnote
+
    
+
+
    **. 
    
+
    another unnumbered asterisk footnote/endnote
 
     
    
-*3. editors notes, numbered asterisk footnote/endnote series
+
    
+
+
    *3. 
    
+
    editors notes, numbered asterisk footnote/endnote series
 
     
    
-+2. editors notes, numbered asterisk footnote/endnote series
+
    
+
+
    +2. 
    
+
    editors notes, numbered asterisk footnote/endnote series
 
     
    
-14 <http://www.sisudoc.org/
+
    14. .
  14. <http://www.sisudoc.org/
 >
 
     
    
-15. <http://www.ruby-lang.org/en/
+
    15. .
  15. <http://www.ruby-lang.org/en/
 >
 
     
    
-16. Table from the Wealth of Networks by Yochai Benkler <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler
+
    16. .
  16. 
+
    Table from the Wealth of Networks by Yochai Benkler
+
     
    
+<http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler
 >
-
 
     
    
-17. .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 subsequent processing. It may be however that when the resulting
-file is shared
+
    17. .
  17. .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 appropriate suffix to use.
+
     
    
+
    18. .
  18. <http://www.postgresql.org/
+>
 
     
    
-19. <http://www.postgresql.org/
-> 
    
 <http://advocacy.postgresql.org/
 > 
    
 <http://en.wikipedia.org/wiki/Postgresql
 > 
    
-20. <http://www.hwaci.com/sw/sqlite/
-> 
    
+
    19. .
  19. <http://www.hwaci.com/sw/sqlite/
+>
+
     
    
 <http://en.wikipedia.org/wiki/Sqlite
 > 
    
-21. <http://search.sisudoc.org
+
    20. .
  20. <http://search.sisudoc.org
 >
 
     
    
-22. (which could be extended further with current back-end). As regards scaling
+
    21. .
  21. (which could be extended further with current back-end). As regards scaling
 of the database, it is as scalable as the database (here Postgresql) and
 hardware allow.
 
     
    
-23. of this feature when demonstrated to an IBM software innovations evaluator
+
    22. .
  22. of this feature when demonstrated to an IBM software innovations evaluator
 in 2004 he said to paraphrase: this could be of interest to us. We have
 large document management systems, you can search hundreds of thousands
 of documents and we can tell you which documents meet your search criteria,
 but there is no way we can tell you without opening each document where
 within each your matches are found.
 
     
    
-24. There is nothing to stop MySQL support being added in future.
+
    23. .
  23. There is nothing to stop MySQL support being added in future.
 
     
    
-25. <http://www.jus.uio.no/sisu/man/sisu.1.html
+
    24. .
  24. <http://www.jus.uio.no/sisu/man/sisu.1.html
 >
 
     
    
-26. <http://www.jus.uio.no/sisu/man/sisu.8.html
+
    25. .
  25. <http://www.jus.uio.no/sisu/man/sisu.8.html
 >
 
     
    
-27. <http://www.jus.uio.no/sisu/man
+
    26. .
  26. <http://www.jus.uio.no/sisu/man
 >
 
     
    
 28. the Debian Free Software guidelines require that everything distributed
@@ -4301,7 +4362,9 @@ while freely distributable are not freely changeable.
 
     
    
 29. named index.html or more extensively through sisu_manifest.html 
    
 
-
    
+
     
    27. 
+

+
 
See Also

 

 sisu(1)
@@ -4366,20 +4429,20 @@ More information about SiSU can be found at <9.1 Heading Levels
 
  • 9.2 Font Attributes
    • 
 
  • 9.3 Indentation and Bullets
    • 
-
  • 9.4 Footnotes / Endnotes
    • 
-
  • 9.5 Links
    • 
-
  • 9.5.1 Naked Urls Within Text, Dealing with Urls
    • 
-
  • 9.5.2 Linking Text
    • 
-
  • 9.5.3 Linking Images
    • 
-
  • 9.6 Grouped Text
    • 
-
  • 9.6.1 Tables
    • 
-
  • 9.6.2 Poem
    • 
-
  • 9.6.3 Group
    • 
-
  • 9.6.4 Code
    • 
-
  • 9.7 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks
    • 
-
  • 9.7.1 Line-breaks
    • 
-
  • 9.7.2 Page Breaks
    • 
-
  • 9.8 Book Index
    • 
+
  • 9.4 Hanging Indents
    • 
+
  • 9.5 Footnotes / Endnotes
    • 
+
  • 9.6 Links
    • 
+
  • 9.6.1 Naked Urls Within Text, Dealing with Urls
    • 
+
  • 9.6.2 Linking Text
    • 
+
  • 9.7 Grouped Text
    • 
+
  • 9.7.1 Tables
    • 
+
  • 9.7.2 Poem
    • 
+
  • 9.7.3 Group
    • 
+
  • 9.7.4 Code
    • 
+
  • 9.8 Additional Breaks - Linebreaks Within Objects, Column and Page-breaks
    • 
+
  • 9.8.1 Line-breaks
    • 
+
  • 9.8.2 Page Breaks
    • 
+
  • 9.9 Book Index
    • 
 
  • 10. Composite Documents Markup
    • 
 
  • Markup Syntax History
    • 
 
  • 11. Notes Related to Files-types and Markup Syntax
    • 
-- 
cgit v1.2.3