resourceBundle.dtd

<!-- DTD for ICU resource bundles -->

<!--
    Deprecated format!

    ICU4C (and to some extent ICU4J) uses its own binary and .txt formats for resource bundles.
    Some time ago we defined this XML format that exactly mirrors the binary/.txt formats.
    We are retracting this format because

    - We are not aware of anyone using it.
    - It does not provide any significant advantages over the .txt format.
    - It is only now (ICU 2.4) barely supported by ICU tools.
    - For application localization we now recommend to use XLIFF,
       for which we plan to develop some tools this year
       (at least an XLIFF->.txt transformer).

    For details about the last two points please see 
    http://icu.sourceforge.net/userguide/localizing.html

    See Jitterbug 2702 and the proposal to the icu mailing list on 2003-jan-07.
-->

<!-- some element and attribute names are truncated to save space -->

<!-- a resource bundle has a name (locale ID if it is a locale resource bundle)
     and contains one table (see below) -->
<!ELEMENT resourceBundle (table)>

<!-- the name must only contain "invariant" characters
     (subset of ASCII graphic characters) -->
<!ATTLIST resourceBundle name CDATA #REQUIRED>

<!-- a macro for "any one of the possible resource elements" -->
<!ENTITY % anyElement "(str|int|intVector|bin|importBin|array|table|alias)">

<!-- all resource elements have an optional key attribute;
     it must be present in elements that are directly nested in a <table>
     but must not be present in elements that are directly nested in an <array>;
     the key attribute must only contain "invariant" characters
     (subset of ASCII graphic characters) and must not be empty -->

<!-- also note that if an empty value is desired in an NMTOKENS attribute,
     then the entire attribute must be omitted because NMTOKENS requires
     at least one NMTOKEN if there is an attribute -->

<!-- a table, i.e., an array of zero or more (key, value) pairs
     where the values are arbitrary resource elements;
     all direct sub-elements must have key attributes -->
<!ELEMENT table (%anyElement;)*>
<!ATTLIST table key CDATA #IMPLIED>

<!-- a simple array of zero or more arbitrary resource elements;
     all direct sub-elements must not have key attributes -->
<!ELEMENT array (%anyElement;)*>
<!ATTLIST array key CDATA #IMPLIED>

<!-- string,
     may contain any Unicode characters and may be empty;
     note CDATA parsing rules in XML:
     all sequences of whitespace get replaced by single spaces U+0020;
     if multiple spaces or CR or LF are intended, then
     they must be written as NCRs &#x20; &#xd; &#xa; etc. -->
<!ELEMENT str EMPTY>
<!ATTLIST str key CDATA #IMPLIED
              val CDATA #IMPLIED>

<!-- Alias,
     may contain any Unicode characters and may be empty;
     note CDATA parsing rules in XML:
     all sequences of whitespace get replaced by single spaces U+0020;
     if multiple spaces or CR or LF are intended, then
     they must be written as NCRs &#x20; &#xd; &#xa; etc. -->
<!ELEMENT alias EMPTY>
<!ATTLIST alias key CDATA #IMPLIED
              val CDATA #IMPLIED>

<!-- 28-bit integer (not 32 bits!),
     value range: -2^27..2^28-1 to reach all signed and unsigned 32-bit values;
     for details see icuhtml/design/bnf_rb.txt;
     value format: decimal number or C-style hexadecimal with a 0x prefix -->
<!ELEMENT int EMPTY>
<!ATTLIST int key CDATA #IMPLIED
              val NMTOKEN #REQUIRED>

<!-- a vector of zero or more 32-bit integers; for details see icuhtml/design/bnf_rb.txt -->
<!ELEMENT intVector EMPTY>
<!ATTLIST intVector key CDATA #IMPLIED
                    val NMTOKENS #IMPLIED>

<!-- simple binary data, the val attribute must contain pairs of hex digits -->
<!ELEMENT bin EMPTY>
<!ATTLIST bin key CDATA #IMPLIED
              val NMTOKENS #IMPLIED>

<!-- binary data imported from a local file -->
<!ELEMENT importBin EMPTY>
<!ATTLIST importBin key CDATA #IMPLIED
                    filename CDATA #REQUIRED>

<!-- This is an example of an XML file that is valid with this DTD
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE resourceBundle
  SYSTEM "http://oss.software.ibm.com/icu/dtd/resourceBundle.dtd">
<resourceBundle name="eo">
  <table>
    <int key="a" val="2"/>
    <str key="s" val="Vladimir"/>
    <str key="s2" val="Markus"/>
    <int key="i" val="0x22"/>
    <str key="emptyString" val=""/>
    <str key="anotherEmptyString"/>
    <intVector key="iv" val="20 21 -1 0x7f"/>
    <intVector key="emptyIntegerVector"/>
    <array key="array">
      <int val="20"/>
      <str val="Andy"/>
      <str val="Andy2"/>
      <bin val="fe ff 0a b5"/>
      <intVector val="20 21 -1 0x7f"/>
      <importBin filename="/other.jpeg"/>
      <str/><str val=""/>
      <bin/>
      <intVector/>
      <array/>
      <table/>
    </array>
    <array key="emptyArray"/>
    <bin key="b" val="fe ff 0a b5"/>
    <bin key="emptyBinary"/>
    <importBin key="bb" filename="/something.jpeg"/>
    <table key="t">
      <int key="t0" val="-21"/>
    </table>
    <table key="emptyTable"/>
  </table>
</resourceBundle>
-->