Journal Archiving and Interchange Tag Library NISO JATS Draft Version 1.1d2

<private-char>

Private Character (Custom or Unicode)

Custom character supplied by a publisher, or a custom character from the Unicode private-use area, for which a bitmap or other representation of the glyph is included in or with the XML. The glyph may be represented as an inline graphic, an explicit bitmap glyph, or a reference to a previously defined character.

Remarks

Use of Unicode Characters. This Suite has been designed with Unicode values as the basic representation of all characters, including what is frequently called in publishing “special characters”, for example: Greek letters, publishing marks such as section symbols and em-dashes, mathematical symbols such as roots and fractions, alphabets with diacritics, etc. The use of combining characters is supported and encouraged, as is the use of entities defined by the STIX project (http://www.stixfonts.org/). 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. With this element, a graphic image may be included or a corresponding bitmap or alternative Unicode character may be included using the <glyph-data> element.
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. Special characters defined by publishers as custom entities or in the Unicode Private Use Area cannot be handled by the NISO JATS Tag Sets unchanged. Publishers who have defined characters in the Private Use Area may:
  • Remap those characters to existing Unicode values (using combining characters for special accented characters where appropriate), or
  • Recreate each character as an image or as a bitmap using one of the methods supported under the <private-char> element.
Best Practice: The most repository-friendly technique is to use the element <glyph-data> to provide an individual bitmap. [We would like to thank the APS (American Physical Society) for providing us with this technique.] Private character files may also be described using the <inline-graphic> element. Since there are no completely standard/public agreements on how such characters are to be named and displayed, this technique can 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 file referenced by an <inline-graphic> element.
Attributes. The attributes for this element should be used to 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 (for example, “NORTHWEST SOUTHEAST ARROW”).
New General Entities. In cases where a general entity reference is preferred to <private-char>, but the entity is not present in the standard ISO standard entity sets, the entity name, with its corresponding Unicode value can be defined in the %chars.ent; module (for example, as has been done with the Euro € symbol).

Related Elements

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

Attributes

description Description of a Private Character
id Document Internal Identifier
name Name (Private Character)
specific-use Specific Use
xml:base Base

Content Model

<!ELEMENT  private-char %private-char-model;                         >

Expanded Content Model

((glyph-data | glyph-ref) | inline-graphic*)

Description

Any one of:

This element may be contained in:

<abbrev>, <abbrev-journal-title>, <addr-line>, <aff>, <alternatives>, <alt-title>, <anonymous>, <article-title>, <attrib>, <award-id>, <bold>, <chapter-title>, <chem-struct>, <collab>, <comment>, <compound-kwd-part>, <compound-subject-part>, <conf-acronym>, <conf-loc>, <conf-name>, <conf-num>, <conf-sponsor>, <conf-theme>, <copyright-statement>, <corresp>, <def-head>, <degrees>, <disp-formula>, <edition>, <element-citation>, <email>, <etal>, <ext-link>, <fax>, <fixed-case>, <funding-source>, <funding-statement>, <given-names>, <gov>, <history>, <inline-formula>, <inline-supplementary-material>, <institution>, <issue>, <issue-part>, <issue-sponsor>, <issue-title>, <italic>, <journal-subtitle>, <journal-title>, <kwd>, <label>, <license-p>, <meta-name>, <meta-value>, <mixed-citation>, <monospace>, <named-content>, <on-behalf-of>, <overline>, <p>, <part-title>, <patent>, <phone>, <prefix>, <preformat>, <product>, <publisher-loc>, <publisher-name>, <rb>, <related-article>, <related-object>, <role>, <roman>, <sans-serif>, <sc>, <self-uri>, <series>, <series-text>, <series-title>, <sig>, <sig-block>, <source>, <speaker>, <std-organization>, <strike>, <string-conf>, <string-date>, <string-name>, <styled-content>, <sub>, <subject>, <subtitle>, <suffix>, <sup>, <supplement>, <surname>, <target>, <td>, <term>, <term-head>, <textual-form>, <th>, <title>, <trans-source>, <trans-subtitle>, <trans-title>, <underline>, <unstructured-kwd-group>, <uri>, <verse-line>, <version>, <volume>, <volume-id>, <volume-series>, <xref>

Example 1

...
<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>
...

Example 2

An example of a triple bond glyph. To a chemist, a triple bond is not the same as Unicode x2261, but using alternatives, as shown below, is sometimes the easiest way to display the character visually and still stay within Unicode: 
...
<alternatives>

<textual-form specific-use="unicode-look-alike">&#x2261;</textual-form>

<private-char name="Triple Bond" description="Chemistry Triple Bond">
<glyph-data id="tbond" format="PBM" resolution="300"
x-size="16" y-size="32">
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
0001111111111111111111111100000
0000000000000000000000000000000
0000000000000000000000000000000
0001111111111111111111111100000
0000000000000000000000000000000
0000000000000000000000000000000
0001111111111111111111111100000
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
0000000000000000000000000000000
</glyph-data>
</private-char>

</alternatives>
...

Journal Archiving and Interchange Tag Library NISO JATS Draft Version 1.1d2

Version of December 2014

Back to Top