Robert Desprez Communications

  • My Services
  • My Blog
  • About Me
  • Contact Me

Generating iPad content using RoboHelp 10

September 6, 2012 by RDesprez 6 Comments

Robo­Help 10 makes it much eas­i­er to gen­er­ate EPUB files, the most wide­ly accept­ed file for­mat for e‑books. EPUB files can be read on an array of devices includ­ing the iPad, iPhone, and smart­phones run­ning on Android.

What is an EPUB file?

An EPUB doc­u­ment is a zip file with the .epub exten­sion. You cre­ate EPUB files using Microsoft Word, Adobe InDe­sign, and help author­ing tools such as Mad­cap Flare and Adobe Robo­Help. This blog entry explains the major steps of cre­at­ing EPUB files using Robo­Help 10, which was released this summer.

Advantages of EPUB

* Easy to pro­duce. Cre­at­ing EPUB files are easy to pro­duce with new­er author­ing tools.

* EPUB con­tent reflows. In Eliz­a­beth Cas­tro’s book EPUB Straight to the Point, she writes: “If you’re read­ing it (an EPUB file) on an iPhone, the width of the page is a fair bit small­er than if you’re read­ing it on an iPad, or on some oth­er read­er. The beau­ty of EPUB is that it flows the text to fit what­ev­er screen it’s on.” In con­trast, the pre­sen­ta­tion of a PDF file stays large­ly sta­t­ic, regard­less if you’re using a PC, a Mac, an iPhone, or an iPad.

* Can be viewed offline. Once you down­load a EPUB file, you can view it with­out an Inter­net connection.

Disadvantages of EPUB

* Nav­i­ga­tion is not ide­al. The EPUB file for­mat sup­ports a table of con­tents at the start of the EPUB file. But if you’re want­i­ng to skim the table of con­tents, you need to jump to the front of the doc­u­ment. A tra­di­tion­al online help sys­tem always dis­plays the table of con­tents, mak­ing it easy to jump to anoth­er topic.

* Best suit­ed to lin­ear read­ing. The EPUB file for­mat is fine for tra­di­tion­al books in which you read lin­ear­ly. Users of tech­ni­cal doc­u­ments do not read this way. They skip from top­ic to top­ic in an effort to find the answers they need.

* Extra app required. iBooks, Apple’s e‑reader app, is not pre-installed on the iPad. Users first need to down­load the free app before they can read EPUB files. Not a huge deal but it is anoth­er step for users.

Writing EPUB content in RoboHelp

I assume that you are famil­iar with Robo­Help so I don’t try to explain every option and con­cept in the soft­ware. I focus on what’s new in Robo­Help 10 and how it can eas­i­ly cre­ate EPUB files.

Step 1: Write your content in RoboHelp

Write your doc­u­men­ta­tion in Robo­Help as you nor­mal­ly would.

Step 2: Generate your content as an EPUB format

  1. In the Sin­gle Source Lay­outs sec­tion, dou­ble-click eBook.

Step 3: Select your options

General section
  1. In the eBook Set­tings dia­log box, click Gen­er­al.
  2. In the eBook For­mats sec­tion, select the EPUB 3 check box. You can also gen­er­ate an out­put file that is com­pat­i­ble with the Kindle.
  3. If need­ed, make changes to your out­put fold­er and file name.
  4. In the Options sec­tion, you may want to select the Val­i­date EPUB 3 Out­put check box. An open source tool called epub­check val­i­dates your EPUB file.

Content section
  1. In the eBook Set­tings dia­log box, click Con­tent.
  2. In the Table of Con­tents drop-down list, select the table of con­tents that you cre­at­ed in RoboHelp.
  3. In the Index and Glos­sary drop-down lists, select an index and glos­sary if you set them up in RoboHelp.
  4. In the Con­di­tion­al Build Expres­sion sec­tion, change your con­di­tion­al text set­tings if need­ed. With con­di­tion­al text, you can tag cer­tain sec­tions of your con­tent for dif­fer­ent audi­ences or deliverables.
Meta Information section
  1. In the eBook Set­tings dia­log box, click Meta Infor­ma­tion.
  2. In the Title box, type the name of the EPUB file.
  3. In the Author(s) box, type the name of the author. This may be your name or the name of your department.
  4. In the Publisher(s) box, type your com­pa­ny’s name.
  5. In the Descrip­tion box, type a sen­tence or two that pro­vides a good sum­ma­ry of your document.
  6. In the Cov­er Image sec­tion, select the image you’d like to be on the cov­er on your EPUB file.
  7. Click Save and Generate.

Step 4: Download Adobe Digital Editions

Adobe Dig­i­tal Edi­tions free soft­ware offers a way to view and man­age EPUB files and oth­er dig­i­tal pub­li­ca­tions. I think of it as soft­ware to quick­ly test your gen­er­at­ed file before trans­fer­ring the file to an iPad.

This step is option­al but could save you time if you intend to gen­er­ate mul­ti­ple EPUB files. When Robo­Help fin­ish­es gen­er­at­ing the file and you click View Result, you can imme­di­ate­ly view your EPUB file in Adobe Dig­i­tal Editions.

If there’s a prob­lem with the file, you can fix the issue and then quick­ly regen­er­ate the content.

Step 5: Transfer the file to an iPad

After you have gen­er­at­ed the con­tent, Robo­Help cre­ates the EPUB file in a fold­er that you specified.

To syn­chro­nize the file to an iPad, ensure you have iTunes installed on your com­put­er. In addi­tion, you need to install iBooks, a free e‑reader on your iPad.

  1. Con­nect your iPad to your computer.
  2. In iTunes, click the Sum­ma­ry but­ton and select the Man­u­al­ly man­age music and videos check box.
  3. Locate the gen­er­at­ed EPUB file on your computer.
  4. Drag it to your device in iTunes.

