SDD Primer Home   Index

SDD Part 0: Introduction and Primer to the SDD Standard

3.2.4 Specifying languages and audiences for the document

Audiences are central to the way SDD supports multilingual descriptions and descriptions for differing purposes.

An audience in SDD is a combination of a language, specified using a standard two-letter language descriptors and an expertise level varying from 1-6.

The language descriptors follow ISO639. Examples include en (english), de (german), fr (french), es (spanish).

The expertise levels should follow the following:

0 = unspecified (expertise level not known or defined, used especially for legacy data)
1 = elementary school (years 1 to 6)
2 = middle school (years 7 to 10)
3 = high school (years 11 above) and general public (specialized terminology or jargon avoided)
4 = university students or (partly) trained personnel (specialised terminology allowed but explained where appropriate)
5 = experts (using the full range of terminology)

Audiences relevant to the current SDD document are specified in the <ProjectDefinition> section. Audiences are then referred to throughout the document by their key references wherever alternate representations of strings are needed.

 

Example 3.2.4.1 - Specifying audiences in SDD

  <ProjectDefinition>

    <Audiences defaultaudience="en5">

      <Audience audiencekey="en1" lang="en" ExpertiseLevel="1">
        <LabelText>Schoolchildren (ca. grade 1 to 6)</LabelText>
        <Description>Vocabulary simplified for schoolchildren</Description>
      </Audience>

      <Audience audiencekey="de1" lang="de" ExpertiseLevel="1">
        <LabelText>Schulkinder (ca. 1. bis 6. Schuljahr)</LabelText>
        <Description>Die verwendeten Ausdrücke wurden so einfach wie möglich gehalten um Schulkindern bis
             ca. einschließlich der sechster Klasse den Zugang zu erleichtern.</Description>
      </Audience>

      <Audience audiencekey="en5" lang="en" ExpertiseLevel="5">
      <LabelText>Experts</LabelText>
      <Description>This setting uses the full scope of expert terminology.</Description>
      </Audience>

      <Audience audiencekey="de5" lang="de" ExpertiseLevel="5">
      <LabelText>Experten</LabelText>
      <Description>Beschreibungen unter Verwendung des vollständigen Fachvokabulars.</Description>
      </Audience>

    </Audiences>

  </ProjectDefinition>

Audiences are specified in <Audience> elements in the <Audiences> collection of <ProjectDefinition>

The <Audiences> element has a required attribute, defaultaudience, that must reference one of the specified audiences.

Each <Audience> element in the collection has three required attributes and one required and one optional subelements:

The audiencekey attribute is a string value, to be used for referring to the audience elsewhere in the document. The syntax of audiencekey is not controlled by the SDD Schema, but it is recommended that it be constructed by a concatenation of the language and expertise level (with, if necessary, a suffix a,b,c etc when several audiences of the same language and expertise are specified).

The lang attribute specifies the language using the ISO639 two-letter codes

The ExpertiseLevel attribute specifies the expertise level using an integer between 0 and 5 as above

<LabelText> specifies a label for the audience. <LabelText> should be a short string, and is used for listing purposes by a consuming application

<Description> specifies a verbose description of the language as necessary

At least one audience must be specified in any valid SDD document so that at least the language of the document will be specified (the expertise level 0=undefined may be used if necessary).

For examples of audiences referenced elsewhere in SDD documents, see the topic Specifying the list of characters and states.

KRT Last Edit: 31 Dec 03