tekReader transform properties

The tekReader platform created by eGloo technologies allows you to create electronic publications which adapt automatically to any output device.

In order to display the tekReader publications created by TopLeaf you will need to have a server account. Contact Turn-Key Systems for more information.

[Note] Note

Unlike other output formats, a table of contents is mandatory for tekReader publications. Your stylesheet must have mappings that assign values to the appropriate TOC levels.

Property Name Possible values Description
title any text The title of the publication.
url a valid URL The URL to which the publication will be uploaded. See below for more information.
pubid an integer A number identifying the publication.
datakey a string A string identifying the publication.
upload yes or no Controls whether to upload to a server.
newfile as for the HTML property Determines when a new tekReader part is started. See the corresponding HTML property description for more information.
include.N a file path Each instance contains the path to a file to be included in the publication. There must be a value with N set to 1. For additional values increase N by one. See below for more information.
include.N.path a file name or relative path Sets the destination path for an included file. See below for more information.
book a javascript object Specifies the content written to the “book.json” file. See below for more information.
thumbnails yes or no If yes (the default) thumbnail versions of large images are created.
index.N.title any text Sets the title for an index. The value of N must be 1-9 or xref. See below for more information.
index.N.group true or false If true an index level is created when the first letter of the item changes in index N. See below for more information.

Uploading the publication

The default action is to attempt to upload the data to a server. A warning will be generated if the upload is not successful. Set the upload property to no to disable this.

All of the url, pubid and datakey properties are required for a successful upload. Contact Turn-Key Systems for information about the appropriate values to use.

Including additional files

A file can be included in the publication as follows:

  • Set one of the include.N properties to the absolute path of the file.

  • Use the book property to create publication meta-data that includes the file name.

The file must exist when the publication is created. By default it is stored at the top level of the publication using the same file name. If the include.N.path property is set (using the same value of N) its value is used as the destination path. This must be either a simple file name or a relative path (for example, “resources/logo.png”).

A common use for this is to include a PDF rendition of the publication that is displayed when the user clicks the “print” button. The following example demonstrates this:

<meta name="convert.tekr.include.1" string="C:\pub\sample.pdf"/>
<meta name="convert.tekr.book">&#x7b;
  "pdf" : "sample.pdf"
}</set>

Note the use of a character reference to encode the “{” character, since this is a reserved character in custom content.

Generating indexes

Indexes can be generated from data produced by mappings that set the Assign to index level or XREF field on the Content tab.

To create an index in the publication you must set an appropriate title. The following sets a title for items captured using level 5:

<meta name="convert.tekr.index.5.title" string="catchwords"/>

Document identifiers

The converter will generate unique identifiers for each element in the output. A consequence of this is that each conversion run creates new identifier values.

The following command can be used to set the identifier prefix to a known value for all content from this point on:

<tekr-info name="docid" value="PREFIX"/>