<join>

<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, @rend, @style, @rendition, @xml:base, @xml:space) (att.global.linking (@corresp, @synch, @sameAs, @copyOf, @next, @prev, @exclude, @select)) (att.global.analytic (@ana)) (att.global.facs (@facs)) (att.global.change (@change)) att.pointing (@targetLang, @target, @evaluate) att.typed (@type, @subtype)
targetsspecifies the identifiers of the elements or passages to be joined into a virtual element.
DeprecatedThis feature will be withdrawn after 2013-09-20
Status Optional
Datatype 2–∞ occurrences of 

<rng:ref name="data.pointer"/>
data.pointer
separated by whitespace
Values two or more pointers (URIs), separated by whitespace
Note

This attribute is deprecated. It is retained for backward compatibility only; the attribute target should be used for preference. It is an error to supply both attributes, but one or the other must be present.

resultspecifies the name of an element which this aggregation may be understood to represent.
Status Optional
Datatype 

<rng:ref name="data.name"/>
data.name
Values The generic identifier of an element in the current schema.
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 

<rng:ref name="data.enumerated"/>
data.enumerated
Legal values are:
root
the rooted subtrees indicated by the targets attribute are joined, each subtree become a child of the virtual element created by the join [Default]
branches
the children of the subtrees indicated by the targets attribute become the children of the virtual element (i.e. the roots of the subtrees are discarded)
Member of
model.global.meta
Contained by
analysis: cl m phr s span w
core: abbr add addrLine address author bibl biblScope cit citedRange corr date del distinct editor email emph expan foreign gloss head headItem headLabel hi imprint item l label lg list measure mentioned name note num orig p pubPlace publisher q quote ref reg resp rs said series sic soCalled sp speaker stage street term textLang time title unclear
corpus: activity channel constitution derivation domain factuality interaction locale preparedness purpose
dictionaries: case colloc def dictScrap entry entryFree etym form gen gram gramGrp hom hyph iType lang lbl mood number orth per pos pron re sense stress subc syll tns usg xr
drama: actor camera caption castGroup castItem castList epilogue performance prologue role roleDesc set sound spGrp tech view
figures: cell figure table
header: authority change classCode distributor edition extent funder geoDecl handNote language licence principal scriptNote sponsor typeNote
linking: ab joinGrp seg
msdescription: accMat acquisition additions catchwords collation colophon condition custEvent decoNote explicit filiation finalRubric foliation heraldry incipit layout material msItem musicNotation objectType origDate origPlace origin provenance rubric secFol signatures source stamp summary support surrogates watermark
namesdates: addName affiliation age birth bloc country death district education faith floruit forename genName geogFeat geogName langKnown nameLink nationality occupation orgName persName person placeName region residence roleName settlement sex socecStatus surname
nets: graph
spoken: u writing
tagdocs: eg valDesc
textcrit: app lem rdg wit witDetail
textstructure: argument back body byline closer dateline div div1 div2 div3 div4 div5 div6 div7 docAuthor docDate docEdition docImprint docTitle epigraph floatingText front group imprimatur opener postscript salute signed text titlePage titlePart trailer
transcr: damage fw line metamark mod restore retrace sourceDoc supplied surface surfaceGrp surplus zone
verse: metSym rhyme
May contain
certainty: certainty precision respons
core: desc
Declaration

<rng:element name="join">
 <rng:ref name="att.global.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.pointing.attributes"/>
 <rng:ref name="att.typed.attributes"/>
 <rng:optional>
  <rng:attribute name="targets">
   <rng:list>
    <rng:ref name="data.pointer"/>
    <rng:ref name="data.pointer"/>
    <rng:zeroOrMore>
     <rng:ref name="data.pointer"/>
    </rng:zeroOrMore>
   </rng:list>
  </rng:attribute>
 </rng:optional>
 <rng:optional>
  <rng:attribute name="result">
   <rng:ref name="data.name"/>
  </rng:attribute>
 </rng:optional>
 <rng:optional>
  <rng:attribute name="scope" a:defaultValue="root">
   <rng:choice>
    <rng:value>root</rng:value>
    <rng:value>branches</rng:value>
   </rng:choice>
  </rng:attribute>
 </rng:optional>
 <rng:zeroOrMore>
  <rng:choice>
   <rng:ref name="model.descLike"/>
   <rng:ref name="model.certLike"/>
  </rng:choice>
 </rng:zeroOrMore>
</rng:element>
element join
{
   att.global.attributes,
   att.global.linking.attributes,
   att.global.analytic.attributes,
   att.global.facs.attributes,
   att.global.change.attributes,
   att.pointing.attributes,
   att.typed.attributes,
   attribute targets { list { data.pointer, data.pointer, data.pointer* } }?,
   attribute result { data.name }?,
   attribute scope { "root" | "branches" }?,
   ( model.descLike | model.certLike )*
}
Schematron

<s:report test="@target and @targets">You may not supply both @target and @targets on <s:name/>
</s:report>
Schematron

<s:report test="not(@target) and not(@targets)">You must supply either @target or @targets on <s:name/>
</s:report>
Schematron

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

The following example is discussed in section 16.7 Aggregation:

<sp>
 <speaker>Hughie</speaker>
 <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>...</l>
  </q>
 </p>
</sp>
<sp>
 <speaker>Louie</speaker>
 <p>
  <q>
   <l xml:id="frog_l1">When the old pond</l>
   <l>...</l>
  </q>
 </p>
</sp>
<sp>
 <speaker>Dewey</speaker>
 <p>
  <q>... <l xml:id="frog_l3">It's a new pond.</l>
  </q>
 </p>
 <join target="#frog_l1 #frog_l2 #frog_l3" result="lg" scope="root"/>
</sp>

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.

Example

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">
  <item>
   <s>I done gone</s>
  </item>
  <item>
   <s>I done went</s>
  </item>
 </list> whereas Negro Non-Standard basilect has both these and <list xml:id="LP2">
  <item>
   <s>I done go</s>
  </item>
 </list>.</p>
<p>White Southern dialect also has <list xml:id="LP3">
  <item>
   <s>I've done gone</s>
  </item>
  <item>
   <s>I've done went</s>
  </item>
 </list> which, when they occur in Negro dialect, should probably be considered as borrowings from other varieties of English.</p>
<join
  result="list"
  xml:id="LST1"
  target="#LP1 #LP2 #LP3"
  scope="branches">
 <desc>Sample sentences in Southern speech</desc>
</join>