<Bookmarks> <Document> <UseFile value="no"/> <Path>c:\docs\bookmarks.htm</Path> <UseNamedAnchors value="no"/> <NamedAnchorType value="WordWebPage"/> <UseIncludeFilter value="no"/> <IncludePrefix>bm</IncludePrefix> <UseExcludeFilter value="no"/> <ExcludePrefix>bm_</ExcludePrefix> </Document> </Bookmarks>
Tag | Type | Default | Description |
---|---|---|---|
<Document>
| container | n/a | Specifies document bookmarks to add to the document. |
Tag | Type | Default | Description |
---|---|---|---|
<UseFile>
| value | no | Whether to create bookmarks from hyperlinks in an HTML file |
<Path>
| string | n/a | Path to HTML file containing hyperlinks to use as bookmarks |
<UseNamedAnchors>
| value | no | Whether to create bookmarks from named anchors |
<NamedAnchorType>
| value | WordWebPage | Types of named anchors to use for bookmarks |
<UseIncludeFilter>
| value | no | Whether to apply named anchor inclusion filtering |
<IncludePrefix>
| string | n/a | Inclusion prefix for named anchor filtering |
<UseExcludeFilter>
| value | no | Whether to apply named anchor exclusion filtering |
<ExcludePrefix>
| string | n/a | Exclusion prefix for named anchor filtering |
yes
and provide the path to an HTML file
in the Path element to add the hyperlinks
in the file as bookmarks to the document.
Each hyperlink in the file adds a bookmark to the document
in the same order as the hyperlinks appear in the file.
The hyperlink text (e.g., the content between the opening
<a href="target"> tag and the closing
</a> tag) serves as the bookmark name.
Set the value attribute of the <UseFile> tag
to no
to not create bookmarks from the
hyperlinks of an HTML file.
Examples
This example specifies that the bookmarks are to be created
from the hyperlinks in the file whose path is
c:\docs\bookmarks.htm
.
<UseFile value="yes"/> <Path>c:\docs\bookmarks.htm</Path>This example specifies that no bookmarks are to be created from a file. In this case, the Path element is ignored, so it is not shown nor needed.
<UseFile value="no"/>
yes
to generate bookmarks based on
named anchors (e.g., <a name="anchorName">
tags in HTML source files) from the document source files.
Then set the value attribute of the <NamedAnchorType> tag
to one of the following values to specify which named anchors
to add:
WordWebPage
: If the document source
files were generated using Microsoft Word and saved in
Web Page format, then use this value. In this case, only
named anchors that do not begin with an underscore
character (e.g., '_') are added as bookmarks. The anchor
names serve as the bookmark names.
all
: All named anchors are added
as bookmarks and the anchor names serve as the bookmark
names.
filtered
: All named anchors are added
as bookmarks subject to optional inclusion and/or exclusion
filtering criteria. See the descriptions for
<UseIncludeFilter>
and <UseExcludeFilter>
for how to specify the inclusion and exclusion filters, respectively.
Set the value attribute of the <UseNamedAnchors> tag
to no
to not create bookmarks from the
named anchors of the document source files.
Examples
This example specifies that bookmarks are to be created
from named anchors that match the format of bookmarks in
a Microsoft Word Web Page file.
<UseNamedAnchors value="yes"/> <NamedAnchorType value="WordWebPage"/>This example specifies that bookmarks are to be created from all named anchors from all document source files.
<UseNamedAnchors value="yes"/> <NamedAnchorType value="all"/>This example specifies that no bookmarks are to be created from named anchors.
<UseNamedAnchors value="no"/>
yes
to generate bookmarks from only
those named anchors that begin with the prefix given in
the IncludePrefix element. For each named
anchor having the given prefix, a bookmark is added,
with the anchor name minus the prefix serving as the
bookmark name.Note that the UseIncludeFilter and IncludePrefix elements
have effect only if the value attribute of the <NamedAnchorType>
tag is set to filtered
.
Set the value attribute of the <UseIncludeFilter> tag
to no
to not use an inclusion filter.
Examples
This example specifies that only named anchors beginning with
the two character sequence 'bm' should be used as bookmarks.
<UseNamedAnchors value="yes"/> <NamedAnchorType value="filtered"/> <UseIncludeFilter value="yes"/> <IncludePrefix>bm</IncludePrefix>
yes
to prevent the generation of bookmarks
from named anchors that begin with the prefix given in
the ExcludePrefix element.Note that the UseExcludeFilter and ExcludePrefix elements
have effect only if the value attribute of the <NamedAnchorType>
tag is set to filtered
.
Set the value attribute of the <UseExcludeFilter> tag
to no
to not use an exclusion filter.
Examples
This example specifies that all named anchors except those
beginning with the underscore character (e.g., '_')
should be used as bookmarks.
<UseNamedAnchors value="yes"/> <NamedAnchorType value="filtered"/> <UseExcludeFilter value="yes"/> <ExcludePrefix>_</ExcludePrefix>This example specifies that only named anchors beginning with the two character sequence 'bm' should be used as bookmarks. However, named anchors beginning with the three character sequence 'bm_' should not be used as bookmarks.
<UseNamedAnchors value="yes"/> <NamedAnchorType value="filtered"/> <UseIncludeFilter value="yes"/> <IncludePrefix>bm</IncludePrefix> <UseExcludeFilter value="yes"/> <ExcludePrefix>bm_</ExcludePrefix>