Update Okular developer documentation
ClosedPublic

Authored by yurchor on Dec 25 2018, 6:25 PM.

Details

Summary

The current docs are for KDE 4 and slightly outdated. This patch tries to make them a bit up-to-date.

Test Plan

Just a comparison with the current generators. No testing of code was conducted. Advices needed.

Diff Detail

Repository
R223 Okular
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
yurchor created this revision.Dec 25 2018, 6:25 PM
Restricted Application added a project: Okular. · View Herald TranscriptDec 25 2018, 6:25 PM
Restricted Application added a subscriber: okular-devel. · View Herald Transcript
yurchor requested review of this revision.Dec 25 2018, 6:25 PM
yurchor updated this revision to Diff 48362.Dec 29 2018, 5:04 PM

Fix minor issues with the broken references.

The current developer docs with the patch for easier inspection. Thanks in advance for your review.

While we're at it, maybe we could update the icon shown on the title page to display the current Breeze icon rather than the old KDE4-era Oxygen icon?

While we're at it, maybe we could update the icon shown on the title page to display the current Breeze icon rather than the old KDE4-era Oxygen icon?

That is a customized demo. It is not for delivering to someone. ;)

If Okular developers will decide to share it somewhere we can use any icon you like.

BTW, I can change the icon on the title page of the user documentation if you like the Breeze icon.

https://docs.kde.org/trunk5/en/kdegraphics/okular/okular.pdf

Personally, I think the new is not very self-evident and as good as the current Okular is.

But that's the different story.

Off topic: logo on the docs.kde.org is updated with the Breeze version. Should be visible next Thursday. If someone objects please let me know.

aacid added a subscriber: aacid.Jan 26 2019, 12:01 AM
aacid added inline comments.
Mainpage.dox
45

I'd use the original sorting here, "noone" about xps but everyone cares about PDF, so it being on top makes sense

416

This changeset is wrong (or at least changes the original intent of the document), your changes are for building in source, while the manual is for people that build out of okular's source

758

i guess we don't really need this

yurchor updated this revision to Diff 50309.Jan 26 2019, 8:12 AM

Restore the original formats order, restore CMakeLists.txt, remove KAboutData include

yurchor marked 3 inline comments as done.Jan 26 2019, 8:13 AM
aacid accepted this revision.Feb 6 2019, 10:21 PM

I have not carefully reviewed it, but it seems to be clearly better than what we have, so i'd say go ahead and commit it (without the setPlaceHolder changes that don't belong here i guess)

This revision is now accepted and ready to land.Feb 6 2019, 10:21 PM
This revision was automatically updated to reflect the committed changes.