Warning, /graphics/okular/doc/index.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [ 0003 <!ENTITY kpdf "<application>KPDF</application>"> 0004 <!ENTITY % English "INCLUDE"> 0005 <!ENTITY % addindex "IGNORE"> 0006 ]> 0007 <!-- TODO 0008 add chapter about sidebar 0009 Show/Hide the whole thing to save screen space 0010 Describe all actions only possible in the navigation bars: 0011 Switching between documents using bookmarks 0012 Context menu actions like Rename Bookmarks etc.) 0013 --> 0014 <book id="okular" lang="&language;"> 0015 <bookinfo> 0016 <title>The &okular; Handbook</title> 0017 <authorgroup> 0018 <author> 0019 <firstname>Albert</firstname> 0020 <surname>Astals Cid</surname> 0021 <affiliation> 0022 <address>&Albert.Astals.Cid.mail;</address> 0023 </affiliation> 0024 </author> 0025 <author> 0026 <firstname>Pino</firstname> 0027 <surname>Toscano</surname> 0028 <affiliation> 0029 <address><email>pino@kde.org</email></address> 0030 </affiliation> 0031 </author> 0032 <!-- TRANS:ROLES_OF_TRANSLATORS --> 0033 </authorgroup> 0034 <legalnotice>&FDLNotice;</legalnotice> 0035 <date>2022-02-19</date> 0036 <releaseinfo>22.04</releaseinfo> 0037 <!-- Abstract about this handbook --> 0038 <abstract> 0039 <para>&okular; is a &kde; universal document viewer based on &kpdf; code.</para> 0040 </abstract> 0041 <keywordset> 0042 <keyword>KDE</keyword> 0043 <keyword>okular</keyword> 0044 <keyword>pdf</keyword> 0045 <keyword>ps</keyword> 0046 <keyword>postscript</keyword> 0047 <keyword>tiff</keyword> 0048 <keyword>djvu</keyword> 0049 <keyword>dvi</keyword> 0050 <keyword>chm</keyword> 0051 <keyword>xps</keyword> 0052 <keyword>comicbook</keyword> 0053 <keyword>fictionbook</keyword> 0054 <keyword>markdown</keyword> 0055 <keyword>mobipocket</keyword> 0056 <keyword>plucker</keyword> 0057 <keyword>annotation</keyword> 0058 </keywordset> 0059 </bookinfo> 0060 <chapter id="introduction"> 0061 <title>Introduction</title> 0062 <para>&okular; is a &kde; universal document viewer based on the code of the &kpdf; application. 0063 Although being based on &kpdf; code, &okular; has some unique features such as overview mode, 0064 improved presentation support and annotation support. 0065 </para> 0066 <para> 0067 &okular; supports a lot of different formats like &PDF;, &PostScript;, Tiff, CHM, DjVU, Images (png, jpg, &etc;) 0068 XPS, Fiction Books, Comic Book, Plucker, EPub, Fax and Markdown. 0069 For all supported formats and their features see <ulink url="https://okular.kde.org/formats.php"> 0070 &okular; Document Format Handlers</ulink>. 0071 </para> 0072 <screenshot> 0073 <screeninfo>&okular;s Main Window</screeninfo> 0074 <mediaobject> 0075 <imageobject> 0076 <imagedata fileref="mainwindow.png" format="PNG" /> 0077 </imageobject> 0078 <textobject> 0079 <phrase>&okular;s Main Window</phrase> 0080 </textobject> 0081 </mediaobject> 0082 </screenshot> 0083 </chapter> 0084 <chapter id="use"> 0085 <title>Basic Usage</title> 0086 <sect1 id="opening"> 0087 <title>Opening Files</title> 0088 <para> 0089 To open any supported file in &okular;, select <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem> 0090 </menuchoice>, choose a supported file in the dialog and click <guibutton>Open</guibutton>. 0091 Your file should now be displayed in the main window. 0092 </para> 0093 <important> 0094 <para> 0095 The new document will be opened in a new tab if the <guilabel>Open new files in tabs</guilabel> option on the <link linkend="configgeneral">General configuration page</link> is checked. 0096 </para> 0097 <para> 0098 You can close the tab by clicking with &MMB; on it. 0099 </para> 0100 <para> 0101 The previously closed document in a tab can be reopened using the <menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo></shortcut><guimenu>File</guimenu> <guimenuitem>Undo close tab</guimenuitem></menuchoice> menu item. 0102 </para> 0103 </important> 0104 <para> 0105 If you have already opened files in &okular; before, you can quickly access them by selecting them in 0106 the <menuchoice><guimenu>File</guimenu><guisubmenu>Open Recent</guisubmenu></menuchoice> menu. 0107 </para> 0108 <para>&okular; is the default &kde; application for &PDF; and &PostScript; files, launched when you click with the 0109 &LMB; on such a file type in the filemanager. If you want to open any file whose format is supported by &okular; 0110 use <menuchoice><guimenu>Open with...</guimenu><guimenuitem>&okular;</guimenuitem> </menuchoice> from context 0111 menu in the filemanager. 0112 </para> 0113 <para> 0114 After having a file opened you probably want to read it and therefore navigate through it. Go to the 0115 <link linkend="navigating">next section</link> to learn more about this. 0116 </para> 0117 </sect1> 0118 <sect1 id="navigating"> 0119 <title>Navigating</title> 0120 <para>This section describes how you can navigate through a document in &okular;.</para> 0121 <para> 0122 There are multiple ways of scrolling the viewing area. One is to use the &Up; and &Down; arrow keys. You may also use the scrollbar, your mousewheel or the &PgUp; and &PgDn; keys. 0123 </para> 0124 <para> 0125 You can also use <application>vim</application>-like navigation keys, namely <keycap>H</keycap> to move to the top of the previous page, <keycap>L</keycap> to move to the top of the next page, <keycap>J</keycap> to move one line down, and <keycap>K</keycap> to move one line up. 0126 </para> 0127 <para> 0128 Another way is to hold the &LMB; down at any place on the document while dragging the mouse in the 0129 opposite direction of where you want to move. This procedure only works if the Browse tool is 0130 enabled, which you can select by choosing <menuchoice><guimenu>Tools</guimenu> 0131 <guimenuitem>Browse</guimenuitem></menuchoice>. 0132 </para> 0133 <note> 0134 <para> 0135 When viewing a document in the <link linkend="presentationMode">Presentation mode</link> use &Up; and &Down; arrow keys to switch between pages or slides. The number and the position of the current slide will be shown in the overlay at the right upper corner of screen. 0136 </para> 0137 </note> 0138 <para>If you want to read a document with several pages use the automatic scrolling feature of &okular;. 0139 Start automatic scrolling with <keycombo action="simul">&Shift;&Down;</keycombo> or 0140 <keycombo action="simul">&Shift;&Up;</keycombo>. Then use these keys to increase and 0141 decrease the scrolling speed. You can start or stop automatic scrolling temporarily by pressing the &Shift; key; 0142 pressing any other key deactivates this feature. 0143 </para> 0144 <para>Another way to navigate through a document with several pages is to use the mouse pointer. Drag the page up or down, continue to drag even while reaching the bottom or top of the screen and behold. 0145 Once you cross the border of a page, the mouse cursor appears on top or bottom of the screen again and you can just continue to drag. 0146 </para> 0147 <para> 0148 The sidebar on the left side of the screen enables two more ways of navigating 0149 through a document: 0150 </para> 0151 <itemizedlist> 0152 <listitem> 0153 <para> 0154 If you click on a page thumbnail the viewing area will be brought to 0155 that page. 0156 </para> 0157 </listitem> 0158 <listitem> 0159 <para> 0160 If the document has a table of contents, clicking on a table 0161 of contents item will bring the document to the page linked to that 0162 item. 0163 </para> 0164 </listitem> 0165 <listitem> 0166 <para> 0167 If the document has layers, you can control the layers shown by checking or unchecking 0168 the items in the <guilabel>Layers</guilabel> list. 0169 </para> 0170 </listitem> 0171 <listitem> 0172 <para> 0173 If the document has bookmarks, enable the <guilabel>Bookmarks</guilabel> view 0174 and click them to go to the associated page. 0175 If bookmarks are not only shown for the current document, you can quickly 0176 switch to bookmarks in all recently opened files. 0177 </para> 0178 </listitem> 0179 <listitem> 0180 <para> 0181 If the document has annotations, enable the <guilabel>Annotations</guilabel> view 0182 and click the annotations or select them with the &Up; and &Down; arrow keys and press &Enter; to go to the associated page. 0183 </para> 0184 </listitem> 0185 </itemizedlist> 0186 <para> 0187 Some documents have links. In this case you can click on them and the view will 0188 change to the page it links to. If the link is to a web page or some 0189 other document the default &kde; handler for that format will be invoked. 0190 For example, clicking on a link pointing to <quote>https://www.kde.org</quote> 0191 will open the web page in the default &kde;'s web browser. 0192 </para> 0193 <important> 0194 <para> 0195 The document internal links work only when <link linkend="menutools">Browse Tool</link> is used. 0196 </para> 0197 </important> 0198 <para> 0199 Additionally, you may use the following functionality to quickly move to specific places 0200 in the document: 0201 </para> 0202 <itemizedlist> 0203 <listitem> 0204 <para> 0205 You can go to the beginning of the document using 0206 <keycombo action="simul">&Ctrl;<keycap>Home</keycap></keycombo> or 0207 using 0208 <menuchoice> 0209 <guimenu>Go</guimenu> 0210 <guimenuitem>Beginning of the document</guimenuitem> 0211 </menuchoice>. 0212 </para> 0213 </listitem> 0214 <listitem> 0215 <para> 0216 You can go to the end of the document using 0217 <keycombo action="simul">&Ctrl;<keycap>End</keycap></keycombo> or 0218 using 0219 <menuchoice> 0220 <guimenu>Go</guimenu> 0221 <guimenuitem>End of the document</guimenuitem> 0222 </menuchoice>. 0223 </para> 0224 </listitem> 0225 <listitem> 0226 <para> 0227 You can go forward in the document using &Space; or &PgDn;. 0228 To go to the next page of the document use the <guibutton>Next Page</guibutton> Toolbar 0229 button or 0230 <menuchoice> 0231 <guimenu>Go</guimenu> 0232 <guimenuitem>Next Page</guimenuitem> 0233 </menuchoice> in the menubar. 0234 </para> 0235 </listitem> 0236 <listitem> 0237 <para> 0238 You can go back in the document using &Backspace; or &PgUp;. 0239 To go to the previous page of the document use <guibutton>Previous Page</guibutton> Toolbar 0240 button or 0241 <menuchoice> 0242 <guimenu>Go</guimenu> 0243 <guimenuitem>Previous Page</guimenuitem> 0244 </menuchoice> in the menubar. 0245 </para> 0246 </listitem> 0247 <listitem> 0248 <para> 0249 You can go back to the positions in the document where you came from in a chronological order. 0250 Consider ⪚ reading the phrase <quote>As shown in [15], …</quote>, and you want 0251 to know quickly lookup reference [15]. So you click on it, and &okular; will jump to the list 0252 of references. Using <keycombo>&Alt;&Shift;&Left;</keycombo> or 0253 <menuchoice> 0254 <guimenu>Go</guimenu> 0255 <guimenuitem>Back</guimenuitem> 0256 </menuchoice> in the menubar will bring you back to exactly the position where you came from. 0257 </para> 0258 </listitem> 0259 <listitem> 0260 <para> 0261 You can go forward in the document after the jumping back as described above using 0262 <keycombo>&Alt;&Shift;&Right;</keycombo> or 0263 <menuchoice> 0264 <guimenu>Go</guimenu> 0265 <guimenuitem>Forward</guimenuitem> 0266 </menuchoice> in the menubar. 0267 </para> 0268 </listitem> 0269 <listitem> 0270 <para> 0271 You can go to the next match when searching using 0272 <keycap>F3</keycap> or &Enter; (when the focus is on <guilabel>Find</guilabel> text field) keys or 0273 <menuchoice> 0274 <guimenu>Edit</guimenu> 0275 <guimenuitem>Find Next</guimenuitem> 0276 </menuchoice> 0277 menu item or move back to the previous match using 0278 <keycombo>&Shift;<keysym>F3</keysym></keycombo> or <keycombo>&Shift;&Enter;</keycombo> (when the focus is on <guilabel>Find</guilabel> text field) keys or 0279 <menuchoice> 0280 <guimenu>Edit</guimenu> 0281 <guimenuitem>Find Previous</guimenuitem> 0282 </menuchoice> 0283 menu item. 0284 </para> 0285 </listitem> 0286 </itemizedlist> 0287 </sect1> 0288 <sect1 id="presentationMode"> 0289 <title>Presentation Mode</title> 0290 <para> 0291 The Presentation mode represents another way to view documents in &okular;. It can be 0292 enabled in 0293 <menuchoice><guimenu>View</guimenu><guimenuitem>Presentation</guimenuitem></menuchoice>. 0294 It shows the document on a page per page basis. The pages are shown with 0295 zoom to page, that means all the page is visible. 0296 </para> 0297 <note> 0298 <para> 0299 &PDF; documents can even specify that they are always opened in presentation mode. 0300 </para> 0301 </note> 0302 <para> 0303 When in presentation mode, you have an helper bar located on the top of the screen. Just move 0304 the mouse cursor to the top of the screen to make it appear. 0305 </para> 0306 <screenshot> 0307 <screeninfo>&okular; in Presentation Mode</screeninfo> 0308 <mediaobject> 0309 <imageobject> 0310 <imagedata fileref="presentation.png" format="PNG" /> 0311 </imageobject> 0312 <textobject> 0313 <phrase>&okular; in Presentation Mode</phrase> 0314 </textobject> 0315 </mediaobject> 0316 </screenshot> 0317 <para> 0318 To navigate between 0319 pages you may use the &LMB; (next page) and the &RMB; (previous page), the mouse 0320 wheel, the arrow icons or the line edit in the top bar, 0321 or the keys specified in the <link linkend="navigating">Navigating</link> 0322 section. 0323 </para> 0324 <para> 0325 Use <guilabel>Play/Pause</guilabel> button in the top bar to start playing presentation or pause it, correspondingly. 0326 </para> 0327 <para> 0328 You can exit presentation mode at any time by pressing the &Esc; key or clicking 0329 the <guiicon>Quit</guiicon> icon in the top bar. 0330 </para> 0331 <para> 0332 You can also draw on the current page with a pencil. Click on the 0333 <guilabel>Toggle Drawing Mode</guilabel> icon in the top bar to enable or disable the possibility 0334 to draw in the presentation mode. The drawings are cleared automatically when leaving the presentation 0335 mode. You can also click on the <guilabel>Erase Drawings</guilabel> icon to remove the 0336 drawings in the current page. 0337 </para> 0338 <para> 0339 The presentation mode has support for more than one screen in a multi-monitor configuration. 0340 With more than one screen a new button will appear in the top bar, with the icon of a screen: 0341 this is a drop down box that allows you to move the presentation to any of the other available screens. 0342 </para> 0343 <para> 0344 Presentation mode has some configuration options, you can find their 0345 description in the chapter <link linkend="configpresentation">Configuring &okular;</link>. 0346 </para> 0347 </sect1> 0348 <sect1 id="inverse_search"> 0349 0350 <title>Inverse Search between &latex; Editors and &okular;</title> 0351 0352 <para>Inverse search is a very useful feature when you are writing a &latex; document yourself. If everything is set up properly, you can 0353 click into &okular;'s window with the <mousebutton>left</mousebutton> mouse button while pressing &Shift;. After that editor loads the &latex; source file and jumps to 0354 the proper paragraph.</para> 0355 0356 <para>Inverse search cannot work unless:</para> 0357 0358 <itemizedlist> 0359 <listitem><para>The source file has been compiled successfully.</para></listitem> 0360 <listitem><para>&okular; knows which editor you would like to use.</para></listitem> 0361 <listitem><para>The Browse tool has to be enabled, which you can select by choosing 0362 <menuchoice><guimenu>Tools</guimenu><guimenuitem>Browse 0363 </guimenuitem></menuchoice>.</para></listitem> 0364 </itemizedlist> 0365 0366 <para>With this feature of &okular;, a left mouse click while pressing &Shift; in the &DVI; or &PDF; document will 0367 result in editor opening the corresponding &latex; document and attempt to go to the 0368 corresponding line. Remember to tell &okular; to use proper editor, in &okular;'s 0369 menu item <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Okular...</guimenuitem></menuchoice> 0370 (on the page <guimenuitem>Editor</guimenuitem>).</para> 0371 0372 <para>For more details on editor configuration please refer to the <link linkend="configeditor">corresponding section of this manual</link>.</para> 0373 0374 <screenshot> 0375 <screeninfo>Configuring &okular;</screeninfo> 0376 <mediaobject> 0377 <imageobject> 0378 <imagedata fileref="configure-editor.png" format="PNG" /> 0379 </imageobject> 0380 <textobject> 0381 <phrase>Configuring editor in &okular;</phrase> 0382 </textobject> 0383 <caption><para>Configuring editor in &okular;</para></caption> 0384 </mediaobject> 0385 </screenshot> 0386 </sect1> 0387 </chapter> 0388 0389 <chapter id="advanced"> 0390 <title>&okular; Advanced Features</title> 0391 <sect1 id="embedded-files"> 0392 <title>Embedded Files</title> 0393 <para> 0394 If the current document has some files embedded in it, when you open it a bar 0395 will appear above the page view to notify you about the embedded files. 0396 </para> 0397 <screenshot> 0398 <screeninfo>The embedded files bar</screeninfo> 0399 <mediaobject> 0400 <imageobject> 0401 <imagedata fileref="embedded-files-bar.png" format="PNG" /> 0402 </imageobject> 0403 <textobject> 0404 <phrase>The embedded files bar</phrase> 0405 </textobject> 0406 </mediaobject> 0407 </screenshot> 0408 <para> 0409 In this case, you can either click on the link in the text of the bar or choose 0410 <menuchoice><guimenu>File</guimenu><guimenuitem>Embedded Files</guimenuitem></menuchoice> 0411 to open the embedded files dialog. The dialog allows you to view the embedded files and 0412 to extract them. 0413 </para> 0414 </sect1> 0415 <sect1 id="forms"> 0416 <title>Forms</title> 0417 <para> 0418 If the current document has forms, when you open it a bar 0419 will appear above the page view where you can enable the forms. 0420 </para> 0421 <screenshot> 0422 <screeninfo>The forms bar</screeninfo> 0423 <mediaobject> 0424 <imageobject> 0425 <imagedata fileref="forms-bar.png" format="PNG" /> 0426 </imageobject> 0427 <textobject> 0428 <phrase>The forms bar</phrase> 0429 </textobject> 0430 </mediaobject> 0431 </screenshot> 0432 <para> 0433 In this case, you can either click on <guilabel>Show Forms</guilabel> in the bar or choose 0434 <menuchoice><guimenu>View</guimenu><guimenuitem>Show Forms</guimenuitem></menuchoice> 0435 to enter data into the form fields. 0436 </para> 0437 </sect1> 0438 <sect1 id="signatures"> 0439 <title>Signatures</title> 0440 <para> 0441 If the current document has signatures a bar 0442 will appear above the page view after the document opening. It allows you to open the <guilabel>Signatures</guilabel> panel. 0443 </para> 0444 <screenshot> 0445 <screeninfo>The signatures bar</screeninfo> 0446 <mediaobject> 0447 <imageobject> 0448 <imagedata fileref="signatures-bar.png" format="PNG" /> 0449 </imageobject> 0450 <textobject> 0451 <phrase>The signatures bar</phrase> 0452 </textobject> 0453 </mediaobject> 0454 </screenshot> 0455 <para> 0456 Using the <guilabel>Signatures</guilabel> panel you can inspect the document signature and its certificate. 0457 </para> 0458 <screenshot> 0459 <screeninfo>The signatures panel</screeninfo> 0460 <mediaobject> 0461 <imageobject> 0462 <imagedata fileref="signatures-panel.png" format="PNG" /> 0463 </imageobject> 0464 <textobject> 0465 <phrase>The signatures panel</phrase> 0466 </textobject> 0467 </mediaobject> 0468 </screenshot> 0469 <note> 0470 <para> 0471 This feature is available for &PDF; documents only. You need to install at least version 0.51 of <ulink url="https://poppler.freedesktop.org/">Poppler</ulink> to get most signature information, version 0.68 to get signature location/reason information, and version 0.73 to get signature certificate information. 0472 </para> 0473 </note> 0474 <sect2 id="adding_digital_signatures"> 0475 <title>Adding Digital Signatures</title> 0476 <para> 0477 You can add digital signatures to documents using the corresponding action in the <menuchoice><guimenu>Tools</guimenu></menuchoice> menu. 0478 </para> 0479 <para> 0480 To be able to sign a document you need to have a proper <acronym>PKCS</acronym> signing certificate available on your system. &okular; does not have the ability to create such certificates since they need to be issued by certificate authorities to be useful for validation, &etc; 0481 </para> 0482 <para> 0483 We use the Poppler library to handle signing of &PDF; documents and Poppler is using the NSS library to handle certificates. At the point of writing, Poppler will try to use one of the following NSS certificate stores in order (the first that exists): 0484 </para> 0485 <itemizedlist> 0486 <listitem><para>The current Firefox user certificate store.</para></listitem> 0487 <listitem><para>The system-wide <filename>/etc/pki/nssdb</filename> certificate store.</para></listitem> 0488 <listitem><para>The current user <filename>$HOME/.pki/nssdb</filename></para></listitem> 0489 </itemizedlist> 0490 <para> 0491 If you want to use a custom certificate store you can do so by setting it in the <link linkend="config-pdf-digital-signatures">&PDF; Backend Configuration</link> section of the <link linkend="configure-backends">Configure Backends...</link> dialog. 0492 </para> 0493 <note> 0494 <para> 0495 This feature is available for &PDF; documents only. You need to install at least version 21.01 of <ulink url="https://poppler.freedesktop.org/">Poppler</ulink> to be able to add digital signatures to a document. 0496 </para> 0497 </note> 0498 </sect2> 0499 </sect1> 0500 <sect1 id="annotations"> 0501 <title>Annotations</title> 0502 <para> 0503 &okular; allows you to review and annotate your documents. 0504 </para> 0505 <screenshot> 0506 <screeninfo>&okular;'s Annotations</screeninfo> 0507 <mediaobject> 0508 <imageobject> 0509 <imagedata fileref="annotations.png" format="PNG" /> 0510 </imageobject> 0511 <textobject> 0512 <phrase>&okular;'s Annotations</phrase> 0513 </textobject> 0514 </mediaobject> 0515 </screenshot> 0516 <para>&okular; has two different kind of annotations:</para> 0517 <para>Text annotations like <guilabel>Yellow Highlighter</guilabel> and <guilabel>Black Underlining</guilabel> 0518 can be used with files containing text (⪚ &PDF;).</para> 0519 <para>Graphic annotations like <guilabel>Pop-up Note</guilabel>, <guilabel>Inline Note</guilabel>, <guilabel>Freehand Line</guilabel>, <guilabel>Highlighter</guilabel>, <guilabel>Straight Line</guilabel>, <guilabel>Polygon</guilabel>, <guilabel>Stamp</guilabel>, <guilabel>Underline</guilabel>, <guilabel>Ellipse</guilabel>, and <guilabel>Typewriter</guilabel>.</para> 0520 <para>Graphic annotations are not limited to &PDF; files; they can be used for any format that &okular; supports.</para> 0521 <para>Using the <guilabel>Annotations</guilabel> menu, you can add a <guilabel>Pop up Note</guilabel> or any other kind of annotation to add or edit comments.</para> 0522 0523 <para> 0524 &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>Save As</guisubmenu></menuchoice> and selecting <guilabel>Okular document archive</guilabel> in the <guilabel>Filter</guilabel> selector. Documents saved this way will get <filename>.okular</filename> as their filename extension. To open an &okular; document archive, just open it with &okular; as it would be ⪚ a &PDF; document. 0525 </para> 0526 <para> 0527 You can <emphasis>also</emphasis> save annotations directly into &PDF; files. You can use <menuchoice><guimenu>File</guimenu> <guimenuitem>Save</guimenuitem></menuchoice> to save it over the current file or <menuchoice><guimenu>File</guimenu> <guimenuitem>Save As...</guimenuitem></menuchoice> to save it to a new file. 0528 </para> 0529 <note> 0530 <para> 0531 Note that adding, editing, or removing annotations may not be possible with DRM-enabled files. 0532 </para> 0533 </note> 0534 <note> 0535 <para> 0536 It is possible to <link linkend="edit-undo">undo</link> or <link linkend="edit-redo">redo</link> any annotation action by using the corresponding item from the <guimenu>Edit</guimenu> menu. It is also possible to undo the action by pressing <keycombo>&Ctrl;<keycap>Z</keycap></keycombo> and to redo a previously undone action by pressing <keycombo>&Ctrl;&Shift;<keycap>Z</keycap></keycombo>. 0537 </para> 0538 </note> 0539 <para> 0540 You can configure the default properties and appearance of each annotation tool. Please refer to the <link linkend="configannotations">corresponding section in this documentation</link>. 0541 </para> 0542 <sect2 id="annotations-add"> 0543 <title>Adding annotations</title> 0544 <para> 0545 To add annotations to the document, you can use <guilabel>Quick Annotations</guilabel> button on the main &okular; toolbar, or activate the annotation toolbar. 0546 This is done by either selecting 0547 <menuchoice><guimenu>Tools</guimenu><guimenuitem>Annotations</guimenuitem></menuchoice> or 0548 pressing <keycap>F6</keycap>. Once the annotation toolbar is shown, just press one of 0549 its buttons or use keyboard shortcuts (keys from <keycap>1</keycap> to <keycap>9</keycap>) to use that annotation. 0550 </para> 0551 <para> 0552 The annotation toolbar helps you to make annotations with drawings, shapes, and text messages. You can use the annotation toolbar to mark up a document (⪚ add lines, ellipses, polygons, stamps, highlights, underlines &etc;). The table below describes exactly what the default set of annotation toolbar buttons does. 0553 </para> 0554 <informaltable> 0555 <tgroup cols="3"> 0556 <thead> 0557 <row> 0558 <entry> 0559 Button 0560 </entry> 0561 <entry> 0562 Tool Name 0563 </entry> 0564 <entry> 0565 Description 0566 </entry> 0567 </row> 0568 </thead> 0569 <tbody> 0570 <row> 0571 <entry> 0572 <para> 0573 <inlinemediaobject> 0574 <imageobject> 0575 <imagedata fileref="tool-draw-highlight.png" format="PNG"/> 0576 </imageobject> 0577 </inlinemediaobject> 0578 </para> 0579 </entry> 0580 <entry> 0581 <para> 0582 Highlighter 0583 </para> 0584 </entry> 0585 <entry> 0586 <para> 0587 Highlights text in the document with a given background color. 0588 </para> 0589 <para> 0590 Click on the tool button, then click with the &LMB; and drag to highlight a text snippet. 0591 </para> 0592 <para> 0593 It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the highlighter. Just right-click on the highlighted text and select the <guimenuitem>Properties</guimenuitem> menu item. 0594 </para> 0595 </entry> 0596 </row> 0597 <row> 0598 <entry> 0599 <para> 0600 <inlinemediaobject> 0601 <imageobject> 0602 <imagedata fileref="tool-format-text-underline.png" format="PNG"/> 0603 </imageobject> 0604 </inlinemediaobject> 0605 </para> 0606 </entry> 0607 <entry> 0608 <para> 0609 Underline 0610 </para> 0611 </entry> 0612 <entry> 0613 <para> 0614 Underlines text with a straight line. 0615 </para> 0616 <para> 0617 Click on the tool button, then click with the &LMB; and drag to underline a text snippet. 0618 </para> 0619 <para> 0620 It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item. 0621 </para> 0622 </entry> 0623 </row> 0624 <row> 0625 <entry> 0626 <para> 0627 <inlinemediaobject> 0628 <imageobject> 0629 <imagedata fileref="tool-format-text-underline-squiggle.png" format="PNG"/> 0630 </imageobject> 0631 </inlinemediaobject> 0632 </para> 0633 </entry> 0634 <entry> 0635 <para> 0636 Squiggle 0637 </para> 0638 </entry> 0639 <entry> 0640 <para> 0641 Underlines text with a squiggly line. 0642 </para> 0643 <para> 0644 Click on the tool button, then click with the &LMB; and drag to squiggly underline a text snippet. 0645 </para> 0646 <para> 0647 It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item. 0648 </para> 0649 </entry> 0650 </row> 0651 <row> 0652 <entry> 0653 <para> 0654 <inlinemediaobject> 0655 <imageobject> 0656 <imagedata fileref="tool-format-text-strikethrough.png" format="PNG"/> 0657 </imageobject> 0658 </inlinemediaobject> 0659 </para> 0660 </entry> 0661 <entry> 0662 <para> 0663 Strike Out 0664 </para> 0665 </entry> 0666 <entry> 0667 <para> 0668 Strikes out some text. 0669 </para> 0670 <para> 0671 Click on the tool button, then click with the &LMB; and drag to squiggly strike out a text snippet. 0672 </para> 0673 <para> 0674 It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Highlight</guimenuitem>, <guimenuitem>Squiggle</guimenuitem>, <guimenuitem>Underline</guimenuitem> or <guimenuitem>Strike out</guimenuitem>), <guilabel>Color</guilabel>, and <guilabel>Opacity</guilabel> for the underline. Just right-click on the underlined text and select the <guimenuitem>Properties</guimenuitem> menu item. 0675 </para> 0676 </entry> 0677 </row> 0678 <row> 0679 <entry> 0680 <para> 0681 <inlinemediaobject> 0682 <imageobject> 0683 <imagedata fileref="tool-tool-text.png" format="PNG"/> 0684 </imageobject> 0685 </inlinemediaobject> 0686 </para> 0687 </entry> 0688 <entry> 0689 <para> 0690 Typewriter 0691 </para> 0692 </entry> 0693 <entry> 0694 <para> 0695 Adds text on a transparent background. This is useful for filling out forms lacking integrated editable text fields. 0696 </para> 0697 <para> 0698 Click on the tool button, then click with the &LMB; where you wish to add the top-left corner of the text, then drag to place the bottom-right one. Type some text, then click on the <guibutton>OK</guibutton> to save it, <guibutton>Clear</guibutton> to clear the text and start over, or <guibutton>Cancel</guibutton> to cancel. 0699 </para> 0700 <para> 0701 It is possible to define the <guilabel>Font</guilabel> and <guilabel>Text color</guilabel> for the text. Just right-click on the typewriter text created and select the <guimenuitem>Properties</guimenuitem> menu item. 0702 </para> 0703 </entry> 0704 </row> 0705 <row> 0706 <entry> 0707 <para> 0708 <inlinemediaobject> 0709 <imageobject> 0710 <imagedata fileref="tool-note.png" format="PNG"/> 0711 </imageobject> 0712 </inlinemediaobject> 0713 </para> 0714 </entry> 0715 <entry> 0716 <para> 0717 Inline Note 0718 </para> 0719 </entry> 0720 <entry> 0721 <para> 0722 Draws an inline note. The note will be shown inline as is. 0723 </para> 0724 <para> 0725 Click on the tool button, then click with the &LMB; where you wish to add the top-left corner of the note, then drag to place the bottom-right one. Enter the text of the note then click on the <guibutton>OK</guibutton> to save the note, <guibutton>Clear</guibutton> to clear the note's text, or <guibutton>Cancel</guibutton> to cancel note creation. 0726 </para> 0727 <para> 0728 It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Font</guilabel>, <guilabel>Align</guilabel>, and <guilabel>Border width</guilabel> for the note. Just right-click on the note icon created and select the <guimenuitem>Properties</guimenuitem> menu item. 0729 </para> 0730 </entry> 0731 </row> 0732 <row> 0733 <entry> 0734 <para> 0735 <inlinemediaobject> 0736 <imageobject> 0737 <imagedata fileref="tool-edit-comment.png" format="PNG"/> 0738 </imageobject> 0739 </inlinemediaobject> 0740 </para> 0741 </entry> 0742 <entry> 0743 <para> 0744 Pop-up Note 0745 </para> 0746 </entry> 0747 <entry> 0748 <para> 0749 Draws a multiline note. The note can be viewed by double clicking on the icon created in the document. 0750 </para> 0751 <para> 0752 Click on the tool button, then click on the place in the document where the pop-up note should be added. Enter the text of pop-up note then click on the <guilabel>Close this note</guilabel> button in the top right corner of the pop-up window. 0753 </para> 0754 <para> 0755 It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, and <guilabel>Icon</guilabel> for the note. Just right-click on the note icon created and select the <guimenuitem>Properties</guimenuitem> menu item. 0756 </para> 0757 </entry> 0758 </row> 0759 <row> 0760 <entry> 0761 <para> 0762 <inlinemediaobject> 0763 <imageobject> 0764 <imagedata fileref="tool-draw-freehand.png" format="PNG"/> 0765 </imageobject> 0766 </inlinemediaobject> 0767 </para> 0768 </entry> 0769 <entry> 0770 <para> 0771 Freehand Line 0772 </para> 0773 </entry> 0774 <entry> 0775 <para> 0776 Draws free-form lines. 0777 </para> 0778 <para> 0779 Click on the tool button, then click with the &LMB; and drag to draw the line. 0780 </para> 0781 <para> 0782 It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, and <guilabel>Width</guilabel> for the line. Just right-click on the line created and select the <guimenuitem>Properties</guimenuitem> menu item. 0783 </para> 0784 </entry> 0785 </row> 0786 <row> 0787 <entry> 0788 <para> 0789 <inlinemediaobject> 0790 <imageobject> 0791 <imagedata fileref="tool-draw-arrow.png" format="PNG"/> 0792 </imageobject> 0793 </inlinemediaobject> 0794 </para> 0795 </entry> 0796 <entry> 0797 <para> 0798 Arrow (drop-down list) 0799 </para> 0800 </entry> 0801 <entry> 0802 <para> 0803 Draws an arrow between two points. 0804 </para> 0805 <para> 0806 Click on the tool button, then click with the &LMB; to place the starting point of the arrow, then drag to place the ending point of the line and click once more. 0807 </para> 0808 <para> 0809 It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Width</guilabel>, <guilabel>Line start</guilabel>, <guilabel>Line end</guilabel>, <guilabel>Leader line length</guilabel>, and <guilabel>Leader line extension length</guilabel> for the line. Just right-click on the line created and select the <guimenuitem>Properties</guimenuitem> menu item. 0810 </para> 0811 </entry> 0812 </row> 0813 <row> 0814 <entry> 0815 <para> 0816 <inlinemediaobject> 0817 <imageobject> 0818 <imagedata fileref="tool-draw-line.png" format="PNG"/> 0819 </imageobject> 0820 </inlinemediaobject> 0821 </para> 0822 </entry> 0823 <entry> 0824 <para> 0825 Straight line (drop-down list) 0826 </para> 0827 </entry> 0828 <entry> 0829 <para> 0830 Draws a line between two points. 0831 </para> 0832 <para> 0833 Click on the tool button, then click with the &LMB; to place the starting point of the line, then drag to place the ending point of the line and click once more. 0834 </para> 0835 <para> 0836 It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Width</guilabel>, <guilabel>Line start</guilabel>, <guilabel>Line end</guilabel>, <guilabel>Leader line length</guilabel>, and <guilabel>Leader line extension length</guilabel> for the line. Just right-click on the line created and select the <guimenuitem>Properties</guimenuitem> menu item. 0837 </para> 0838 </entry> 0839 </row> 0840 <row> 0841 <entry> 0842 <para> 0843 <inlinemediaobject> 0844 <imageobject> 0845 <imagedata fileref="tool-draw-rectangle.png" format="PNG"/> 0846 </imageobject> 0847 </inlinemediaobject> 0848 </para> 0849 </entry> 0850 <entry> 0851 <para> 0852 Rectangle (drop-down list) 0853 </para> 0854 </entry> 0855 <entry> 0856 <para> 0857 Draws a rectangle around the chosen area. 0858 </para> 0859 <para> 0860 Click on the tool button, then click with the &LMB; to place the top-left corner of the rectangle, then drag to place the bottom-right one. 0861 </para> 0862 <para> 0863 It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Rectangle</guimenuitem> or <guimenuitem>Ellipse</guimenuitem>), <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Shape fill</guilabel> (and its color), and <guilabel>Width</guilabel> for the border. Just right-click on the border created and select the <guimenuitem>Properties</guimenuitem> menu item. 0864 </para> 0865 </entry> 0866 </row> 0867 <row> 0868 <entry> 0869 <para> 0870 <inlinemediaobject> 0871 <imageobject> 0872 <imagedata fileref="tool-draw-ellipse.png" format="PNG"/> 0873 </imageobject> 0874 </inlinemediaobject> 0875 </para> 0876 </entry> 0877 <entry> 0878 <para> 0879 Ellipse (drop-down list) 0880 </para> 0881 </entry> 0882 <entry> 0883 <para> 0884 Draws an ellipse or rectangle around a chosen area. 0885 </para> 0886 <para> 0887 Click on the tool button, then click with the &LMB; and hold to place the top-left corner of the circumscribed rectangle for the ellipse, then drag to place the bottom-right one. 0888 </para> 0889 <para> 0890 It is possible to define the <guilabel>Type</guilabel> (<guimenuitem>Rectangle</guimenuitem> or <guimenuitem>Ellipse</guimenuitem>), <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Shape fill</guilabel> (and its color), and <guilabel>Width</guilabel> for the border. Just right-click on the border created and select the <guimenuitem>Properties</guimenuitem> menu item. 0891 </para> 0892 </entry> 0893 </row> 0894 <row> 0895 <entry> 0896 <para> 0897 <inlinemediaobject> 0898 <imageobject> 0899 <imagedata fileref="tool-draw-polyline.png" format="PNG"/> 0900 </imageobject> 0901 </inlinemediaobject> 0902 </para> 0903 </entry> 0904 <entry> 0905 <para> 0906 Polygon (drop-down list) 0907 </para> 0908 </entry> 0909 <entry> 0910 <para> 0911 Draws a closed shape from three or more line segments. The corresponding note can be viewed by double clicking inside the polygon. 0912 </para> 0913 <para> 0914 Click on the tool button, then click with the &LMB; to place the first vertex of the polygon, then drag to place of the second vertex. Proceed until you have drawn the whole polygon and connected back up with the first vertex. Click twice to add a note to the polygon. Enter the text of the note then click on the <guibutton>OK</guibutton> to save the note, <guibutton>Clear</guibutton> to clear the note, or <guibutton>Cancel</guibutton> to cancel note entry. 0915 </para> 0916 <para> 0917 It is possible to define the <guilabel>Color</guilabel>, <guilabel>Opacity</guilabel>, <guilabel>Shape fill</guilabel> (and its color), and <guilabel>Width</guilabel> for the polygon. Just right-click on the polygon created and select the <guimenuitem>Properties</guimenuitem> menu item. 0918 </para> 0919 </entry> 0920 </row> 0921 <row> 0922 <entry> 0923 <para> 0924 <inlinemediaobject> 0925 <imageobject> 0926 <imagedata fileref="tool-tag.png" format="PNG"/> 0927 </imageobject> 0928 </inlinemediaobject> 0929 </para> 0930 </entry> 0931 <entry> 0932 <para> 0933 Stamp 0934 </para> 0935 </entry> 0936 <entry> 0937 <para> 0938 Inserts a pre-defined shape into the document. 0939 </para> 0940 <para> 0941 Click on the tool button to choose the stamp from the drop-down list then click with the &LMB; to place the stamp. 0942 </para> 0943 <para> 0944 A single click just places a square stamp (useful for icons). 0945 To add a rectangular stamp you can click with the &LMB; and hold to place the top-left point, then drag to place the bottom-right one. 0946 </para> 0947 <para> 0948 It is possible to define the <guilabel>Opacity</guilabel> and <guilabel>Stamp symbol</guilabel> for the stamp. Just right-click on the stamp icon created and select the <guimenuitem>Properties</guimenuitem> menu item. 0949 </para> 0950 <warning> 0951 <para> 0952 This feature is experimental. Custom stamps inserted in &PDF; documents are not visible in &PDF; readers other than &okular;. 0953 </para> 0954 </warning> 0955 </entry> 0956 </row> 0957 </tbody> 0958 </tgroup> 0959 </informaltable> 0960 <para>These are the default annotations provided by &okular;. Using the <link linkend="configannotations">Annotations page</link> of the configuration dialog 0961 you can add your own annotations like custom stamps, text markup or a geometrical shape with inner color to highlight regions &etc; 0962 </para> 0963 <note> 0964 <para> 0965 It is possible to add &latex; code into the text of annotations. To do so, add <userinput>$$<replaceable>code</replaceable>$$</userinput> into the text of annotation, where <replaceable>code</replaceable> is any valid &latex; equation. Follow the instructions that will appear on the screen to render it using a &latex; distribution installed in your system. 0966 </para> 0967 </note> 0968 <para> 0969 It is possible to configure the selected tool using the annotation toolbar itself: 0970 </para> 0971 <informaltable> 0972 <tgroup cols="3"> 0973 <thead> 0974 <row> 0975 <entry> 0976 Button 0977 </entry> 0978 <entry> 0979 Option Name 0980 </entry> 0981 <entry> 0982 Description 0983 </entry> 0984 </row> 0985 </thead> 0986 <tbody> 0987 <row> 0988 <entry> 0989 <para> 0990 <inlinemediaobject> 0991 <imageobject> 0992 <imagedata fileref="tool-edit-line-width.png" format="PNG"/> 0993 </imageobject> 0994 </inlinemediaobject> 0995 </para> 0996 </entry> 0997 <entry> 0998 <para> 0999 Line width 1000 </para> 1001 </entry> 1002 <entry> 1003 <para> 1004 Click on this button to choose the width from the drop-down list. 1005 </para> 1006 </entry> 1007 </row> 1008 <row> 1009 <entry> 1010 <para> 1011 <inlinemediaobject> 1012 <imageobject> 1013 <imagedata fileref="tool-format-text-color.png" format="PNG"/> 1014 </imageobject> 1015 </inlinemediaobject> 1016 / 1017 <inlinemediaobject> 1018 <imageobject> 1019 <imagedata fileref="tool-bordertool.png" format="PNG"/> 1020 </imageobject> 1021 </inlinemediaobject> 1022 </para> 1023 </entry> 1024 <entry> 1025 <para> 1026 Annotation color 1027 </para> 1028 </entry> 1029 <entry> 1030 <para> 1031 Click on this button to choose the color of the text or border of your annotation. You can chose one of the predefined colors or click on the <guimenuitem>Custom Color...</guimenuitem> item to open the color selection dialog. 1032 </para> 1033 </entry> 1034 </row> 1035 <row> 1036 <entry> 1037 <para> 1038 <inlinemediaobject> 1039 <imageobject> 1040 <imagedata fileref="tool-fill-color.png" format="PNG"/> 1041 </imageobject> 1042 </inlinemediaobject> 1043 </para> 1044 </entry> 1045 <entry> 1046 <para> 1047 Annotation fill color 1048 </para> 1049 </entry> 1050 <entry> 1051 <para> 1052 Click on this button to choose the fill color of your annotation. You can chose one of the predefined colors or click on the <guimenuitem>Custom Color...</guimenuitem> item to open the color selection dialog. 1053 </para> 1054 </entry> 1055 </row> 1056 <row> 1057 <entry> 1058 <para> 1059 <inlinemediaobject> 1060 <imageobject> 1061 <imagedata fileref="tool-edit-opacity.png" format="PNG"/> 1062 </imageobject> 1063 </inlinemediaobject> 1064 </para> 1065 </entry> 1066 <entry> 1067 <para> 1068 Annotation opacity 1069 </para> 1070 </entry> 1071 <entry> 1072 <para> 1073 Click on this button to choose the opacity of your annotation from the drop-down list (<guimenuitem>100%</guimenuitem> creates opaque annotations). 1074 </para> 1075 </entry> 1076 </row> 1077 <row> 1078 <entry> 1079 <para> 1080 <inlinemediaobject> 1081 <imageobject> 1082 <imagedata fileref="tool-font-face.png" format="PNG"/> 1083 </imageobject> 1084 </inlinemediaobject> 1085 </para> 1086 </entry> 1087 <entry> 1088 <para> 1089 Annotation font 1090 </para> 1091 </entry> 1092 <entry> 1093 <para> 1094 Click on this button to open the font selection dialog. 1095 </para> 1096 </entry> 1097 </row> 1098 <row> 1099 <entry> 1100 <para> 1101 <inlinemediaobject> 1102 <imageobject> 1103 <imagedata fileref="tool-settings-configure.png" format="PNG"/> 1104 </imageobject> 1105 </inlinemediaobject> 1106 </para> 1107 </entry> 1108 <entry> 1109 <para> 1110 Advanced settings for the current annotation tool 1111 </para> 1112 </entry> 1113 <entry> 1114 <para> 1115 Click on this button to open the general configuration dialog for your annotation. 1116 </para> 1117 </entry> 1118 </row> 1119 </tbody> 1120 </tgroup> 1121 </informaltable> 1122 <para> 1123 There are three additional utility buttons on the annotation toolbar: 1124 </para> 1125 <informaltable> 1126 <tgroup cols="2"> 1127 <thead> 1128 <row> 1129 <entry> 1130 Button 1131 </entry> 1132 <entry> 1133 Description 1134 </entry> 1135 </row> 1136 </thead> 1137 <tbody> 1138 <row> 1139 <entry> 1140 <para> 1141 <inlinemediaobject> 1142 <imageobject> 1143 <imagedata fileref="tool-favorite.png" format="PNG"/> 1144 </imageobject> 1145 </inlinemediaobject> 1146 </para> 1147 </entry> 1148 <entry> 1149 <para> 1150 Add the current annotation to the <guilabel>Quick Annotations</guilabel> menu on the main toolbar. 1151 </para> 1152 <note> 1153 <para> 1154 You can use the default shortcuts from <keycombo action="simul">&Alt;<keycap>9</keycap></keycombo> to <keycombo action="simul">&Alt;<keycap>0</keycap></keycombo> to select the quick annotation actions any time you like, even with the annotation toolbar hidden. 1155 </para> 1156 </note> 1157 </entry> 1158 </row> 1159 <row> 1160 <entry> 1161 <para> 1162 <inlinemediaobject> 1163 <imageobject> 1164 <imagedata fileref="tool-window-pin.png" format="PNG"/> 1165 </imageobject> 1166 </inlinemediaobject> 1167 </para> 1168 </entry> 1169 <entry> 1170 <para> 1171 When checked, keep the current annotation tool active after use. 1172 </para> 1173 </entry> 1174 </row> 1175 <row> 1176 <entry> 1177 <para> 1178 <inlinemediaobject> 1179 <imageobject> 1180 <imagedata fileref="tool-dialog-close.png" format="PNG"/> 1181 </imageobject> 1182 </inlinemediaobject> 1183 </para> 1184 </entry> 1185 <entry> 1186 <para> 1187 Hide the annotation toolbar. 1188 </para> 1189 </entry> 1190 </row> 1191 </tbody> 1192 </tgroup> 1193 </informaltable> 1194 <para> 1195 By pressing &Shift; you can constrain the angle of line and polygon annotations to 15° steps, and the ratio of shape annotations (⪚ Rectangle, Ellipse) to 1:1. You can also get a toolbar button from <ulink url="help:/fundamentals/config.html#toolbars">Configure Toolbars...</ulink>. 1196 </para> 1197 <para> 1198 The contents of the <guilabel>Quick Annotations</guilabel> menu can be configured using the <link linkend="configannotations">Annotations page of &okular; configuration dialog</link>. This page can be opened by clicking <guilabel>Quick Annotations</guilabel> button, then choosing <guimenuitem>Configure Annotations...</guimenuitem> from the pop-up menu. 1199 </para> 1200 <note> 1201 <para> 1202 Activating the annotation toolbar will automatically switch to Browse Mode. 1203 </para> 1204 </note> 1205 <para> 1206 You can stop annotating any time by pressing the button of the 1207 annotation you are using again, or by pressing the &Esc; key. 1208 </para> 1209 <para> 1210 The newly created annotation will have the author you set in the 1211 <link linkend="configannotations"><guilabel>Annotations</guilabel> page</link> in &okular;s 1212 configuration dialog as its author. The <guilabel>Annotations</guilabel> page can also be used to configure the content of the annotations toolbar. 1213 </para> 1214 </sect2> 1215 <sect2 id="annotations-remove"> 1216 <title>Removing annotations</title> 1217 <para> 1218 To remove an annotation, first select the Browse tool (<menuchoice><guimenu>Tools</guimenu><guimenuitem>Browse</guimenuitem></menuchoice>) then just click on it with the &RMB;, and select 1219 <guimenuitem>Delete</guimenuitem> or select an annotation using the &LMB; and press the ∇ key. 1220 </para> 1221 <para> 1222 When removing the annotation, its window will be closed if it is open. 1223 </para> 1224 </sect2> 1225 <sect2 id="annotations-edit"> 1226 <title>Editing annotations</title> 1227 <para> 1228 To edit an annotation, first select the Browse tool (<menuchoice><guimenu>Tools</guimenu><guimenuitem>Browse</guimenuitem></menuchoice>) then click on an annotation with the &RMB; and select 1229 <guimenuitem>Properties</guimenuitem>. A dialog will appear with the general 1230 annotation settings (like color and opacity, author, &etc;) and the settings specific 1231 to that annotation type. 1232 </para> 1233 <screenshot> 1234 <screeninfo>Annotation Property Dialog</screeninfo> 1235 <mediaobject> 1236 <imageobject> 1237 <imagedata fileref="annotation-properties.png" format="PNG" /> 1238 </imageobject> 1239 <textobject> 1240 <phrase>Annotation Property Dialog</phrase> 1241 </textobject> 1242 </mediaobject> 1243 </screenshot> 1244 <para> 1245 To move an annotation, hold down the &Ctrl; key, move the mouse pointer on it and 1246 then start dragging with the &LMB;. 1247 </para> 1248 <para>If you click with the &LMB; on an annotation, it gets selected. Resize handles appear on the 1249 selection rectangle. When the cursor is moved over one of the 8 resize handles on 1250 the corners or edges, the cursor shape changes to indicate the resize mode. Click anywhere 1251 else on the annotation to move it. 1252 Pressing &Esc; or clicking an area outside the annotation cancels a selection. 1253 </para> 1254 <para>Resizing is only available for the Inline Note, Typewriter, Stamp and Ellipse annotation types.</para> 1255 1256 <note> 1257 <para> 1258 Some options may be disabled depending on the document's permissions (this typically only affects some &PDF; documents). 1259 </para> 1260 </note> 1261 </sect2> 1262 </sect1> 1263 <sect1 id="bookmark-management"> 1264 <title>Bookmark Management</title> 1265 <para> 1266 &okular; has a very flexible bookmark system. &okular; saves the position on the page in bookmark and allows you to define more than one bookmark per page. 1267 </para> 1268 <para> 1269 To manage bookmarks in &okular; you can use <guilabel>Bookmarks</guilabel> view from <guilabel>Sidebar</guilabel>, <link linkend="menubookmarks">Bookmarks menu</link> or context menu of document view (click with &RMB; to open it). 1270 </para> 1271 <sect2 id="bookmarks-view"> 1272 <title>Bookmarks view</title> 1273 <para> 1274 To open <guilabel>Bookmarks</guilabel> view, click on the <guilabel>Bookmarks</guilabel> tab at the top of the <guilabel>Sidebar</guilabel>. If the <guilabel>Sidebar</guilabel> is not shown, click the <guibutton>Show Sidebar</guibutton> button on the toolbar or the menu item, or the <menuchoice><shortcut><keycap>F7</keycap></shortcut> <guimenu>Settings</guimenu><guimenuitem>Show Sidebar</guimenuitem></menuchoice> menu item to make it visible. 1275 </para> 1276 <screenshot> 1277 <screeninfo>Bookmark view context menu</screeninfo> 1278 <mediaobject> 1279 <imageobject> 1280 <imagedata fileref="bookmark-management.png" format="PNG" /> 1281 </imageobject> 1282 <textobject> 1283 <phrase>Bookmark view context menu</phrase> 1284 </textobject> 1285 </mediaobject> 1286 </screenshot> 1287 <para> 1288 The <guilabel>Show for all documents</guilabel> checkbox can be unchecked to show only the bookmarks from the current document. 1289 </para> 1290 <para> 1291 The filter bar at the top of <guilabel>Bookmarks</guilabel> view can be used to filter the content of bookmark list pane according to the text in the box. 1292 </para> 1293 <para> 1294 The list pane permits to view the bookmark list in a tree-like fashion: each document in the list can be <quote>expanded</quote> or <quote>collapsed</quote> by clicking on the <guiicon><</guiicon> or <guiicon>v</guiicon> icon next to it. 1295 </para> 1296 <para> 1297 Right-click menu of document item can be used to open document, rename its item or remove it from the list. Remember that the removal of a document item leads to the removal of all bookmarks in the corresponding document. 1298 </para> 1299 <para> 1300 Right-click menus of individual bookmark items allow you to go to the bookmark, rename or remove it. 1301 </para> 1302 <para> 1303 The Right-click menu of items in the table of contents can be used to create bookmarks or go to the next or previous bookmark. 1304 </para> 1305 </sect2> 1306 </sect1> 1307 <!-- Please keep this section content in sync with man page (man-okular.1.docbook) --> 1308 <sect1 id="command-line-options"> 1309 <title>Command Line Options</title> 1310 <para> 1311 Though &okular; may most often be started from the &kde; program menu, or a desktop icon, it can also be opened at the command line prompt of a terminal window. There are a few useful options that are available when doing this. 1312 </para> 1313 <sect2 id="specify-a-file"> 1314 <title>Specify a File</title> 1315 <para> 1316 By specifying the path and name of a particular file the user can have &okular; open that file immediately upon startup. This option might look something like the following: 1317 </para> 1318 <informalexample><screen><prompt>%</prompt> <userinput><command>okular</command> <option><replaceable>/home/myhome/docs/mydoc.pdf</replaceable></option> </userinput> </screen> 1319 </informalexample> 1320 <note> 1321 <para> 1322 For &PDF; documents, the name can be given as <replaceable>document_name</replaceable>#<replaceable>named_destination</replaceable> where <replaceable>named_destination</replaceable> is a particular named destination embedded in the document. 1323 </para> 1324 </note> 1325 </sect2> 1326 <sect2 id="other-command-line-options"> 1327 <title>Other Command Line Options</title> 1328 <para> 1329 The following command line help options are available 1330 </para> 1331 <variablelist> 1332 <varlistentry> 1333 <term><userinput><command>okular</command> 1334 <option>-p --page <replaceable>number</replaceable></option></userinput></term> 1335 <listitem><para>Open a page with a given number in the document. Also available through <userinput><command>okular</command> <option>-p <replaceable>number</replaceable></option></userinput></para></listitem> 1336 </varlistentry> 1337 <varlistentry> 1338 <term><userinput><command>okular</command> 1339 <option>--presentation</option></userinput></term> 1340 <listitem><para>Start the document in presentation mode.</para></listitem> 1341 </varlistentry> 1342 <varlistentry> 1343 <term><userinput><command>okular</command> 1344 <option>--print</option></userinput></term> 1345 <listitem><para>Start with print dialog.</para></listitem> 1346 </varlistentry> 1347 <varlistentry> 1348 <term><userinput><command>okular</command> 1349 <option>--print-and-exit</option></userinput></term> 1350 <listitem><para>Start with print dialog and exit after printing.</para></listitem> 1351 </varlistentry> 1352 <varlistentry> 1353 <term><userinput><command>okular</command> 1354 <option>--unique</option></userinput></term> 1355 <listitem><para>Unique instance control.</para></listitem> 1356 </varlistentry> 1357 <varlistentry> 1358 <term><userinput><command>okular</command> 1359 <option>--noraise</option></userinput></term> 1360 <listitem><para>Allows to prevent &okular; window raising after the start.</para></listitem> 1361 </varlistentry> 1362 <varlistentry> 1363 <term><userinput><command>okular</command> 1364 <option>--find <replaceable>string</replaceable></option></userinput></term> 1365 <listitem><para>Tries to find and highlight a given string in the document. Only works if just one document is given as an argument of the <userinput><command>okular</command></userinput> command.</para></listitem> 1366 </varlistentry> 1367 <varlistentry> 1368 <term><userinput><command>okular</command> 1369 <option>--editor-cmd <replaceable>string</replaceable></option></userinput></term> 1370 <listitem><para>Sets the external editor command. You cannot set the editor command in an already running &okular; instance. Please note that <option>--unique</option> is not supported when setting the editor command at the commandline.</para></listitem> 1371 </varlistentry> 1372 </variablelist> 1373 </sect2> 1374 </sect1> 1375 <sect1 id="fit-window-to-page"> 1376 <title>Fit window to page</title> 1377 <para> 1378 The Fit window to page feature resizes the window so that it is exactly the same size as the page at the current zoom factor. 1379 If the page doesn't completely fit on the screen, the window is enlarged so that the largest possible part of the page is shown. 1380 </para> 1381 <para> 1382 This feature can be accessed by using the keyboard shortcut <keycombo action="simul">&Ctrl;<keycap>J</keycap></keycombo>. 1383 </para> 1384 </sect1> 1385 </chapter> 1386 1387 <chapter id="primary-menu-items"> 1388 <title>The Menubar</title> 1389 1390 <sect1 id="menufile"> 1391 <title>The File Menu</title> 1392 <variablelist> 1393 <varlistentry> 1394 <term> 1395 <menuchoice> 1396 <shortcut> 1397 <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> 1398 </shortcut> 1399 <guimenu>File</guimenu> 1400 <guimenuitem>Open...</guimenuitem> 1401 </menuchoice> 1402 </term> 1403 <listitem> 1404 <para> 1405 <action>Open</action> a supported file or &okular; document 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>. 1406 </para> 1407 </listitem> 1408 </varlistentry> 1409 1410 <varlistentry> 1411 <term> 1412 <menuchoice> 1413 <guimenu>File</guimenu> 1414 <guisubmenu>Open Recent</guisubmenu> 1415 </menuchoice> 1416 </term> 1417 <listitem> 1418 <para> 1419 <action>Open</action> a file which was used previously from a 1420 submenu. If a file is currently being displayed it 1421 will be closed. For more information, see the section about 1422 <link linkend="opening">Opening Files</link>. 1423 </para> 1424 </listitem> 1425 </varlistentry> 1426 <!-- 1427 <varlistentry> 1428 <term> 1429 <menuchoice> 1430 <shortcut><keycap>G</keycap></shortcut> 1431 <guimenu>File</guimenu> 1432 <guimenuitem>Get Books From Internet...</guimenuitem> 1433 </menuchoice> 1434 </term> 1435 <listitem> 1436 <para>to be written</para> 1437 </listitem> 1438 </varlistentry> 1439 <--> 1440 <varlistentry> 1441 <term> 1442 <menuchoice> 1443 <guimenu>File</guimenu> 1444 <guimenuitem>Import PostScript as &PDF;...</guimenuitem> 1445 </menuchoice> 1446 </term> 1447 <listitem> 1448 <para> 1449 <action>Open</action> a &PostScript; file and convert it to &PDF;. 1450 </para> 1451 </listitem> 1452 </varlistentry> 1453 1454 <varlistentry> 1455 <term> 1456 <menuchoice> 1457 <shortcut> 1458 <keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo> 1459 </shortcut> 1460 <guimenu>File</guimenu> 1461 <guimenuitem>Undo close tab</guimenuitem> 1462 </menuchoice> 1463 </term> 1464 <listitem> 1465 <para> 1466 <action>Reopen</action> the last closed document. This action is active only if you have closed some document in tab during the current session. 1467 </para> 1468 </listitem> 1469 </varlistentry> 1470 1471 <varlistentry> 1472 <term> 1473 <menuchoice> 1474 <guimenu>File</guimenu> 1475 <guimenuitem>Open Containing Folder</guimenuitem> 1476 </menuchoice> 1477 </term> 1478 <listitem> 1479 <para> 1480 <action>Open</action> folder that contains the current document in your favorite file manager. This action is especially useful for the case when you have downloaded a &PDF; file from the internet that opens itself in &okular;. The location of this file may not be clear or easy to find without this feature. 1481 </para> 1482 </listitem> 1483 </varlistentry> 1484 1485 <varlistentry> 1486 <term> 1487 <menuchoice> 1488 <shortcut> 1489 <keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> 1490 </shortcut> 1491 <guimenu>File</guimenu> 1492 <guimenuitem>Save</guimenuitem> 1493 </menuchoice> 1494 </term> 1495 <listitem> 1496 <para><action>Saves</action> the document including all the changes (annotations, form contents, &etc;), provided the document backend supports saving those changes. If the backend does not support saving the changes, the user will be given the option to either discard or to save them together with the document in an &okular; document archive.</para> 1497 </listitem> 1498 </varlistentry> 1499 1500 <varlistentry> 1501 <term> 1502 <menuchoice> 1503 <shortcut> 1504 <keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo> 1505 </shortcut> 1506 <guimenu>File</guimenu> 1507 <guimenuitem>Save As...</guimenuitem> 1508 </menuchoice> 1509 </term> 1510 <listitem> 1511 <para><action>Saves</action> the document under a new name including all the changes (annotations, form contents, &etc;), provided the document backend supports saving changes. If the backend does not support saving the changes, the user will be given the option to either discard or to save them together with the document in an &okular; document archive.</para> 1512 <note> 1513 <para> 1514 Note that, due to the way this is implemented, even if there are no changes to the file, the new file need not to be an exact bit-for-bit copy of the original file (⪚ can have a different SHA-1 hash, &etc;). 1515 </para> 1516 </note> 1517 </listitem> 1518 </varlistentry> 1519 1520 <varlistentry> 1521 <term> 1522 <menuchoice> 1523 <shortcut><keycap>F5</keycap></shortcut> 1524 <guimenu>File</guimenu> 1525 <guimenuitem>Reload</guimenuitem> 1526 </menuchoice> 1527 </term> 1528 <listitem> 1529 <para><action>Reload</action> the currently open file.</para> 1530 </listitem> 1531 </varlistentry> 1532 1533 <varlistentry> 1534 <term> 1535 <menuchoice> 1536 <shortcut><keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut> 1537 <guimenu>File</guimenu> 1538 <guimenuitem>Print...</guimenuitem> 1539 </menuchoice> 1540 </term> 1541 <listitem> 1542 <para> 1543 <action>Print</action> the currently displayed document. Please take into account that &okular; has some specific options for printing &PDF; which are available via pressing the <guibutton>Options >></guibutton> button then choosing the <guilabel>&PDF; Options</guilabel>. Use these options to print your annotations or configure rasterization mode if you have problems with printing some symbols or need to change the scale mode. 1544 </para> 1545 <note> 1546 <para> 1547 The scale mode options are only available when you check the <guilabel>Force rasterization</guilabel> option. 1548 </para> 1549 </note> 1550 </listitem> 1551 </varlistentry> 1552 1553 <varlistentry> 1554 <term> 1555 <menuchoice> 1556 <guimenu>File</guimenu> 1557 <guimenuitem>Print Preview...</guimenuitem> 1558 </menuchoice> 1559 </term> 1560 <listitem> 1561 <para> 1562 <action>Show a preview</action> of how the currently displayed 1563 document would be printed with the default options. 1564 </para> 1565 </listitem> 1566 </varlistentry> 1567 1568 <varlistentry> 1569 <term> 1570 <menuchoice> 1571 <shortcut><keycombo action="simul">&Alt;<keycap>Return</keycap></keycombo></shortcut> 1572 <guimenu>File</guimenu> 1573 <guimenuitem>Properties</guimenuitem> 1574 </menuchoice> 1575 </term> 1576 <listitem> 1577 <para><action>Display some basic information</action> about the document, such as 1578 title, author, creation date, and details about the fonts used. The available information 1579 depends on the type of document.</para> 1580 <note> 1581 <para>Please pay attention on the information about substituting font in the <guilabel>Fonts</guilabel> tab of the <guilabel>Properties</guilabel> dialog. Many problems with font rendering can be solved by installing of the substituted fonts.</para> 1582 </note> 1583 </listitem> 1584 </varlistentry> 1585 <varlistentry> 1586 <term> 1587 <menuchoice> 1588 <guimenu>File</guimenu> 1589 <guimenuitem>Embedded Files...</guimenuitem> 1590 </menuchoice> 1591 </term> 1592 <listitem> 1593 <para><action>Show the files embedded</action> in the document, if the document has any. 1594 For more information, see the section about the 1595 <link linkend="embedded-files">Embedded Files</link>.</para> 1596 </listitem> 1597 </varlistentry> 1598 1599 <varlistentry> 1600 <term> 1601 <menuchoice> 1602 <guimenu>File</guimenu> 1603 <guisubmenu>Export As</guisubmenu> 1604 </menuchoice> 1605 </term> 1606 <listitem> 1607 <para>This item contains the export formats the current document can be exported to. 1608 The first entry for all kind of documents is always <guimenuitem>Plain Text...</guimenuitem>.</para> 1609 <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> 1610 </listitem> 1611 </varlistentry> 1612 1613 <varlistentry> 1614 <term> 1615 <menuchoice> 1616 <guimenu>File</guimenu> 1617 <guisubmenu>Share</guisubmenu> 1618 </menuchoice> 1619 </term> 1620 <listitem> 1621 <para>This item contains the services which can be used to share the current document with other people or send it to your devices. 1622 The entries in this sub-menu are controlled by the system. They depend on the current document format and the installed KPurpose plugins.</para> 1623 </listitem> 1624 </varlistentry> 1625 1626 <varlistentry> 1627 <term> 1628 <menuchoice> 1629 <shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut> 1630 <guimenu>File</guimenu> 1631 <guimenuitem>Quit</guimenuitem> 1632 </menuchoice> 1633 </term> 1634 <listitem> 1635 <para><action>Close</action> &okular;.</para> 1636 </listitem> 1637 </varlistentry> 1638 </variablelist> 1639 </sect1> 1640 1641 <sect1 id="menuedit"> 1642 <title>The Edit Menu</title> 1643 <variablelist> 1644 <varlistentry> 1645 <term> 1646 <anchor id="edit-undo"/> 1647 <menuchoice> 1648 <shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> 1649 <guimenu>Edit</guimenu> 1650 <guimenuitem>Undo</guimenuitem> 1651 </menuchoice> 1652 </term> 1653 <listitem> 1654 <para><action>Undo</action> the last annotation editing command (creation and removal of annotations, editing arbitrary annotation properties, relocating annotations with &Ctrl;+drag, and editing the text contents of an annotation).</para> 1655 </listitem> 1656 </varlistentry> 1657 <varlistentry> 1658 <term> 1659 <anchor id="edit-redo"/> 1660 <menuchoice> 1661 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut> 1662 <guimenu>Edit</guimenu> 1663 <guimenuitem>Redo</guimenuitem> 1664 </menuchoice> 1665 </term> 1666 <listitem> 1667 <para><action>Redo</action> the last undo step when editing annotations.</para> 1668 </listitem> 1669 </varlistentry> 1670 </variablelist> 1671 1672 <variablelist> 1673 <varlistentry> 1674 <term> 1675 <menuchoice> 1676 <shortcut><keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut> 1677 <guimenu>Edit</guimenu> 1678 <guimenuitem>Copy</guimenuitem> 1679 </menuchoice> 1680 </term> 1681 <listitem> 1682 <para><action>Copy</action> the currently selected text in 1683 <guibutton>Text Selection</guibutton> mode to the clipboard.</para> 1684 </listitem> 1685 </varlistentry> 1686 </variablelist> 1687 1688 <variablelist> 1689 <varlistentry> 1690 <term> 1691 <menuchoice> 1692 <shortcut><keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> 1693 <guimenu>Edit</guimenu> 1694 <guimenuitem>Select All</guimenuitem> 1695 </menuchoice> 1696 </term> 1697 <listitem> 1698 <para><action>Selects</action> all the text (if the document provides it). This works only in 1699 <guibutton>Text Selection</guibutton> mode.</para> 1700 </listitem> 1701 </varlistentry> 1702 </variablelist> 1703 1704 <variablelist> 1705 <varlistentry> 1706 <term> 1707 <menuchoice> 1708 <guimenu>Edit</guimenu> 1709 <guimenuitem>Select All Text on Current Page</guimenuitem> 1710 </menuchoice> 1711 </term> 1712 <listitem> 1713 <para><action>Selects</action> all the text (if the document provides it) of the current page. 1714 </para> 1715 </listitem> 1716 </varlistentry> 1717 </variablelist> 1718 1719 <variablelist> 1720 <varlistentry> 1721 <term> 1722 <menuchoice> 1723 <shortcut><keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> 1724 <guimenu>Edit</guimenu> 1725 <guimenuitem>Find...</guimenuitem> 1726 </menuchoice> 1727 </term> 1728 <listitem> 1729 <para> 1730 Show the find bar on the bottom of the viewing area that allows you to 1731 <action>search for a string in the document</action>. 1732 </para> 1733 </listitem> 1734 </varlistentry> 1735 1736 <varlistentry> 1737 <term> 1738 <menuchoice> 1739 <shortcut><keycap>F3</keycap></shortcut> 1740 <guimenu>Edit</guimenu> 1741 <guimenuitem>Find Next</guimenuitem> 1742 </menuchoice> 1743 </term> 1744 <listitem> 1745 <para>Try to <action>find the previous searched string again</action> in the document.</para> 1746 </listitem> 1747 </varlistentry> 1748 1749 <varlistentry> 1750 <term> 1751 <menuchoice> 1752 <shortcut><keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo></shortcut> 1753 <guimenu>Edit</guimenu> 1754 <guimenuitem>Find Previous</guimenuitem> 1755 </menuchoice> 1756 </term> 1757 <listitem> 1758 <para><action>Goes to the previous occurrence of the search string</action> in the document.</para> 1759 </listitem> 1760 </varlistentry> 1761 </variablelist> 1762 </sect1> 1763 1764 <sect1 id="menuview"> 1765 <title>The View Menu</title> 1766 <variablelist> 1767 <varlistentry> 1768 <term> 1769 <menuchoice> 1770 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo></shortcut> 1771 <guimenu>View</guimenu> 1772 <guimenuitem>Presentation</guimenuitem> 1773 </menuchoice> 1774 </term> 1775 <listitem> 1776 <para><action>Activates</action> the Presentation Mode. For more information, see the 1777 section about <link linkend="presentationMode">Presentation Mode</link>.</para> 1778 </listitem> 1779 </varlistentry> 1780 <varlistentry> 1781 <term> 1782 <menuchoice> 1783 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></shortcut> 1784 <guimenu>View</guimenu> 1785 <guimenuitem>Full Screen Mode</guimenuitem> 1786 </menuchoice> 1787 </term> 1788 <listitem> 1789 <para><action>Enables the full screen mode</action>. Note that 1790 full screen mode is different from presentation mode insofar as the 1791 only peculiarity of full screen mode is that it hides the window 1792 decorations, the menubar and the toolbar.</para> 1793 </listitem> 1794 </varlistentry> 1795 <varlistentry> 1796 <term> 1797 <menuchoice> 1798 <shortcut><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut> 1799 <guimenu>View</guimenu> 1800 <guimenuitem>Zoom In</guimenuitem> 1801 </menuchoice> 1802 </term> 1803 <listitem> 1804 <para><action>Increase the magnification</action> of the document view.</para> 1805 </listitem> 1806 </varlistentry> 1807 1808 <varlistentry> 1809 <term> 1810 <menuchoice> 1811 <shortcut><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut> 1812 <guimenu>View</guimenu> 1813 <guimenuitem>Zoom Out</guimenuitem> 1814 </menuchoice> 1815 </term> 1816 <listitem> 1817 <para><action>Decrease the magnification</action> of the document view.</para> 1818 </listitem> 1819 </varlistentry> 1820 <varlistentry> 1821 <term> 1822 <menuchoice> 1823 <guimenu>View</guimenu> 1824 <guimenuitem>Zoom to 100%</guimenuitem> 1825 </menuchoice> 1826 </term> 1827 <listitem> 1828 <para><action>Zoom the document image to the actual size</action> as prescribed by the document parameters.</para> 1829 </listitem> 1830 </varlistentry> 1831 <varlistentry> 1832 <term> 1833 <menuchoice> 1834 <guimenu>View</guimenu> 1835 <guimenuitem>Fit Width</guimenuitem> 1836 </menuchoice> 1837 </term> 1838 <listitem> 1839 <para><action>Change the magnification</action> of the document 1840 view to a value that makes the pages' width equal to the document 1841 view's width.</para> 1842 </listitem> 1843 </varlistentry> 1844 <varlistentry> 1845 <term> 1846 <menuchoice> 1847 <guimenu>View</guimenu> 1848 <guimenuitem>Fit Page</guimenuitem> 1849 </menuchoice> 1850 </term> 1851 <listitem> 1852 <para><action>Change the magnification</action> of the document view 1853 to a value that makes at least one whole page visible.</para> 1854 </listitem> 1855 </varlistentry> 1856 <varlistentry> 1857 <term> 1858 <menuchoice> 1859 <guimenu>View</guimenu> 1860 <guimenuitem>Auto Fit</guimenuitem> 1861 </menuchoice> 1862 </term> 1863 <listitem> 1864 <para><action>Change the magnification</action> of the document view 1865 to a value that, depending on the size relation between the page and the view area, automatically either makes the pages' width equal to the document view's width (like fit-width), the pages' height equal to the document view's height (like fit-height), or the whole page visible (like fit-page).</para> 1866 </listitem> 1867 </varlistentry> 1868 <varlistentry> 1869 <term> 1870 <menuchoice> 1871 <guimenu>View</guimenu> 1872 <guisubmenu>View Mode</guisubmenu> 1873 </menuchoice> 1874 </term> 1875 <listitem> 1876 <para>This submenu makes you choose the view mode for the pages. The possible 1877 options are: <guimenuitem>Single Page</guimenuitem> (only one page per row), 1878 <guimenuitem>Facing Pages</guimenuitem> (two pages per row, in a book style), 1879 <guimenuitem>Facing Pages (Center First Page)</guimenuitem> and 1880 <guimenuitem>Overview</guimenuitem> (the number of columns is the one 1881 specified in the <link linkend="configure">&okular; settings</link>).</para> 1882 <para>Additionally, you can enable the <guimenuitem>Continuous</guimenuitem> mode. 1883 In continuous mode, all pages of the document are shown, and you can smoothly 1884 scroll through them. Otherwise, only one page (or one row of pages) is shown 1885 at a time.</para> 1886 </listitem> 1887 </varlistentry> 1888 <varlistentry> 1889 <term> 1890 <menuchoice> 1891 <guimenu>View</guimenu> 1892 <guisubmenu>Orientation</guisubmenu> 1893 </menuchoice> 1894 </term> 1895 <listitem> 1896 <para> 1897 This submenu allows you to <action>changes the orientation</action> 1898 of the pages of the document. 1899 </para> 1900 <note> 1901 <para> 1902 The rotation is applied to the orientation of every page. 1903 </para> 1904 </note> 1905 <para> 1906 You can select <guimenuitem>Original Orientation</guimenuitem> to restore 1907 the orientation of the document, discarding all the rotations applied 1908 manually. 1909 </para> 1910 </listitem> 1911 </varlistentry> 1912 <varlistentry> 1913 <term> 1914 <menuchoice> 1915 <guimenu>View</guimenu> 1916 <guisubmenu>Trim View</guisubmenu> 1917 </menuchoice> 1918 </term> 1919 <listitem> 1920 <para> 1921 This submenu allows you to remove the white border of pages when viewing pages (<guimenuitem>Trim Margins</guimenuitem> item) or trim viewport to selection (<guimenuitem>Trim To Selection</guimenuitem> item). 1922 </para> 1923 <para> 1924 The <quote>trim to selection</quote> mode allows you to draw a selection over the rendered page in order to define a visible bounding box to be applied to <emphasis>all pages</emphasis> in the document. Selecting a small trim bounding box enforces minimum dimensions size (20% as a percentage of total page size). 1925 </para> 1926 <para> 1927 The <quote>trim margins</quote> mode is persistent across &okular; restarts. The <quote>trim to selection</quote> mode is forgotten across &okular; restarts. 1928 </para> 1929 <para> 1930 When you switch &okular; from <quote>trim margins</quote> mode to <quote>trim to selection</quote> mode, the view jumps out of <quote>trim margins</quote> mode for the bounding box selection interaction. 1931 </para> 1932 <para> 1933 The trim mode can be deactivated by selecting the same menu item that activates it once again. 1934 </para> 1935 </listitem> 1936 </varlistentry> 1937 <varlistentry> 1938 <term> 1939 <menuchoice> 1940 <guimenu>View</guimenu> 1941 <guimenuitem>Show/Hide Forms</guimenuitem> 1942 </menuchoice> 1943 </term> 1944 <listitem> 1945 <para> 1946 <action>Show or hides the display</action> of the form fields of the 1947 document. 1948 </para> 1949 <note> 1950 <para> 1951 This menu item is active only if the current document has form 1952 fields. 1953 </para> 1954 </note> 1955 </listitem> 1956 </varlistentry> 1957 </variablelist> 1958 <!-- Crtl + mouse wheel zoom in + out--> 1959 </sect1> 1960 1961 <sect1 id="menugo"> 1962 <title>The Go Menu</title> 1963 <variablelist> 1964 <varlistentry> 1965 <term> 1966 <menuchoice> 1967 <guimenu>Go</guimenu> 1968 <guimenuitem>Previous Page</guimenuitem> 1969 </menuchoice> 1970 </term> 1971 <listitem> 1972 <para><action>View the previous page</action> of the document.</para> 1973 </listitem> 1974 </varlistentry> 1975 <varlistentry> 1976 <term> 1977 <menuchoice> 1978 <guimenu>Go</guimenu> 1979 <guimenuitem>Next Page</guimenuitem> 1980 </menuchoice> 1981 </term> 1982 <listitem> 1983 <para><action>View the next page</action> of the document.</para> 1984 </listitem> 1985 </varlistentry> 1986 <varlistentry> 1987 <term> 1988 <menuchoice> 1989 <shortcut><keycombo action="simul">&Ctrl;&Home;</keycombo></shortcut> 1990 <guimenu>Go</guimenu> 1991 <guimenuitem>Beginning of the document</guimenuitem> 1992 </menuchoice> 1993 </term> 1994 <listitem> 1995 <para><action>Go to the beginning</action> of the document.</para> 1996 </listitem> 1997 </varlistentry> 1998 <varlistentry> 1999 <term> 2000 <menuchoice> 2001 <shortcut><keycombo action="simul">&Ctrl;&End;</keycombo></shortcut> 2002 <guimenu>Go</guimenu> 2003 <guimenuitem>End of the document</guimenuitem> 2004 </menuchoice> 2005 </term> 2006 <listitem> 2007 <para><action>Go to the end</action> of the document.</para> 2008 </listitem> 2009 </varlistentry> 2010 <varlistentry> 2011 <term> 2012 <menuchoice> 2013 <shortcut><keycombo action="simul">&Alt;&Shift;&Left;</keycombo></shortcut> 2014 <guimenu>Go</guimenu> 2015 <guimenuitem>Back</guimenuitem> 2016 </menuchoice> 2017 </term> 2018 <listitem> 2019 <para><action>Go back to the previous view</action> of the document.</para> 2020 </listitem> 2021 </varlistentry> 2022 <varlistentry> 2023 <term> 2024 <menuchoice> 2025 <shortcut><keycombo action="simul">&Alt;&Shift;&Right;</keycombo></shortcut> 2026 <guimenu>Go</guimenu> 2027 <guimenuitem>Forward</guimenuitem> 2028 </menuchoice> 2029 </term> 2030 <listitem> 2031 <para><action>Move forward to the next view</action> of the document. This only works if you have already moved back before.</para> 2032 </listitem> 2033 </varlistentry> 2034 <varlistentry> 2035 <term> 2036 <menuchoice> 2037 <shortcut><keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo></shortcut> 2038 <guimenu>Go</guimenu> 2039 <guimenuitem>Go to Page...</guimenuitem> 2040 </menuchoice> 2041 </term> 2042 <listitem> 2043 <para>Open a dialog which allows you to <action>go to any page</action> of the document.</para> 2044 </listitem> 2045 </varlistentry> 2046 </variablelist> 2047 </sect1> 2048 2049 <sect1 id="menubookmarks"> 2050 <title>The Bookmarks Menu</title> 2051 <variablelist> 2052 <varlistentry> 2053 <term> 2054 <menuchoice> 2055 <shortcut><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></shortcut> 2056 <guimenu>Bookmarks</guimenu> 2057 <guimenuitem>Add/Remove Bookmark</guimenuitem> 2058 </menuchoice> 2059 </term> 2060 <listitem> 2061 <para> 2062 <action>Add or remove a bookmark for the current position</action>. 2063 </para> 2064 </listitem> 2065 </varlistentry> 2066 <varlistentry> 2067 <term> 2068 <menuchoice> 2069 <guimenu>Bookmarks</guimenu> 2070 <guimenuitem>Rename Bookmark</guimenuitem> 2071 </menuchoice> 2072 </term> 2073 <listitem> 2074 <para> 2075 <action>Rename a bookmark for the current position</action>. 2076 </para> 2077 </listitem> 2078 </varlistentry> 2079 <varlistentry> 2080 <term> 2081 <menuchoice> 2082 <guimenu>Bookmarks</guimenu> 2083 <guimenuitem>Previous Bookmark</guimenuitem> 2084 </menuchoice> 2085 </term> 2086 <listitem> 2087 <para><action>Go to the previous bookmark</action>, or do nothing if there 2088 are no bookmarks prior to the current one.</para> 2089 </listitem> 2090 </varlistentry> 2091 <varlistentry> 2092 <term> 2093 <menuchoice> 2094 <guimenu>Bookmarks</guimenu> 2095 <guimenuitem>Next Bookmark</guimenuitem> 2096 </menuchoice> 2097 </term> 2098 <listitem> 2099 <para><action>Go to the next bookmark</action>, or do nothing if there 2100 are no bookmarks after the current one.</para> 2101 </listitem> 2102 </varlistentry> 2103 <varlistentry> 2104 <term> 2105 <menuchoice> 2106 <guimenu>Bookmarks</guimenu> 2107 <guimenuitem>No Bookmarks</guimenuitem> 2108 </menuchoice> 2109 </term> 2110 <listitem> 2111 <para>This is an always disabled action that appears in this menu only if the current document has 2112 no bookmarks. Otherwise a list of all bookmarks is displayed here. Clicking on these bookmarks 2113 allows you to go directly to the associated position.</para> 2114 </listitem> 2115 </varlistentry> 2116 </variablelist> 2117 </sect1> 2118 2119 <sect1 id="menutools"> 2120 <title>The Tools Menu</title> 2121 <variablelist> 2122 <varlistentry> 2123 <term> 2124 <menuchoice> 2125 <shortcut><keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo></shortcut> 2126 <guimenu>Tools</guimenu> 2127 <guimenuitem>Browse</guimenuitem> 2128 </menuchoice> 2129 </term> 2130 <listitem> 2131 <para>The mouse will have its normal behavior, &LMB; for dragging the document and following links and &RMB; for adding bookmarks and fit to width.</para> 2132 </listitem> 2133 </varlistentry> 2134 <varlistentry> 2135 <term> 2136 <menuchoice> 2137 <shortcut><keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo></shortcut> 2138 <guimenu>Tools</guimenu> 2139 <guimenuitem>Zoom</guimenuitem> 2140 </menuchoice> 2141 </term> 2142 <listitem> 2143 <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> 2144 </listitem> 2145 </varlistentry> 2146 <varlistentry> 2147 <term> 2148 <menuchoice> 2149 <shortcut><keycombo action="simul">&Ctrl;<keycap>3</keycap></keycombo></shortcut> 2150 <guimenu>Tools</guimenu> 2151 <guimenuitem>Area Selection</guimenuitem> 2152 </menuchoice> 2153 </term> 2154 <listitem> 2155 <para>The mouse will work as a rectangular region selection tool. In that mode clicking &LMB; and dragging will draw a selection box and provide the option of copying the selected content to the clipboard, speaking the selected text, or transforming the selection region into an image and saving it to a file.</para> 2156 </listitem> 2157 </varlistentry> 2158 <varlistentry> 2159 <term> 2160 <menuchoice> 2161 <shortcut><keycombo action="simul">&Ctrl;<keycap>4</keycap></keycombo></shortcut> 2162 <guimenu>Tools</guimenu> 2163 <guimenuitem>Text Selection</guimenuitem> 2164 </menuchoice> 2165 </term> 2166 <listitem> 2167 <para>The mouse will work as a text selection tool. In that mode clicking &LMB; and 2168 dragging will give the option of selecting the text of the document. Then, just 2169 click with the &RMB; to copy to the clipboard or speak the current selection.</para> 2170 </listitem> 2171 </varlistentry> 2172 <varlistentry> 2173 <term> 2174 <menuchoice> 2175 <shortcut><keycombo action="simul">&Ctrl;<keycap>5</keycap></keycombo></shortcut> 2176 <guimenu>Tools</guimenu> 2177 <guimenuitem>Table Selection</guimenuitem> 2178 </menuchoice> 2179 </term> 2180 <listitem> 2181 <para> 2182 Draw a rectangle around the text for the table, 2183 then click with the &LMB; to divide the text block into rows and columns. 2184 A &LMB; click on an existing line removes it and merges the adjacent rows or columns. 2185 Finally, just click with the &RMB; to copy the table to the clipboard. 2186 </para> 2187 </listitem> 2188 </varlistentry> 2189 <varlistentry> 2190 <term> 2191 <menuchoice> 2192 <shortcut><keycombo action="simul">&Ctrl;<keycap>6</keycap></keycombo></shortcut> 2193 <guimenu>Tools</guimenu> 2194 <guimenuitem>Magnifier</guimenuitem> 2195 </menuchoice> 2196 </term> 2197 <listitem> 2198 <para>Activates the magnifier mode for the mouse pointer. Press and hold the &LMB; to activate magnifier widget, move the pointer for panning through the document. The magnifier scales each pixel in the document into 10 pixels in the magnifier widget.</para> 2199 </listitem> 2200 </varlistentry> 2201 <varlistentry> 2202 <term> 2203 <menuchoice> 2204 <shortcut><keycap>F6</keycap></shortcut> 2205 <guimenu>Tools</guimenu> 2206 <guimenuitem>Annotations</guimenuitem> 2207 </menuchoice> 2208 </term> 2209 <listitem> 2210 <para><action>Open the annotation toolbar</action>. The annotation toolbar allows you to add 2211 annotations on the document you are reading. For more information, please see the 2212 section about <link linkend="annotations">Annotations</link>.</para> 2213 </listitem> 2214 </varlistentry> 2215 <varlistentry> 2216 <term> 2217 <menuchoice> 2218 <guimenu>Tools</guimenu> 2219 <guimenuitem>Digitally Sign...</guimenuitem> 2220 </menuchoice> 2221 </term> 2222 <listitem> 2223 <para><action>Starts the digital signature creation workflow</action>. Addition of digital signatures is only supported for PDF files at this point. For more information, please see the section about <link linkend="adding_digital_signatures">Adding Digital Signatures</link>.</para> 2224 </listitem> 2225 </varlistentry> 2226 <varlistentry> 2227 <term> 2228 <menuchoice> 2229 <guimenu>Tools</guimenu> 2230 <guimenuitem>Speak Whole Document</guimenuitem> 2231 </menuchoice> 2232 </term> 2233 <term> 2234 <menuchoice> 2235 <guimenu>Tools</guimenu> 2236 <guimenuitem>Speak Current Page</guimenuitem> 2237 </menuchoice> 2238 </term> 2239 <term> 2240 <menuchoice> 2241 <guimenu>Tools</guimenu> 2242 <guimenuitem>Stop Speaking</guimenuitem> 2243 </menuchoice> 2244 </term> 2245 <term> 2246 <menuchoice> 2247 <guimenu>Tools</guimenu> 2248 <guimenuitem>Pause/Resume Speaking</guimenuitem> 2249 </menuchoice> 2250 </term> 2251 <listitem> 2252 <para>These items allow you to speak the whole document or just the current page and stop speaking using the system speech service. 2253 This service is provided by a &Qt; library which wraps speech-dispatcher on &Linux;, and native speech systems on other platforms. 2254 It is possible to choose the current voice via &okular; <link linkend="configaccessibility">Accessibility</link> configuration page.</para> 2255 <para>The <guilabel>Speak ...</guilabel> actions are enabled only if a speech service is available in the system.</para> 2256 </listitem> 2257 </varlistentry> 2258 </variablelist> 2259 </sect1> 2260 2261 <sect1 id="settings-help-menu"> 2262 <title>The Settings and Help Menu</title> 2263 <para>Apart from the common &kde; <guimenu>Settings</guimenu> and <guimenu>Help</guimenu> menus described 2264 in the <ulink url="help:/fundamentals/menus.html">Menu</ulink> chapter of the &kde; Fundamentals documentation 2265 &okular; has these application specific menu entries:</para> 2266 <variablelist> 2267 <varlistentry> 2268 <term> 2269 <menuchoice> 2270 <shortcut><keycap>F7</keycap></shortcut> 2271 <guimenu>Settings</guimenu> 2272 <guimenuitem>Show Sidebar</guimenuitem> 2273 </menuchoice> 2274 </term> 2275 <listitem> 2276 <para><action>Shows or hides the Sidebar.</action></para> 2277 </listitem> 2278 </varlistentry> 2279 <varlistentry> 2280 <term> 2281 <menuchoice> 2282 <guimenu>Settings</guimenu> 2283 <guimenuitem>Show Page Bar</guimenuitem> 2284 </menuchoice> 2285 </term> 2286 <listitem> 2287 <para><action>Toggle the page bar</action> at the bottom of document area on and off to save vertical place in &okular; window. Note that the page numbers will be shown on the default toolbar anyway.</para> 2288 </listitem> 2289 </varlistentry> 2290 <varlistentry> 2291 <term> 2292 <menuchoice> 2293 <guimenu>Settings</guimenu> 2294 <guimenuitem>Configure Backends...</guimenuitem> 2295 </menuchoice> 2296 </term> 2297 <listitem> 2298 <para>Opens the <link linkend="configure-backends">Backend Configuration</link> 2299 window.</para> 2300 </listitem> 2301 </varlistentry> 2302 </variablelist> 2303 </sect1> 2304 2305 </chapter> 2306 <chapter id="configure-backends"> 2307 <title>Configuring &okular; Backends</title> 2308 <para> 2309 You can configure &okular; backends by choosing <menuchoice> 2310 <guimenu>Settings</guimenu> 2311 <guimenuitem>Configure Backends...</guimenuitem> 2312 </menuchoice>. 2313 Currently, configuration options are provided for EPub, &PostScript;, FictionBook, Txt, OpenDocument Text, and &PDF; backends only. 2314 </para> 2315 <screenshot> 2316 <screeninfo>The backends configuration dialog</screeninfo> 2317 <mediaobject> 2318 <imageobject> 2319 <imagedata fileref="configure-backends.png" format="PNG" /> 2320 </imageobject> 2321 <textobject> 2322 <phrase>The backends configuration dialog</phrase> 2323 </textobject> 2324 </mediaobject> 2325 </screenshot> 2326 <para> 2327 Using backend configuration pages for EPub, FictionBook, Mobipocket, Markdown, TXT, and OpenDocument Text you can define the font to render documents in the corresponding formats. The <guibutton>Choose...</guibutton> button in these pages opens standard &kde; font configuration window. Please refer to the <ulink url="help:/fundamentals/fonts.html">&kde; Fundamentals documentation</ulink> for the details. 2328 </para> 2329 <para> 2330 The description of Markdown, &PostScript; and &PDF; backends configuration pages can be found below. 2331 </para> 2332 <sect1 id="config-markdown"> 2333 <title>Markdown backend configuration</title> 2334 <para> 2335 You can configure &okular; Markdown rendering backend based on <ulink url="https://www.pell.portland.or.us/~orc/Code/markdown/">Discount</ulink> by choosing <guilabel>Markdown</guilabel> from the list on the left part of the configuration dialog. An additional configurable option is as follows. 2336 </para> 2337 <para> 2338 <variablelist> 2339 <varlistentry> 2340 <term> 2341 <guilabel>Enable SmartyPants formatting</guilabel> 2342 </term> 2343 <listitem> 2344 <para>When checked this option allows &okular; to process <ulink url="https://daringfireball.net/projects/smartypants/">SmartyPants</ulink> formatting. Such formatting can be troublesome in the technical texts because of unwanted substitutions (⪚, it replaces <literal>(C)</literal> with a copyright symbol). This option is checked by default. 2345 </para> 2346 </listitem> 2347 </varlistentry> 2348 </variablelist> 2349 </para> 2350 </sect1> 2351 <sect1 id="config-ghostscript"> 2352 <title>&PostScript; backend configuration</title> 2353 <para> 2354 You can configure &okular; &PostScript; rendering backend based on <ulink url="https://www.ghostscript.com/">Ghostscript</ulink> by choosing <guilabel>Ghostscript</guilabel> from the list on the left part of the configuration dialog. The only configurable option is as follows. 2355 </para> 2356 <para> 2357 <variablelist> 2358 <varlistentry> 2359 <term> 2360 <guilabel>Use platform fonts</guilabel> 2361 </term> 2362 <listitem> 2363 <para>This option determines whether Ghostscript should be allowed to use platform fonts, if unchecked only usage of fonts embedded in the document will be allowed. This option is checked by default. 2364 </para> 2365 </listitem> 2366 </varlistentry> 2367 </variablelist> 2368 </para> 2369 </sect1> 2370 <sect1 id="config-pdf"> 2371 <title>&PDF; backend configuration</title> 2372 <para> 2373 You can configure &okular; &PDF; rendering backend based on <ulink url="https://poppler.freedesktop.org/">Poppler</ulink> by choosing <guilabel>&PDF;</guilabel> from the list on the left part of the configuration dialog. The only configurable option is as follows. 2374 </para> 2375 <para> 2376 <variablelist> 2377 <varlistentry> 2378 <term> 2379 <guilabel>Enhance thin lines</guilabel> 2380 </term> 2381 <listitem> 2382 <para> 2383 Drawing lines in &okular; is implemented in two steps: generation of the clipping path and filling this clipping path. When the line in the original document is less than one pixel this two step implementation could cause problems. For those lines, the clipping path is filled with the filling color that depends on the thickness of the line part inside the clipping area. If the part of the line inside the clipping area gets very small the contrast between the shape and the background color can become too low for the line to be recognizable. The grids of such lines then looks very unpretty. 2384 </para> 2385 <informaltable> 2386 <tgroup cols="2"> 2387 <tbody> 2388 <row> 2389 <entry> 2390 <para> 2391 <screenshot> 2392 <mediaobject> 2393 <imageobject> 2394 <imagedata fileref="enhance-thinline.png" format="PNG"/> 2395 </imageobject> 2396 </mediaobject> 2397 </screenshot> 2398 </para> 2399 </entry> 2400 <entry> 2401 <para> 2402 <screenshot> 2403 <mediaobject> 2404 <imageobject> 2405 <imagedata fileref="enhance-lowcontrast.png" format="PNG"/> 2406 </imageobject> 2407 </mediaobject> 2408 </screenshot> 2409 </para> 2410 </entry> 2411 </row> 2412 <row> 2413 <entry>Thin line (red), its clipping path (dashed line) and pixel boundaries (black solid lines)</entry> 2414 <entry>Thin line shown at a low contrast</entry> 2415 </row> 2416 </tbody> 2417 </tgroup> 2418 </informaltable> 2419 <para> 2420 To enhance the look of the thin lines &okular; implements two options. 2421 </para> 2422 <para> 2423 The first option is <guimenuitem>Solid</guimenuitem>. With this option &okular; adjusts clipping path and line position so that clipping path and line are on the same pixel boundary, &ie; &okular; enlarges the thin lines to one pixel on the output device. This mode is similar to the <guilabel>Enhance thin lines</guilabel> in <trademark class="registered">Adobe</trademark> 2424 <trademark class="registered">Reader</trademark>. If this option is chosen, the thin lines are always enlarged. 2425 </para> 2426 <para> 2427 <screenshot> 2428 <mediaobject> 2429 <imageobject> 2430 <imagedata fileref="enhance-solid.png" format="PNG"/> 2431 </imageobject> 2432 <textobject> 2433 <phrase>Thin line with <guimenuitem>Solid</guimenuitem> enhancement</phrase> 2434 </textobject> 2435 <caption> 2436 <para>Thin line with <guimenuitem>Solid</guimenuitem> enhancement</para> 2437 </caption> 2438 </mediaobject> 2439 </screenshot> 2440 </para> 2441 <para> 2442 The second option is <guimenuitem>Shape</guimenuitem>. With this option the clipping path and line are adjusted to pixel boundary as well, but the line intensity is corrected according to its width. 2443 </para> 2444 <para> 2445 <screenshot> 2446 <mediaobject> 2447 <imageobject> 2448 <imagedata fileref="enhance-shape.png" format="PNG"/> 2449 </imageobject> 2450 <textobject> 2451 <phrase>Thin line with <guimenuitem>Shape</guimenuitem> enhancement</phrase> 2452 </textobject> 2453 <caption> 2454 <para>Thin line with <guimenuitem>Shape</guimenuitem> enhancement</para> 2455 </caption> 2456 </mediaobject> 2457 </screenshot> 2458 </para> 2459 <para> 2460 The thin lines are not enhanced by default (option <guimenuitem>No</guimenuitem>). 2461 </para> 2462 </listitem> 2463 </varlistentry> 2464 </variablelist> 2465 </para> 2466 <sect2 id="config-pdf-digital-signatures"> 2467 <title>&PDF; Digital Signature Certificates</title> 2468 <para> 2469 <screenshot><mediaobject><imageobject><imagedata fileref="config-pdf-digital-signatures.png" format="PNG"/></imageobject></mediaobject></screenshot> 2470 This section allows you to set a custom Certificate Database to use when adding Digital Signatures to &PDF; files. 2471 </para> 2472 <para> 2473 It also lists the certificates available in the current Certificate Database (if any). 2474 </para> 2475 </sect2> 2476 </sect1> 2477 </chapter> 2478 <chapter id="configure"> 2479 <title>Configuring &okular;</title> 2480 <sect1 id="configindex"> 2481 <title>General configuration</title> 2482 <para> 2483 You can configure &okular; by choosing <menuchoice><guimenu>Settings</guimenu> 2484 <guimenuitem>Configure &okular;...</guimenuitem></menuchoice>. 2485 The configuration dialog is split into six sections. This chapter describes the available 2486 options in detail. 2487 </para> 2488 <itemizedlist> 2489 <listitem> 2490 <para><link linkend="configgeneral">General</link></para> 2491 </listitem> 2492 <listitem> 2493 <para><link linkend="configaccessibility">Accessibility</link></para> 2494 </listitem> 2495 <listitem> 2496 <para><link linkend="configperformance">Performance</link></para> 2497 </listitem> 2498 <listitem> 2499 <para><link linkend="configpresentation">Presentation</link></para> 2500 </listitem> 2501 <listitem> 2502 <para><link linkend="configannotations">Annotations</link></para> 2503 </listitem> 2504 <listitem> 2505 <para><link linkend="configeditor">Editor</link></para> 2506 </listitem> 2507 </itemizedlist> 2508 <screenshot> 2509 <screeninfo>The configuration dialog</screeninfo> 2510 <mediaobject> 2511 <imageobject> 2512 <imagedata fileref="configure.png" format="PNG" /> 2513 </imageobject> 2514 <textobject> 2515 <phrase>The configuration dialog</phrase> 2516 </textobject> 2517 </mediaobject> 2518 </screenshot> 2519 <para> 2520 Depending on the currently installed backends, the <menuchoice><guimenu>Settings</guimenu> 2521 <guimenuitem>Configure Backends...</guimenuitem></menuchoice> menu item could be enabled. 2522 This particular configuration dialog holds the configurations of the backends that can 2523 actually be configured. 2524 </para> 2525 </sect1> 2526 <sect1 id="configgeneral"> 2527 <title>General</title> 2528 <variablelist> 2529 <varlistentry> 2530 <term><guilabel>Use smooth scrolling</guilabel></term> 2531 <listitem> 2532 <para>Whether to display animated transitions when scrolling using the mouse wheel and keyboard.</para> 2533 </listitem> 2534 </varlistentry> 2535 <varlistentry> 2536 <term><guilabel>Show scrollbars</guilabel></term> 2537 <listitem> 2538 <para>Whether to show scrollbars for the document view.</para> 2539 </listitem> 2540 </varlistentry> 2541 <varlistentry> 2542 <term><guilabel>Link the thumbnails with the page</guilabel></term> 2543 <listitem> 2544 <para>Whether the thumbnails view should always display the current 2545 page or not.</para> 2546 </listitem> 2547 </varlistentry> 2548 <varlistentry> 2549 <term><guilabel>Show hints and info messages</guilabel></term> 2550 <listitem> 2551 <para>Whether to show some informative messages on startup, file 2552 load, &etc;</para> 2553 </listitem> 2554 </varlistentry> 2555 <varlistentry> 2556 <term><guilabel>Notify about embedded files, forms, or signatures</guilabel></term> 2557 <listitem> 2558 <para>Whether to show informative panels about embedded files, forms 2559 or signatures &etc;</para> 2560 </listitem> 2561 </varlistentry> 2562 <varlistentry> 2563 <term><guilabel>Display document title in titlebar if available</guilabel></term> 2564 <listitem> 2565 <para>Whether to show the current document title in the titlebar of &okular; window. If no metadata for title 2566 found in the document or this item is unchecked &okular; shows filename of the document. 2567 </para> 2568 </listitem> 2569 </varlistentry> 2570 <varlistentry> 2571 <term><guilabel>When not displaying document title</guilabel></term> 2572 <listitem> 2573 <para>You can choose any of two options, <guilabel>Display file name only</guilabel> or <guilabel>Display full file path</guilabel>. 2574 </para> 2575 </listitem> 2576 </varlistentry> 2577 <varlistentry> 2578 <term><guilabel>Use custom background color</guilabel></term> 2579 <listitem> 2580 <para>Enables <ulink url="help:/fundamentals/colors.html">choosing the document background color</ulink> (the color around the displayed page). By default, the &Qt; toolkit color is used when this option is unchecked. 2581 </para> 2582 </listitem> 2583 </varlistentry> 2584 <varlistentry> 2585 <term><guilabel>Open new files in tabs</guilabel></term> 2586 <listitem> 2587 <para>Whether to open new documents in tabs. The tabs are disabled by default.</para> 2588 <para> 2589 The default shortcuts to switch between tabs are <keycombo>&Ctrl;<keycap>.</keycap></keycombo> (<guilabel>Next tab</guilabel>) and <keycombo>&Ctrl;<keycap>,</keycap></keycombo> (<guilabel>Previous tab</guilabel>). 2590 </para> 2591 </listitem> 2592 </varlistentry> 2593 <varlistentry> 2594 <term><guilabel>Switch to existing tab if file is already open</guilabel></term> 2595 <listitem> 2596 <para>Whether &okular; should switch to a tab if the file is already open instead of opening a new tab. This option is enabled by default. Can be toggled only if <guilabel>Open new files in tabs</guilabel> is enabled.</para> 2597 </listitem> 2598 </varlistentry> 2599 <varlistentry> 2600 <term><guilabel>Obey DRM limitations</guilabel></term> 2601 <listitem> 2602 <para>Whether &okular; should obey <firstterm>DRM</firstterm> 2603 (Digital Rights Management) restrictions. DRM limitations are used 2604 to make it impossible to perform certain actions with &PDF; documents, 2605 such as copying content to the clipboard. Note that in some configurations 2606 of &okular;, this option is not available.</para> 2607 </listitem> 2608 </varlistentry> 2609 <varlistentry> 2610 <term><guilabel>Reload document on file change</guilabel></term> 2611 <listitem> 2612 <para>Whether opened files should be automatically checked for 2613 changes and updated, if necessary.</para> 2614 </listitem> 2615 </varlistentry> 2616 <varlistentry> 2617 <term><guilabel>Show backend selection dialog</guilabel></term> 2618 <listitem> 2619 <para>Whether &okular; should ask the user which backend to use in case of more 2620 than one backend able to open the current file. If unchecked, &okular; will 2621 use the backend with the highest priority.</para> 2622 </listitem> 2623 </varlistentry> 2624 <varlistentry> 2625 <term><guilabel>Right to left reading direction</guilabel></term> 2626 <listitem> 2627 <para> 2628 Whether to use right to left reading direction by default for the opened files. Can be useful for <ulink url="https://en.wikipedia.org/wiki/Right-to-left">some writing systems</ulink>. 2629 </para> 2630 </listitem> 2631 </varlistentry> 2632 <varlistentry> 2633 <term><guilabel>Open in continuous mode by default</guilabel></term> 2634 <listitem> 2635 <para> 2636 Whether to use the continuous mode by default. In continuous mode, all pages of the document are shown, and you can smoothly scroll through them. Otherwise, only one page (or one row of pages) is shown at a time. 2637 </para> 2638 </listitem> 2639 </varlistentry> 2640 <varlistentry> 2641 <term><guilabel>When using Browse Tool, wrap cursor at screen edges</guilabel></term> 2642 <listitem> 2643 <para> 2644 Allows endless scrolling around the entire document with the <link linkend="menutools">Browse Tool</link>. If enabled, the mouse cursor will wrap to the opposite end of the screen when it touches the borders while dragging the document. This feature is only supported on X11. 2645 </para> 2646 </listitem> 2647 </varlistentry> 2648 <varlistentry> 2649 <term><guilabel>Overview columns</guilabel></term> 2650 <listitem> 2651 <para> 2652 This option represents the number of columns to use in the overview mode. 2653 </para> 2654 </listitem> 2655 </varlistentry> 2656 <varlistentry> 2657 <term><guilabel>Page Up/Down overlap</guilabel></term> 2658 <listitem> 2659 <para> 2660 Here you can define the percentage of the current viewing area that should be visible after pressing &PgUp;/&PgDn; keys. 2661 </para> 2662 </listitem> 2663 </varlistentry> 2664 <varlistentry> 2665 <term><guilabel>Default Zoom</guilabel></term> 2666 <listitem> 2667 <para> 2668 This options specifies the default zoom mode for file which were never 2669 opened before. For those files which were opened before the previous zoom mode 2670 is applied. 2671 </para> 2672 </listitem> 2673 </varlistentry> 2674 </variablelist> 2675 </sect1> 2676 <sect1 id="configaccessibility"> 2677 <title>Accessibility</title> 2678 <variablelist> 2679 <varlistentry> 2680 <term><guilabel>Draw border around links</guilabel></term> 2681 <listitem> 2682 <para>Whether to draw a border around links.</para> 2683 </listitem> 2684 </varlistentry> 2685 <varlistentry> 2686 <term><guilabel>Change colors</guilabel></term> 2687 <listitem> 2688 <para><action>Enables</action> the color changing options.</para> 2689 </listitem> 2690 </varlistentry> 2691 <varlistentry> 2692 <term><guilabel>Color mode</guilabel></term> 2693 <listitem> 2694 <para><action>Defines</action> the color changing mode.</para> 2695 <variablelist> 2696 <varlistentry> 2697 <term><guilabel>Invert Colors</guilabel></term> 2698 <listitem> 2699 <para><action>Inverts</action> colors on the view, &ie; black objects will be shown white.</para> 2700 </listitem> 2701 </varlistentry> 2702 <varlistentry> 2703 <term><guilabel>Change Paper Color</guilabel></term> 2704 <listitem> 2705 <para><action>Changes</action> the paper's color, &ie; the document's background.</para> 2706 <para>The color can be selected using the <guilabel>Paper color</guilabel> swatch below. 2707 </para> 2708 </listitem> 2709 </varlistentry> 2710 <varlistentry> 2711 <term><guilabel>Change Dark & Light Colors</guilabel></term> 2712 <listitem> 2713 <para><action>Changes</action> the dark and light color to your preference, that means 2714 black will not be rendered as black but as the selected dark color and white 2715 will not be rendered as white but as the selected light color.</para> 2716 </listitem> 2717 </varlistentry> 2718 <varlistentry> 2719 <term><guilabel>Convert to Black & White</guilabel></term> 2720 <listitem> 2721 <para><action>Converts</action> the document to black and white. You can set the 2722 threshold and the contrast. Setting the threshold to a higher value 2723 by moving it to the right will result in lighter grays used.</para> 2724 </listitem> 2725 </varlistentry> 2726 <varlistentry> 2727 <term><guilabel>Invert Lightness</guilabel></term> 2728 <listitem> 2729 <para><action>Inverts</action> lightness of all colors. 2730 Light and dark colors will be swapped, but hue and saturation will not be affected. 2731 The Contrast in images will usually be worse than in <guilabel>Invert Luma (sRGB Linear)</guilabel>.</para> 2732 </listitem> 2733 </varlistentry> 2734 <varlistentry> 2735 <term><guilabel>Invert Luma (sRGB Linear)</guilabel></term> 2736 <listitem> 2737 <para><action>Inverts</action> luma of all colors. 2738 Light and dark will be swapped, but hue and saturation will not be affected. 2739 The Contrast in images is preserved better than in <guilabel>Invert Lightness</guilabel>, 2740 but graphics and colorful text markup usually look worse. 2741 Uses sRGB luma coefficients, but no gamma correction.</para> 2742 </listitem> 2743 </varlistentry> 2744 <varlistentry> 2745 <term><guilabel>Invert Luma (Symmetric)</guilabel></term> 2746 <listitem> 2747 <para><action>Inverts</action> luma of all colors, using symmetric luma coefficients. 2748 Light and dark will be swapped, but hue and saturation will not be affected. 2749 Very similar to <guilabel>Invert Lightness</guilabel>, 2750 but the contrast is in some cases better.</para> 2751 </listitem> 2752 </varlistentry> 2753 <varlistentry> 2754 <term><guilabel>Shift Hue Positive</guilabel></term> 2755 <listitem> 2756 <para><action>Shifts</action> hue of all colors by 120 degrees. 2757 Can mitigate some contrast problems in colorful graphics.</para> 2758 </listitem> 2759 </varlistentry> 2760 <varlistentry> 2761 <term><guilabel>Shift Hue Negative</guilabel></term> 2762 <listitem> 2763 <para><action>Shifts</action> hue of all colors by 240 degrees. 2764 Can mitigate some contrast problems in colorful graphics.</para> 2765 </listitem> 2766 </varlistentry> 2767 </variablelist> 2768 <note><para>You can configure keyboard shortcuts and toolbar actions for the color modes using the corresponding menu items in the <guimenu>Settings</guimenu> menu of the &okular; main window.</para></note> 2769 </listitem> 2770 </varlistentry> 2771 <varlistentry> 2772 <term><guilabel>Text-to-speech engine</guilabel></term> 2773 <listitem> 2774 <para><action>Allows you to choose</action> the text-to-speech (<abbrev>TTS</abbrev>) engine to be used by &okular;. 2775 The default is <application>speechd</application> <abbrev>TTS</abbrev>.</para> 2776 </listitem> 2777 </varlistentry> 2778 <varlistentry> 2779 <term><guilabel>Text-to-speech voice</guilabel></term> 2780 <listitem> 2781 <para><action>Allows you to choose</action> a voice for the text-to-speech engine to be used by &okular;. 2782 You can use all languages and voices depending on the available synthesizers on your platform. On &Linux;, 2783 speech-dispatcher is used by default to determine available voices.</para> 2784 </listitem> 2785 </varlistentry> 2786 </variablelist> 2787 </sect1> 2788 <sect1 id="configperformance"> 2789 <title>Performance</title> 2790 <variablelist> 2791 <varlistentry> 2792 <term><guilabel>Enable transparency effects</guilabel></term> 2793 <listitem> 2794 <para>Draw selections and other special graphics using 2795 transparency effects. Disable the option to draw them using 2796 outline or opaque fill styles and increase speed on selections.</para> 2797 </listitem> 2798 </varlistentry> 2799 <varlistentry> 2800 <term><guilabel>Memory usage</guilabel></term> 2801 <listitem> 2802 <para>&okular; can achieve best performance by tuning the memory usage, based on your system and your tastes. 2803 The more memory you let it to use, the faster the program will behave. The Default profile is good 2804 for every system, but you can prevent &okular; from using more memory than necessary by selecting the Low 2805 profile, or let it get the most out of your system using Aggressive. Use Greedy profile to preload all 2806 pages without risk of system memory overfull (only 50% of total memory or free memory will be used).</para> 2807 </listitem> 2808 </varlistentry> 2809 <varlistentry> 2810 <term><guilabel>Rendering options</guilabel></term> 2811 <listitem> 2812 <para>Using this group of options you can improve text and image rendering in &okular;. The result depends on the device to display the document. 2813 <guilabel>Enable Text Antialias</guilabel> and <guilabel>Enable Graphics Antialias</guilabel> items can be used to switch on and off <ulink url="https://en.wikipedia.org/wiki/Spatial_anti-aliasing">spatial anti-aliasing</ulink> of text and images in document, correspondingly. 2814 <guilabel>Enable Text Hinting</guilabel> item is meant to be a switcher for <ulink url="https://en.wikipedia.org/wiki/Font_hinting">font hinting</ulink>. 2815 Antialiasing and hinting change how the documents are displayed, you may want to tweak them to your preference.</para> 2816 </listitem> 2817 </varlistentry> 2818 </variablelist> 2819 </sect1> 2820 <sect1 id="configpresentation"> 2821 <title>Presentation</title> 2822 <variablelist> 2823 <varlistentry> 2824 <term><guilabel>Advance every</guilabel></term> 2825 <listitem> 2826 <para>Enables automatic advancing of pages given a time period.</para> 2827 </listitem> 2828 </varlistentry> 2829 <varlistentry> 2830 <term><guilabel>Loop after last page</guilabel></term> 2831 <listitem> 2832 <para>When navigating on presentation mode and going past the last page the first page will appear.</para> 2833 </listitem> 2834 </varlistentry> 2835 <varlistentry> 2836 <term><guilabel>Touch navigation</guilabel></term> 2837 <listitem> 2838 <para>Allows you to fine-tune touchscreen navigation with tapping in the presentation using the following three possible values:</para> 2839 <itemizedlist> 2840 <listitem> 2841 <para><guilabel>Tap left/right side to go back/forward</guilabel>: Tapping on the left (right) half of the screen makes the presentation go to the previous (next) slide.</para> 2842 </listitem> 2843 <listitem> 2844 <para><guilabel>Tap anywhere to go forward</guilabel> (default): Tapping on the screen makes the presentation go to the next slide, no matter where the screen is being tapped.</para> 2845 </listitem> 2846 <listitem> 2847 <para><guilabel>Disabled</guilabel>: Screen tapping does not do anything.</para> 2848 </listitem> 2849 </itemizedlist> 2850 </listitem> 2851 </varlistentry> 2852 <varlistentry> 2853 <term><guilabel>Background color</guilabel></term> 2854 <listitem> 2855 <para>The color that will fill the part of the screen not covered by the page when on presentation mode.</para> 2856 </listitem> 2857 </varlistentry> 2858 <varlistentry> 2859 <term><guilabel>Mouse cursor</guilabel></term> 2860 <listitem> 2861 <para>Whether the mouse should be always hidden, always shown or hidden after a small time of inactivity.</para> 2862 </listitem> 2863 </varlistentry> 2864 <varlistentry> 2865 <term><guilabel>Show progress indicator</guilabel></term> 2866 <listitem> 2867 <para>Whether to show a progress circle that shows the current page and the total number of pages on the upper 2868 right corner of the presentation screen every time you change the page.</para> 2869 </listitem> 2870 </varlistentry> 2871 <varlistentry> 2872 <term><guilabel>Show summary page</guilabel></term> 2873 <listitem> 2874 <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> 2875 </listitem> 2876 </varlistentry> 2877 <varlistentry> 2878 <term><guilabel>Enable transitions</guilabel></term> 2879 <listitem> 2880 <para>Use this check box to enable or disable transition effects between pages.</para> 2881 </listitem> 2882 </varlistentry> 2883 <varlistentry> 2884 <term><guilabel>Default transition</guilabel></term> 2885 <listitem> 2886 <para>The transition effect between page and page if the document does not specify one. Set this to <guilabel>Random 2887 Transition</guilabel> to make &okular; randomly choose one of the available effects.</para> 2888 </listitem> 2889 </varlistentry> 2890 <varlistentry> 2891 <term><guilabel>Placement</guilabel></term> 2892 <listitem> 2893 <para>In this section you can select the <guilabel>Screen</guilabel> used to display the presentation.</para> 2894 <para><guilabel>Current Screen</guilabel> is same screen of the &okular; window that starts the presentation mode.</para> 2895 <para><guilabel>Default Screen</guilabel> is the screen marked as default in the xinerama configuration.</para> 2896 <para><guilabel>Screen 0</guilabel>, <guilabel>Screen 1</guilabel> &etc; are the available screens.</para> 2897 </listitem> 2898 </varlistentry> 2899 <varlistentry> 2900 <term><guilabel>Drawing Tool Configuration</guilabel></term> 2901 <listitem> 2902 <para>Manage the colors of the pencil used when drawing on the pages during the presentation mode.</para> 2903 </listitem> 2904 </varlistentry> 2905 </variablelist> 2906 </sect1> 2907 <sect1 id="configannotations"> 2908 <title>Annotations</title> 2909 <screenshot> 2910 <screeninfo>The Annotations page of the configuration dialog</screeninfo> 2911 <mediaobject> 2912 <imageobject> 2913 <imagedata fileref="configure-annotations.png" format="PNG" /> 2914 </imageobject> 2915 <textobject> 2916 <phrase>The Annotations page of the configuration dialog</phrase> 2917 </textobject> 2918 </mediaobject> 2919 </screenshot> 2920 <variablelist> 2921 <varlistentry> 2922 <term><guilabel>Annotation toolbar</guilabel></term> 2923 <listitem> 2924 <para>Allows switching between <guimenuitem>Full Annotation Toolbar</guimenuitem> (<link linkend="annotations-add">default toolbar</link> in the top section of the &okular; window) and <guimenuitem>Quick Annotation Toolbar</guimenuitem> (sliding toolbar with your favorite tools at the right part of the document pane).</para> 2925 </listitem> 2926 </varlistentry> 2927 <varlistentry> 2928 <term><guilabel>Author</guilabel></term> 2929 <listitem> 2930 <para>The author of the contents added on a document. 2931 Default is the name from the <guilabel>Password & User Account</guilabel> page of the &systemsettings; module <guilabel>Account Details</guilabel>.</para> 2932 </listitem> 2933 </varlistentry> 2934 <varlistentry> 2935 <term><guilabel>Annotation tools</guilabel></term> 2936 <listitem> 2937 <para> 2938 This pane is used to configure your <link linkend="annotations-add">annotation toolbar</link>. 2939 </para> 2940 <para> 2941 There are five buttons (<guibutton>Add</guibutton>, <guibutton>Edit</guibutton>, <guibutton>Remove</guibutton>, <guibutton>Move Up</guibutton>, <guibutton>Move Down</guibutton>) and a list box (which lists the contents of the current annotation toolbar) which are used to configure the toolbar. 2942 </para> 2943 <para> 2944 If you need to add some tool button on the toolbar click on the <guibutton>Add</guibutton> button. You can choose the <guilabel>Name</guilabel>, the <guilabel>Type</guilabel> and the <guilabel>Appearance</guilabel> of the created tool. 2945 </para> 2946 <note> 2947 <para> 2948 Please remember that annotation tools in &okular; are highly configurable. For example, you can have two buttons of the same tool but with different color. Do not hesitate to experiment in choosing the button set that is exactly tailored to your workflow. 2949 </para> 2950 </note> 2951 <para> 2952 Click on some item in the list box then click on the corresponding button at the right part of the page to edit, remove, move up or move down the item. The keyboard shortcut of the tool (keys from <keycap>1</keycap> to <keycap>9</keycap>) depends on its position in the list of annotation toolbar. 2953 </para> 2954 </listitem> 2955 </varlistentry> 2956 <varlistentry> 2957 <term>Using Custom Stamps</term> 2958 <listitem> 2959 <orderedlist> 2960 <listitem><para>Create the icon you want to use for your own stamp and save it in any graphics format supported by &okular;</para></listitem> 2961 <listitem><para>Click the <guibutton>Add</guibutton> button, select type <guilabel>Stamp</guilabel> and enter a name for your stamp.</para></listitem> 2962 <listitem><para>Enter the full path to your custom icon into the dropdown box in the <guilabel>Stamp Symbol</guilabel> group</para></listitem> 2963 </orderedlist> 2964 </listitem> 2965 </varlistentry> 2966 </variablelist> 2967 </sect1> 2968 <sect1 id="configeditor"> 2969 <title>Editor</title> 2970 <variablelist> 2971 <varlistentry> 2972 <term><guilabel>Editor</guilabel></term> 2973 <listitem> 2974 <para>Choose the editor you want to launch when &okular; wants to open a source file. 2975 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>). 2976 </para> 2977 <para> 2978 &okular; ships with preconfigured settings for the following editors: <ulink url="https://kate-editor.org/">&kate;</ulink>, <ulink url="https://kile.sourceforge.io/">Kile</ulink>, <ulink url="https://www.scintilla.org/SciTE.html">SciTE</ulink>, <ulink url="https://www.gnu.org/software/emacs/">&Emacs; client</ulink>, <ulink url="https://www.lyx.org/">LyX client</ulink>, <ulink url="https://www.texstudio.org/">TeXstudio</ulink>, and <ulink url="https://github.com/hannah-sten/texify-idea">TeXiFy IDEA</ulink>. 2979 </para> 2980 <note> 2981 <para> 2982 To use inverse search in &kile;, you have to compile your &latex; file with the <guilabel>Modern</guilabel> configuration. 2983 </para> 2984 </note> 2985 </listitem> 2986 </varlistentry> 2987 <varlistentry> 2988 <term><guilabel>Command</guilabel></term> 2989 <listitem> 2990 <para>This is the command and its parameters to invoke the selected editor with the source file of the actual document.</para> 2991 <para>This field will be filled automatically if you use one of the preconfigured editors. Otherwise, please choose <guimenuitem>Custom Text Editor</guimenuitem> in <guilabel>Editor</guilabel> drop down box and refer to the documentation on your favorite editor to find the proper command. 2992 </para> 2993 <para>You can use the following placeholders:</para> 2994 <itemizedlist> 2995 <listitem> 2996 <para>%f - the file name</para> 2997 </listitem> 2998 <listitem> 2999 <para>%l - the line of the file to be reached</para> 3000 </listitem> 3001 <listitem> 3002 <para>%c - the column of the file to be reached</para> 3003 </listitem> 3004 </itemizedlist> 3005 <para>If %f is not specified, then the document name is appended to the specified command.</para> 3006 </listitem> 3007 </varlistentry> 3008 </variablelist> 3009 </sect1> 3010 </chapter> 3011 <chapter id="credits"> 3012 <title>Credits and License</title> 3013 3014 <itemizedlist> 3015 <title>Program Copyright:</title> 3016 <listitem><para>&Albert.Astals.Cid; &Albert.Astals.Cid.mail; Current maintainer</para></listitem> 3017 <listitem><para>Pino Toscano <email>pino@kde.org</email></para></listitem> 3018 <listitem><para>Enrico Ros <email>eros.kde@email.it</email> &kpdf; developer</para></listitem> 3019 </itemizedlist> 3020 3021 <itemizedlist> 3022 <title>Documentation Copyright:</title> 3023 <listitem><para>&Albert.Astals.Cid; &Albert.Astals.Cid.mail; Author</para></listitem> 3024 <listitem><para>Titus Laska <email>titus.laska@gmx.de</email> Some updates and additions</para></listitem> 3025 <listitem><para>Pino Toscano <email>pino@kde.org</email></para></listitem> 3026 </itemizedlist> 3027 <!-- TRANS:CREDIT_FOR_TRANSLATORS --> 3028 &underFDL; 3029 &underGPL; 3030 </chapter> 3031 3032 &documentation.index; 3033 </book> 3034 3035 3036 <!-- 3037 Local Variables: 3038 mode: sgml 3039 sgml-minimize-attributes:nil 3040 sgml-general-insert-case:lower 3041 sgml-indent-step:0 3042 sgml-indent-data:nil 3043 End: 3044 3045 // vim:ts=2:sw=2:tw=78:noet 3046 -->