Add a skeleton FreeBSD specific glossary, and the appropriate glue to the
handbook to allow it to be incorporated in the build. This is not on by default at the moment, and users who want it will need to set WITH_GLOSSARY to a non-empty string when building ("make WITH_GLOSSARY=yes" being the common case). It is expected that committers will help to flesh out the glossary before it is connected to the build by default; the current entries have been chosen to illustrate the way that DocBook allows for "See also" and "See" in the glossary elements. This commit also takes the index out of the appendices in the handbook, as this is not the usual place for an index to sit in a book, and moves it to the end of the book.
This commit is contained in:
parent
b8494fd2f5
commit
bddac34733
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=18152
4 changed files with 73 additions and 1 deletions
|
@ -31,6 +31,7 @@ DOC?= book
|
|||
FORMATS?= html-split
|
||||
|
||||
HAS_INDEX= true
|
||||
WITH_GLOSSARY?=
|
||||
|
||||
INSTALL_COMPRESSED?= gz
|
||||
INSTALL_ONLY_COMPRESSED?=
|
||||
|
@ -172,6 +173,9 @@ SYMLINKS= ${DESTDIR} index.html handbook.html
|
|||
CHAPTERS?= ${SRCS:M*chapter.sgml}
|
||||
|
||||
SGMLFLAGS+= ${CHAPTERS:S/\/chapter.sgml//:S/^/-i chap./}
|
||||
.if defined(WITH_GLOSSARY) && !empty(WITH_GLOSSARY)
|
||||
SGMLFLAGS+= -i chap.freebsd-glossary
|
||||
.endif
|
||||
|
||||
# XXX The Handbook build currently overflows some internal, hardcoded
|
||||
# limits in pdftex. Until we split the Handbook up, build the PDF
|
||||
|
|
|
@ -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;
|
||||
]>
|
||||
|
@ -234,8 +235,9 @@
|
|||
<![ %chap.bibliography; [ &chap.bibliography; ]]>
|
||||
<![ %chap.eresources; [ &chap.eresources; ]]>
|
||||
<![ %chap.pgpkeys; [ &chap.pgpkeys; ]]>
|
||||
<![ %chap.index; [ &chap.index; ]]>
|
||||
</part>
|
||||
<![ %chap.freebsd-glossary; [ &bookinfo.freebsd-glossary; ]]>
|
||||
<![ %chap.index; [ &chap.index; ]]>
|
||||
&chap.colophon;
|
||||
</book>
|
||||
|
||||
|
|
|
@ -12,3 +12,5 @@
|
|||
<!ENTITY bookinfo.legalnotice SYSTEM "legalnotice.sgml">
|
||||
|
||||
<!ENTITY bookinfo.trademarks SYSTEM "trademarks.sgml">
|
||||
|
||||
<!ENTITY bookinfo.freebsd-glossary SYSTEM "glossary/freebsd-glossary.sgml">
|
||||
|
|
64
en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml
Normal file
64
en_US.ISO8859-1/share/sgml/glossary/freebsd-glossary.sgml
Normal file
|
@ -0,0 +1,64 @@
|
|||
<!--
|
||||
FreeBSD Specific Glossary Terms
|
||||
Please keep this file sorted.
|
||||
|
||||
$FreeBSD$
|
||||
-->
|
||||
|
||||
<glossary status="draft" id="freebsd-glossary">
|
||||
<title>&os; Glossary</title>
|
||||
<para>This glossary contains terms and acronyms specific to &os;.</para>
|
||||
|
||||
<glossdiv>
|
||||
<title>B</title>
|
||||
|
||||
<glossentry id="bikeshed">
|
||||
<glossterm>Bikeshed Building</glossterm>
|
||||
<glossdef>
|
||||
<para>A phenomenon whereby many people will give an opinion on
|
||||
an uncomplicated topic, whilst a complex topic receives little
|
||||
or no discussion. See the
|
||||
<ulink url="../faq/misc.html#BIKESHED-PAINTING">FAQ</ulink> for
|
||||
the origin of the term.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glossdiv>
|
||||
|
||||
<glossdiv>
|
||||
<title>M</title>
|
||||
|
||||
<glossentry id="mfc">
|
||||
<glossterm>Merge From Current</glossterm>
|
||||
<acronym>MFC</acronym>
|
||||
<glossdef>
|
||||
<para>To merge functionality or a patch from the -CURRENT
|
||||
branch to another, most often -STABLE.</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry id="mfs">
|
||||
<glossterm>Merge From Stable</glossterm>
|
||||
<acronym>MFS</acronym>
|
||||
<glossdef>
|
||||
<para>In the normal course of FreeBSD development, a change will
|
||||
be committed to the -CURRENT branch for testing before being
|
||||
merged to -STABLE. On rare occassions, a change will go into
|
||||
-STABLE first and then be merged to -CURRENT.</para>
|
||||
<glossseealso otherterm="mfc">
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>MFC</glossterm>
|
||||
<glosssee otherterm="mfc">
|
||||
</glossentry>
|
||||
|
||||
<glossentry>
|
||||
<glossterm>MFS</glossterm>
|
||||
<glosssee otherterm="mfs">
|
||||
</glossentry>
|
||||
|
||||
</glossdiv>
|
||||
|
||||
</glossary>
|
||||
|
Loading…
Reference in a new issue