mirror of
https://github.com/kovidgoyal/calibre.git
synced 2025-07-09 03:04:10 -04:00
Updated User Manual
This commit is contained in:
Kovid Goyal
parent
df1b369f34
commit
8b0e1ff4f0
@ -32,6 +32,8 @@ title = 'Frequently Asked Questions'
|
||||
<li><a href="#CanIsavemybookstothedisk">Can I save my books to the disk?</a></li>
|
||||
<li><a href="#Iused${app}totransfersomebookstomyreaderandnowtheSONYsoftwarehangseverytimeIconnectthereader">I used ${app} to transfer some books to my reader, and now the SONY software hangs every time I connect the reader?</a></li>
|
||||
<li><a href="#NoimagesintheLRFfileafterconversionfromHTML">No images in the LRF file after conversion from HTML?</a></li>
|
||||
<li><a href="#osxfonts">Why does ${app} show only some of my fonts on OS X?</a></li>
|
||||
<li><a href="#unicode">How do I convert my file containing non-English characters?</a></li>
|
||||
<li><a href="#CanIuseweb2lrftodownloadanarbitrarywebsite">Can I use web2lrf to download an arbitrary website?</a></li>
|
||||
<li><a href="#Iwantsomefeatureaddedto${app}.WhatcanIdo">I want some feature added to ${app}. What can I do?</a></li>
|
||||
<li><a href="#HowdoIusesomeoftheadvancedfeaturesoftheconversiontools">How do I use some of the advanced features of the conversion tools?</a></li>
|
||||
@ -76,11 +78,45 @@ title = 'Frequently Asked Questions'
|
||||
</li><li>Deleting the file media.xml from the reader's main memory using windows explorer (search for the file to find all locations where it is present). Note that by doing this you will lose all your collections, bookmarks, history etc.
|
||||
</li><li>Unplugging the reader and waiting till the list of books shows up again
|
||||
</li><li>Re-connecting the reader and starting the SONY software
|
||||
</li></ul><h2 id="NoimagesintheLRFfileafterconversionfromHTML">No images in the LRF file after conversion from HTML?</h2>
|
||||
</li></ul>
|
||||
|
||||
<h2 id="NoimagesintheLRFfileafterconversionfromHTML">No images in the LRF file after conversion from HTML?</h2>
|
||||
<p>
|
||||
If you use the GUI to convert an HTML file, you have to create a zip file with the HTML file and any images it references and then convert that ZIP file to LRF.
|
||||
</p>
|
||||
|
||||
<h2 id="osxfonts">Why does ${app} show only some of my fonts on OS X?</h2>
|
||||
<p>
|
||||
${app} embeds fonts in ebook files it creates. E-book files support embedding only
|
||||
TrueType (.ttf) fonts. Most fonts on OS X systems are in .dfont format, thus they
|
||||
cannot be embedded. ${app} shows only TrueType fonts founf on your system. You can
|
||||
obtain many TrueType fonts on the web. Simply download the .ttf files and add them
|
||||
to the <code>Library/Fonts</code> directory in your home directory.
|
||||
</p>
|
||||
|
||||
<h2 id="unicode">How do I convert my file containing non-English characters?</h2>
|
||||
<p>
|
||||
There are two aspects to this problem:
|
||||
</p>
|
||||
<ol>
|
||||
<li>
|
||||
Knowing the encoding of the source file: ${app} tries to guess what
|
||||
character encoding your source files use, but often, this is impossible,
|
||||
so you need to tell it what encoding to use. This can be done in the GUI
|
||||
via the "Source encoding" field in the "Look & Feel" section.
|
||||
The command-line tools all have an <code>--encoding</code> option.
|
||||
</li>
|
||||
<li>
|
||||
Embedding fonts: If you are generating an LRF file to read on your
|
||||
SONY Reader, you are limited by the fact that the Reader only supports
|
||||
a few non-English characters in the fonts it comes pre-loaded with.
|
||||
You can work around this problem by embedding a unicode-aware font
|
||||
that supports the character set your file uses into the LRF file. You
|
||||
should embed atleast a serif and a sans-serif font. Be aware that
|
||||
embedding fonts significantly slows down page-turn speed on the reader.
|
||||
</li>
|
||||
</ol>
|
||||
|
||||
|
||||
<h2 id="CanIuseweb2lrftodownloadanarbitrarywebsite">Can I use web2lrf to download an arbitrary website?</h2>
|
||||
<pre class="showcmd">web2lrf --url http://mywebsite.com default</pre>
|
||||
|
||||
|
||||
@ -328,7 +328,7 @@ Author
|
||||
The Jobs panel shows you the number of currently running jobs. Jobs are tasks that run in a separate
|
||||
process, they include converting ebooks and talking to your reader device.
|
||||
You can click on the jobs panel to access the list of jobs.
|
||||
Once a job has completed, by clicking it in the list, you can see a detailed log from that job. This is useful
|
||||
Once a job has completed, by double-clicking it in the list, you can see a detailed log from that job. This is useful
|
||||
to debug jobs that may not have completed successfully.
|
||||
</p>
|
||||
|
||||
|
||||
@ -1,3 +1,13 @@
|
||||
<?python
|
||||
import re
|
||||
from genshi import HTML
|
||||
from pygments import highlight
|
||||
from pygments.lexers import PythonLexer
|
||||
from pygments.formatters import HtmlFormatter
|
||||
formatter = HtmlFormatter(linenos='inline', cssclass='codeblock',
|
||||
lineanchors='lineno', lineseparator='\n')
|
||||
lexer = PythonLexer()
|
||||
?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml"
|
||||
@ -12,15 +22,34 @@
|
||||
<meta name="copyright" content="© 2008 ${author}" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
||||
<link rel="stylesheet" type="text/css" href="styles/common.css" />
|
||||
${select('*|text()')}
|
||||
<style type="text/css">
|
||||
${formatter.get_style_defs('.codeblock')}
|
||||
.codeblock {
|
||||
background-color: #eeeeee;
|
||||
border: inset 1px black;
|
||||
}
|
||||
.lineno {
|
||||
color: lightgray;
|
||||
font-weight: normal;
|
||||
border-top: solid 1px black;
|
||||
}
|
||||
</style>
|
||||
|
||||
${select('*|text()')}
|
||||
</head>
|
||||
</py:match>
|
||||
|
||||
<py:match path="div[@class='pygmentize']">
|
||||
${HTML(highlight(re.compile(r'^\|\|\|$', re.MULTILINE).sub('', unicode(select('*|text()'))), lexer, formatter))}
|
||||
</py:match>
|
||||
|
||||
<py:match path="body">
|
||||
|
||||
<body py:attrs="select('@*')">
|
||||
<h1 class="documentHeading">
|
||||
${title}
|
||||
</h1>
|
||||
|
||||
${select('*|text()')}
|
||||
<py:if test="footer">
|
||||
<hr />
|
||||
|
||||
@ -17,11 +17,22 @@ title = 'Using custom news sources'
|
||||
|
||||
<body>
|
||||
<p>
|
||||
<b>This page is awaiting the new news infrastructure in ${app}.</b>
|
||||
${app} contains a very powerful and flexible engine to make fetching
|
||||
news from the Internet and converting it to a nicely formatted ebook,
|
||||
really easy. The easiest way to explain its full power and ease-of-use
|
||||
is through examples, so lets get started...
|
||||
</p>
|
||||
<div class="pygmentize">
|
||||
from libprs500.ebooks.lrf.web.profiles.automatic import AutomaticRSSProfile
|
||||
|||
|
||||
class BBC(DefaultProfile):
|
||||
|||
|
||||
feeds = [
|
||||
'http://newsrss.bbc.co.uk/rss/newsonline_uk_edition/front_page/rss.xml',
|
||||
'http://newsrss.bbc.co.uk/rss/newsonline_uk_edition/sci/tech/rss.xml',
|
||||
]
|
||||
</div>
|
||||
|
||||
</body>
|
||||
|
||||
|
||||
@ -24,18 +24,35 @@ title = '%s User Manual'%app
|
||||
go out to the internet and fetch metadata for your books. It can download newspapers and convert
|
||||
them into e-books for convenient reading. It is cross platform, running on Linux, Windows and OS X.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
To get started you should use the <a href="gui.html">Graphical User Interface</a>. It can be launched
|
||||
using its icon or the command <span class="cmd">${app}</span>.
|
||||
So you've just started ${app}. What do you do now? Well, before ${app} can do anything with your
|
||||
ebooks, it first has to know about them. So drag and drop a few ebook files into ${app}, or click
|
||||
the "Add books" button and browse for the ebooks you want to work with. Once you've added the books,
|
||||
they will show up in the main view looking something like this:<br/>
|
||||
<img src="images/added_books.png"/><br/>
|
||||
</p>
|
||||
<p>
|
||||
Once you've admired the list of books you just added to your heart's content, you'll probably want to read on.
|
||||
In order to do that you'll have to convert the book to a format your reader understands. For the SONY
|
||||
Reader that's the LRF format. Conversion is a breeze, just select the book you want to convert, and
|
||||
click the "Convert E-book" button. Ignore all the options for now and just click "OK". The little hourglass
|
||||
in the bottom right corner will start spinning. Once it's finished spinning, your converted book is ready.
|
||||
Click to "View" button to read the book.
|
||||
</p>
|
||||
<p>
|
||||
Now if you want to read the book on your reader, just connect it to the computer, wait till
|
||||
${app} detects it (10-20secs) and then click the "Send to device" button. Once the hourglass stops
|
||||
spinning again, disconnect your reader and read away!
|
||||
</p>
|
||||
<p>
|
||||
To get started with more advanced usage, you should read about the
|
||||
<a href="gui.html">Graphical User Interface</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
For advanced usage you should check out the <a href="cli-index.html">Command Line Interface</a>.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
You may find the list of <a href="faq.html">Frequently Asked Questions</a> useful as well.
|
||||
You will find the list of <a href="faq.html">Frequently Asked Questions</a> useful as well.
|
||||
</p>
|
||||
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user