HTML+: Supporting and Extending HTML
HTML Tags Supported/Enhanced
Tag | Attribute | Comments |
<body> | link=color*, vlink=color*, alink=color* | Requires </body>. |
leftmargin=n, topmargin=n | ||
text=color* | ||
bgcolor=color* | ||
<p> | align=left | </p> is recommended. Currently only default alignment (left) is supported. |
bullet=disc, circle, square, default, blank, url*** | An HTML+ extension. Renders paragraph with a wrapped bullet character specified by type which is interpreted as indicated below.**** The image's height will be sized to the paragraph's lineheight. If not specified, the defaultBullet character will be used. Note that the HTML+ <textinsert> and <imageinsert> tags can be used to produce "drop cap" effects with vertical spans of more than a single line. | |
indent=n | An HTML+ extension. Indents entire paragraph by the specified amount. | |
nonebetween | An HTML+ extension. If set, eliminates the additional spacing inserted before and after the paragraph. | |
<font> | color=color* | Requires </font>. |
face=name | ||
size=n | ||
<b> or <strong> | Renders text in bold. Requires </b> or </strong>. | |
<i> or <em> | Renders text in italics. Requires </i> or </em>. | |
<u> | Underlines text. Requires </u>. | |
<sub> | Renders text as subscript. Requires </sub> | |
<sup> | Renders text as superscript. Requires </sup> | |
<basefont> | color=color* | Sets the base font for text not explicitly set by a <font> tag or using the style=properties specification. Also used as the basis for the relative font size specifications of the <font> tage (e.g., <font size=+2>). |
name=fontname | ||
size=n | ||
<a> | href=url*** | Specifies URL of hyperlink. Requires </a>. |
style=properties** | Currently not supported. Use the link color properties of the <body> tag to set link colors. By default, JDoc follows HTML conventions and underlines links. Use style="text-decoration: none;" or the convenient HTML+ extension attribute <nounderline> to turn underlining off. | |
target=blank, parent, top, self, somewindow | Specifies the window into which the link is to be loaded. Must be a valid
frame specified with the <frame> tag or be one of the following: blank, to load into a new browser window; parent, to load into the parent of the window containing the link; top, to load into the current top window; or self, to load into the link's current window. The literal values blank, etc., may be preceeded by an optional underscore character ("_"). Important Note: JDoc interprets target=self as a message to update() its document window. In all other cases, JDoc will pass the URL to the server using Java's showDocument() method, to be processed as any other request. This could result in a new document being loaded into the frame containing the JDoc/JSite applet without a way to get back to the applet. To prevent this, always use target=blank to invoke a new browser window when you wish to allow the user to link to another site and then return. |
|
nounderline | Eliminates underlining of this link. | |
plaintext | Forces display of file designated by href as plain text. By default, all files with the extension .htm or .html are rendered as HTML source files; otherwise they are displayed as plain text. | |
<img> | align=left,right | |
height=n, width=n | ||
hspace=n, vspace=n | ||
src=url*** | ||
style=properties** | ||
nowrap | An HTML+ extension. When set, forces text below image instead of wrapping around it. By default, text wraps image. | |
<hr> | align=left, right | |
color=color* | ||
size=n | Specifies height of rule in pixels | |
width=n | Specifies width of rule either in pixels (e.g., 35) or percent of window width (e.g., 35%). | |
<span> | style=properties** | When used with style=properties, specifies elements within document to which the style properties are to be applied. Requires </span>. |
<ul> | style=properties** | Specifies a bulleted (unordered) list. Requires </ul>. Note: nested <ul></ul> pairs are supported. |
compact | When set, vertical spacing between list items is reduced to inter-line spacing instead of the default inter-paragraph spacing. | |
type=disc, circle, square, default, blank, url*** | The type attribute is interpreted as described below.**** The bullet character's height will be sized to the paragraph's lineheight. If not specified, the defaultBullet character will be used. | |
wrapbullet | If set, bullet appears wrapped by text ("inside" rendering) rather than outside of text. The default for a bulleted list is outside rendering (i.e., wrapbullet not set). Note that when the bullet attribute is set for a <p> tag, inside rendering is always used. | |
<li> | style=properties** | Denotes a list item. Requires </li>. |
blankbullet | An HTML+ extension, the effect of this attribute is to render the bullet for this list element as a blank space, thus maintaining indentation of the list elements. Can be used to continue a list item over several paragraphs. | |
<br> | Inserts a line break. Subsequent <br> tags after the first are interpreted as blank lines. | |
<table> | align=left,right | Requires </table>. Currently, nested tables are not supported. |
cols=n | JDoc interprets this attribute as the maximum number of columns it will allocate for the table. The default is 15 and must be reset using the cols attribute if a higher value is required. Any cells encountered by the table parser beyond the limit imposed by cols will be ignored and a Java warning message will be written to the browser's console window or output log. Important Note: Column and row spanning are currently not supported. Inconsistent specification of cells within rows will generate errors or unpredictable results. | |
width=n[%] | If not specified, table width is set by default to the line width of the document in which the table is embedded. Otherwise width is set to the given value n or optionally to a percentage of the document's width when the syntax n% is used. Note: If a width greater than the document's line width is specified here, a horizontal scroll bar will automatically be set for the document's user-interface panel. | |
allowwrap | An HTML+ extension. When set, allows text to wrap table. By default, text is forced below table. | |
gutter=n | Defines the spacing between the table's columns. The default value is 10.
Notes: 1) This value is scaled according to the viewer's screen resolution. 2) This value should be ignored in specifying column widths in the <td> tag; see notes for that tag for discussion of how space for gutters is allotted. |
|
<tr> | Creates table row. Requires </tr>. | |
<td> | width=n[%] or * | Creates table cell. Requires </td>. If specified, cell width is set
to n or optionally to n% of the width of the table. If the *
value is specified for one or more columns in the row, the otherwise unassigned table
width will be divided among these columns. JDoc will always use the column widths
for the last row for which such values were specified. It is unnecessary to specify widths
for more than one row and, regardless of consistency among rows, the last set of values
encountered will be used. Important Notes: 1) If no column widths are specified JDoc uses the quotient of the table width and the number of columns it encounters in parsing the table. This is a departure from HTML which, in the case that no column widths are set, makes widths proportional to same sort of average of the line lengths in the column's cells. 2) Column widths, whether absolute or relative, should not take the table's gutters into account. This is done automatically by the table's show() method: The total white space occupied by the gutters is subtracted from the table's width and the remaining available space is then allocated proportionally among the columns. |
colspan=n | Not currently used. The newCell() method does read the HTML colspan attribute in the <td> tag but column spanning is not currently supported. | |
<form> | width=n | Requires </form>. |
action=url*** | ||
method=get, post | Specifies method for sending form's output to the CGI server. | |
target=window | Specifies the window into which results of the submitted for are to be loaded. Must be a valid frame specified with the <frame> tag or be one of the following: blank, to load into a new browser window; parent, to load into the parent of the window containing the link; self, to load into the link's current window; or top to load into the current top window. | |
allowwrap | An HTML+ extension. When set, allows text to wrap form. By default, text is forced below form. | |
noshow | An HTML+ extension. When set, results returned by CGI server are saved in the form object's results instance variable for use by the programmer. Otherwise (the default) HTML results are read by JDoc and displayed in the browser). | |
<input> | align=right,left | |
checked | Sets checkbox or radio button to its selected state when the form initially loads | |
maxlength=n | Limits the maximum number of characters that can be entered into a text control. Not currently supported but will be implemented in subsequent release. | |
name=name | Specifies the name of the control which will be passed to the specified script as part of the form's name-value string. | |
size=n | The width of the control. NOTE: HTML+ interprets the control's size in pixels and sets its width equal to n times the font's average character width. | |
type=type | The following types are supported: text, textarea, password, checkbox, radio, submit, reset, hidden, and button. | |
value=value, _longdate, _shortdate | Specifies the default value for text/numeric controls or the value to be returned when boolean control (checkbox or radio) are selected. An HTML enhancement is implemented: the constants _longdate and _shortdate set a text field to dates of the form Thu Jan 01 1998 10:00 AM and 01/01/1998, respectively. | |
<textarea> | cols=n | The width of the control. NOTE: HTML+ interprets the control's size in pixels and sets its width equal to n times the font's average character width. The textarea control can also be specified with the <input> tag's type=textarea attribute and the cols=n and rows=n attributes will be set. The <textarea> tag requires a following </textarea> and intervening text will be interpreted as the textarea's initial value. |
The height of the control. NOTE: HTML+ interprets the control's size in pixels and sets its height equal to n times the font's height. | ||
*Color specified as " #XXYYZZ;" where xx, etc., are hexadecimal values specifying the RGB color values and the bracketing # and ; characters are optional. | ||
**Currently, only style="color: #XXYYZZ;" and style="text-decoration: none;" are supported (the latter setting sets turns text underlining off). | ||
***If complete URL is supplied (e.g., "http://www.server.com/images/imgfile.ext) it will be used as specified. Otherwise (e.g., "images/imgfile.ext") is assumed to be relative to the path of the HTML document file containing the tag associated with this attribute (e.g., <img> or <a>). In addition, several special calls to certain Java functions are supported in a manner analogous to HTML's support of javascript calls specified as URLs of the form href="javascript: myFunction(myparam)". See documentation of the Link class for more information. | ||
****Both Internet Explorer and Netscape Navigator recognize the W3C bullet character specifiers circle (hollow circle), disc (solid circle), and square (solid square). HTML+ also allows a default value (set initially to disc, the HTML default) as well as a blank bullet (i.e., white space). Finally, a url*** can be supplied to specify a user-supplied bitmap. |