Cutlery/calibre
1
0
Fork 0
mirror of https://github.com/kovidgoyal/calibre.git synced 2025-07-08 10:44:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

Browse Source
This commit is contained in:
Kovid Goyal 2008-02-23 22:57:22 +00:00
parent 9aae9ce736
commit def450837e
16 changed files with 288 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/libprs500/manual/Makefile Normal file
View File

@ -0,0 +1,11 @@
QTDIR=/usr/local/Trolltech/Qt-4.4.0-tp1
QCG=${QTDIR}/bin/qcollectiongenerator
ASSISTANT=${QTDIR}/bin/assistant_new
LD_LIBRARY_PATH=${QTDIR}/lib
all : clean
LD_LIBRARY_PATH=${LD_LIBRARY_PATH} ${QCG} libprs500.qhcp && \
LD_LIBRARY_PATH=${LD_LIBRARY_PATH} ${ASSISTANT} -collectionFile libprs500.qhc &
clean :
rm -rf *.qhc *.qch ~/.assistant/libprs500.qhc

1
src/libprs500/manual/about.txt Normal file
View File

@ -0,0 +1 @@
<b>libprs500</b> is an ebook management application with support for various ebook readers. Created by <b>Kovid Goyal</b> &copy; 2007.

22
src/libprs500/manual/common.css Normal file
View File

@ -0,0 +1,22 @@
body {
font-family: sans-serif;
background-color: white;
}
.documentHeading {
text-align: center;
font-family: monospace;
}
.sectionHeading {
font-family: monospace;
}
.subsectionHeading {
font-family: monospace;
}
.action {
font-family: monospace;
font-weight: bold;
}

126
src/libprs500/manual/gui.html Normal file
View File

@ -0,0 +1,126 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" >
<head>
<meta name="author" content="Kovid Goyal" />
<meta name="copyright" content="2008 Kovid Goyal" />
<title>The Graphical User Interface</title>
<link rel="stylesheet" type="text/css" href="common.css" />
</head>
<body>
<h1 class="documentHeading">The Graphical User Interface</h1>
<p>
The Graphical User Interface <i>(GUI)</i> provides access to all
library management and ebook format conversion features. The interface
is divided into various sections:
</p>
<ul>
<li><a href="#actions">Actions</a></li>
<li><a href="#catalogs">Catalogs</a></li>
<li><a href="#search">Search</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#library">Library</a></li>
<li><a href="#book_details">Book Details</a></li>
<li><a href="#jobs">Jobs</a></li>
</ul>
<hr />
<h2 class="sectionHeading" id="actions">Actions</h2>
<div><img src="images/actions.png" alt="The Actions toolbar"/></div>
<p>
The actions toolbar provides convenient shortcuts to commonly used actions.
Most of the action buttons have little arrows next to them. By clicking the arrows,
you can perform slight variations on the defult action.
</p>
<ul>
<li><a href="#add_books">Add books</a></li>
<li><a href="#remove_books">Remove books</a></li>
<li><a href="#edit_meta_information">Edit meta information</a></li>
<li><a href="#send_to_device">Send to device</a></li>
<li><a href="#save_to_disk">Save to disk</a></li>
<li><a href="#fetch_news">Fetch News</a></li>
<li><a href="#convert_ebooks">Convert E-books</a></li>
<li><a href="#view">View</a></li>
</ul>
<h3 class="subsectionHeading" id="add_books">Add books</h3>
<p>
The <span class="action">Add books</span> action has three variations, accessed by the
arrow next to the button.
</p>
<ul>
<li>
<b>Add books from a single directory</b>: Opens a file chooser dialog and allows you to
specify which books in a directory should be added. This action is <i>context sensitive</i>, i.e.
it depends on which <a href="#catalogs">catalog</a> you have selected. If you have selected the
library, books will be added to the library. If you have selected the ebook reader device, the books
will be uploaded to the device.
</li>
<li>
<b>Add books recursively (One book per directory)</b>: Allows you to choose a directory. The directory and
all its sub-directories are scanned recursively and any ebooks found are added to the library. The algorithm
assumes that each directory contains a single book. All ebook files in a directory are assumed to be the same book
in different formats. This action is the inverse of the <a href="#save_to_disk_multiple">Save to disk</a> action,
i.e. you can Save to disk, delete the books and re-add them with no lost information (except Date).
</li>
<li>
<b>Add books recursively (Multiple books per directory)</b>: Allows you to choose a directory. The directory and
all its sub-directories are scanned recursively and any ebooks found are added to the library. The algorithm
assumes that each directory contains many books. All ebook files with the same name in a directory are assumed to be
the same book in different formats. This action is the inverse of the
<a href="#save_to_disk_single">Save to disk in a single directory</a> action,
i.e. you can Save to disk, delete the books and re-add them with no lost information (except Date).
</li>
</ul>
<p>
The <span class="action">Add books</span> action can read metadata from the following ebook formats:
<code>LRF, EPUB, LIT, MOBI, RTF, PDF, PRC, HTML</code>. In addition it tries to guess metadata from the filename.
See <a href="#config_filename_metadata">Configuration</a> section, to learn how to configure this.
</p>
<h3 class="subsectionHeading" id="remove_books">Remove books</h3>
<h3 class="subsectionHeading" id="edit_meta_information">Edit meta information</h3>
<h3 class="subsectionHeading" id="send_to_device">Send to device</h3>
<h3 class="subsectionHeading" id="save_to_disk">Save to disk</h3>
<h3 class="subsectionHeading" id="fetch_news">Fetch news</h3>
<h3 class="subsectionHeading" id="convert_ebooks">Convert E-books</h3>
<h3 class="subsectionHeading" id="view">View</h3>
<hr />
<h2 class="sectionHeading" id="catalogs">Catalogs</h2>
<div><img src="images/catalogs.png" alt="Catalogs"/></div>
<hr />
<h2 class="sectionHeading" id="search">Search</h2>
<div><img src="images/search.png" alt="Search"/></div>
<hr />
<h2 class="sectionHeading" id="configuration">Configuration</h2>
<div><img src="images/configuration.png" alt="Configuration" /></div>
<hr />
<h2 class="sectionHeading" id="library">Library</h2>
<div><img src="images/library.png" alt="Library"/></div>
<p>multiple selection</p>
<hr />
<h2 class="sectionHeading" id="book_details">Book Details</h2>
<div><img src="images/book_details.png" alt="Book Details" /></div>
<hr />
<h2 class="sectionHeading" id="jobs">Jobs</h2>
<div><img src="images/jobs.png" alt="Jobs" /></div>
</body>
</html>

