Sigil User Guide

0.7.2

FAQ

— Frequently Asked Questions —

Common Questions

Does Sigil Support EPUB 3?

Sigil is an EPUB 2 editor and does not currently support all the features of EPUB 3. However it does support audio and video files which are the most often requested parts of EPUB 3, and does allow you to preserve EPUB 3 tags. A future version may support EPUB 3, but EPUB 3 ereaders are not common yet, even though some ereaders support certain parts of EPUB 3.

Why does my book look okay in Sigil but not on my device?

Every device or program that displays your book uses slightly different software. Despite EPUB being a standard, this means there may be differences in how your book appears on each device. Sigil also supports some features not in the EPUB 2 standard (such as audio, video, and various HTML 5 tags). In some cases, although it looks okay in Sigil, it may not look okay on a specific device. And in other cases, it might not look ok in Sigil but it might display fine on your ereader. You must test your book on as many devices as you can.

What are all these " " words in my code?

  is a non-breaking space. If you edit in Book View you may end up with these HTML entities in your code because Book View will create them anytime it thinks you wanted one (e.g. if you type two spaces in a row it will convert one to   so that it is not lost – multiple spaces are reduced to one space by ereaders). You can replace them with a normal space if you don’t actually need them for your text.

Where to Get Help

Where can I get help with Sigil?

If you have any questions about Sigil not covered in the Sigil User Guide, then visit the Sigil Forum at MobileRead where the users and developers of Sigil will try to help.

Where can I ask questions about EPUB?

You can post on the EPUB Forum at MobileRead if your questions are more about how to format and style something in an EPUB than how to do something in Sigil.

Where can I report bugs or request features?

Read the Reporting Issues information to submit a bug report or feature request.

Using Sigil

Sigil does not start on MAC OS 10.6?

Sigil on the MAC requires MAC OS 10.7 or later.

Is there a tutorial or manual for Sigil?

Yes – in Sigil use Help→User Guide to see an HTML version of the Sigil User Guide which also includes tutorials. Or visit the Sigil home page for a link to the HTML and EPUB versions.

Can I write my book using Sigil?

Yes, you can, but Sigil is primarily an editing program for books that have already been written in one of the many existing word processors. You may prefer to write using your favourite editor, export it to HTML, and then use Sigil to format it for EPUB. But if you really want to write and edit it in Sigil, then you certainly can – the Sigil User Guide was written completely using Sigil.

Are DOC, Mobi, KF8 formats supported?

Sigil is an EPUB editor. It can open EPUB files and import HTML files, but all other formats must be converted to HTML first before importing.

There are a lot of formats out there, and converting from one format to another is not a trivial issue. Since there are already excellent tools for converting from one format to another, Sigil will remain focused on being the best EPUB editor available.

See the Prepare Your File For Sigil chapter for more information.

To convert EPUB to Mobi or KF8 you should use Kindle tools.

How do I use Regex?

See the Regular Expressions chapter in the User Guide for more details and tips on using Regex.

Sigil won’t import my file?

Sigil can only import or open valid HTML and EPUB files. It will try to recover from some common problems in files, but if there is a significant issue (missing standard code or files) then it may be unable to open the file.

If your Preferences have Clean Source turned off, try setting it to Pretty Print Tidy as it will correct certain errors. Sometimes Sigil will give you an error message that might identify the problem with the file. In this case you may be able to open your file with a Zip or archive program and edit the files to correct them. But often the cause of the problem is not clear.

If you want to report a problem with a file that cannot load and crashes Sigil, then you must attach the EPUB file to your bug report. You can set bug reports to private so that non-developers cannot see your file. But in most cases you will need to correct the file.

Spellcheck does not handle quotes or dashes correctly?

If you install your own hunspell dictionary and it isn’t recognizing curly quotes, em-dashes, etc. then you may need additional hyphenation dictionary files. See Spellcheck Dictionary preferences in the User Guide for more details.

Text pasted into Sigil does not look right?

Pasting rich text into Sigil may not work very well. You can try to export (or convert) your text to HTML and then import the new file directly. This may preserve the formatting.

If you want to paste something as plain text, you may need to paste it into Code View to avoid preserving formatting tags.

Formatting and Styles

Why does my book display random question marks?

This may be because your original file has soft hyphens. ADE (the Adobe software that is used to display EPUB files on many systems) does not handle soft hypens. So just remove the soft hypens from your file and the question marks will go away. Look for something like ­ or ‑. Basically anything “strange” that exists between those two characters. You have to look in Code View to see the raw HTML, but you can use the Reports feature to show what characters are used in the document.

It may also be because ADE cannot perform font substitution.

In Sigil, if the font you are using does not have the required glyphs to render a character present in the text, glyphs from a different font that can render it are used. This is called font substitution. So as long as some fonts on your computer can display these characters, so can Sigil.

