wilderjds
/
okular
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- kpdf -> okular conversions

Browse Source 
- some updates to reflect the current okular status

svn path=/trunk/playground/graphics/doc/okular/; revision=596096
remotes/origin/KDE/4.0
Pino Toscano 20 years ago
parent 2b1aea502f
commit 3b984a06aa
1 changed files with 196 additions and 50 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 244
      doc/index.docbook

244
doc/index.docbook
Unescape View File

@ -1,21 +1,22 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kpdf "<application>KPDF</application>">
<!ENTITY kappname "&kpdf;">
<!ENTITY okular "<application>okular</application>">
<!ENTITY kappname "&okular;">
<!ENTITY package "kdegraphics">
<!ENTITY kpdf "<application>KPDF</application>">
<!ENTITY % English "INCLUDE">
<!ENTITY % addindex "IGNORE">
]>
<book lang="&language;">
<bookinfo>
<title>The &kpdf; Handbook</title>
<title>The &okular; Handbook</title>
<authorgroup>
<author>
<firstname>Albert</firstname>
<surname>Astals Cid</surname>
<affiliation>
<address><email>tsdgeos@yahoo.es</email></address>
<address><email>aacid@kde.org</email></address>
</affiliation>
</author>
<author>
@ -25,55 +26,68 @@
<address><email>titus.laska@gmx.de</email></address>
</affiliation>
</author>
<author>
<firstname>Pino</firstname>
<surname>Toscano</surname>
<affiliation>
<address><email>pino@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<legalnotice>&FDLNotice;</legalnotice>
<date>2006-05-20</date>
<releaseinfo>0.5</releaseinfo>
<date>2006-10-16</date>
<releaseinfo>0.5.81</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>&kpdf; is a &kde; PDF viewer based on xpdf code.</para>
<para>&okular; is a &kde; universal document viewer based on &kpdf; code.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>kpdf</keyword>
<keyword>okular</keyword>
<keyword>pdf</keyword>
<keyword>ps</keyword>
<keyword>tiff</keyword>
<keyword>djvu</keyword>
<keyword>dvi</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>&kpdf; is a &kde; <firstterm>PDF</firstterm> (Portable Document Format) viewer
based on the code of the xpdf application. Although being based on xpdf code, &kpdf;
has some unique features such as continuous mode and presentation support.
<para>&okular; is a &kde; univeral document viewer based on the code of the &kpdf; application.
Although being based on &kpdf; code, &okular; has some unique features such as overview mode,
improved presentation support and annotation support.
</para>
<!--
<para>
The PDF format is widely used for publishing documents that are
mostly not meant to be edited again. &kpdf; is only a viewer
mostly not meant to be edited again. &okular; is only a viewer
for these files and therefore it doesn't provide any functionality
to edit or create PDF documents.
</para>
-->
</chapter>
<chapter id="use">
<title>Using &kpdf;</title>
<title>Using &okular;</title>
<sect1 id="opening">
<title>Opening Files</title>
<para>
To view a PDF file in &kpdf;, select <menuchoice><guimenu>File</guimenu><guimenuitem>Open...
</guimenuitem></menuchoice>, choose a PDF or PS file in the dialogue and click <guibutton>Open</guibutton>.
To view any supported file in &okular;, select <menuchoice><guimenu>File</guimenu><guimenuitem>Open...
</guimenuitem></menuchoice>, choose a supported file in the dialogue and click <guibutton>Open</guibutton>.
Your file should now be displayed in the main window.
</para>
<para>
If you have already opened files in &kpdf; before, you can quickly access them by selecting them in
If you have already opened files in &okular; before, you can quickly access them by selecting them in
the <menuchoice><guimenu>File</guimenu><guisubmenu>Open Recent</guisubmenu></menuchoice> menu.
</para>
<para>
After having a file opened you probably want to read it and therefore navigate through it. Click
Next to learn more about this.
After having a file opened you probably want to read it and therefore navigate through it. Go to the
<link linkend="navigating">next section</link> to learn more about this.
</para>
</sect1>
<sect1 id="navigating">
<title>Navigating</title>
<para>This section describes how you can navigate through a document in &kpdf;.</para>
<para>This section describes how you can navigate through a document in &okular;.</para>
<para>
There are multiple ways of scrolling the viewing area. One is to use the
<keycap>Up Arrow</keycap> and <keycap>Down Arrow</keycap> keys. You may also use
@ -107,7 +121,7 @@
</itemizedlist>
<para>
Some documents have links. In this case you can click on them and the view will
change to the page it links to. If the link is to a web page the default
change to the page it links to. If the link is to a web page the default &kde;
browser will be invoked.
</para>
<para>
@ -164,7 +178,7 @@
<sect1 id="presentationMode">
<title>Presentation Mode</title>
<para>
The Presentation mode represents another way to view PDF documents in &kpdf;. It can be
The Presentation mode represents another way to view documents in &okular;. It can be
enabled in
<menuchoice><guimenu>View</guimenu><guimenuitem>Presentation</guimenuitem></menuchoice>.
It shows the document on a page per page basis. The pages are shown with
@ -175,21 +189,24 @@
PDF documents can even specify that they are always opened in presentation mode.
</para>
</note>
<para>
When in presentation mode, you have an helper bar located on the top of the screen. Just move
the mouse cursor to the top of the screen to make it appear.
</para>
<para>
To navigate between
pages you may use the &LMB; (next page) and the &RMB; (previous page), the mouse
wheel, the arrow icons that appear as soon as you move the mouse cursor to the top of the screen,
wheel, the arrow icons or the line edit in the top bar,
or the keys specified in the <link linkend="navigating">Navigating</link>
section.
</para>
<para>
You can exit presentation mode at any time by pressing the <keycap>ESC</keycap> key or clicking
the <guiicon>Quit</guiicon> icon appearing if you move the mouse cursor to the top of the
screen.
the <guiicon>Quit</guiicon> icon in the top bar.
</para>
<para>
Presentation mode has some configuration options, you can find their
description at <link linkend="configpresentation">Configuring &kpdf;</link>.
description at <link linkend="configpresentation">Configuring &okular;</link>.
</para>
</sect1>
</chapter>
@ -212,7 +229,7 @@
</term>
<listitem>
<para>
<action>Open</action> a PDF or PS file. If there is already an opened file it will be closed.
<action>Open</action> a supported file. If there is already an opened file it will be closed.
For more information, see the section about <link linkend="opening">Opening Files</link>.
</para>
</listitem>
@ -286,7 +303,8 @@
</term>
<listitem>
<para><action>Display some basic information</action> about the document, such as
title, author, creation date, and details about the fonts used.</para>
title, author, creation date, and details about the fonts used. The available information
depends on the type of document.</para>
</listitem>
</varlistentry>
@ -299,7 +317,7 @@
</menuchoice>
</term>
<listitem>
<para><action>Close</action> &kpdf;.</para>
<para><action>Close</action> &okular;.</para>
</listitem>
</varlistentry>
</variablelist>
@ -423,12 +441,43 @@
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Two Pages</guimenuitem>
<guimenuitem>Render Mode</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Enable the two page mode</action>, which shows two pages of
the document next to each other..</para>
<para>This submenu makes you choose the view mode for the pages. The possible
options are: <guimenuitem>Single</guimenuitem> (only one page per row),
<guimenuitem>Facing</guimenuitem> (two pages per row, in a book style) and
<guimenuitem>Overview</guimenuitem> (the number of columns is the one
specified in the <link linkend="configure">&okular; settings</link>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Orientation</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Changes the orientation</action> of the pages of the
document.</para>
<note><para>The rotation is applied to the orientation of every
page.</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</guimenu>
<guimenuitem>Paper sizes</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Changes the size of the paper</action> fo the pages of the
document.</para>
<note><para>This submenu is active only if the current type of document
supports different paper sizes.</para></note>
</listitem>
</varlistentry>
</variablelist>
@ -509,6 +558,32 @@
<para><action>Move forward to the next view</action> of the document. This only works if you have already moved back before.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Alt; <keycap>Left</keycap></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Previous Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go to the previous bookmarked page</action>, or do nothing if there
are no bookmarked pages prior to the current one.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">&Alt;<keycap>Right</keycap></keycombo></shortcut>
<guimenu>Go</guimenu>
<guimenuitem>Next Bookmark</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Go to the next bookmarked page</action>, or do nothing if there
are no bookmarked pages after the current one.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
@ -560,6 +635,31 @@
<para>The mouse will work as a select tool. In that mode clicking &LMB; and dragging will give the option of copying the text/image of current the selected area to the clipboard, speak a text or to save an image to a file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Text Selection Tool</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The mouse will work as a text selection tool. In that mode clicking &LMB; and
dragging will give the option of selecting the text of the document. Then, just
click with the &RMB; to copy to the clipboard or speak the current selection.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Tools</guimenu>
<guimenuitem>Review</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Open the review toolbar</action>. The review toolbar allows you to add
annotations on the document you are reading.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
@ -646,7 +746,7 @@
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &kpdf;...</guimenuitem>
<guimenuitem>Configure &okular;...</guimenuitem>
</menuchoice>
</term>
<listitem>
@ -654,6 +754,18 @@
window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Backends...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>Opens the <link linkend="configure">Backend Configuration</link>
window.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
@ -664,12 +776,12 @@
</chapter>
<chapter id="configure">
<title>Configuring &kpdf;</title>
<title>Configuring &okular;</title>
<sect1 id="configindex">
<title>Overview</title>
<title>General configuration</title>
<para>
You can configure &kpdf; by choosing <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &kpdf;...</guimenuitem></menuchoice>.
You can configure &okular; by choosing <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &okular;...</guimenuitem></menuchoice>.
The configuration dialogue is split into four sections. This chapter describes the available
options in detail.
</para>
@ -698,10 +810,22 @@
</textobject>
</mediaobject>
</screenshot>
<para>
Depending on the current installed plugins, the <menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Backends...</guimenuitem></menuchoice> menu item could be enabled.
This particular configuration dialogue holds the configurations of the plugins that can
actually be configured.
</para>
</sect1>
<sect1 id="configgeneral">
<title>General</title>
<variablelist>
<varlistentry>
<term>Show scrollbars</term>
<listitem>
<para>Whether to show scrollbars for the document view.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Show search bar in thumbnails list</term>
<listitem>
@ -718,22 +842,27 @@
</listitem>
</varlistentry>
<varlistentry>
<term>Show scrollbars</term>
<term>Show hints and info messages</term>
<listitem>
<para>Whether to show scrollbars for the document view.</para>
<para>Whether to show some informative messages on startup, file
load, &etc;.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Show hints and info messages</term>
<term>Center first page in facing mode</term>
<listitem>
<para>Whether to show some informative messages on startup, file
load, etc.</para>
<para>Whether the first page should be centered or aligned to the right when
displaying the pages in facing mode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Obey DRM limitations</term>
<listitem>
<para>Whether &kpdf; should obey <firstterm>DRM</firstterm> (Digital Rights Management) restrictions. DRM limitations are used to make it impossible to perform certain actions with PDF documents, such as copying content to the clipboard. Note that in some configurations of &kpdf;, this option is not available.</para>
<para>Whether &okular; should obey <firstterm>DRM</firstterm>
(Digital Rights Management) restrictions. DRM limitations are used
to make it impossible to perform certain actions with PDF documents,
such as copying content to the clipboard. Note that in some configurations
of &okular;, this option is not available.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -743,6 +872,21 @@
changes and updated, if necessary.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Show generator selection dialog</term>
<listitem>
<para>Whether &okular; should ask the user which generator to use in case of more
than one generator able to open the current file. If unchecked, &okular; will
use the generaor with the highest priority.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Overview rows/columns</term>
<listitem>
<para>These options represent the number of rows and columns to use in the overview
mode.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="configaccessibility">
@ -818,9 +962,9 @@
<varlistentry>
<term>Memory usage profiles</term>
<listitem>
<para>&kpdf; can achieve best performance by tuning the memory usage, based on your system and your tastes.
<para>&okular; can achieve best performance by tuning the memory usage, based on your system and your tastes.
The more memory you let it to use, the faster the program will behave. The Default profile is good
for every system, but you can prevent &kpdf; from using more memory than necessary by selecting the Low
for every system, but you can prevent &okular; from using more memory than necessary by selecting the Low
profile, or let it get the most out of your system using Aggressive.</para>
</listitem>
</varlistentry>
@ -851,7 +995,7 @@
<term>Default transition</term>
<listitem>
<para>The transition effect between page and page if the document does not specify one. Set this to <guilabel>Random
Transition</guilabel> to make &kpdf; randomly choose one of the available effects.</para>
Transition</guilabel> to make &okular; randomly choose one of the available effects.</para>
</listitem>
</varlistentry>
<varlistentry>
@ -881,7 +1025,8 @@
<itemizedlist>
<title>Program Copyright:</title>
<listitem><para>Albert Astals Cid<email>tsdgeos@yahoo.es</email> Current maintainer</para></listitem>
<listitem><para>Albert Astals Cid<email>aacid@kde.org</email> Current maintainer</para></listitem>
<listitem><para>Pino Toscano <email>pino@kde.org</email></para></listitem>
<listitem><para>Christophe Devriese<email>oelewapperke@ulyssis.org</email></para></listitem>
<listitem><para>&Wilco.Greven; &Wilco.Greven.mail; Original author</para></listitem>
<listitem><para>Enrico Ros<email>eros.kde@email.it</email> Refactoring for 3.4</para></listitem>
@ -890,8 +1035,9 @@
<itemizedlist>
<title>Documentation Copyright:</title>
<listitem><para>Albert Astals Cid<email>tsdgeos@yahoo.es</email> Author</para></listitem>
<listitem><para>Albert Astals Cid<email>aacid@kde.org</email> Author</para></listitem>
<listitem><para>Titus Laska<email>titus.laska@gmx.de</email> Some updates and additions</para></listitem>
<listitem><para>Pino Toscano <email>pino@kde.org</email></para></listitem>
</itemizedlist>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
@ -901,14 +1047,14 @@
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-kapp">
<title>How to obtain &kpdf;</title>
<title>How to obtain &okular;</title>
&install.intro.documentation;
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
<note>
<para>
If you are reading this help in the &khelpcenter;, &kpdf; has already been
If you are reading this help in the &khelpcenter;, &okular; has already been
installed on this system and you do not need install it anymore.
</para>
</note>

Write Preview
Loading…
Cancel
Save