From: John Mandereau Date: Tue, 10 Jun 2008 16:07:35 +0000 (+0200) Subject: Advertise xrefs checking script in docs policy X-Git-Tag: release/2.11.49-1~1^2~8 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=97a0ec882833f3f5247e66027cba28bce0abe471;p=lilypond.git Advertise xrefs checking script in docs policy --- diff --git a/Documentation/user/policy.txt b/Documentation/user/policy.txt index 3cbae4c7d4..4197d0c6ac 100644 --- a/Documentation/user/policy.txt +++ b/Documentation/user/policy.txt @@ -66,7 +66,7 @@ Users are not expected to read this manual from start to finish. * Music Glossary: information about the music notation itself. - Explainations and translations about notation terms go here. + Explanations and translations about notation terms go here. Users are not expected to read this manual from start to finish. @@ -137,6 +137,20 @@ main docs (ie 1.1.1 Writing Pitches). +%%%%% CHECKING CROSS-REFERENCES + +Cross-references between different manuals are heavily used in the +documentation, but they are not checked during compilation. However, +if you compile the documentation, a script called check_texi_refs can +help you with checking and fixing these cross-references; for +information on usage, cd into a source tree where documentation has +been built, cd into Documentation and look for check-xrefs and +fix-xrefs targets in 'make help' output. Note that you have to find +yourself the source files to fix cross-references in the generated +documentation such as the Internals Reference; e.g. you can grep +scm/ and lily/. + + %%%%% GENERAL WRITING * Do not forget to create @cindex entries for new sections of text.