Skip to content

Glossary for translators also in Markdown file format

Rafael Fontenelle requested to merge rafaelff/chronojump:glossary-md into master

Currently there is only .html and .lyx file formats. Damned Lies (GNOME Translation management system) links the .html file to ease translators access to this file. It is like that since the cgit web interface, which was replaced with this GitLab.

Now in GitLab, the link for the glossary in Chronojump page in Damned Lies is for the raw mode, showing the HTML source code instead of a page -- no much use. The alternative is to browse the web view of GitLab, which won't show HTML page as well.

So, this MR adds a Markdown version of the glossary for pretty viewing in GitLab web view and for linking in Damned Lies.

Please notice that nothing was changed in the content of the glossary, I only did formatting adjustments. Here is what I did:

  1. Convert .html file to GFM markdown format (which is what GitLab uses) using pandoc
  2. Clean the formatting text: removed some <div> tag without content within; changed internal links from style underlined italic word followed by asterisk to an typical Markdown hyperlink (just like the above hyperlink)
  3. Replaced glossary terms' bullet points with headings to enable anchors and local linking

Note on the 3rd item:
The .hmtl file had <span> tags to create anchors for the glossary terms, but it didn't work in the Markdown file. While the expected behavior of clicking in the internal link was to go to the anchored text via <span>, what I saw was the screen rolling going up one line (?). Therefore, replaced these tags and bullet points with headings, which turned out to be much more cleaner.

Edited by Xavier de Blas

Merge request reports