[go: up one dir, main page]
Scribd
Upload
58 views3 pages

Test 2

This document outlines conventions used in documentation, including symbols used to indicate precautions, important information, and additional details. It describes typographical conventions such as formatting for character strings to enter, settings to make, and commands. Drawing conventions are also discussed, noting drawings may be simplified or modified for description purposes.

Uploaded by

kamran ali
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
58 views3 pages

Test 2

This document outlines conventions used in documentation, including symbols used to indicate precautions, important information, and additional details. It describes typographical conventions such as formatting for character strings to enter, settings to make, and commands. Drawing conventions are also discussed, noting drawings may be simplified or modified for description purposes.

Uploaded by

kamran ali
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 3

Documentation Conventions Page 1 of 3

Documentation Conventions
n Symbols
The following symbols are used in the User's Manuals.
Indicates precautions to avoid a danger that may lead to death or severe
injury.

Indicates precautions to avoid a danger that may lead to minor or moderate


injury or property damage.

Indicates important information required to understand operations or


functions.
Indicates additional information.

Indicates referenced content.


In online manuals, you can view the referenced content by clicking the links
that are in green text. However, this action does not apply to the links that
are in black text.

n Typographical Conventions
The following typographical conventions are used throughout the User's Manuals.

l Commonly Used Conventions throughout the User's Manuals


• Character string to be entered
The characters that must be entered are shown in monospace font as follows:
Example:
FIC100.SV=50.0

• ▼ Mark
This symbol indicates the description for an item for which you should make a setting in the product's
engineering window.
While operating an engineering window, the help information for the selected item can be accessed
from "Builder Definition Items" in the Help menu. Listing more than one definition item after this
symbol implies that the paragraph on the page describes more than one definition items.
Example:
▼ Tag Name, Station Name

• Δ Mark
Indicates that a space must be entered between character strings.
Example:
.ALΔPIC010Δ-SC

• Character string enclosed by braces { }

file:///C:/Program%20Files%20(x86)/YOKOGAWA/IA/iPCS/Products/CENTUMVP/Pro... 11/15/2022
Documentation Conventions Page 2 of 3

Indicates character strings that may be omitted.


Example:
.PRΔTAG{Δ.sheet name}

l Conventions Used to Show Key or Button Operations


• Characters enclosed by brackets [ ]
When characters are enclosed by brackets in the description of a key or button operation, it indicates
a key on the keyboard, a key on the operation keyboard, a button name in a window, or an item in a
list box displayed in a window.
Example:
To alter the function, press the [ESC] key.

l Conventions Used in Command Syntax or Program Statements


The following conventions are used within a command syntax or program statement format:
• Characters enclosed by angle brackets < >
Indicate character strings that user can specify freely according to certain guidelines.
Example:
#define <Identifier> <Character string>

• "..."
Indicates previous command or argument that may be repeated.
Example:
Imax (arg1, arg2, ...)

• Characters enclosed by brackets [ ]


Indicate character strings that may be omitted.
Example:
sysalarm <format character string> [, <output value>…]

• Characters enclosed by separators | |


Indicates character strings that can be selected from more than one option.
Example:

n Drawing Conventions
Drawings used in the User's Manuals may be partially emphasized, simplified, or omitted for the
convenience of description.
Drawings of windows may be slightly different from the actual screenshots with different settings or
fonts. The difference does not hamper the understanding of basic functionalities and operation and

file:///C:/Program%20Files%20(x86)/YOKOGAWA/IA/iPCS/Products/CENTUMVP/Pro... 11/15/2022
Documentation Conventions Page 3 of 3

monitoring tasks.

file:///C:/Program%20Files%20(x86)/YOKOGAWA/IA/iPCS/Products/CENTUMVP/Pro... 11/15/2022

You might also like