From 7f5f76f2602c90701abbc2d958d371d5dfede6e6 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Thu, 28 Feb 2008 19:07:07 +0000 Subject: [PATCH] --- src/libprs500/manual/faq.html | 117 ++++++++++++++++++ src/libprs500/manual/gui.html | 108 +++++++++++++--- src/libprs500/manual/images/library.png | Bin 36182 -> 0 bytes src/libprs500/manual/images/search.png | Bin 2508 -> 33484 bytes src/libprs500/manual/images/search_button.png | Bin 0 -> 724 bytes src/libprs500/manual/images/search_sort.png | Bin 0 -> 77314 bytes src/libprs500/manual/index.html | 1 + src/libprs500/manual/libprs500.qhp | 27 +++- src/libprs500/manual/libprs500.webprj | 1 + src/libprs500/manual/make.py | 91 +++++++++----- src/libprs500/manual/start.html | 1 + src/libprs500/manual/templates/basic.html | 1 + src/libprs500/manual/templates/navtree.html | 1 + 13 files changed, 303 insertions(+), 45 deletions(-) create mode 100644 src/libprs500/manual/faq.html delete mode 100644 src/libprs500/manual/images/library.png create mode 100644 src/libprs500/manual/images/search_button.png create mode 100644 src/libprs500/manual/images/search_sort.png diff --git a/src/libprs500/manual/faq.html b/src/libprs500/manual/faq.html new file mode 100644 index 0000000000..c78c05aaa6 --- /dev/null +++ b/src/libprs500/manual/faq.html @@ -0,0 +1,117 @@ + + + + + + + + + + + + + + +

Frequently Asked Questions

+ +
+ +
+ +

What devices does libprs500 support?

+

+ At the moment libprs500 has full support for the SONY PRS500 and PRS505. However, using the "save to disk" function you can use it with any ebook reader that exports itself as a USB disk. +

+ +

What formats does libprs500 read metadata from?

+

+ libprs500 reads metadata from the following formats: LRF, PDF, LIT, RTF, OPF, MOBI, PRC, EPUB. + In addition it can write metadata to: LRF, RTF, OPF +

+

What formats does libprs500 support conversion to/from?

+

+ libprs500 supports the conversion of the following formats to LRF: HTML, LIT, MOBI, PRC, EPUB, RTF, TXT, PDF and LRS. It also supports the conversion of LRF to LRS and HTML(upcoming). Note that libprs500 does not support the conversion of DRMed ebooks. +

+

What are the best formats to convert to LRF?

+

+ In order of decreasing preference: LIT, MOBI, HTML, PRC, RTF, TXT, PDF +

+

Why does the PDF conversion lose some images?

+

+ The PDF conversion tries to extract the text and images from the PDF file and convert them to and HTML based ebook. Some PDF files have images in a format that cannot be extracted (vector images). +

+

Where are the book files stored?

+

+ When you import books into the library, they are stored in a database. The database location can be found out by clicking the configuration button (The button with the icon of a hammer next to the search bar). +

+

Can I save my books to the disk?

+

+ You can save your books to the disk by selecting the books and clicking the "Save to disk" button. Your books will be saved in nicely organized folders. +

+

I used libprs500 to transfer some books to my reader, and now the SONY software hangs every time I connect the reader?

+

+ You should not use both libprs500 and Connect to transfer books to the reader. You can fix this problem by: +

+

No images in the LRF file after conversion from HTML?

+

+ 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. +

+ +

Can I use web2lrf to download an arbitrary website?

+
web2lrf --url http://mywebsite.com default
+ +

I want some feature added to libprs500. What can I do?

+

+ You have two choices: +

+
    +
  1. Create a patch by hacking on libprs500 and send it to me for review and inclusion. See + Development. +
  2. +
  3. Open a ticket (you have to register and login first) and hopefully I will find the time to implement your feature. +
  4. +
+ +

How do I use some of the advanced features of the conversion tools?

+

+ You can get help on any individual feature of the converters by mousing over it in the GUI or running html2lrf --help at a terminal. A good place to start is to look at the following demo files that demonstrate some of the advanced features: +

+ + + +
+ + + + diff --git a/src/libprs500/manual/gui.html b/src/libprs500/manual/gui.html index 2eee951a1e..f9538a73d9 100644 --- a/src/libprs500/manual/gui.html +++ b/src/libprs500/manual/gui.html @@ -6,6 +6,7 @@ + The Graphical User Interface @@ -14,15 +15,21 @@

The Graphical User Interface

The Graphical User Interface (GUI) provides access to all - library management and ebook format conversion features. The interface - is divided into various sections: + library management and ebook format conversion features. The basic workflow + for using libprs500 is to first add books to the library from your hard disk. + libprs500 will automatically try to read metadata from the books and add them + to its internal database. Once they are in the database, you can performa various + actions on them that include conversion from one format to another, + transfer to the reading device, viewing on your computer, editing metadata, including covers, etc. +

+

+ The interface is divided into various sections:

@@ -114,7 +121,7 @@
  • Edit metadata in bulk: This allows you to edit common metadata fields for large numbers of books simulataneously. It - operates on all the books you have selected in the Library view. + operates on all the books you have selected in the Library view.
  • @@ -224,28 +231,101 @@ Author

    Catalogs

    Catalogs
    +

    + A catalog is a collection of books. libprs500 can manage three different catalogs: +

    +
    - -
    Search
    +

    Search & Sort

    +
    Search & Sort
    +

    + The Search & Sort section allows you to perform several powerful actions + on your book collections. +

    + +

    The Search Interface

    +

    + You can search all the metadata by entering search terms in the search bar. Searches are case insensitive. + For example: +

    + +
    +            Asimov Foundation format:lrf
    +        
    +

    + This will match all books in your library that have Asimov and Foundation in their metadata + and are available in the LRF format. You can build advanced search queries easily using the "Advanced Search Dialog" + by clicking the button Search button.

    +

    + + + + + + +
    Advanced Search Dialog + You can search on individual fields as shown. The "Negate" checkbox implies that only results that + do not match the search expression will be returned. You can require all the search criteria to match + or any of them. +

    Configuration

    -
    Configuration
    - -
    -

    Library

    -
    Library
    - -

    multiple selection

    +

    + The configuration dialog allows you to set some global defaults used by all of libprs500. To access it, click the + Configuration button. +


    Book Details

    Book Details
    +

    + The Book Details display shows you extra information and the cover for the currently selected book. +


    Jobs

    Jobs
    +

    + 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 + to debug jobs that may not have completed successfully. +