Generate EPUB – Typefi Support

The Generate EPUB workflow action (formerly Create EPUB) converts a Content XML (CXML) file into an EPUB file (.epub).

Generate EPUB is divided into six tabs: General, Text, Links, Metadata, CSS, and Advanced.

General

Use this tab to specify the input, resources, output, cover image, and required metadata.

Field	Description
Input	The file path to the input Content XML file (.cxml). Click the Choose File icon to choose a file, or enter the file path; for example, Input/my-input.cxml.
Resources	The path to the core XZIP resource package (.xzip). Your Solutions Consultant will make resources available for you to download from the Typefi FTP. Click the Choose File icon to choose a file, or enter the file path; for example, path/to/resources.xzip.
Output	The path to the output EPUB (.epub). Enter a name or click Choose File to choose an output EPUB (.epub). The default output is output-1.epub.
Cover Image	The file path to an external cover image. Click the Choose file icon to choose the cover image, or enter the file path; for example, Covers/image/my-image.png.
Optimize for Apple Books (formerly iBooks)	Choose whether to optimize for Apple Books. Select Optimize for Apple Books to: use embedded fonts instead of default fonts use pop-up footnotes for Apple Books lock iPhone display to portrait mode Optimize for Apple Books is selected by default.
Required Metadata	Metadata is data about data. That is, if an e-book is considered data, then the information describing the e-book, like the title and creator, would be metadata. Use this section to enter the required metadata elements that an EPUB file needs to be successfully validated. Note: Leaving Required metadata fields empty may cause third-party validation to fail.
Identifier	Enter the identifier element (`<dc:identifier>`). The identifier is a reference to the e-book, such as an ISBN or DOI. If left empty, a Universally Unique Identifier (UUID) will be generated. For more information about adding an identifier, see the Dublin Core Metadata initiative.
Title	Enter the title element (`<dc:title>`). The title is the name given to the e-book. For more information about adding a title, see the Dublin Core Metadata Initiative.
Creator	Enter the creator element (`<dc:creator>`). The creator is the name of the person or organisation who created the e-book. For more information about adding a creator, see the Dublin Core Metadata Initiative.
Date	Enter the date element (`<dc:date>`). The date defines the publication date of the e-book. Use the DateTime format `(YYYY-MM, or YYYY-MM-DD)` to enter the date. For example, you could enter 2020, 2020-08, or 2020-08-04. If you leave this field empty, Typefi Server automatically generates `<dc:date>` to the current date and time. For more information about adding a date, see the Dublin Core Metadata Initiative.

Text

Use this tab to configure how text is formatted in the generated EPUB file.

Field	Description
Soft returns	Select Remove soft returns to remove all soft returns in the e-book. Deselect to keep soft returns. Remove soft returns is deselected by default.
Table of Contents	(Requires CXML 3.3) Specify the heading levels to include in the Table of Contents (TOC). For the TOC structure to be accurately generated, your Content XML (CXML) must contain corresponding CXML 3.3 HTML heading tags (`<h1>`, `<h2>`, `<h3>`). For example, if the CXML uses `<h1>` through `<h6>`, but you only want a three-level TOC, select H1, H2, and H3. H1 is selected by default. If no heading levels are selected, an empty TOC will be generated to maintain EPUB validity. For more information on how to format headings in your CXML, see CXML 3.3.
Split document	Use this section to specify if the e-book should be kept as one HTML file or split.
Split document	Select Split document to split the CXML file using Typefi Sections or a single paragraph style into new XHTML files. Deselect to keep the EPUB file as one HTML file. Split document is deselected by default.
Enter parameters	If you selected Split document, enter one or more Typefi Section or paragraph style where the HTML5 file should be split. Note: Your entry must contain only sections or only paragraph styles. Formatting guidelines: For sections: Each entry must start with `section:`, followed by a comma-separated list of section names (case-sensitive). Examples: Single section: `section:Name of section` Multiple sections: `section:Chapter,Back matter` For Paragraph styles: Each entry must start with `paragraph:`, followed by a comma-separated list of style names (case-sensitive) Examples: Single paragraph style: `paragraph:style 1` Multiple paragraph styles: `paragraph:Section title,Annex title,Glossary title`
Footnotes	Use this section to specify where footnotes are placed.
Layout	Choose where footnotes are placed. Options include: End of the section (endnotes): Footnotes are converted to endnotes. After paragraph: Footnotes are placed after the paragraph. In a pop-up (EPUB 3-only): Footnotes are placed inside a pop-up. Note: Optimize for Apple Books must be selected to ensure pop-ups are compatible with Apple Books. The default value is End of the section (endnotes).
Style	Choose the numbering style for footnotes. Options include: 1,2,3 a,b,c A,B,C i,ii,iii I,II,III
Endnotes	Use this section to specify how endnotes are formatted.
Endnote title	Enter a display title for the endnotes.
Layout	Choose where endnotes are placed. Options include: End of document: Endnotes are placed at the end of the document. End of section: Endnotes are placed at the end of each split file. Merge with footnotes: Endnotes are converted to footnotes. The default value is End of Document.
Style	Choose the numbering style for endnotes. Options include: 1,2,3 a,b,c A,B,C i,ii,iii I,II,III

