diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 150 |
1 files changed, 71 insertions, 79 deletions
@@ -31,8 +31,7 @@ manifests of generated output. Book indexes may be made. Some document markup samples are provided in the package sisu -markup-samples. Homepages: -* <http://www.sisudoc.org/> -* <http://www.jus.uio.no/sisu> +- <https://www.sisudoc.org/> INSTALL OR RUN WITHOUT INSTALLATION *********************************** @@ -103,7 +102,7 @@ For a list of alternative actions you may type: rake -T -Rake: <http://rake.rubyforge.org/> <http://rubyforge.org/frs/?group_id=50> +Rake: <https://rake.rubyforge.org/> <https://rubyforge.org/frs/?group_id=50> ---------------------------------------- @@ -151,8 +150,8 @@ ruby setup.rb setup ruby setup.rb install further information: -<http://i.loveruby.net/en/projects/setup/> -<http://i.loveruby.net/en/projects/setup/doc/usage.html> +<https://i.loveruby.net/en/projects/setup/> +<https://i.loveruby.net/en/projects/setup/doc/usage.html> ruby setup.rb config && ruby setup.rb setup && sudo ruby setup.rb install @@ -179,8 +178,7 @@ adding the following to your sources list /etc/apt/sources.list #/etc/apt/sources.list -deb http://www.jus.uio.no/sisu/archive unstable main non-free -deb-src http://www.jus.uio.no/sisu/archive unstable main non-free +deb https://www.jus.uio.no/sisu/archive unstable main non-free The non-free section is for sisu markup samples provided, which contain authored works the substantive text of which cannot be changed, and which as a @@ -210,7 +208,7 @@ The package is divided into the following components: *Debian* Free Software Guidelines non-free) *SiSU* is available off Debian Unstable and Testing [link: -<http://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu>] +<https://packages.debian.org/cgi-bin/search_packages.pl?searchon=names&subword=1&version=all&release=all&keywords=sisu>] [^1] install it using apt-get, aptitude or alternative *Debian* install tools. DEPENDENCIES @@ -266,7 +264,7 @@ document, produces multiple output formats including: /plaintext/, /HTML/, /XHTML/, /XML/, /EPUB/, /ODT/ (/OpenDocument/ (/ODF/) text), /LaTeX/, /PDF/, info, and /SQL/ (/PostgreSQL/ and /SQLite/) , which share text object numbers ("object citation numbering") and the same document structure information. For -more see: <http://sisudoc.org> or <http://www.jus.uio.no/sisu> +more see: <https://sisudoc.org> or <https://git.sisudoc.org> DOCUMENT PROCESSING COMMAND FLAGS ................................. @@ -907,11 +905,11 @@ All paragraphs are separated by an empty line. Markup is comprised of: -* at the top of a document, the document header made up of semantic meta-data +- at the top of a document, the document header made up of semantic meta-data about the document and if desired additional processing instructions (such an instruction to automatically number headings from a particular level down) -* followed by the prepared substantive text of which the most important single +- followed by the prepared substantive text of which the most important single characteristic is the markup of different heading levels, which define the primary outline of the document structure. Markup of substantive text includes: @@ -973,22 +971,22 @@ text * if C~ is last used: C~ or B~; if D~ is used: D~, C~ or B~) -* level A~ is the tile and is mandatory -* there can only be one level A~ -* heading levels BCD, are optional and there may be several of each +- level A~ is the tile and is mandatory +- there can only be one level A~ +- heading levels BCD, are optional and there may be several of each (where all three are used corresponding to e.g. Book Part Section) * sublevels that are used must follow each other sequentially (alphabetically), -* heading levels A~ B~ C~ D~ are followed by other heading levels rather +- heading levels A~ B~ C~ D~ are followed by other heading levels rather than substantive text which may be the subsequent sequential (alphabetic) heading part level or a heading (segment) level 1~ -* there must be at least one heading (segment) level 1~ +- there must be at least one heading (segment) level 1~ (the level on which the text is segmented, in a book would correspond to the Chapter level) -* additional heading levels 1~ 2~ 3~ are optional and there may be several +- additional heading levels 1~ 2~ 3~ are optional and there may be several of each -* heading levels 1~ 2~ 3~ are followed by text (which may be followed by +- heading levels 1~ 2~ 3~ are followed by text (which may be followed by the same heading level) and/or the next lower numeric heading level (followed by text) or indeed return to the relevant part level @@ -1005,12 +1003,10 @@ ONLINE ...... Online markup examples are available together with the respective outputs -produced from <http://www.jus.uio.no/sisu/SiSU/examples.html> or from -<http://www.jus.uio.no/sisu/sisu_examples/> +produced from <https://git.sisudoc.org/sisu-markup> or from There is of course this document, which provides a cursory overview of sisu markup and the respective output produced: -<http://www.jus.uio.no/sisu/sisu_markup/> an alternative presentation of markup syntax: /usr/share/doc/sisu/on_markup.txt.gz @@ -1076,24 +1072,20 @@ to this one: :num_top: 1 :breaks: new=C; break=1 :bold: /Gnu|Debian|Ruby|SiSU/ - :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org - :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org + :home_button_text: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org + :footer: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org :manpage: name=sisu - documents: markup, structuring, publishing in multiple standard formats, and search; synopsis=sisu [-abcDdeFhIiMmNnopqRrSsTtUuVvwXxYyZz0-9] [filename/wildcard ] . sisu [-Ddcv] [instruction] . sisu [-CcFLSVvW] @links: - { SiSU Homepage }http://www.sisudoc.org/ - { SiSU Manual }http://www.sisudoc.org/sisu/sisu_manual/ - { Book Samples & Markup Examples }http://www.jus.uio.no/sisu/SiSU/examples.html - { SiSU Download }http://www.jus.uio.no/sisu/SiSU/download.html - { SiSU Changelog }http://www.jus.uio.no/sisu/SiSU/changelog.html - { SiSU Git repo }http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary - { SiSU List Archives }http://lists.sisudoc.org/pipermail/sisu/ - { SiSU @ Debian }http://packages.qa.debian.org/s/sisu.html - { SiSU Project @ Debian }http://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org - { SiSU @ Wikipedia }http://en.wikipedia.org/wiki/SiSU + { SiSU Homepage }https://www.sisudoc.org/ + { SiSU Manual }https://www.sisudoc.org/sisu/sisu_manual/ + { SiSU Git repo }https://git.sisudoc.org/sisu/ + { SiSU @ Debian }https://packages.qa.debian.org/s/sisu.html + { SiSU Project @ Debian }https://qa.debian.org/developer.php?login=sisu@lists.sisudoc.org + { SiSU @ Wikipedia }https://en.wikipedia.org/wiki/SiSU AVAILABLE HEADERS ................. @@ -1158,8 +1150,8 @@ This is a sample header :isbn: [ISBN] :oclc: -@links: { SiSU }http://www.sisudoc.org - { FSF }http://www.fsf.org +@links: { SiSU }https://www.sisudoc.org + { FSF }https://www.fsf.org @make: :num_top: 1 @@ -1169,8 +1161,8 @@ This is a sample header :promo: sisu, ruby, sisu_search_libre, open_society :bold: [regular expression of words/phrases to be made bold] :italics: [regular expression of words/phrases to italicise] - :home_button_text: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org - :footer: {SiSU}http://sisudoc.org; {git}http://git.sisudoc.org + :home_button_text: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org + :footer: {SiSU}https://sisudoc.org; {git}https://git.sisudoc.org @original: :language: [language] @@ -1307,7 +1299,7 @@ _2* bullet text, two step indent *resulting output:* -* bullet text +- bullet text * bullet text, first indent @@ -1439,33 +1431,33 @@ decoration is omitted). *markup example:* -normal text http://www.sisudoc.org/ continues +normal text https://www.sisudoc.org/ continues *resulting output:* -normal text <http://www.sisudoc.org/> continues +normal text <https://www.sisudoc.org/> continues An escaped url without decoration *markup example:* -normal text _http://www.sisudoc.org/ continues +normal text _https://www.sisudoc.org/ continues -deb _http://www.jus.uio.no/sisu/archive unstable main non-free +deb _https://www.jus.uio.no/sisu/archive unstable main non-free *resulting output:* -normal text http://www.sisudoc.org/ continues +normal text https://www.sisudoc.org/ continues -deb http://www.jus.uio.no/sisu/archive unstable main non-free +deb https://www.jus.uio.no/sisu/archive unstable main non-free where a code block is used there is neither decoration nor hyperlinking, code blocks are discussed later in this document *resulting output:* -deb http://www.jus.uio.no/sisu/archive unstable main non-free -deb-src http://www.jus.uio.no/sisu/archive unstable main non-free +deb https://www.jus.uio.no/sisu/archive unstable main non-free +deb-src https://www.jus.uio.no/sisu/archive unstable main non-free ---------------------------------------- @@ -1477,22 +1469,22 @@ To link text or an image to a url the markup is as follows *markup example:* -about { SiSU }http://url.org markup +about { SiSU }https://url.org markup *resulting output:* -about SiSU [link: <http://www.sisudoc.org/>] markup +about SiSU [link: <https://www.sisudoc.org/>] markup A shortcut notation is available so the url link may also be provided automatically as a footnote *markup example:* -about {~^ SiSU }http://url.org markup +about {~^ SiSU }https://url.org markup *resulting output:* -about SiSU [link: <http://www.sisudoc.org/>] [^7] markup +about SiSU [link: <https://www.sisudoc.org/>] [^7] markup Internal document links to a tagged location, including an ocn @@ -1528,24 +1520,24 @@ LINKING IMAGES [image: "a better way"] [image: "Way Better - with Gnu/Linux, Debian and Ruby"] -{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ +{~^ ruby_logo.png "Ruby" }https://www.ruby-lang.org/en/ *resulting output:* tux.png 64x80 [link: local image] -tux.png 64x80 "Gnu/Linux - a better way" [link: <http://www.sisudoc.org/>] +tux.png 64x80 "Gnu/Linux - a better way" [link: <https://www.sisudoc.org/>] GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian -and Ruby" [link: <http://www.sisudoc.org/>] +and Ruby" [link: <https://www.sisudoc.org/>] -ruby_logo.png 70x90 "Ruby" [link: <http://www.ruby-lang.org/en/>] [^8] +ruby_logo.png 70x90 "Ruby" [link: <https://www.ruby-lang.org/en/>] [^8] *linked url footnote shortcut* -{~^ [text to link] }http://url.org +{~^ [text to link] }https://url.org -% maps to: { [text to link] }http://url.org ~{ http://url.org }~ +% maps to: { [text to link] }https://url.org ~{ https://url.org }~ % which produces hyper-linked text within a document/paragraph, with an endnote providing the url for the text location used in the hyperlink @@ -1570,21 +1562,21 @@ TREE */"Viral Spiral"/, David Bollier* -"Viral Spiral", David Bollier [link: <http://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>] - document manifest [link: <http://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>] - html, segmented text [link: <http://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/viral_spiral.david_bollier.toc.html>] - html, scroll, document in one [link: <http://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier.html>] - epub [link: <http://www.sisudoc.org/sisu/en/epub/viral_spiral.david_bollier.epub>] - pdf, landscape [link: <http://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>] - pdf, portrait [link: <http://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>] - odf: odt, open document text [link: <http://www.sisudoc.org/sisu/en/odt/viral_spiral.david_bollier.odt>] - xhtml scroll [link: <http://www.sisudoc.org/sisu/en/xhtml/viral_spiral.david_bollier.xhtml>] - xml, sax [link: <http://www.sisudoc.org/sisu/en/xml_sax/viral_spiral.david_bollier.sax.xml>] - xml, dom [link: <http://www.sisudoc.org/sisu/en/xml_dom/viral_spiral.david_bollier.dom.xml>] - concordance [link: <http://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/concordance.html>] - dcc, document content certificate (digests) [link: <http://www.sisudoc.org/sisu/en/digest/viral_spiral.david_bollier.hash_digest.txt>] - markup source text [link: <http://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst>] - markup source (zipped) pod [link: <http://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst.zip>] +"Viral Spiral", David Bollier [link: <https://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>] + document manifest [link: <https://www.sisudoc.org/sisu/en/manifest/viral_spiral.david_bollier.manifest.html>] + html, segmented text [link: <https://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/viral_spiral.david_bollier.toc.html>] + html, scroll, document in one [link: <https://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier.html>] + epub [link: <https://www.sisudoc.org/sisu/en/epub/viral_spiral.david_bollier.epub>] + pdf, landscape [link: <https://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>] + pdf, portrait [link: <https://www.sisudoc.org/sisu/en/pdf/viral_spiral.david_bollier.landscape.a4.pdf>] + odf: odt, open document text [link: <https://www.sisudoc.org/sisu/en/odt/viral_spiral.david_bollier.odt>] + xhtml scroll [link: <https://www.sisudoc.org/sisu/en/xhtml/viral_spiral.david_bollier.xhtml>] + xml, sax [link: <https://www.sisudoc.org/sisu/en/xml_sax/viral_spiral.david_bollier.sax.xml>] + xml, dom [link: <https://www.sisudoc.org/sisu/en/xml_dom/viral_spiral.david_bollier.dom.xml>] + concordance [link: <https://www.sisudoc.org/sisu/en/html/viral_spiral.david_bollier/concordance.html>] + dcc, document content certificate (digests) [link: <https://www.sisudoc.org/sisu/en/digest/viral_spiral.david_bollier.hash_digest.txt>] + markup source text [link: <https://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst>] + markup source (zipped) pod [link: <https://www.sisudoc.org/sisu/en/src/viral_spiral.david_bollier.sst.zip>] GROUPED TEXT / BLOCKED TEXT ........................... @@ -1675,7 +1667,7 @@ Very active contributors*** | 0| 31| 190| 692| 1,6 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. *resulting output:* @@ -1683,7 +1675,7 @@ No. of articles, all languages | 25| 19,000| 138,000| 490,000| 862,0 ┆Jan. 2001┆Jan. 2002┆Jan. 2003┆Jan. 2004┆July 2004┆June 2006』Contributors*┆10┆472┆2,188┆9,653┆25,011┆48,721』Active contributors**┆9┆212┆846┆3,228┆8,442┆16,945』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 +- Contributed at least ten times; ** at least 5 times in last month; *** more than 100 times in last month. @@ -2133,7 +2125,7 @@ pb: Harvard University Press edn: (edition) yr: 2006 pl: U.S. -url: http://cyber.law.harvard.edu/wealth_of_networks/Main_Page +url: https://cyber.law.harvard.edu/wealth_of_networks/Main_Page note: sn: Benkler, /{Wealth of Networks}/ (2006) id: Benkler2006 @@ -2184,7 +2176,7 @@ pb: publisher edn: edition yr: year (yyyy or yyyy-mm or yyyy-mm-dd) (required) pg: pages -url: http://url +url: https://url note: note id: create_short_identifier e.g. authorSurnameYear (used in substitutions: when found within text will be @@ -2330,7 +2322,7 @@ Configure substitution in _sisu/sisu_document_make ---------------------------------------- - [1]: <http://packages.qa.debian.org/s/sisu.html> + [1]: <https://packages.qa.debian.org/s/sisu.html> [2]: from the *Debian* control file @@ -2357,13 +2349,13 @@ Configure substitution in _sisu/sisu_document_make [+2]: editors notes, numbered plus symbol footnote/endnote series - [7]: <http://www.sisudoc.org/> + [7]: <https://www.sisudoc.org/> - [8]: <http://www.ruby-lang.org/en/> + [8]: <https://www.ruby-lang.org/en/> [9]: Table from the Wealth of Networks by Yochai Benkler - <http://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler> + <https://sisudoc.org/spine/en/html/the_wealth_of_networks.yochai_benkler/toc.html> [10]: for which you may alternatively use the full form author: title: and year: |