2.15. Comment section

This section explains how to put comments inside and outside the graph.

2.15.1. W:   One line comment section

Insert any string inside or outside the graph. Format is one line as:

W: String / X( \(x\) ) Y( \(y\) ) IX( \(ix\) ) IY( \(iy\) ) S( \(s\) ) C( \(c\) ) A( \(a\) ) F( \(f\) )


Strings after W: up to / (including blank ) are shown according to the position and size specified by the parameters after /. Each parameter is explained below.

2.15.1.1. Parameters for one line comment

Table 2.24 Parameters for one line comment

parameters

explanation

X( \(x\) )

Set the position of the string be \(x\) in the X axis.

Y( \(y\) )

Set the position of the string be \(y\) in the Y axis.

IX( \(ix\) )

Set the horizontal anchor: 1 = left (default), 2 = center, 3 = right.

IY( \(iy\) )

Set the vertical anchor: 0 = baseline (default), 1 = lower, 2 = center, 3 = upper.

S( \(s\) )

Multiplies the size of the string by \(s\) with the default value of 1. (D=1)

C( \(c\) )

Let the color of the string be \(c\) [1]. (D=e)

A( \(a\) )

Rotate the string counterclockwise by \(a\) degrees around ( \(x\), \(y\) ) (D=0)

F( \(f\) )

Let the font of the string be \(f\) [2] (D=0).

2.15.2. WT:   Multi-line comment section

Insert any multi-line string inside or outside the chart. The format is
WT: X( \(x\) ) Y( \(y\) ) IX( \(ix\) ) IY( \(iy\) ) S( \(s\) ) C( \(c\) ) A( \(a\) ) F( \(f\) ) B( \(b\) ) \
   BOX( \(boxname\) ) CB( \(cb\) ) CL( \(cl\) ) CS( \(cs\) )
\vspace{ \(vs\) } string
\hspace{ \(hs\) } string
string & string
string & string
E:

The WT: line before the string is connected by \, but it is one line.

A multi-line string after the WT: line, including the blank line up to the E: line, are displayed according to the position and size specified by the parameters after the WT:. The input line feed will be the output line feed as it is.

2.15.2.1. Parameters for multi-line comment

Table 2.25 Parameters for multi-line comment 1

parameters

explanation

X( \(x\) )

Set the position of the string be \(x\) in the X axis.

Y( \(y\) )

Set the position of the string be \(y\) in the Y axis.

IX( \(ix\) )

Set the horizontal anchor and line justification: 1 = left, 2 = center, 3 = right.

IY( \(iy\) )

Set the vertical anchor: 1 = lower, 2 = center, 3 = upper (default).

S( \(s\) )

Multiplies the size of the string by \(s\) with the default value of 1. (D=1)

C( \(c\) )

Let the color of the string be \(c\) [3]. (D=e)

A( \(a\) )

Rotate the string counterclockwise by \(a\) degrees around ( \(x\), \(y\) ) (D=0)

F( \(f\) )

Let the font of the string be \(f\) [4] (D=0).

B( \(b\) )

Multiplies the line spacing of the string by \(b\) with the default of 1. (D=1)

Table 2.26 Parameters for multi-line comment 2

parameters

explanation

BOX( \(boxname\) )

Enclose the entire string in a box of \(boxname\) [5].

CB( \(cb\) )

Set the background color of the box be \(cb\) [6] (D=w).

CL( \(cl\) )

Set the color of the box frame be \(cl\) (D=e).

CS( \(cs\) )

Set the shadow color of the box be \(cs\) (D=e).

In the above format, the command starting with & and \ are parameters that control the indentation of each line, the adjustment of line spacing, and the horizontal movement. Each parameter is explained below.
Table 2.27 Parameters for multi-line comment 3

parameters

explanation

&

Align the characters of & written on sequential lines.

\vspace{ \(vs\) }

Set the interval between the upper line and the next line be \(vs\) with respect to the default line spacing as 1.

\hspace{ \(hs\) }

Insert a space \(hs\) at that location with respect to a space character as 1.

2.15.2.2. Example for multi-line comment 1

The following example shows the indented output using &.

List 2.21 • Example for multi-line comment 1

