README encoding improvements ala #2070 (#2494)

* Use <name>, not <idno> (nor just plain text) for element and class names in READMEs. * Various minor improvements based on note [2] of #2070.
TEIC · Nov 9, 2023 · 8ddff14 · 8ddff14
1 parent 023167f
commit 8ddff14
Show file tree

Hide file tree

Showing 40 changed files with 668 additions and 1,571 deletions.
diff --git a/P5/Makefile b/P5/Makefile
@@ -257,7 +257,7 @@ readus:
 	cp VERSION release/tei-p5-doc/share/doc/tei-p5-doc
 	@echo BUILD: Make web pages for release notes
 	for i in ReleaseNotes/readme*xml; do \
-	echo ${ANT} -f ${XSL}/html/build-to.xml -lib Utilities/lib/${SAXONJAR} -Dprofiledir=${XSL}/profiles -Dprofile=readme \
+	${ANT} -f ${XSL}/html/build-to.xml -lib Utilities/lib/${SAXONJAR} -Dprofiledir=${XSL}/profiles -Dprofile=readme \
 	-DinputFile=`pwd`/$$i -DoutputFile=`pwd`/release/tei-p5-doc/share/doc/tei-p5-doc/`basename $$i .xml`.html; \
 	done
 

diff --git a/P5/ReleaseNotes/readme-0.4.1.xml b/P5/ReleaseNotes/readme-0.4.1.xml
@@ -31,8 +31,7 @@
 	<list>
 	  <item>Revision of the TEI class system continues, with the definition
 	    of several new classes following on from a systematic review of all
