C:\DITA\WKFS_oXygen_Files\fragments\webhelp.fragment.head.xml
Jump to main content C:\DITA\WKFS_oXygen_Files\fragments\webhelp.fragment.before.body.xml

# The Role Attribute As Used in Expere

Values for the Role attribute honored by Expere stylesheets.

## Overview

This document presents the values for the Role attribute that are honored by the stylesheets delivered with Expere.

The Role attribute (note the upper-case ‘R’) is available for use on the following 59 elements in the Expere authoring schema.

Appendix | FragmentedPara | Parties
AppendixIntro | Hyperlink | PartyBlock
BlankLine | IndividualInfo | PartyPara
Body | InlineGraphic | Phrase
Chapter | Instruction | Prefix
ChapterInfo | Keyword | Prolog
Citation | KeywordSet | RecordingInfo
CitationComment | List | Section
Comment | ListItem | SectionInfo
DefinedTerm | Notary | Subscript
DocInfo | NotaryBlock | SubTitle
DocTitle | NotaryInfo | Suffix
Document | Notice | SummaryInfo
DocumentReference | NoticeContent | Superscript
Emphasis | NoticeInfo | Symbol
EntityInfo | NoticeSubTitle | Table
Epilog | NoticeTitle | Title
ExternalGraphic | ObjectInfo | TitleInfo
FedBox | Other | TransactionGraphic
FormalPara | Para |

Those element names highlighted in boldface have stylesheet behaviors associated with them. In addition, the presentation of some elements may be affected by Role attributes of ancestor or descendant elements.

All of the above element definitions are associated with the same attribute definition via a schema mechanism called a reference. There is one element, SeparatorLine, that specifies the attribute directly rather than by reference, however, that usage is marked as deprecated. The single definition that is shared by all the other elements defines the attribute as being of type ‘NMTOKENS’, and no specific values are defined.

The value NMTOKENS specifies a sequence of zero to many NMTOKEN values separated by one or more spaces. Each NMTOKEN is composed of the one or more of the following characters:

- Letters (A-Z, a-z)
- Digits (0-9)
- Period (.)
- Hyphen (-)
- Underscore (_)
- Colon (:)
- Combining characters and extenders (not normally seen and not used in Expere)

When the value of a NMTOKEN is a Name, (meaning it is used to name an element or attribute), the NMTOKEN must begin with a letter, Underscore or Colon.

What the above means is that the following sample values for theRole attribute would be valid values:

- Role=”12345”
- Role=”__USA__”
- Role=”:--GeneralPatton--:’
- Role=”NewLine Indent FirstLineIndent”

Important: In each of the supported uses of the Role attribute, the value is case-sensitive. When a value is case-sensitive, it must be entered exactly as shown in the documentation. For example, the values “NewLine” and “Newline” are not equivalent.

Also, note that although the specification allows the Role attribute to have morethan one value, separated by spaces, the Expere stylesheets only support the uses described here. None of these uses permit more than one value for the Role attribute attached to a given element.

As a general rule, if an alternative to the Role attribute exists, we recommend that the alternative be used. In this document, when an alternative exists, the recommended usage is presented in italics.

## The Document Element

Any of the following options will result in a document that is single column, otherwise, the standard Expere document Body will be produced in two columns.

- Recordable=”Yes”
- Role=”SmallBody”
- DocumentClass=”Addendum”
- Columns=”1”

## The Emphasis Element

If Role=”LeadIn”, the contents are produced in small caps.

Recommendation: Use Capitalization=”SmallCaps”.

## The Epilog Element

The following option produces the Epilog as a single column:

- Role=”SmallBody”

## The FormalPara Element

See The Title Element

## The List Element

If Role=”KeepTogether”, the List contents are kept in the same column.

Recommendation: Use KeepTogether=”Yes”.

## The ListItem Element

If Role=”Outdent”, the block for this single ListItem is outdented (moved left) 12 points. The outdent does not change the value or type of list item marker used, if any.

## The Notary Element