1:  WT: X(0) Y(0) IX(1) IY(1) BOX(shadowBox) F(5)
2:  The notes on multi-lines & comments are summarized below.
3:    &(1) Blank lines have meaning as blank lines.
4:    &(2) Indenting with & only works on contiguous lines.
5:    &(3) The justification for each line is specified by ix( ).
6:  E:
../_images/wt004e.png

Fig. 2.18 Example for multi-line comment 1

2.15.2.3. Example for multi-line comment 2

The following example shows the output when justification for each line, changing the value of ix( ). From the left, it shows the examples of ix(1), ix(2), ix(3).

List 2.22 • Example for multi-line comment 2

1:  WT: X(0) Y(0) IX(1) IY(1) BOX(singleBox) F(5)
2:  The indent is specified by {\tt ix(1)}.
3:  {\tt ix(1)} is left justified.
4:  {\tt ix(2)} is centered.
5:  {\tt ix(3)} is right justified.
6:  E:
../_images/wt001e.png

Fig. 2.19 Example for multi-line comment 2

2.15.2.4. Example for multi-line comment 3

The following example is the output of a sentence containing an equation.

List 2.23 • Example for multi-line comment 3

 1:  WT: X(0) Y(0) IX(1) IY(1) BOX(ovalshadowBox) F(5)
 2:  The following equations are described by \LaTeX  input.
 3:  \vspace{1.2} \hspace{4} \
 4:  $\rho\_i\,({\bf r}) & \equiv   \bigint  \frac{d\,{\ib p}}{(2\pi \hbar )^3}\
 5:    f_i\;({\ib r},{\ib p})$
 6:  \vspace{1.6}\
 7:  $& =   \frac{1}{(2\piL)^{-3/2}}  \exp  \left[ - \
 8:  \frac{({\ib r} - {\ib R}_i)^2}{2L} \right].$
 9:  \vspace{1.6}\
10:  Indent like {\tt \yen}eqnarray is available.
11:  E:
../_images/wt005.png

Fig. 2.20 Example for multi-line comment 3

2.15.3. WTAB:   Multi-row tabular comment section

Insert any multi-line string in tabular form inside or outside the graph. The format is
WTAB: TAB{ \(cols\) } X( \(x\) ) Y( \(y\) ) IX( \(ix\) ) IY( \(iy\) ) S( \(s\) ) C( \(c\) ) A( \(a\) ) F( \(f\) ) \
   CB( \(cb\) ) CL( \(cl\) )
\hline   \vspace{ \(vs\) }
String & String & String & String
\vline{ \(cols\) }   \tabtopsp{ \(ts\) }
String & String & String & String
\cline{ \(m-n\) }
String & String & \selcolor{ \(cs\) } String & String
E:

The WTAB: line before the string is connected by \, but it should be one line. A multi-row table with blank rows after the WTAB: row up to the E: row is displayed according to the position and size specified after the WTAB:. The input line feed will be the output line feed as it is. The number of columns is specified by the argument \(cols\) of TAB{  }. In the string, use & to separate them. It is almost the same format as LaTeX. In addition to strings, there are lines that start with \, which are parameters enabling to control the horizontal ruled lines and the spacing between lines. The height between lines is automatically determined from the height of the character string of the element, so not all lines have the same line spacing. If you enter large letters or equations, the line spacing will increase. The shaded table in the first row of the table in this manual is a paste of the table written in this multi-row tabular comment of ANGEL . Each parameter is explained below.

2.15.3.1. Parameters for multi-row tabular comment 1

Table 2.28 Parameters for multi-row tabular comment 1

parameters

explanation

Tab{ \(cols\) }

Specify the number of columns in the table and the vertical ruled line.

tab{ \(cols\) }

Use Tab to make the table blank larger and tab to make it smaller.

X( \(x\) )

Set the table position be \(x\) in X coordinate values.

Y( \(y\) )

Set the table position be \(y\) in Y coordinate values.

IX( \(ix\) )

Horizontal anchor: 1 left (default), 2 center, 3 right.

IY( \(iy\) )

Vertical anchor: 1 lower, 2 center, 3 upper (default).

Table 2.29 Parameters for multi-row tabular comment 2

parameters

explanation

S( \(s\) )

Multiply the size of the table by \(s\) with the default value of 1 (D=1)

C( \(c\) )

Set the color of the table string be \(c\) [7] (D=e)

A( \(a\) )

