Annotations

Okular allows you to review and annotate your documents. Annotations created in Okular are automatically saved in the internal local data folder for each user. Okular does not implicitly change any document it opens.


Okular's Annotations

Okular has two different kind of annotations:

Text annotations like Yellow Highlighter and Black Underlining for files with text like e.g. PDF.

Graphic annotations like Pop-up Note, Inline Note, Freehand Line, Highlighter, Straight Line, Polygon, Stamp, Underline, and 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 e.g. a PDF document.

Since Okular 0.15 you can also save annotations directly into PDF files. This feature is only available if Okular has been built with version 0.20 or later of Poppler rendering library. You can use FileSave As... to save the copy of PDF file with annotations.

Note

It is not possible to save annotations into PDF file if original file was encrypted and Okular uses Poppler libraries of version which is lower than 0.22.

Note

If you open a PDF with existing annotations, your annotation changes are not automatically saved in the internal local data folder, and you need to save the modified document (using FileSave As...) before closing it. Should you forget to do this Okular will show confirmation window that allows you to save the document.

Note

Due to DRM limitations (typically with PDF documents), adding, editing some properties or removing annotations could not be possible.

Note

Any action on annotations (creation and removal of annotations, editing arbitrary annotation properties, relocating annotations with Ctrl+drag, and editing the text contents of an annotation) can be undone or redone using the corresponding item from the Edit menu. It is also possible to undo the action by pressing Ctrl+Z and redo the undone action by pressing Ctrl+Shift+Z.

Since Okular 0.17 you can configure the default properties and appearance of each annotating tool. Please refer to the corresponding section in this documentation.

Adding annotations

To add some annotations to the document, you have to activate the annotating toolbar. This is done by either selecting ToolsReview or pressing F6. Once the annotating toolbar is shown, just press one of its buttons or use keyboard shortcuts (keys from 1 to 9) to start constructing that annotation.

The annotating toolbar helps you to make annotations with drawings, shapes, and text messages. You can use the annotating toolbar to mark up a document (e.g. add lines, ellipses, polygons, stamps, highlights, underlines etc.). The table below describes exactly what the default set of annotating toolbar buttons does.

Button Tool Name Description

Pop-up Note

To draw multiline note. The note will can be viewed by double clicking on an icon in the document.

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 Close this note button in the top right corner of the pop-up window.

Inline Note

To draw inline note. The note will be shown inline as is.

Click on the tool button, then click with the left mouse button and hold to place 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 OK to save the note, Cancel to cancel note entering or Clear to clear the note.

Freehand Line

To draw free-form lines.

Click on the tool button, then click with the left mouse button and hold to place the start of the line, then drag to draw the line.

Highlighter

To highlight text in the document with some given background color.

Click on the tool button, then click with the left mouse button and hold to place the beginning of the highlighted text snippet, then drag to highlight it.

Straight Line

To mark with a line.

Click on the tool button, then click with the left mouse button to place the starting point of the line, then drag to place of the ending point of the line should be and click once more.

Polygon

To draw a closed plane figure from three or more segments. The corresponding note can be viewed by double clicking inside the polygon.

Click on the tool button, then click with the left mouse button to place the first vertex of the polygon, then drag to place of the second vertex. Proceed until you draw the whole polygon up to the first vertex. Click twice if you want to add some note to the polygon. Enter the text of the note then click on the OK to save the note, Cancel to cancel note entering or Clear to clear the note.

Stamp

To mark the text or image with some predefined shape.

Click on the tool button then click with the left mouse button to place the stamp.

A single click just places a square stamp (useful for icons). To add a rectangular stamp you can click with the left mouse button and hold to place the top-left point, then drag to place the bottom-right one.

Underline

To underline some text.

Click on the tool button, then click with the left mouse button and hold to place the beginning of the underlined text snippet, then drag to underline it.

Ellipse

To draw an ellipse around some chosen area.

Click on the tool button, then click with the left mouse button and hold to place the top-left corner of the circumscribed rectangular for the ellipse, then drag to place the bottom-right one.

The contents of the annotating toolbar can be configured using the Annotations page of Okular configuration dialog. This page can be opened with right mouse button clicking on the annotating toolbar then choosing Configure Annotations... from the context menu.

With a single left mouse button click on an annotation tool button you can use a tool once. If you e.g. want to highlight all important parts of a text, activate that tool permanently by double clicking on the tool button. Press the Esc key or click the tool button again to leave the permanent mode.

Note

The annotating toolbar can be docked in any side of the viewing area: just drag it to move it to another place.

Note

Activating the annotating toolbar will make you switch to the Browse Tool Mode.

You can stop the construction any time by pressing again on the button of the annotation you are constructing, or by pressing the Esc key.

The newly constructed annotation will have as author the author you set in the Annotations page in Okulars configuration dialog. The Annotations page can also be used to configure the content of the annotating toolbar.

Removing annotations

To remove an annotation, just click on it with the right mouse button, and select Delete.

When removing the annotation, its window will be closed if open.

Note

This option could not be enabled because the document does not allow removing annotations.

Editing annotations

To edit an annotation, click on it with the right mouse button and select Properties. A dialog will appear with the general annotation settings (like color and opacity, author, etc.) and the settings specific to that annotation type.


Annotation Property Dialog

To move an annotation, hold down the Ctrl key, move the mouse pointer on it and then start dragging with the left mouse button.

Note

Depending on the document permissions (typically with PDF documents), some options can be disabled.