Documentation:Open UBC/Guide/Open Education Self-Publishing Guide/Creating your Open Textbook

From UBC Wiki

File format

Editable files allow for easier changes to an open textbook

Editable Files

Editable files are the digital files generated for an open textbook, or other open educational resource, that can be easily changed or edited. Editable files allow faculty, students, and others using your book to put into practice all permissions granted by an open-copyright licence, especially the rights to revise and remix, as described in David Wiley’s 5Rs framework [New Tab].

Editable files allow for easier changes to an open textbook

Which files are editable

Most files can be edited, but the task isn’t always simple. To determine whether a file is suitable for editing, one must ask these questions:

  • How easy or difficult is the file to edit? Does it require more than one or two steps?
  • Is additional technology required to edit the file?
  • Was the file type designed with editing in mind?

Text documents are the most editable file type because changes can be made directly to the file’s native format, and the task does not require additional steps or technology.[1] Examples of text document files are OpenOffice [New Tab] (ODT) and Microsoft Word [New Tab] (DOCX).

xHTML and XML [New Tab] files are designed for interoperability, i.e. the transfer of information from one source to another. xHTML (Extensible Hypertext Markup Language) is a member of the XML family and acts as an extended and stricter version of the broadly used HTML (Hypertext Markup Language). [2] Editing these types of files is typically a two-step process whereby the second step involves transferring the file to a system that allows editing of the file. HTML files can work in certain platforms including WordPress if an HTML Import plugin [New Tab] is used.

EPUB files are designed for portability. These files can be read by most eReader devices and software. The point of these files is not to provide editing capability, but to deliver a comprehensive package that contains all elements of a book including text and images — like a zipped package — to a device for reading offline. However, Pressbooks does accept an EPUB file so that it too can be edited once added to this platform. Like the xHTML and XML files, editing using an EPUB file is a two-step process.

A PDF file (Portable Document Text) can be edited with the right software, such as Adobe Acrobat PDF Editor, but doing so is not ideal. The PDF format was designed to represent documents not create or change them.[3]

If you are working in Pressbooks, see How to Export Different File Types from a Textbook [New Tab] in the BCcampus Open Education Pressbooks Guide.

Beyond text

In addition to providing editable files for the textbook, authors should also consider offering editable files for media included in their textbook or as ancillary OER, such as images, audio clips and video files, and the transcripts that accompany these media. Some questions to ask when doing this are:

  • Is the format open or proprietary?
  • Is the format built for viewing or for portability between operating systems?
  • How simple is the format to use?
  • How well does it integrate with other technologies such as Pressbooks and LMSs (Learning Management Systems, e.g., Moodle, Blackboard, Canvas, Desire2Learn)?
  • How compatible is the format with online devices?
  • Will the format allow editing? If so, how easy or difficult is this to do?

File types and accessibility

Josie Gray

Case study: One of Josie Gray’s tasks as Open Education Production Assistant with BCcampus is to review open textbooks for accessibility and edit them so they meet Web Content Accessibility Guidelines [New Tab] (WCAG). She says that some file types work with some assistive technologies better than others and that having multiple file types available allows students to select the format that works best for them and their learning style.

For example, EPUB and MOBI files work best for people who want to access content through their phone or tablet offline, as the text and content will adjust to fit the screen. While PDFs are the easiest file type to open and use, they don’t work well with mobile devices, screen readers, or text-to-speech technology.  Instead, students using screen readers will likely use the web version of the book.

Alternatively, people who need a larger text size may choose to use a PDF or the web version, as both formats make it easy to enlarge the text size.

Print copies of a book are important for people who prefer learning from print materials. In addition, they are the best option for people who are not comfortable with computers or don’t have a reliable Internet access. (See Print-on-Demand Copies.)


Audio files

