Mike Gerwitz

Activist for User Freedom

aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMike Gerwitz <mike.gerwitz@rtspecialty.com>2018-02-05 10:05:07 -0500
committerMike Gerwitz <mike.gerwitz@rtspecialty.com>2018-02-06 11:33:34 -0500
commitffb709dbc48c383d9247e3d5bb46d4b94acb226a (patch)
tree57d70c93eddb78f56769932bdeed6be4fff5bd6f /doc
parentd0bbc04218795ecdb752baf76fce48db6553a92a (diff)
downloadliza-ffb709dbc48c383d9247e3d5bb46d4b94acb226a.tar.gz
liza-ffb709dbc48c383d9247e3d5bb46d4b94acb226a.tar.bz2
liza-ffb709dbc48c383d9247e3d5bb46d4b94acb226a.zip
doc: Add trivia macro
Useful for random historical facts that give useful context for developers of Liza. It hopefully helps to mitigate some of the issues of Theory Building as noted by Peter Naur. * doc/liza.css: Refactor some styles to make them more concise. (.trivia): Add styling. * doc/macros.texi (trivia): Add macro.
Diffstat (limited to 'doc')
-rw-r--r--doc/liza.css13
-rw-r--r--doc/macros.texi12
2 files changed, 19 insertions, 6 deletions
diff --git a/doc/liza.css b/doc/liza.css
index 623bb28..0990fe9 100644
--- a/doc/liza.css
+++ b/doc/liza.css
@@ -125,9 +125,7 @@ but don't sacrifice space on small screens.
border-color: #d33682;
}
-.doc-notice.devnotice p::before,
-.doc-notice.devnote p::before,
-.doc-notice.tip p::before
+.doc-notice p::before
{
display: block;
float: left;
@@ -151,9 +149,12 @@ but don't sacrifice space on small screens.
content: '\261E';
}
-.doc-notice.devnotice p,
-.doc-notice.devnote p,
-.doc-notice.tip p
+.doc-notice.trivia p::before
+{
+ content: '\1F914';
+}
+
+.doc-notice p
{
padding-left: 1.75em;
}
diff --git a/doc/macros.texi b/doc/macros.texi
index 117786d..ed7dbfd 100644
--- a/doc/macros.texi
+++ b/doc/macros.texi
@@ -150,6 +150,18 @@ This system has maintenance concerns.
@end macro
+@c Conveying the historical details of the project is important to
+@c understand why the system exists in the state that it does
+@c today. Use of this macro will hopefully help mitigate some of the
+@c problems noted by Peter Naur in his paper Programming as Theory Building:
+@c http://pages.cs.wisc.edu/~remzi/Naur.pdf
+@macro trivia{text}
+@noticestart{trivia}
+\text\
+@noticeend
+@end macro
+
+
@c link to source file if URI is known, otherwise display
@c the path to the file
@ifset SRCURI