If Role=”KeepTogether”, the TitleInfo/Title contents are produced in-line with the following contents otherwise the Title is produced as a separate block. In addition, the engine will try to keep all of the contents of the Notary element including SeparatorLine elements in the same column.

If the Notary element does not have Role=”KeepTogether”, any SeparatorLine element will be marked keep-with-next, so that the SeparatorLine and the following content will appear on the same column or page.

## The NotaryBlock Element

All of the contents of the NotaryBlock element are kept in the same column unless Role=”AllowBreak”.

## The Notice Element

The Notice element will be bounded by a 2 point box if any of the following conditions apply:

- Boxing=”Yes”
- Role=”Boxed” (border width will be 1 point)
- Remap=”TextBox” (border width will be 0.25 point)
- A child NoticeInfo element has Role=”KeepTogether”

## The NoticeContent Element

If this is not the first NoticeContent child and Role=”HangingBlock”, its contents will be produced in-line with the preceding contents. Note that the NoticeTitle or NoticeSubTitle for this Notice should have RunningTitle=”Yes”.

For any NoticeContent element with Role=”HangingBlock”, the Para child elements will be produced in-line with preceding contents.

## The NoticeInfo Element

If Role=”KeepTogether”, the containing Notice will be bounded by a 2 point box (see The Notice Element.)

## The Para Element

If Role = NewLine, the Para element contents will be produced without any preceding space. There is provision for a line-of-business-specific user of WKFS_Styleguide to override the standard spacing. The Integrated Disclosures stylesheet will discard the standard spacing if the Para is a descendant of a Table element.

If Role = Indent, the Para contents will be indented from the containing block.

If Role = FirstLineIndent, the text will be indented the standard indent width.

If Role = NewLineFirstLineIndent, the effect of NewLine and FirstLineIndent are combined.

If Role = NewLineIndent, the effect of NewLine and Indent are combined.

If Role = NewLineOutdent, the effect of NewLine takes effect and the Para is outdented.

## The Parties Element

See The Title Element

## The PartyBlock Element

The EntityInfo or IndividualInfo contents are produced in a block that is indented 12 points. If Role=”KeepTogether”, the block width is set to 100%. If Role=”AllowBreak”, the contents can break across columns or pages.

## The Phrase Element

If Role=”ForeignWord”, the contents are produced in italics.

If Role=”Acronym”, the contents will be produced in a serif font.

## The Prefix Element

If Role=”Prompt”, the contents are produced in bold face.

## The Section Element

If not the descendant of a Section element and not the descendant of a Document element having Role=”SmallBody”, the section is padded left and right 10.5 points.

If not the descendant of a Document element having Role=”SmallBody” and the Section element has span=”all” and the following sibling does not have span=”all”, follow this Section with 12 points of padding.

If Role=”KeepTogether”, keep all of the contents of this element in the same column.

Recommendation: Use KeepTogether=”Yes” instead of Role=”KeepTogether”.

## The Signature Element

See The Title Element

## The SignatureSection Element

If not the descendant of a Section element and not the descendant of a Document element having Role=”SmallBody”, the section is padded left and right 10.5 points.

If not the descendant of a Document element having Role=”SmallBody” and the SignatureSection element has span=”all” and the following sibling does not have span=”all”, follow this Section with 12 points of padding.

If not the descendant of a Document element having Role=”SmallBody”, set the contents of this element to span all columns.

If Role=”KeepTogether”, keep all of the contents of this element in the same column.

Recommendation: Use KeepTogether=”Yes” instead of Role=”KeepTogether”.

## The Suffix Element

If Role=”Prompt”, the contents are produced in bold face.

## The Title Element

When the Title element is a child of the Parties, Signature or FormalPara elements the following behavior occurs:

- The element contents are produced
- If Role=”Plain”, a single space is appended, otherwise a non-breaking-space is appended. The consequence is that the last (or only) word of the Title will be produced on the same line as the first word of the next in-line content (if any) unless Role=”Plain”.

See also: The Notary Element

C:\DITA\WKFS_oXygen_Files\fragments\webhelp.fragment.after.body.xml