[Bug 204893] [patch] FDP, section 7.6.2: Wrong example for defining parameter entities

Sun Nov 29 09:41:43 UTC 2015

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=204893

            Bug ID: 204893
           Summary: [patch] FDP, section 7.6.2: Wrong example for defining
                    parameter entities
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Keywords: patch
          Severity: Affects Many People
          Priority: ---
         Component: Documentation
          Assignee: freebsd-doc at FreeBSD.org
          Reporter: andipersti at gmail.com
          Keywords: patch

In section 7.6.2 ("Parameter Entities") of the FDP
(https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/xml-primer-entities.html#xml-primer-parameter-entities)
the example given is wrong. The XML standard doesn't allow references to
parameter entities within markup declarations in an internal subset of the DTD
(see http://www.w3.org/TR/2006/REC-xml11-20060816/#wfc-PEinInternalSubset).
Thus, the line 5 in the example (<!ENTITY % param.new "%param.some more
%param.text">) is not well-formed XML. (The delimiting semicolons are also
missing in both references.) 

I suggest to replace that example with a more realistic one like

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [
<!ENTITY % entity "<!ENTITY version '1.0'>">
<!-- use the parameter entity -->
%entity;
]>

(The attached patch also fixes a typo and adds a sentence about the usefulness
of parameter entities.)

-- 
You are receiving this mail because:
You are the assignee for the bug.