S

Last Updated : Oct 06, 2021 |

section

Represents an organizational division in a topic. Sections are not available in task topics.
Use sections to organize subsets of information that are directly related to the topic. You can include multiple <section> elements in a topic. However, the sections do not represent a hierarchy. They represent peer divisions of that topic.
You cannot nest sections. You can modify the attributes of a <section> element to add a title to a section.

security

As defined in the Avaya Style Guide, use the <security> element to call attention to situations that can increase the potential for unauthorized use of a telecommunications system.

shortcut

Identifies a keyboard shortcut for a menu or window action inside a <uicontrol>. The character that you identify as a shortcut is underlined.
For example, <uicontrol><shortcut>P</shortcut>rogram</uicontrol>.

shortdesc

The short description represents the purpose or theme of the topic, using which readers can determine whether a topic might be of interest to them. You can add the element both in topics and maps.
Keep the short description to a single, concise paragraph with one or two sentences of about 50 words. Otherwise, use the <abstract> element to provide richer content around the <shortdesc> element.
shortdesc is used in link previews and HTML outputs as hover text, and in search results.

simpletable

Creates tables with a s structure that do not need a caption.
The <simpletable> element must contain the following elements:
  • An <sthead> element to define for column headings.
  • One or more <strow> elements to define for rows of data in the table.
  • One or more <stentry> elements to define table cells.
Use <simpletable> instead of table whenever possible. If you do require a more complex table, use the <table> element.
Do not include tables within the paragraph element for the preceding paragraph. Make sure that you insert any tables after the closing tag.

simple-equation

Use the <simple-equation> element when you are including a simple equation in your content.

sstitle

Provides the heading in a <subsection> element.
This element is automatically inserted when you select the <subsection> element. The <sstitle> element is only supported for use within a <subsection> element. If you select <sstitle> in any other context, auto-generated text warns you that this element is only supported with a <subsection>.

stentry

Represents a single table cell in a simple table.
Use the <stentry> element in the <simpletable> element. You can place any number of <stentry> cells in the following elements:
  • An <sthead> element if the cell will be part of a column heading.
  • An <strow> element if the cell will be part of a table row.

step

Represents a particular action that a user must complete to accomplish the overall task in the topic.
Each <step> element task must contain a command <cmd> element. The step element can also contain the following optional elements:
  • <info> element for additional information
  • <substep> element for one or more substeps
  • <stepxmp> for an example related to the step
  • <choices> for choices that need to be made during the step
  • <stepresult> for the rare occasion when the result of the step is not obvious
If a step is optional, insert the word Optional in parenthesis at the beginning of the step.

stepresult

Provides useful information on the expected outcome of a step.
Only use the <stepresult> element if the result is not obvious and only when the result will provide value to the user.

steps

Provides the main content of a task topic.
The <steps> section includes a series of steps that the user must follow in the specified order to accomplish the task. The <steps> section of a task must contain one or more <step> elements.

stepsection

The <stepsection> element provides expository text before a step element. This element is useful if you need to describe a series of upcoming steps or if there’s important information you need to include before a step that isn’t appropriate to include in the previous step. This element should not be used to insert a title before a group of steps. In the output, the stepsection appears without a step number.

steps-unordered

Contains one or more steps that must be performed to complete a task.
Use the <steps-unordered> element when the order of steps may vary from one situation to another, or when the task requires only a single step.
The <steps-unordered> element must contain one or more <step> elements.

stepxmp

Describes an example that illustrates how to perform a step in a task. The example can be a single sentence or an entire paragraph.
Do not use the <stepxmp> element to provide an example of the entire task. Use the <example> element to provide an example of the entire task.

sthead

Specifies the header row for a simple table.
The <sthead> element is a container element inside the simple table.
The header row is optional in a simple table.

strow

Identifies a row in a simple table>.
The <strow> element must contain at least one <stentry> element.

structbody

The <structbody> element is the main body-level element for a structure topic. The <structbody> element allows <structbody> and <required-cleanup> elements.

structsection

The <structsection> element represents an organizational division in a topic. Sections are used to organize subsets of information that are directly related to the structure. Multiple sections within a single topic do not represent a hierarchy, but rather peer divisions of that topic. Sections cannot be nested and may have an optional title.

structure

Use the structure topic type to describe the components of a container of some kind, such as a product interface or a hardware component. For a user interface, this can include application fields and icons, report fields, etc. For hardware components, this can include a list of components of a server or an image followed by a description of the image contents.
When creating a new structure topic, use the Structure tag template.

sub

Indicates that the text must be subscripted, or placed lower in relationship to the surrounding text.
The <sub> element determines the appearance of the text in the output.

subsection

Use this element to create run-in headings, where the text of the paragraph immediately follows the title and the entire contents is contained with the <subsection> element. <subsection> should only be used for single paragraphs.
The difference between <section> and <subsection> is related to the scale of the content. You should use <section> when you need to break the topic into parallel groups of content, basically creating a level of hierarchy in the topic. Use <subsection> when you have a group or list of items that with titles that don’t require breaking the topic into major groupings or creating another level of hierarchy.
Never add additional paragraphs after the subsection element that you intend for the sstitle to be grouped under. The subsection element is intended only for use as a run-in heading, and no additional structure or paragraphs should be added.

substep

Indicates an action that is part of a step.
The <substep> element has the same structure as a <step>. However, you cannot include lists of choices or substeps within a <substep> element. This restriction prevents unlimited nesting of steps.
You must contain a <substep> element inside a <substeps> element.

substeps

Breaks a step down into a series of separate actions.
Only use the <substeps> element after you have tried to describe the steps of a task in a single level of steps. If you need to use more than one level of substep nesting, rewrite and simplify the task.
The <substeps> section of a task must contain one or more <substep> elements.

sup

Indicates that the text must be superscripted, or placed higher in relationship to the surrounding text.
The <sup> element determines the appearance of the text in the output.

systemoutput

Identifies computer output or responses to a command or situation. This is typically intended for messages that come out from scripts or a command line, such as the Windows command line.
Do not use the <systemoutput> element for messages generated by an application, use the <msgph> element instead.
In the output, all text you enter in the <systemoutput> element is displayed in a monospaced font.