Links

Use this tab to configure how images (JPEG, PNG, and GIF) are exported.

Field	Description
Optimize images	Select Optimize images to optimize images for the generated EPUB. Optimize images is selected by default.
Output format	Specify the output format. Choosing a format converts all images to the selected format. Options include: JPEG GIF PNG: Disables the image compression settings; use this option for lossless images or for images that include transparency. Automatic: Keep original file types and adjust resolution as needed. The default value is Automatic.
Resolution (ppi)	Choose the resolution of the images in pixels per inch (ppi). While operating systems have standardised on either 72 ppc or 96 ppi, mobile devices have not. Options include: 72 96 150 300 The default resolution is 150, which is the standard for e-book devices.
JPEG quality	Specify the image quality. Enter a value between 1-100. Higher values yield better quality.
PNG quality	Specify the image quality. Enter a value between 1-100. Higher values yield better quality.
GIF palette	Adaptive: Creates a palette using a representative sample of colours in the graphic without any dithering (mixing of small spots of colours to simulate additional colours). Web: Creates a palette of web-safe colours that are a subset of Windows and macOS system colours. The default palette is Adaptive.

Metadata

Use this table to add optional metadata, such as description, publisher, copyright, and subject.

Field	Description
Description	Enter the description element (`<dc:description>`). The description is an abstract or account of the e-book. For more information about adding a description, see the Dublin Core Metadata Initiative.
Publisher	Enter the publisher element (`<dc:publisher>`). The publisher is the entity responsible for making the resource available. For more information about adding a publisher, see the Dublin Core Metadata Initiative.
Rights	Enter the copyright element(`<dc:rights>`). Information about rights held in and over the e-book. For more information about adding a copyright, see the Dublin Core Metadata Initiative.
Subject	Enter the subject element(`<dc:subject>`). The subject is the topic—typically expressed as keywords, key phrases, or classification codes—that describe the topic of the e-book. For more information about adding a subject, see the Dublin Core Metadata Initiative.
Language	Enter the language element(`<dc:language>`). The language is the language of the intellectual content of the resource. For more information about adding a language, see the Dublin Core Metadata Initiative.
Contributor (optional)	Optional. Enter the contributor element (`<dc:contributor>`). The contributor is the entity responsible for making contributions to the resource, for example, a person or organisation that contributes to the creation of the content. For more information, see the Dublin Core Metadata Initiative.
Format	Optional. Enter the format element (`<dc:format>`). The file format, physical medium, or dimensions of the resource. For more information on adding the format, see the Dublin Core Metadata Initiative.
Relation	Optional. Enter the relation element (`<dc:relation>`). The relation is a reference to a related resource, for example an ISBN or DOI. For more information on adding a relation, see the Dublin Core Metadata Initiative.
Source	Optional. Enter the source element (`<dc:source>`). The source is a related resource from which the described resource is derived. For more information on adding a source, see the Dublin Core Metadata Initiative.
Type	Optional. Enter the type element (`<dc:type>`). The type is the nature or genre of the content of the resource. For more information on adding the type, see the Dublin Core Metadata Initiative.

CSS

Use this section to load Cascading Style Sheets (CSS) that control the appearance and layout of your e-book content.

Field

Description

Custom CSS

The file path to one or more external Cascading Style Sheets (.css). Click the Choose File icon

to choose additional CSS file(s). Alternatively, enter the file path to the additional CSS files—for example, Styles/my-style.css.

Include built-in CSS

Select Include built-in CSS to apply Typefi’s built-in cascading style sheet (.css), which provides basic styling rules (for example, allcaps and smallcaps) for your EPUB output. The built-in CSS is dynamic and only includes rules for settings you've activated.

Note: Uncheck Include built-in CSS to take full control of the styling by providing your own Custom CSS file.

Include built-in CSS is selected by default.

Advanced

Use this tab to add JavaScript files to enhance EPUB functionality.

Field	Description
JavaScripts	The file path to one or more external JavaScript file (.js). Click the Choose File icon to choose additional JavaScript (.js) files. Alternatively, enter the file path to the additional JavaScript files—for example, Scripts/my-script.js

You can also use workflow variables to specify input fields. To insert a workflow variable, click the lightning bolt icon and choose a variable from the pop-up menu.