iTunes syn­chro­nizes the file to your iPad.

Step 6: View the file in iBooks

  1. Open iBooks.
  2. In the Library in iBooks, tap the file you just transferred.
    The EPUB file appears. Here is an exam­ple of an EPUB file that is dis­play­ing in iBooks.

If you want to know more about EPUB files, check out Eliz­a­beth Cas­tro’s book EPUB Straight to the Point. 

Filed Under: Career Development, Help Authoring Tools, Online Reading, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: EPUB, iPad, RoboHelp 10, writing for tablets

AMAZING TED TALK HIGHLIGHTS THE FUTURE OF DIGITAL BOOKS

May 19, 2011 by RDesprez 1 Comment

In a recent blog post, I wrote some of my thoughts on how I think tech­ni­cal doc­u­men­ta­tion may change in the next 10 years. Based on the num­ber of com­ments post­ed, it seemed to gen­er­ate a lot of interest.

On a relat­ed note, I recent­ly vis­it­ed www.mytechcomm.org for the first time. One of the dis­cus­sion top­ics includ­ed a link to an online video that’s avail­able on the TED con­fer­ence web site. In the video, soft­ware devel­op­er Mike Matas presents the first full-length inter­ac­tive book for the iPad.

In the dis­cus­sion group, some tech­ni­cal writ­ers argued that this could be the future of tech­ni­cal doc­u­men­ta­tion. In my opin­ion, I could see some of these tech­nolo­gies being employed. But I’d also haz­ard a guess that cre­at­ing these inter­ac­tive graph­ics is chal­leng­ing and prob­a­bly very time con­sum­ing. What do you think? Here’s the web site: http://www.ted.com/talks/mike_matas.html

Filed Under: Online Reading, Online Writing for Mobile, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: interactive books, iPad

INSPIRING VIDEO OF WIRED MAGAZINE RUNNING ON AN iPAD

March 4, 2011 by RDesprez 1 Comment

When Apple unveiled the new iPad yes­ter­day, it remind­ed me of this very cool video—a demo of an elec­tron­ic ver­sion of Wired mag­a­zine that has been opti­mized for use on the device that every­one seems to want. Imag­ine if users could read­i­ly inter­act with elec­tron­ic user guides or help sys­tems this way? Inspiring.

http://www.youtube.com/watch?feature=player_embedded&v=wwFbwHaP5tE

Filed Under: Help Authoring Tools, Online Reading, Robert Desprez | Vancouver technical writer | Blog, Technology Tagged With: iPad, online help

About Robert Desprez

I have worked as a Vancouver technical writer for more than 20 years, working at some of British Columbia's largest high-tech firms. I have served in leadership positions for the Society for Technical Communication and have worked as a writing instructor at Vancouver's Simon Fraser University.

Robert Desprez Follow 1,147 239

Vancouver Technical Writer. Former Instructor at Simon Fraser University. Dog Lover. Coffee Drinker. Tennis and Piano Player.

robert_desprez
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923413647243559161

Image for twitter card

I Regret My Tesla | The Walrus

I wanted to be good. Then the car company fell from grace

thewalrus.ca

Reply on Twitter 1923413647243559161 Retweet on Twitter 1923413647243559161 0 Like on Twitter 1923413647243559161 0 Twitter 1923413647243559161
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923413050498957392

Image for twitter card

Brian Chesky Lost His Mind One Night—and Now He's Relaunching Airbnb as an Everything App

Airbnb's CEO is spending hundreds of millions to relaunch his travel company as an all-purpose service app. Fitness!...

www.wired.com

Reply on Twitter 1923413050498957392 Retweet on Twitter 1923413050498957392 0 Like on Twitter 1923413050498957392 0 Twitter 1923413050498957392
robert_desprez avatar; Robert Desprez @robert_desprez ·
16 May 1923412665478627824

Toronto Centre MP Evan Solomon appointed Canada’s first AI minister /via @globeandmail

Image for twitter card

Toronto Centre MP Evan Solomon appointed Canada’s first AI minister

Experts say Solomon could face a host of challenges in his role, including how to increase AI adoption and comme...

www.theglobeandmail.com

Reply on Twitter 1923412665478627824 Retweet on Twitter 1923412665478627824 0 Like on Twitter 1923412665478627824 0 Twitter 1923412665478627824
robert_desprez avatar; Robert Desprez @robert_desprez ·
2 May 1918126029463536113

This productivity poison is exhausting you /via @globeandmail

Image for twitter card

This productivity poison is exhausting you

Constantly shifting your attention undermines what is your super power in most knowledge jobs. How you anticipate an...

www.theglobeandmail.com

Reply on Twitter 1918126029463536113 Retweet on Twitter 1918126029463536113 0 Like on Twitter 1918126029463536113 0 Twitter 1918126029463536113
Load More

Recent Blog Posts

  • ChatGPT: The AI-Powered Proofreader
  • Four Ways Confluence Could Be Better
  • First impressions of MadCap’s purchase of IXIASOFT
  • Online Conferences for Technical Writers in 2023

About Me

Robert Desprez I have worked as a Vancouver technical writer for more than 20 years, working at Kodak, Boeing, Teck Resources, and FortisBC. In addition, I have worked as a writing instructor at Simon Fraser University in Vancouver.

Contact Me

Robert Desprez Com­mu­ni­ca­tions Inc.
North Van­cou­ver, British Columbia
Canada
Phone: 604–836-4290

  • Email
  • LinkedIn
  • Twitter

Copyright © 2025  · Robert Desprez Communications Inc.