CLDR-17091 kbd: move names into info name="…"

- drop the <names> element - make <info> required - add <info name="…"> as a required attribute - update docs and dtd - test fix for XML validity - update the info name= attribute
unicode-org · Oct 8, 2023 · 29af7f2 · 29af7f2
1 parent ba1c4f0
commit 29af7f2
Show file tree

Hide file tree

Showing 14 changed files with 49 additions and 160 deletions.
diff --git a/common/supplemental/attributeValueValidity.xml b/common/supplemental/attributeValueValidity.xml
@@ -452,7 +452,7 @@
 			<attributeValues dtds='keyboard3' elements='keyboard3' attributes='locale' type='TODO'></attributeValues>
 			<!-- <attributeValues dtds='keyboard3' elements='map' attributes='longPress' type='TODO'></attributeValues>
 			<attributeValues dtds='keyboard3' elements='map' attributes='to' type='TODO'></attributeValues> -->
-			<attributeValues dtds='keyboard3' elements='name' attributes='value' type='TODO'></attributeValues>
+			<attributeValues dtds='keyboard3' elements='info' attributes='name' type='TODO'></attributeValues>
 			<attributeValues dtds='keyboard3' elements='transform' attributes='from' type='TODO'></attributeValues>
 			<attributeValues dtds='keyboard3' elements='transform' attributes='to' type='TODO'></attributeValues>
 			<attributeValues dtds='keyboard3' elements='transforms' attributes='type' type='choice'>simple</attributeValues>

