aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2011-09-18 12:57:44 +0300
committerSergey Poznyakoff <gray@gnu.org.ua>2011-09-18 13:02:26 +0300
commit0c6c4140a92c2f151ea13874215e1b9a2509f3ad (patch)
treec09d9d369d61865dfece4fe4ef0ee7b07def19b9
parentcff56e700dcd05278ff86566bca097479079f3c6 (diff)
downloadimprimatur-0c6c4140a92c2f151ea13874215e1b9a2509f3ad.tar.gz
imprimatur-0c6c4140a92c2f151ea13874215e1b9a2509f3ad.tar.bz2
Minor fixes.
* imprimatur.m4: Fix comments. * imprimatur.texi: Add conditional WEBDOCS parts for web documentation. Don't use @group within @display, it doesn't work anyway. Don't use @cartouche inside @example. Use @quotation instead of @display for example Texinfo output. * rendition.texi: Don't call @unmacro in html mode, because texi2html mishandles it. (FIXMEREF): Don't treat html output specially.
-rw-r--r--imprimatur.m410
-rw-r--r--imprimatur.texi82
-rw-r--r--rendition.texi20
3 files changed, 65 insertions, 47 deletions
diff --git a/imprimatur.m4 b/imprimatur.m4
index 073392e..990009c 100644
--- a/imprimatur.m4
+++ b/imprimatur.m4
@@ -54,12 +54,14 @@ AC_DEFUN([_IMPRIMATUR_OPTION_SWITCH],
AC_DEFUN([_IMPRIMATUR_SET_OPTIONS],
[m4_foreach_w([_IMPRIMATUR_Option], [$1], [_IMPRIMATUR_SET_OPTION(_IMPRIMATUR_Option)])])
-# IMPRIMATUR_INIT([DIR],[RENDITION])
+# IMPRIMATUR_INIT([DIR],[OPTIONS])
# DIR - Directory in the source tree where imprimatur has been cloned.
# Default is "imptimatur".
-# RENDITION - Documentation rendition. Default is DISTRIB for stable releases
-# and PROOF for alpha releases. The release type is determined by
-# the version number, assuming GNU versioning.
+# OPTIONS - A whitespace-separated list of options. Valid options are:
+# any one of PROOF, DISTRIB or PUBLISH to set the default
+# rendition, frenchspacing to declare that French sentence
+# spacing should be assumed, and makedoc to enable rules for
+# building imprimatur documentation.
AC_DEFUN([IMPRIMATUR_INIT],[
m4_pushdef([imprimaturdir],[m4_if([$1],,[imprimatur],[$1])])
AC_SUBST([IMPRIMATUR_MODULE_DIR],imprimaturdir)
diff --git a/imprimatur.texi b/imprimatur.texi
index 85131dd..1229a01 100644
--- a/imprimatur.texi
+++ b/imprimatur.texi
@@ -7,7 +7,7 @@
@c The UPDATED date is updated automatically by the Emacs magic at the
@c end of this file.
-@set UPDATED 17 September 2011
+@set UPDATED 18 September 2011
@set VERSION 1.0
@c This document contains examples of all the rendition macros, so it
@@ -60,8 +60,10 @@ is included in the section entitled ``GNU Free Documentation License''.
@node Top
@top Imprimatur
+@ifclear WEBDOCS
This edition of the @cite{Imprimatur Manual}, last updated @value{UPDATED},
documents @command{Imprimatur} Version @value{VERSION}.
+@end ifclear
@end ifnottex
@menu
@@ -78,6 +80,12 @@ documents @command{Imprimatur} Version @value{VERSION}.
Appendices
+@ifhtml
+@ifset WEBDOCS
+* This Manual in Other Formats::
+@end ifset
+@end ifhtml
+
* Copying This Manual:: The GNU Free Documentation License.
* Concept Index:: Index of Concepts.
@@ -106,6 +114,15 @@ several other free software projects its author maintains: GNU
Mailutils, Dico and Pies, to name a few. It was reorganized into a
standalone submodule project in 2011.
+@ifhtml
+@ifset WEBDOCS
+This edition of the @cite{Imprimatur Manual}, last updated @value{UPDATED},
+documents @command{Imprimatur} Version @value{VERSION}. It is
+available in various formats. @xref{This Manual in Other Formats}, to
+select another format.
+@end ifset
+@end ifhtml
+
@node Intro
@chapter Introduction
@cindex annotation
@@ -368,14 +385,12 @@ values.@}
In @samp{PROOF} rendition, this Texinfo excerpt produces the following
output:
-@display
-@group
+@quotation
The @var{fmt} argument is a database format identifier.
If it is valid, the function returns expiration interval for that
format. @example-FIXME{It is not clear how to obtain negative expiration
values.}
-@end group
-@end display
+@end quotation
In other renditions, the @samp{@@FIXME} macro produces no output at
all.
@@ -386,11 +401,11 @@ you can obtain a listing of all pending @samp{@@FIXME} notes bu
running @code{make imprimatur-fixmes}, e.g.:
@example
-@cartouche
+@group
$ make imprimatur-fixmes
Unresolved FIXMEs:
functions.texi:2231: It is not clear how to obtain negative expiration
-@end cartouche
+@end group
@end example
It is especially handy if you use @samp{compile} mode of GNU Emacs, as
@@ -405,12 +420,12 @@ that need a revision. A listing of such nodes can be obtaining using
the @samp{imprimatur-unrevised} rule:
@example
-@cartouche
+@group
$ make imprimatur-unrevised
Unrevised nodes:
mailfromd.texi:2567:@@UNREVISED
functions.texi:1508:@@UNREVISED
-@end cartouche
+@end group
@end example
The @samp{@@UNREVISED} macro produces output in @samp{PROOF} and
@@ -440,22 +455,20 @@ channel. @@FIXME-xref@{Logging and Debugging@}.
This Texinfo fragment produces:
-@display
-@group
+@quotation
Enable transcript of @acronym{SMTP} sessions to the log
channel. @example-FIXME-xref{Logging and Debugging}.
-@end group
-@end display
+@end quotation
To list unresolved cross-reference use the @samp{imprimatur-refs}
Makefile rule:
@example
-@cartouche
+@group
$ make imprimatur-refs
Unresolved cross-references:
options.texi:4951: Logging and Debugging
-@end cartouche
+@end group
@end example
@node Init
@@ -746,9 +759,9 @@ Checks whether the files contain tabs (ASCII 9). If so the following
diagnostics is displayed:
@example
-@cartouche
+@group
Sources contain tabs; run make imprimatur-untabify
-@end cartouche
+@end group
@end example
@xref{imprimatur-untabify}.
@@ -761,13 +774,13 @@ the macros @samp{FIXME-ref}, @samp{FIXME-xref} or @samp{FIXME-pxref}
displayed and the rule exits with code 2. For example:
@example
-@cartouche
+@group
Unresolved cross-references:
mailfromd.texi:3535: existing categories
mailfromd.texi:4951: optimizer
mailfromd.texi:9899: debug configuration
functions.texi:1273: filter chains
-@end cartouche
+@end group
@end example
@end deffn
@@ -778,12 +791,12 @@ its content. If the content has several lines, only first of them is
displayed. For example:
@example
-@cartouche
+@group
Unresolved FIXMEs:
functions.texi:1518: Check references to 'Polling functions'
functions.texi:1562: Give more details and references.
functions.texi:2231: How to obtain negative
-@end cartouche
+@end group
@end example
@end deffn
@@ -793,11 +806,11 @@ with the @samp{@@WRITEME} macro (@pxref{Macros, WRITEME}). If so,
it displays locations of each @samp{@@WRITEME}, e.g.:
@example
-@cartouche
+@group
Empty nodes:
calloutd.texi:6:@@WRITEME
mfdbtool.texi:148:@@WRITEME
-@end cartouche
+@end group
@end example
@end deffn
@@ -816,12 +829,12 @@ refers to the place where the macro was encountered and the actual node
name is prefixed with @samp{(@@WRITEME)}, as shown in the example below:
@example
-@cartouche
+@group
Empty nodes:
./calloutd.texi:6: calloutd
./mfdbtool.texi:148: Configuring mfdbtool
./upgrade.texi:31: (@@WRITEME) Upgrading from 7.0 to 8.0
-@end cartouche
+@end group
@end example
@cindex imprimatur-ignore
@@ -840,11 +853,11 @@ ones marked with the @samp{@@UNREVISED} macro (@pxref{Macros,
UNREVISED}). If so, display locations of each @samp{@@UNREVISED}, e.g.:
@example
-@cartouche
+@group
Unrevised nodes:
mailfromd.texi:2567:@@UNREVISED
mailfromd.texi:2694:@@UNREVISED
-@end cartouche
+@end group
@end example
@end deffn
@@ -1050,24 +1063,19 @@ check-rules:
To illustrate its output, suppose that the rule
@samp{imprimatur-fixmes} is not documented. Then, you will get:
-
@display
-@group
$ make -k check-rules
Not documented Makefile rules:
imprimatur-fixmes
-@end group
@end display
Similarly, if the docs document rule @samp{imprimatur-fixme}
(presumably a typo: the @samp{s} is missing), you'll get:
@display
-@group
$ make -k check-rules
Non-existing Makefile rules:
imprimatur-fixme
-@end group
@end display
In both cases, the exit code will indicate an error.
@@ -1086,6 +1094,16 @@ short test case with the steps needed to reproduce the bug.
Any errors, typos or omissions found in this manual also qualify as
bugs. Please report them, if you happen to find any.
+@ifhtml
+@ifset WEBDOCS
+@node This Manual in Other Formats
+@appendix This Manual in Other Formats
+@html
+<!--#include virtual="manual/formats.html" -->
+@end html
+@end ifset
+@end ifhtml
+
@node Copying This Manual
@appendix GNU Free Documentation License
@include fdl.texi
diff --git a/rendition.texi b/rendition.texi
index ad1a976..22524a7 100644
--- a/rendition.texi
+++ b/rendition.texi
@@ -85,8 +85,14 @@
@c The \errmessage function is used to indicate error when producing
@c TeX output. Otherwise, a call to undefined macro with
@c self-explaining name ``Empty-node-in-publish-rendition!'' is used.
+@c
+@c Texi2html (at least up to v. 1.78 mishandles unmacro directive, so
+@c it is disabled for html output.
@c ------------------------------------------------------------------
+@ifnothtml
@unmacro Empty-node-in-publish-rendition!
+@end ifnothtml
+
@macro WRITEME
@ifset PUBLISH
@iftex
@@ -117,7 +123,10 @@
@c self-explaining name ``Unrevised-node-in-publish-rendition!'' is
@c used.
@c ------------------------------------------------------------------
+@ifnothtml
@unmacro Unrevised-node-in-publish-rendition!
+@end ifnothtml
+
@macro UNREVISED
@ifset PUBLISH
@iftex
@@ -182,20 +191,9 @@ otherwise inaccurate. This message will disappear, once this node revised.}
@c for various output formats.
@c ------------------------------------------------------------------
-@ifhtml
-@macro FIXMEREF{text,string}
-@html
-\text\ <span class="deadlink">\string\</span>
-@end html
-@deadlink{}
-@end macro
-@end ifhtml
-
-@ifnothtml
@macro FIXMEREF{text,string}
\text\ @i{\string\}@deadlink{}
@end macro
-@end ifnothtml
@c ------------------------------------------------------------------
@c @FIXME-ref{node} -- produces a @ref-style reference to undefined

Return to:

Send suggestions and report system problems to the System administrator.