2 <!DOCTYPE book PUBLIC
"-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3 <!ENTITY kappname
"&okular;">
4 <!ENTITY package
"kdegraphics">
5 <!ENTITY kpdf
"<application>KPDF</application>">
6 <!ENTITY PDF
"<acronym>PDF</acronym>">
7 <!ENTITY % English
"INCLUDE">
8 <!ENTITY % addindex
"IGNORE">
11 <book lang=
"&language;">
13 <title>The
&okular; Handbook
</title>
16 <firstname>Albert
</firstname>
17 <surname>Astals Cid
</surname>
19 <address><email>aacid@kde.org
</email></address>
23 <firstname>Pino
</firstname>
24 <surname>Toscano
</surname>
26 <address><email>pino@kde.org
</email></address>
29 <!-- TRANS:ROLES_OF_TRANSLATORS -->
31 <legalnotice>&FDLNotice;</legalnotice>
32 <date>2009-
01-
25</date>
33 <releaseinfo>0.8</releaseinfo>
34 <!-- Abstract about this handbook -->
36 <para>&okular; is a
&kde; universal document viewer based on
&kpdf; code.
</para>
39 <keyword>KDE
</keyword>
40 <keyword>okular
</keyword>
41 <keyword>pdf
</keyword>
43 <keyword>postscript
</keyword>
44 <keyword>tiff
</keyword>
45 <keyword>djvu
</keyword>
46 <keyword>dvi
</keyword>
47 <keyword>chm
</keyword>
48 <keyword>xps
</keyword>
49 <keyword>comicbook
</keyword>
50 <keyword>fictionbook
</keyword>
51 <keyword>mobipocket
</keyword>
52 <keyword>plucker
</keyword>
53 <keyword>annotation
</keyword>
56 <chapter id=
"introduction">
57 <title>Introduction
</title>
58 <para>&okular; is a
&kde; universal document viewer based on the code of the
&kpdf; application.
59 Although being based on
&kpdf; code,
&okular; has some unique features such as overview mode,
60 improved presentation support and annotation support.
64 The PDF format is widely used for publishing documents that are
65 mostly not meant to be edited again. &okular; is only a viewer
66 for these files and therefore it doesn't provide any functionality
67 to edit or create PDF documents.
72 <title>Basic Usage
</title>
74 <title>Opening Files
</title>
76 To view any supported file in
&okular;, select
<menuchoice><guimenu>File
</guimenu><guimenuitem>Open...
</guimenuitem>
77 </menuchoice>, choose a supported file in the dialogue and click
<guibutton>Open
</guibutton>.
78 Your file should now be displayed in the main window.
81 If you have already opened files in
&okular; before, you can quickly access them by selecting them in
82 the
<menuchoice><guimenu>File
</guimenu><guisubmenu>Open Recent
</guisubmenu></menuchoice> menu.
85 After having a file opened you probably want to read it and therefore navigate through it. Go to the
86 <link linkend=
"navigating">next section
</link> to learn more about this.
89 <sect1 id=
"navigating">
90 <title>Navigating
</title>
91 <para>This section describes how you can navigate through a document in
&okular;.
</para>
93 There are multiple ways of scrolling the viewing area. One is to use the
94 <keycap>Up Arrow
</keycap> and
<keycap>Down Arrow
</keycap> keys. You may also use
95 the scrollbar, your mousewheel or the
<keycap>Page Up
</keycap> and
<keycap>Page Down
</keycap>
99 Another way is to hold the
&LMB; down at any place on the document while dragging the mouse in the
100 opposite direction of where you want to move. This procedure only works if the Browse Tool is
101 enabled, which you can select by choosing
<menuchoice><guimenu>Tools
</guimenu><guimenuitem>Browse Tool
102 </guimenuitem></menuchoice>.
105 The navigation panel on the left side of the screen enables two more ways of navigating
111 If you click on a page thumbnail the viewing area will be brought to
117 If the document has a table of contents, clicking on a table
118 of contents item will bring the document to to the page linked to that
124 Some documents have links. In this case you can click on them and the view will
125 change to the page it links to. If the link is to a web page or some
126 other document the default
&kde; handler for that format will be invoked.
127 For example, clicking on a link pointing to
<quote>http://www.kde.org
</quote>
128 will open the web page in the default
&kde;'s web browser.
131 Additionally, you may use the following functionality to quickly move to specific places
137 You can go to the first page of the document using
138 <keycombo action=
"simul">&Ctrl;<keycap>Home
</keycap></keycombo> or
141 <guimenu>Go
</guimenu>
142 <guimenuitem>First Page
</guimenuitem>
148 You can go to the last page of the document using
149 <keycombo action=
"simul">&Ctrl;<keycap>End
</keycap></keycombo> or
152 <guimenu>Go
</guimenu>
153 <guimenuitem>Last Page
</guimenuitem>
159 You can go forward in the document using
<keycap>Space
</keycap> or
<keycap>Page Down
</keycap>.
160 To go to the next page of the document use the
<guibutton>Next Page
</guibutton> Toolbar
163 <guimenu>Go
</guimenu>
164 <guimenuitem>Next Page
</guimenuitem>
165 </menuchoice> in the menubar.
170 You can go back in the document using
<keycap>Backspace
</keycap> or
<keycap>Page Up
</keycap>.
171 To go to the previous page of the document use
<guibutton>Previous Page
</guibutton> Toolbar
174 <guimenu>Go
</guimenu>
175 <guimenuitem>Previous Page
</guimenuitem>
176 </menuchoice> in the menubar.
181 <sect1 id=
"presentationMode">
182 <title>Presentation Mode
</title>
184 The Presentation mode represents another way to view documents in
&okular;. It can be
186 <menuchoice><guimenu>View
</guimenu><guimenuitem>Presentation
</guimenuitem></menuchoice>.
187 It shows the document on a page per page basis. The pages are shown with
188 zoom to page, that means all the page is visible.
192 &PDF; documents can even specify that they are always opened in presentation mode.
196 When in presentation mode, you have an helper bar located on the top of the screen. Just move
197 the mouse cursor to the top of the screen to make it appear.
201 pages you may use the
&LMB; (next page) and the
&RMB; (previous page), the mouse
202 wheel, the arrow icons or the line edit in the top bar,
203 or the keys specified in the
<link linkend=
"navigating">Navigating
</link>
207 You can exit presentation mode at any time by pressing the
<keycap>ESC
</keycap> key or clicking
208 the
<guiicon>Quit
</guiicon> icon in the top bar.
211 You can also draw on the current page with a pencil. Click on the
212 <guilabel>Toggle Drawing Mode
</guilabel> icon in the top bar to enable or disable the possibility
213 of draw in the presentation mode. The drawings are cleared automatically when switching to
214 another page, or manually selecting the
<guilabel>Erase Drawings
</guilabel> icon in the top bar.
217 The presentation mode has support for more than one screen in a multi-monitor configuration.
218 With more than one screen a new button will appear in the top bar, with the icon of a screen:
219 this is a drop down box that allows you to move the presentation to any of the other available screens.
222 Presentation mode has some configuration options, you can find their
223 description in the chapter
<link linkend=
"configpresentation">Configuring
&okular;</link>.
228 <chapter id=
"advanced">
229 <title>&okular; Advanced Features
</title>
230 <sect1 id=
"embedded-files">
231 <title>Embedded Files
</title>
233 If the current document has some files embedded in it, when you open it a yellow bar
234 will appear above the page view to notify you about the embedded files.
237 <screeninfo>The embedded files bar
</screeninfo>
240 <imagedata fileref=
"embedded-files-bar.png" format=
"PNG" />
243 <phrase>The embedded files bar
</phrase>
248 In this case, you can either click on the link in the text of the bar or choose
249 <menuchoice><guimenu>File
</guimenu><guimenuitem>Embedded Files
</guimenuitem></menuchoice>
250 to open the embedded files dialog. The dialog allows you to view the embedded files and
254 <sect1 id=
"annotations">
255 <title>Annotations
</title>
257 &okular; allows you to review and annotate your documents.
258 Annotations created in
&okular; are automatically saved in the internal local data folder
260 &okular; does not implicitly change any document it opens.
263 Since
&kde; 4.2,
&okular; has the
"document archiving" feature. This is an
&okular;-specific format for carrying the document plus various metadata related to it (currently only annotations). You can save a
"document archive" from the open document by choosing
<menuchoice><guimenu>File
</guimenu><guisubmenu>Export As
</guisubmenu><guimenuitem>Document Archive
</guimenuitem></menuchoice>. To open an
&okular; document archive, just open it with
&okular; as it would be
⪚ a
&PDF; document.
267 Due to DRM limitations (typically with
&PDF; documents), adding, editing some properties
268 or removing annotations could not be possible.
271 <sect2 id=
"annotations-add">
272 <title>Adding annotations
</title>
274 To add some annotations to the document, you have to activate the annotating toolbar.
275 This is done by either selecting
276 <menuchoice><guimenu>Tools
</guimenu><guimenuitem>Review
</guimenuitem></menuchoice> or
277 pressing
<keycap>F6
</keycap>. Once the annotating toolbar is shown, just press one of
278 its buttons to start constructing that annotation.
282 The annotating toolbar can be docked in any side of the viewing area: just drag it to
283 move it to another place.
288 Activating the annotating toolbar will make you switch to the Normal Mode.
292 You can stop the construction any time by pressing again on the button of the
293 annotation you are constructing, or by pressing the
<keycap>ESC
</keycap> key.
296 The newly constructed annotation will have as author the author you set in the
297 <guilabel>Identity
</guilabel> page in
&okular;s
298 <link linkend=
"configure">configuration
</link> dialog.
301 <sect2 id=
"annotations-remove">
302 <title>Removing annotations
</title>
304 To remove an annotation, just click on it with the
&RMB;, and select
305 <guimenuitem>Delete
</guimenuitem>.
308 When removing the annotation, its window will be closed if open.
312 This option could not be enabled because the document does not allow removing
317 <sect2 id=
"annotations-edit">
318 <title>Editing annotations
</title>
320 To edit an annotation, click on it with the
&RMB; and select
321 <guimenuitem>Properties
</guimenuitem>. A dialog will appear with the general
322 annotation settings (like color and opacity, author,
&etc;) and the settings specific
323 to that annotation type.
326 To move an annotation, hold down the
&Ctrl; key, move the mouse pointer on it and
327 then start dragging with the
&LMB;.
331 Depending on the document permissions (typically with
&PDF; documents), some options
339 <chapter id=
"primary-menu-items">
340 <title>The Menubar
</title>
342 <sect1 id=
"menufile">
343 <title>The
<guimenu>File
</guimenu> Menu
</title>
349 <keycombo action=
"simul">&Ctrl;<keycap>O
</keycap></keycombo>
351 <guimenu>File
</guimenu>
352 <guimenuitem>Open...
</guimenuitem>
357 <action>Open
</action> a supported file or okular archive. If there is already an opened file it will be closed. For more information, see the section about
<link linkend=
"opening">Opening Files
</link>.
365 <guimenu>File
</guimenu>
366 <guisubmenu>Open Recent
</guisubmenu>
371 <action>Open
</action> a file which was used previously from a
372 submenu. If a file is currently being displayed it
373 will be closed. For more information, see the section about
374 <link linkend=
"opening">Opening Files
</link>.
382 <shortcut><keycap>G</keycap></shortcut>
383 <guimenu>File</guimenu>
384 <guimenuitem>Get Books From Internet...</guimenuitem>
388 <para>to be written</para>
395 <guimenu>File
</guimenu>
396 <guimenuitem>Import PostScript as
&PDF;...
</guimenuitem>
401 <action>Open
</action> a PostScript file and convert it to
&PDF;.
409 <guimenu>File
</guimenu>
410 <guimenuitem>Save As...
</guimenuitem>
414 <para><action>Save
</action> the currently open file under a different name using the document backend. With the
&PDF; backend (Poppler
>=
0.8 required) it is possible to save the document with the changed values of the form fields.
</para>
421 <guimenu>File
</guimenu>
422 <guimenuitem>Save Copy As...
</guimenuitem>
426 <para><action>Save
</action> a copy of the currently open file under a different name
427 without using the current document backend.
</para>
434 <shortcut><keycap>F5
</keycap></shortcut>
435 <guimenu>File
</guimenu>
436 <guimenuitem>Reload
</guimenuitem>
440 <para><action>Reload
</action> the currently open file.
</para>
447 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>P
</keycap></keycombo></shortcut>
448 <guimenu>File
</guimenu>
449 <guimenuitem>Print...
</guimenuitem>
454 <action>Print
</action> the currently displayed document.
462 <guimenu>File
</guimenu>
463 <guimenuitem>Print Preview...
</guimenuitem>
468 <action>Show a preview
</action> of how the currently displayed
469 document would be printed with the default options.
477 <guimenu>File
</guimenu>
478 <guimenuitem>Properties
</guimenuitem>
482 <para><action>Display some basic information
</action> about the document, such as
483 title, author, creation date, and details about the fonts used. The available information
484 depends on the type of document.
</para>
490 <guimenu>File
</guimenu>
491 <guimenuitem>Embedded Files...
</guimenuitem>
495 <para><action>Show the files embedded
</action> in the document, if the document has any.
496 For more information, see the section about the
497 <link linkend=
"embedded-files">Embedded Files
</link>.
</para>
504 <guimenu>File
</guimenu>
505 <guisubmenu>Export As
</guisubmenu>
509 <para>This item contains the export formats the current document can be exported to.
510 The first entry for all kind of documents is always
<guimenuitem>Plain Text...
</guimenuitem></para>
511 <para>The second entry is
<guimenuitem>Document Archive
</guimenuitem>, which allows you to save the document with your annotations into an
&okular;-specific archive format. Thus it is easily possible to share the original document and your annotations with other
&okular; users or work with them collaboratively.
</para>
518 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>Q
</keycap></keycombo></shortcut>
519 <guimenu>File
</guimenu>
520 <guimenuitem>Quit
</guimenuitem>
524 <para><action>Close
</action> &okular;.
</para>
530 <sect1 id=
"menuedit">
531 <title>The
<guimenu>Edit
</guimenu> Menu
</title>
536 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>C
</keycap></keycombo></shortcut>
537 <guimenu>Edit
</guimenu>
538 <guimenuitem>Copy
</guimenuitem>
542 <para><action>Copy
</action> the currently selected text in
543 <guibutton>Text Selection
</guibutton> mode to the clipboard.
</para>
552 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>A
</keycap></keycombo></shortcut>
553 <guimenu>Edit
</guimenu>
554 <guimenuitem>Select All
</guimenuitem>
558 <para><action>Selects
</action> all the text (if the document provides it). This works only in
559 <guibutton>Text Selection
</guibutton> mode.
</para>
568 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>F
</keycap></keycombo></shortcut>
569 <guimenu>Edit
</guimenu>
570 <guimenuitem>Find...
</guimenuitem>
575 Show the find bar on the bottom of the viewing area that allows you to
576 <action>search for a string in the document
</action>.
584 <shortcut><keycap>F3
</keycap></shortcut>
585 <guimenu>Edit
</guimenu>
586 <guimenuitem>Find Next
</guimenuitem>
590 <para>Try to
<action>find the previous searched string again
</action> in the document.
</para>
597 <shortcut><keycombo action=
"simul">&Shift;<keycap>F3
</keycap></keycombo></shortcut>
598 <guimenu>Edit
</guimenu>
599 <guimenuitem>Find Previous
</guimenuitem>
603 <para><action>Goes to the previous occurrence of the search string
</action> in the document.
</para>
609 <sect1 id=
"menuview">
610 <title>The
<guimenu>View
</guimenu> Menu
</title>
615 <shortcut><keycombo action=
"simul">&Ctrl;&Shift;<keycap>P
</keycap></keycombo></shortcut>
616 <guimenu>View
</guimenu>
617 <guimenuitem>Presentation
</guimenuitem>
621 <para><action>Activates
</action> the Presentation Mode. For more information, see the
622 section about
<link linkend=
"presentationMode">Presentation Mode
</link>.
</para>
628 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>+
</keycap></keycombo></shortcut>
629 <guimenu>View
</guimenu>
630 <guimenuitem>Zoom In
</guimenuitem>
634 <para><action>Increase the magnification
</action> of the document view.
</para>
641 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>-
</keycap></keycombo></shortcut>
642 <guimenu>View
</guimenu>
643 <guimenuitem>Zoom Out
</guimenuitem>
647 <para><action>Decrease the magnification
</action> of the document view.
</para>
653 <guimenu>View
</guimenu>
654 <guimenuitem>Fit Width
</guimenuitem>
658 <para><action>Change the magnification
</action> of the document
659 view to a value that makes the pages' width equal to the document
666 <guimenu>View
</guimenu>
667 <guimenuitem>Fit Page
</guimenuitem>
671 <para><action>Change the magnification
</action> of the document view
672 to a value that makes at least one whole page visible.
</para>
678 <guimenu>View
</guimenu>
679 <guimenuitem>Continuous
</guimenuitem>
683 <para><action>Enable the continuous page mode
</action>. In continuous mode,
684 all pages of the document are shown, and you can scroll through
685 them without having to use the
<menuchoice><guimenu>Go
</guimenu>
686 <guimenuitem>Previous Page
</guimenuitem></menuchoice> and
687 <menuchoice><guimenu>Go
</guimenu><guimenuitem>Next Page
</guimenuitem>
688 </menuchoice> options.
</para>
694 <guimenu>View
</guimenu>
695 <guisubmenu>View Mode
</guisubmenu>
699 <para>This submenu makes you choose the view mode for the pages. The possible
700 options are:
<guimenuitem>Single Page
</guimenuitem> (only one page per row),
701 <guimenuitem>Facing Pages
</guimenuitem> (two pages per row, in a book style) and
702 <guimenuitem>Overview
</guimenuitem> (the number of columns is the one
703 specified in the
<link linkend=
"configure">&okular; settings
</link>).
</para>
709 <guimenu>View
</guimenu>
710 <guisubmenu>Orientation
</guisubmenu>
715 This submenu allows you to
<action>changes the orientation
</action>
716 of the pages of the document.
720 The rotation is applied to the orientation of every page.
724 You can select
<guimenuitem>Original Orientation
</guimenuitem> to restore
725 the orientation of the document, discarding all the rotations applied
733 <guimenu>View
</guimenu>
734 <guisubmenu>Page Size
</guisubmenu>
739 <action>Changes the size of the pages
</action> of the document.
743 This submenu is active only if the current type of document
744 supports different page sizes.
752 <guimenu>View
</guimenu>
753 <guimenuitem>Trim Margins
</guimenuitem>
758 Remove the white border of pages when viewing pages.
765 <guimenu>View
</guimenu>
766 <guimenuitem>Show/Hide Forms
</guimenuitem>
771 <action>Show or hides the display
</action> of the form fields of the
776 This menu item is active only if the current document has form
786 <title>The
<guimenu>Go
</guimenu> Menu
</title>
791 <shortcut><keycap>Backspace
</keycap></shortcut>
792 <guimenu>Go
</guimenu>
793 <guimenuitem>Previous Page
</guimenuitem>
797 <para><action>View the previous page
</action> of the document.
</para>
803 <shortcut><keycap>Space
</keycap></shortcut>
804 <guimenu>Go
</guimenu>
805 <guimenuitem>Next Page
</guimenuitem>
809 <para><action>View the next page
</action> of the document.
</para>
815 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>Home
</keycap></keycombo></shortcut>
816 <guimenu>Go
</guimenu>
817 <guimenuitem>First Page
</guimenuitem>
821 <para><action>Go to the first page
</action> of the document.
</para>
827 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>End
</keycap></keycombo></shortcut>
828 <guimenu>Go
</guimenu>
829 <guimenuitem>Last Page
</guimenuitem>
833 <para><action>Go to the last page
</action> of the document.
</para>
839 <guimenu>Go
</guimenu>
840 <guimenuitem>Back in the Document
</guimenuitem>
844 <para><action>Go back to the previous view
</action> of the document.
</para>
850 <guimenu>Go
</guimenu>
851 <guimenuitem>Forward in the Document
</guimenuitem>
855 <para><action>Move forward to the next view
</action> of the document. This only works if you have already moved back before.
</para>
861 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>G
</keycap></keycombo></shortcut>
862 <guimenu>Go
</guimenu>
863 <guimenuitem>Go to Page...
</guimenuitem>
867 <para>Open a dialog which allows you to
<action>go to any page
</action> of the document.
</para>
873 <sect1 id=
"menubookmarks">
874 <title>The
<guimenu>Bookmarks
</guimenu> Menu
</title>
879 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>B
</keycap></keycombo></shortcut>
880 <guimenu>Bookmarks
</guimenu>
881 <guimenuitem>Add/Remove Bookmark
</guimenuitem>
886 <action>Add or remove a bookmark for the current page
</action>.
893 <guimenu>Bookmarks
</guimenu>
894 <guimenuitem>Previous Bookmark
</guimenuitem>
898 <para><action>Go to the previous bookmarked page
</action>, or do nothing if there
899 are no bookmarked pages prior to the current one.
</para>
905 <guimenu>Bookmarks
</guimenu>
906 <guimenuitem>Next Bookmark
</guimenuitem>
910 <para><action>Go to the next bookmarked page
</action>, or do nothing if there
911 are no bookmarked pages after the current one.
</para>
917 <guimenu>Bookmarks
</guimenu>
918 <guimenuitem>No Bookmarks
</guimenuitem>
922 <para>This is an always disabled action that appears in this menu only if the current document has
923 no bookmarks. Otherwise a list of all bookmarked pages is displayed here. Clicking on these bookmarks
924 allows you to go directly to the associated pages.
</para>
930 <sect1 id=
"menutools">
931 <title>The
<guimenu>Tools
</guimenu> Menu
</title>
936 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>1</keycap></keycombo></shortcut>
937 <guimenu>Tools
</guimenu>
938 <guimenuitem>Browse Tool
</guimenuitem>
942 <para>The mouse will have its normal behaviour,
&LMB; for dragging the document and following links and
&RMB; for adding bookmarks and fit to width.
</para>
948 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>2</keycap></keycombo></shortcut>
949 <guimenu>Tools
</guimenu>
950 <guimenuitem>Zoom Tool
</guimenuitem>
954 <para>The mouse will work as a zoom tool. Clicking
&LMB; and dragging will zoom the view to the selected area, clicking
&RMB; will bring the document back to the previous zoom.
</para>
960 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>3</keycap></keycombo></shortcut>
961 <guimenu>Tools
</guimenu>
962 <guimenuitem>Selection Tool
</guimenuitem>
966 <para>The mouse will work as a select tool. In that mode clicking
&LMB; and dragging will give the option of copying the text/image of current selected area to the clipboard, speak a text or to save an image to a file.
</para>
972 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>4</keycap></keycombo></shortcut>
973 <guimenu>Tools
</guimenu>
974 <guimenuitem>Text Selection Tool
</guimenuitem>
978 <para>The mouse will work as a text selection tool. In that mode clicking
&LMB; and
979 dragging will give the option of selecting the text of the document. Then, just
980 click with the
&RMB; to copy to the clipboard or speak the current selection.
</para>
986 <shortcut><keycap>F6
</keycap></shortcut>
987 <guimenu>Tools
</guimenu>
988 <guimenuitem>Review
</guimenuitem>
992 <para><action>Open the review toolbar
</action>. The review toolbar allows you to add
993 annotations on the document you are reading. For more information, please see the
994 section about
<link linkend=
"annotations">Annotations
</link>.
</para>
1000 <guimenu>Tools
</guimenu>
1001 <guimenuitem>Speak Whole Document
</guimenuitem>
1006 <guimenu>Tools
</guimenu>
1007 <guimenuitem>Speak Current Page
</guimenuitem>
1012 <guimenu>Tools
</guimenu>
1013 <guimenuitem>Stop Speaking
</guimenuitem>
1017 <para>These items allow you to speak the whole document or just the current page and stop speaking using the
&kde; Text-to-Speech system
<application>KTTS
</application>.
</para>
1018 <para>The
<guilabel>Speak ...
</guilabel> actions are enabled only if
<application>KTTS
</application> is available in the system.
</para>
1024 <sect1 id=
"settings-menu">
1025 <title>The
<guimenu>Settings
</guimenu> Menu
</title>
1030 <shortcut><keycombo action=
"simul">&Ctrl;<keycap>M
</keycap></keycombo></shortcut>
1031 <guimenu>Settings
</guimenu>
1032 <guimenuitem>Show Menubar
</guimenuitem>
1036 <para><action>Toggle the Menubar display
</action> on and off. Once
1037 hidden it can be made visible using the shortcut
1038 <keycombo action=
"simul">&Ctrl;<keycap>M
</keycap></keycombo> again.
</para>
1044 <guimenu>Settings
</guimenu>
1045 <guimenuitem>Show Toolbar
</guimenuitem>
1049 <para><action>Toggle the Toolbar display
</action> on and off.
</para>
1055 <shortcut><keycap>F7
</keycap></shortcut>
1056 <guimenu>Settings
</guimenu>
1057 <guimenuitem>Show Navigation Panel
</guimenuitem>
1061 <para><action>Toggle the navigation panel
</action> on and off.
</para>
1067 <shortcut><keycombo action=
"simul">&Ctrl;&Shift;<keycap>F
</keycap></keycombo></shortcut>
1068 <guimenu>Settings
</guimenu>
1069 <guimenuitem>Full Screen Mode
</guimenuitem>
1073 <para><action>Enables the full screen mode
</action>. Note that
1074 full screen mode is different from
<link
1075 linkend=
"presentationMode">presentation mode
</link> insofar as the
1076 only peculiarity of full screen mode is that it hides the window
1077 decorations, the menubar and the toolbar.
</para>
1083 <guimenu>Settings
</guimenu>
1084 <guimenuitem>Configure Shortcuts...
</guimenuitem>
1088 <para>Opens a window that lets you
<action>configure the keyboard
1089 shortcuts
</action> for many menu commands.
</para>
1095 <guimenu>Settings
</guimenu>
1096 <guimenuitem>Configure Toolbars...
</guimenuitem>
1100 <para>Opens a window that lets you choose which icons are visible
1101 in the toolbar.
</para>
1107 <guimenu>Settings
</guimenu>
1108 <guimenuitem>Configure Backends...
</guimenuitem>
1112 <para>Opens the
<link linkend=
"configure">Backend Configuration
</link>
1119 <guimenu>Settings
</guimenu>
1120 <guimenuitem>Configure
&okular;...
</guimenuitem>
1124 <para>Opens the
<link linkend=
"configure">Configure
</link>
1131 <sect1 id=
"menuhelp">
1132 <title>The
<guimenu>Help
</guimenu> Menu
</title>
1133 &help.menu.documentation;
1137 <chapter id=
"configure">
1138 <title>Configuring
&okular;</title>
1139 <sect1 id=
"configindex">
1140 <title>General configuration
</title>
1142 You can configure
&okular; by choosing
<menuchoice><guimenu>Settings
</guimenu>
1143 <guimenuitem>Configure
&okular;...
</guimenuitem></menuchoice>.
1144 The configuration dialogue is split into five sections. This chapter describes the available
1149 <para><link linkend=
"configgeneral">General
</link></para>
1152 <para><link linkend=
"configaccessibility">Accessibility
</link></para>
1155 <para><link linkend=
"configperformance">Performance
</link></para>
1158 <para><link linkend=
"configpresentation">Presentation
</link></para>
1161 <para><link linkend=
"configidentity">Identity
</link></para>
1165 <screeninfo>The configuration dialogue
</screeninfo>
1168 <imagedata fileref=
"configure.png" format=
"PNG" />
1171 <phrase>The configuration dialogue
</phrase>
1176 Depending on the currently installed backends, the
<menuchoice><guimenu>Settings
</guimenu>
1177 <guimenuitem>Configure Backends...
</guimenuitem></menuchoice> menu item could be enabled.
1178 This particular configuration dialogue holds the configurations of the backends that can
1179 actually be configured.
1182 <sect1 id=
"configgeneral">
1183 <title>General
</title>
1186 <term><guilabel>Show scrollbars
</guilabel></term>
1188 <para>Whether to show scrollbars for the document view.
</para>
1192 <term><guilabel>Link the thumbnails with the page
</guilabel></term>
1194 <para>Whether the thumbnails view should always display the current
1199 <term><guilabel>Show hints and info messages
</guilabel></term>
1201 <para>Whether to show some informative messages on startup, file
1206 <term><guilabel>Obey DRM limitations
</guilabel></term>
1208 <para>Whether
&okular; should obey
<firstterm>DRM
</firstterm>
1209 (Digital Rights Management) restrictions. DRM limitations are used
1210 to make it impossible to perform certain actions with
&PDF; documents,
1211 such as copying content to the clipboard. Note that in some configurations
1212 of
&okular;, this option is not available.
</para>
1216 <term><guilabel>Reload document on file change
</guilabel></term>
1218 <para>Whether opened files should be automatically checked for
1219 changes and updated, if necessary.
</para>
1223 <term><guilabel>Show backend selection dialog
</guilabel></term>
1225 <para>Whether
&okular; should ask the user which backend to use in case of more
1226 than one backend able to open the current file. If unchecked,
&okular; will
1227 use the backend with the highest priority.
</para>
1231 <term><guilabel>Center first page
</guilabel></term>
1233 <para>Whether the first page should be centered or aligned to the left when
1234 displaying the pages in facing and overview mode.
</para>
1238 <term><guilabel>Overview columns
</guilabel></term>
1241 This options represent the number of columns to use in the overview mode.
1247 <sect1 id=
"configaccessibility">
1248 <title>Accessibility
</title>
1251 <term><guilabel>Draw border around links
</guilabel></term>
1253 <para>Whether to draw a border around links.
</para>
1257 <term><guilabel>Change colors
</guilabel></term>
1259 <para><action>Enables
</action> the color changing options.
</para>
1263 <term><guilabel>Invert Colors
</guilabel></term>
1265 <para><action>Inverts
</action> colors on the view,
&ie; black objects will be shown white.
</para>
1269 <term><guilabel>Change Paper Color
</guilabel></term>
1271 <para><action>Changes
</action> the paper's color,
&ie; the document's background.
</para>
1275 <term><guilabel>Change Dark
& Light Colors
</guilabel></term>
1277 <para><action>Changes
</action> the dark and light color to your preference, that means
1278 black will not be rendered as black but as the selected dark color and white
1279 will not be rendered as white but as the selected light color.
</para>
1283 <term><guilabel>Convert to Black
& White
</guilabel></term>
1285 <para><action>Converts
</action> the document to black and white. You can set the
1286 threshold and the contrast. Setting the threshold to a higher value
1287 will result in darker grays used.
</para>
1292 <sect1 id=
"configperformance">
1293 <title>Performance
</title>
1296 <term><guilabel>Enable transparency effects
</guilabel></term>
1298 <para>Draw selections and other special graphics using
1299 transparency effects. Disable the option to draw them using
1300 outline or opaque fill styles and increase speed on selections.
</para>
1304 <term><guilabel>Enable background generation
</guilabel></term>
1306 <para>Use a background thread to generate the pages. By disabling
1307 this option the user interface will become less reactive (will be blocked
1308 if necessary), but pages will be displayed a bit faster.
</para>
1312 <term><guilabel>Memory Usage
</guilabel></term>
1314 <para>&okular; can achieve best performance by tuning the memory usage, based on your system and your tastes.
1315 The more memory you let it to use, the faster the program will behave. The Default profile is good
1316 for every system, but you can prevent
&okular; from using more memory than necessary by selecting the Low
1317 profile, or let it get the most out of your system using Aggressive.
</para>
1322 <sect1 id=
"configpresentation">
1323 <title>Presentation
</title>
1326 <term><guilabel>Advance every
</guilabel></term>
1328 <para>Enables automatic advancing of pages given a time period.
</para>
1332 <term><guilabel>Loop after last page
</guilabel></term>
1334 <para>When navigating on presentation mode and going past the last page the first page will appear.
</para>
1338 <term><guilabel>Background color
</guilabel></term>
1340 <para>The color that will fill the part of the screen not covered by the page when on presentation mode.
</para>
1344 <term><guilabel>Pencil color
</guilabel></term>
1346 <para>The color of the pencil used when drawing on the pages during the presentation mode.
</para>
1350 <term><guilabel>Mouse cursor
</guilabel></term>
1352 <para>Whether the mouse should be always hidden, always shown or hidden after a small time of inactivity.
</para>
1356 <term><guilabel>Show progress indicator
</guilabel></term>
1358 <para>Whether to show a progress circle that shows the current page and the total number of pages on the upper
1359 right corner of the presentation screen every time you change the page.
</para>
1363 <term><guilabel>Show summary page
</guilabel></term>
1365 <para>Whether to show a summary page at the beginning of the presentation with the title, author and number of pages of the document.
</para>
1369 <term><guilabel>Default transition
</guilabel></term>
1371 <para>The transition effect between page and page if the document does not specify one. Set this to
<guilabel>Random
1372 Transition
</guilabel> to make
&okular; randomly choose one of the available effects.
</para>
1376 <term><guilabel>Placement
</guilabel></term>
1378 <para>In this section you can select the
<guilabel>Screen
</guilabel> used to display the presentation.
</para>
1379 <para><guilabel>Current Screen
</guilabel> is same screen of the
&okular; window that starts the presentation mode.
</para>
1380 <para><guilabel>Default Screen
</guilabel> is the screen marked as default in the xinerama configuration.
</para>
1381 <para><guilabel>Screen
0</guilabel>,
<guilabel>Screen
1</guilabel> &etc; are the available screens.
</para>
1386 <sect1 id=
"configidentity">
1387 <title>Identity
</title>
1390 <term><guilabel>Author
</guilabel></term>
1392 <para>The author of the contents added on a document.
</para>
1397 <sect1 id=
"configeditor">
1398 <title>Editor
</title>
1401 <term><guilabel>Editor
</guilabel></term>
1403 <para>Choose the editor you want to launch when
&okular; wants to open a source file.
1404 This is the case when the document has references to the various points (usually row and column number) of sources it was generated from. The
&DVI; format supports natively the addition of the information about the sources the LaTeX document was generated from. A similar system exists for
&PDF; documents, called
<acronym>pdfsync
</acronym>, which stores these extra information in an external file named after the
&PDF; file itself (for example
<filename>mydocument.pdfsync
</filename> for
<filename>mydocument.pdf
</filename>).
1409 <term><guilabel>Command
</guilabel></term>
1411 <para>This is the command and its parameters to invoke the selected editor with the source file of the actual document.
</para>
1417 <chapter id=
"credits">
1418 <title>Credits and License
</title>
1421 <title>Program Copyright:
</title>
1422 <listitem><para>Albert Astals Cid
<email>aacid@kde.org
</email> </para></listitem>
1423 <listitem><para>Pino Toscano
<email>pino@kde.org
</email> Current maintainer
</para></listitem>
1424 <listitem><para>Enrico Ros
<email>eros.kde@email.it
</email> &kpdf; developer
</para></listitem>
1428 <title>Documentation Copyright:
</title>
1429 <listitem><para>Albert Astals Cid
<email>aacid@kde.org
</email> Author
</para></listitem>
1430 <listitem><para>Titus Laska
<email>titus.laska@gmx.de
</email> Some updates and additions
</para></listitem>
1431 <listitem><para>Pino Toscano
<email>pino@kde.org
</email></para></listitem>
1433 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
1438 <appendix id=
"installation">
1439 <title>Installation
</title>
1440 <sect1 id=
"getting-kapp">
1441 <title>How to obtain
&okular;</title>
1442 &install.intro.documentation;
1444 <sect1 id=
"compilation">
1445 <title>Compilation and Installation
</title>
1448 If you are reading this help in the
&khelpcenter;,
&okular; has already been
1449 installed on this system and you do not need install it anymore.
1452 &install.compile.documentation;
1455 &documentation.index;
1462 sgml-minimize-attributes:nil
1463 sgml-general-insert-case:lower
1465 sgml-indent-data:nil
1468 // vim:ts=2:sw=2:tw=78:noet