Schema Central  >  USLM 2.1.0  >  uslm-components-2.1.0.xsd  >  uslm:referenceItem
Advanced search

uslm:referenceItem

 
            A <referenceItem> is an item in a ToCIndex that refers to specific content
            in the document (versus a concept or a grouping). The referenceItem may also
            contain lower level referenceItems if the content being referred to contains
            lower level content.

Element information

Namespace: http://schemas.gpo.gov/xml/uslm

Schema document: uslm-components-2.1.0.xsd

Type: uslm:ItemType

Properties: Global, Qualified

Content

  • Choice [0..*]
    • uslm:designator A <designator> contains the alpha-numeric part of an item in a table of contents or index. It is typically the number of the item (e.g. "Part 1").
    • uslm:label A <label> contains the textual part of an item in a table of contents or index. It is typically the heading of the item (e.g. "Definitions").
    • uslm:target A <target> is a reference to the target in a table of contents or index. It is typically found in the last column and may contain like the page number or beginning section number. It has the usual attributes for references.
      • from subst. group uslm:footnote
    • uslm:footnote A <footnote> is a note that is to be rendered at the bottom of a page or column or table. It typically has a corresponding <ref idref="xxx"> element, where the @idref matches the @id of the <footnote>.
    • uslm:sidenote A <sidenote> is a note that is to be rendered in the side margins of a page. It may have a corresponding <ref idref="xxx"> element, where the @idref matches the @id of the <sidenote>.
    • uslm:endnote An <endnote> is a note that is to be rendered at the bottom logical unit of content. The logical unit can be specified in the @relativeTo attribute. It typically has a corresponding <ref idref="xxx"> element, where the @idref matches the @id of the <endnote>.
    • uslm:ear An <ear> contains the text to be printed in the outside margin. It is used, for example, in the CFR.
      • from subst. group uslm:page
    • uslm:page A <page> is an element indicating where a page boundary occurred. The content will typically be the page number.
    • uslm:line A <line> is an element indicating where a line boundary occurred. The content will typically be the line number, and possibly also the page number.
      • from subst. group uslm:referenceItem
    • uslm:referenceItem A <referenceItem> is an item in a ToCIndex that refers to specific content in the document (versus a concept or a grouping). The referenceItem may also contain lower level referenceItems if the content being referred to contains lower level content.
    • uslm:headingItem A <headingItem> is an item in a ToCIndex that is a columnar-type heading for the items below it. e.g. “Sec.” or “Page”. This is commonly repeated on following pages.
    • uslm:groupItem A <groupItem> is an item in a ToCIndex that collects a number of referenceItems or other groupItems under a heading. The groupItem may or may not refer to a specific place in the document. groupItems may also contain nested groupItems.

Attributes

