From d02a940746c8fae096ce18f1dcbd0b76bb375036 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Sun, 14 Oct 2007 21:14:39 -0700 Subject: [PATCH] Update policy with info about links. --- Documentation/user/policy.txt | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Documentation/user/policy.txt b/Documentation/user/policy.txt index bb377d3921..a6a6c0e112 100644 --- a/Documentation/user/policy.txt +++ b/Documentation/user/policy.txt @@ -63,7 +63,7 @@ main docs * You _must_ include a @seealso. The order of items inside the @seealso section is - Music glossary: @rgloss{foo}, @rgloss{bar}. + Music glossary: @rglos{foo}, @rglos{bar}. User manual: @ref{baz}, @ref{foozle}. @@ -73,6 +73,15 @@ main docs ("Snippets" is REQUIRED; the others are optional) +* To create links, use @ref{} if the link is within the same + manual. If you are linking to another manual (say, + learning->glossary or user->program usage), then use: + @rlearning{} + @ruser{} + @rprogram{} + @rglos{} + @internalsref{} + * @commonprop and @refbugs are optional. -- 2.39.5