os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Mention what catalog files are. Also suggest that people set the

Browse source 
FreeBSD-specific catalog files are set during this tutorial; this will
answer a common FreeBSD docproj complaint on complaints generated by
emacs.

"if it's wrong, fix it" by: nik
This commit is contained in:
Michael Lucas 2002-02-14 19:31:09 +00:00
parent bc87172e26
commit 8c54a4e432
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=12191
1 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
View file

@ -323,6 +323,14 @@
simpler just to <emphasis>always</emphasis> quote your attribute simpler just to <emphasis>always</emphasis> quote your attribute
values.</para> values.</para>
<para>The information on attributes, elements, and tags is stored
in SGML catalogs. The various Documentation Project tools use
these catalog files to validate your work. The tools in
<port>textproc/docproj</port> include a variety of SGML catalog
files. The FreeBSD Documentation Project includes its own set
of catalog files. Your tools need to know about both sorts of
catalog files.</para>
<sect2> <sect2>
<title>For you to do&hellip;</title> <title>For you to do&hellip;</title>
@ -341,7 +349,10 @@
<step> <step>
<para>Add lines to your shell startup files to set <para>Add lines to your shell startup files to set
<envar>SGML_CATALOG_FILES</envar>.</para> <envar>SGML_CATALOG_FILES</envar>. (If you are not working
on the English version of the documentation, you will want
to substitute the correct directory for your
language.)</para>
<example id="sgml-primer-envars"> <example id="sgml-primer-envars">
<title><filename>.profile</filename>, for &man.sh.1; and <title><filename>.profile</filename>, for &man.sh.1; and
@ -352,6 +363,8 @@ SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog
SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES SGML_CATALOG_FILES=${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/en_US.ISO8859-1/share/sgml/catalog
export SGML_CATALOG_FILES</programlisting> export SGML_CATALOG_FILES</programlisting>
</example> </example>
@ -363,7 +376,9 @@ export SGML_CATALOG_FILES</programlisting>
setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog
setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES</programlisting> setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES=/usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES=/usr/doc/en_US.ISO8859-1/share/sgml/catalog</programlisting>
</example> </example>
<para>Then either log out, and log back in again, or run those <para>Then either log out, and log back in again, or run those