NameOccTypeDescriptionNotes
xml:base [0..1]xsd:anyURIdenotes an attribute whose value provides a URI to be used as the base for interpreting any relative URIs in the scope of the element on which it appears; its value is inherited. This name is reserved by virtue of its definition in the XML Base specification.from group uslm:XmlSpecialAttrs
xml:lang [0..1]Anonymousdenotes an attribute whose value is a language code for the natural language of the content of any element; its value is inherited. from group uslm:XmlSpecialAttrs
xml:space [0..1]Anonymousdenotes an attribute whose value is a keyword indicating what whitespace processing discipline is intended for the content of the element; its value is inherited.from group uslm:XmlSpecialAttrs
id [0..1]xsd:ID The @id attribute should always be assigned an immutable (non-changing) value. If the item is subject to renaming or renumbering, then the @id attribute should not reflect any part of the changeable part. This is to allow the @id to be long lasting without causing confusion should the item be renamed or renumbered. The @id should be prefixed with "id" and followed by a GUID that is guaranteed to be globally unique across both time and space. As an "xsd:ID", the identity must be ensured to be unique in the document - and it is a good idea that it be guaranteed globally unique. As the @id is immutable, it is a good identity with which to associate external information to the item. If an item is deleted and later a similarly named item is created, then the new item should be assigned a newly generated identity as it is not the same item as the earlier item. The @id attribute is optional, but recommended for all elements which will contain any other identity attributes. from group uslm:IdentificationGroup
temporalId [0..1]uslm:MediumStringSimpleType The @temporalId attribute is a name, scoped to the document, that is intended to reflect the current identify of the element in a human-readable way. This means that the @temporalId may need to be recomputed based on the temporal state of a document or according to the temporal specification in a requesting URL. A @temporalId is intended to be scoped to the document as a whole while the @name is scoped to its immediate parent. The @temporalId is built as an "_" separated hierarchy of @name or, in the absence of an @name, element names. However, in a couple cases, the levels of the hierarchy are suppressed. First of all, the <main> level is suppressed when calculating any @temporalId contained within. Secondly, when dealing with sections which are numbered as a sequence without regard to the upper levels, then the upper levels are suppressed from the computation of the @temporalId. Some examples: * "s2" - section 2 in the main part of the document * "schedule_s2" - section 2 in the schedule * "pt2_d1" - division 1 of part 2 in the main part of the document The @temporalId attribute is optional. from group uslm:IdentificationGroup
identifier [0..1]uslm:LongStringSimpleType Use the @identifier attribute to specify the URL context of the element. Typically, the @identifier will be established on the root element or on any element, such as a <quotedContent> element, that changes the context. The @identifier attribute is optional. from group uslm:IdentificationGroup
scope [0..1]uslm:LongStringSimpleType Use the @scope attribute to specify the scope within which the @identifier attribute is valid. Typically, @scope is formatted as a URL, referring to a specific context. @scope is used for terms within in definitions to specify the scope of the definition. The @scope attribute is optional. from group uslm:IdentificationGroup
role [0..1]uslm:ShortStringSimpleType Use the @role attribute to provide further refinement to an element's type. This is particularly useful when defining a refinement of an element from the abstract set. Another possible use is to use the customary local name for an element whenever the element name is not a complete match. For example, if the customary name for an "explanation" is "summary", then the element can be expressed as <explanation role="summary">. There is a rough equivalence between an element of a base class with a @role attribute and a derived class in the schema, although this equivalence is not explicit. For example <level role="division"> is roughly equal to <division>. When transforming XML to HTML, the @role attribute should be appended to the element name using an "_" underscore and used as the first value in the HTML @class attribute. If desired, the proposed XHTML @role attribute can be computed as either the XML @role attribute or, in the absence of the XML @role attribute, the XML element name. For example: <level role="division"> => <div role="division" class="level_division"> <division> => <div role="division" class="division"> This approach is easily reversible. In a similar way to the @class attribute, multiple role values can be specified in a space separated list. from group uslm:ClassificationGroup
class [0..1]uslm:MediumStringSimpleType The @class attribute corresponds to the @class attribute in HTML. It can be used to specify presentation characteristics of an element that are not specified by the element name and the @role attribute. For example, the @class attribute can be used to specify the presence or absence of the ending separator. Like the HTML @class attribute, multiple class values can be specified in a space separated list. from group uslm:ClassificationGroup
style [0..1]uslm:LongStringSimpleType The @style attribute is used to specify CSS attributes that override the default styles defined for an element or an element class. The current loose-leaf publication standards should be specified using an external style sheet and the use of the @style attribute should be reserved for exception cases where the default presentation must be overridden. from group uslm:ClassificationGroup
styleType [0..1]uslm:StyleTypeEnum The @styleType attribute is used to set the overall semantic type of the block. This has rendering implications. Only a small set of values is allowed. Default value is "OLC". from group uslm:ClassificationGroup
note [0..1]uslm:LongStringSimpleType The @note attribute should be the primary mechanism for recording simple text notes to be associated with elements. from group uslm:AnnotationGroup
alt [0..1]uslm:LongStringSimpleType The @alt attribute should be used to provide an alternative description of the element. For use with WCAG 2.0 and other accessibility initiatives. from group uslm:AnnotationGroup
meta [0..1]uslm:LongStringSimpleType The @meta attribute should be used to associate metadata information with the element for search and other uses. How this attribute is used is not prescribed by the schema. from group uslm:AnnotationGroup
misc [0..1]uslm:LongStringSimpleType The @misc attribute is provided for future use. from group uslm:AnnotationGroup
draftingTip [0..1]uslm:LongStringSimpleType The @draftingTip is for internal use. from group uslm:AnnotationGroup
codificationTip [0..1]uslm:LongStringSimpleType The @codificationTip is for internal use by the OLRC. from group uslm:AnnotationGroup
title [0..1]uslm:MediumStringSimpleType The @title attribute is used to specify the text describing the element in a table of contents or index. It must be a simple text string and should consist of fewer than 40 or so characters - although this is not enforced. from group uslm:DescriptionGroup
brief [0..1]uslm:LongStringSimpleType The @brief attribute is an alternate method for providing a longer description of an element, limited to 1024 characters. from group uslm:DescriptionGroup
sortOrder [0..1]xsd:integer The @sortOrder attribute is used to specify a sorting order for a list of items, when that sort order is not the document sequence. The @sortOrder value must be specified as a positive integer. This attribute should rarely be used. from group uslm:DescriptionGroup
startPeriod [0..1]uslm:DateSimpleType The @startPeriod attribute is the earliest date that a particular version applies to. The @startPeriod is not necessarily the effective date. It's merely the earliest date that the particular version of the text should be returned in point-in-time calculations. The @startPeriod works with the @endPeriod which defines that last date that a specific version applies to. Together, the @startPeriod and the @endPeriod define a period of time that the version applies to. This version may be in states such as pending, operational, partially commenced, suspended, or even repealed. If the @startPeriod is not specified, then all past time is assumed. from group uslm:VersioningGroup
endPeriod [0..1]uslm:DateSimpleType The @endPeriod attribute is the last date that a specific version of the text should be returned in point-in-time calculations. If the @endPeriod is not specified, then all future time is assumed. from group uslm:VersioningGroup
status [0..1]uslm:StatusEnum The @status attribute is used to show the status of a version of provision. This attribute works with the @startPeriod and the @endPeriod and applies to the period of time defined by these attributes. from group uslm:VersioningGroup
partial [0..1]xsd:boolean The @partial attribute is used, in conjunction with the @status attribute to indicate that the status is not fully applied. from group uslm:VersioningGroup
inEffect [0..1]xsd:boolean The @inEffect attribute is used to indicate whether the level or provision is currently in effect. The default value is 'true'. Note that the @status attribute also contains information about the state of a provision. If the value of the @status attribute is anything other than 'inEffect' the value of the @inEffect attribute should be 'false'. The net effect of contradictory values of these two attributes is not defined. from group uslm:VersioningGroup
Any attribute [0..*]Namespace: ##other, Process Contents: laxfrom type uslm:BaseBlockType
changed [0..1]uslm:ChangedEnum The @changed attribute indicates if the component has been added, deleted, or is not changed. This is mostly used in Engrossed Amendments and Reported Bills. The @changed attribute is optional.
origin [0..1]xsd:anyURI The @origin attribute is used to refer to the origin of quoted text. The value must always be specified as a relative URL conforming to the reference specification. The @origin attribute is optional.
href [0..1]xsd:anyURI The @href attribute is used to specify references to external documents or items in documents. The value must always be specified as a relative URL conforming to the reference specification. from group uslm:ReferenceGroup
idref [0..1]xsd:IDREF The @idref attribute is used to specify references to internal elements within the same document. The @idref is specified as the value of the @id attribute of the element being referenced. As in HTML, there is an equivalence between an @href specified as href="#{id}" and idref="{id}". However, the @idref attribute is preferred for internal references. If the @idref points to a <ref> element, then the referencing element builds on top of that reference, acquiring its attributes as default values (which may be overridden by local values). This is a recursive structure; an element may, through the @idref attribute, point to an <ref> element which itself builds on another <ref> element, and so on. This is to support the complex referencing sometimes found in legislation. from group uslm:ReferenceGroup
portion [0..1]uslm:MediumStringSimpleType The @portion attribute is used, in conjunction with the @idref attribute, when only a portion of the referenced item is being affected. The value of @portion is an additional part to append to the URL, with a "/" separator to identify the item affected. Do not include a leading "/" in the @portion value. from group uslm:ReferenceGroup

Used in

Substitution hierarchy

Sample instance

<uslm:referenceItemNamespace: ##other, Process Contents: laxfrom type />