Audio files embedded into the web version of a textbook or offered as a stand-alone resource for a printed book can assist students who are visually impaired or those with a learning disability, as they can listen while reading along. Each of the twenty-three open textbooks in the Common Core Trades series [New Tab] includes an audio file in addition to the textbook. For adults learning to read, audio clips of short stories from the accompanying text are embedded throughout the B.C. Reads: Adult Literacy Fundamental English, Course Pack 1 [New Tab].


Book Cover

A professional looking cover helps ensure a good first impression for your open textbook, so we advise that you use the services of a professional, such a graphic designer, for this task. Covers for textbooks published for the BCcampus collection rely on a template devised by our marketing department. Above are three examples. The art for Database Design, 2nd Edition [New Tab] was selected with guidance from our project team; the photo for BC Reads: Adult Literacy Fundamental English, Course Pack 2 [New Tab], was chosen by the textbook’s author, and the collage of photos used for Introduction to Tourism and Hospitality in BC [New Tab] was a collective decision made by the team of writers behind this book.

If you’re working with an academic press or your organization’s publishing department, they might create a textbook cover for you. If not, then see the Open Textbook Cover Toolkit [New Tab] found in the BCcampus Open Education Print-on-Demand Guide.

Incorporate the creation of the textbook cover into the project’s timeline and allow time to review the cover’s draft and to make changes if needed. (See Project Charter and Timeline.) Provide clear instructions to the designer about information the cover should contain. This includes items such as:

  • Textbook title
  • Subtitle
  • Edition number and type (if relevant)
  • Author(s) or editor
  • Name of institution sponsor or funder
  • Attribution statement for cover art

Cover art

If you decide to include an image on the cover, you can use an original photo or artwork or search for an image in one of the many repositories containing items that have been released with an open-copyright licence. (See Resources: Search and Find.) Take these steps for best results.

  1. Check the permissions and/or licence of the image. (See Resources: Only the Open.)
  2. Find as large and high quality of an image as you can (preferably 300 DPI 7×5 inches or 2250×1500 pixels at 300dpi) for optimal resolution and clarity in both the digital and print version of your textbook. If you provide a PDF of your textbook for download and file size is a concern, use a smaller file.
  3. If you’re undecided about cover art, consider an abstract, even generic, photo or illustration that conveys the theme of your book rather than a specific image. Colour often works better than black and white.
  4. If the image is taken from an external source, record the following information for the attribution statement:
    1. name of the image and its link
    2. name of the creator and a link (if available) to the creator’s home page in the repository used
    3. the licence or permission type, or if it is in the public domain


Sample Cover Requirements

Dennis Kong is the Solutions Consultant at Simon Fraser University’s Document Solutions department, which provides print-on-demand copies for the B.C. Open Textbook Collection. He provided the following specifications to keep in mind when creating textbook covers:

  • 8.5×11 inches for the printable area with a one-eighth-inch (minimum) bleed all around (8.625 x 11.125)
  • Colours should be CMYK (cyan, magenta, yellow, and black) if possible
  • Resolution should be at 300 DPI (especially for images)
  • Avoid using unusual fonts. If necessary, convert the fonts to outlines or convert to an image
  • Avoid having any text (or critical design elements) located less than a half-inch from any edge
  1. "Choosing the Right File Format/Text Documents," Wikibooks, last revised July 26, 2017, https://en.wikibooks.org/wiki/Choosing_The_Right_File_Format/Text_Documents (accessed August 17, 2017). This information is used under a CC BY-SA 3.0 licence.
  2. "HTML," Wikipedia, last revised August 12, 2017, https://en.wikipedia.org/wiki/HTML (accessed August 17, 2017), and "XHTML," Wikipedia, last revised April 24, 2017, https://en.wikipedia.org/wiki/XHTML (accessed August 17, 2017). This information is used under a CC BY-SA 3.0 licence. ↵
  3. "PDF Reference, sixth edition: Adobe Portable Document Format version 1.7," Adobe Systems Incorporated, November 2006, http://www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/pdf_reference_1-7.pdf (accessed August 17, 2017). ↵