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