Globally rename document parts

PreTeXtBook · Jun 19, 2015 · 31a2bdd · 31a2bdd
1 parent ca15b4c
commit 31a2bdd
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 3 deletions.
diff --git a/examples/sample-article.xml b/examples/sample-article.xml
@@ -103,6 +103,24 @@ the xsltproc executable.
             <url>not-implemented.html</url>
              <!-- <text>My Button Text</text>  -->
         </feedback>
+
+        <!--
+        "Names" for various parts of a document are determined exactly
+        once for each language, ensuring consistency and saving you the
+        bother of always typing them in.  These can be found in the
+        xsl/mathbook-localization.xsl file.
+
+        You can make a document-specific, global override.  Here we
+        decide we have no need for any "proposition"s and repurpose
+        that enviroment in US English as a "Conundrum."
+
+        See the localization file for more on language codes, and realize
+        that US English is the default if there is no "lang" attribute
+        given on the document.
+        -->
+        <rename element="proposition" lang="en-US">Conundrum</rename>
+
+
     </docinfo>
 
     <!--
@@ -2067,6 +2085,7 @@ the xsltproc executable.
                 <li><p>Equations: single, first with no name: <xref ref="equation-alternate-FTC" />.  Then with an autoname: <xref ref="equation-alternate-FTC" autoname="yes" />.</p></li>
                 <li><p>Equations: multi-row, first with no name: <xref ref="equation-use-FTC" />.  Then with an autoname: <xref ref="equation-use-FTC" autoname="yes" />.  And two, exercising plural form: <xref ref="equation-alternate-FTC" autoname="plural" /> and <xref ref="equation-use-FTC" />.</p></li>
                 <li><p>A range of exercises, with plural and no autonaming: <xref ref="exercises-null-problem" autoname="plural" /><ndash /><xref ref="exercises-cosine-derivative" autoname="no" />.</p></li>
+                <li><p>A link to a <c>proposition</c> element, while this document has globally renamed <c>proposition</c>s as <q>Conundrum</q>s, so this link should use the new name: <xref ref="proposition-as-conundrum" autoname="yes" /></p></li>
             </ul>
 
         </section>
@@ -2903,6 +2922,36 @@ the xsltproc executable.
 
         </section>
 
+        <section>
+            <title>Customizations</title>
+
+            <subsection>
+                <title>Renaming Document Parts</title>
+
+                <p><q>Names</q> for various parts of a document are determined exactly once for each language, ensuring consistency and saving you the bother of always typing them in.</p>
+
+                <p>However, you may want to have <q>Conundrum</q>s in your document and you have no use for any <q>Proposition</q>s.  So you can repurpose the <c>proposition</c> tag to render a different name.  Or you might have a Lab Manual and want to rename <c>subsection</c> as <q>Activity</q>.  See the <c>docinfo</c> portion of this sample article to see how this is done, in concert with the example below.</p>
+
+                <proposition xml:id="proposition-as-conundrum">
+                    <statement>
+                        <p>Aah, this <em>is</em> confusing!</p>
+                    </statement>
+                </proposition>
+
+                <paragraphs>
+                    <title>Important Notes</title>
+
+                    <p>If you are renaming many parts of your document, then you may not understand the design philosophy of MathBook XML.  In particular, you should not be doing a wholesale shuffle of <c>part</c>, <c>chapter</c>, <c>section</c>, <etc />  This feature is intended for very limited use and is <em>not considered best practice</em>.</p>
+
+                    <p>This feature could also be abused to provide a comprehensive suite of translations into a language not yet supported.  If so, please contact us about moving your translations into MathBook XML for the benefit of all.  Thanks.</p>
+                </paragraphs>
+
+            </subsection>
+
+        </section>
+
+
+
         <!-- Bibliography/References can appear anywhere -->
 
         <references>

diff --git a/xsl/mathbook-common.xsl b/xsl/mathbook-common.xsl
@@ -851,9 +851,18 @@ along with MathBook XML.  If not, see <http://www.gnu.org/licenses/>.
 <xsl:template name="type-name">
     <xsl:param name="string-id" />
     <xsl:variable name="translation">
-        <xsl:for-each select="document('mathbook-localization.xsl')">
-            <xsl:value-of select="key('localization-key', concat($document-language,$string-id) )"/>
-        </xsl:for-each>
+        <xsl:choose>
+            <!-- First look in docinfo for document-specific rename -->
+            <xsl:when test="/mathbook/docinfo/rename[@element=$string-id and @lang=$document-language]">
+                <xsl:apply-templates select="/mathbook/docinfo/rename[@element=$string-id and @lang=$document-language]" />
+            </xsl:when>
+            <!-- default to a lookup from the localization file -->
+            <xsl:otherwise>
+                <xsl:for-each select="document('mathbook-localization.xsl')">
+                    <xsl:value-of select="key('localization-key', concat($document-language,$string-id) )"/>
+                </xsl:for-each>
+            </xsl:otherwise>
+        </xsl:choose>
     </xsl:variable>
     <xsl:choose>
         <xsl:when test="$translation!=''"><xsl:value-of select="$translation" /></xsl:when>