The annotation element is a top-level element that defines an annotation.
Syntax:
Element | Attributes | Value | Notes for Element/Attribute/Value |
|---|---|---|---|
annotation | name | string | |
author | string | ||
subject | string | ||
date | string | yyyy-mm-dd HH:MM:SS+HH:MM | |
icon | help | Default. | |
comment | |||
note | |||
key | |||
insert | |||
color | color | ||
type | square | Default. | |
circle | |||
value | string | Annotation text. |
If the annotation text is large and extends over several lines, then child phrase elements can be used.
Phrase text can come from the value attribute or text nodes between the start and end phrase tag.
The options attribute can be used to insert spaces or new lines before and after the text value.
The options value is a comma-separated list of tokens.
Syntax:
Element | Attributes | Value | Notes for Element/Attribute/Value |
|---|---|---|---|
phrase | options | sb | Space before text value. |
sa | Space after text value. | ||
nb | New line before text value. | ||
na | New line after text value. | ||
value | string | Text value. |
Example
<annotation name="doc-help" icon="help" author="author" color="annotation">
<phrase options="na">This is help one line</phrase>
<phrase options="na" value="This is help two"/>
<phrase options="na">This is help three</phrase>
</annotation>