BIN
src/libprs500/manual/images/actions.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
src/libprs500/manual/images/book_details.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 21 KiB

BIN
src/libprs500/manual/images/catalogs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.4 KiB

BIN
src/libprs500/manual/images/configuration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 662 B

BIN
src/libprs500/manual/images/jobs.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 4.7 KiB

BIN
src/libprs500/manual/images/library.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 35 KiB

BIN
src/libprs500/manual/images/search.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.4 KiB

21
src/libprs500/manual/index.html Normal file
View File

@ -0,0 +1,21 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"
xml:lang="en" >
<head>
<meta name="author" content="Kovid Goyal" />
<meta name="copyright" content="&copy; 2008 Kovid Goyal" />
<title>libprs500 User Manual</title>
<link rel="stylesheet" type="text/css" href="common.css" />
</head>
<body>
index.xhtml
</body>
</html>

29
src/libprs500/manual/libprs500.qhcp Normal file
View File

@ -0,0 +1,29 @@
<?xml version="1.0" encoding="utf-8" ?>
<QHelpCollectionProject version="1.0">
<assistant>
<title>libprs500 Help</title>
<startPage>qthelp://libprs500/manual/index.html</startPage>
<applicationIcon>../gui2/images/library.png</applicationIcon>
<enableFilterFunctionality>false</enableFilterFunctionality>
<enableDocumentationManager>false</enableDocumentationManager>
<enableAddressBar visible="true">true</enableAddressBar>
<aboutMenuText>
<text>About libprs500</text>
</aboutMenuText>
<aboutDialog>
<file>about.txt</file>
<icon>../gui2/images/dialog_information.svg</icon>
</aboutDialog>
</assistant>
<docFiles>
<generate>
<file>
<input>libprs500.qhp</input>
<output>libprs500.qch</output>
</file>
</generate>
<register>
<file>libprs500.qch</file>
</register>
</docFiles>
</QHelpCollectionProject>

36
src/libprs500/manual/libprs500.qhp Normal file
View File

@ -0,0 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
<namespace>libprs500</namespace>
<virtualFolder>manual</virtualFolder>
<customFilter name="index">
<filterAttribute>libprs500</filterAttribute>
</customFilter>
<filterSection>
<filterAttribute>libprs500</filterAttribute>
<toc>
<section title="Start" ref="index.html" />
<section title="Using the GUI" ref="gui.html">
<section title="Actions" ref="gui.html#actions" />
</section>
</toc>
<files>
<file>index.html</file>
<file>gui.html</file>
<file>common.css</file>
<file>images/actions.png</file>
<file>images/catalogs.png</file>
<file>images/book_details.png</file>
<file>images/configuration.png</file>
<file>images/jobs.png</file>
<file>images/library.png</file>
<file>images/search.png</file>
</files>
</filterSection>
</QtHelpProject>

23
src/libprs500/manual/libprs500.webprj Normal file
View File

@ -0,0 +1,23 @@
<!DOCTYPE webproject>
<webproject>
<project type="Local" name="libprs500" encoding="utf8" >
<upload/>
<author/>
<email/>
<defaultDTD>-//W3C//DTD XHTML 1.1//EN</defaultDTD>
<item url="about.txt" uploadstatus="1" />
<item url="libprs500.qhcp" uploadstatus="1" />
<item url="libprs500.qhp" uploadstatus="1" />
<item url="Makefile" uploadstatus="1" />
<item url="" uploadstatus="1" />
<annotations/>
<templates>templates/</templates>
<toolbars>toolbars/</toolbars>
<item url="templates/" uploadstatus="1" />
<item url="templates/basic.html" />
<item url="index.html" />
<item url="common.css" />
<item url="gui.html" />
<item url="images/" />
</project>
</webproject>

19
src/libprs500/manual/templates/basic.html Normal file
View File

@ -0,0 +1,19 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"
xml:lang="en" >
<head>
<meta name="author" content="Kovid Goyal" />
<meta name="copyright" content="&copy; 2008 Kovid Goyal" />
<title></title>
<link rel="stylesheet" type="text/css" href="../css/common.css" />
</head>
<body>
</body>
</html>