From 21d6363c406bd0301b52711a30f98e1f03d0afaa Mon Sep 17 00:00:00 2001 From: Grégoire Détrez Date: Fri, 5 Jul 2019 15:25:29 +0200 Subject: doc/template.html: Add parent links at the top. --- doc/template.html | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'doc/template.html') diff --git a/doc/template.html b/doc/template.html index e17f0e3..ceb2576 100644 --- a/doc/template.html +++ b/doc/template.html @@ -19,6 +19,12 @@ $endif$ span.smallcaps{font-variant: small-caps;} span.underline{text-decoration: underline;} div.column{display: inline-block; vertical-align: top; width: 50%;} + @media only screen and (min-width: 600px) { + .parent { + float: right; + margin-left: 1em; + } + } $if(quotes)$ q { quotes: "“" "”" "‘" "’"; } $endif$ @@ -48,14 +54,18 @@ $endfor$ $for(include-before)$ $include-before$ $endfor$ -
+
$if(title)$ -

$title$

+
+$if(parent)$ +
Parent
+$endif$ +

$title$

+
$endif$ $body$ -
@@ -72,5 +82,6 @@ $endif$
+ -- cgit v1.2.3 From 420cd08692d4962155b23925eabc74d9002bf55d Mon Sep 17 00:00:00 2001 From: Guilhem Moulin Date: Fri, 5 Jul 2019 15:29:07 +0200 Subject: doc/template.html: Fix minor space damage. --- doc/template.html | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) (limited to 'doc/template.html') diff --git a/doc/template.html b/doc/template.html index ceb2576..17cbdbe 100644 --- a/doc/template.html +++ b/doc/template.html @@ -15,18 +15,21 @@ $if(keywords)$ $endif$ $if(title-prefix)$$title-prefix$ – $endif$$pagetitle$ $if(highlighting-css)$ @@ -37,11 +40,6 @@ $endif$ $for(css)$ $endfor$ - $if(math)$ $math$ $endif$ -- cgit v1.2.3 From 060554e73c9effe783a10c25e83df80c5e7a33ea Mon Sep 17 00:00:00 2001 From: Guilhem Moulin Date: Fri, 5 Jul 2019 15:31:31 +0200 Subject: doc/*.md: Improve wording. --- doc/development.md | 2 +- doc/index.md | 2 +- doc/template.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/template.html') diff --git a/doc/development.md b/doc/development.md index 87eb32c..428c11d 100644 --- a/doc/development.md +++ b/doc/development.md @@ -1,4 +1,4 @@ -% Test environment setup for [`interimap`(1)] and [`pullimap`(1)] +% Test environment setup % [Guilhem Moulin](mailto:guilhem@fripost.org) Introduction diff --git a/doc/index.md b/doc/index.md index 281317e..a403a3e 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,4 +1,4 @@ -% [`interimap`(1)] and [`pullimap`(1)] documentation +% [`interimap`(1)] and [`pullimap`(1)] % [Guilhem Moulin](mailto:guilhem@fripost.org) Manuals (HTML versions) diff --git a/doc/template.html b/doc/template.html index 17cbdbe..97062e3 100644 --- a/doc/template.html +++ b/doc/template.html @@ -70,7 +70,7 @@ $body$
$if(author)$ - © + Copyright © $for(author)$$author$$sep$, $endfor$ $endif$
-- cgit v1.2.3 From 955cda2cfa32ca6e475b6726df4732f5dc98a30f Mon Sep 17 00:00:00 2001 From: Guilhem Moulin Date: Fri, 5 Jul 2019 17:39:46 +0200 Subject: doc/template.html: Justify paragraphs on larger screens. --- doc/template.html | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'doc/template.html') diff --git a/doc/template.html b/doc/template.html index 97062e3..a3a3938 100644 --- a/doc/template.html +++ b/doc/template.html @@ -24,6 +24,9 @@ $endif$ float: right; margin-left: 1em; } + .content p { + text-align: justify; + } } @media(max-width: 1440px) { .container{ max-width: 1080px; } } @media(max-width: 1280px) { .container{ max-width: 960px; } } @@ -64,6 +67,7 @@ $endif$ $endif$ $body$ +
@@ -80,6 +84,5 @@ $endif$
- -- cgit v1.2.3 From 4b61d5e13773bf8bf25537f28d1a42f7c6473b75 Mon Sep 17 00:00:00 2001 From: Guilhem Moulin Date: Sat, 6 Jul 2019 14:55:04 +0200 Subject: doc/*: Fix minor space damage. Also, set tab size to 4 spaces in the HTML for consistency. --- doc/build.md | 10 +++++----- doc/development.md | 14 +++++++------- doc/template.html | 1 + 3 files changed, 13 insertions(+), 12 deletions(-) (limited to 'doc/template.html') diff --git a/doc/build.md b/doc/build.md index ec87e73..5c362f1 100644 --- a/doc/build.md +++ b/doc/build.md @@ -33,9 +33,9 @@ On Debian GNU/Linux systems, the dependencies can be installed with the following command: $ apt install libconfig-tiny-perl \ - libdbi-perl \ - libdbd-sqlite3-perl \ - libnet-ssleay-perl + libdbi-perl \ + libdbd-sqlite3-perl \ + libnet-ssleay-perl Additional packages are required in order to run the test suite: @@ -68,8 +68,8 @@ the `CSS` environment variable (the value of which defaults to For instance, use $ CSS="https://guilhem.org/static/css/bootstrap.min.css" \ - HTML_ROOTDIR="$XDG_RUNTIME_DIR/interimap" \ - make html + HTML_ROOTDIR="$XDG_RUNTIME_DIR/interimap" \ + make html to generate the HTML documentation under directory `$XDG_RUNTIME_DIR/interimap` (which needs to exist) using a remote CSS file. diff --git a/doc/development.md b/doc/development.md index 428c11d..49e8d74 100644 --- a/doc/development.md +++ b/doc/development.md @@ -83,7 +83,7 @@ pre-authenticated [IMAP4rev1] in the test environment for username `testuser`, list mailboxes, and exit, run: $ env -i PATH="/usr/bin:/bin" USER="testuser" \ - doveadm -c "$BASEDIR/dovecot.conf" exec imap + doveadm -c "$BASEDIR/dovecot.conf" exec imap * PREAUTH [CAPABILITY IMAP4rev1 …] Logged in as testuser a LIST "" "*" * LIST (\HasNoChildren) "." INBOX @@ -98,10 +98,10 @@ the latter to create a mailbox `foo`, add a sample message to it, and finally mark it as `\Seen`. $ env -i PATH="/usr/bin:/bin" USER="testuser" \ - doveadm -c "$BASEDIR/dovecot.conf" mailbox create "foo" + doveadm -c "$BASEDIR/dovecot.conf" mailbox create "foo" $ env -i PATH="/usr/bin:/bin" USER="testuser" HOME="$BASEDIR/testuser" \ - doveadm -c "$BASEDIR/dovecot.conf" exec dovecot-lda -e -m "foo" <<-EOF + doveadm -c "$BASEDIR/dovecot.conf" exec dovecot-lda -e -m "foo" <<-EOF From: To: Subject: Hello world! @@ -112,7 +112,7 @@ finally mark it as `\Seen`. EOF $ env -i PATH="/usr/bin:/bin" USER="testuser" \ - doveadm -c "$BASEDIR/dovecot.conf" flags add "\\Seen" mailbox "foo" "*" + doveadm -c "$BASEDIR/dovecot.conf" flags add "\\Seen" mailbox "foo" "*" Normally [`dovecot-lda`(1)](https://wiki.dovecot.org/LDA) tries to do a userdb lookup in order to determine the user's home directory. Since we @@ -155,7 +155,7 @@ You can now run [`interimap`(1)] with `--watch` set, here to one second to observe synchronisation steps early. $ env -i PATH="$PATH" perl -I./lib -T ./interimap --config="$BASEDIR/interimap.conf" \ - --watch=1 --debug + --watch=1 --debug Use instructions from the [previous section][Mail storage access] (substituting `testuser` with `local` or `remote`) in order to simulate @@ -179,12 +179,12 @@ Create a [`pullimap`(1)] configuration file with as section `[foo]`. Run [`pullimap`(1)] without `--idle` in order to create the state file. $ env -i PATH="$PATH" perl -I./lib -T ./pullimap --config="$BASEDIR/pullimap.conf" \ - --no-delivery foo + --no-delivery foo You can now run [`pullimap`(1)] with `--idle` set. $ env -i PATH="$PATH" perl -I./lib -T ./pullimap --config="$BASEDIR/pullimap.conf" \ - --no-delivery --idle --debug foo + --no-delivery --idle --debug foo Use instructions from the [previous section][Mail storage access] in order to simulate activity on the “remote” server (in the relevant diff --git a/doc/template.html b/doc/template.html index a3a3938..2cd7cc9 100644 --- a/doc/template.html +++ b/doc/template.html @@ -19,6 +19,7 @@ $endif$ span.smallcaps{font-variant: small-caps;} span.underline{text-decoration: underline;} div.column{display: inline-block; vertical-align: top; width: 50%;} + pre{tab-size: 4; -moz-tab-size: 4;} @media only screen and (min-width: 600px) { .parent { float: right; -- cgit v1.2.3