diff --git a/doc/configure.png b/doc/configure.png new file mode 100644 index 000000000..bbe89d9f2 Binary files /dev/null and b/doc/configure.png differ diff --git a/doc/index.docbook b/doc/index.docbook index 8a41b7ae3..2498d7615 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -18,11 +18,18 @@
tsdgeos@yahoo.es
+ + Titus + Laska + +
titus.laska@gmx.de
+ + &FDLNotice; - 2005-02-20 - 1.0 + 2005-12-10 + 0.5 &kpdf; is a &kde; PDF viewer based on xpdf code. @@ -35,91 +42,162 @@ Introduction - &kpdf; is a &kde; PDF viewer based on xpdf code. Although being - based on xpdf code, &kpdf; has some unique features like continuous - mode, presentation support, etc. - - - Navigating - This section describes how you can navigate a document in &kpdf;. - - You can scroll up and down the viewing area with the - Up Arrow and Down Arrow keys, using the - mouse wheel, pressing &LMB; and dragging while in normal mode or using - Page Up and Page Down keys. - - - If you click on a page thumbnail the viewing area will be brought to - that page. - - - If the document has a table of contents, clicking on a table - of contents item will bring the document to to the page linked to that - item. - - - If the document has links in it, 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 - browser will be invoked. - - - You can go to the first page of the document using - &Ctrl;Home or - using - - Go - First Page - . - - - You can go to the last page of the document using - &Ctrl;End or - using - - Go - Last Page - . - - - You can go to the next page of the document using - Space, the Next Page Toolbar - button or using - - Go - Next Page - . + &kpdf; is a &kde; PDF (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. - You can go to the previous page of the document using - Backspace, the Previous Page Toolbar - button or using - - Go - Previous Page - . + The PDF format is widely used for publishing documents that are + mostly not meant to be edited again. &kpdf; is only a viewer + for these files and therefore it doesn't provide any functionality + to edit or create PDF documents. - - Presentation Mode - - Presentation mode can be enabled in - ViewPresentation. - It shows the document in a page per page basis. The pages are shown with - zoom to page, that means all the page is visible. To navigate between - pages you have to use &LMB; (next page) and &RMB; (previous page). You - can exit presentation mode using ESC key. - - - Presentation mode has a few configuration options, you can find their - meaning at Configuring &kpdf; - + + Using &kpdf; + + Opening Files + + To view a PDF file in &kpdf;, select FileOpen... + , choose a file in the dialogue and click Open. + As long as you selected a valid PDF file, your file should know be displayed in the main window. + + + If you have already opened files in &kpdf; before, you can quickly access them by selecting them in + the FileOpen Recent menu. + + + After having a file opened you probably want to read it and therefore navigate through it. Click + Next to learn more about this. + + + + Navigating + This section describes how you can navigate through a document in &kpdf;. + + There are multiple ways of scrolling the viewing area. One is to use the + Up Arrow and Down Arrow keys. You may also use + the scrollbar, your mousewheel or the Page Up and Page Down + keys. + + + Another way is to hold the &LMB; down at any place on the document while dragging the mouse in the + opposite direction of where you want to move. This procedure only works if the Browse Tool is + enabled, which you can select by choosing ToolsBrowse Tool + . + + + The navigation panel on the left side of the screen enables two more ways of navigating + through a document: + + + + + If you click on a page thumbnail the viewing area will be brought to + that page. + + + + + If the document has a table of contents, clicking on a table + of contents item will bring the document to to the page linked to that + item. + + + + + 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 + browser will be invoked. + + + Additionally, you may use the following functionality to quickly move to specific places + in the document: + + + + + You can go to the first page of the document using + &Ctrl;Home or + using + + Go + First Page + . + + + + + You can go to the last page of the document using + &Ctrl;End or + using + + Go + Last Page + . + + + + + You can go to the next page of the document using + Space, the Next Page Toolbar + button or using + + Go + Next Page + . + + + + + You can go to the previous page of the document using + Backspace, the Previous Page Toolbar + button or using + + Go + Previous Page + . + + + + + + Presentation Mode + + The Presentation mode represents another way to view PDF documents in &kpdf;. It can be + enabled in + ViewPresentation. + It shows the document on a page per page basis. The pages are shown with + zoom to page, that means all the page is visible. + + + + PDF documents can even specify that they are always opened in presentation mode. + + + + 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 to the top of the screen, + or the keys specified in the Navigating + section. + + + You can exit presentation mode at any time by pressing the ESC key or clicking + the Quit icon appearing if you move the mouse to the top of the + screen. + + + Presentation mode has some configuration options, you can find their + description at Configuring &kpdf;. + + The Menubar - - The <guimenu>File</guimenu> Menu + <guimenu>File</guimenu> Menu @@ -133,7 +211,8 @@ - Open a file. If a file is currently being displayed it will be closed. + Open a PDF file. If there is already an opened file it will be closed. + For more information, see the section about Opening Files. @@ -147,9 +226,10 @@ - Open a file selected from a combo box list of - recently opened files. If a file is currently being displayed it - will be closed. + Open a file which was used previously from a + submenu. If a file is currently being displayed it + will be closed. For more information, see the section about + Opening Files. @@ -162,7 +242,7 @@ - Save the currently open file. + Save the currently open file under a different name. @@ -190,8 +270,8 @@ - Shows a preview of how the currently displayed - document will print with the default options. + Show a preview of how the currently displayed + document would be printed with the default options. @@ -204,7 +284,8 @@ - Display some basic information about the document. + Display some basic information about the document, such as + title, author, creation date, and details about the fonts used. @@ -222,9 +303,8 @@ - - The <guimenu>Edit</guimenu> Menu + <guimenu>Edit</guimenu> Menu @@ -235,7 +315,8 @@ - Finds a string in the document text. + Open a dialogue that allows you to search for a string in + the document. @@ -248,14 +329,13 @@ - Finds the previous searched string again. + Try to find the previous searched string again in the document. - - The <guimenu>View</guimenu> Menu + <guimenu>View</guimenu> Menu @@ -266,8 +346,8 @@ - Activates the presentation mode. + Activates the Presentation Mode. For more information, see the + section about Presentation Mode. @@ -303,8 +383,9 @@ - Changes the magnification of the document - view so that the pages width fill all the view space. + Change the magnification of the document + view to a value that makes the pages' width equal to the document + view's width. @@ -315,8 +396,8 @@ - Changes the magnification of the document view - so that the pages fits completely on the view space. + Change the magnification of the document view + to a value that makes at least one whole page visible. @@ -327,7 +408,12 @@ - Enables the continuous page mode. + Enable the continuous page mode. In continuos mode, + all pages of the document are shown, and you can scroll through + them without having to use the Go + Previous Page and + GoNext Page + options. @@ -338,14 +424,14 @@ - Enables the two page mode. + Enable the two page mode, which shows two pages of + the document next to each other.. - - The <guimenu>Go</guimenu> Menu + <guimenu>Go</guimenu> Menu @@ -356,7 +442,7 @@ - View the previous page of the document. + View the previous page of the document. @@ -368,8 +454,8 @@ - View the next page of the document. - + View the next page of the document. + @@ -404,38 +490,37 @@ - Go to the page displayed before. + Go back to the previous view of the document. - &Alt;Right + &Alt; Right Go Forward - + - Go to the page of the document where you were after. + Move forward to the next view of the document. This only works if you have already moved back before. - &Ctrl;G + &Ctrl; G Go - Go to Page - + Go to Page... + - Go to a selected page of the document. + Open a dialog which allows you to go to any page of the document. - - The <guimenu>Tools</guimenu> Menu + <guimenu>Tools</guimenu> Menu @@ -467,19 +552,18 @@ - 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, images can be saved to a file too. + 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, or to save it to a file. - - The <guimenu>Settings</guimenu> Menu + <guimenu>Settings</guimenu> Menu - &Ctrl;M + &Ctrl; M Settings Show/Hide Menubar @@ -503,27 +587,27 @@ - &Ctrl;L + &Ctrl; L Settings Show/Hide Navigation Panel - Toggle the Navigation Panel display on and off. + Toggle the navigation panel on and off. - &Ctrl;&Shift;F + &Ctrl; &Shift; F Settings Full Screen Mode - Enables the full screen mode. Note that + Enables the full screen mode. Note that full screen mode is different from presentation mode as the + linkend="presentationMode">presentation mode insofar as the only peculiarity of full screen mode is that it hides the window decorations, the menubar and the toolbar. @@ -536,8 +620,8 @@ - Opens a window that lets you configure the keyboard - shortcuts for many menu commands. + Opens a window that lets you configure the keyboard + shortcuts for many menu commands. @@ -560,7 +644,7 @@ - Opens the Configure + Opens the Configure window. @@ -571,23 +655,50 @@ <guimenu>Help</guimenu> Menu &help.menu.documentation; - - + Configuring &kpdf; - + + Overview + + You can configure &kpdf; by choosing Settings + Configure &kpdf;.... + The configuration dialogue is split into four sections. This chapter describes the available + options in detail. + + + + General + + + Accessibility + + + Performance + + + Presentation + + + + The configuration dialogue + + + + + + The configuration dialogue + + + + + General - Show left panel - - Whether to show the left panel. - - - - Show search bar in thumbnails view + Show search bar in thumbnails list - Whether to show search bar in thumbnails view or not. That + Whether to the show a search bar in the thumbnails view or not. That search bar is useful for filtering pages that contain a given string. @@ -595,14 +706,14 @@ Link thumbnails list with the page - Whether the thumbnails view will always show the current + Whether the thumbnails view should always display the current page or not. Show scrollbars - Whether to show scrollbars. + Whether to show scrollbars for the document view. @@ -612,9 +723,22 @@ load, etc. + + Obey DRM limitations + + Whether &kpdf; should obey DRM (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. + + + + Watch file + + Whether opened files should be automatically checked for + changes and updated, if necessary. + + - + Accessibility @@ -638,30 +762,34 @@ Invert colors - Inverts colors on the view, &ie; black things will be shown white. + Inverts colors on the view, &ie; black objects will be shown white. Change paper color - Changes paper color. + Changes the paper's color, &ie; the document's background. Change dark and light colors - Changes the dark and light color, that means black will not be rendered as black but as the dark color and the same for white. + Changes the dark and light color to your preference, that means + black will not be rendered as black but as the selected dark color and white + will not be rendered as white but as the selected light color. Convert to black and white - Converts the document to black and white. + Converts the document to black and white. You can set the + threshold and the contrast. Setting the threshold to a higher value + will result in darker grays used. - + Performance @@ -676,7 +804,7 @@ Enable background generation Use a background thread to generate the pages. By disabling - this option the &GUI; will become less reactive (will be blocked + this option the user interface will become less reactive (will be blocked if necessary), but pages will be displayed a bit faster. @@ -691,13 +819,13 @@ - + Presentation Advance every - Enables auto advancing of pages given a time period. + Enables automatic advancing of pages given a time period. @@ -715,7 +843,8 @@ Default transition - The transition between page and page if the document does not specify one. + The transition effect between page and page if the document does not specify one. Set this to Random + Transition to make &kpdf; randomly choose one of the available effects. @@ -727,7 +856,8 @@ Show progress indicator - Whether to show a progress circle that shows the current page and the total number of pages on the upper right corner. + Whether to show a progress circle that shows the current page and the total number of pages on the upper + right corner of the presentation screen everytime you change the page. @@ -748,15 +878,41 @@ Christophe Devrieseoelewapperke@ulyssis.org &Wilco.Greven; Wilco.Greven.mail; Original author Enrico Roseros.kde@email.it Refactoring for 3.4 + Laurent Montelmontel@kde.org + + &underGPL; + + + Documentation Copyright: + Albert Astals Cidtsdgeos@yahoo.es Author + Titus Laskatitus.laska@gmx.de Some updates and additions - &underFDL; &underGPL; + + + Installation + + How to obtain &kpdf; + &install.intro.documentation; + + + Compilation and Installation + + + If you are reading this help in the &khelpcenter;, &kpdf; has already been + installed on this system and you do not need install it anymore. + + + &install.compile.documentation; + + &documentation.index; +