SoK/2021/StatusReport/Pablo Marcos: Difference between revisions
(Prettier) |
|||
| Line 1: | Line 1: | ||
== New Website for Okular == | === 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 [https://konsole.kde.org/ Konsole]. Fortunately, some work was already initiated by Carl Schwan, so I only needed to continue and finish his work. | |||
=== | ==== Mentors ==== | ||
== | |||
* [https://invent.kde.org/carlschwan/ Carl Schwan] | * [https://invent.kde.org/carlschwan/ Carl Schwan] | ||
=== Links === | ==== Links ==== | ||
Repositories | Repositories | ||
* [https://invent.kde.org/websites/okular-kde-org/ Official | * [https://invent.kde.org/websites/okular-kde-org/ Official Repo where all work will be merged] | ||
* [https://invent.kde.org/carlschwan/okular-kde-org/-/tree/work Working Repo] | * [https://invent.kde.org/carlschwan/okular-kde-org/-/tree/work Working Repo] | ||
=== Work Done === | ==== 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, [https://www.eldiario.es/sociedad/filomena-tine-blanco-espana-imagenes-nevada-historica_3_6738421.html there was a lot of snow!] Which is super nice :p | |||
===== February 2021 ===== | |||
I started by [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/e3e8529ff33be74ea4d9ed59406fdef4e5418127 porting the Anouncements section from Raw HTML to Markdown], for which I wrote a small script. Then, I [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/9229e022294accb9b279d87f3d91fb1693251a61 configured the project] to use the [https://invent.kde.org/websites/aether-sass aether-sass] (kde's HUGO standard theme) as a Go module, as Git submodules were less desirable. Finally, I added [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/62829821d073506f15e46def4d0f1418ec215834 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, [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/7b85b02878982032487e49058771c9685c39b213 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; [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/a042f38d0fe1d781860a0056721e66349393b997 this was achieved by using the <nowiki>{{i18n}}</nowiki> HUGO template], which I also used in the /applications table of supported formats. Next, [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/0e7989a171c36f2d7d0b32332a43a490a27ccf59 I added the /contact page], which I redesigned and updated to include matrix. [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/1795c0da36113ee0219a69d66bfce1595218f94c I modified the index] to include a refference to Okular's [https://invent.kde.org/graphics/okular/-/merge_requests/296 upcoming PDF signing support] (¡so neat! I might finally stop using [https://github.com/ctt-gob-es/clienteafirma Autofirma]), [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/9cab0470f744252ecff9ef9721f71de084167dfb cleaned up unnecesary files that were left from the transition], [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/05ce2a78d2b77d4e4e4e19e64a7e3601856095bf and added a Site Search] functionality [https://invent.kde.org/carlschwan/okular-kde-org/-/commit/01d76a0403681263c991b55667f038db80323f3c that works] client-side and does not depend on google, insipired by (some might say ''copied'' ''from'' / en los mentideros dirán que ''copiado de'') [https://gist.github.com/eddiewebb/735feb48f50f0ddd65ae5606a1cb41ae 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. | |||
===== What I've learnt so far ===== | |||
* The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in some personal projects :p | |||
* How to use HUGO in general, and HUGO i18n in particular | |||
*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 [https://revista.giepm.com/ Mathematics Journal "Pensamiento Matemático"] | |||
*KDE is as cool as I thought! 😏 | |||
==== Contact ==== | |||
If you want to make suggestions for this project, please do not hesitate to contact me. | |||
[https://invent.kde.org/flyingflamingo Pablo Marcos] | |||
Matrix :- @pablitouh:matrix.org | |||
== Work in Progress == | == Work in Progress == | ||
Revision as of 19:15, 25 March 2021
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.
Mentors
Links
Repositories
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 the 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 say copied from / en los mentideros dirán que copiado de) 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.
What I've learnt so far
- The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in some personal projects :p
- How to use HUGO in general, and HUGO i18n in particular
- 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! 😏
Contact
If you want to make suggestions for this project, please do not hesitate to contact me.
Matrix :- @pablitouh:matrix.org
Work in Progress
I am currently working on the /download and /build-it pages. I wrote a HTML mockup, and am in the process of transitioning to a HUGO markdown and HTML templae format.
What I've learnt so far
- The HTML labels </details> and </summary> exist! This has been super useful, as I have already used that knowledge in some personal projects :p
- How to use HUGO in general
Contact
If you want to make suggestions in this project do contact me.
Matrix :- @pablitouh:matrix.org