ViennaRSS / vienna-rss

Vienna is a free and open-source RSS/Atom newsreader for macOS.
https://www.vienna-rss.com
Apache License 2.0
1.85k stars 227 forks source link

Improvements to help book #1794

Closed Eitot closed 3 months ago

Eitot commented 3 months ago

Help books can now be localised with Crowdin. Crowdin supports localising HTML files:

image

For this to work, the source HTML files and localised HTML files should have the same structure. I went through the HTML files and:

  1. removed all HTML files for locales that weren't localised at all,
  2. updated the remaining HTML files to match the structure of the English HTML files and
  3. updated the English HTML files to include some changes the French HTML files have (which seems to be the most maintained).

Some caveats:

Eitot commented 3 months ago

The manual page warns that it "may be slow" to generate those. I will have to test. Maybe we need to provide the script's input files so that it runs only when changes are made to those files. That way it shouldn't interfere with incremental builds.

Eitot commented 3 months ago

Speed is not an issue, but the result doesn't look promising:

Indexing help book for fr ...
/Vienna.html
    Title: Aide Vienna
    Descr:  Explications des réglages de l'onglet Advancés des Préférences.
/advanced.html#AdvancedSettingsSection
    Title: (null)
    Descr: (null)
/intro.html
    Title: Introduction à Vienna
    Descr: Pour visualiser au cas par cas les liens pour les pages dans un autre navigateur, choisissez dans le menu contextuel de la page (bouton droit ou Crontrol-clic) la commande "Ouvrir le lien dans XXX" ou "Ouvrir la page dans XXX" où XXX est le nom de votre navigateur internet par défaut. 
/faq.html#I_found_a_problem_with_Vienna._How_do_I_report_it
    Title: Comment faire ?
    Descr:  Par contre, pour les serveurs qui exigent un cookie, le nom d'utilisateur et le mot de passe ne doivent PAS apparaître dans la boite de dialogue "Infos" du flux. 
/keyboard.html#KeyboardSection
    Title: (null)
    Descr: (null)
TAKeanice commented 3 months ago

I started by adding the German localization to the intro file :) Or is that an old one?

Eitot commented 3 months ago

I did some digging and found that the "robots" tag affected the indexer. Those pages that have "keywords" or "anchors" as the value won't be indexed fully, i.e. none of the content, only metadata. This is why above the result was shown as (null). I fixed that by applying that tag to the title page only, which doesn't need to be indexed except for the anchors. I wasn't happy with the result of the --generate-summaries option, so I decided to add descriptions myself by borrowing the phrases on the title page (which some modifications).

I uploaded the updated HTML files to Crowdin.

/advanced.html#AdvancedSettingsSection
    Title: Advanced Settings
    Descr: Explains advanced settings in Vienna.
/intro.html#intro-page
    Title: Introduction to Vienna
    Descr: Learn how to get started with Vienna.
/Vienna.html#title-page
    Title: (null)
    Descr: (null)
/faq.html#faq-page
    Title: How Do I?
    Descr: Frequently asked questions about Vienna, getting support and troubleshooting steps.
/keyboard.html#KeyboardSection
    Title: Keyboard Shortcuts
    Descr: Discover keyboard shortcuts for common commands in Vienna.
Eitot commented 3 months ago

I started by adding the German localization to the intro file :) Or is that an old one?

Crowdin has the most recent version. It should be most up-to-date there. The German files miss entire sections and I find that there are many mistakes and weird phrases in the existing translations. :/