1Imprimatur README 2Copyright (C) 2011 Sergey Poznyakoff 3See the end of file for copying conditions. 4 5* Introduction 6 7This file contains brief information about installing and configuring 8Imprimatur. It is *not* intended as a replacement for the 9documentation, and is provided as a brief reference only. 10The complete documentation in Texinfo format is included. To build 11it, change to the imprimatur subdirectory and run `makeinfo 12imprimatur'. 13 14Complete documentation in various formats is available online from the 15following URL: 16 17 http://www.gnu.org.ua/software/imprimatur/manual 18 19* Overview 20 21Imprimatur provides Texinfo macros for various editing tasks such as 22adding editor notes and annotations, as well as makeinfo rules for 23verifying texinfo document structure, format, and (to a certain 24extent) content coverage. 25 26In particular, it provides a mechanism for verifying whether the 27entities, such as command line options, configuration file statements, 28library functions, and the like, which are defined in a set of source 29files are also described in the Texinfo document. 30 31* Installation 32 33To use Imprimatur in your project, follow these steps: 34 35** Import the package as a submodule 36 37This needs to be done only once: 38 39 git submodule add git://git.gnu.org.ua/imprimatur.git imprimatur 40 git submodule init 41 42The `submodule add' command takes two arguments: the submodule 43repository, which should be exactly as shown above, and the pathname 44of the cloned submodule in your project. This latter is entirely at 45your option. Throughout this document we will suppose that the module 46pathname is `imprimatur'. You will need to adjust the examples if you chose 47another name for it. 48 49** Edit the toplevel Makefile.am 50 51Add `-I imprimatur' to the ACLOCAL_AMFLAGS variable, and `imprimatur' 52to the SUBDIRS variable. For example: 53 54 ACLOCAL_AMFLAGS = -I m4 -I imprimatur 55 SUBDIRS = imprimatur 56 57** Edit the configure.ac file 58 59Add a call to IMPRIMATUR_INIT. Normally no parameters are needed. 60However, if you cloned Imprimatur into a directory with another name, 61the actual directory name must be supplied as the first argument. For 62example, if you used this submodule command 63 64 git submodule add git://git.gnu.org.ua/imprimatur.git somedir 65 66then use 67 68 IMPRIMATUR_INIT(somedir) 69 70in your configure.ac 71 72** Edit Makefile.am in your doc subdirectory 73 74Apply the following changes to the Makefile.am located in the 75subdirectory where you have your Texinfo sources: 76 771. To AM_MAKEINFOFLAGS add @IMPRIMATUR_MAKEINFOFLAGS@ 782. Define the variable `imprimatur_INPUT'. It must contain the 79names of Texinfo sources to be verified by Imprimatur. Normally, 80the following definition is sufficient: 81 82 imprimatur_INPUT=$(info_TEXINFOS) $(<BASE>_TEXINFOS) 83 84where <BASE> stands for the base name of your Texinfo document (e.g. 85"foo", if it is named "foo.texi"). 863. Include imprimatur.mk using relative addressing. For example, if 87your documentation subdirectory is located at the same nesting level 88as the directory you cloned Imprimatur to, use: 89 90 include ../imprimatur/imprimatur.mk 91 92Do not use Automake substitutions nor Makefile variables in the 93argument to include. 944. If you plan to use the `check-docs.sh' script, define the following 95variable: 96 97 CHECK_DOCS=$(top_srcdir)/@IMPRIMATUR_MODULE_DIR@/check-docs.sh 98 99For example: 100 101 AM_MAKEINFOFLAGS = @IMPRIMATUR_MAKEINFOFLAGS@ 102 imprimatur_INPUT=$(info_TEXINFOS) $(foo_TEXINFOS) 103 include ../imprimatur/imprimatur.mk 104 CHECK_DOCS=$(top_srcdir)/@IMPRIMATUR_MODULE_DIR@/check-docs.sh 105 106** Include `rendition.texi' into your main Texinfo source. 107 108* Bug reporting. 109 110Send bug reports to <gray+imprimatur@gnu.org.ua>. 111 112^L 113* Copyright information: 114 115Copyright (C) 2011 Sergey Poznyakoff 116 117 Permission is granted to anyone to make or distribute verbatim copies 118 of this document as received, in any medium, provided that the 119 copyright notice and this permission notice are preserved, 120 thus giving the recipient permission to redistribute in turn. 121 122 Permission is granted to distribute modified versions 123 of this document, or of portions of it, 124 under the above conditions, provided also that they 125 carry prominent notices stating who last changed them. 126 127 128Local Variables: 129mode: outline 130paragraph-separate: "[ ]*$" 131version-control: never 132End: 133