ADE on the other hand only displays a small subset of Unicode characters by default. The supported characters are listed in the Adobe PDF Reference v1.7, Appendix D, tables D.1 and D.3.

If you want other characters than these to display in ADE, you will have to embed the required fonts.

How do I change the style of my text?

Read the Stylesheet tutorial in the User Guide – you’ll need it to make use of many of the answers in this section.

Note that ereaders may support displaying formats or styles differently and how text is display in one reader, or in Sigil, may be slightly different to how it’s displayed in another ereader.

What are stylesheets and CSS?

CSS stands for Cascading Stylesheets. See the Stylesheet tutorial in the User Guide for more details on CSS and why you should use stylesheets to format your text.

Can I embed my own fonts using Sigil?

Yes – see the Fonts tutorial in the User Guide.

What does sgc-1 mean in my document?

sgc indicates a Sigil class that is used to set the formatting style for certain parts of your text. sgc classes are automatically created for certain span tags and "style=" attributes if you have HTML Tidy turned on (Edit→Clean Source).

Why does my code have &nbsp; and <p>&nbsp;</p> entries in it?

If you edit in Book View it may insert blank spaces or other formatting text you weren’t expecting. Book View is generally for basic editing. To avoid unexpected characters you can edit in Code View, or use Find & Replace to remove/change any unexpected text.

How do I add blank lines?

Don’t. Its much better to use stylesheets to define the amount of space above or below your special sections using a style definition. For instance to leave 1.5 lines of space above a paragraph you can use this style class:

p.blankabove { margin-top: 1.5em; }

and in your text use the class with your paragraph:

<p class="blankabove">My paragraph</p>

If you really want to, you can insert a break:

<br />

or an empty paragraph:

<p>&nbsp;</p>

For multiple blank lines,it’s best to use a style to define the amount of space you want to leave.

How do I start a new page?

If you use a separate file for your page, then almost all ereaders will start a new page for your text.

How can I use an image for a Chapter heading in the TOC?

Insert your image where you want it – it will look something like this in Code View:

<img src="../Images/myimage.png" />

Add the heading tag you want to use for the image and give it a title to display in the TOC, e.g.

<h1 title="CHAPTER 1"><img src="../Images/myimage.png" /></h1>

The TOC will now have an entry called "CHAPTER 1" which links to your image.

You can even use heading tags with no text in your document if you just want a Chapter entry:

<h2 title="Chapter Subsection"></h2>

But it's probably easier just to link the TOC to the file if the image is at the top.

How do I add margins to my text?

Add this text with your preferred left and right margins to your CSS definitions:

@page {
   margin-left: 5px;
   margin-right: 5px;
}

How do I remove the white space between paragraphs?

To remove the white space between all paragraphs, add this to CSS definitions:

p {
    margin: 0; 
    padding: 0;
}

This will affect only the paragraph spacing (the p means paragraph). To remove all the whitespace between the various elements and make the document look more “book like”, use this code:

body, div, p, h1, h2, h3, h4 { margin: 0; padding: 0; }

How do I add a “drop cap”?

Drop caps are not supported in all readers, but there are several ways to do a drop cap. If your book is formatted just right, it can be done just with CSS.

Add this code to your CSS definitions, which will set the text using the dropcap class in a span tag to use certain values:

span.dropcap {
    float: left;
    font-size: 4.7em;
    line-height: 0.8em;
    margin-right: 3pt;
    margin-bottom: -0.1em;
}

In Sigil, find the paragraph you want to start with a drop cap, and switch to Code View. Change the text from something like this:

<p>Hello</p>

to:

<p><span class="dropcap">H</span>ello</p>

Switch back to Book View and you should see the drop-cap.

Add <span class="dropcap"></span> around all the letters at the start of paragraphs where you want a drop cap.

You might need to adjust the values for font-size, line-height and margin-bottom to get the effect you want. Sigil’s Book View may not show exactly how it’ll appear on all ereaders, but it’s pretty close.

Why doesn’t my font show up in iBooks?

If you embed a font in your EPUB, iBooks requires a non-standard file in the EPUB to tell it to use your font. This cannot be done in Sigil.

Create a file called com.apple.ibooks.display-options.xml with a text editor and put these lines into it:

<?xml version="1.0" encoding="UTF-8"?>
<display_options>
<platform name="*">
<option name="specified-fonts">true</option>
</platform>
</display_options>

Then use an archive manager to unzip or access the EPUB file. Add the xml file you created to your EPUB in the META-INF directory, then re-zip your EPUB.

Why doesn’t my file pass EPUBCHECK due to plist?

If you open your EPUB in iTunes it will automatically add an extra .plist file to the top of the EPUB. This will cause it to fail EPUBCHECK. Do not open your EPUB in iTunes if you intend to use it elsewhere. You can unzip the EPUB and remove the file, then re-zip the file.

Table of contents

previous page start next page