<private-char>

Private Character (Custom or Unicode)

Definition

A custom character entity defined by a publisher, or a custom character from the Unicode Private Use Area for which a bitmap is submitted for the glyph

Remarks

This Suite has been designed with Unicode as the basic representation of all special characters. The use of combining characters is supported and encouraged, as is the use of entities defined by the STIX project (http://www.ams.org/STIX/). Unicode values in planes other than Plane 0 may be freely used. Use of private publisher entities and the Unicode Private Use Area is discouraged but supported with the <private-char> element, for which a corresponding bitmap must be submitted using the <glyph-data> element. In cases where an entity name has been generally accepted with a corresponding Unicode number and the entity has not been added to the ISO standard entity sets, a named entity may be defined in the %chars.ent; module (e.g., the Euro €).

Because of the potential for conflicts in assignments by different publishers, this Suite does not support assignment of values in the Unicode Private Use Area. Publishers who have defined characters in the Private Use Area must remap those characters to existing Unicode values (using combining characters for special accented characters where appropriate) or must submit bitmaps of those characters using one of the two methods supported under the <private-char> element. Those custom publisher entities for which corresponding Unicode values have not been determined must be tagged with the <private-char> element.

Special characters defined by publishers as custom entities or in the Unicode Private Use Area may not be deposited as is. If they cannot be remapped to existing Unicode values, each must be submitted as a bitmap using the <private-char> element. The most repository-friendly technique uses the element <glyph-data> although individual bitmap files may be submitted with <inline-graphic>. [We would like to thank the APS (American Physical Society) for providing us with this technique.]

Since there are no completely standard/public agreements on how such characters are to be named and displayed, this technique is to be used instead of a custom general entity reference to provide complete information on the intended character. A document should contain a <private-char> element at each location where a private character is used within the document. The corresponding image for the glyph may be given in the <glyph-data> element, as a <glyph-ref> reference to a <glyph-data> element elsewhere in the document, or as an external bitmap file referenced by an <inline-graphic> element.

The attributes for this element supply a human-readable description of the character, for example, “Arrow, normal weight, single line, two-headed, Northwest to Southeast” and a unique name for the character in all uppercase ASCII, similar to names found in Unicode standard (e.g., “NORTHWEST SOUTHEAST ARROW”).

Implementation Note: <inline-graphic> should only be used outside <private-char> when the graphic is something other than a special character, for example, an icon.

Attributes

description Description of a Private Character
name Name

Related Elements

The element <glyph-data> may only be used inside the element <private-char>.

Model Information

Content Model

<!ELEMENT  private-char ((glyph-data | glyph-ref) | inline-graphic*) >

Description

Any one of:

This element may be contained in:

<addr-line> Address Line; <alt-title> Alternate Title; <article-title> Article Title; <attrib> Attribution; <bold> Bold; <citation> Citation; <collab> Collaborative (Group) Author; <comment> Comment in a Citation; <conf-theme> Conference Theme; <contract-sponsor> Contract Sponsor; <def-head> Definition List: Definition Head; <disp-formula> Formula, Display; <grant-num> Grant Number; <grant-sponsor> Grant Sponsor; <inline-formula> Formula, Inline; <italic> Italic; <label> Label (Of a Figure, Reference, Etc.); <meta-name> Metadata Data Name for Custom Metadata; <meta-value> Metadata Data Value for Custom Metadata; <monospace> Monospace Text (Typewriter Text); <named-content> Named Special (Subject) Content; <overline> Overline; <p> Paragraph; <product> Product Information; <sans-serif> Sans Serif; <sc> Small Caps; <sig> Signature; <sig-block> Signature Block; <strike> Strike Through; <sub> Subscript; <subject> Subject Grouping Name; <subtitle> Article Subtitle; <sup> Superscript; <supplement> Supplement Information; <td> Table Data Cell (XHTML table model); <term> Definition List: Term; <term-head> Definition List: Term Head; <th> Table Header Cell (XHTML table model); <title> Title; <trans-subtitle> Translated Subtitle; <trans-title> Translated Title; <underline> Underline; <verse-line> Line of a Verse

Tagged Example


...
<p>...The map symbol indicating these conditions will be a 
<private-char name="NORTHWEST SOUTHEAST ARROW" description="Arrow,
normal weight, single line, two-headed, Northwest to Southeast">
<glyph-data id="NWSEArr" format="PBM" resolution="300" 
x-size="34" y-size="34">
 0000000000000000000000000000000000 0111111111111100000000000000000000
 0111111111111100000000000000000000 0111110000000000000000000000000000
 0111110000000000000000000000000000 0111111000000000000000000000000000
 0110111100000000000000000000000000 0110011110000000000000000000000000
 0110001111000000000000000000000000 0110000111100000000000000000000000
 0110000011110000000000000000000000 0110000001111000000000000000000000
 0110000000111100000000000000000000 0110000000011110000000000000000000
 0110000000001111000000000000000000 0110000000000111100000000000000000
 0110000000000011110000000000000000 0000000000000001111000000000000000
 0000000000000000111100000000000110 0000000000000000011110000000000110
 0000000000000000001111000000000110 0000000000000000000111100000000110
 0000000000000000000011110000000110 0000000000000000000001111000000110
 0000000000000000000000111100000110 0000000000000000000000011110000110
 0000000000000000000000001111000110 0000000000000000000000000111100110
 0000000000000000000000000011110110 0000000000000000000000000001111110
 0000000000000000000000000001111110 0000000000000000011111111111111110
 0000000000000000011111111111111110 0000000000000000000000000000000000
 </glyph-data></private-char>. The NOAA 1993 standard definition of 
<private-char name="NORTHWEST SOUTHEAST ARROW" description="Arrow,
normal weight, single line, two-headed, Northwest to Southeast">
<glyph-ref glyph-data="NWSEArr"/></private-char> will apply.
</p>
... 


Module

chars.ent