[Bug 27676] New: Typography makes it extremely difficult to find the definition of a built-in template

https://www.w3.org/Bugs/Public/show_bug.cgi?id=27676

            Bug ID: 27676
           Summary: Typography makes it extremely difficult to find the
                    definition of a built-in template
           Product: XPath / XQuery / XSLT
           Version: Last Call drafts
          Hardware: PC
                OS: Windows NT
            Status: NEW
          Severity: normal
          Priority: P2
         Component: XSLT 3.0
          Assignee: mike@saxonica.com
          Reporter: dnovatchev@gmail.com
        QA Contact: public-qt-comments@w3.org

In section "6.7.1 Built-in Templates: Text-only Copy" at
http://www.w3.org/TR/2014/WD-xslt-30-20141002/#built-in-templates-text-only-copy,
we read:

"The built-in template rule for text and attribute nodes returns a text node
containing the string value of the context node. It is effectively:

<xsl:template match="text()|@*" mode="M">
  <xsl:value-of select="string(.)"/>
</xsl:template>
Note:

This text node may have a string value that is zero-length.

diff="chg" at="R-bug26751">The built-in template rule atomic values returns a
text node containing the value. It is effectively:

<xsl:template match=".[. instance of xs:anyAtomicType]" mode="M">
  <xsl:value-of select="string(.)"/>
</xsl:template>
Note:

This text node may have a string value that is zero-length.

The built-in template rule for processing instructions, comments, and namespace
nodes does nothing (it returns the empty sequence)."



It is very difficult to notice that the quoted text actually contains the
definitions for two built-in templates, the second being buried inside a Note
for the first definition. Also, it seems that the displayed string 'diff="chg"
at="R-bug26751">' is the result of accident and this may be the cause of the
way the text is displayed (both in Chrome and IE11).

Because of the importance of built-in templates in the language, any reader
would expect any built-in template definition to be clearly visible and not
hidden among other text. Besides correcting the typography, adding a TOC entry
for every built-in template will significantly improve the quality of the
document.

Dimitre Novatchev

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

Received on Friday, 19 December 2014 19:24:36 UTC