Rotate the table counterclockwise by \(a\) degrees around (\(x\), \(y\)) (D=0)

F( \(f\) )

Specifies the font [8] for the table string. (D=0)

CB( \(cb\) )

Set the background color of the table be \(cb\) [7]. (D=w)

CL( \(cl\) )

Set the color of the table frame be \(cl\). (D=e)

The parameters used for TAB{ \(cols\) } and \vline{ \(cols\) } are explained below.

Table 2.30 Parameters for multi-row tabular comment 4

argument

 symbol

explanation

l

Left-aligned element

2-3

c

Centered element

2-3 \(cols\)

r

Right-aligned element

2-3

|

Add a vertical ruled line.

2-3

||

Insert a vertical double ruled line.

In the above format, in addition to the character string, the line starting with \ is a parameter enabling to control the horizontal ruled line and the space between lines. More than one parameter can be written on one line. Each parameter is explained below.
Table 2.31 Parameters for multi-row tabular comment 3

parameters

explanation

\Hline

Add a horizontal ruled line.

\hline

The thickness of the ruled line is standard with \hline and thickened with \Hline.

\Cline{ \(m-n\) }

Insert horizontal ruled lines from \(m\) column to \(n\) column.

\cline{ \(m-n\) }

The thickness of the ruled line is standard with \cline and thickened with \Cline.

\vline{ \(cols\) }

According to \(cols\), put a vertical ruled line only in the column above this line.

\vspace{ \(vs\) }

The space between the upper string and the next horizontal ruled line is \(vs\) with the height of the string set as 1.

\tabtopsp{ \(ts\) }

The space between the upper horizontal ruled line and the next character string is \(ts\) with the height of the character string as 1.

\selcolor{ \(cs\) }

Set the background color of the cell containing this instruction be \(cs\) [9].

2.15.3.2. Example for multi-row tabular comment 1

The following example shows the output of a basic multi-row tabular comment. Specify the column justification with TAB{lllc } on the first row. In this example, there are four elements, left, left, left, and centered, starting from left.

List 2.24 • Example for multi-row tabular comment 1

1:  WTAB: TAB{lllc}  X(0) Y(0) IX(2) IY(2) F(5)
2:  {\bf Title}  & {\bf Author}  & {\bf Publisher}   & {\bf Price}

3:  \TeX Book  & Donald E. Knuth  & ASCII Media Works  & ¥6,000
4:  Document processing system \LaTeX  & Leslie Lamport   & ASCII Media Works  & ¥2,800
5:  \LaTeX Beautiful document creation  & Haruhiko Okumura  & Gijutsu-Hyohron Co. & ¥2,500
6:  E:
../_images/wt006e.png

Fig. 2.21 Example for multi-row tabular comment 1

2.15.3.3. Example for multi-row tabular comment 2

The following example is an output showing how to draw a vertical ruled line. The list shows only the first line.

List 2.25 • Example for multi-row tabular comment 2

1:  WTAB: TAB{|l||l|l|c|}  X(-0.5) Y(0) IX(2) IY(2) F(5)
../_images/wt007e.png

Fig. 2.22 Example for multi-row tabular comment 2

2.15.3.4. Example for multi-row tabular comment 3

Next, to draw a horizontal ruled line, put \hline between the lines where you want to put a horizontal ruled line. If you write two \hline in a row, you can draw a double horizontal ruled line.

List 2.26 • Example for multi-row tabular comment 3

 1:  WTAB: TAB{|l||l|l|c|}  X(0) Y(0) IX(2) IY(2) F(5)
 2:  \hline
 3:  {\bf Title}  & {\bf Author}  & {\bf Publisher}   & {\bf Price}
 4:  \hline \hline
 5:  \TeX Book  & Donald E. Knuth  & ASCII Media Works  & ¥6,000
 6:  \hline
 7:  Document processing system \LaTeX  & Leslie Lamport   & ASCII Media Works  & ¥2,800
 8:  \hline
 9:  \LaTeX Beautiful document creation  & Haruhiko Okumura  & Gijutsu-Hyohron Co. & ¥2,500
10:  \hline
11:  E:
../_images/wt008e.png

Fig. 2.23 Example for multi-row tabular comment 3

2.15.3.5. Example for multi-row tabular comment 4

