diff --git a/specification/langRef/base/consequence.dita b/specification/langRef/base/consequence.dita index cda146ec..882a9fd2 100644 --- a/specification/langRef/base/consequence.dita +++ b/specification/langRef/base/consequence.dita @@ -21,11 +21,11 @@

Example -

In the following code sample, a hazard statement is assigned a - "CAUTION" signal word. The type of hazard is a specified as "HOT - SURFACES," and the consequence of not avoiding the hazard is - "Contact may cause a burn." The hazard image is explicitly - associated with the type of hazard.

+ +

The following code sample shows the markup for a hazard statement + that warns about hot surfaces. The + consequence element provides information + about what might happen: "Contact might cause a burn."

<hazardstatement type="caution"> <messagepanel> <typeofhazard> diff --git a/specification/langRef/base/hazardstatement.dita b/specification/langRef/base/hazardstatement.dita index ec5e8b2e..e91da040 100644 --- a/specification/langRef/base/hazardstatement.dita +++ b/specification/langRef/base/hazardstatement.dita @@ -3,7 +3,8 @@ <xmlelement>hazardstatement</xmlelement> A hazard statement provides information about a hazard and its - consequences. It also explains how to avoid the hazard. + consequences. It also explains how to avoid the hazard. It can also + associate an image. @@ -13,10 +14,6 @@ -
- Usage information -

-

Specialization hierarchy

The hazardstatement element is @@ -71,10 +68,8 @@ hazardstatement element can be used.

Simple hazard statement -

The following code sample defines a hazard statement with a - signal word of "DANGER". It also includes an image that - illustrates the possible consequences of not avoiding the - hazard.

+

The following code sample shows the markup for a hazard + statement that warns about rotating blades:

<hazardstatement type="danger"> <messagepanel> <typeofhazard> @@ -84,31 +79,48 @@ <howtoavoid>Follow lockout procedure before servicing.</howtoavoid> </messagepanel> </hazardstatement> -

- -

Would it be helpful to have a screen capture of one possible - rending of the hazard statement, with the caveat that - rendering is implementation-specific?

- -

Example of a hazard statement that contains multiple hazards -

- +

The following code sample generates an ANSI Z535.6 grouped + safety message that specifies information about multiple + hazards:

+ <hazardstatement type="warning"> + <messagepanel> + <typeofhazard> + <hazardsymbol keyref="hazard-electricshock"/> + ELECTRIC SHOCK HAZARD</typeofhazard> + <consequence>The equipment must be grounded. Improper grounding, setup, or usage of + the system can cause electric shock + </consequence> + <howtoavoid> + <hazardsymbol keyref="hazard-groundpowersource"/> + <ul> + <li>Turn off and disconnect power at main switch before disconnecting any + cables or before servicing or installing any equipment.</li> + <li>Connect only to grounded power sources.</li> + <li>All electric wiring must be done by a qualified electrician and comply + with all local codes and regulations.</li> + </ul> + </howtoavoid> + </messagepanel> + <!-- ... --> + <messagepanel> + <typeofhazard> + <hazardsymbol keyref="hazard-hotsurface"/> + BURN HAZARD</typeofhazard> + <consequence>Electric sufaces and fluid can become very hot during + operation.</consequence> + <howtoavoid> + To avoid burns: + <ul> + <li>Do not touch hot fluid or equipment.</li> + </ul> + </howtoavoid> + </messagepanel> +</hazardstatement> - - - - - - - - - - -

diff --git a/specification/langRef/base/hazardsymbol.dita b/specification/langRef/base/hazardsymbol.dita index b8dff9ae..4925f401 100644 --- a/specification/langRef/base/hazardsymbol.dita +++ b/specification/langRef/base/hazardsymbol.dita @@ -18,7 +18,8 @@ a result of not avoiding a hazard, or any combination of these messages.When a hazardsymbol element is directly contained by messagepanel, the hazardsymbol is assumed to be associated - with the typeofhazard element.

+ with the typeofhazard element. Otherwise, + the image is associated with the containing element.

Rendering expectations @@ -66,9 +67,8 @@ a result of not avoiding a hazard, or any combination of these messages.
Example -

The following code sample defines a hazard statement with a signal word of "DANGER." The - hazardsymbol element is explicitly associated with the - typeofhazard element.

+

The following code sample defines a hazard statement that + specifies an image that illustrates the type of hazard:

<hazardstatement type="danger"> <messagepanel> <typeofhazard> @@ -78,19 +78,15 @@ a result of not avoiding a hazard, or any combination of these messages.Follow lockout procedure before servicing.</howtoavoid> </messagepanel> </hazardstatement> -

