In-line text stylings

These elements provide various font stylings for in-line text, complete with descriptions, examples, and usage notes.

Common in-line element stylings

We frequently use these in-line elements.


Element	Sample	Notes
Bold (<b>)	sample text	To call attention to most important text fragments; draw the eye to; scanning aid. Use sparingly; be judicious. OK to use as lead-in bold for list items. Do not use just to strengthen your tone.
Code phrase (<codeph>)	`sample text`	For code elements appearing in text.
File path (<filepath>)	sample text	The name and optionally the location of a referenced file by specifying the directory containing the file, and other directories that may precede it in the system hierarchy
Italic or emphasis (<i>)	sample text	Emphasis or italic. Good to use the first time you reference a term that needs definition (and which the definition quickly follows in the same topic).
Option (<option>)	sample text	Option to modify a command or SETUP SCREEN option.
Phrase (<ph>)	sample text	This gets passed-through with no formatting. Use this element to: Conditionalize text. See Conditional processing. Reuse text in aa a conref.
Term (<term>)	sample text	Words that label a concept, where the definition of the term quickly follows. May also be used for a glossary term. For information about using Term to highlight a glossary entry, see Creating a glossary entry.
Trademark element/symbol (<tm>)	sample text™	Do not apply Superscript to the mark. Use for the first citation of a Medallia-only trademark.
User input (<userinput>)	`sample text`	Text the user should enter.

These in-line elements are available, but we rarely use them.


Element	Sample	Notes
Line-through or strike-through (<line-through>)	sample text	(Avoid) Indicates text that is no longer true, but which must be included.
Quotation (<q>)	“sample text”	(Avoid) Text quoted from another source. Short quote displayed in-line; unlike <lq> which is one of the Block elements.
Superscript (<sup>)	sample^text	We generally do not use this.
Subscript (<sub>)	sample_text	We generally do not use this.
Syntax phrase (<synph>)	sample text	We do not use this.
Underline (<u>)	sample text	Do not use this because it is easily confused with links.

These elements identify user-interface elements.


Element	Sample	Notes
GUI control element (<uicontrol>)	sample text	GUI elements the user can interact with, especially buttons.
Window title (<wintitle>)	sample text	Title for the names of screens, windows, dialog, etc. Not use use when the name appears in a breadcrumb list.
Keyboard shortcut (<shortcut>)	Sample text	(Not used) Keyboard shortcut for a menu. Must appear in a <ui control>. In this sample, the 'S' is the shortcut.
Screen name (<screen>)	sample text	DO NOT USE.

These software element stylings are available, but we generally don't use them.


Tag	Sample	Notes
Message phrase (<msgph>)	`sample text`	Text content of a message produced by an application or program.
Message block (<msgblock>)	sample text	a multi-line message or set of messages
Message number (<msgnum>)	sample 505 text	The number of a message produced by an application or program
Command name (<cmdname>)	sample text	Command name in a discussion. Use curl to connect to the server.
Variable name (<varname>)	`sample text`	A variable that must be supplied to a software application
System output (<systemoutput>)	`sample text`	Computer output or responses to a command or situation.

These are available, but we generally don't use them.


Element	Sample	Notes
Keyword (<keyword>)	sample text	Used for "variable" keywords. Should have no formatting in output.
API name/endpoint (<apiname>)	sample text	For API names; use <cmdname> for command names.
Parameter name (<parmname>)	sample text	Parameter name
Command name (<cmdname>)	sample text	Command name