diff --git a/src/calibre/manual/develop.rst b/src/calibre/manual/develop.rst index efab5a1cac..e7f3103fce 100644 --- a/src/calibre/manual/develop.rst +++ b/src/calibre/manual/develop.rst @@ -194,7 +194,7 @@ You can insert the following two lines of code to start an interactive python se When running from the command line, this will start an interactive python interpreter with access to all locally defined variables (variables in the local scope). The interactive prompt even has TAB completion for object properties and you can use the various python facilities for introspection, such as -:function:`dir`, :function:`type`, :function:`repr`, etc. +:func:`dir`, :func:`type`, :func:`repr`, etc. Using print statements ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/src/calibre/manual/images/bookmark.png b/src/calibre/manual/images/bookmark.png new file mode 100644 index 0000000000..c6671a2541 Binary files /dev/null and b/src/calibre/manual/images/bookmark.png differ diff --git a/src/calibre/manual/images/font_size.png b/src/calibre/manual/images/font_size.png new file mode 100644 index 0000000000..59ba041d83 Binary files /dev/null and b/src/calibre/manual/images/font_size.png differ diff --git a/src/calibre/manual/images/full_screen.png b/src/calibre/manual/images/full_screen.png new file mode 100644 index 0000000000..ed1e283194 Binary files /dev/null and b/src/calibre/manual/images/full_screen.png differ diff --git a/src/calibre/manual/images/nav_pos.png b/src/calibre/manual/images/nav_pos.png new file mode 100644 index 0000000000..2b99182176 Binary files /dev/null and b/src/calibre/manual/images/nav_pos.png differ diff --git a/src/calibre/manual/images/pref_button.png b/src/calibre/manual/images/pref_button.png new file mode 100644 index 0000000000..f43f2d7627 Binary files /dev/null and b/src/calibre/manual/images/pref_button.png differ diff --git a/src/calibre/manual/images/prev_next.png b/src/calibre/manual/images/prev_next.png new file mode 100644 index 0000000000..cc761704e7 Binary files /dev/null and b/src/calibre/manual/images/prev_next.png differ diff --git a/src/calibre/manual/images/ref_mode.png b/src/calibre/manual/images/ref_mode.png new file mode 100644 index 0000000000..67a75edf21 Binary files /dev/null and b/src/calibre/manual/images/ref_mode.png differ diff --git a/src/calibre/manual/images/ref_mode_button.png b/src/calibre/manual/images/ref_mode_button.png new file mode 100644 index 0000000000..efed1af26b Binary files /dev/null and b/src/calibre/manual/images/ref_mode_button.png differ diff --git a/src/calibre/manual/images/toc.png b/src/calibre/manual/images/toc.png new file mode 100644 index 0000000000..462b6b6c32 Binary files /dev/null and b/src/calibre/manual/images/toc.png differ diff --git a/src/calibre/manual/index.rst b/src/calibre/manual/index.rst index d736dbd020..827d848eb1 100644 --- a/src/calibre/manual/index.rst +++ b/src/calibre/manual/index.rst @@ -29,6 +29,7 @@ Sections gui news + viewer conversion metadata faq diff --git a/src/calibre/manual/viewer.rst b/src/calibre/manual/viewer.rst new file mode 100644 index 0000000000..40ef71918b --- /dev/null +++ b/src/calibre/manual/viewer.rst @@ -0,0 +1,105 @@ +.. include:: global.rst + +.. _gui: + +The E-book Viewer +============================= + +|app| includes a built-in E-book viewer that can view all the major e-book formats. +The viewer is highly customizable and has many advanced features. + +.. contents:: + :depth: 1 + :local: + +Starting the viewer +-------------------- + +You can view any of the books in your |app| library by selecting the book and pressing the View button. This +will open up the book in the e-book viewer. You can also launch the viewer by itself, from the Start menu in windows +or using the command :command:`ebook-viewer` in Linux and OS X (you have to install the command line tools on OS X +first by going to Preferences->Advanced). + +Navigating around an e-book +----------------------------- + +.. |pni| image:: images/prev_next.png + +.. |bookmi| image:: images/bookmark.png + +.. |toci| image:: images/toc.png + +.. |navposi| image:: images/nav_pos.png + +.. |refmi| image:: images/ref_mode_button.png + + +You can "turn pages" in a book by using the :guilabel:`Page Next` and :guilabel:`Page Previous` buttons |pni|, or by pressing +the Page Down/Page Up keys. Unlike most e-book viewers, |app| does not force you to view books in paged mode. You can +scroll by amounts less than a page by using the scroll bar or various customizable keyboard shortcuts. + +Bookmarks +^^^^^^^^^^^^ + +When you are in the middle of a book and close the viewer, it will remember where you stopped reading and return there +the next time you open the book. You can also set bookmarks in the book by using the Bookmark button |bookmi|. When viewing EPUB format +books, these bookmarks are actually saved in the EPUB file itself, so you can add bookmarks, then send the file to a friend and +when they open the file, they will be able to see your bookmarks. + +Table of Contents +^^^^^^^^^^^^^^^^^^^^ + +If the book you are reading defines a Table of Contents, you can access it by pressing the Table of Contents button |toci|. +This will bring up a list of sections in the book and you can click on any of them to jump to that portion of the book. + +Navigating by location +^^^^^^^^^^^^^^^^^^^^^^^^ + +E-books, unlike paper books have no concept of pages. Instead, +as you read through the book, you will notice that your position in the book is displayed in the upper left corner in a box +like this |navposi|. This is both your current position and the total length of the book. These numbers are independent of the screen size and font +size you are viewing the boko at, and they play a similar role to page numbers in paper books. +You can enter any number you like to go to the corresponding location in the book. + +|app| also has a very handy +reference mode. You can turn it on by clicking the Reference Mode button |refmi|. Once you do this, every time you move your +mouse over a paragraph, calibre will display a unique number made up of the section and paragraph numbers. + +.. image:: images/ref_mode.png + +You can use this number to unambiguously refer to parts of the books when discussing it with friends or referring to it +in other works. You can enter these numbers in the box marked Go to at the top of the window to go to a particular +reference location. + +If you click on links inside the e-book to take you to different parts of the book, like an endnote, you can use the back and forward buttons +in the top left corner to return to where you were. These button behave just like those in a web browser. + +Customizing the look and feel of your reading experience +------------------------------------------------------------ + +.. |fontsizei| image:: images/font_size.png + +.. |fsi| image:: images/full_screen.png + +.. |prefbi| image:: images/pref_button.png + +You can change font sizes on the fly by using the font size buttons |fontsizei|. You can also make the viewer full screen +by pressing the Full Screen button |fsi|. By clicking the Preferences button |prefbi|, you can change the default fonts used +by the viewer to ones you like as well as the default font size when the viewer starts up. + +More advanced customization can be achieved by the User Stylesheet setting. This is a stylesheet you can set that will be applied +to every book. Using it you can do things like have white text on a black background, change paragraph styles, text justification, etc. +For examples if custom stylesheets used by |app|'s users, see `http://www.mobileread.com/forums/showthread.php?t=51500`_. + +Dictionary lookup +------------------- + +You can lookup the meaning of words in the current book by right clicking on a word. |app| uses the publicly available dictionary +server at ``dict.org`` to lookup words. The definition is displayed in a small box at the bottom of the screen. + +Copying text and images +------------------------- + +You can select text and images by dragging the content with your mouse and then right click to copy to the clipboard. +The copied material can be pasted into another application as plain text and images. +