diff --git a/docs/ldml/tr35-keyboards.md b/docs/ldml/tr35-keyboards.md
@@ -74,8 +74,6 @@ The LDML specification is divided into the following parts:
   * [Element: locale](#Element_locale)
   * [Element: version](#Element_version)
   * [Element: info](#Element_info)
-  * [Element: names](#Element_names)
-  * [Element: name](#Element_name)
   * [Element: settings](#Element_settings)
   * [Element: keys](#Element_keys)
   * [Element: key](#Element_key)
@@ -334,7 +332,7 @@ This is the top level element. All other elements defined below are under this e
 >
 > Parents: _none_
 >
-> Children: [displays](#Element_displays), [import](#Element_import), [info](#Element_info), [keys](#Element_keys), [layers](#Element_layers), [locales](#Element_locales), [names](#Element_names), [settings](#Element_settings), [_special_](tr35.md#special), [transforms](#Element_transforms), [variables](#Element_variables), [version](#Element_version)
+> Children: [displays](#Element_displays), [import](#Element_import), [info](#Element_info), [keys](#Element_keys), [layers](#Element_layers), [locales](#Element_locales), [settings](#Element_settings), [_special_](tr35.md#special), [transforms](#Element_transforms), [variables](#Element_variables), [version](#Element_version)
 >
 > Occurrence: required, single
 >
@@ -485,7 +483,9 @@ Element containing informative properties about the layout, for displaying in us
 **Syntax**
 
 ```xml
-<info author="{author}"
+<info
+      name="{keyboard name}"
+      author="{author}"
       layout="{hint of the layout}"
       indicator="{short identifier}" />
 ```
@@ -496,10 +496,27 @@ Element containing informative properties about the layout, for displaying in us
 >
 > Children: _none_
 >
-> Occurrence: optional, single
+> Occurrence: required, single
 >
 > </small>
 
+_Attribute:_ `name` (required)
+
+> Note that this is the only required attribute for the `<info>` element.
+>
+> This attribute is an informative name for the keyboard.
+
+```xml
+<keyboard3 locale="bg-t-k0-phonetic-trad">
+    …
+    <info name="Bulgarian (Phonetic Traditional)" />
+    …
+</keyboard3>
+```
+
+* * *
+
+
 _Attribute:_ `author`
 
 > The `author` attribute contains the name of the author of the layout file.
@@ -519,69 +536,6 @@ _Attribute:_ `indicator`
 
 * * *
 
-### <a name="Element_names" href="#Element_names">Element: names</a>
-
-Element used to store any names given to the layout.
-
-These names are not localized but are informative names for the keyboard. Localization of these names would be done as separate data items elsewhere in CLDR.
-
-**Syntax**
-
-```xml
-<names>
-    {set of name elements}
-</names>
-```
-
-> <small>
->
-> Parents: [keyboard3](#Element_keyboard)
->
-> Children: [name](#Element_name), [_special_](tr35.md#special)
->
-> Occurrence: required, single
->
-> </small>
-
-### <a name="Element_name" href="#Element_name">Element: name</a>
-
-A single name given to the layout.
-
-**Syntax**
-
-```xml
-<name value="..">
-```
-
-> <small>
->
-> Parents: [names](#Element_names)
->
-> Children: _none_
->
-> Occurrence: required, multiple
->
-> </small>
-
-_Attribute:_ `value` (required)
-
-> The name of the layout.
-
-
-**Example**
-
-```xml
-<keyboard3 locale="bg-t-k0-phonetic-trad">
-    …
-    <names>
-        <name value="Bulgarian (Phonetic Traditional)" />
-    </names>
-    …
-</keyboard3>
-```
-
-* * *
-
 ### <a name="Element_settings" href="#Element_settings">Element: settings</a>
 
 An element used to keep track of layout-specific settings by implementations. This element may or may not show up on a layout. These settings reflect the normal practice by the implementation. However, an implementation using the data may customize the behavior.

diff --git a/keyboards/3.0/fr-t-k0-azerty.xml b/keyboards/3.0/fr-t-k0-azerty.xml
@@ -16,11 +16,7 @@
 		keyboard formats -->
 	<!-- 'version' element is now optional -->
 	<version number="1.0.0" />
-	<info author="Team Keyboard" layout="AZERTY" indicator="FR" />
-	<names>
-		<name value="French Test" />
-		<name value="French Test AZERTY" />
-	</names>
+	<info name="French Test AZERTY" author="Team Keyboard" layout="AZERTY" indicator="FR" />
 
 	<displays>
 		<!-- Note: displays is only used for keycap presentation -->

diff --git a/keyboards/3.0/ja-Latn.xml b/keyboards/3.0/ja-Latn.xml
@@ -5,10 +5,7 @@
 		<locale id="en" />
 	</locales>
 	<version number="0.0.0" />
-	<names>
-		<!-- this is the Romaji (English) layer of the JIS keyboard -->
-		<name value="Romaji (JIS)" />
-	</names>
+	<info name="Romaji (JIS)" />
 
 	<keys>
 		<import base="cldr" path="techpreview/keys-Zyyy-punctuation.xml" />

diff --git a/keyboards/3.0/mt-t-k0-47key.xml b/keyboards/3.0/mt-t-k0-47key.xml
@@ -5,12 +5,8 @@
         <!-- English is also an official language in Malta.-->
         <locale id="en" />
     </locales>
-    <info author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
-
-    <names>
-        <name value="Maltese 47-key" />
-        <name value="MSA 100:2002 47-key" />
-    </names>
+    <info name="Maltese 47-key" author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
+    <!-- MSA 100:2002 -->
 
     <keys>
         <!-- imports -->

diff --git a/keyboards/3.0/mt.xml b/keyboards/3.0/mt.xml
@@ -11,12 +11,8 @@
         <!-- English is also an official language in Malta.-->
         <locale id="en" />
     </locales>
-    <info author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
-
-    <names>
-        <name value="Maltese" />
-        <name value="MSA 100:2002" />
-    </names>
+    <info name="Maltese" author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
+    <!-- MSA 100:2002 -->
 
     <keys>
         <!-- imports -->

diff --git a/keyboards/3.0/pcm.xml b/keyboards/3.0/pcm.xml
@@ -2,10 +2,7 @@
 <!DOCTYPE keyboard3 SYSTEM '../dtd/ldmlKeyboard3.dtd'>
 <keyboard3 locale="pcm" conformsTo="techpreview">
   <version number="1.0.0" />
-  <names>
-    <name value="Nigerian Pidgin" />
-    <name value="Naijíriá Píjin" />
-  </names>
+  <info name="Naijíriá Píjin" />
   <keys>
     <import base="cldr" path="techpreview/keys-Zyyy-punctuation.xml" />
     <import base="cldr" path="techpreview/keys-Zyyy-currency.xml" />

diff --git a/keyboards/3.0/pt-t-k0-abnt2.xml b/keyboards/3.0/pt-t-k0-abnt2.xml
@@ -5,10 +5,7 @@
 		<locale id="pt" />
 	</locales>
 	<version number="0.0.0" />
-	<names>
-		<name value="Portuguese (Brazil) (ABNT2)" />
-	</names>
-
+	<info name="Portuguese (Brazil) (ABNT2)" />
 	<displays>
 		<display to="\m{acute}"  display="´"/>
 		<display to="\m{grave}"  display="`"/>

diff --git a/keyboards/dtd/ldmlKeyboard3.dtd b/keyboards/dtd/ldmlKeyboard3.dtd
@@ -10,7 +10,7 @@ The CLDR Keyboard Subcommittee is currently developing major changes to the CLDR
 Please view the subcommittee page for the most recent information.
 <https://cldr.unicode.org/index/keyboard-workgroup> -->
 
-<!ELEMENT keyboard3 ( import*, locales?, version?, info?, names, settings?, displays?, keys?, forms?, layers*, variables?, transforms*, special* ) >
+<!ELEMENT keyboard3 ( import*, locales?, version?, info, settings?, displays?, keys?, forms?, layers*, variables?, transforms*, special* ) >
     <!--@TECHPREVIEW-->
 <!ATTLIST keyboard3 locale CDATA #REQUIRED >
     <!--@MATCH:validity/bcp47-wellformed-->
@@ -45,6 +45,9 @@ Please view the subcommittee page for the most recent information.
 
 <!ELEMENT info EMPTY >
     <!--@TECHPREVIEW-->
+<!ATTLIST info name CDATA #REQUIRED >
+    <!--@MATCH:any-->
+    <!--@VALUE-->
 <!ATTLIST info author CDATA #IMPLIED >
     <!--@MATCH:any-->
     <!--@VALUE-->
@@ -55,26 +58,12 @@ Please view the subcommittee page for the most recent information.
     <!--@MATCH:any-->
     <!--@VALUE-->
 
-<!ELEMENT names ( import*, name+, special* ) >
-    <!--@TECHPREVIEW-->
-
-<!ELEMENT name EMPTY >
-    <!--@ORDERED-->
-    <!--@TECHPREVIEW-->
-<!ATTLIST name value CDATA #REQUIRED >
-    <!--@MATCH:any-->
-    <!--@VALUE-->
-
-<!ELEMENT special ANY >
-    <!--@TECHPREVIEW-->
-
 <!ELEMENT settings EMPTY >
     <!--@ORDERED-->
     <!--@TECHPREVIEW-->
 <!ATTLIST settings normalization (disabled) #IMPLIED >
     <!--@VALUE-->
 
-
 <!ELEMENT displays ( import*, display*, displayOptions*, special* ) >
     <!--@TECHPREVIEW-->
 
@@ -97,6 +86,9 @@ Please view the subcommittee page for the most recent information.
     <!--@VALUE-->
     <!--@ALLOWS_UESC-->
 
+<!ELEMENT special ANY >
+    <!--@TECHPREVIEW-->
+
 <!ELEMENT keys ( import*, ( key | flicks )*, special* ) >
     <!--@TECHPREVIEW-->
 

diff --git a/keyboards/dtd/ldmlKeyboard3.xsd b/keyboards/dtd/ldmlKeyboard3.xsd
@@ -22,8 +22,7 @@ Note: DTD @-annotations are not currently converted to .xsd. For full CLDR file
         <xs:element maxOccurs="unbounded" minOccurs="0" ref="import"/>
         <xs:element minOccurs="0" ref="locales"/>
         <xs:element minOccurs="0" ref="version"/>
-        <xs:element minOccurs="0" ref="info"/>
-        <xs:element ref="names"/>
+        <xs:element ref="info"/>
         <xs:element minOccurs="0" ref="settings"/>
         <xs:element minOccurs="0" ref="displays"/>
         <xs:element minOccurs="0" ref="keys"/>
@@ -97,6 +96,7 @@ Note: DTD @-annotations are not currently converted to .xsd. For full CLDR file
 
   <xs:element name="info">
     <xs:complexType>
+      <xs:attribute name="name" use="required"/>
       <xs:attribute name="author"/>
       <xs:attribute name="layout"/>
       <xs:attribute name="indicator"/>
@@ -109,27 +109,8 @@ Note: DTD @-annotations are not currently converted to .xsd. For full CLDR file
 
 
 
-  <xs:element name="names">
-    <xs:complexType>
-      <xs:sequence>
-        <xs:element maxOccurs="unbounded" minOccurs="0" ref="import"/>
-        <xs:element maxOccurs="unbounded" ref="name"/>
-        <xs:element maxOccurs="unbounded" minOccurs="0" ref="special"/>
-      </xs:sequence>
-    </xs:complexType>
-  </xs:element>
-
-  <xs:element name="name">
-    <xs:complexType>
-      <xs:attribute name="value" use="required"/>
-    </xs:complexType>
-  </xs:element>
-
-
 
 
-  <xs:element name="special" type="any"/>
-
   <xs:element name="settings">
     <xs:complexType>
       <xs:attribute name="normalization">
@@ -178,6 +159,8 @@ Note: DTD @-annotations are not currently converted to .xsd. For full CLDR file
 
 
 
+  <xs:element name="special" type="any"/>
+
   <xs:element name="keys">
     <xs:complexType>
       <xs:sequence>

diff --git a/...r-code/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-missing.xml b/...r-code/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-missing.xml
@@ -8,12 +8,7 @@
         <!-- English is also an official language in Malta.-->
         <locale id="en" />
     </locales>
-    <info author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
-
-    <names>
-        <name value="Maltese (48-key)" />
-        <!-- <name value="MSA 100:2002" /> -->
-    </names>
+    <info name="Broken Import Test" author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
 
     <keys>
         <!-- imports -->

diff --git a/...de/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-unknownbase.xml b/...de/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-unknownbase.xml
@@ -8,12 +8,7 @@
         <!-- English is also an official language in Malta.-->
         <locale id="en" />
     </locales>
-    <info author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
-
-    <names>
-        <name value="Maltese (48-key)" />
-        <!-- <name value="MSA 100:2002" /> -->
-    </names>
+    <info name="Broken Test" author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
 
     <keys>
         <!-- imports -->

diff --git a/...ode/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-unknownver.xml b/...ode/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-unknownver.xml
@@ -8,12 +8,9 @@
         <!-- English is also an official language in Malta.-->
         <locale id="en" />
     </locales>
-    <info author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
+    <info  name="Maltese (48-key)" author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
 
-    <names>
-        <name value="Maltese (48-key)" />
-        <!-- <name value="MSA 100:2002" /> -->
-    </names>
+    <!-- MSA 100:2002 -->
 
     <keys>
         <!-- imports -->

diff --git a/...de/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-wrongparent.xml b/...de/src/test/resources/org/unicode/cldr/tool/KeyboardFlatten/broken-import-wrongparent.xml
@@ -5,18 +5,12 @@
     <!DOCTYPE keyboard3 SYSTEM "../../../../../../../../../../keyboards/dtd/ldmlKeyboard3.dtd"> -->
 <keyboard3 locale="mt" conformsTo="techpreview">
     <locales>
+        <!-- Error - can't import 'keys' into a 'locales' section. -->
+        <import base="cldr" path="techpreview/keys-Zyyy-punctuation.xml"/>
         <!-- English is also an official language in Malta.-->
         <locale id="en" />
     </locales>
-    <info author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
-
-    <names>
-        <!-- Error - can't import 'keys' into a 'names' section. -->
-        <import base="cldr" path="techpreview/keys-Zyyy-punctuation.xml"/>
-
-        <name value="Maltese (48-key)" />
-        <!-- <name value="MSA 100:2002" /> -->
-    </names>
+    <info name="Broken Test" author="Steven R. Loomis" layout="QWERTY" indicator="MT" />
 
     <keys>
         <!-- imports -->