New Publication Usages (Sub-usage & groups)

[ferishili]

This PR solves and fixes #182,

Description

see the related issue

Solution

see the list in related issue

Concept

• Instead of adding fallbacks every time, when someone needs another publication usage, this PR introduces the sub- usage method. (currently available only for download)

• Beside subs, one could also group publication usages, but this only affect the presentation of those publications that will be displayed to the users like download, annotation etc.

• Import/Export of newly added tables (subs and groups) are applied.

• The external_download_source setting option has been taken out of the main settings area and added only into DOWNLOAD publication usages and sub-usages.

• The grouped usages/sub-usages will be displayed in a dropdown in the video list. NOTE that if a group consists of only one item, the usage/sub itself will be displayed

• A new field called "Display Name" is added and is also capable of being translated by only adding the related string into the lang strings like follows:

  • pus_display_name_{the display name in lowercase}: For publication sub-usages.
  • pug_display_name_{the display name in lowercase}: For publication groups
  • pu_display_name_{the display name in lowercase}: For publication usages
    (replace {the display name in lowercase} with whatever you entered for display name)

• NOTE: (UPDATED 2) This PR will increase the plugin version to 5.2.1 5.3.1 5.3.2 5.3.3 and needs an (db) update to apply dbupdate 41 42 43 (this will have conflicts with Paella 7 #204) There is no more conflict!

[dagraf]

@reiferschris Did you already test this PR on your installation?

[reiferschris]

Hi @dagraf
we sure did, I just didn't get around to comment yesterday. It works as intended.
We might need to come with a proper place for the explanation that @ferishili wrote in the concept section above. Dare I say documentation?

[reiferschris]

Thanks for all your work on this. It works as intended, so I approve of these changes. Unfortunately I can not comment on the code directly, so I hope someone with more programming knowledge can also review in this regard.

[chfsx]

Thank you @ferishili for the PR, I have written a few comments. The PR is very large, so it is quite difficult to do a comprehensive review. a few general points that i would like to add:

• Introduce typing whenever possible, in paramaters, return types etc.
• Always create new data tables in the database with ilDBInterface

A few more notes so that this is documented: With the PR, many new GUIS and especially tables and forms will be introduced. These are all elements that we will have to revise again very soon because they will no longer be available in ILIAS 10/11 (ilTableGUI, ilPropertyFormGUI, ilAdvancedSelectionListGUI, ...). this is not a criticism of the PR, but something that the community must decide whether it wants and be aware of the costs that this will cause in the future (ping @dagraf, topic for the community meeting).

functionally I could not test the PR, other people are better suited :-)

[dagraf]

@chfsx: Thank you for your comment. Concerning your note to tables and forms: Is there an alternative for the actual solution that would be more 'sustainable'?

[chfsx]

@dagraf this is certainly a problem that cannot really be solved as long as we are supposed to support several versions of ILIAS. for example, the table is only available with ILIAS 8, and even then it is rather limited and certain things might not even be possible to implement. the forms are a little further along, but even there, for example, not all input options are available yet.

[ferishili]

Paella 7 is now merged into this PR from main! and there is no more conflicts, Therefore it is safe to merge this PR when it is approved!

[dagraf]

I did some testing and can confirm that all our publications still work as expected. Please be aware, that i was able to test this PR only rudimentary since we are lacking the use cases to test it proparly. Therefore and @ALL adopters: Please test this PR with your installation and configuration.

Some wordings in English and especially in German need to be improved. @reiferschris is taking care of it. Thx!

[ferishili]

Thanks a lot @dagraf
I will also resolve the conflicts to make it ready for merge!

[ferishili]

Thanks @reiferschris,
I am working on the unified way of using locale strings! and the logical issue.

[ferishili]

Hi @chfsx,
As we discussed, I have provided a new LocaleTrait to handle the display name situations which has a backward compatibility with ILIAS < 8 and uses only the $plugin->txt method.
Please have a look, and if this could solve that problem, I need to use it in other PRs as well.
Thanks in advance

[ferishili]

Hi @reiferschris, that would be great if you could also test the items we talked about. Thanks in advance.

[chfsx]

@ferishili LocaleTrait looks fine from my point of view, thanks!

[dagraf]

I can confirm the improved wordings and that functions still work as expected.

Therefore, and @Amstutz: Can you please review this PR and comment it if needed or merge it? Thx!

[reiferschris]

Hi @reiferschris, that would be great if you could also test the items we talked about. Thanks in advance.

Hi @ferishili thanks for the fix. The optional translations for the publication groups and sub-usages now work as expected. The display-name is used as a fallback in case there is no translation in the ilias_de.lang for example.

[ferishili]

Hi @Amstutz,
Is it possible to have this PR merged soon, so that I can use the new LocaleTrait in order PRs.
Thanks in advance

[dagraf]

@ferishili We will test this PR today or tomorrow and then ask @Amstutz or @chfsx for a review. We will post the results of our tests here.

[dagraf]

This comment #208 (comment) was ment for a different PR. So please ignore it.

This PR is acutally with @chfsx for a review.

[chfsx]

Merged using #230