docs/56729: [patch] artciles/pr-guidelines: explain meaning of MFC

[Martin Heinen]

On Wed, Sep 17, 2003 at 11:09:24PM +0100, Ceri Davies wrote:

> I have started out with only including FreeBSD specific terms in the
> freebsd-glossary.sgml.  There's no reason why we couldn't then have another
> file containing generic computing terms (but personally, I'm not sure that
> is necessary), although the build would need to be tweaked a bit.
> 
> I've also included a change to the handbook build that will allow you to
> build in the glossary by running "make GLOSSARY=yes", but which is off by
> default.
> 
> Note that there are not many entries at the moment; once this is committed
> then people can feel free to add stuff to it - I've chosen the current entries
> to illustrate the docbook way of GlossSeeAlso, GlossSee, etc, elements.
> 
> Any thoughts?

Cool.

> Index: doc/en_US.ISO8859-1/books/handbook/book.sgml
> ===================================================================
> RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/handbook/book.sgml,v
> retrieving revision 1.141
> diff -u -r1.141 book.sgml
> --- doc/en_US.ISO8859-1/books/handbook/book.sgml	5 Sep 2003 21:30:20 -0000	1.141
> +++ doc/en_US.ISO8859-1/books/handbook/book.sgml	17 Sep 2003 21:28:01 -0000
> @@ -54,6 +54,7 @@
>  <!ENTITY % chap.eresources "IGNORE">
>  <!ENTITY % chap.pgpkeys "IGNORE">
>  <!ENTITY % chap.index "IGNORE">
> +<!ENTITY % chap.freebsd-glossary "IGNORE">
>  
>  <!ENTITY % pgpkeys SYSTEM "../../../share/pgpkeys/pgpkeys.ent"> %pgpkeys;
>  ]>
> @@ -236,6 +237,7 @@
>      <![ %chap.pgpkeys;                  [ &chap.pgpkeys;              ]]>
>      <![ %chap.index;                    [ &chap.index;                ]]>
>    </part>
> +  <![ %chap.freebsd-glossary;         [ &bookinfo.freebsd-glossary; ]]>
>    &chap.colophon;
>  </book>

Most books put the index after the glossary.  Also, we could
move the index out of the appendices and end up with something
like the following:

>      <![ %chap.pgpkeys;                  [ &chap.pgpkeys;              ]]>
>    </part>
>    <![ %chap.freebsd-glossary;         [ &bookinfo.freebsd-glossary; ]]>
>    <![ %chap.index;                    [ &chap.index;                ]]>
>    &chap.colophon;
>  </book>

-- 
Marxpitn