office/okular
office/okular
1
0
Fork 0
mirror of https://invent.kde.org/graphics/okular synced 2024-06-25 20:32:16 +00:00
Code Issues Projects Releases Wiki Activity
10,769 Commits 137 Branches 354 Tags 121 MiB
C++ 86.7%
C 10.4%
CMake 1.2%
QML 1.2%
JavaScript 0.3%
Other 0.1%
master
Go to file
Pratham Gandhi e5900f9a4f created global qobject
2024-06-24 10:39:38 +05:30
autotests Added keystroke tests for AFNumber_Keystroke 2024-06-19 21:55:38 +00:00
cmake/modules Convert CMake module license statements to SPDX 2021-06-10 08:11:56 +00:00
conf Add a configuration option to disable drag-scrolling beyond screen edges 2022-09-28 00:10:56 +00:00
core created global qobject 2024-06-24 10:39:38 +05:30
doc man page: refer to Qt6 & KF6 version of commandline options 2024-04-04 03:13:41 +02:00
generators Fix crash on certain pdf actions 2024-06-19 18:05:21 +00:00
gui A collection of cppcheck fixes 2024-04-15 19:59:42 +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 Port sidebar to QDockWidget 2022-12-22 22:50:55 +00:00
LICENSES Download GFDL-1.2-or-later license 2021-06-10 08:11:56 +00:00
mobile GIT_SILENT Update Appstream for new release 2024-06-10 00:04:30 +02:00
part Replace unsigned open document with signed 2024-06-19 12:05:45 +00:00
po GIT_SILENT Sync po/docbooks with svn 2024-06-23 01:24:01 +00:00
shell Replace unsigned open document with signed 2024-06-19 12:05:45 +00:00
_clang-format Manual fixes to license headers 2021-06-10 08:11:56 +00:00
.clang-tidy Warn on suspicious realloc 2024-02-22 15:33:21 +00:00
.craft.ini we want to create appx packages for windows 2024-04-23 10:38:28 +02: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 CI: More 6.6 -> 6.7 2024-05-13 12:42:12 +02:00
.kde-ci.yml Xml lint include certain rc files 2024-04-25 09:00:29 +00:00
.krazy synctex is "external code", make krazy stay away from it 2010-02-08 23:15:24 +00:00
aboutdata.h okular About dialog human names should be translated 2022-05-29 11:37:24 +03:00
CMakeLists.txt created global qobject 2024-06-24 10:39:38 +05:30
config-okular.h.cmake Allow dbus to be disabled 2023-07-18 07:53:42 +00:00
cppcheck-suppressions.xml Ignore synctex_parser; it's 3rd party code 2024-03-19 07:55:56 +00:00
kdocumentviewer.h Convert license headers to SPDX 2021-06-10 08:11:56 +00:00
Mainpage.dox Switch to kf6 2023-12-18 22:56:22 +00: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_part.desktop SVN_SILENT made messages (.desktop file) - always resolve ours 2023-11-07 02:06:23 +00:00
okular_part.json SVN_SILENT made messages (.desktop file) - always resolve ours 2024-05-22 01:18:54 +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
Okular6Config.cmake.in Replace Okular5 with Okular6 in cmake config 2023-12-18 22:56:22 +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 Revert "Update download link" 2023-03-31 17:51:03 +02: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.