office/okular
office/okular
1
0
Fork 0
mirror of https://invent.kde.org/graphics/okular synced 2024-11-05 18:34:53 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
9789 commits 138 branches 360 tags 104 MiB
C++ 86.9%
C 10.2%
CMake 1.2%
QML 1.1%
JavaScript 0.4%
Other 0.1%
Find a file
Friedrich W. H. Kossebau dd44014b7a Too-Small-Digital-Signature dialog buttons: title capitalization, ui marker
2022-07-13 10:36:29 +00:00
autotests Use the poppler version includes instead of check_cxx_source_compiles 2022-05-04 01:16:35 +02:00
cmake/modules Convert CMake module license statements to SPDX 2021-06-10 08:11:56 +00:00
conf Add a few definitions that will come with ECM 5.85 2022-04-07 23:02:12 +00:00
core SVN_SILENT made messages (.desktop file) - always resolve ours 2022-06-09 03:27:27 +00:00
doc Add TTS voice selection option to the docs 2022-02-20 21:23:52 +02:00
generators SVN_SILENT made messages (.desktop file) - always resolve ours 2022-07-03 03:27:15 +00:00
gui Don't require KF5::IconThemes for Mobile 2022-04-09 00:29:23 +02:00
hooks Add .git-blame-ignore-revs and some instructions for clang-format 2020-07-11 09:17:54 +02:00
icons New part/ directory for okularpart sources from /, ui/, conf/ 2020-11-18 19:32:56 +00:00
interfaces Convert license headers to SPDX 2021-06-10 08:11:56 +00:00
LICENSES Download GFDL-1.2-or-later license 2021-06-10 08:11:56 +00:00
mobile GIT_SILENT made messages (after extraction) 2022-07-09 00:43:22 +00:00
part Too-Small-Digital-Signature dialog buttons: title capitalization, ui marker 2022-07-13 10:36:29 +00:00
shell GIT_SILENT made messages (after extraction) 2022-07-12 00:43:49 +00:00
.clang-tidy Enable readability-braces-around-statements 2022-03-09 23:29:56 +01:00
.git-blame-ignore-revs Add the readability-braces-around-statements hash to .git-blame-ignore-revs 2022-03-10 00:09:09 +01:00
.gitignore Add auto generated files to .gitignore 2021-12-17 01:40:21 +03:00
.gitlab-ci.yml Add Windows CI 2022-05-08 18:59:25 +02:00
.kde-ci.yml Add Windows CI 2022-05-08 18:59:25 +02:00
.krazy synctex is "external code", make krazy stay away from it 2010-02-08 23:15:24 +00:00
_clang-format Manual fixes to license headers 2021-06-10 08:11:56 +00:00
aboutdata.h okular About dialog human names should be translated 2022-05-29 11:37:24 +03:00
CMakeLists.txt GIT_SILENT Upgrade release service version to 22.07.80. 2022-07-13 00:26:31 +02:00
config-okular.h.cmake Increase kjs requirement for using the timeout check 2020-06-24 12:06:32 +02:00
kdocumentviewer.h Convert license headers to SPDX 2021-06-10 08:11:56 +00:00
Mainpage.dox Clean up ServiceType property usage for JSON based plugins 2021-05-21 06:53:52 +02:00
Messages.sh Extract i18n from gui 2022-06-30 00:01:01 +02:00
metainfo.yaml replace "MacOSX" with "macOS" 2021-08-24 21:00:17 +00:00
okular.categories Use new syntax 2018-11-20 13:21:08 +01:00
okular.upd Store the state of the builtin annotations in a new config key 2020-08-25 10:16:10 +02:00
Okular5Config.cmake.in Use ecm_setup_qtplugin_macro_names 2020-09-13 11:20:50 +02:00
okular_part.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2022-07-03 03:27:15 +00:00
OkularConfigureChecks.cmake Force release of free memory 2018-05-30 10:55:17 +02:00
README.clang-format Move to clang-format 13 2022-03-10 00:23:22 +01:00
README.internals.png Optimize PNG files again. 2008-01-02 00:10:07 +00:00
README.md Set QT_PLUGIN_PATH 2022-03-07 23:09:02 +00:00
TODO Fix some typos found by Krazy2 2013-06-24 13:46:16 +03:00

README.md

Okular – Universal Document Viewer

Okular can view and annotate documents of various formats, including PDF, Postscript, Comic Book, and various image formats. It supports native PDF annotations.

Downloads

For download and installation instructions, see https://okular.kde.org/download.php

User manual

https://docs.kde.org/?application=okular&branch=stable5

Bugs

https://bugs.kde.org/buglist.cgi?product=okular

Please report bugs on Bugzilla (https://bugs.kde.org/enter_bug.cgi?product=okular), and not on our GitLab instance (https://invent.kde.org).

Mailing list

https://mail.kde.org/mailman/listinfo/okular-devel

Source code

https://invent.kde.org/graphics/okular.git

The Okular repository contains the source code for:

  • the okular desktop application (the “shell”),
  • the okularpart KParts plugin,
  • the okularkirigami mobile application,
  • several okularGenerator_xyz plugins, which provide backends for different document types.

Apidox

https://api.kde.org/okular/html/index.html

Contributing

Okular uses the merge request workflow. Merge requests are required to run pre-commit CI jobs; please don’t push to the master branch directly. See https://community.kde.org/Infrastructure/GitLab for an introduction.

Build instructions

Okular can be built like many other applications developed by KDE. See https://community.kde.org/Get_Involved/development for an introduction.

If your build environment is set up correctly, you can also build Okular using CMake:

git clone https://invent.kde.org/graphics/okular.git
cd okular
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/install/dir ..
make
make install

Okular also builds tests in the build tree. To run them, you have to run make install first.

If you install Okular in a different path than your system install directory it is possible that you need to run

source prefix.sh

so that the correct Okular instance and libraries are picked up. Afterwards one can run okular inside the shell instance. The source command is also required to run the tests manually.

As stated above, Okular has various build targets. Two of them are executables. You can choose which executable to build by passing a flag to CMake:

cmake -DCMAKE_INSTALL_PREFIX=/path/to/your/install/dir -DOKULAR_UI=desktop ..

Available options are desktop, mobile, and both.

clang-format

The Okular project uses clang-format to enforce source code formatting. See README.clang_format for more information.