-	    content models by the Council (see <ptr
-	      target="http://www.tei-c.org/Council/tcw07.xml"/>).</item>
+	    content models by the Council (see <ptr target="http://www.tei-c.org/Council/tcw07.xml"/>).</item>
 
 	  <item>
 	    Detailed proposals for the encoding of personal data (for example in

diff --git a/P5/ReleaseNotes/readme-0.6.xml b/P5/ReleaseNotes/readme-0.6.xml
@@ -28,9 +28,7 @@
     <body>
 
       <p>Changes since the last packaged release (0.5, October 2006)
-      are listed briefly below (please refer to the file <name
-      type="file">ChangeLog</name> in directory <name
-      type="dir">ReleaseNotes</name> at the Sourceforge archive for a
+      are listed briefly below (please refer to the file <name type="file">ChangeLog</name> in directory <name type="dir">ReleaseNotes</name> at the Sourceforge archive for a
       full list).</p>
 
       <p>This (somewhat delayed) release contains a large number of

diff --git a/P5/ReleaseNotes/readme-1.1.xml b/P5/ReleaseNotes/readme-1.1.xml
@@ -19,17 +19,15 @@
       </sourceDesc>
     </fileDesc>
     <revisionDesc>
-      <change who="http://users.ox.ac.uk/~lou"
-	      when="2007-07-28">created retrospectively from svn ChangeLog</change>
+      <change who="http://users.ox.ac.uk/~lou" when="2007-07-28">created retrospectively from svn ChangeLog</change>
     </revisionDesc>
   </teiHeader>
   <text>
     <body>
 
       <p>This is a maintenance release, implementing several changes
             agreed following the review of outstanding feature requests
-	    undertaken at the Council meeting in Galway in April (see <ref
-	    target="http://www.tei-c.org/Council/Working/tcw12.xml">Working
+	    undertaken at the Council meeting in Galway in April (see <ref target="http://www.tei-c.org/Council/Working/tcw12.xml">Working
 	    Paper TCW12</ref> for a complete list)</p>
 
 <p>In addition to these specific responses to feature requests, a

diff --git a/P5/ReleaseNotes/readme-1.2.xml b/P5/ReleaseNotes/readme-1.2.xml
@@ -19,8 +19,7 @@
       </sourceDesc>
     </fileDesc>
     <revisionDesc>
-      <change who="http://users.ox.ac.uk/~lou"
-	      when="2007-10-28">created retrospectively from svn ChangeLog</change>
+      <change who="http://users.ox.ac.uk/~lou" when="2007-10-28">created retrospectively from svn ChangeLog</change>
     </revisionDesc>
   </teiHeader>
   <text>
@@ -49,14 +48,14 @@ them to declare @type locally (1848442 1970880 2100015)</item>
 <item>Clarified and exemplified use of <att>period</att> attribute
 (1927987)</item>
 <item>Changed <gi>egXML</gi> so that its content references a
-new macro <ident>anyXML</ident>; this has the side effect that DTD
-language cannot be used (2021933). </item>
-<item>Introduced new class <ident>att.canonical</ident> to support all kinds of
+new macro <name type="macro">anyXML</name>; this has the side effect that DTD
+language cannot be used (2021933).</item>
+<item>Introduced new class <name type="class">att.canonical</name> to support all kinds of
 canonical name referencing (1852101 1977702)</item>
 <item>Changed content model for <gi>monogr</gi> to permit <gi>idno</gi>
 (1930148)</item>
 <item>Made consistent usage of @extent as alternative to other more
-precise attributes inherited from <ident>att.dimensions</ident> (1925125)</item>
+precise attributes inherited from <name type="class">att.dimensions</name> (1925125)</item>
 <item>Merged in French translations for <gi>remarks</gi> components of
 all element specifications, completed Chinese translations of
 descriptions, and added Korean translations</item>

diff --git a/P5/ReleaseNotes/readme-1.3.xml b/P5/ReleaseNotes/readme-1.3.xml
@@ -18,8 +18,7 @@
       </sourceDesc>
     </fileDesc>
     <revisionDesc>
-      <change who="http://users.ox.ac.uk/~lou"
-	      when="2009-02-01"/>
+      <change who="http://users.ox.ac.uk/~lou" when="2009-02-01"/>
     </revisionDesc>
   </teiHeader>
   <text>

diff --git a/P5/ReleaseNotes/readme-1.4.xml b/P5/ReleaseNotes/readme-1.4.xml
@@ -18,8 +18,7 @@
       </sourceDesc>
     </fileDesc>
     <revisionDesc>
-      <change who="http://users.ox.ac.uk/~lou"
-	      when="2009-06-20"/>
+      <change who="http://users.ox.ac.uk/~lou" when="2009-06-20"/>
     </revisionDesc>
   </teiHeader>
   <text>

diff --git a/P5/ReleaseNotes/readme-1.5.xml b/P5/ReleaseNotes/readme-1.5.xml
@@ -85,6 +85,3 @@ class so that it can appear at either end of a <gi>div</gi>
     </body>
   </text>
 </TEI>
-
-
-
diff --git a/P5/ReleaseNotes/readme-1.6.xml b/P5/ReleaseNotes/readme-1.6.xml
@@ -101,6 +101,3 @@ model.respLike (2881416) </item>
     </body>
   </text>
 </TEI>
-
-
-
diff --git a/P5/ReleaseNotes/readme-1.7.xml b/P5/ReleaseNotes/readme-1.7.xml
@@ -86,6 +86,3 @@ elements which can appear within choice (2834505)</item>
 </p>    </body>
   </text>
 </TEI>
-
-
-
diff --git a/P5/ReleaseNotes/readme-1.9.xml b/P5/ReleaseNotes/readme-1.9.xml
@@ -43,11 +43,11 @@
 	in the process had allowed some invalid ones through).</item>
 
 	<item>All elements have been changed to make them explicit members of 
-	the <ident>att.global</ident> attribute class, rather than having this
+	the <name type="class">att.global</name> attribute class, rather than having this
 	done by special-case processing during the build
 	procedure. This means that any ODD which defines elements in
 	the TEI namespace will have to explicitly add
-	<ident>att.global</ident> to them.</item>
+	<name type="class">att.global</name> to them.</item>
 
 	<item>The Guidelines are now available in ePub and Kindle formats.</item>
       </list>
@@ -64,29 +64,25 @@
 	<row>
 	  <cell>2011-02</cell>
 	  <cell>Add @valid to egXML</cell>
-	  <cell><ptr
-	  target="https://sourceforge.net/tracker/?func=detail&amp;aid=3156049&amp;group_id=106328&amp;atid=644065"/>
+	  <cell><ptr target="https://sourceforge.net/tracker/?func=detail&amp;aid=3156049&amp;group_id=106328&amp;atid=644065"/>
 	  </cell>
 	</row>
 	<row>
 	  <cell>2011-02</cell>
 	  <cell>Make all elements explicit members of
 	  att.global</cell>
-	  <cell><ptr
-	  target="https://sourceforge.net/tracker/?func=detail&amp;aid=2994685&amp;group_id=106328&amp;atid=644065"/>
+	  <cell><ptr target="https://sourceforge.net/tracker/?func=detail&amp;aid=2994685&amp;group_id=106328&amp;atid=644065"/>
 	  </cell>
 	</row>
 	<row>
 	  <cell>2011-02</cell>
 	  <cell>make <gi>collection</gi> typeable</cell>
-	  <cell><ptr
-	  target="https://sourceforge.net/tracker/?func=detail&amp;atid=644065&amp;aid=3114917&amp;group_id=106328"/></cell>
+	  <cell><ptr target="https://sourceforge.net/tracker/?func=detail&amp;atid=644065&amp;aid=3114917&amp;group_id=106328"/></cell>
 	</row>
 	<row>
 	  <cell>2011-02</cell>
 	  <cell>allow <gi>date</gi> as child of <gi>analytic</gi></cell>
-	  <cell><ptr
-	  target="http://sourceforge.net/tracker/?func=detail&amp;aid=3168838&amp;group_id=106328&amp;atid=644065"/></cell>
+	  <cell><ptr target="http://sourceforge.net/tracker/?func=detail&amp;aid=3168838&amp;group_id=106328&amp;atid=644065"/></cell>
 	</row>
 	</table>
     </body>

diff --git a/P5/ReleaseNotes/readme-2.0.1.xml b/P5/ReleaseNotes/readme-2.0.1.xml
@@ -39,8 +39,7 @@ for this release:
       <list type="ordered">
 	<item>Several new elements have been introduced to facilitate
 	a more "document-focussed" (as opposed to "text-focussed") way
-	of working, following extensive work within the <ref
-	target="http://wiki.tei-c.org/index.php/Genetic_Editions">TEI
+	of working, following extensive work within the <ref target="http://wiki.tei-c.org/index.php/Genetic_Editions">TEI
 	Special Interest Group on Genetic Editing</ref> and
 	elsewhere. A new <gi>sourceDoc</gi> element can now be used to
 	organize digital images of a source document in much the same
@@ -60,12 +59,11 @@ for this release:
 (moving to a dual license model of CC-BY and BSD2 for most TEI
 outputs), and made more evident; the source code tree was
 tidied up, with all unused items being moved out; some old annoyances
-— notably the meaningless distinction between "mwa" and "opt" as
-properties of attributes — were
+&#x2014; notably the meaningless distinction between "mwa" and "opt" as
+properties of attributes &#x2014; were
 removed </item>
 
-<item>Following extensive work by the <ref
-target="wiki.tei-c.org/index.php/SIG:Music">Special Interest Group in
+<item>Following extensive work by the <ref target="https://wiki.tei-c.org/index.php/SIG:Music">Special Interest Group in
 Music</ref>, a new <gi>notatedMusic</gi> element was added to support
 representation of musical notation within texts in a way compatible
 with the existing Music Encoding Initiative and MusicXML standards. </item>

diff --git a/P5/ReleaseNotes/readme-2.0.2.xml b/P5/ReleaseNotes/readme-2.0.2.xml
@@ -36,7 +36,7 @@
         substantive change:</p>
 
       <list type="ordered">
-        <item><gi>geo</gi> has been added to the class <ident>att.declaring</ident>.</item>
+        <item><gi>geo</gi> has been added to the class <name type="class">att.declaring</name>.</item>
 
         </list>
 
@@ -58,8 +58,7 @@ for this release:
       <list type="ordered">
 	<item>Several new elements have been introduced to facilitate
 	a more "document-focussed" (as opposed to "text-focussed") way
-	of working, following extensive work within the <ref
-	target="http://wiki.tei-c.org/index.php/Genetic_Editions">TEI
+	of working, following extensive work within the <ref target="http://wiki.tei-c.org/index.php/Genetic_Editions">TEI
 	Special Interest Group on Genetic Editing</ref> and
 	elsewhere. A new <gi>sourceDoc</gi> element can now be used to
 	organize digital images of a source document in much the same
@@ -79,12 +78,11 @@ for this release:
 (moving to a dual license model of CC-BY and BSD2 for most TEI
 outputs), and made more evident; the source code tree was
 tidied up, with all unused items being moved out; some old annoyances
-— notably the meaningless distinction between "mwa" and "opt" as
-properties of attributes — were
+&#x2014; notably the meaningless distinction between "mwa" and "opt" as
+properties of attributes &#x2014; were
 removed </item>
 
-<item>Following extensive work by the <ref
-target="wiki.tei-c.org/index.php/SIG:Music">Special Interest Group in
+<item>Following extensive work by the <ref target="https://wiki.tei-c.org/index.php/SIG:Music">Special Interest Group in
 Music</ref>, a new <gi>notatedMusic</gi> element was added to support
 representation of musical notation within texts in a way compatible
 with the existing Music Encoding Initiative and MusicXML standards. </item>

diff --git a/P5/ReleaseNotes/readme-2.0.xml b/P5/ReleaseNotes/readme-2.0.xml
@@ -36,8 +36,7 @@ for this release:
       <list type="ordered">
 	<item>Several new elements have been introduced to facilitate
 	a more "document-focussed" (as opposed to "text-focussed") way
-	of working, following extensive work within the <ref
-	target="http://wiki.tei-c.org/index.php/Genetic_Editions">TEI
+	of working, following extensive work within the <ref target="http://wiki.tei-c.org/index.php/Genetic_Editions">TEI
 	Special Interest Group on Genetic Editing</ref> and
 	elsewhere. A new <gi>document</gi> element can now be used to
 	organize digital images of a source document in much the same
@@ -57,12 +56,11 @@ for this release:
 (moving to a dual license model of CC-BY and BSD2 for most TEI
 outputs), and made more evident; the source code tree was
 tidied up, with all unused items being moved out; some old annoyances
-— notably the meaningless distinction between "mwa" and "opt" as
-properties of attributes — were
+&#x2014; notably the meaningless distinction between "mwa" and "opt" as
+properties of attributes &#x2014; were
 removed </item>
 
-<item>Following extensive work by the <ref
-target="wiki.tei-c.org/index.php/SIG:Music">Special Interest Group in
+<item>Following extensive work by the <ref target="https://wiki.tei-c.org/index.php/SIG:Music">Special Interest Group in
 Music</ref>, a new <gi>notatedMusic</gi> element was added to support
 representation of musical notation within texts in a way compatible
 with the existing Music Encoding Initiative and MusicXML standards. </item>

diff --git a/P5/ReleaseNotes/readme-2.1.0.xml b/P5/ReleaseNotes/readme-2.1.0.xml
@@ -39,8 +39,8 @@ variations. </p>
 <p> Since the last release (14 February 2012), the Council has
 considered and disposed of 70 tickets entered in the sourceforge
 tracking system, from 15 different members of the TEI community.  Full
-details may be found at http://tei.sf.net : an active list sorted by ticket
-number is available at the url http://bit.ly/N2P9Q2 and ticket numbers are also
+details may be found at <ptr target="http://tei.sf.net"/>: an active list sorted by ticket
+number is available at the url <ptr target="http://bit.ly/N2P9Q2"/> and ticket numbers are also
 referenced in the subversion ChangeLog, as usual.</p>
 <div><head>Schema Changes</head>
 <p>These changes should not affect existing documents,
@@ -54,17 +54,17 @@ modified to remove some inappropriate restrictions (3449887, 1650195, 3437782,
 3441658, 3305016)</item>
 <item>Additional schematron constraints have been implemented for
 several elements, notably for <gi>attDef</gi>, <gi>delSpan</gi> and
-other members of the <ident>att.spanning</ident> class.</item>
-<item>A new class <ident>att.datcat</ident> has been introduced to
+other members of the <name type="class">att.spanning</name> class.</item>
+<item>A new class <name type="class">att.datcat</name> has been introduced to
 permit the use of ISO Standard Data Category Registry values where
 appropriate (3432520)</item>
 <item>The attribute <att>version</att> has been renamed
 <att>versionDate</att> to clarify its function (3393781)</item>
-<item>A new class <ident type="class">att.witnessed</ident> was
+<item>A new class <name type="class">att.witnessed</name> was
 introduced to ensure that only appropriate elements carry the
 <att>wit</att> attribute (3496951)</item>
 <item>A new attribute <att>targetLang</att> was added to the
-<ident>att.pointing</ident> class to specify the
+<name type="class">att.pointing</name> class to specify the
 language of the content of an element being pointed to  (3288293)</item>
 
 <!--
@@ -129,7 +129,7 @@ versions of the Guidelines, notably to ensure that only  open source
 fonts are used throughout; </item>
 <item>a large number of typos were corrected,  many of them reported by
 a few careful proofreaders from the TEI Community (particular thanks
-this time to Jens Østergaard Petersen and to Pablo Rodriguez who
+this time to Jens &#xD8;stergaard Petersen and to Pablo Rodriguez who
 between them reported over 30 errors!)</item>
 </list>
 </p>
@@ -276,7 +276,7 @@ have seen a large number of changes since the Council decided to
 ensure that a TEI P5 Release could be tested and delivered by any
 Council member. Full details of the procedure for doing this are
 now provided in a Council working Paper available at
-http://www.tei-c.org/Activities/Council/Working/tcw22.xml. </p>
+<ptr target="http://www.tei-c.org/Activities/Council/Working/tcw22.xml"/>. </p>
 
 <!--
 stormy corner
Original file line number	Diff line number	Diff line change
Expand Up		@@ -85,6 +85,3 @@ class so that it can appear at either end of a <gi>div</gi>
		</body>
		</text>
		</TEI>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -101,6 +101,3 @@ model.respLike (2881416) </item>
		</body>
		</text>
		</TEI>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -86,6 +86,3 @@ elements which can appear within choice (2834505)</item>
		</p> </body>
		</text>
		</TEI>