diff --git a/doc/annotation-properties.png b/doc/annotation-properties.png new file mode 100644 index 000000000..ee62fd8c2 Binary files /dev/null and b/doc/annotation-properties.png differ diff --git a/doc/annotations.png b/doc/annotations.png new file mode 100644 index 000000000..f43febac7 Binary files /dev/null and b/doc/annotations.png differ diff --git a/doc/configure.png b/doc/configure.png index c544a2555..b3a31071a 100644 Binary files a/doc/configure.png and b/doc/configure.png differ diff --git a/doc/forms-bar.png b/doc/forms-bar.png new file mode 100644 index 000000000..8540fbf04 Binary files /dev/null and b/doc/forms-bar.png differ diff --git a/doc/index.docbook b/doc/index.docbook index 3cff6192e..c6a63c1bb 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -29,8 +29,8 @@ &FDLNotice; - 2009-05-22 - 0.9 + 2010-09-03 + 0.11 (&kde; 4.5) &okular; is a &kde; universal document viewer based on &kpdf; code. @@ -59,6 +59,23 @@ Although being based on &kpdf; code, &okular; has some unique features such as overview mode, improved presentation support and annotation support. + + &okular; supports a lot of different formats like PDF, Postscript, Tiff, CHM, DjVU, Images (png, jpg, &etc;) + XPS, Open Document (ODT), Fiction Books, Comic Book, Plucker, EPub and Fax. + For all supported formats and their features see + &okular; Document Format Handlers. + + + &okular;s Main Window + + + + + + &okular;s Main Window + + + There are multiple ways of scrolling the viewing area. One is to use the @@ -109,6 +127,15 @@ Add a 'Find Previous' entry enabled, which you can select by choosing ToolsBrowse Tool . + If you want to read a document with several pages use the automatic scrolling feature of &okular;. + Start automatic scrolling with &Shift;Down Arrow or + &Shift;Up Arrow. Then use these keys to increase and + decrease the scrolling speed. You can start or stop automatic scrolling temporarily by pressing the &Shift; key; + pressing any other key deactivates this feature. + + Another way to navigate through a 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. + 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. + The navigation panel on the left side of the screen enables two more ways of navigating through a document: @@ -127,6 +154,14 @@ Add a 'Find Previous' entry item. + + + If the document has bookmarks, enable the Bookmarks view + and click them to go to the associated page. + If bookmarks are not only shown for the current document, you can quickly + switch to bookmarks in all recently opened files. + + Some documents have links. In this case you can click on them and the view will @@ -141,6 +176,17 @@ Add a 'Find Previous' entry + + + You can go to the first page of 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 + . + + @@ -204,6 +263,17 @@ Add a 'Find Previous' entry 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. + + &okular; in Presentation Mode + + + + + + &okular; in Presentation Mode + + + To navigate between pages you may use the &LMB; (next page) and the &RMB; (previous page), the mouse @@ -218,8 +288,8 @@ Add a 'Find Previous' entry You can also draw on the current page with a pencil. Click on the Toggle Drawing Mode icon in the top bar to enable or disable the possibility - of draw in the presentation mode. The drawings are cleared automatically when switching to - another page, or manually selecting the Erase Drawings icon in the top bar. + of draw in the presentation mode. The drawings are cleared automatically when leaving the presentation + mode, switching to another page, or manually selecting the Erase Drawings icon in the top bar. The presentation mode has support for more than one screen in a multi-monitor configuration. @@ -259,6 +329,29 @@ Add a 'Find Previous' entry to extract them. + + Forms + + If the current document has forms, when you open it a bar + will appear above the page view where you can enable the forms. + + + The forms bar + + + + + + The forms bar + + + + + In this case, you can either click on Show Forms in the bar or choose + ViewShow Forms + to enter data into the form fields. + + Annotations @@ -267,6 +360,23 @@ Add a 'Find Previous' entry for each user. &okular; does not implicitly change any document it opens. + + &okular;'s Annotations + + + + + + &okular;'s Annotations + + + + &okular; has two different kind of annotations: + Text annotations like Yellow Highlighter and Black Underlining + for files with text like ⪚ PDF. + Graphic annotations like Note, Inline Note, Green Freehand Line, Straight Yellow Line, Blue Polygon, Stamp and Cyan Ellipse for all formats supported by &okular;. + Using the context menu either in the Reviews view of the navigation panel or in the main window you can open a Pop up Note for any kind of annotation and add or edit comments. + Annotations are not only limited to PDF files, they can be used for any format &okular; supports. Since &kde; 4.2, &okular; has the "document archiving" feature. This is an &okular;-specific format for carrying the document plus various metadata related to it (currently only annotations). You can save a "document archive" from the open document by choosing FileExport AsDocument Archive. To open an &okular; document archive, just open it with &okular; as it would be ⪚ a &PDF; document. @@ -293,7 +403,7 @@ Add a 'Find Previous' entry - Activating the annotating toolbar will make you switch to the Normal Mode. + Activating the annotating toolbar will make you switch to the Browse Tool Mode. @@ -330,6 +440,17 @@ Add a 'Find Previous' entry annotation settings (like color and opacity, author, &etc;) and the settings specific to that annotation type. + + Annotation Property Dialog + + + + + + Annotation Property Dialog + + + To move an annotation, hold down the &Ctrl; key, move the mouse pointer on it and then start dragging with the &LMB;. @@ -348,7 +469,7 @@ Add a 'Find Previous' entry The Menubar - The <guimenu>File</guimenu> Menu + The File Menu @@ -419,7 +540,7 @@ Add a 'Find Previous' entry - Save the currently open file under a different name using the document backend. With the &PDF; backend (Poppler >= 0.8 required) it is possible to save the document with the changed values of the form fields. + Save the currently open file under a different name using the document backend. With the &PDF; backend (Poppler >= 0.8 required) it is possible to save the document with the changed values of the form fields. @@ -536,7 +657,7 @@ Add a 'Find Previous' entry - The <guimenu>Edit</guimenu> Menu + The Edit Menu @@ -615,7 +736,7 @@ Add a 'Find Previous' entry - The <guimenu>View</guimenu> Menu + The View Menu @@ -706,7 +827,8 @@ Add a 'Find Previous' entry This submenu makes you choose the view mode for the pages. The possible options are: Single Page (only one page per row), - Facing Pages (two pages per row, in a book style) and + Facing Pages (two pages per row, in a book style), + Facing Pages (Center First Page) and Overview (the number of columns is the one specified in the &okular; settings). @@ -788,15 +910,15 @@ Add a 'Find Previous' entry + - The <guimenu>Go</guimenu> Menu + The Go Menu - &Backspace; Go Previous Page @@ -808,7 +930,6 @@ Add a 'Find Previous' entry - Space Go Next Page @@ -823,10 +944,12 @@ Add a 'Find Previous' entry &Ctrl;Home Go First Page + Go to the first page of the document. + @@ -835,15 +958,18 @@ Add a 'Find Previous' entry &Ctrl;End Go Last Page + Go to the last page of the document. + + &Alt;&Shift;Left Go Back in the Document @@ -855,6 +981,7 @@ Add a 'Find Previous' entry + &Alt;&Shift;Right Go Forward in the Document @@ -879,7 +1006,7 @@ Add a 'Find Previous' entry - The <guimenu>Bookmarks</guimenu> Menu + The Bookmarks Menu @@ -936,7 +1063,7 @@ Add a 'Find Previous' entry - The <guimenu>Tools</guimenu> Menu + The Tools Menu @@ -1022,15 +1149,15 @@ Add a 'Find Previous' entry - These items allow you to speak the whole document or just the current page and stop speaking using the &kde; Text-to-Speech system KTTS. - The Speak ... actions are enabled only if KTTS is available in the system. + These items allow you to speak the whole document or just the current page and stop speaking using the &kde; Text-to-Speech system Jovie. + The Speak ... actions are enabled only if &jovie; is available in the system. - The <guimenu>Settings</guimenu> Menu + The Settings Menu @@ -1137,7 +1264,7 @@ Add a 'Find Previous' entry - The <guimenu>Help</guimenu> Menu + The Help Menu &help.menu.documentation; @@ -1238,13 +1365,13 @@ Add a 'Find Previous' entry use the backend with the highest priority. - + Overview columns @@ -1400,7 +1527,8 @@ Add a 'Find Previous' entry Author - The author of the contents added on a document. + The author of the contents added on a document. + Default is the name from the Password & User Account page of the &systemsettings; module Account Details. diff --git a/doc/mainwindow.png b/doc/mainwindow.png new file mode 100644 index 000000000..abddeae55 Binary files /dev/null and b/doc/mainwindow.png differ diff --git a/doc/presentation.png b/doc/presentation.png new file mode 100644 index 000000000..d87a60126 Binary files /dev/null and b/doc/presentation.png differ