diff options
| author | Michael Lucas <mwlucas@FreeBSD.org> | 2002-02-14 19:31:09 +0000 |
|---|---|---|
| committer | Michael Lucas <mwlucas@FreeBSD.org> | 2002-02-14 19:31:09 +0000 |
| commit | 8c54a4e4321c48c81baedc0b140c5321d0753ebd (patch) | |
| tree | 585f3ef798aad630f4b56997f8348c5b459ad69e | |
| parent | bc87172e26f41ec1003745786985e5a1b8769628 (diff) | |
| download | doc-8c54a4e4321c48c81baedc0b140c5321d0753ebd.tar.gz doc-8c54a4e4321c48c81baedc0b140c5321d0753ebd.zip | |
Mention what catalog files are. Also suggest that people set the
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
Notes
Notes:
svn path=/head/; revision=12191
| -rw-r--r-- | en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml index e85e22eb11..e0a11b412d 100644 --- a/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml +++ b/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml @@ -323,6 +323,14 @@ simpler just to <emphasis>always</emphasis> quote your attribute 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> <title>For you to do…</title> @@ -341,7 +349,10 @@ <step> <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"> <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}/html/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> </example> @@ -363,7 +376,9 @@ export SGML_CATALOG_FILES</programlisting> 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}/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> <para>Then either log out, and log back in again, or run those |