diff options
author | Daniel Silverstone <dsilvers@digital-scurf.org> | 2017-01-14 19:17:07 +0000 |
---|---|---|
committer | Daniel Silverstone <dsilvers@digital-scurf.org> | 2017-01-14 19:17:07 +0000 |
commit | 081f601ebe248be58c672454b3d8b89c55758e1b (patch) | |
tree | 28a838215ae3fc517b815f6b2a27688b7349cc8f /doc | |
parent | e8901d9a3fbb3d80014d87d4876f7d90f51a6455 (diff) | |
download | gitano-081f601ebe248be58c672454b3d8b89c55758e1b.tar.gz |
More cleanups, make document nicer, include cover logo
Diffstat (limited to 'doc')
-rw-r--r-- | doc/admin/000.mdwn | 9 | ||||
-rw-r--r-- | doc/admin/Makefile | 7 | ||||
-rw-r--r-- | doc/admin/header.tex | 20 | ||||
-rw-r--r-- | doc/admin/image.html | 1 | ||||
-rw-r--r-- | doc/admin/logo-front.jpg | bin | 0 -> 96665 bytes | |||
-rw-r--r-- | doc/admin/manual.css | 333 | ||||
-rw-r--r-- | doc/admin/titling.tex | 7 |
7 files changed, 372 insertions, 5 deletions
diff --git a/doc/admin/000.mdwn b/doc/admin/000.mdwn index f70f065..44e729e 100644 --- a/doc/admin/000.mdwn +++ b/doc/admin/000.mdwn @@ -1,11 +1,14 @@ --- title: Gitano Admininistration -author: Lars Wirzenius, Richard Maw, Daniel Silverstone, and the Gitano project +author: + - Lars Wirzenius <liw@liw.fi> + - Richard Maw <richard.maw@gmail.com> + - Daniel Silverstone <dsilvers@digital-scurf.org> date: Gitano v1.0, Manual v0.1 ... -**NOTA BENE:** This manual is incomplete and describes the state of -Gitano at its 1.0 release. +> **NOTA BENE:** This manual is incomplete and describes the state of +> Gitano at its 1.0 release. # Introduction diff --git a/doc/admin/Makefile b/doc/admin/Makefile index 36fe506..42ffcac 100644 --- a/doc/admin/Makefile +++ b/doc/admin/Makefile @@ -3,7 +3,10 @@ sources = $(wildcard *.mdwn) all: gitano-admin-doc.pdf gitano-admin-doc.html gitano-admin-doc.pdf: $(sources) Makefile - pandoc --toc -o gitano-admin-doc.pdf $(sources) + pandoc --standalone --toc --chapters -V documentclass:report -V geometry:margin=1in -V graphics:true -V papersize:a4paper -H titling.tex -H header.tex -o gitano-admin-doc.pdf $(sources) gitano-admin-doc.html: $(sources) Makefile - pandoc --toc --standalone -o gitano-admin-doc.html $(sources) + pandoc --toc --standalone --css manual.css -B image.html -o gitano-admin-doc.html $(sources) + +clean: + $(RM) gitano-admin-doc.pdf gitano-admin-doc.html diff --git a/doc/admin/header.tex b/doc/admin/header.tex new file mode 100644 index 0000000..0a6c227 --- /dev/null +++ b/doc/admin/header.tex @@ -0,0 +1,20 @@ +\usepackage{fancyhdr} + +\pagestyle{fancy} + +\fancyhf{} + +\lhead{\leftmark} +\rhead{Gitano Admin Manual} + +\rfoot{Page \thepage} + +\renewcommand{\headrulewidth}{2pt} +\renewcommand{\footrulewidth}{1pt} + +\fancypagestyle{plain}{% + \fancyhf{}% + \rfoot{Page \thepage}% + \renewcommand{\headrulewidth}{0pt}% + \renewcommand{\footrulewidth}{1pt}% +} diff --git a/doc/admin/image.html b/doc/admin/image.html new file mode 100644 index 0000000..fe9483b --- /dev/null +++ b/doc/admin/image.html @@ -0,0 +1 @@ +<img width="600" height="600" src="logo-front.jpg" /> diff --git a/doc/admin/logo-front.jpg b/doc/admin/logo-front.jpg Binary files differnew file mode 100644 index 0000000..428e64a --- /dev/null +++ b/doc/admin/logo-front.jpg diff --git a/doc/admin/manual.css b/doc/admin/manual.css new file mode 100644 index 0000000..cc5a420 --- /dev/null +++ b/doc/admin/manual.css @@ -0,0 +1,333 @@ +/* The content of this CSS file acquired from https://gist.github.com/killercup/5917178 + * used under the terms of the CC0 licence as per https://gist.github.com/killercup/5917178#gistcomment-1924106 + * The terms of CC0 can be found at https://creativecommons.org/publicdomain/zero/1.0/ + */ + +/* + * I add this to html files generated with pandoc. + */ + +html { + font-size: 100%; + overflow-y: scroll; + -webkit-text-size-adjust: 100%; + -ms-text-size-adjust: 100%; +} + +body { + color: #444; + font-family: Georgia, Palatino, 'Palatino Linotype', Times, 'Times New Roman', serif; + font-size: 12px; + line-height: 1.7; + padding: 1em; + margin: auto; + max-width: 42em; + background: #fefefe; +} + +a { + color: #0645ad; + text-decoration: none; +} + +a:visited { + color: #0b0080; +} + +a:hover { + color: #06e; +} + +a:active { + color: #faa700; +} + +a:focus { + outline: thin dotted; +} + +*::-moz-selection { + background: rgba(255, 255, 0, 0.3); + color: #000; +} + +*::selection { + background: rgba(255, 255, 0, 0.3); + color: #000; +} + +a::-moz-selection { + background: rgba(255, 255, 0, 0.3); + color: #0645ad; +} + +a::selection { + background: rgba(255, 255, 0, 0.3); + color: #0645ad; +} + +p { + margin: 1em 0; +} + +img { + max-width: 100%; +} + +h1, h2, h3, h4, h5, h6 { + color: #111; + line-height: 125%; + margin-top: 2em; + font-weight: normal; +} + +h4, h5, h6 { + font-weight: bold; +} + +h1 { + font-size: 2.5em; +} + +h2 { + font-size: 2em; +} + +h3 { + font-size: 1.5em; +} + +h4 { + font-size: 1.2em; +} + +h5 { + font-size: 1em; +} + +h6 { + font-size: 0.9em; +} + +blockquote { + color: #666666; + margin: 0; + padding-left: 3em; + border-left: 0.5em #EEE solid; +} + +hr { + display: block; + height: 2px; + border: 0; + border-top: 1px solid #aaa; + border-bottom: 1px solid #eee; + margin: 1em 0; + padding: 0; +} + +pre, code, kbd, samp { + color: #000; + font-family: monospace, monospace; + _font-family: 'courier new', monospace; + font-size: 0.98em; +} + +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +b, strong { + font-weight: bold; +} + +dfn { + font-style: italic; +} + +ins { + background: #ff9; + color: #000; + text-decoration: none; +} + +mark { + background: #ff0; + color: #000; + font-style: italic; + font-weight: bold; +} + +sub, sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +ul, ol { + margin: 1em 0; + padding: 0 0 0 2em; +} + +li p:last-child { + margin-bottom: 0; +} + +ul ul, ol ol { + margin: .3em 0; +} + +dl { + margin-bottom: 1em; +} + +dt { + font-weight: bold; + margin-bottom: .8em; +} + +dd { + margin: 0 0 .8em 2em; +} + +dd:last-child { + margin-bottom: 0; +} + +img { + border: 0; + -ms-interpolation-mode: bicubic; + vertical-align: middle; +} + +figure { + display: block; + text-align: center; + margin: 1em 0; +} + +figure img { + border: none; + margin: 0 auto; +} + +figcaption { + font-size: 0.8em; + font-style: italic; + margin: 0 0 .8em; +} + +table { + margin-bottom: 2em; + border-bottom: 1px solid #ddd; + border-right: 1px solid #ddd; + border-spacing: 0; + border-collapse: collapse; +} + +table th { + padding: .2em 1em; + background-color: #eee; + border-top: 1px solid #ddd; + border-left: 1px solid #ddd; +} + +table td { + padding: .2em 1em; + border-top: 1px solid #ddd; + border-left: 1px solid #ddd; + vertical-align: top; +} + +.author { + font-size: 1.2em; + text-align: center; +} + +@media only screen and (min-width: 480px) { + body { + font-size: 14px; + } +} +@media only screen and (min-width: 768px) { + body { + font-size: 16px; + } +} +@media print { + * { + background: transparent !important; + color: black !important; + filter: none !important; + -ms-filter: none !important; + } + + body { + font-size: 12pt; + max-width: 100%; + } + + a, a:visited { + text-decoration: underline; + } + + hr { + height: 1px; + border: 0; + border-bottom: 1px solid black; + } + + a[href]:after { + content: " (" attr(href) ")"; + } + + abbr[title]:after { + content: " (" attr(title) ")"; + } + + .ir a:after, a[href^="javascript:"]:after, a[href^="#"]:after { + content: ""; + } + + pre, blockquote { + border: 1px solid #999; + padding-right: 1em; + page-break-inside: avoid; + } + + tr, img { + page-break-inside: avoid; + } + + img { + max-width: 100% !important; + } + + @page :left { + margin: 15mm 20mm 15mm 10mm; +} + + @page :right { + margin: 15mm 10mm 15mm 20mm; +} + + p, h2, h3 { + orphans: 3; + widows: 3; + } + + h2, h3 { + page-break-after: avoid; + } +} diff --git a/doc/admin/titling.tex b/doc/admin/titling.tex new file mode 100644 index 0000000..2d348ea --- /dev/null +++ b/doc/admin/titling.tex @@ -0,0 +1,7 @@ +\usepackage{titling} + +\pretitle{ + \begin{center} + \includegraphics[width=8cm,height=8cm]{logo-front.jpg}\\[\bigskipamount] +} +\posttitle{\end{center}} |