eBookTools/Metadata - Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : eBookTools/Metadata

Working with Metadata for eBookTools

 

Introduction

eBook Metadata Palette

Rules for Entering Metadata Tags

Bookmarks

Hyperlinks

Index with Plain Text Entries

Index with Formatted Entries

Figures

Tables

Introduction

Metadata tags are used to add index entries; name and specify properties of figures and tables; and create hyperlinks to bookmarks, figures, and tables within the book.

eBook Metadata Palette

One way to add metadata tags is by using the eBook Metadata palette.  If this palette is not visible in the palettes pane, from the View menu, select Palettes > Show Palette > eBook Metadata.

The palette entries in this palette are templates containing placeholders.  After inserting one of these palette entries into a worksheet, replace the placeholders with the appropriate content.  (This works similarly to the Expression Palette.)

Rules for Entering Metadata Tags

1. 

Only the following two colors can be used: color 1and color 2.

2. 

Attributes must be plain text. No formatting, 2-D math, images, hyperlinks, or embedded components can be used.

3. 

As with XML, metadata tags must be properly nested and closed.

Bookmarks

To create a bookmark, use one of the following methods:

1. 

Add a bookmark to a section heading or paragraph using Format > Bookmarks menu.

2. 

Insert Bookmark entry from eBook Metadata palette.

3. 

Enter <MBookmark ID="id of bookmark"/>.

Attributes

Name

Required

Default value

Description

ID

Yes

None

Value referred to when specifying a hyperlink. For example, enteringexpressions.

Label

No

<default>

Used as text of hyperlink

Type

No

<default>

Type of bookmark. To add a bookmark to a table set Type to Table.

Hyperlinks

To create a hyperlink, use one of the following methods:

1. 

Insert hyperlink using Insert > Hyperlink menu:

a. 

Set Type to Help Topic

b. 

Set Target to <hyperlink type>:<chapter name>, where <hyperlink type> is one of:

• 

Book - generic hyperlink

• 

FigureRef - hyperlink to a figure

• 

TableRef - hyperlink to a table

c. 

Set Bookmark to the desired bookmark ID.

Note: The hyperlink text will be the bookmark label.  (The text entered in Link Text field does not appear in the output book.)  In PDF output, the hyperlink text will be the bookmark label and the page number. Figures and Tables are referenced by number (for example, Table 1.2), and no page number is displayed.

1. 

Insert Hyperlink entry from eBook Metadata palette.

2. 

Enter <MHyperlink Type="type" Filename="chapter name" Target="bookmark"/>.

Attributes

Name

Required

Default value

Description

Type

Yes

None

Possible values are: internal - link to a bookmark within the current worksheet, external - link to a bookmark within another worksheet in the book, or URL - link to external resource.

Filename

Yes, for external type

<default>

Name of the chapter

Target

Yes

None

Name of bookmark or URL

Index with Plain Text Entries

You can specify index entries with a depth of one, two, or three levels.

To create a plain text index entry, use one of the following methods:

1. 

Insert Index entry from eBook Metadata palette.

2. 

Enter <MIndex Label="label" Sort="sort string"/>.

Attributes

Name

Required

Default value

Description

Label

Yes

None

Index entry, with at most three levels separated by commas

Sort

No

value of Label

String to be used instead of Label for sorting of index entries

Index with Formatted Entries

To create an index entry with different font or 2-D math, use one of the following methods:

1. 

Insert Formatted Index entry from eBook Metadata palette.  Depending on the number of levels in the index entry, you may not need all the nested levels provided in the template.

2. 

Enter <MFormattedIndex><MIndexLevel1 Sort="sort string">index string</MIndexLevel1></MFormattedIndex>.

Attributes

Name

Required

Default value

Description

Sort

No

plain text version of the entry

String to be used for sorting of index entries

Example

• 

"Plotting, x2": <MFormattedIndex><MIndexLevel1>Plotting</MIndexLevel1><MIndexLevel1 Sort="x^2">x2</MIndexLevel1></MFormattedIndex>

Figures

• 

Figures can be formal or informal.  Formal figures are numbered.  In addition, formal figures appear in the List of Figures in the Table of Contents.

To create a figure, use one of the following methods:

1. 

Insert Figure entry from eBook Metadata palette.

2. 

Enter <MFigure Bookmark="bookmark" Formal="true"><MFigureTitle>title of the figure</MFigureTitle>2-D math, plot, image, or embedded component</MFigure>.

Attributes

Name

Required

Default value

Description

Bookmark

Yes

None

Bookmark of the figure. It must be unique within the worksheet.

Formal

Yes

None

true or false.  When true, a formal figure is created.

Title

No

None

Plain text title, ignored if MFigureTitle is used

alignment

No

None

Alignment of the figure

width

No

None

Width of the figure

Tables

• 

Tables can be formal or informal.  Formal tables are numbered.  In addition, formal tables appear in the List of Tables in the Table of Contents.

• 

A table is considered formal if Show caption>Table 1: Title is set in table's properties and title is provided.

• 

A header row is repeated if a table is split between two pages (in PDF or EPUB).

• 

To mark a row of a table as a header row perform one of the following in any table cell within the row:

1. 

Insert Table Header entry from eBook Metadata palette.

2. 

Enter <MTableHeaders/>.

See Also

Authoring Guidelines for eBookTools

eBookTools

Expression Palette

Overview of Palettes