[Koha-patches] [PATCH] [SIGNED-OFF] Bug 6152: Document DOM authority index config

[Frédéric Demians]

From: Jared Camins-Esakov <jcamins at bywatersolutions.com>

Add a note so developers know not to edit authority-zebra-indexdefs.xsl directly
but to instead edit authority-koha-indexdefs.xml and use the
koha-indexdefs-to-zebra.xsl stylesheet to generate the former from the latter.

Signed-off-by: Frédéric Demians <f.demians at tamil.fr>
---
 .../authorities/authority-koha-indexdefs.xml       |    6 ++++++
 .../authorities/authority-zebra-indexdefs.xsl      |    8 ++++++++
 .../marc21/authorities/koha-indexdefs-to-zebra.xsl |    8 ++++++++
 3 files changed, 22 insertions(+), 0 deletions(-)

diff --git a/etc/zebradb/marc_defs/marc21/authorities/authority-koha-indexdefs.xml b/etc/zebradb/marc_defs/marc21/authorities/authority-koha-indexdefs.xml
index 2515317..87d31bc 100644
--- a/etc/zebradb/marc_defs/marc21/authorities/authority-koha-indexdefs.xml
+++ b/etc/zebradb/marc_defs/marc21/authorities/authority-koha-indexdefs.xml
@@ -1,4 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!-- This is the canonical source for the authority DOM indexing configuration
+for MARC21. To generate the authority-zebra-indexdefs.xsl file that Zebra uses,
+run the following command:
+`xsltproc koha-indexdefs-to-zebra.xsl authority-koha-indexdefs.xml >
+authority-zebra-indexdefs.xsl`
+-->
 <kohaidx:index_defs xmlns:kohaidx="http://www.koha-community.org/schemas/index-defs">
   <!-- variables -->
   <kohaidx:var name="form_subdivision_subfield">v</kohaidx:var>
diff --git a/etc/zebradb/marc_defs/marc21/authorities/authority-zebra-indexdefs.xsl b/etc/zebradb/marc_defs/marc21/authorities/authority-zebra-indexdefs.xsl
index 9538e6f..5c37bc6 100644
--- a/etc/zebradb/marc_defs/marc21/authorities/authority-zebra-indexdefs.xsl
+++ b/etc/zebradb/marc_defs/marc21/authorities/authority-zebra-indexdefs.xsl
@@ -1,4 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+This file has been automatically generated from a Koha index definition file
+with the stylesheet koha-indexdefs-to-zebra.xsl. Do not manually edit this file,
+as it may be overwritten. To regenerate, edit the appropriate Koha index
+definition file (probably something like authority-koha-indexdefs.xml) and run:
+`xsltproc koha-indexdefs-to-zebra.xsl authority-koha-indexdefs.xml >
+authority-zebra-indexdefs.xsl` (substituting the appropriate file names).
+-->
 <xslo:stylesheet xmlns:xslo="http://www.w3.org/1999/XSL/Transform" xmlns:marc="http://www.loc.gov/MARC21/slim" xmlns:z="http://indexdata.com/zebra-2.0" xmlns:kohaidx="http://www.koha-community.org/schemas/index-defs" version="1.0">
   <xslo:output indent="yes" method="xml" version="1.0" encoding="UTF-8"/>
   <xslo:template match="text()"/>
diff --git a/etc/zebradb/marc_defs/marc21/authorities/koha-indexdefs-to-zebra.xsl b/etc/zebradb/marc_defs/marc21/authorities/koha-indexdefs-to-zebra.xsl
index d466611..66bf816 100644
--- a/etc/zebradb/marc_defs/marc21/authorities/koha-indexdefs-to-zebra.xsl
+++ b/etc/zebradb/marc_defs/marc21/authorities/koha-indexdefs-to-zebra.xsl
@@ -18,6 +18,14 @@
     <xsl:key name="index_match_heading_tag" match="kohaidx:index_match_heading" use="@tag"/>
 
     <xsl:template match="kohaidx:index_defs">
+    <xsl:comment>
+This file has been automatically generated from a Koha index definition file
+with the stylesheet koha-indexdefs-to-zebra.xsl. Do not manually edit this file,
+as it may be overwritten. To regenerate, edit the appropriate Koha index
+definition file (probably something like authority-koha-indexdefs.xml) and run:
+`xsltproc koha-indexdefs-to-zebra.xsl authority-koha-indexdefs.xml >
+authority-zebra-indexdefs.xsl` (substituting the appropriate file names).
+</xsl:comment>
         <xslo:stylesheet version="1.0">
             <xslo:output indent="yes" method="xml" version="1.0" encoding="UTF-8"/>
             <xslo:template match="text()"/>
-- 
1.7.4