Next, to draw a partial horizontal ruled line, use \cline, such as \cline{1-2}. If you change the 6th line of the above list to the following, you will get the following output.

List 2.27 • Example for multi-row tabular comment 4

6:  \cline{1-2} \cline{4-4}
../_images/wt009e.png

Fig. 2.24 Example for multi-row tabular comment 4

2.15.3.6. Example for multi-row tabular comment 5

Next, to draw a partial vertical ruled line, use \vline, such as \vline{| l || l | lc | }. The \vline command specified on each line is written for the vertical ruled line not specified on the WTAB: line. Therefore, the vertical ruled line specified in the line WTAB: cannot be canceled.

List 2.28 • Example for multi-row tabular comment 5

 1:  WTAB: TAB{|l||l|lc|}  X(0) Y(0) IX(2) IY(2) F(5)
 2:  \hline
 3:  {\bf Title}  & {\bf Author}  & {\bf Publisher}   & {\bf Price}
 4:  \hline \hline \vline{|l||l|l|c|}

 5:  \TeX Book  & Donald E. Knuth  & ASCII Media Works  & ¥6,000
 6:  \cline{1-2}

 7:  Document processing system \LaTeX  & Leslie Lamport   & ASCII Media Works  & ¥2,800
 8:  \hline
 9:  \LaTeX Beautiful document creation  & Haruhiko Okumura  & Gijutsu-Hyohron Co. & ¥2,500
10:  \hline \vline{|l||l|l|c|}
11:  E:
../_images/wt010e.png

Fig. 2.25 Example for multi-row tabular comment 5

2.15.3.7. Example for multi-row tabular comment 6

Next, use \selcolor{ } to color each cell. In the example below, the cell in the first row is grayed out. Only the third line of Example 5 is shown. The \selcolor{ } specification must precede the cell element.

List 2.29 • Example for multi-row tabular comment 6

3:  \selcolor{k} {\bf Title} & {\bf Author} & \selcolor{k} {\bf Publisher} & {\bf Price}
../_images/wt011e.png

Fig. 2.26 Example for multi-row tabular comment 6

2.15.4. AW:   Arrow comment section

Insert any string inside or outside the graph with an arrow. Format is only one line.

AW: String / X( \(x\) ) Y( \(y\) ) AX( \(ax\) ) AY( \(ay\) )  IR  IL  S( \(s\) ) C( \(c\) ) A( \(a\) )  T  Z


Strings (including spaces) after AW: up to / are displayed with arrows according to the position and size specified after /. Each parameter is explained below.

2.15.4.1. Parameters for arrow comment

Table 2.32 Parameters for arrow comment

parameter

explanation

X( \(x\) )

Set the starting position of the arrow be \(x\) in the X coordinate value.

Y( \(y\) )

Set the starting position of the arrow be \(y\) in the value of the Y coordinate.

AX( \(ax\) )

Set the end of the arrow be \(ax\) in X coordinate value.

AY( \(ay\) )

Set the end of the arrow be \(ay\) in Y coordinate value.

IR

Set \(x\) be the position on the right side of the string.

IL

Set \(x\) be the position on the left side of the string.

S( \(s\) )

Multiplies the size of the string by \(s\) with the default value of 1. (D=1)

C( \(c\) )

Set the color of the arrow and the character string be \(c\) [10] (D=e)

A( \(a\) )

Set the arrow open angle be \(a\) with a default value of 1.

T

Make the arrow line thicker; repeat for a thicker line.

Z

Make the arrow line thinner; repeat for a thinner line.

The position of the comment is to the left of the arrow start point if the arrow tilt is positive, and to the right of the arrow start point if the arrow tilt is negative. Please use IL, and IR to force the comment to be repositioned.

2.15.4.2. Example for arrow comment

To show the default positions of the arrow and the comment, an example using IL, and IR is shown below.

List 2.30 • Example for arrow comment

1:  AW: Arrow default/ X(0) Y(1.5) AX(1) AY(2.5)
2:  AW: Arrow IL/ X(0) Y(0.5) AX(1) AY(1.5) IL
3:  AW: Arrow default/ X(0) Y(-0.5) AX(-1) AY(0.5)
4:  AW: Arrow IR/ X(0) Y(-1.5) AX(-1) AY(-0.5) IR
../_images/aw001e.png

Fig. 2.27 Example for arrow comment