From 5abfa8d8627e4b0d0ab2ac5834f53602ff202207 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Fri, 21 Sep 2007 16:26:05 -0700 Subject: [PATCH] More GDP tips. --- Documentation/user/README.txt | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/Documentation/user/README.txt b/Documentation/user/README.txt index d2480a0939..293d35abde 100644 --- a/Documentation/user/README.txt +++ b/Documentation/user/README.txt @@ -80,6 +80,12 @@ highly recommended. * Use two spaces after a period. +* Don't use a @ref{link to another section} in the middle of a + sentence. It looks ok in HTML, moderately bad in PDF, and + utterly horrible in INFO. Instead, reword the sentence so that + users are encouraged to see @ref{link to another section}. + (at the end of the sentence) + * Variables or numbers which consist of a single character (probably followed by a punctuation mark) should be tied properly, either to the previous or the next word. Example: @@ -135,8 +141,8 @@ highly recommended. all such characters appear in all output formats. * Lines should be less than 72 characters long. (I personally - recommend writing with 66-char lines, but don't bother changing - this if you see long lines.) + recommend writing with 66-char lines, but don't bother modifying + existing material.) * Use @q instead of `...' and @qq instead of ``...''. The latter macro should be used with care since we use `...' as the default quoting -- 2.39.5