In the following code sample, the hazardsymbol is contained by the - messagepanel element. By default, this markup also associates the - hazardsymbol element with the - typeofhazard element. This markup can be useful when migrating - hazard statements from earlier versions to DITA 2.0.

- <hazardstatement type="danger"> + + diff --git a/specification/langRef/base/howtoavoid.dita b/specification/langRef/base/howtoavoid.dita index 1f698fbb..bdbb93d6 100644 --- a/specification/langRef/base/howtoavoid.dita +++ b/specification/langRef/base/howtoavoid.dita @@ -21,11 +21,11 @@ not use solvents to clean the drum surface."

Example -

The following code sample shows a hazard statement with the signal - word of "NOTICE", which is reserved for situations that only - involve possible property damage or other undesirable states. The - howtoavoid element provides instructions - about how to avoid the undesirable state:

+

The following code sample shows the markup for a hazard statement + that warns about possible damage to machinery. The + howtoavoid element provides specific + information about what the reader needs to do to avoid the + hazard.

<hazardstatement type="notice"> <messagepanel> <typeofhazard> @@ -39,8 +39,7 @@ not use solvents to clean the drum surface." </ul> </howtoavoid> </messagepanel> -</hazardstatement> - +</hazardstatement> diff --git a/specification/langRef/base/messagepanel.dita b/specification/langRef/base/messagepanel.dita index 8a7d6709..c989c1e5 100644 --- a/specification/langRef/base/messagepanel.dita +++ b/specification/langRef/base/messagepanel.dita @@ -2,11 +2,11 @@ <xmlelement>messagepanel</xmlelement> -The messagepanel element contains -the textual information that is displayed on the hazard statement. -This information identifies the hazard, specifies how to avoid the -hazard, and states the probable consequences of failing to avoid the -hazard. +The messagepanel element contains the + textual information that is displayed on the hazard statement. This + information identifies the hazard, specifies how to avoid the hazard, + states the probable consequences of failing to avoid the hazard, and + might specify one or more images. hazard statement @@ -23,42 +23,8 @@ hazard.

Example -

The following code sample generates an ANSI Z535.6 grouped safety message that specifies - information about multiple hazards.

- <hazardstatement type="warning"> - <messagepanel> - <typeofhazard> - <hazardsymbol keyref="hazard-electricshock"/> - ELECTRIC SHOCK HAZARD</typeofhazard> - <consequence>The equipment must be grounded. Improper grounding, setup, or usage of - the system can cause electric shock - </consequence> - <howtoavoid> - <hazardsymbol keyref="hazard-groundpowersource"/> - <ul> - <li>Turn off and disconnect power at main switch before disconnecting any - cables or before servicing or installing any equipment.</li> - <li>Connect only to grounded power sources.</li> - <li>All electric wiring must be done by a qualified electrician and comply - with all local codes and regulations.</li> - </ul> - </howtoavoid> - </messagepanel> - <!-- ... --> - <messagepanel> - <typeofhazard> - <hazardsymbol keyref="hazard-hotsurface"/> - BURN HAZARD</typeofhazard> - <consequence>Electric sufaces and fluid can become very hot during - operation.</consequence> - <howtoavoid> - To avoid burns: - <ul> - <li>Do not touch hot fluid or equipment.</li> - </ul> - </howtoavoid> - </messagepanel> -</hazardstatement> +

See hazardstatement.

 diff --git a/specification/langRef/base/typeofhazard.dita b/specification/langRef/base/typeofhazard.dita index b71bd4f2..d4381d3d 100644 --- a/specification/langRef/base/typeofhazard.dita +++ b/specification/langRef/base/typeofhazard.dita @@ -20,9 +20,8 @@ a description of the type of hazard, for example, "Hot surfaces inside." Example -

The following code sample generates a "CAUTION" hazard statement, - which warns users against lifting heavy objects without referring - to the product safety manual:

+

The following code sample shows the markup for a hazard statement + that warns about a lifting hazard:

<hazardstatement type="caution"> <messagepanel> <typeofhazard> diff --git a/specification/langRef/containers/hazard-d.dita b/specification/langRef/containers/hazard-d.dita index f3548a18..19e4f0de 100644 --- a/specification/langRef/containers/hazard-d.dita +++ b/specification/langRef/containers/hazard-d.dita @@ -6,9 +6,10 @@ The hazardstatement domain adds markup to support hazard statements. It is based on the regulations - of ANSI Z535 and ISO 3864. The domain enables authors to select the - signal word, describe the hazard and its consequences, explain how to - avoid it, and add one or more safety images. + of ANSI Z535 and ISO 3864. The domain enables authors to provide all + the information necessary for a hazard statement: a signal word, + description of the hazard and its consequences, how to avoid the + hazard, and one or more images. domainshazard statement