p

Indicates a paragraph element. Each paragraph is a block of text containing a single main idea.

Some elements automatically include a <p> element.

parml

Use the parameter list (<parml>) element to document a list of terms and definitions that describes the parameters for a command or an API. Parameter lists contain a series of parameter entries <plentry>.

If you are referencing the name of a parameter within the text flow of your topic or in a syntax, use <parmname>.

parmname

Use <parmname> when referencing the name of a command parameter or API parameter within the text flow of your topic or in a syntax.

If you're documenting a list of parameters and their descriptions, use <parml>.

partdesc

Use the <partdesc> element to define the heading of the description column in a parts table. The default value for this element is Description.

parthead

The <parthead> element defines the heading row of the parts table and includes the <partname> and <partdesc> elements.

partname

Use the <partname> element to define the heading of the name column in a parts table. The default value for this element is Name.

partrow

The <partrow> element contains <partname> and <partdesc> elements that you can use to provide the names and descriptions in a parts table.

parttable

Use the <parttable> element within a structure topic type to create a parts table that describes the components of a container of some kind, such as a product interface or a hardware component. The <parttable> element contains the <parthead> and multiple <partrow> elements.

ph

The phrase (<ph>) element is used to organize content for reuse or conditional processing (for example, when part of a paragraph applies to a particular audience).

Take care not to overuse the <ph> element for reuse to the point that it becomes difficult to manage and maintain. See Guidelines for reusing content for more information about reuse through conrefs.

pd

Use a parameter definition (<pd>) to provide a command or API parameter term description within a parameter list entry (<parml>). Each <pd> must have a corresponding parameter term (<pt>).

If you are referencing the name of a parameter within the text flow of your topic or in a syntax, use <parmname> instead of a parameter list.

platform

The <platform> metadata element contains a description of the operating system and/or hardware related to the product being described by the <prodinfo> element.

plentry

The parameter list entry element (<plentry>) contains one or more parameter terms and definitions (pd and pt) within a <parml>. Parameter entries document terms and definitions that describes the parameters for a command or an API.

postreq

Describes steps or tasks that the user must perform after the successful completion of the current task.

The <postreq> element is optional. This element automatically inserts a heading above the text.

pre

Use <pre> for samples of preformatted ASCII outputs, such as log files or report outputs.

In the output, all text you enter in the <pre> element has preserved line endings and is displayed in a monospaced font.

Do not use <pre> for code samples; use <codeblock> instead because it is more semantic.

prodinfo

The <prodinfo> metadata element in the prolog is a container for prodname, platform, featnum, component, vrmlist.

prodname

The <prodname> metadata element contains the name of the product that is supported by the information in this topic.

prereq

Describes steps or tasks that user must perform before starting the current task. Do not include concept or reference information in a <prereq> element.

The <prereq> element is optional. This element automatically inserts a heading above the text.

product

Use the <product> element for names of products. Rather than typing each occurrence of a product name, reuse the defined product elements from the team reusable elements topic.

propdesc

Provides a short description of a property type and its values in a properties table. Properties tables are part of reference or structure topics.

You must use the <propdesc> element with a <property> element.

propdeschd

Specifies a heading for the Description column in a properties table. Properties tables are part of reference or structure topics.

You must use the <propdeschd> element inside a <prophead> container element.

properties

Provides a list of properties, typically rendered in a table format. Properties tables are part of reference or structure topics.

Each property in a <properties> element can include the type, value, and a description.

To represent multiple values for a type, create additional property elements. Use the <propvalue> element for each successive value. You can also use <propdesc> when needed.

property

Defines a property in a Properties table. Properties tables are part of reference or structure topics.

The <property> element contains three optional elements: type, value, and description.

prophead

Specifies the header row for a Properties table. Properties tables are part of reference or structure topics.

The <prophead> element is a container element inside the Properties table. The <prophead> element can contain the following header elements: <propdeschd>, <proptypehd>, and <propvaluehd>.

proptype

Defines the type for the current property in a Properties table.

proptypehd

Specifies a heading for the Type column in a Properties table.

You must use the <proptypehd> element inside a <prophead> container element.

propvalue

Defines the value or values of the current property type in a Properties table. Properties tables are part of reference or structure topics.

If each value for the property needs a separate description, enter the values in separate rows of the table and leave the <proptype> element blank.

propvaluehd

Specifies a heading for the property value column in a Properties table. Properties tables are part of reference or structure topics.

You must use the <propvaluehd> element inside a <prophead> container element.

pt

Use a parameter term (<pt>) to provide a command or API parameter term name within a parameter list entry (<parml>). Each <pt> must have a corresponding parameter definition (<pd>).

If you are referencing the name of a parameter within the text flow of your topic or in a syntax, use <parmname> instead of a parameter list.