-
Notifications
You must be signed in to change notification settings - Fork 227
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improvements to help book #1794
Conversation
This removes all HTML files from the help book for those locales that have no localised files at all. Users that use these locales will use the English help book instead.
- As pointed out by Mario Guzman, the most reliable way to see the updated content is to __drag__ the debug build of Vienna.app into the Applications folder, log out, log back in and wait a few minutes. - For some reason, Xcode does not show the "Products" folder if it is the last https://marioaguzman.wordpress.com/2020/09/12/auth/ https://forums.developer.apple.com/forums/thread/77406
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We probably need to add the --generate-summaries
option to hiutil
calls in the IndexHelpbook.sh
script, as the help pages miss <meta name="description" ...>
tags.
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. |
Speed is not an issue, but the result doesn't look promising:
|
This tag causes the help indexer to index only the anchors, not the content. Apple's documentation recommends to use this only for the title page of the help book, if it only contains links to other pages/sections.
hiutil complains if it cannot find an identifier in the HTML pages.
The summary will be shown when in the search results of the help viewer. I reused the phrases on the title page (Vienna.html) with some modifications to make it clear that the entry refers to Vienna.
I started by adding the German localization to the intro file :) Or is that an old one? |
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 I uploaded the updated HTML files to Crowdin.
|
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. :/ |
Help books can now be localised with Crowdin. Crowdin supports localising HTML files:
For this to work, the source HTML files and localised HTML files should have the same structure. I went through the HTML files and:
Some caveats:
<p>
somewhere, can cause Crowdin to remove and re-add all subsequent elements. I will be looking into this more, maybe we have to use<div>
elements withid
attributes to make the references clearer.witdh
attributes in table columns. However, these can be replaced with CSS.