Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/delibero.git

Commented build script for installation documentation.

AuthorDave Jarvis <email>
Date2015-01-06 21:02:33 GMT-0800
Commitafd73db9db1bb5733be87d9b74fe83dc5ef836f5
Parent5bbfd97
docs/install/build.sh
#!/bin/bash
-# Script directory.
+# The purpose of this script is to generate installation documentation that
+# is thematically consistent with the overview manual.
+
+# Script's working directory.
DIR="$(cd "$( dirname "$0" )" && pwd)"
+# Convert the install wiki (markdown) into a ConTeXt file.
pandoc \
--data-dir=$DIR --template=template.tex \
- -t context --columns 80 -N \
+ -t context -N --chapters \
../../wiki/Install.md > install.tex
+# Generate PDF documentation from the ConTeXt file.
context --path=../common/ --purge install.tex
docs/install/install.pdf
Binary files differ
docs/install/install.tex
\startbodymatter
-\section[installation]{Installation}
-
-\section[requirements]{Requirements}
-
+\chapter{Installation}
+\chapter{Requirements}
System requirements include:
docs/install/install.tuc
utilitydata.job.pagestates.collected={
-}
-
-if not utilitydata.job then utilitydata.job = { } end
-if not utilitydata.job.structure then utilitydata.job.structure = { } end
-
-utilitydata.job.structure.collected={
- ["branches"]={},
- ["name"]="install",
- ["type"]="text",
-}
-
-if not utilitydata.job then utilitydata.job = { } end
-if not utilitydata.job.positions then utilitydata.job.positions = { } end
-
-utilitydata.job.positions.collected={
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.specials then utilitydata.structures.specials = { } end
-
-utilitydata.structures.specials.collected={
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.counters then utilitydata.structures.counters = { } end
-
-utilitydata.structures.counters.collected={
- ["chemical"]={
- { 0, 0, 0 },
- },
- ["combination"]={
- { 0 },
- },
- ["endnote"]={
- { 0 },
- },
- ["figure"]={
- { 0, 0, 0 },
- },
- ["footnote"]={
- { 0 },
- },
- ["formula"]={
- { 0, 0 },
- },
- ["graphic"]={
- { 0, 0, 0 },
- },
- ["intermezzo"]={
- { 0, 0, 0 },
- },
- ["itemgroup:itemize"]={
- { 0, 3, 0 },
- },
- ["linenote"]={
- { 0 },
- },
- ["paragraph"]={
- { 0, 0 },
- },
- ["realpage"]={
- { 5 },
- },
- ["subpage"]={
- { 0 },
- },
- ["table"]={
- { 0, 0, 0 },
- },
- ["userpage"]={
- { 2 },
- },
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.lists then utilitydata.structures.lists = { } end
-
-utilitydata.structures.lists.collected={
- {
- ["metadata"]=1,
- ["numberdata"]=3,
- ["references"]={
- ["block"]="bodypart",
- ["internal"]=1,
- ["realpage"]=4,
- ["reference"]="installation",
- ["section"]=1,
- },
- ["titledata"]={
- ["label"]="section",
- ["title"]="Installation",
- },
- },
- {
- ["metadata"]=1,
- ["numberdata"]=5,
- ["references"]={
- ["block"]="bodypart",
- ["internal"]=2,
- ["realpage"]=4,
- ["reference"]="requirements",
- ["section"]=2,
- },
- ["titledata"]={
- ["label"]="section",
- ["title"]="Requirements",
- },
- },
- {
- ["metadata"]=6,
- ["numberdata"]=8,
- ["references"]={
- ["block"]="backpart",
- ["internal"]=3,
- ["realpage"]=5,
- ["reference"]="pubs",
- ["section"]=3,
- ["used"]="fit",
- },
- ["titledata"]={
- ["bookmark"]="pubs",
- ["title"]="\\headtext {pubs}",
- },
- },
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.pages then utilitydata.structures.pages = { } end
-
-utilitydata.structures.pages.collected={
- {
- ["block"]="frontpart",
- ["number"]=2,
- ["numberdata"]=9,
- ["prefixdata"]=10,
- ["state"]="start",
- },
- {
- ["block"]="frontpart",
- ["number"]=3,
- ["numberdata"]=9,
- ["prefixdata"]=10,
- ["state"]="stop",
- },
- {
- ["block"]="frontpart",
- ["number"]=3,
- ["numberdata"]=9,
- ["prefixdata"]=10,
- ["state"]="start",
- },
- {
- ["block"]="bodypart",
- ["number"]=1,
- ["numberdata"]=9,
- ["prefixdata"]=10,
- ["state"]="start",
- },
- {
- ["block"]="backpart",
- ["number"]=2,
- ["numberdata"]=9,
- ["prefixdata"]=10,
- ["state"]="start",
- },
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.references then utilitydata.structures.references = { } end
-
-utilitydata.structures.references.collected={
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.references then utilitydata.structures.references = { } end
-
-utilitydata.structures.references.referred={
- { 2, 1 },
- { 3, 2 },
-}
-
-if not utilitydata.job then utilitydata.job = { } end
-if not utilitydata.job.objects then utilitydata.job.objects = { } end
-
-utilitydata.job.objects.collected={
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.synonyms then utilitydata.structures.synonyms = { } end
-
-utilitydata.structures.synonyms.collected={
- ["definition"]={
- ["entries"]={
- {
- ["definition"]={
- ["meaning"]="Free, open, unoccupied, unrestricted, uncontrolled.",
- ["synonym"]="Līberum",
- ["tag"]="Liberum",
- ["used"]=true,
- },
- ["metadata"]=11,
- },
- {
- ["definition"]={
- ["meaning"]="Consultation, deliberation, advice, council.",
- ["synonym"]="Cōnsilium",
- ["tag"]="Consilium",
- ["used"]=true,
- },
- ["metadata"]=11,
- },
- {
- ["definition"]={
- ["meaning"]="Thoughtful evalutation of discourse, prior to decision making.",
- ["synonym"]="Deliberation",
- ["tag"]="Deliberation",
- ["used"]=false,
- },
- ["metadata"]=11,
- },
- },
- ["metadata"]=12,
- },
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.registers then utilitydata.structures.registers = { } end
-
-utilitydata.structures.registers.collected={
-}
-
-if not utilitydata.structures then utilitydata.structures = { } end
-if not utilitydata.structures.blocks then utilitydata.structures.blocks = { } end
-
-utilitydata.structures.blocks.collected={
-}
-
-if not utilitydata.job then utilitydata.job = { } end
-if not utilitydata.job.files then utilitydata.job.files = { } end
-
-utilitydata.job.files.collected={
-}
-
-if not utilitydata.publications then utilitydata.publications = { } end
-
-utilitydata.publications.collected={
-}
-
-utilitydata.job.packed={
- ["index"]={
- {
- ["catcodes"]=8,
- ["coding"]="tex",
- ["increment"]="yes",
- ["kind"]="section",
- ["name"]="section",
- },
- { 0, 0, 1 },
- {
- ["block"]="bodypart",
- ["numbers"]=2,
- ["set"]="all",
- },
- { 0, 0, 2 },
- {
- ["block"]="bodypart",
- ["numbers"]=4,
- ["set"]="all",
- },
- {
- ["catcodes"]=8,
- ["coding"]="tex",
- ["increment"]="yes",
- ["kind"]="section",
- ["name"]="chapter",
- },
- { 0, 1 },
- {
- ["block"]="backpart",
- ["hidenumber"]=true,
- ["numbers"]=7,
+ ["margintext"]={ 4, 5 },
+}
+
+if not utilitydata.job then utilitydata.job = { } end
+if not utilitydata.job.structure then utilitydata.job.structure = { } end
+
+utilitydata.job.structure.collected={
+ ["branches"]={},
+ ["name"]="install",
+ ["type"]="text",
+}
+
+if not utilitydata.job then utilitydata.job = { } end
+if not utilitydata.job.positions then utilitydata.job.positions = { } end
+
+utilitydata.job.positions.collected={
+ ["md:h"]={
+ {
+ ["x"]=4792729,
+ },
+ {
+ ["x"]=4792729,
+ },
+ },
+ ["p:1"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["p"]=3,
+ ["x"]=10090163,
+ ["y"]=40636617,
+ },
+ ["p:2"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["p"]=3,
+ ["x"]=4792729,
+ ["y"]=39031902,
+ },
+ ["p:3"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["p"]=3,
+ ["x"]=4792729,
+ ["y"]=37427187,
+ },
+ ["p:4"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["p"]=3,
+ ["x"]=4792729,
+ ["y"]=35822472,
+ },
+ ["p:5"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["p"]=3,
+ ["x"]=4792729,
+ ["y"]=34217757,
+ },
+ ["p:6"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["p"]=6,
+ ["x"]=4792729,
+ ["y"]=43365609,
+ },
+ ["p:7"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["ls"]=2359296,
+ ["p"]=6,
+ ["x"]=7152025,
+ ["y"]=41323244,
+ },
+ ["p:8"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["ls"]=2359296,
+ ["p"]=6,
+ ["x"]=7152025,
+ ["y"]=40156178,
+ },
+ ["p:9"]={
+ ["d"]=326777,
+ ["h"]=840289,
+ ["hs"]=28755763,
+ ["ls"]=2359296,
+ ["p"]=6,
+ ["x"]=7152025,
+ ["y"]=38989112,
+ },
+ ["text:1"]={
+ ["h"]=36838115,
+ ["p"]=1,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+ ["text:2"]={
+ ["h"]=36838115,
+ ["p"]=2,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+ ["text:3"]={
+ ["h"]=36838115,
+ ["p"]=3,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+ ["text:4"]={
+ ["h"]=36838115,
+ ["p"]=4,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+ ["text:5"]={
+ ["h"]=36838115,
+ ["p"]=5,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+ ["text:6"]={
+ ["h"]=36838115,
+ ["p"]=6,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+ ["text:7"]={
+ ["h"]=36838115,
+ ["p"]=7,
+ ["w"]=28755763,
+ ["x"]=4792729,
+ ["y"]=7367782,
+ },
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.specials then utilitydata.structures.specials = { } end
+
+utilitydata.structures.specials.collected={
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.counters then utilitydata.structures.counters = { } end
+
+utilitydata.structures.counters.collected={
+ ["chemical"]={
+ { 0, 0, 0, 0, 0, 0, 0 },
+ },
+ ["combination"]={
+ { 0 },
+ },
+ ["endnote"]={
+ { 0 },
+ },
+ ["figure"]={
+ { 0, 0, 0, 0, 0, 0, 0 },
+ },
+ ["footnote"]={
+ { 0 },
+ },
+ ["formula"]={
+ { 0, 0, 0, 0 },
+ },
+ ["graphic"]={
+ { 0, 0, 0, 0, 0, 0, 0 },
+ },
+ ["intermezzo"]={
+ { 0, 0, 0, 0, 0, 0, 0 },
+ },
+ ["itemgroup:itemize"]={
+ { 0, 0, 0, 3, 0 },
+ },
+ ["linenote"]={
+ { 0 },
+ },
+ ["paragraph"]={
+ { 0, 0, 0, 0 },
+ },
+ ["realpage"]={
+ { 7 },
+ },
+ ["subpage"]={
+ { 0 },
+ },
+ ["table"]={
+ { 0, 0, 0, 0, 0, 0, 0 },
+ },
+ ["userpage"]={
+ { 4 },
+ },
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.lists then utilitydata.structures.lists = { } end
+
+utilitydata.structures.lists.collected={
+ {
+ ["metadata"]=1,
+ ["numberdata"]=3,
+ ["references"]={
+ ["block"]="bodypart",
+ ["internal"]=1,
+ ["realpage"]=4,
+ ["section"]=1,
+ ["used"]="fit",
+ ["x"]=4792729,
+ ["y"]=4125420,
+ },
+ ["titledata"]={
+ ["label"]="chapter",
+ ["title"]="Installation",
+ },
+ },
+ {
+ ["metadata"]=1,
+ ["numberdata"]=5,
+ ["references"]={
+ ["block"]="bodypart",
+ ["internal"]=2,
+ ["realpage"]=5,
+ ["section"]=2,
+ ["used"]="fit",
+ ["x"]=4792729,
+ ["y"]=4125420,
+ },
+ ["titledata"]={
+ ["label"]="chapter",
+ ["title"]="Requirements",
+ },
+ },
+ {
+ ["metadata"]=1,
+ ["numberdata"]=6,
+ ["references"]={
+ ["block"]="backpart",
+ ["internal"]=3,
+ ["realpage"]=7,
+ ["reference"]="pubs",
+ ["section"]=3,
+ ["used"]="fit",
+ ["x"]=4792729,
+ ["y"]=4125420,
+ },
+ ["titledata"]={
+ ["bookmark"]="pubs",
+ ["title"]="\\headtext {pubs}",
+ },
+ },
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.pages then utilitydata.structures.pages = { } end
+
+utilitydata.structures.pages.collected={
+ {
+ ["block"]="frontpart",
+ ["number"]=2,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="start",
+ },
+ {
+ ["block"]="frontpart",
+ ["number"]=3,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="stop",
+ },
+ {
+ ["block"]="frontpart",
+ ["number"]=3,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="start",
+ },
+ {
+ ["block"]="bodypart",
+ ["number"]=1,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="start",
+ },
+ {
+ ["block"]="bodypart",
+ ["number"]=2,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="start",
+ },
+ {
+ ["block"]="bodypart",
+ ["number"]=3,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="start",
+ },
+ {
+ ["block"]="backpart",
+ ["number"]=4,
+ ["numberdata"]=7,
+ ["prefixdata"]=8,
+ ["state"]="start",
+ },
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.references then utilitydata.structures.references = { } end
+
+utilitydata.structures.references.collected={
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.references then utilitydata.structures.references = { } end
+
+utilitydata.structures.references.referred={
+ { 2, 1 },
+ { 3, 2 },
+}
+
+if not utilitydata.job then utilitydata.job = { } end
+if not utilitydata.job.objects then utilitydata.job.objects = { } end
+
+utilitydata.job.objects.collected={
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.synonyms then utilitydata.structures.synonyms = { } end
+
+utilitydata.structures.synonyms.collected={
+ ["definition"]={
+ ["entries"]={
+ {
+ ["definition"]={
+ ["meaning"]="Free, open, unoccupied, unrestricted, uncontrolled.",
+ ["synonym"]="Līberum",
+ ["tag"]="Liberum",
+ ["used"]=true,
+ },
+ ["metadata"]=9,
+ },
+ {
+ ["definition"]={
+ ["meaning"]="Consultation, deliberation, advice, council.",
+ ["synonym"]="Cōnsilium",
+ ["tag"]="Consilium",
+ ["used"]=true,
+ },
+ ["metadata"]=9,
+ },
+ {
+ ["definition"]={
+ ["meaning"]="Thoughtful evalutation of discourse, prior to decision making.",
+ ["synonym"]="Deliberation",
+ ["tag"]="Deliberation",
+ ["used"]=false,
+ },
+ ["metadata"]=9,
+ },
+ },
+ ["metadata"]=10,
+ },
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.registers then utilitydata.structures.registers = { } end
+
+utilitydata.structures.registers.collected={
+}
+
+if not utilitydata.structures then utilitydata.structures = { } end
+if not utilitydata.structures.blocks then utilitydata.structures.blocks = { } end
+
+utilitydata.structures.blocks.collected={
+}
+
+if not utilitydata.job then utilitydata.job = { } end
+if not utilitydata.job.files then utilitydata.job.files = { } end
+
+utilitydata.job.files.collected={
+}
+
+if not utilitydata.publications then utilitydata.publications = { } end
+
+utilitydata.publications.collected={
+}
+
+utilitydata.job.packed={
+ ["index"]={
+ {
+ ["catcodes"]=8,
+ ["coding"]="tex",
+ ["increment"]="yes",
+ ["kind"]="section",
+ ["name"]="chapter",
+ },
+ { 0, 1 },
+ {
+ ["block"]="bodypart",
+ ["numbers"]=2,
+ ["set"]="all",
+ },
+ { 0, 2 },
+ {
+ ["block"]="bodypart",
+ ["numbers"]=4,
+ ["set"]="all",
+ },
+ {
+ ["block"]="backpart",
+ ["hidenumber"]=true,
+ ["numbers"]=2,
["set"]="all",
},
Delta435 lines added, 287 lines removed, 148-line increase