Formatting tags

The following describes the tags that are available to a Formatting user exit when formatting data for the report. The tags provide a way to create headings, lists, and so on for the displayed data using HTML-like syntax. The tag stream is passed back to Fault Analyzer from the Formatting user exit using the IDIWRITE command.

The following example showing the use of the formatting tags is also provided in softcopy format as member IDISUFM3 in data set IDI.SIDISAM1:
Figure 1. Sample REXX Formatting user exit 3 source
"IDIWRITE '<P>First paragraph.'"
"IDIWRITE '<AREA INDENT=5>'"
"IDIWRITE '<P>Second paragraph, indented 5 characters from the first. '"
"IDIWRITE 'This <DATA 3><P> tag is treated as text only.'"
"IDIWRITE '<P COMPACT>Third paragraph. '"
"IDIWRITE 'Note that this paragraph is not preceded by a blank line.'"
"IDIWRITE '</AREA>'"
"IDIWRITE '<P>Fourth paragraph - now we are back at the left margin.</P>'"
"IDIWRITE '<L>**************************************** This line will '"
"IDIWRITE '<HP>not</HP> wrap at the preferred formatting width!'"
"IDIWRITE '<P><ADDR 625f22>Previous area</ADDR> and <ADDR 625f22></ADDR> are '"
"IDIWRITE 'both point-and-shoot fields to the Dump Storage '"
"IDIWRITE 'display for address 00625F22 in the interactive reanalysis report.'"
"IDIWRITE '<DL BREAK=STDLBL>'"
"IDIWRITE '<DT>This is a long definition term'"
"IDIWRITE '<DD>This is the matching definition description which might wrap '"
"IDIWRITE 'depending on the preferred formatting width.'"
"IDIWRITE '<DT>A shorter definition term'"
"IDIWRITE '<DD>The definition description of the second term.'"
"IDIWRITE '</DL>'"
"IDIWRITE '<P><DUMP 0 20>Address 0 storage for a length of 32 bytes:</DUMP>'"
"IDIWRITE '<UL>'"
"IDIWRITE '<LI>In an unordered list, each item is preceded by a bullet. '"
"IDIWRITE 'If necessary, the item description will wrap at the '"
"IDIWRITE 'preferred formatting width.'"
"IDIWRITE '<LI>Another item in the same list.'"
"IDIWRITE '</UL>'"
"IDIWRITE '<P><NOTEL>'"
"IDIWRITE '<LI>In a note list, each note is numbered and the list is '"
"IDIWRITE 'preceded by a ""Notes:"" heading.  If necessary, the note '"
"IDIWRITE 'description will wrap at the preferred formatting width.'"
"IDIWRITE '<LI>Another note in the same list.'"
"IDIWRITE '</NOTEL>'"
"IDIWRITE '<P><TH>Column Column</TH>'"
"IDIWRITE '<L><U>1     <U>2     </U>'"
"IDIWRITE '<L>   123     17'"
exit 0
Formatted, the above might appear as follows (point-and-shoot fields and highlighted text shown in bold style):
Figure 2. Sample REXX Formatting user exit 3 output
  File  View  Services  Help
──────────────────────────────────────────────────────────────────────────────
Interactive Reanalysis Options                                 Line 1 Col 1 80
Command ===> ________________________________________________ Scroll ===> CSR 

JOBNAME: P35777    SYSTEM ABEND: 0C7            FAE1      2019/10/31  22:51:13

First paragraph.

     Second paragraph, indented 5 characters from the first. This <P> tag is
     treated as text only.
     Third paragraph. Note that this paragraph is not preceded by a blank
     line.

Fourth paragraph - now we are back at the left margin.
**************************************** This line will not wrap at the prefer

Previous area and 00625F22 are both point-and-shoot fields to the Dump Storage
display for address 00625F22 in the interactive reanalysis report.

This is a long definition
term. . . . . . . . . . . . : This is the matching definition description
                              which might wrap depending on the preferred
                              formatting width.

A shorter definition term . : The definition description of the second term.

Address 0 storage for a length of 32 bytes:
Address  Offset     Hex                                 EBCDIC / ASCII    
00000000            040C0000 810692C8 00000000 00000000 *....a.kH........*
00000010       +10  00FC7F08 00000000 070E0000 00000000 *..".............*

o   In an unordered list, each item is preceded by a bullet. If necessary,
    the item description will wrap at the preferred formatting width.

o   Another item in the same list.

Notes:

1.  In a note list, each note is numbered and the list is preceded by a
    "Notes:" heading.  If necessary, the note description will wrap at the
    preferred formatting width.

2.  Another note in the same list.

 Column Column
 1      2     
    123     17
General rules for the formatting tags:
  • All blanks are significant, except at the beginning and end of lines in a paragraph, and at the beginning and end of definition descriptions (text preceded by the <DD> tag).
  • Text, including blank characters, that is not preceded by any tag implicitly causes a <P> tag to be inserted ahead of the text.
  • All tags and attributes are non-case-sensitive.
  • The maximum line width of any output is 132 characters. Beyond this, the text wraps.

The following explains each tag in detail.