aboutsummaryrefslogtreecommitdiffhomepage
path: root/README
diff options
context:
space:
mode:
authorRalph Amissah <ralph.amissah@gmail.com>2023-01-30 14:09:43 -0500
committerRalph Amissah <ralph.amissah@gmail.com>2023-01-30 17:11:30 -0500
commite1082e5c5592d1253f21cbbd25280467d63cd170 (patch)
treeacb3cbbfc8c0b4c2c09029f414b0ca59f1c7ff44 /README
parentversion & changelog, open commit window (diff)
changelog & urls housekeeping, more required
- keep manual changelog? could rely on git changelogs - qi modified to match current urls - lots of url related stuff needs checking
Diffstat (limited to 'README')
-rw-r--r--README126
1 files changed, 60 insertions, 66 deletions
diff --git a/README b/README
index 2d1e9825..9aac70bf 100644
--- a/README
+++ b/README
@@ -31,7 +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/>
+- <https://www.sisudoc.org/>
INSTALL OR RUN WITHOUT INSTALLATION
***********************************
@@ -102,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>
----------------------------------------
@@ -150,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
@@ -178,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
@@ -209,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
@@ -265,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://www.jus.uio.no/sisu>
DOCUMENT PROCESSING COMMAND FLAGS
.................................
@@ -1004,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://www.jus.uio.no/sisu/SiSU/examples.html> 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
@@ -1075,24 +1072,21 @@ 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/
+ { Book Samples & Markup Examples }https://www.jus.uio.no/sisu/SiSU/examples.html
+ { 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
.................
@@ -1157,8 +1151,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
@@ -1168,8 +1162,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]
@@ -1438,33 +1432,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
----------------------------------------
@@ -1476,22 +1470,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
@@ -1527,24 +1521,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
@@ -1569,21 +1563,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
...........................
@@ -2132,7 +2126,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
@@ -2183,7 +2177,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
@@ -2329,7 +2323,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
@@ -2356,13 +2350,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://www.jus.uio.no/sisu/the_wealth_of_networks.yochai_benkler>
[10]: for which you may alternatively use the full form author: title: and year: