From 8778b70aef35e2895c4d64cbadd571dfd3bb89f6 Mon Sep 17 00:00:00 2001
From: Norman Walsh <ndw@nwalsh.com>
Date: Fri, 28 Oct 2005 12:35:15 +0000
Subject: [PATCH] New parameter: id.warnings. If non-zero, warnings are
 generated for titled objects that don't have titles. True by default; I
 wonder if this will be too aggressive?

---
 xsl/html/biblio.xsl        |  4 ++++
 xsl/html/component.xsl     | 12 ++++++++++++
 xsl/html/division.xsl      |  8 ++++++++
 xsl/html/formal.xsl        |  2 ++
 xsl/html/glossary.xsl      |  6 ++++++
 xsl/html/html.xsl          | 38 ++++++++++++++++++++++++++++++++++++++
 xsl/html/index.xsl         |  6 ++++++
 xsl/html/param.ent         |  1 +
 xsl/html/param.xweb        |  2 ++
 xsl/html/refentry.xsl      |  4 ++++
 xsl/html/sections.xsl      | 16 ++++++++++++++++
 xsl/params/id.warnings.xml | 24 ++++++++++++++++++++++++
 12 files changed, 123 insertions(+)
 create mode 100644 xsl/params/id.warnings.xml

diff --git a/xsl/html/biblio.xsl b/xsl/html/biblio.xsl
index 9ff9fa366..ffb243ef9 100644
--- a/xsl/html/biblio.xsl
+++ b/xsl/html/biblio.xsl
@@ -15,6 +15,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="bibliography">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:if test="$generate.id.attributes != 0">
       <xsl:attribute name="id">
@@ -40,6 +42,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="bibliodiv">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:apply-templates/>
   </div>
diff --git a/xsl/html/component.xsl b/xsl/html/component.xsl
index 0c2f8f16b..75b9b2cc4 100644
--- a/xsl/html/component.xsl
+++ b/xsl/html/component.xsl
@@ -73,6 +73,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="dedication" mode="dedication">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -104,6 +106,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="colophon">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -131,6 +135,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="preface">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -186,6 +192,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="chapter">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -244,6 +252,8 @@
     <xsl:call-template name="chunk"/>
   </xsl:variable>
 
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -315,6 +325,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="article">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
diff --git a/xsl/html/division.xsl b/xsl/html/division.xsl
index 15bf0531c..50799c9a6 100644
--- a/xsl/html/division.xsl
+++ b/xsl/html/division.xsl
@@ -15,6 +15,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="set">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -51,6 +53,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="book">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -89,6 +93,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="part">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -129,6 +135,8 @@
 <xsl:template match="part/subtitle"></xsl:template>
 
 <xsl:template match="partintro">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
diff --git a/xsl/html/formal.xsl b/xsl/html/formal.xsl
index deed85446..0bf5fb986 100644
--- a/xsl/html/formal.xsl
+++ b/xsl/html/formal.xsl
@@ -16,6 +16,8 @@
   <xsl:param name="placement" select="'before'"/>
   <xsl:param name="class" select="local-name(.)"/>
 
+  <xsl:call-template name="id.warning"/>
+
   <div class="{$class}">
     <xsl:call-template name="anchor">
       <xsl:with-param name="conditional" select="0"/>
diff --git a/xsl/html/glossary.xsl b/xsl/html/glossary.xsl
index afad5f847..8ca0223b5 100644
--- a/xsl/html/glossary.xsl
+++ b/xsl/html/glossary.xsl
@@ -15,6 +15,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="glossary">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:if test="$generate.id.attributes != 0">
       <xsl:attribute name="id">
@@ -72,6 +74,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="glossdiv">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:apply-templates select="(glossentry[1]/preceding-sibling::*)"/>
 
@@ -297,6 +301,8 @@ GlossEntry ::=
   <xsl:variable name="terms" select="//glossterm[not(parent::glossdef)]|//firstterm"/>
   <xsl:variable name="collection" select="document($glossary.collection, .)"/>
 
+  <xsl:call-template name="id.warning"/>
+
   <xsl:if test="$glossary.collection = ''">
     <xsl:message>
       <xsl:text>Warning: processing automatic glossary </xsl:text>
diff --git a/xsl/html/html.xsl b/xsl/html/html.xsl
index 15fd486e9..e14a7b784 100644
--- a/xsl/html/html.xsl
+++ b/xsl/html/html.xsl
@@ -122,5 +122,43 @@
   </xsl:choose>
 </xsl:template>
 
+<xsl:template name="id.warning">
+  <xsl:if test="not(@id) and not(@xml:id) and parent::*">
+    <xsl:variable name="title">
+      <xsl:choose>
+	<xsl:when test="title">
+	  <xsl:value-of select="title[1]"/>
+	</xsl:when>
+	<xsl:when test="contains(local-name(*[1]),'info')">
+	  <xsl:value-of select="*[1]/title[1]"/>
+	</xsl:when>
+	<xsl:when test="refmeta/refentrytitle">
+	  <xsl:value-of select="refmeta/refentrytitle"/>
+	</xsl:when>
+	<xsl:when test="refnamediv/refname">
+	  <xsl:value-of select="refnamediv/refname[1]"/>
+	</xsl:when>
+      </xsl:choose>
+    </xsl:variable>
+
+    <xsl:message>
+      <xsl:text>ID recommended on </xsl:text>
+      <xsl:value-of select="local-name(.)"/>
+      <xsl:if test="$title != ''">
+	<xsl:text>: </xsl:text>
+	<xsl:choose>
+	  <xsl:when test="string-length($title) &gt; 40">
+	    <xsl:value-of select="substring($title,1,40)"/>
+	    <xsl:text>...</xsl:text>
+	  </xsl:when>
+	  <xsl:otherwise>
+	    <xsl:value-of select="$title"/>
+	  </xsl:otherwise>
+	</xsl:choose>
+      </xsl:if>
+    </xsl:message>
+  </xsl:if>
+</xsl:template>
+
 </xsl:stylesheet>
 
diff --git a/xsl/html/index.xsl b/xsl/html/index.xsl
index 352f50f31..d7c9cf660 100644
--- a/xsl/html/index.xsl
+++ b/xsl/html/index.xsl
@@ -21,6 +21,8 @@
   <!-- is non-zero, in which case, this is where the automatically -->
   <!-- generated index should go. -->
 
+  <xsl:call-template name="id.warning"/>
+
   <xsl:if test="count(*)>0 or $generate.index != '0'">
     <div class="{name(.)}">
       <xsl:if test="$generate.id.attributes != 0">
@@ -73,6 +75,8 @@
   <!-- is non-zero, in which case, this is where the automatically -->
   <!-- generated index should go. -->
 
+  <xsl:call-template name="id.warning"/>
+
   <xsl:if test="count(*)>0 or $generate.index != '0'">
     <div class="{name(.)}">
       <xsl:if test="$generate.id.attributes != 0">
@@ -104,6 +108,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="indexdiv">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:if test="$generate.id.attributes != 0">
       <xsl:attribute name="id">
diff --git a/xsl/html/param.ent b/xsl/html/param.ent
index db3ad4c9c..bc04b4bbf 100644
--- a/xsl/html/param.ent
+++ b/xsl/html/param.ent
@@ -279,3 +279,4 @@
 <!ENTITY annotation.graphic.close SYSTEM "../params/annotation.graphic.close.xml">
 <!ENTITY annotation.css SYSTEM "../params/annotation.css.xml">
 <!ENTITY keep.relative.image.uris SYSTEM "../params/keep.relative.image.uris.xml">
+<!ENTITY id.warnings SYSTEM "../params/id.warnings.xml">
diff --git a/xsl/html/param.xweb b/xsl/html/param.xweb
index 281ff739c..b1d1d273f 100644
--- a/xsl/html/param.xweb
+++ b/xsl/html/param.xweb
@@ -157,6 +157,7 @@ stylesheet like this:</para>
 &suppress.footer.navigation;
 &header.rule;
 &footer.rule;
+&id.warnings;
 </reference>
 
 <reference id="meta"><title>Meta/*Info</title>
@@ -584,6 +585,7 @@ around all these parameters.</para>
 <src:fragref linkend="htmlhelp.use.hhk.frag"/>
 <src:fragref linkend="htmlhelp.window.geometry.frag"/>
 <src:fragref linkend="img.src.path.frag"/>
+<src:fragref linkend="id.warnings.frag"/>
 <src:fragref linkend="index.on.role.frag"/>
 <src:fragref linkend="index.on.type.frag"/>
 <src:fragref linkend="index.prefer.titleabbrev.frag"/>
diff --git a/xsl/html/refentry.xsl b/xsl/html/refentry.xsl
index 28389083d..fa21b88c9 100644
--- a/xsl/html/refentry.xsl
+++ b/xsl/html/refentry.xsl
@@ -15,6 +15,8 @@
 <!-- ==================================================================== -->
 
 <xsl:template match="reference">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -81,6 +83,8 @@
 </xsl:template>
 
 <xsl:template match="refentry">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
diff --git a/xsl/html/sections.xsl b/xsl/html/sections.xsl
index 50106a98c..6628cc9cf 100644
--- a/xsl/html/sections.xsl
+++ b/xsl/html/sections.xsl
@@ -17,6 +17,8 @@
 <xsl:template match="section">
   <xsl:variable name="depth" select="count(ancestor::section)+1"/>
 
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -92,6 +94,8 @@
 </xsl:template>
 
 <xsl:template match="sect1">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -139,6 +143,8 @@
 </xsl:template>
 
 <xsl:template match="sect2">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -182,10 +188,14 @@
 </xsl:template>
 
 <xsl:template match="sect2/title" mode="titlepage.mode" priority="2">
+  <xsl:call-template name="id.warning"/>
+
   <xsl:call-template name="section.title"/>
 </xsl:template>
 
 <xsl:template match="sect3">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -233,6 +243,8 @@
 </xsl:template>
 
 <xsl:template match="sect4">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -280,6 +292,8 @@
 </xsl:template>
 
 <xsl:template match="sect5">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
@@ -327,6 +341,8 @@
 </xsl:template>
 
 <xsl:template match="simplesect">
+  <xsl:call-template name="id.warning"/>
+
   <div class="{name(.)}">
     <xsl:call-template name="dir">
       <xsl:with-param name="inherit" select="1"/>
diff --git a/xsl/params/id.warnings.xml b/xsl/params/id.warnings.xml
new file mode 100644
index 000000000..37be8e6eb
--- /dev/null
+++ b/xsl/params/id.warnings.xml
@@ -0,0 +1,24 @@
+<refentry id="id.warnings">
+<refmeta>
+<refentrytitle>id.warnings</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>id.warnings</refname>
+<refpurpose>Should warnings be generated for titled elements without IDs?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='id.warnings.frag'>
+<xsl:param name="id.warnings" select="1"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If non-zero, the stylesheet will issue a warning for
+any element (other than the root element) which
+has a title but does not have an ID.</para>
+
+</refsect1>
+</refentry>
-- 
2.40.0