<join> identifies a possibly fragmented segment of text, by pointing at the possibly discontiguous elements which compose it. [16.7 Aggregation]
Modulelinking — Linking, Segmentation, and Alignment
Attributesatt.global (@xml:id, @n, @xml:lang, @xml:base, @xml:space) (att.global.rendition (@rend, @style, @rendition)) (att.global.linking (@corresp, @synch, @sameAs, @copyOf, @next, @prev, @exclude, @select)) (att.global.analytic (@ana)) (att.global.facs (@facs)) (att.global.change (@change)) (att.global.responsibility (@cert, @resp)) att.pointing (@targetLang, @target, @evaluate) att.typed (@type, @subtype)
resultspecifies the name of an element which this aggregation may be understood to represent.
Status Optional
Datatype teidata.name
scopeindicates whether the targets to be joined include the entire element indicated (the entire subtree including its root), or just the children of the target (the branches of the subtree).
Status Recommended
Datatype teidata.enumerated
Legal values are:
the rooted subtrees indicated by the target attribute are joined, each subtree become a child of the virtual element created by the join [Default]
the children of the subtrees indicated by the target attribute become the children of the virtual element (i.e. the roots of the subtrees are discarded)
Member of
Contained by
analysis: cl m phr s span w
figures: cell figure table
linking: ab joinGrp seg
nets: graph
spoken: u writing
tagdocs: eg valDesc
textcrit: lem rdg wit witDetail
verse: metSym rhyme
May contain

The following example is discussed in section 16.7 Aggregation:

 <p>How does it go? <q>
   <l xml:id="frog_x1">da-da-da</l>
   <l xml:id="frog_l2">gets a new frog</l>
   <l xml:id="frog_l1">When the old pond</l>
  <q>... <l xml:id="frog_l3">It's a new pond.</l>
 <join target="#frog_l1 #frog_l2 #frog_l3"


The join element here identifies a linegroup (lg) comprising the three lines indicated by the target attribute. The value root for the scope attribute indicates that the resulting virtual element contains the three l elements linked to at #frog_l1 #frog_l2 #frog_l3, rather than their character data content.


In this example, the attribute scope is specified with the value of branches to indicate that the virtual list being constructed is to be made by taking the lists indicated by the target attribute of the join element, discarding the list tags which enclose them, and combining the items contained within the lists into a single virtual list:

<p>Southern dialect (my own variety, at least) has only <list xml:id="LP1">
   <s>I done gone</s>
   <s>I done went</s>
 </list> whereas Negro Non-Standard basilect has both these and <list xml:id="LP2">
   <s>I done go</s>
<p>White Southern dialect also has <list xml:id="LP3">
   <s>I've done gone</s>
   <s>I've done went</s>
 </list> which, when they occur in Negro dialect, should probably be considered as borrowings from other varieties of English.</p>
<join result="listxml:id="LST1"
 target="#LP1 #LP2 #LP3scope="branches">

 <desc>Sample sentences in Southern speech</desc>

<s:assert test="contains(@target,' ')">You must supply at least two values for @target on <s:name/>
Content model
 <alternate minOccurs="0"

  <classRef key="model.descLike"/>
  <classRef key="model.certLike"/>
Schema Declaration
<rng:element name="join">
 <rng:ref name="att.global.attributes"/>
 <rng:ref name="att.global.rendition.attributes"/>
 <rng:ref name="att.global.linking.attributes"/>
 <rng:ref name="att.global.analytic.attributes"/>
 <rng:ref name="att.global.facs.attributes"/>
 <rng:ref name="att.global.change.attributes"/>
 <rng:ref name="att.global.responsibility.attributes"/>
 <rng:ref name="att.pointing.attributes"/>
 <rng:ref name="att.typed.attributes"/>
  <rng:attribute name="result">
   <rng:ref name="teidata.name"/>
  <rng:attribute name="scope"

   <rng:ref name="model.descLike"/>
   <rng:ref name="model.certLike"/>
element join
   attribute result { teidata.name }?,
   attribute scope { "root" | "branches" }?,
   ( model.descLike | model.certLike )*