New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support word-level descriptive attributes for <char> #18

klassenjm opened this Issue Jul 12, 2016 · 0 comments


None yet
1 participant

klassenjm commented Jul 12, 2016


  • Support a defined set of additional descriptive attributes for element <char>
    • In USX, <char> elements always include a @style attribute which indicates the type of content being marked.
    • USX 3.0 and subsequent USX versions will define the official list of @style tagged <char> elements which may provide further descriptive attributes, and the list of attribute names and value options encoded for each.
  • User defined attributes are allowed using a specific naming syntax.

This is the USX companion to USFM 3.0 proposal "Syntax for assigning word-level descriptive attributes". See: ubsicap/usfm#24 for detail.

General Syntax

Attributes are added to <char> elements using standard XML syntax.

<char style="w" lemma="grace">

Default Attribute
In the case of the USFM specification, a single default attribute may be defined for a given character marker, and does not require the attribute name to be written within the text. To be valid, the XML expression in USX must always contain the attribute name and its value.

In the preceding example, <char @style="w"> accepts an additional attribute lemma, which is the default attribute found in the USFM expression for the same text.

User Defined Attributes

Attributes may be added to <char> elements within a text beyond the defined set for the latest USX version (3.0 or later). These will not be considered strictly USX compliant, and there is no assurance that they will be supported by compliant software tools or processes. Future versions of USX may formally define additional attributes.

Any user defined attributes must begin with the prefix x-.

<char style="w" x-myattr="metadata">gracious</char>
<char style="w" lemma="grace" x-myattr="metadata">gracious</char>

User defined attributes can be added to any USX <char> element, even if it is not within the list of @style tagged <char> elements officially providing descriptive attributes for the current version of the USX specification.

3.0 Elements Officially Providing Descriptive Attributes

  • <char @style="w">

@klassenjm klassenjm added this to the 3.0.rc1 milestone Jul 12, 2016

@klassenjm klassenjm changed the title from Support word level descriptive attributes for <char> to Support word-level descriptive attributes for <char> Jul 12, 2016

@klassenjm klassenjm modified the milestones: 3.0.rc1, 3.0.0 Oct 27, 2017

@klassenjm klassenjm closed this Jan 23, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment