Bug 142417 - Online Help: "File Conversion Filter Names" page should contain an "API Name" column
Summary: Online Help: "File Conversion Filter Names" page should contain an "API Name"...
Alias: None
Product: LibreOffice
Classification: Unclassified
Component: Documentation (show other bugs)
(earliest affected)
Hardware: All All
: medium normal
Assignee: Kevin Suo
Whiteboard: target:7.2.0
Depends on:
Blocks: HelpGaps-NewFeatures
  Show dependency treegraph
Reported: 2021-05-22 03:00 UTC by Kevin Suo
Modified: 2021-05-31 15:10 UTC (History)
1 user (show)

See Also:
Crash report or crash signature:


Note You need to log in before you can comment on or make changes to this bug.
Description Kevin Suo 2021-05-22 03:00:51 UTC
The following API documentation page:

says that the FilterName option passed using com.sun.star.beans.PropertyValue should be an internal filter name and references to the following Online Help page:

However, the Filter Names as listed on this Online Help page are actually UI Names (or Localized Names) of those filters, not API Names.

For instance:
* on the online help page the Filter Name for ODT is "Writer 8", but according to filter/source/config/fragments/filters/writer8.xcu in the source code the API name for ODT should be "writer8". The API name should be used in the MediaDescriptor::FilterName rather than the UI name, otherwise the API calling will be wrong and the API then falls back to the default fiter.
* Online help page says "Word 2007–365", but the API name should be "MS Word 2007 XML". 

The solution is not to revise those names on Online Help to those UI names, but to add a new column indicating their corresponding API Names, just like the OpenOffice wiki page did:
Comment 1 Kevin Suo 2021-05-28 15:35:16 UTC
There is a helper script in:

which can be used to update the convertfilters.xhp file. 

Olivier Hallot: I see you had updated that script before, are you going to update it to include the API Names column? If not, then I will take this.

The information should be taken from the oor:name attribute such as:

<node oor:name="MS Excel 4.0" oor:op="replace">

This column will be marked as localize="false" so that no translation is needed.
Comment 2 Olivier Hallot 2021-05-29 00:30:24 UTC
Yes I created helpcontent2/helpers/convertfilters.py, based on Eike Rathke advice.

Please feel free to take for improvements and let me know if you need assistance.
Comment 3 Kevin Suo 2021-05-30 13:14:49 UTC
A path is submitted on gerrit for review:

In my patch, I did some tweak for the python script. The important change is the following:
1. The previously code generated the filters list based on all the Types nodes. However, the problem is that there are duplicated entries (e.g. for writer.xcd there are two oor:component-data/node[@oor:name="Types"] and thus causes duplicates. The revised script takes the last oor:name="Filter" node as the start point, and get the UI Name and API Name information from that node; then, it dig into the oor:name="Types" node to query for the Media Type and Extension info, using the API Name as the key. Since the API Names are unique, no duplicates will be generated, and also we take the order from the xcd files directly and no sorting is done.
2. The previous code uses some random numbers or the "count" sequential numbers for the IDs. However, this will cause problem for translators because once the xhp file is re-generated using this script the IDs will change and thus the translated strings will become fuzzy in the PO files. The revised script uses some fixed words (i.e., the API Names which may not change overtime) for the IDs, thus (best to my knowledge) when re-generated the translations will remain the same if the string is not changed. In theory we can manually edit the xhp file, but there is a lot and mistake may happen and the future maintenance  is not easy. 

I am aware that this change will cause the l10n team to re-translate the strings on this page, but this change will benefit in the long-run.
Comment 4 Commit Notification 2021-05-31 14:45:23 UTC
Kevin Suo committed a patch related to this issue.
It has been pushed to "master":


tdf#142417: Improve convertfilters.py and add API Names column