IBM Health Checker for z/OS User's Guide
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


Special formatting tags for the message table

IBM Health Checker for z/OS User's Guide
SC23-6843-02

<mv ></mv>
For use in the message explanation, <msgitem> tags, specifies that the text within the <mv></mv> tags are variables. The text within the tags will generally format in italics. See Message text (<msgtext>) and message variable (<mv>) tags for complete information about variables.
<!-- comment --> tags
The data placed between these tags is treated as a comment. Comment are not supported within a <msgtext> or <msgitem> section. Comments put in these sections will result in a syntax error and the HZSMSGEN REXX exec cannot generate the messages into a compilable assembler CSECT. You cannot place comments or blank lines inside the body of individual messages, between the <msg> and </msg> tags. This will cause unpredictable results. You should only place comments and blank lines:
  • Before the copyright statement for the message table (<lines id="ownername" props="copyright" > * copyright information * </lines>).
  • Between the copyright statement and the message list tag, <msglist>
  • Between the <msglist> tag and the message tag, <msg>
  • Between individual messages, which would be between the message end tag, </msg>, and the next message start tag, <msg>.
Comments must go on a separate line with no other data.

See Defining your own symbols for check messages for putting comments in an entity declaration.

<lines></lines>
The <lines> tag lets you control lines of text by keeping short lines of text from flowing together or by generating blank lines. You can use the <lines> tags to format text in the message text (<msgtext>) or explanation (<msgitem> tags) for any type of message. The <lines class="center"> tag lets you both control and center lines of text. Use <lines tags with the following considerations:
  • For exception messages, use <lines></lines> tags to define a new line before you reach the WTO limit of 71 characters. Make sure you include the message number in your count.
  • The <lines> or <lines class="center"> beginning tag generates a new line. Use <lines></lines> to create a blank line for messages in the message buffers. Blank lines are suppressed for WTOs, so in the WTO message text for an exception message <lines></lines> will just start a new line.
  • If you specify too long a line of text within the <lines> tag to fit on the line, the data wraps to a new line.
  • The end of a line is broken on a word boundary and causes the next word to begin a new line.
  • You can put variables (<mv> tag) and symbols within <lines tags.
  • You cannot use <p> tags within the <lines markup.
<lines> example 1: The following example show a valid use of <lines> tags to keep a group of short lines from flowing together:
<lines>
Short lines of data
that format exactly as I type them
in the generated output.
</lines>
<lines> example 2: You cannot use <p></p> tags within the message text <msgtext> tags. If you need to start a new line, use <lines></lines> instead. For example, you might want to break a line in an exception message text before you reach the WTO limit of 71 characters.
<msgtext>
I need a new line, but I can't use a paragraph tag.
<lines></lines>
But I can get a new line with the lines tag.
</msgtext>
For a WTO message text, <lines></lines> tagging starts a new line:
I need a new line, but I can't use a paragraph tag.
But I can get a new line with the lines tag.
In the message buffer, <lines></lines> gives you a blank line:
I need a new line, but I can't use a paragraph tag.

But I can get a new line with the lines tag.
<lines class="center"> example: Use <lines class="center"> to center your lines of text:
<lines class="center">
Short lines of data
that format exactly as I type them
in the generated output
except centered
</lines>
You will get the following output:
       Short lines of data
that format exactly as I type them
     in the generated output
         except centered
<p></p>
A paragraph contains text in paragraph form. Use paragraph tags to format paragraph text as follows:
  • Paragraph tags are required to enclose the text in all <msgitem> tags, for any type of message.
  • You cannot use paragraph tags in message text <msgtext>. Instead, use <lines></lines> to create a blank line.
  • The <p> beginning tag starts a new line and data begins at the start of the next line.
  • If your text in a paragraph hits the end of the line boundary, the line splits on a word boundary. Leading and trailing blanks may be lost when the line is split. See How messages are formatted in the message buffer.
Example: The following example shows valid use of paragraph tags:
This is a line of text.                       
<p>Although the text flow of paragraph is the default behavior,         
more rigid rules are observed.                                          
</p>                                                                    
<p>                                                                    
Blank                                                                   
lines are suppressed.                                      
</p>
This example will format as follows:
 This is a line of text.  

Although the text flow of paragraph is the default behavior, more rigid
rules are observed.

Blank lines are suppressed.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014