uslm:preface
Documents may optionally have a preface before the main body of
the document. Some information in the preface may be duplicated
in the meta section. The content in the meta section would be
normalized, whereas the content in the preface would contain the
text as it is rendered for the user.
Element information
Namespace: http://schemas.gpo.gov/xml/uslm
Schema document: uslm-components-2.1.0.xsd
Type: uslm:PrefaceType
Properties: Global, Qualified
Content
- Choice [0..*]
- Any element Namespace: http://purl.org/dc/elements/1.1/, Process Contents: lax
- uslm:property A <property> is a simple value recorded with the document. Typically properties are stored in the <meta> and/or <preface> blocks of the document. If a property in the <meta> block has textual content, then this text is not intended for publication. However, if a property in the <preface> block has textual content, then this text is intended for publication.
- uslm:coverTitle A <coverTitle> is the version of the title that is rendered on the cover page. This is, for example, found on some Public Laws.
- uslm:amendmentNumber The <amendmentNumber> is a property used to identify the amendment number attached to this amendment document.
- uslm:congress The <congress> is a property used to identify the congress number that the document was created in. When in the <meta> element, the content is the normalized form (e.g., 115). When in the <preface> element, the content is the form that is rendered (e.g., One Hundred Fifteenth Congress of the United States of America).
- uslm:currentChamber The <currentChamber> is a property used to identify the chamber that currently has control of the legislation (e.g., “In the House of Representatives” or “In the Senate of the United States”). In the <meta> element the choices are 'HOUSE' or 'SENATE'. For conference reports there are two elements, one for each of HOUSE and SENATE.
- uslm:currentThroughPublicLaw The <currentThroughPublicLaw> is a property used to identify the public law number of the latest amendment(s) applied to a statute compilation, or, if appropriate, the fact that no amendments have been applied.
- uslm:distributionCode The <distributionCode> is a property that signals to GPO how many copies to print by law. These codes are used by several areas in Plant Operations.
- uslm:docNumber The <docNumber> is a property that contains a numeric designation assigned to this document. The document number should not contain any document prefix. Use the <docType> for the prefix, or the <docTitle> in amendment documents where that is appropriate.
- uslm:docPart The <docPart> is a property used to identify the part of the document, such as "Part 2 of 3". The attribute @role holds the type of part, such as "book", "part", etc.
- uslm:docPublicationName The <docPublicationName> is a property used to record the name of the publication that this document is part of. The values of the <docPublicationName> are not defined.
- uslm:docReleasePoint The <docReleasePoint> is a property used to record the point the document was released. The values of the doc status are not defined. For a USC title, this may be the Public Law number that the title is updated through.
- uslm:docStage The <docStage> is a property used to hold the stage of the document, such as Enrolled. The attribute @value holds the normalized stage, from the list at https://www.govinfo.gov/help/bills#versions, capitalized.
- uslm:enrolledDateline The <enrolledDateline> is a property used to hold the date and location of the start of the session, which is printed on enrolled bills.
- uslm:purpose The <purpose> is a property that documents the purpose in amendment documents. This is often related to the official title of the bill being amended.
- uslm:relatedDocument The <relatedDocument> is a property used to identify a document (such as a committee report or chamber Calendar) that is related to this document and referenced from it in the preface or meta. If there are multiple parts to the referenced report, then the <relatedDocuments> element is used as a wrapper around the individual reports.
- uslm:session The <session> is a property used to identify the session within a congress that the document was created in. When in the <meta> element, the content is the normalized form (e.g., 1). When in the <preface> element, the content is the form that is rendered (e.g., AT THE FIRST SESSION).
- uslm:subject The <subject> is a property used to identify the subject associated with the document.
- uslm:volume The <volume> is a property used to identify volume of the document.
- uslm:provisionRange The <provisionRange> property gives the starting and ending provision that is covered by the document.
- uslm:set Properties can be grouped into sets. These sets can be used to represent something like a series of events, a person, or another other object related to the document.
- uslm:action The <action> contains information about the actions associated with the document.
- uslm:coverText A <coverText> is content on the cover page that is in addition to, or instead of, the coverTitle.
- uslm:draftingOffice The <draftingOffice> is a property used to identify the office that drafted the amendment or early-stage bill or resolution. Examples are SLC, OLRC, or a committee.
- uslm:figure A <figure> is a unit of content, optionally with a caption, that is self-contained, that is typically referenced as a single unit from the main flow of the document, and that can be moved away from the main flow of the document without affecting the document’s meaning. A figure usually contains an <img> element, but may instead contain mathematical or chemical markup. This element is modelled after the HTML5 <figure> element.
- uslm:firstPageHeading A <firstPageHeading> is heading content typically used in bills and amendment documents that do not have a cover page but have content that fulfills a similar purpose.
- uslm:firstPageSubheading A <firstPageSubheading> is subheading content typically used in bills and amendment documents that do not have a cover page but have content that fulfills a similar purpose.
- uslm:leftRunningHead A <leftRunningHead> contains the text to be printed in the left hand running header. It is used, for example, in the CFR.
- uslm:centerRunningHead A <centerRunningHead> contains the text to be printed in the center running header. It is used, for example, in amendment documents.
- uslm:rightRunningHead A <rightRunningHead> contains the text to be printed in the right hand running header. It is used, for example, in the CFR.
- uslm:slugLine The <slugLine> contains the information that may be printed on the slug (footer) line. This is the USLM equivalent to the I90 line.
- uslm:relatedDocuments The <relatedDocuments> contains information about other documents such as reports and calendars that are related to the document. This is used when multiple report parts are referenced, for example. The <relatedDocument> element is used for individual references to documents. In USLM 2, only related documents that are specifically added by the clerk or drafter are to be added to the USLM relatedDocument elements.
- uslm:starPrint A reprint of a bill, resolution, amendment, or committee report correcting technical or substantive errors in a previous printing; so called because of the small black star that appears on the front page or cover. Within the <meta> section, the content is the star print number; 0 is the default (no star print). The maximum is 4 stars printed. Within the <preface> section, the content is the actual star characters to be printed.
- uslm:notes The <notes> is a container for sets of individual notes.
- uslm:legislativeHistory A <legislativeHistory> contains a set of notes about a piece of legislation. It is typically found at the end of a Public Law. This element does not contain the 'amended by' or 'amended through' information associated with a statute compilation; there are meta elements defined for that purpose.
- uslm:note A <note> is a generic element for a note associated with items in the document.
- uslm:elided An <elided> element is a replacement for text content that has been elided or omitted from this document. The optional ref attribute may point to the text that was elided. The <elided> element may only contain text content (typically asterisks, called 'stars').
- uslm:sourceCredit A <sourceCredit> is a note included to indicate the source of a provision. It usually will contain a reference to the source of the provision and the Statute(s) that have affected it. Source credits are usually set out in parenthesis. The surrounding parentheses are shown in the text - they are not automatically added.
- uslm:uscNote A <uscNote> is a note below sections and big-level headings in the U.S. Code.
- uslm:statutoryNote An <statutoryNote> is a note that becomes part of the law.
- uslm:drafterNote A <drafterNote> is a note that does not become part of the law. It is used by drafters for their own purposes (commenting out a section of drafted content, for example, or asking questions, or proposing alternative wording) and is generally deleted before the document is published to others.
- uslm:editorialNote An <editorialNote> is a note included for editorial purposes only. While present in the text of the document as printed, it is not a part of the law. Editorial notes are often used to record where provisions have been omitted or other changes have been made, or in a preface of the CFR.
- uslm:changeNote A <changeNote> is a note that records a non-substantive change that has been made to the US Code. Usually change notes are set out in square brackets and these must be set out in the text and must not be automatically added.
- uslm:authority An <authority> is a note included to indicate the authority behind a provision. In the CFR and statutes at large, the <authority> is the law which authorizes the regulation.
- uslm:source A <source> is a note included to indicate the source of a provision. In the CFR, the <source> is a citation to an entry in the Federal Register where the provision is sourced. <source> is similar to <sourceCredit> in the U.S. Code, but is specifically called "Source" in the CFR.
- uslm:effectiveDateNote An <effectiveDateNote> is a note to indicate the effectivity of a provision. In the CFR, the <effectiveDateNote> contains a heading, explanatory text, and sometimes the text of the provision that will become effective on that date. Some of this new text may be elided.
- uslm:frDocId An <frDocId> is a note identifying the Document ID of an entry in the Federal Register.
- uslm:billingCode A <billingCode> is a note containing the billing code of an item. It is used, for example, in the Federal Register.
- uslm:editionNote An <editionNote> is a note that describes the edition of the document. It is used, for example, in the preface of the CFR for the "Official Edition Notice".
- uslm:organizationNote An <organizationNote> is a note that identifies an organization associated with the document. It is used, for example, in the preface of the CFR and the statutes at large to identify the organization that publishes the document.
- uslm:citationNote A <citationNote> is a note that gives information about how to cite this document and/or about citations within the document. It is used, for example, in the preface of the CFR.
- uslm:explanationNote An <explanationNote> is a note that gives an explanation. It is used, for example. in the preface in the CFR and statutes at large to explain the document.
- uslm:findingAidsNote A <findingAids> element is one or more finding aids, typically found in the back matter of a publication. It is used, for example, in the back matter of the CFR.
- 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.
- uslm:p A <p> is a simple paragraph. This is different from the more complex numbered <paragraph> element used for the formal paragraph level of legislative documents.
- uslm:editorialContent Used for preliminary content, which is non-statutory content added by editorial teams, for example when creating a <statuteCompilation> from a public law.
- uslm:toc A <toc> is a table of contents. A table of contents can appear in a number of locations in document. A table of contents can appear in three different locations: - It can appear anywhere within the top of the <main> element, before the levels. - It can appear in any level following the <heading>, <subheading>, and any notes. - It can appear in an <appendix>.
- uslm:index An <index> is an index element. An index can appear before or after the main content of the document. The most common use for an <index> is as a basis of elements that have specific names for the specific type of item that is indexed or listed, such as the <listOf...> elements. The <index> element is closely related to the <toc> element.
- uslm:tableOfTitlesAndChapters A <tableOfTitlesAndChapters> is a table of titles and chapters.
- uslm:listOfAgencies A <listOfAgencies> is a list of agencies. It is found for example in the back matter of the CFR.
- uslm:listOfSectionsAffected A <listOfSectionsAffected> is a list of sections that are affected. It is found for example in the back matter of the CFR.
- uslm:listOfBillsEnacted A <listOfBillsEnacted> is a list of bills enacted into law; either public law or private law. It is found for example in the front of the Statutes at Large.
- uslm:listOfPublicLaws A <listOfPublicLaws> is a list of public laws. It is found for example in the front of the Statutes at Large.
- uslm:listOfPrivateLaws A <listOfPrivateLaws> is a list of private laws. It is found for example in the front of the Statutes at Large.
- uslm:listOfConcurrentResolutions A <listOfConcurrentResolutions> is a list of concurrent resolutions. It is found for example in the front of the Statutes at Large.
- uslm:listOfProclamations A <listOfProclamations> is a list of presidential proclamations. It is found for example in the front of the Statutes at Large.
- uslm:popularNameIndex A <popularNameIndex> is a list of popular names for acts. It is found for example in the back of the Statutes at Large.
- uslm:subjectIndex A <subjectIndex> list is an index of subjects. It is found for example in the back of the Statutes at Large.
from subst. group uslm:propertyfrom subst. group uslm:firstPageHeadingfrom subst. group uslm:leftRunningHeadfrom subst. group uslm:notesfrom subst. group uslm:notefrom subst. group uslm:footnotefrom subst. group uslm:pagefrom subst. group uslm:tocfrom subst. group uslm:index
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| xml:base | [0..1] | xsd:anyURI | denotes 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] | Anonymous | denotes 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] | Anonymous | denotes 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: lax | from type uslm:BaseBlockType |
Used in
- Type uslm:AppendixType (Elements uslm:appendix, uslm:schedule)
- Type uslm:LawDocType (Elements uslm:lawDoc, uslm:bill, uslm:constitutionalAmendment, uslm:pLaw, uslm:statute, uslm:statuteCompilation, uslm:statutesAtLarge ...more)
- Type uslm:CollectionType (Elements uslm:collection, uslm:notices, uslm:rules, uslm:proposedRules, uslm:presidentialDocs, uslm:agencyGroup, uslm:publicLaws ...more)
Sample instance
<uslm:prefaceNamespace: ##other, Process Contents: laxfrom type />