Bug 48980

Summary: [patch] nsgmls -s errors and sect. 3.2.1 of the fdp-primer
Product: Documentation Reporter: Martin Karlsson <mk-freebsd>
Component: Books & ArticlesAssignee: Giorgos Keramidas <keramida>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Martin Karlsson 2003-03-06 18:10:08 UTC
	Section 3.2.1 of the fdp-primer shows some environment variables
for use with the FDP and SGML files. As pointed out by Warren Block 
(Message-ID: Pine.BSF.4.21.0212021241330.8913-100000@wonkity.com) in 
an e-mail to the doc mailing list, running nsgmls -s on an SGML file,
with these environment variables set, produces errors. This patch swaps 
the docbook and iso8879 lines so that the docbook line is first 
(per Warren's suggestion), and this appears to fix the problem.

How-To-Repeat: 	Use the environment variables shown in section 3.2.1 of the
fdp-primer, and test an SGML file with nsgmls -s foo.sgml.
Comment 1 Giorgos Keramidas freebsd_committer freebsd_triage 2006-11-05 17:56:35 UTC
On 2003-03-06 19:09, Martin Karlsson <mk-freebsd@bredband.net> wrote:
> 	Section 3.2.1 of the fdp-primer shows some environment variables
> for use with the FDP and SGML files. As pointed out by Warren Block 
> (Message-ID: Pine.BSF.4.21.0212021241330.8913-100000@wonkity.com) in 
> an e-mail to the doc mailing list, running nsgmls -s on an SGML file,
> with these environment variables set, produces errors. This patch swaps 
> the docbook and iso8879 lines so that the docbook line is first 
> (per Warren's suggestion), and this appears to fix the problem.
> >How-To-Repeat:
> 	Use the environment variables shown in section 3.2.1 of the
> fdp-primer, and test an SGML file with nsgmls -s foo.sgml.

Hi Martin,

Using nsgmls is not the recommended way of building or testing the
documentation, as far as I know.  If you use the doc/ Makefiles, then
the correct SGML_CATALOG_FILES will be used.  You can even build the
doc/ tree _without_ _anything_ in SGML_CATALOG_FILES.

I'm not sure I would find it nice if we started recommending that people
bypass the entire doc/ Makefile framework and use nsgmls manually
themselves.

- Giorgos
Comment 2 Giorgos Keramidas freebsd_committer freebsd_triage 2006-11-05 18:26:42 UTC
Responsible Changed
From-To: freebsd-doc->keramida

I know why this happens.  I'll take care of documenting the 
cause and commiting the fix.
Comment 3 dfilter service freebsd_committer freebsd_triage 2006-11-05 18:32:12 UTC
keramida    2006-11-05 18:32:05 UTC

  FreeBSD doc repository

  Modified files:
    en_US.ISO8859-1/books/fdp-primer/sgml-primer chapter.sgml 
  Log:
  The docbook/4.1 `dbcent.mod' module contains references to public entities
  first defined in ${SGMLROOT}/html/catalog and ${SGML_ROOT}/iso8879/catalog.
  By setting the SGML_CATALOG_FILES in the order suggested until now, we end
  up with a value of SGML_CATALOG_FILES like (wrapped to keep the length of
  the lines reasonable):
  
    /usr/doc/en_US.ISO8859-1/share/sgml/catalog:/usr/doc/share/sgml/catalog:\
    /usr/local/share/sgml/docbook/4.1/catalog:/usr/local/share/sgml/html/catalog:\
    /usr/local/share/sgml/iso8879/catalog:/usr/local/share/sgml/jade/catalog
  
  This means that when `dbcent.mod' refers to entities like %ISOamsa; they
  are not known already (because they are defined in catalog files later in
  the search path, not loaded by nsgmls yet).  This results in errors like:
  
    nsgmls:/usr/local/share/sgml/docbook/4.1/dbcent.mod:54:0:E: \
    cannot open "/usr/local/share/sgml/docbook/4.1/iso-amsa.gml" \
    (No such file or directory)
  
  By rearranging the order of the catalog files a bit, we can convince nsgmls
  to load the `html' and `iso8879' public entities first, and make it
  possible to use nsgmls to validate DocBook SGML documents too (instead of
  HTML only).
  
  PR:             docs/48980
  Submitted by:   Martin Karlsson <mk-freebsd@bredband.net>
  
  Revision  Changes    Path
  1.46      +4 -4      doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
_______________________________________________
cvs-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/cvs-all
To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
Comment 4 Giorgos Keramidas freebsd_committer freebsd_triage 2006-11-05 18:32:39 UTC
State Changed
From-To: open->closed

Committed in revision 1.46 of 
doc/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml,v 

Thanks