SoK/2021/StatusReport/Pablo Marcos

New Website for Okular

Okular is a multifaceted program that I use almost every day for my PDF reading and annotating needs, although it can do much more. Sadly, its website is a bit outdated and not mobile friendly. I thus proposed to rewrite the Okular website using the HUGO framework, in a similar way as was done with the kde.org main website, keeping consistency with other KDE applications such as Konsole. Fortunately, some work was already initiated by Carl Schwan, so I only needed to continue and finish his work.

Mentor

Repo Links

Work Done

January 2021

I didnt do much in January, as it was the "partiels" (final exams) month at INSA and I was really caught up studying. But, back in Spain, there was a lot of snow! Which is super nice :p

February 2021

I started by porting the Anouncements section from Raw HTML to Markdown, for which I wrote a small script. Then, I configured the project to use aether-sass (kde's HUGO standard theme) as a Go module, as Git submodules were less desirable. Finally, I added a FAQ section, which was easy since most questions had been removed from the FAQ in a recent cleanup. For this, I used the </details> and </summary> HTML labels, which I didnt know about and which seem super cool to me. Finally, I added the new /download and /build-it pages, using a mixture of HUGO markdown and raw html templates.

March 2021

Having added the index page as a raw html template, now I needed to add i18n support; this was achieved by using the {{i18n}} HUGO template, which I also used in the /applications table of supported formats. Next, I added the /contact page, which I redesigned and updated to include matrix. I modified the index to include a refference to Okular's upcoming PDF signing support (¡so neat! I might finally stop using Autofirma), cleaned up unnecesary files that were left from the transition, and added a Site Search functionality that works client-side and does not depend on google, insipired by (some might even say copied from) eddieweb's popular gist.

April 2021

I have finished the work on the project. All that is left is some minor modifications and writing this project report.

Balance of the Project

I believe that the goals set at the start of the project (click here if you dont have a KDE account or wish to see the spanish version) have been mostly fulfilled: the project does in fact present the information in a clear and beautiful, mobile-friendly way, thanks to the aether-sass theme. It has a google-independent in-page search, although it does not use lunar.js as was suggested, and the development news are now in its own section, although the changelogs were left outside of the individual posts for practical reasons. The screenshots and other have been updated, but most of them have been removed as we have decided for a simpler homepage which highlights the most important features of the program.

In all, most features in the old webpage have been kept, while adding a more modern redesign which increases usability and makes the project more attractive and coherent with KDE's aesthetic.

What I've learnt
  • The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in my personal webpage :p
  • How to use HUGO in general, and HUGO i18n in particular
  • That, in my opinion, HUGO is not only much more modular and adaptable than, for example, WordPress, but, for people who know how to use the command terminal, it is even simpler than Wordpress itself
  • That Okular is adding PDF Signatures support!
  • How to wirte HTML, CSS and JavaScript, important knowledge that I have already applied in my next project, the website for the Mathematics Journal "Pensamiento Matemático"
  • KDE is as cool as I thought! 😏

Blog Posts on KDE Planet

The links for this blog posts are on my personal site, not on KDE Planet, but you can check they aggregate to Planet by clicking here.

Screenshots

In order not to supercharge this server, and given the more limited nature of Wiki when it comes to image formatting, I suggest that you check the equivalent to this report on my personal blog in case you want to take a look at the screenshots.

Contact

If you want to make suggestions for this project, please do not hesitate to contact me.

KDE Invent :- Pablo Marcos

Matrix :- @pablitouh:matrix.org


This page was last edited on 29 March 2021, at 12:31. Content is available under Creative Commons License SA 4.0 unless otherwise noted.