EPUB is an online format for creating reflowable digital books (ebooks). This format is developed and maintained by the International Digital Publishing Forum (IDPF). For additional information about this group and the EPUB format, see http://idpf.org/.
EPUB is sort of a hybrid format. The output is designed to be viewed electronically; in that way, it is like an online format. On the other hand, its structure is like a book or manual; in that way, it is like a print-based format. In fact, you can follow many of the same steps for creating PDF output to produce EPUB output.
features
Following are some of the features of the EPUB format in Flare:
- Reflowable EPUB output allows for reflowable content, such as word wrap and resizeable text. Therefore, the content can be displayed optimally on different devices.
-
Single File You only need to distribute a single EPUB file, rather than a collection of files and folders.
Note: If you extract the EPUB file using another tool, you will find that it contains one or more XHTML files. If you have used chapter breaks in the outline TOC
-
Embedded Metadata In the EPUB target you can provide information such as a title, author, publisher, rights, ISBN, identifier, which become embedded in the final output. The document title you provide will usually be displayed at the top of the EPUB reader. If you do not provide a title, the target name will automatically be used instead.
For more information about EPUB metadata and the fields supported in Flare (except "Tag"), see:
- Embedded Fonts Flare includes all of your used fonts in the final EPUB output file. Therefore, if someone has a reader that does not have your fonts installed, that person will still be able to see your content as you designed it.
- Cover Page You can use the Target Editor to quickly and easily select an image file to be used as the cover for your ebook.
- Validate EPUB Output You can validate EPUB output so that it will be acceptable to most online stores, such as amazon.com.
- MOBI Output MOBI is the standard format used for the Amazon Kindle. You can use settings in the Target Editor in Flare to generate EPUB output that uses MOBI content.
- MathML to PNG Conversion If you use the Equation Editor to insert equations, you are in essence creating MathML markup
- Enable or Disable Dynamic Content Per Target If you use dynamic content—togglers, popups, drop-downs, expanding text, slideshows, or help controls—in your output, you may want to enable dynamic content for your EPUB target so your users can take advantage of these features. Likewise, you may want to disable dynamic content if your users are using an e-reader that does not fully support dynamic content.
-
Select Reader to View Output From the Builds window pane, you can select a specific EPUB reader (if you have more than one installed) to view the output.
reading systems
EPUB output can be viewed on many kinds of software and hardware, across many platforms. Following are just a few examples of reading systems for EPUB output:
- Amazon Kindle (MOBI)
- Barnes & Noble Nook
- Bluefire Reader (Android, iOS)
- EPUBReader (Firefox)
- Duokan (Kindle)
- iPad, iPhone, iPod Touch
- Lexcycle Stanza (iOS, Windows, Mac OS X)
- Mobipocket (Windows, Blackberry, Symbian, Windows Mobile)
- Sony Reader
Important: Some readers handle EPUB output and respect your formatting better than others.
note
Note: Performance issues with EPUB may be caused by not having page or chapter breaks in your files, thus causing the output to consist of a single long document instead of several shorter ones. Other issues may arise due to rendering problems with different e-readers. See Troubleshooting EPUB Issues.
output type comparison tables
Following are tables that show the various output types available, with the distinguishing features of each.
Note
Note: If an item does not have a check mark, that does not necessarily mean the feature is unavailable in the output. Rather, it means that the feature cannot be added in Flare. For example, search cannot be added in Flare for EPUB output, but some ebook readers may have search built in.
general
Following are general features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
.NET Integration |
|
|
|
|
|
|
|
|
|
Responsive Output |
|
|
|
|
|
|
|
|
|
Single Output File Possible |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
.NET Integration |
|
|
|
|
|
Responsive Output |
|
|
|
|
|
Single Output File Possible |
|
|
|
|
accessibility
Following are accessibility features (e.g., Section 508, WCAG) supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Accessibility Supported |
|
|
|
|
|
|
|
|
|
Compiler Warnings |
|
|
|
|
|
|
|
|
|
Empty Alt Text for Images |
|
|
|
|
|
|
|
|
|
Scrolling for Toolbars and Navigation Frames—Enable |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Accessibility Supported |
|
|
|
|
|
Compiler Warnings |
|
|
|
|
|
Empty Alt Text for Images |
|
|
|
|
|
Scrolling for Toolbars and Navigation Frames—Enable |
|
|
|
|
context-sensitive help
Following are context-sensitive Help (CSH) features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
CSH Supported |
|
|
|
|
|
|
|
|
|
Embedded CSH Supported |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
CSH Supported |
|
|
|
|
|
Embedded CSH Supported |
|
|
|
|
feedback statistics and reporting features
Following are Feedback statistics and reporting features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Feedback Supported |
|
|
|
|
|
|
|
|
||
|
Search Results |
|
|
|
|
|
|
|
|
||
|
1For HTML5, Feedback is supported only in Tripane output. It is not supported in Top Navigation or skinless outputs. |
|
|
||||||||
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Feedback Supported |
|
|
|
|
|
Search Results |
|
|
|
|
generated content
Following are generated content features supported in each output type:
|
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
|||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Autonumbers1 |
|
|
|
|
|
|
|
|
||
|
Breadcrumbs |
|
|
|
|
|
|
|
|
||
|
Browse Sequences |
|
|
|
|
|
|
|
|
||
|
Concept Links |
|
|
|
|
|
|
|
|
||
|
Keyword Links |
|
|
|
|
|
|
|
|
||
|
Glossaries from Proxies |
|
|
|
|
|
|
|
|
||
|
Indexes from Proxies |
|
|
|
|
|
|
|
|
||
|
List of Concepts |
|
|
|
|
|
|
|
|
||
|
List of Elements |
|
|
|
|
|
|
|
|
||
|
List of Endnotes |
|
|
|
|
|
|
|
|
||
|
Lists (Numbered and Bulleted) |
|
|
|
|
|
|
|
|
||
|
Menus from Proxies |
|
|
|
|
|
|
|
|
||
|
Mini-TOCs from Proxies |
|
|
|
|
|
|
|
|
||
|
Page Numbers |
|
|
|
|
|
|
|
|
||
|
Related Topics Links |
|
|
|
|
|
|
|
|
||
|
Relationship Links |
|
|
|
|
|
|
|
|
||
|
Scripts |
|
|
|
|
|
|
|
|
||
|
Search Bars from Proxies |
|
|
|
|
|
|
|
|
||
|
Search Results from Proxies |
|
|
|
|
|
|
|
|
||
|
Shortcut Controls |
|
|
|
|
|
|
|
|
||
|
TOCs from Proxies |
|
|
|
|
|
|
|
|
||
|
Topic Toolbars from Proxies |
|
|
|
|
|
|
|
|
||
|
1It is possible to use autonumbering in online outputs, but only in a limited way. For example, if you have notes throughout your project, you can create an autonumber format on a paragraph style class that simply has the text "Note:" followed by a space. Then whenever you want to apply that style class to note content, it will automatically start with "Note:" so that you don't have to type it each time. However, in the traditional sense where autonumbering is used to increment numbers for elements such as chapters, figures, and tables, it is really only intended for print-based outputs. 2In HTML5, the proxies and related skin components for search bars and search results are supported only in Top Navigation output, as well as in targets not using a skin. They are not supported in Tripane output. |
|
|
||||||||
|
|
|
PRINT (LEGACY) |
||
|---|---|---|---|---|
|
|
|
|
|
|
|
Autonumbers |
|
|
|
|
|
Breadcrumbs |
|
|
|
|
|
Browse Sequences |
|
|
|
|
|
Concept Links |
|
|
|
|
|
Glossaries from Proxies |
|
|
|
|
|
Indexes from Proxies |
|
|
|
|
|
Keyword Links |
|
|
|
|
|
List of Concepts |
|
|
|
|
|
List of Elements |
|
|
|
|
|
List of Endnotes |
|
|
|
|
|
Lists (Numbered and Bulleted) |
|
|
|
|
|
Menus from Proxies |
|
|
|
|
|
Mini-TOCs from Proxies |
|
|
|
|
|
Page Numbers |
|
|
|
|
|
Related Topics Links |
|
|
|
|
|
Relationship Links |
|
|
|
|
|
Scripts |
|
|
|
|
|
Search Bars from Proxies |
|
|
|
|
|
Search Results from Proxies |
|
|
|
|
|
Shortcut Controls |
|
|
|
|
|
TOCs from Proxies |
|
|
|
|
|
Topic Toolbars from Proxies |
|
|
|
|
glossaries
Following are glossary features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Glossaries—Created via Glossary File and Proxy |
|
|
|
|
|
|
|
|
|
Glossaries—Created via Glossary File and Skin Setting |
|
|
|
|
|
|
|
|
|
Auto-generate |
|
|
|
|
|
|
|
|
|
Sorting |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Glossaries—Created via Glossary File and Proxy |
|
|
|
|
|
Glossaries—Created via Glossary File and Skin Setting |
|
|
|
|
|
Auto-generate |
|
|
|
|
|
Sorting |
|
|
|
|
images
Following are image features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Absolute Positioning |
|
|
|
|
|
|
|
|
|
Image Hyperlinks |
|
|
|
|
|
|
|
|
|
Image Maps |
|
|
|
|
|
|
|
|
|
Pre-Compile Resized |
|
|
|
|
|
|
|
|
|
Thumbnail Images |
|
|
|
|
|
|
|
|
|
Web-Safe—Convert from Non—Web-safe |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Absolute Positioning |
|
|
|
|
|
Image Hyperlinks |
|
|
|
|
|
Image Maps |
|
|
|
|
|
Pre-Compile Resized |
|
|
|
|
|
Thumbnail Images |
|
|
|
|
|
Web-Safe—Convert from Non—Web-safe |
|
|
|
|
indexes
Following are index features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Indexes—Created Using Keywords and Proxy |
|
|
|
|
|
|
|
|
|
Indexes—Created Using Keywords and Skin Setting |
|
|
|
|
|
|
|
|
|
Auto-generate |
|
|
|
|
|
|
|
|
|
Binary Indexes |
|
|
|
|
|
|
|
|
|
Bookmarks in Index Entries |
|
|
|
|
|
|
|
|
|
Index Links |
|
|
|
|
|
|
|
|
|
Search—Can Exclude Index Entries from Search |
|
|
|
|
|
|
|
|
|
Sorting |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Indexes—Created Using Keywords and Proxy |
|
|
|
|
|
Indexes—Created Using Keywords and Skin Setting |
|
|
|
|
|
Auto-generate |
|
|
|
|
|
Binary Indexes |
|
|
|
|
|
Bookmarks in Index Entries |
|
|
|
|
|
Index Links |
|
|
|
|
|
Search—Can Exclude Index Entries from Search |
|
|
|
|
|
Sorting |
|
|
|
|
language support
Following are language support features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Author and Generate Output in Left-to-Right (LTR) and Right-to-Left (RTL) Languages |
|
|
|
|
|
|
|
|
||
|
Invert Image Callouts to RTL |
|
|
|
|
|
|
|
|
||
|
Invert Page Layouts to RTL |
|
|
|
|
|
|
|
|
||
|
Invert Styles to RTL |
|
|
|
|
|
|
|
|
||
|
Multilingual Support—Link to External Projects in Target |
|
|
|
|
|
|
|
|
||
|
Output Interface—Display in LTR and RTL |
|
|
|
|
|
|
|
|
||
|
Output Interface—Display English, French, Japanese, or German |
|
|
|
|
|
|
|
|
||
|
Language Skins |
|
|
|
|
|
|
|
|
||
|
Separate UI Text tab in Skin Editor for Localization |
|
|
|
|
|
|
|
|
||
|
1This is controlled on the UI Text tab in a regular HTML5 skin. 2This is controlled in a language skin. 3This is possible with the MadCap Help Viewer, where the end user selects the language. 4As an alternative to using language skins, you can use the UI Text tab in the Skin Editor to perform all of the localization tasks for HTML5 targets. Be aware that translations in the Skin Editor are prioritized over translations in a language skin, so you should try to perform your localization tasks in one place to avoid conflicts. |
|
|
||||||||
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Author and Generate Output in Left-to-Right (LTR) and Right-to-Left (RTL) Languages |
|
|
|
|
|
Invert Image Callouts to RTL |
|
|
|
|
|
Invert Page Layouts to RTL |
|
|
|
|
|
Invert Styles to RTL |
|
|
|
|
|
Multilingual Support—Link to External Projects in Target |
|
|
|
|
|
Output Interface—Display in LTR and RTL |
|
|
|
|
|
Output Interface—Display English, French, Japanese, or German |
|
|
|
|
|
Language Skins |
|
|
|
|
|
Separate UI Text tab in Skin Editor for Localization |
|
|
|
|
master pages and page layouts
Following are master page and page layout features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Master Pages Supported |
|
|
|
|
|
|
|
|
|
Page Layouts Supported |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Master Pages Supported |
|
|
|
|
|
Page Layouts Supported |
|
|
|
|
merging output
Following are merging output features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Merge Output Supported |
|
|
|
|
|
|
|
|
||
|
Merge Output at Runtime |
|
|
|
|
|
|
|
|
||
|
1 Flare's HTML5 Top Navigation skin does not support project merging. 2 HTML5 outputs do not support pre-merging. |
|
|
||||||||
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Merge Output Supported |
|
|
|
|
|
Merge Output at Runtime |
|
|
|
|
miscellaneous features
Following are miscellaneous features supported in each output type:
|
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
|||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Equations |
|
|
|
|
|
|
|
|
||
|
Footnotes |
|
|
|
|
|
|
|
|
||
|
Horizontal Rules |
|
|
|
|
|
|
|
|
||
|
Object Positioning |
|
|
|
|
|
|
|
|
||
|
PDF Stitching |
|
|
|
|
|
|
|
|
||
|
QR Codes |
|
|
|
|
|
|
|
|
||
|
Preview Topics in Output Type |
|
|
|
|
|
|
|
|
||
|
Redacted Text |
|
|
|
|
|
|
|
|
||
|
Slideshows |
|
|
|
|
|
|
|
|
||
|
Snippets |
|
|
|
|
|
|
|
|
||
|
Tables |
|
|
|
|
|
|
|
|
||
|
Text Boxes |
|
|
|
|
|
|
|
|
||
|
1Footnotes are converted to popups. |
|
|
||||||||
|
|
|
PRINT (LEGACY) |
||
|---|---|---|---|---|
|
|
|
|
|
|
|
Equations |
|
|
|
|
|
Footnotes |
|
|
|
|
|
Horizontal Rules |
|
|
|
|
|
Object Positioning |
|
|
|
|
|
PDF Stitching |
|
|
|
|
|
QR Codes |
|
|
|
|
|
Preview Topics in Output Type |
|
|
|
|
|
Redacted Text |
|
|
|
|
|
Slideshows |
|
|
|
|
|
Snippets |
|
|
|
|
|
Tables |
|
|
|
|
|
Text Boxes |
|
|
|
|
multimedia
Following are multimedia features supported in each output type:
|
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|||
|
3D Models (U3D Files) |
|
|
|
|
|
|
|
|
|||
|
Audio and Video Files |
|||||||||||
|
ASF |
|
|
|
|
|
|
|
|
|||
|
ASX |
|
|
|
|
|
|
|
|
|||
|
AU |
|
|
|
|
|
|
|
|
|||
|
AVI4 |
|
|
|
|
|
|
|
|
|||
|
M4V4 |
|
|
|
|
|
|
|
|
|||
|
MID |
|
|
|
|
|
|
|
|
|||
|
MIDI |
|
|
|
|
|
|
|
|
|||
|
MP3 |
|
|
|
|
|
|
|
|
|||
|
MP44 |
|
|
|
|
|
|
|
|
|||
|
MPA |
|
|
|
|
|
|
|
|
|||
|
MPE |
|
|
|
|
|
|
|
|
|||
|
MPEG |
|
|
|
|
|
|
|
|
|||
|
MPG |
|
|
|
|
|
|
|
|
|||
|
OGG4 |
|
|
|
|
|
|
|
|
|||
|
OGV4 |
|
|
|
|
|
|
|
|
|||
|
OPUS |
|
|
|
|
|
|
|
|
|||
|
SWF |
|
|
|
|
|
|
|
|
|||
|
WAV |
|
|
|
|
|
|
|
|
|||
|
WEBM4 |
|
|
|
|
|
|
|
|
|||
|
WMA |
|
|
|
|
|
|
|
|
|||
|
WMV |
|
|
|
|
|
|
|
|
|||
|
MadCap Mimic Movie Links |
|||||||||||
|
Flash (SWF) Format |
|
|
|
|
|
|
|
|
|||
|
HTML5 Format (Depending on Browser)4 |
|
|
|
|
|
|
|
|
|||
|
Mimic Movie Format |
|
|
|
|
|
|
|
|
|||
|
Silverlight Format |
|
|
|
|
|
|
|
|
|||
|
Vimeo Embedded Videos |
|
|
|
|
|
|
|
|
|||
|
YouTube Embedded Videos |
|
|
|
|
|
|
|
|
|||
|
1EPUB support for each element or file type depends on if a particular reader supports it. 2Support for each element or file type depends on if a particular browser supports it. This is especially true with WebHelp mobile output and mobile browsers. 3For this output, the 3D Model opens in a separate window. 4To view HTML5 movie output, end users must have a newer browser that supports these types of videos. 5If you generate DotNet Help, embedded HTML5 movies are not supported out of the box. That's because DotNet Help uses Internet Explorer 7, which does not support HTML5 movies. However, you can make it work by adding the default meta tag to your target: <meta http-equiv="X-UA-Compatible" content="IE=Edge" />. 6This file format does not work in Internet Explorer. 7If you generate DotNet Help or Microsoft HTML Help, YouTube videos are rendered smaller than in other outputs and Vimeo Advanced settings are not supported. However, you can make it work by adding the default meta tag to your target: <meta http-equiv="X-UA-Compatible" content="IE=Edge" />. |
|
|
|
||||||||
|
|
|
PRINT (LEGACY) |
||||
|---|---|---|---|---|---|---|
|
|
|
|
|
|
||
|
3D Models (U3D Files) |
|
|
|
|
||
|
Audio and Video Files |
||||||
|
ASF |
|
|
|
|
||
|
ASX |
|
|
|
|
||
|
AU |
|
|
|
|
||
|
AVI |
|
|
|
|
||
|
M4V |
|
|
|
|
||
|
MID |
|
|
|
|
||
|
MIDI |
|
|
|
|
||
|
MP3 |
|
|
|
|
||
|
MP4 |
|
|
|
|
||
|
MPA |
|
|
|
|
||
|
MPE |
|
|
|
|
||
|
MPEG |
|
|
|
|
||
|
MPG |
|
|
|
|
||
|
OGG |
|
|
|
|
||
|
OGV |
|
|
|
|
||
|
OPUS |
|
|
|
|
||
|
SWF |
|
|
|
|
||
|
WAV |
|
|
|
|
||
|
WEBM |
|
|
|
|
||
|
WMA |
|
|
|
|
||
|
WMV |
|
|
|
|
||
|
MadCap Mimic Movie Links |
||||||
|
Flash (SWF) Format |
|
|
|
|
||
|
HTML5 Format (Depending on Browser) |
|
|
|
|
||
|
Mimic Movie Format |
|
|
|
|
||
|
Silverlight Format |
|
|
|
|
||
|
Vimeo Embedded Videos |
|
|
|
|
||
|
YouTube Embedded Videos |
|
|
|
|
||
|
1PDF support for 3D Models requires Adobe Reader 7.0+. |
|
|
||||
navigation links
Following are navigation link features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Cross-References Supported |
|
|
|
|
|
|
|
|
|
Cross-References—Context-sensitive |
|
|
|
|
|
|
|
|
|
Drop-down Text |
|
|
|
|
|
|
|
|
|
Expanding Text |
|
|
|
|
|
|
|
|
|
Text Hyperlinks |
|
|
|
|
|
|
|
|
|
Text Popups |
|
|
|
|
|
|
|
|
|
Togglers |
|
|
|
|
|
|
|
|
|
Topic Popups |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Cross-References Supported |
|
|
|
|
|
Cross-References—Context-sensitive |
|
|
|
|
|
Drop-down Text |
|
|
|
|
|
Expanding Text |
|
|
|
|
|
Text Hyperlinks |
|
|
|
|
|
Text Popups |
|
|
|
|
|
Togglers |
|
|
|
|
|
Topic Popups |
|
|
|
|
pulse (socially enabled output)
Following are Pulse features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Pulse Integration |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Pulse Integration |
|
|
|
|
search
Following are search features supported in each online output type.
general support
The table below summarizes search support in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Search Supported Via Flare Integration |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Search Supported Via Flare Integration |
|
|
|
|
end user search features
The table below summarizes the key search features and capabilities for each output type. With HTML5 and WebHelp outputs, you can distribute either client- or server-based outputs. This is why the table below lists them twice—under client- and server-based output.
End user search features are supported by the Eclipse Help Viewer and search operations are provided by a plug-in that you develop using the Eclipse platform (for more information, see org.eclipse.help.ui.searchEngine). The Flare search engine does not handle Eclipse Help search operations.
|
CLIENT-BASED OUTPUT |
SERVER-BASED OUTPUT |
||||||||
|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|||
|
Glossary Search—Find Matching Terms |
|
|
|
|
|
|
|
||
|
Index Search—Find Matching Terms |
|
|
|
|
|
|
|
||
|
Search Favorites—Save Queries to Favorites List |
|
|
|
|
|
|
|
||
|
Search Query—Asterisk (*) Wildcard Character |
|
|
|
|
|
|
|
||
|
Search Query—Boolean Operators |
|
|
|
|
|
|
|
||
|
Search Query—Full-text Search (not case sensitive) |
|
|
|
|
|
|
|
||
|
Search Query—Enclose Terms in Quotes (" ") |
|
|
|
|
|
|
|
||
|
Search Results—Narrow Search Scope Using Search Filter Sets |
|
|
|
|
|
|
|
||
|
Search Results—Results Listed in Ranked Order and Show Rank Number See Optimizing Search. |
|
|
|
|
|
|
|
||
|
Search Results—Search Hits Highlighted in Topics See Search Highlighting. |
|
|
|
|
|
|
|
||
|
Search Results—Search Hits Bolded |
|
|
|
|
|
|
|
||
|
1Use CTRL+F in the Glossary pane. 2SQL Server Compact is required. 3Select the operator from the built-in list. 4Results are listed in order. Rank number is not visible. |
|
|
|||||||
content developer search features
This table summarizes the key search features and capabilities that are available to you, the content developer, for each output type. With HTML5 and WebHelp outputs, you can distribute either client- or server-based outputs. This is why the table below lists them twice—under client- and server-based output.
|
CLIENT-BASED OUTPUT |
SERVER-BASED OUTPUT |
||||||||
|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|||
|
Enable Search Feature |
|
|
|
|
|
|
|
||
|
Content Optimization—Adjust Abstract Character Limit |
|
|
|
|
|
|
|
||
|
Content Optimization—Enable or Disable Importance in Search Results |
|
|
|
|
|
|
|
||
|
Content Optimization—Include or Exclude Glossary Terms in Search Results |
|
|
|
|
|
|
|
||
|
Content Optimization—Set Number of Results Displayed Per Page |
|
|
|
|
|
|
|
||
|
Search Highlighting—Set Highlight Color |
|
|
|
|
|
|
|
||
|
Search Performance—Chunk Large Search Database Files |
|
|
|
|
|
|
|
||
|
Search Performance—Enable Partial-word Searching and Set Minimum Word Size |
|
|
|
|
|
|
|
||
|
Search Performance—Enable Stop Words in Search |
|
|
|
|
|
|
|
||
|
Search Performance—Exclude Index Entries from Search |
|
|
|
|
|
|
|
||
|
Search Performance—Exclude Non-words from Search |
|
|
|
|
|
|
|
||
|
Search Performance—Include SQL Search Database |
|
|
|
|
|
|
|
||
|
Search Performance—Pre-merge Search Database |
|
|
|
|
|
|
|
||
|
Search Performance—Set N-Gram Size for Chinese, Japanese, and Korean Projects |
|
|
|
|
|
|
|
||
|
Search Toolbar—Include and Customize a Quick Search Field and/or Select Search Button |
|
|
|
|
|
|
|
||
|
Search Results—Customize Order of Search Filter Sets |
|
|
|
|
|
|
|
||
|
Styles—Generated Search Results Pages |
|
|
|
|
|
|
|
||
|
1HTML5 skin. 2Search cannot be disabled. 3Standard skin. 4Mobile skin. 5Stop words are always enabled. 6Index entries are always excluded. 7Non-words are always excluded. 8SQL Server Compact is required. 9These styles are supported only in HTML5 Top Navigation and skinless outputs. They are not supported in HTML5 Tripane output. |
|
|
|||||||
skins
Following are skin features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Skin Type |
HTML5 |
|
|
Standard |
Standard |
Standard |
Mobile |
Standard |
||
|
About Box |
|
|
|
|
|
|
|
|
||
|
Accordion Titles—Exclude |
|
|
|
|
|
|
|
|
||
|
Browser Settings |
|
|
|
|
|
|
|
|
||
|
Caption for Output Window |
|
|
|
|
|
|
|
|
||
|
Elements (e.g., tabs, accordions)—Specify Default Element |
|
|
|
|
|
|
|
|
||
|
Elements (e.g., tabs, accordions)—Specify Which to Include |
|
|
|
|
|
|
|
|
||
|
Feedback Comments, Email Notifications, User Profile |
|
|
|
|
|
|
|
|
||
|
Generate All |
|
|
|
|
|
|
|
|
||
|
Language Skins |
|
|
|
|
|
|
|
|
||
|
Menu Skin Component |
|
|
|
|
|
|
|
|
||
|
Navigation Links in Standalone Topics |
|
|
|
|
|
|
|
|
||
|
Navigation Pane Settings |
|
|
|
|
|
|
|
|
||
|
Preview Skin for Output Type |
|
|
|
|
|
|
|
|
||
|
Runtime Skins—Choose Different Skins at Runtime |
|
|
|
|
|
|
|
|
||
|
Search Bar Skin Component |
|
|
|
|
|
|
|
|
||
|
Search Results Skin Component |
|
|
|
|
|
|
|
|
||
|
Separate UI Text Tab in Skin Editor for Localization |
|
|
|
|
|
|
|
|
||
|
Styles |
|
|
|
|
|
|
|
|
||
|
TOC Entry—Select Skin For |
|
|
|
|
|
|
|
|
||
|
Topic Toolbar—Custom Settings |
|
|
|
|
|
|
|
|
||
|
Web Toolbar—Add via Skin |
|
|
|
|
|
|
|
|
||
|
Web Toolbar—Custom Settings |
|
|
|
|
|
|
|
|
||
|
Window—Size/Position |
|
|
|
|
|
|
|
|
||
|
Window—User-Defined Size/Position |
|
|
|
|
|
|
|
|
||
|
1This is available in the Tripane skin only. It is not available in the Top Navigation skin. 2This is handled through the org.eclipse.help.base plug-in. 3As an alternative to using language skins, you can use the UI Text tab in the Skin Editor to perform all of the localization tasks for HTML5 targets. Be aware that translations in the Skin Editor are prioritized over translations in a language skin, so you should try to perform your localization tasks in one place to avoid conflicts. 4This is available in the Top Navigation skin only. It is not available in the Tripane skin. 5Only some styles (e.g., Feedback, toolbar) are supported. 6Topic toolbar settings can be controlled in a Topic Toolbar skin component, as well as in a Topic Toolbar proxy. 7Limited settings are available. |
|
|
||||||||
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Skin Type |
|
|
|
|
|
About Box |
|
|
|
|
|
Accordion Titles—Exclude |
|
|
|
|
|
Browser Settings |
|
|
|
|
|
Caption for Output Window |
|
|
|
|
|
Elements (e.g., tabs, accordions)—Specify Default Element |
|
|
|
|
|
Elements (e.g., tabs, accordions)—Specify Which to Include |
|
|
|
|
|
Feedback Comments, Email Notifications, User Profile |
|
|
|
|
|
Generate All |
|
|
|
|
|
Language Skins |
|
|
|
|
|
Menu Skin Component |
|
|
|
|
|
Navigation Links in Standalone Topics |
|
|
|
|
|
Navigation Pane Settings |
|
|
|
|
|
Preview Skin for Output Type |
|
|
|
|
|
Runtime Skins—Choose Different Skins at Runtime |
|
|
|
|
|
Search Bar Skin Component |
|
|
|
|
|
Search Results Skin Component |
|
|
|
|
|
Separate UI Text Tab in Skin Editor for Localization |
|
|
|
|
|
Styles |
|
|
|
|
|
TOC Entry—Select Skin For |
|
|
|
|
|
Topic Toolbar—Custom Settings |
|
|
|
|
|
Web Toolbar—Add via Skin |
|
|
|
|
|
Web Toolbar—Custom Settings |
|
|
|
|
|
Window—Size/Position |
|
|
|
|
|
Window—User-Defined Size/Position |
|
|
|
|
tables of contents and mini-tocs
Following are table of contents (TOC) and mini-TOC features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
TOCs—Created via Headings and Proxy |
|
|
|
|
|
|
|
|
|
TOCs—Created via TOC File and Skin Setting |
|
|
|
|
|
|
|
|
|
Auto-generate |
|
|
|
|
|
|
|
|
|
Binary TOCs |
|
|
|
|
|
|
|
|
|
Mark as New |
|
|
|
|
|
|
|
|
|
Mini-TOCs |
|
|
|
|
|
|
|
|
|
Skin—Select for TOC Entry |
|
|
|
|
|
|
|
|
|
Synchronize With Topics |
|
|
|
|
|
|
|
|
|
1Some ebook readers have a built-in TOC. |
||||||||
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
TOCs—Created via Headings and Proxy |
|
|
|
|
|
TOCs—Created via TOC File and Skin Setting |
|
|
|
|
|
Auto-generate |
|
|
|
|
|
Binary TOCs |
|
|
|
|
|
Mark as New |
|
|
|
|
|
Mini-TOCs |
|
|
|
|
|
Skin—Select for TOC Entry |
|
|
|
|
|
Synchronize With Topics |
|
|
|
|
target settings
Following are target features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
||
|
Auto-generate Glossary, Index, TOC |
|
|
|
|
|
|
|
|
||
|
Characters and Spaces—Replace With Underscores |
|
|
|
|
|
|
|
|
||
|
CMYK |
|
|
|
|
|
|
|
|
||
|
Content Folder—Omit from Output |
|
|
|
|
|
|
|
|
||
|
Crop and Registration Marks—Include in Output |
|
|
|
|
|
|
|
|
||
|
DOCTYPE Declaration |
|
|
|
|
|
|
|
|
||
|
Empty Pages—Inject Automatically |
|
|
|
|
|
|
|
|
||
|
File Extensions—Custom |
|
|
|
|
|
|
|
|
||
|
Languages—Link to External Projects (Create Multilingual Output) |
|
|
|
|
|
|
|
|
||
|
Mark of the Web |
|
|
|
|
|
|
|
|
||
|
Meta Tags—Custom |
|
|
|
|
|
|
|
|
||
|
Startup Topic |
|
|
|
|
|
|
|
|
||
|
Stylesheet Medium |
|
|
|
|
|
|
|
|
||
|
Tracked Changes—Preserve |
|
|
|
|
|
|
|
|
||
|
Warnings—Ignore |
|
|
|
|
|
|
|
|
||
|
1We recommend disabling this option for non-English content. 2The standard mobile DOCTYPE is always used. |
|
|
||||||||
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Auto-generate Glossary, Index, TOC |
|
|
|
|
|
Characters and Spaces—Replace With Underscores |
|
|
|
|
|
CMYK |
|
|
|
|
|
Content Folder—Omit from Output |
|
|
|
|
|
Crop and Registration Marks—Include in Output |
|
|
|
|
|
DOCTYPE Declaration |
|
|
|
|
|
Empty Pages—Inject Automatically |
|
|
|
|
|
File Extensions—Custom |
|
|
|
|
|
Languages—Link to External Projects (Create Multilingual Output) |
|
|
|
|
|
Mark of the Web |
|
|
|
|
|
Meta Tags—Custom |
|
|
|
|
|
Startup Topic |
|
|
|
|
|
Stylesheet Medium |
|
|
|
|
|
Tracked Changes—Preserve |
|
|
|
|
|
Warnings—Ignore |
|
|
|
|
variables
Following are variable features supported in each output type:
|
ONLINE |
OTHER |
ONLINE (LEGACY) |
||||||
|---|---|---|---|---|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
Basic Variables |
|
|
|
|
|
|
|
|
|
Date/Time Variables |
|
|
|
|
|
|
|
|
|
Heading Variables |
|
|
|
|
|
|
|
|
|
Running HF Variables |
|
|
|
|
|
|
|
|
|
Snippet Variables |
|
|
|
|
|
|
|
|
|
System Variables |
|
|
|
|
|
|
|
|
|
|
PRINT (LEGACY) |
|||
|---|---|---|---|---|
|
|
|
|
|
|
|
Basic Variables |
|
|
|
|
|
Date/Time Variables |
|
|
|
|
|
Heading Variables |
|
|
|
|
|
Running HF Variables |
|
|
|
|
|
Snippet Variables |
|
|
|
|
|
System Variables |
|
|
|
|