← Back to branch summary

~ubuntu-branches/debian/sid/qpdfview/sid

« back to all changes in this revision

Viewing changes to miscellaneous/help.html

  • Committer: Package Import Robot
  • Author(s): Benjamin Eltzner
  • Date: 2012-09-02 15:18:34 UTC
  • mfrom: (1.2.1) (4.1.1 experimental)
  • Revision ID: package-import@ubuntu.com-20120902151834-xa61s2fuphrrdwxs
Tags: 0.3.3-1
http://bugs.debian.org/685599
* Fixed some rendering artifacts.
* Improved navigation using bookmarks.
* Reorganized settings dialog and made keyboard modifiers for several mouse
  actions configurable.
* Added menu and tool bar actions to copy texts or images or add annotations.
* Added Ukrainian translation. Thanks to Vladimir Smolyar.
* Updated Slovak translation. Thanks to DAG Software.
* Updated Czech translation. Thanks to Pavel Fric.
* Updated Russian translation. Thanks to Eugene Marshal and Vladimir Smolyar.
* Added MIME file. (Closes: #685599)

Show diffs side-by-side

added added

removed removed

Lines of Context:
miscellaneous/help.html
39
39
        <li><a href="#file">File</a></li>
40
40
        <li><a href="#edit">Edit</a></li>
41
41
        <li><a href="#view">View</a></li>
42
 
        <li><a href="#tab">Tab</a></li>
 
42
        <li><a href="#tabs">Tabs</a></li>
 
43
        <li><a href="#bookmarks">Bookmarks</a></li>
43
44
        <li><a href="#help">Help</a></li>
44
45
    </ol>
45
46
    <li><a href="#mainview">Main view</a></li>
46
 
    <ol>
47
 
        <li><a href="#mousewheel">Mouse wheel</a></li>
48
 
        <li><a href="#selections">Selections</a></li>
49
 
        <li><a href="#links">Links</a></li>
50
 
        <li><a href="#bookmarks">Bookmarks</a></li>
51
 
    </ol>
52
47
    <li><a href="#auxiliaryviews">Auxiliary views</a></li>
53
 
    <ol>
54
 
        <li><a href="#outline">Outline</a></li>
55
 
        <li><a href="#metainformation">Meta-information</a></li>
56
 
        <li><a href="#thumbnails">Thumbnails</a></li>
57
 
    </ol>
58
 
    <li><a href="#commandlineoptions">Command-line options</a></li>
59
 
    <li><a href="#configurationfile">Configuration file</a></li>
 
48
    <li><a href="#settings">Settings</a></li>
60
49
</ol>
61
50
 
62
51
<h4>Introduction</h4>
63
52
 
64
 
<p><em>qpdfview</em> is a viewer for document files in the portable document format (PDF). It uses the Poppler library for rendering and the Qt toolkit for its interface. It supports displaying several documents in separate tabs in the same window.</p>
 
53
<p><em>qpdfview</em> is a simple viewer for document files in the portable document format (PDF). It uses the Poppler library for rendering and the Qt toolkit for its interface.</p>
 
54
 
 
55
<p>Refer to the manual page for information on command-line options and configuration files.</p>
65
56
 
66
57
<h3><a name="mainmenu">Main menu</a> <a href="#top">&uarr;</a></h3>
67
58
 
69
60
 
70
61
<ul>
71
62
        <li><b>Open...</b> Opens a dialogue to choose a file to open in the current tab. If there is no tab, the file is opened in a new tab.</li>
72
 
        <li><b>Open in new tab...</b> Opens a dialogue to choose files to open in new tabs. New tabs are added to the right of the tab bar.</li>
73
 
        <li><b>Recently used</b> This menu contains a list of the 5 most recently used files. Clicking on a file in the list opens it in the current tab or in a new tab if there is none.</li>
 
63
        <li><b>Open in new tab...</b> Opens a dialogue to choose files to open in new tabs.</li>
 
64
        <li><b>Recently used</b> Contains a list of the ten most recently used files.</li>
74
65
        <li><b>Refresh</b> Reloads the file displayed in the current tab.</li>
75
66
        <li><b>Save copy...</b> Opens a dialogue to save a copy of the file displayed in the current tab.</li>
76
 
        <li><b>Print...</b> Opens a dialogue to print the file displayed in the current tab. If the current page layout is 'Two pages' or 'Two columns', the document will be printed with two pages per side.</li>
 
67
    <li><b>Print...</b> Opens a dialogue to print the file displayed in the current tab.</li>
77
68
        <li><b>Exit</b> Closes all tabs and ends the program.</li>
78
69
</ul>
79
70
 
80
71
<h4><a name="edit">Edit</a> <a href="#top">&uarr;</a></h4>
81
72
 
82
73
<ul>
83
 
        <li><b>Next/Previous/First/Last page</b> Displays the next/previous/first/last page of the document in the current tab. Without effect if the last/first/first/last page of the document is currently displayed.</li>
84
 
        <li><b>Jump to page...</b> Opens a dialog to enter the page to display in the current tab.</li>
85
 
        <li><b>Search...</b> Opens a search toolbar at the bottom of the window. The search starts if characters have been entered into the search field and no further character is entered for two seconds. The search can be started manually by pressing the return key. If a search is currently running when a new search is started, the currently running search is aborted. If another tab is selected, the search is aborted and the search field is cleared. The search toolbar can be closed by pressing the escape key.</li>
86
 
        <li><b>Find previous/next</b> If a search has been conducted, jumps to the previous/next occurrence of the search term in the document. Without effect, if no search has been conducted.</li>
 
74
        <li><b>Next/Previous/First/Last page</b> Skips to the next/previous/first/last page of the document. Without effect if the last/first/first/last page of the document is already displayed.</li>
 
75
    <li><b>Jump to page...</b> Opens a dialogue to enter a page to display in the current tab.</li>
 
76
        <li><b>Search...</b> Opens the search tool bar at the bottom of the window. The search automatically starts two seconds after the last change of the search term or is manually started by pressing the return key.</li>
 
77
        <li><b>Find previous/next</b> Jumps to the previous/next occurrence of the search term in the document.</li>
87
78
        <li><b>Cancel search</b> Cancels the currently running search and closes the search tool bar.</li>
88
 
        <li><b>Settings...</b> Opens the settings dialogue.
89
 
                <ul>
90
 
                        <li><b>Tab bar as needed</b> The tab bar is hidden if there are less than two tabs.</li>
91
 
                        <li><b>Tab position</b> Determines where tabs are displayed in relation to the main view.</li>
92
 
                        <li><b>Restore tabs</b> If this is activated, the program will save the tabs and their properties in the configuration files on closing the window and restore them on restart. If this is deactivated, that information will be removed from the configuration files.</li>
93
 
                        <li><b>Auto-refresh</b> Files are reloaded if they change on disk.</li>
94
 
                        <li><b>Fit to equal width</b> If the page layout is 'Two pages' or 'Two columns', the pages of each row are scaled to equal width.</li>
95
 
                        <li><b>Highlight links</b> Links are highlighted by red frames.</li>
96
 
                        <li><b>External links</b> External links are opened in the default browser. (External links may be malicious, therefore this is deactivated by default.)</li>
97
 
                        <li><b>Antialiasing</b> Improves display quality at the cost of performance.</li>
98
 
                        <li><b>Text antialiasing</b> Improves text display quality at the cost of performance.</li>
99
 
                        <li><b>Text hinting</b> May improve text readability on computer displays.</li>
100
 
                        <li><b>Maximum page cache size</b> Sets the maximum size for the page cache for each tab to limit the memory usage of qpdfview. Be aware though that this is only a part of the overall memory usage of qpdfview. (The page cache will be increased automatically and temporarily to hold at least three pages. This can lead to a large cache when using a large scale factor and a high-resolution computer display.)</li>
101
 
                        <li><b>Prefetch</b> The program will try to render some pages that are not yet visible at the cost of increased page cache usage.</li>
102
 
                </ul>
103
 
        </li>
 
79
        <li><b>Copy to clipboard</b> If checked, the program will wait for a frame to be dragged to copy texts or images.</li>
 
80
        <li><b>Add annotation</b> If checked, the program will wait for a frame to be dragged to add annotations.</li>
 
81
        <li><b>Settings...</b> Opens the settings dialogue.</li>
104
82
</ul>
105
83
 
106
 
<p>You can change the current page by entering the desired page into the text field in the edit toolbar and pressing the return key.</p>
 
84
<p>The <em>current page</em> can be changed by entering the desired page into the text field in the edit tool bar and pressing the return key.</p>
107
85
 
108
86
<h4><a name="view">View</a> <a href="#top">&uarr;</a></h4>
109
87
 
110
88
<ul>
111
 
        <li><b>Page layout options</b> The first group of options defines way the pages are laid out. 'Two pages' or 'Two columns' displays two pages in a horizontal arrangement. 'One page'/'Two pages' displays only one page/two pages at a time while 'One Column'/'Two columns' displays all pages continuously.</li>
112
 
        <li><b>Scale mode options</b> 'Fit to page width' ('Fit to page') determines the scale factor such that all pages fully fit into the view horizontally (and vertically).</li>
113
 
        <li><b>Zoom in</b> Increases the scale factor by 10%.</li>
114
 
        <li><b>Zoom out</b> Decreases the scale factor by 10%.</li>
115
 
        <li><b>Rotate left</b> Rotates the pages left/counterclockwise.</li>
116
 
        <li><b>Rotate right</b> Rotates the pages right/clockwise.</li>
117
 
        <li><b>Toolbars</b> This menu contains a list of available toolbars for quick access to commonly used actions.</li>
 
89
        <li><b>Continuous</b> Determines whether all rows of the page layout are visible at once.</li>
 
90
        <li><b>Two pages</b> Determines whether the page layout uses two columns.</li>
 
91
        <li><b>Zoom in</b> Increases the scale factor by 10 percent.</li>
 
92
        <li><b>Zoom out</b> Decreases the scale factor by 10 percent.</li>
 
93
        <li><b>Original size</b> Resets the scale factor to 100 percent.</li>
 
94
        <li><b>Fit to page width</b> Determines the scale factor such that all pages fully fit into the main view horizontally.</li>
 
95
        <li><b>Fit to page size</b> Determines the scale factor such that all pages fully fit into the main view horizontally and vertically.</li>
 
96
        <li><b>Rotate left</b> Rotates the pages left/counterclockwise by 90 degrees.</li>
 
97
        <li><b>Rotate right</b> Rotates the pages right/clockwise by 90 degrees.</li>
 
98
        <li><b>Tool bars</b> This menu contains a list of available tool bars for accessing often used actions.</li>
118
99
        <li><b>Docks</b> This menu contains a list of available docks for displaying supplementary information.</li>
119
 
        <li><b>Fonts...</b> Opens a dialogue displaying the fonts used in the document.</li>
120
 
        <li><b>Fullscreen</b> Enables and disables the fullscreen mode, where the window is maximized and its titlebar is hidden.</li>
121
 
        <li><b>Presentation...</b> Starts a presentation which can be ended by pressing F12 or escape. One page is displayed at a time. The home/end key is used to display the first/last page. Arrow keys right and down, space and the page down key jump to the next page. Arrow keys left and up, backspace and the page up key jump to the previous page.</li>
 
100
        <li><b>Fonts...</b> Opens a dialogue listing the fonts used in the document.</li>
 
101
        <li><b>Fullscreen</b> Toggles the fullscreen mode, i.e. the window is shown maximized and without decoration.</li>
 
102
        <li><b>Presentation...</b> Enters presentation mode which can be left by pressing F12 or escape. The home/end key is used to display the first/last page. Arrow keys right and down, space and the page down key jump to the next page. Arrow keys left and up, backspace and the page up key jump to the previous page. The return key returns to the page before the last jump.</li>
122
103
</ul>
123
104
 
124
 
<p>You can change the scale factor by entering the desired percentage into the text field in the view toolbar and pressing the return key.</p>
 
105
<p>The <em>scale factor</em> can be changed by entering the desired percentage into the text field in the view tool bar and pressing the return key.</p>
125
106
 
126
 
<h4><a name="tab">Tab</a> <a href="#top">&uarr;</a></h4>
 
107
<h4><a name="tabs">Tabs</a> <a href="#top">&uarr;</a></h4>
127
108
 
128
109
<ul>
129
 
    <li><b>Previous/Next tab</b> Makes the previous/next tab the current tab.</li>
 
110
    <li><b>Previous/Next tab</b> Makes the previous/next tab the current tab. Cycles to the last/first tab if the first/last tab is the current tab.</li>
130
111
    <li><b>Close tab</b> Closes the current tab.</li>
131
112
    <li><b>Close all tabs</b> Closes all tabs.</li>
132
113
    <li><b>Close all tabs but current tab</b> Closes all tabs except for the current tab.</li>
133
114
</ul>
134
115
 
135
 
<p>This menu also contains a list of all tabs which can be made the current tab by clicking on them. You can close a tab by middle-clicking on it. The position of the tab bar can be changed using its context menu.</p>
 
116
<p>This menu contains a list of all tabs which can be made the current tab by clicking on them. Tabs can be closed by middle-clicking on them.</p>
 
117
 
 
118
<h4><a name="bookmarks">Bookmarks</a> <a href="#top">&uarr;</a></h4>
 
119
 
 
120
<ul>
 
121
    <li><b>Previous bookmark</b> Jumps to the closest bookmark before the current page.</li>
 
122
    <li><b>Next bookmark</b> Jumps to the closest bookmark after the current page.</li>
 
123
    <li><b>Add bookmark</b> Adds a bookmark for the current file and page.</li>
 
124
    <li><b>Remove bookmark</b> Removes the bookmark for the current file and page.</li>
 
125
    <li><b>Remove all bookmarks</b> Removes all bookmarks.</li>
 
126
    <li><b>Open</b> Opens the corresponding file in the current tab. If there is no tab, the file is opened in a new tab.</li>
 
127
    <li><b>Open in new tab</b> Opens the corresponding file in a new tab.</li>
 
128
    <li><b>Jump to page</b> Jumps to the corresponding page if the corresponding file is open and opens the corresponding file in a new tab otherwise.</li>
 
129
</ul>
136
130
 
137
131
<h4><a name="help">Help</a> <a href="#top">&uarr;</a></h4>
138
132
 
139
133
<ul>
140
134
        <li><b>Contents</b> Displays this document.</li>
141
 
        <li><b>About</b> Displays information about qpdfview.</li>
 
135
        <li><b>About</b> Displays the program version.</li>
142
136
</ul>
143
137
 
144
138
<h3><a name="mainview">Main view</a> <a href="#top">&uarr;</a></h3>
145
139
 
146
 
<p>You can skip to the next/previous page using the left/right arrow key. You can go to the first/last page using the home/end key. You can skip one screen up/down using the page up/down key or backspace/space key.</p>
147
 
 
148
 
<h4><a name="mousewheel">Mouse wheel</a> <a href="#top">&uarr;</a></h4>
149
 
 
150
 
<ul>
151
 
    <li>The mouse wheel can be used to scroll up and down.</li>
152
 
    <li>Holding <b>ALT</b> while using the mouse wheel scrolls left and right.</li>
153
 
    <li>Holding <b>CTRL</b> while using the mouse wheel scales the document.</li>
154
 
    <li>Holding <b>SHIFT</b> while using the mouse wheel rotates the document.</li>
155
 
</ul>
156
 
 
157
 
<h4><a name="selections">Selections</a> <a href="#top">&uarr;</a></h4>
158
 
 
159
 
<p>To copy texts or images, hold <b>SHIFT</b>, click and hold the left mouse button to drag a frame around the area to copy. Once the mouse button is released, a menu is displayed where you can select whether to copy a text or an image into the clipboard.</p>
160
 
 
161
 
<h4><a name="links">Links</a> <a href="#top">&uarr;</a></h4>
162
 
 
163
 
<p>Links are highlighted by red frames (if not disabled in the settings). Hovering over a link with the mouse shows a tooltip with the link destination. Left-clicking on a link shows the linked page in the current tab or opens the linked URL in the default browser (if enabled in the settings).</p>
164
 
 
165
 
<h4><a name="bookmarks">Bookmarks</a> <a href="#top">&uarr;</a></h4>
166
 
 
167
 
<p>The context menu of the view contains a simple transient bookmarks mechanism. Bookmarks are specific to each tab and are lost when page layout, scaling or rotation is changed.</p>
168
 
 
169
 
<ul>
170
 
        <li><b>Return</b> Returns to the position before the last jump.</li>
171
 
        <li><b>Add entry</b> Creates a bookmark at the current vertical position.</li>
172
 
        <li><b>Remove entries on current page</b> Removes all bookmarks on the current page, i.e. the page whose number is displayed inside the toolbar.</li>
173
 
        <li><b>Go to previous/next entry</b> Jumps to the vertical position of the nearest bookmark whose vertical position is above/below the current vertical position. If there is not previous/next bookmark, this will jump to the last/first bookmark.</li>
174
 
        <li><b>Clear list</b> Removes all bookmarks.</li>
175
 
</ul>
 
140
<p>The backspace/space key skips to the previous/next page. The home/end key skips to the first/last page. The arrow, page up and page down keys scroll the viewport. The return key returns to the page before the last jump.</p>
 
141
 
 
142
<p>Using the mouse wheel scrolls up and down. Holding <b>ALT</b> while using the mouse wheel scrolls left and right. Holding <b>CTRL</b> while using the mouse wheel scales the document. Holding <b>SHIFT</b> while using the mouse wheel rotates the document.</p>
 
143
 
 
144
<p>Links are highlighted by red frames (if enabled in the settings). Left-click on a link to show the linked page or open the linked URL in the default browser (if enabled in the settings). Hovering over a link displays its destination as a tool tip.</p>
 
145
 
 
146
<p>To <em>copy texts or images</em>, hold <b>SHIFT</b>, click and hold the left mouse button to drag a frame around the area to copy. Once the mouse button is released, a pop-up menu is displayed to select whether to copy texts or images into the clipboard.</p>
 
147
 
 
148
<p>To <em>add annotations</em>, hold <b>CTRL</b>, click and hold the left mouse button to drag a frame around the region of interest. Once the mouse button is released, a pop-up menu is displayed to select whether to add text or highlight annotations. Left-click to <em>edit annotations</em>. Right-click to <em>remove annotations</em>. (Adding and removing annotations requires version 0.20 or higher of the Poppler library.) Hovering over an annotation displays its contents as a tool tip.</p>
176
149
 
177
150
<h3><a name="auxiliaryviews">Auxiliary views</a> <a href="#top">&uarr;</a></h3>
178
151
 
179
 
<h4><a name="outline">Outline</a> <a href="#top">&uarr;</a></h4>
180
 
 
181
 
<p>The outline dock displays an overview of the contents of the document. A left click on an entry jumps to the respective vertical position.</p>
182
 
 
183
 
<h4><a name="metainformation">Meta-information</a> <a href="#top">&uarr;</a></h4>
184
 
 
185
 
<p>The meta-information dock displays further information supplied by the document.</p>
186
 
 
187
 
<h4><a name="thumbnails">Thumbnails</a> <a href="#top">&uarr;</a></h4>
188
 
 
189
 
<p>The thumbnail dock displays miniature versions of the pages. A double click on a thumbnail jumps to the respective page.</p>
190
 
 
191
 
<h3><a name="commandlineoptions">Command-line options</a> <a href="#top">&uarr;</a></h3>
192
 
 
193
 
<p>If an instance of qpdfview is started with the <b>--unique</b> option, later invocations using this option will activate this instance to open the specified files. Please refer to the manual page for a detailed description of the command-line options.</p>
194
 
 
195
 
<h3><a name="configurationfile">Configuration file</a> <a href="#top">&uarr;</a></h3>
196
 
 
197
 
<p>The configuration file is typically located at '~/.config/qpdfview/qpdfview.conf'. The toolbars are configured by setting the keys 'fileToolBar', 'editToolBar' and 'viewToolBar' in the section 'mainWindow'. The values are ordered comma-separated lists. The default (available) entries are:</p>
198
 
 
199
 
<ul>
200
 
<li><b>fileToolBar:</b> openInNewTab,refresh (open,saveCopy,print),
201
 
<li><b>editToolBar:</b> currentPage,numberOfPages,previousPage,nextPage (firstPage,lastPage,jumpToPage,search),
202
 
<li><b>viewToolBar:</b> scaleFactor,zoomIn,zoomOut (onePage,twoPages,oneColumn,twoColumns,fitToPage,fitToPageWidth,doNotScale,rotateLeft,rotateRight,fullscreen,presentation).
203
 
</ul>
204
 
 
205
 
<p>The size of the thumbnails is specified by setting the keys 'thumbnailWidth' and 'thumbnailHeight' in the section 'documentView'. The icon theme used by Qt can be overridden by setting the key 'iconTheme' in the section 'mainWindow'.</p>
 
152
<p>The <em>outline</em> dock displays an overview of the contents of the document. A left click on an entry jumps to the respective page in the main view.</p>
 
153
 
 
154
<p>The <em>properties</em> dock displays further information supplied by the document.</p>
 
155
 
 
156
<p>The <em>thumbnails</em> dock displays small versions of the pages. A left click on an entry jumps to the respective page in the main view.</p>
 
157
 
 
158
<h3><a name="settings">Settings</a> <a href="#top">&uarr;</a></h3>
 
159
 
 
160
<p>Interface settings</p>
 
161
 
 
162
<ul>
 
163
    <li><b>Open URL</b> Determines whether links to URL are opened in the default browser.</li>
 
164
    <li><b>Auto-refresh</b> Determines whether files are automatically reloaded if changed on disk.</li>
 
165
    <li><b>Track recently used</b> If enabled, a recently used menu is available and lists the ten most recently used documents. (Effective after restart.)</li>
 
166
    <li><b>Restore tabs</b> If enabled, tabs and their properties are saved on ending the program and restored on restart.</li>
 
167
    <li><b>Restore bookmarks</b> If enabled, bookmarks are saved on ending the program and restored on restart.</li>
 
168
    <li><b>Tab position</b> Defines at which edge of the main view tabs will be displayed.</li>
 
169
    <li><b>Tab visibility</b> Determines whether tabs will be displayed if less than two documents are opened.</li>
 
170
    <li><b>File tool bar</b> Defines which actions are visible in the file tool bar. Available actions are openInNewTab, open, refresh, saveCopy and print. (Effective after restart.)</li>
 
171
    <li><b>Edit tool bar</b> Defines which actions are visible in the edit tool bar. Available actions are currentPage, previousPage, nextPage, firstPage, lastPage, jumpToPage, search, copyToClipboard and addAnnotation. (Effective after restart.)</li>
 
172
    <li><b>View tool bar</b> Defines which actions are visible in the view tool bar. Available action are scaleFactor, zoomIn, zoomOut, continuousMode, twoPagesMode, originalSize, fitToPageWidth, fitToPageSize, rotateLeft, rotateRight, fullscreen and presentation. (Effective after restart.)</li>
 
173
    <li><b>Zoom modifiers</b> The keyboard modifiers to zoom using the mouse wheel in the main view.</li>
 
174
    <li><b>Rotate modifiers</b> The keyboard modifiers to rotate using the mouse wheel in the main view.</li>
 
175
    <li><b>Horizontal modifiers</b> The keyboard modifiers to scroll horizontally using the mouse wheel in the main view.</li>
 
176
    <li><b>Copy modifiers</b> The keyboard modifiers to copy texts or images from a page.</li>
 
177
    <li><b>Annotate modifiers</b> The keyboard modifiers to add annotations to a page.</li>
 
178
</ul>
 
179
 
 
180
<p>Graphics settings</p>
 
181
 
 
182
<ul>
 
183
    <li><b>Decorate pages</b> Determines whether pages are set apart from the background.</li>
 
184
    <li><b>Decorate links</b> Determines whether links are highlighted by red frames.</li>
 
185
    <li><b>Invert colors</b> Determines whether pages are rendered with inverted colors.</li>
 
186
    <li><b>Page spacing</b> Determines both vertical and horizontal space displayed between pages.</li>
 
187
    <li><b>Thumbnail spacing</b> Determines both vertical and horizontal space displayed between thumbnails.</li>
 
188
    <li><b>Thumbnail size</b> Determines the size of the thumbnails.</li>
 
189
    <li><b>Antialiasing</b> Improves display quality at the cost of performance</li>
 
190
    <li><b>Text antialiasing</b> Improves text display quality at the cost of performance</li>
 
191
    <li><b>Text hinting</b> May improve text display quality for certain fonts.</li>
 
192
    <li><b>Cache size</b> The program will try to cache rendered pages within this limit increasing rendering speed at the cost of increased memory usage.</li>
 
193
    <li><b>Prefetch</b> The program will try to render pages that are not yet visible increasing rendering speed at the cost of increased cache usage.</li>
 
194
</ul>
206
195
 
207
196
</body>
208
197