From 5588bc15c6df5eb225c315ed82e2a8239ef26d36 Mon Sep 17 00:00:00 2001 From: Ralph Amissah Date: Sun, 4 Apr 2021 21:57:11 -0400 Subject: headers: copyright, license, year; also https --- doc/man/man1/spine.1 | 174 ++++++++++++++++++++------------------------------- 1 file changed, 68 insertions(+), 106 deletions(-) (limited to 'doc') diff --git a/doc/man/man1/spine.1 b/doc/man/man1/spine.1 index 255119a..723d14a 100644 --- a/doc/man/man1/spine.1 +++ b/doc/man/man1/spine.1 @@ -73,9 +73,8 @@ generated output. Book indexes may be made. Some document markup samples are provided in the package sisu -markup-samples. Homepages: -- - -- +- +- .SH COMMANDS SUMMARY @@ -106,8 +105,8 @@ info, and and .I SQLite ) , which share text object numbers ("object citation numbering") and the same -document structure information. For more see: or - +document structure information. For more see: or + .SH DOCUMENT PROCESSING COMMAND FLAGS .TP @@ -590,7 +589,7 @@ The most up to date information on sisu should be contained in the sisu_manual, available at: .BR - + .BR The manual can be generated from source, found respectively, either within the @@ -644,21 +643,6 @@ Available man pages are converted back to html using man2html: .BR ./data/doc/sisu/html - -.BR -An online version of the sisu man page is available here: - -.BR - -- various sisu man pages [^1] - -.BR -- sisu.1 [^2] -.SH SISU BUILT-IN INTERACTIVE HELP, [DISCONTINUED] - - -.BR -This fell out of date and has been discontinued. .SH INTRODUCTION TO SISU MARKUP[^3] .SH SUMMARY @@ -786,24 +770,11 @@ text * .SH MARKUP EXAMPLES -.SH ONLINE - - .BR -Online markup examples are available together with the respective outputs -produced from or from - +check at: .BR -There is of course this document, which provides a cursory overview of sisu -markup and the respective output produced: - - -.BR -an alternative presentation of markup syntax: -/usr/share/doc/sisu/on_markup.txt.gz -.SH INSTALLED - + .BR With @@ -865,24 +836,18 @@ make: 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/projects/?p=software/spine.git;a=summary + { SiSU @ Wikipedia }https://en.wikipedia.org/wiki/SiSU .fi .SH AVAILABLE HEADERS @@ -972,8 +937,8 @@ identify: .fi .nf -links: { SiSU }http://www.sisudoc.org - { FSF }http://www.fsf.org +links: { SiSU }https://www.sisudoc.org + { FSF }https://www.fsf.org .fi .nf @@ -985,8 +950,8 @@ make: 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 .fi .nf @@ -1378,7 +1343,7 @@ decoration is omitted). .B markup example: .nf -normal text http://www.sisudoc.org/ continues +normal text https://www.sisudoc.org/ continues .fi @@ -1387,7 +1352,7 @@ normal text http://www.sisudoc.org/ continues .B resulting output: .BR -normal text continues +normal text continues .BR An escaped url without decoration @@ -1396,9 +1361,8 @@ An escaped url without decoration .B markup example: .nf -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 .fi @@ -1407,10 +1371,8 @@ deb _http://www.jus.uio.no/sisu/archive unstable main non-free .B resulting output: .BR -normal text <_http://www.sisudoc.org/> continues +normal text <_https://www.sisudoc.org/> continues -.BR -deb <_http://www.jus.uio.no/sisu/archive> unstable main non-free .BR where a code block is used there is neither decoration nor hyperlinking, code @@ -1420,8 +1382,8 @@ blocks are discussed later in this document .B resulting output: .nf -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 .fi .SH LINKING TEXT @@ -1434,7 +1396,7 @@ To link text or an image to a url the markup is as follows .B markup example: .nf -about { SiSU }http://url.org markup +about { SiSU }https://url.org markup .fi @@ -1443,7 +1405,7 @@ about { SiSU }http://url.org markup .B resulting output: .BR -aboutSiSU markup +aboutSiSU markup .BR A shortcut notation is available so the url link may also be provided @@ -1453,7 +1415,7 @@ automatically as a footnote .B markup example: .nf -about {~^ SiSU }http://url.org markup +about {~^ SiSU }https://url.org markup .fi @@ -1462,7 +1424,7 @@ about {~^ SiSU }http://url.org markup .B resulting output: .BR -aboutSiSU [^7] markup +aboutSiSU [^7] markup .BR Internal document links to a tagged location, including an ocn @@ -1512,11 +1474,11 @@ book markup examples⌡⌈:SiSU/examples.html⌋ % various url linked images -{tux.png 64x80 "a better way" }http://www.sisudoc.org/ +{tux.png 64x80 "a better way" }https://www.sisudoc.org/ -{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }http://www.sisudoc.org/ +{GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian and Ruby" }https://www.sisudoc.org/ -{~^ ruby_logo.png "Ruby" }http://www.ruby-lang.org/en/ +{~^ ruby_logo.png "Ruby" }https://www.ruby-lang.org/en/ .fi @@ -1528,22 +1490,22 @@ book markup examples⌡⌈:SiSU/examples.html⌋ [ tux.png ] .BR -tux.png 64x80 "Gnu/Linux - a better way" +tux.png 64x80 "Gnu/Linux - a better way" .BR GnuDebianLinuxRubyBetterWay.png 100x101 "Way Better - with Gnu/Linux, Debian -and Ruby" +and Ruby" .BR -ruby_logo.png 70x90 "Ruby" [^8] +ruby_logo.png 70x90 "Ruby" [^8] .BR .B linked url footnote shortcut .nf -{~^ [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 .fi @@ -1576,21 +1538,21 @@ TREE .B .I "Viral Spiral", David Bollier -"Viral Spiral", David Bollier - document manifest - ⌠html, segmented text⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 - ⌠html, scroll, document in one⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 - ⌠epub⌡「http://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」 - ⌠pdf, landscape⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 - ⌠pdf, portrait⌡「http://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 - ⌠odf: odt, open document text⌡「http://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」 - ⌠xhtml scroll⌡「http://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」 - ⌠xml, sax⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 - ⌠xml, dom⌡「http://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 - ⌠concordance⌡「http://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 - ⌠dcc, document content certificate (digests)⌡「http://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」 - ⌠markup source text⌡「http://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」 - ⌠markup source (zipped) pod⌡「http://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」 +"Viral Spiral", David Bollier + document manifest + ⌠html, segmented text⌡「https://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 + ⌠html, scroll, document in one⌡「https://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 + ⌠epub⌡「https://corundum/sisu_manual/en/epub/viral_spiral.david_bollier.epub」 + ⌠pdf, landscape⌡「https://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 + ⌠pdf, portrait⌡「https://corundum/sisu_manual/en/pdf/viral_spiral.david_bollier.pdf」 + ⌠odf: odt, open document text⌡「https://corundum/sisu_manual/en/odt/viral_spiral.david_bollier.odt」 + ⌠xhtml scroll⌡「https://corundum/sisu_manual/en/xhtml/viral_spiral.david_bollier.xhtml」 + ⌠xml, sax⌡「https://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 + ⌠xml, dom⌡「https://corundum/sisu_manual/en/xml/viral_spiral.david_bollier.xml」 + ⌠concordance⌡「https://corundum/sisu_manual/en/html/viral_spiral.david_bollier.html」 + ⌠dcc, document content certificate (digests)⌡「https://corundum/sisu_manual/en/digest/viral_spiral.david_bollier.txt」 + ⌠markup source text⌡「https://corundum/sisu_manual/en/src/viral_spiral.david_bollier.sst」 + ⌠markup source (zipped) pod⌡「https://corundum/sisu_manual/en/pod/viral_spiral.david_bollier.sst.zip」 .SH GROUPED TEXT / BLOCKED TEXT @@ -2187,7 +2149,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 @@ -2250,7 +2212,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 @@ -2577,10 +2539,10 @@ processing can be done directly against a sisupod; which may be located locally or on a remote server for which a url is provided. .BR - + .BR - + .SH CONFIGURATION .SH CONFIGURATION FILES @@ -3026,8 +2988,8 @@ there they are copied to the root of the output directory with the command: .BR Current markup examples and document output samples are provided off - or and in the sisu --markup-sample package available off + or and in the sisu +-markup-sample package available off .BR For some documents hardly any markup at all is required at all, other than a @@ -3598,7 +3560,7 @@ INCLUDING OBJECT CITATION NUMBERING (BACKEND CURRENTLY POSTGRESQL) .BR -Sample search frontend [^15] A small database and +Sample search frontend [^15] A small database and sample query front-end (search from) that makes use of the citation system, .I object citation numbering to demonstrates functionality.[^16] @@ -3949,12 +3911,12 @@ square brackets .BR .TP .BI 1. - + .BR .TP .BI 2. - + .BR .TP @@ -4000,18 +3962,18 @@ editors notes, numbered plus symbol footnote/endnote series .BR .TP .BI 7. - + .BR .TP .BI 8. - + .BR .TP .BI 9. Table from the Wealth of Networks by Yochai Benkler - + .BR .TP @@ -4033,18 +3995,18 @@ rather fine and this behaviour could be reinstated. .BR .TP .BI 13. - - + + .BR .TP .BI 14. - + .BR .TP .BI 15. - + .BR .TP @@ -4079,10 +4041,10 @@ matches are found. sisu_vim(7) .TP .SH HOMEPAGE - More information about SiSU can be found at or + More information about SiSU can be found at or .TP .SH SOURCE - + .TP .SH AUTHOR SiSU is written by Ralph Amissah -- cgit v1.2.3