https://github.com/TEIC/TEI
Tip revision: 347c64fac3fa1a64ade0d8d1842813d4b8f7acec authored by Hugh Cayless on 12 May 2017, 16:57:59 UTC
Updates.
Updates.
Tip revision: 347c64f
ref-param.html
<!DOCTYPE html
SYSTEM "about:legacy-compat">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8" /><!--THIS FILE IS GENERATED FROM AN XML MASTER. DO NOT EDIT (7)--><title>TEI element param </title><meta property="Language" content="en" /><meta property="DC.Title" content="TEI element param " /><meta property="DC.Language" content="SCHEME=iso639 en" /><meta property="DC.Creator.Address" content="tei@oucs.ox.ac.uk" /><meta charset="utf-8" /><link href="guidelines.css" rel="stylesheet" type="text/css" /><link href="odd.css" rel="stylesheet" type="text/css" /><link rel="stylesheet" media="print" type="text/css" href="guidelines-print.css" /><script type="text/javascript" src="jquery-1.2.6.min.js"></script><script type="text/javascript" src="columnlist.js"></script><script type="text/javascript" src="popupFootnotes.js"></script><script type="text/javascript">
$(function() {
$('ul.attrefs-class').columnizeList({cols:3,width:30,unit:'%'});
$('ul.attrefs-element').columnizeList({cols:3,width:30,unit:'%'});
$(".displayRelaxButton").click(function() {
$(this).parent().find('.RNG_XML').toggle();
$(this).parent().find('.RNG_Compact').toggle();
});
$(".tocTree .showhide").click(function() {
$(this).find(".tocShow,.tocHide").toggle();
$(this).parent().find("ul.continuedtoc").toggle();
});
})
</script><script type="text/javascript"><!--
var displayXML=0;
states=new Array()
states[0]="element-a"
states[1]="element-b"
states[2]="element-c"
states[3]="element-d"
states[4]="element-e"
states[5]="element-f"
states[6]="element-g"
states[7]="element-h"
states[8]="element-i"
states[9]="element-j"
states[10]="element-k"
states[11]="element-l"
states[12]="element-m"
states[13]="element-n"
states[14]="element-o"
states[15]="element-p"
states[16]="element-q"
states[17]="element-r"
states[18]="element-s"
states[19]="element-t"
states[20]="element-u"
states[21]="element-v"
states[22]="element-w"
states[23]="element-x"
states[24]="element-y"
states[25]="element-z"
function startUp() {
}
function hideallExcept(elm) {
for (var i = 0; i < states.length; i++) {
var layer;
if (layer = document.getElementById(states[i]) ) {
if (states[i] != elm) {
layer.style.display = "none";
}
else {
layer.style.display = "block";
}
}
}
var mod;
if ( mod = document.getElementById('byMod') ) {
mod.style.display = "none";
}
}
function showall() {
for (var i = 0; i < states.length; i++) {
var layer;
if (layer = document.getElementById(states[i]) ) {
layer.style.display = "block";
}
}
}
function showByMod() {
hideallExcept('');
var mod;
if (mod = document.getElementById('byMod') ) {
mod.style.display = "block";
}
}
--></script></head><body id="TOP"><div id="container"><div id="banner"><img src="Images/banner.jpg" alt="Text Encoding Initiative logo and banner" /></div></div><div class="mainhead"><h1>P5:
Guidelines for Electronic Text Encoding and Interchange</h1><p>Version 3.1.1a. Last updated on
10th May 2017, revision bd8dda3</p></div><div class="main-content"><div class="miniTOC miniTOC_right"><ul class="subtoc"><li class="subtoc"></li><li class="subtoc"></li><li class="subtoc"><a class="navigation" href="index.html">Home</a></li><li class="subtoc"><a class="navigation" href="REF-ELEMENTS.html">C Elements</a></li></ul></div><div><h3 class="oddSpec" id="param"><param></h3><table class="wovenodd"><tr><td colspan="2" class="wovenodd-col2"><span class="label"><param> </span>provides a parameter for a model behaviour by supplying its name and an XPath expression identifying the location of its content. [<a class="link_ptr" href="TD.html#TDPMMB" title="Behaviours and their parameters"><span class="headingNumber">22.5.5.5 </span>Behaviours and their parameters</a>]</td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Module</span></td><td class="wovenodd-col2">tagdocs — Documentation Elements</td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Attributes</span></td><td class="wovenodd-col2"><a class="link_odd" title="provides attributes common to all elements in the TEI encoding scheme." href="ref-att.global.html">att.global</a> (<span class="attribute">@xml:id</span>, <span class="attribute">@n</span>, <span class="attribute">@xml:lang</span>, <span class="attribute">@xml:base</span>, <span class="attribute">@xml:space</span>) (<a class="link_odd" title="provides rendering attributes common to all elements in the TEI encoding scheme." href="ref-att.global.rendition.html">att.global.rendition</a> (<span class="attribute">@rend</span>, <span class="attribute">@style</span>, <span class="attribute">@rendition</span>)) (<a class="link_odd" title="provides a set of attributes for hypertextual linking." href="ref-att.global.linking.html">att.global.linking</a> (<span class="attribute">@corresp</span>, <span class="attribute">@synch</span>, <span class="attribute">@sameAs</span>, <span class="attribute">@copyOf</span>, <span class="attribute">@next</span>, <span class="attribute">@prev</span>, <span class="attribute">@exclude</span>, <span class="attribute">@select</span>)) (<a class="link_odd" title="provides additional global attributes for associating specific analyses or interpretations with appropriate portions of a text." href="ref-att.global.analytic.html">att.global.analytic</a> (<span class="attribute">@ana</span>)) (<a class="link_odd" title="provides an attribute used to express correspondence between an element containing transcribed text and all or part of an image representing that text." href="ref-att.global.facs.html">att.global.facs</a> (<span class="attribute">@facs</span>)) (<a class="link_odd" title="supplies the @change attribute, allowing its member elements to specify one or more states or revision campaigns with which they are associated." href="ref-att.global.change.html">att.global.change</a> (<span class="attribute">@change</span>)) (<a class="link_odd" title="provides attributes indicating the agent responsible for some aspect of the text, the markup or something asserted by the markup, and the degree of certainty associated with it." href="ref-att.global.responsibility.html">att.global.responsibility</a> (<span class="attribute">@cert</span>, <span class="attribute">@resp</span>)) (<a class="link_odd" title="provides an attribute used by elements to point to an external source." href="ref-att.global.source.html">att.global.source</a> (<span class="attribute">@source</span>)) <table class="attList"><tr><td class="odd_label">name<span class="bookmarklink"><a class="bookmarklink" id="tei_att.name" href="#tei_att.name" title="link to this attribute "><span class="invisible"> name</span><span class="pilcrow">¶</span></a></span></td><td class="odd_value">a name for the parameter being supplied
Suggested values include: 1] alternate; 2] default; 3] height; 4] id; 5] label; 6] level; 7] link; 8] place; 9] type; 10] url; 11] width<table class="attDef"><tr><td class="odd_label"><span class="label" lang="en">Status</span> </td><td class="odd_value"><span lang="en"><span class="required">Required</span></span></td></tr><tr><td class="odd_label"><span lang="en" class="label">Datatype</span> </td><td class="odd_value"><a class="link_element" href="ref-teidata.enumerated.html">teidata.enumerated</a></td></tr><tr><td class="odd_label"><span class="label" lang="en">Suggested values include:</span></td><td class="odd_value"><dl class="valList"><dt class="odd_label">alternate</dt><dd class="odd_value">when used with behaviour <code>alternate</code>, a parameter of this name supplies one of the pair of possible values; for example the regularized form rather than the original form within a <a class="gi" title="groups a number of alternative encodings for the same point in a text." href="ref-choice.html">choice</a> element.</dd><dt class="odd_label">default</dt><dd class="odd_value">when used with behaviour <code>alternate</code>, a parameter of this name supplies one of the pair of possible values; for example the original form rather than the regularized form within a <a class="gi" title="groups a number of alternative encodings for the same point in a text." href="ref-choice.html">choice</a> element.</dd><dt class="odd_label">height</dt><dd class="odd_value">when used with behaviour <span class="ident">graphic</span>, a parameter of this name supplies a value for the height of the graphic e.g. "300px", "50%".</dd><dt class="odd_label">id</dt><dd class="odd_value">a parameter of this name should supply a unique identifier for the element being processed; as for example with the <span class="ident">anchor</span> behaviour</dd><dt class="odd_label">label</dt><dd class="odd_value">a parameter of this name should supply an expression to be used to label something, for example <code>concat('Page ', @n)</code> for a page break or <code>@n</code> for a footnote reference; typically used with the <span class="ident">note</span> or <span class="ident">break</span> behaviours</dd><dt class="odd_label">level</dt><dd class="odd_value">when used with the <span class="ident">heading</span> behaviour, a parameter of this name supplies a positive integer indicating the hierarchic level of a heading.</dd><dt class="odd_label">link</dt><dd class="odd_value">when used with the <span class="ident">link</span> behaviour, a parameter of this name should supply a URL to be used as the target of a link. </dd><dt class="odd_label">place</dt><dd class="odd_value">when used with the <code>note</code> behaviour, a parameter of this name should provide a string which describes the intended placement of some text; typical values include "margin", "footnote", "endnote", "inline", "bottom"</dd><dt class="odd_label">type</dt><dd class="odd_value">a parameter of this name can be used to categorize the specified behaviour in any way; for example the kind of break (when used with the <code>break</code> behaviour) or the kind of index to be generated (if used with the <code>index</code> behaviour) etc.</dd><dt class="odd_label">url</dt><dd class="odd_value">when used with behaviour <span class="ident">graphic</span>, a parameter of this name supplies a a URL indicating the graphic intended.</dd><dt class="odd_label">width</dt><dd class="odd_value">when used with behaviour <span class="ident">graphic</span>, a parameter of this name supplies a value for the width of the graphic e.g. "400px", "70%".</dd></dl></td></tr></table></td></tr><tr><td class="odd_label">value<span class="bookmarklink"><a class="bookmarklink" id="tei_att.value" href="#tei_att.value" title="link to this attribute "><span class="invisible"> value</span><span class="pilcrow">¶</span></a></span></td><td class="odd_value">supplies an XPath expression which when evaluated provides the value for the parameter<table class="attDef"><tr><td class="odd_label"><span class="label" lang="en">Status</span> </td><td class="odd_value"><span lang="en"><span class="required">Required</span></span></td></tr><tr><td class="odd_label"><span lang="en" class="label">Datatype</span> </td><td class="odd_value"><a class="link_element" href="ref-teidata.xpath.html">teidata.xpath</a></td></tr></table></td></tr></table></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Contained by</span></td><td class="wovenodd-col2"><div class="parent"><div class="specChildren"><div class="specChild"><span class="specChildModule">tagdocs: </span><span class="specChildElements"><a class="link_odd_elementSpec" title="describes the processing intended for a specified element." href="ref-model.html">model</a></span></div></div></div></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">May contain</span></td><td class="wovenodd-col2"><span lang="en">Empty element</span></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Note</span></td><td class="wovenodd-col2"><!-- --><p>An implementation may require parameters other than those listed here, and is not required to follow this partial specification. </p><p>The names and datatypes of the expected parameters should be documented in the corresponding customization using a <a class="gi" title="supplies specification for one parameter of a model behaviour" href="ref-paramSpec.html">paramSpec</a> element. Literal strings provided in an XPath expression should be quoted.</p></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Example</span></td><td class="wovenodd-col2"><p>In this example, which will be processed for a <a class="gi" title="groups a number of alternative encodings for the same point in a text." href="ref-choice.html">choice</a> element which has both <a class="gi" title="(Latin for thus or so) contains text reproduced although apparently incorrect or inaccurate." href="ref-sic.html">sic</a> and <a class="gi" title="(correction) contains the correct form of a passage apparently erroneous in the copy text." href="ref-corr.html">corr</a> child elements, the <span class="ident">default</span> parameter will provide the value of the child <a class="gi" title="(correction) contains the correct form of a passage apparently erroneous in the copy text." href="ref-corr.html">corr</a> element, and the <span class="ident">alternate</span> parameter will provide that of the child <a class="gi" title="(Latin for thus or so) contains text reproduced although apparently incorrect or inaccurate." href="ref-sic.html">sic</a> elements. If neither <a class="gi" title="provides a parameter for a model behaviour by supplying its name and an XPath expression identifying the location of its content." href="ref-param.html">param</a> element was supplied, both elements would still be available to an application, but the application would need to distinguish them for itself.</p><div id="index-egXML-d52e147165" class="pre egXML_valid"><span class="element"><elementSpec <span class="attribute">ident</span>="<span class="attributevalue">choice</span>"></span><br /> <span class="element"><model <span class="attribute">predicate</span>="<span class="attributevalue">sic and corr</span>"<br /> <span class="attribute">behaviour</span>="<span class="attributevalue">alternate</span>"></span><br /> <span class="element"><param <span class="attribute">name</span>="<span class="attributevalue">default</span>" <span class="attribute">value</span>="<span class="attributevalue">corr</span>"/></span><br /> <span class="element"><param <span class="attribute">name</span>="<span class="attributevalue">alternate</span>" <span class="attribute">value</span>="<span class="attributevalue">sic</span>"/></span><br /> <span class="element"></model></span><br /><span class="element"></elementSpec></span><div style="float: right;"><a href="examples-param.html">Show all</a> </div></div></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Example</span></td><td class="wovenodd-col2"><div id="index-egXML-d52e147171" class="pre egXML_valid"><span class="element"><elementSpec <span class="attribute">ident</span>="<span class="attributevalue">graphic</span>" <span class="attribute">mode</span>="<span class="attributevalue">change</span>"></span><br /> <span class="element"><model <span class="attribute">behaviour</span>="<span class="attributevalue">graphic</span>"></span><br /> <span class="element"><param <span class="attribute">name</span>="<span class="attributevalue">url</span>" <span class="attribute">value</span>="<span class="attributevalue">@url</span>"/></span><br /> <span class="element"><param <span class="attribute">name</span>="<span class="attributevalue">width</span>" <span class="attribute">value</span>="<span class="attributevalue">@width</span>"/></span><br /> <span class="element"><param <span class="attribute">name</span>="<span class="attributevalue">width</span>" <span class="attribute">value</span>="<span class="attributevalue">@height</span>"/></span><br /> <span class="element"></model></span><br /><span class="element"></elementSpec></span><div style="float: right;"><a href="examples-param.html">Show all</a> </div></div></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Content model</span></td><td class="wovenodd-col2"><pre class="eg"><span class="element"><content/></span></pre></td></tr><tr><td class="wovenodd-col1"><span class="label" lang="en">Schema Declaration</span></td><td class="wovenodd-col2"><div class="displayRelax"><button class="displayRelaxButton"><span class="RNG_Compact">XML syntax</span><span class="RNG_XML">Compact syntax</span></button><pre class="RNG_XML"><span class="element"><rng:element <span class="attribute">name</span>="<span class="attributevalue">param</span>"></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.rendition.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.linking.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.analytic.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.facs.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.change.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.responsibility.attributes</span>"/></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">att.global.source.attributes</span>"/></span><br /> <span class="element"><rng:attribute <span class="attribute">name</span>="<span class="attributevalue">name</span>"></span><br /> <span class="element"><rng:choice></span><br /> <span class="element"><rng:value></span>alternate<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>default<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>height<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>id<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>label<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>level<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>link<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>place<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>type<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>url<span class="element"></rng:value></span><br /> <span class="element"><rng:value></span>width<span class="element"></rng:value></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">teidata.enumerated</span>"/></span><br /> <span class="element"></rng:choice></span><br /> <span class="element"></rng:attribute></span><br /> <span class="element"><rng:attribute <span class="attribute">name</span>="<span class="attributevalue">value</span>"></span><br /> <span class="element"><rng:ref <span class="attribute">name</span>="<span class="attributevalue">teidata.xpath</span>"/></span><br /> <span class="element"></rng:attribute></span><br /> <span class="element"><rng:empty/></span><br /><span class="element"></rng:element></span></pre><pre class="RNG_Compact">
<span class="rnc_keyword">element</span> <span class="rnc_nc">param</span>
{
<a class="link_odd" title="provides attributes common to all elements in the TEI encoding scheme." href="ref-att.global.html">att.global.attributes</a>,
<a class="link_odd" title="provides rendering attributes common to all elements in the TEI encoding scheme." href="ref-att.global.rendition.html">att.global.rendition.attributes</a>,
<a class="link_odd" title="provides a set of attributes for hypertextual linking." href="ref-att.global.linking.html">att.global.linking.attributes</a>,
<a class="link_odd" title="provides additional global attributes for associating specific analyses or interpretations with appropriate portions of a text." href="ref-att.global.analytic.html">att.global.analytic.attributes</a>,
<a class="link_odd" title="provides an attribute used to express correspondence between an element containing transcribed text and all or part of an image representing that text." href="ref-att.global.facs.html">att.global.facs.attributes</a>,
<a class="link_odd" title="supplies the @change attribute, allowing its member elements to specify one or more states or revision campaigns with which they are associated." href="ref-att.global.change.html">att.global.change.attributes</a>,
<a class="link_odd" title="provides attributes indicating the agent responsible for some aspect of the text, the markup or something asserted by the markup, and the degree of certainty associated with it." href="ref-att.global.responsibility.html">att.global.responsibility.attributes</a>,
<a class="link_odd" title="provides an attribute used by elements to point to an external source." href="ref-att.global.source.html">att.global.source.attributes</a>,
<span class="rnc_keyword">attribute</span> <span class="rnc_nc">name</span>
{
"alternate"
| "default"
| "height"
| "id"
| "label"
| "level"
| "link"
| "place"
| "type"
| "url"
| "width"
| <a class="link_odd" title="" href="ref-teidata.enumerated.html">teidata.enumerated</a>
},
attribute value { <a class="link_odd" title="" href="ref-teidata.xpath.html">teidata.xpath</a> },
empty
}</pre></div></td></tr></table></div></div><div class="stdfooter autogenerated"><p>
[<a href="../../en/html/ref-param.html">English</a>]
[<a href="../../de/html/ref-param.html">Deutsch</a>]
[<a href="../../es/html/ref-param.html">Español</a>]
[<a href="../../it/html/ref-param.html">Italiano</a>]
[<a href="../../fr/html/ref-param.html">Français</a>]
[<a href="../../ja/html/ref-param.html">日本語</a>]
[<a href="../../ko/html/ref-param.html">한국어</a>]
[<a href="../../zh-TW/html/ref-param.html">中文</a>]
</p><hr /><div class="footer"><a class="plain" href="http://www.tei-c.org/About/">TEI Consortium</a> | <a class="plain" href="http://www.tei-c.org/About/contact.xml">Feedback</a></div><hr /><address><br />TEI Guidelines <a class="link_ref" href="AB.html#ABTEI4">Version</a> <a class="link_ref" href="../../readme-3.1.1.html">3.1.1a</a>. Last updated on <span class="date">10th May 2017</span>, revision <a class="link_ref" href="https://github.com/TEIC/TEI/commit/bd8dda3">bd8dda3</a>. This page generated on 2017-05-12T12:30:09Z.</address></div></body></html>