Feature Wiki

Information about planned and released features

Tabs

Suggested Process for Preparing Plugin Help packages

Page Overview

[Hide]

1 Screen-ID grammar was published

A guideline for Screen-ID grammar has to be devised and published.  The grammar has become a part of the Development Guide.
Instead of simple component prefixes, you MUST make sure that the is vendor given as a prefix ind the component part i.e. "databay_...". This avoids naming conflicts. 

2 Suggested use of Screen-IDs

ILIAS has a release cycle, the help has one and each Plugin has one of it's own. Plugins should have their own and separate help packages.

Caveat: No Plugin help text must be displayed in the trunk screens. Plugin texts MUST NOT be assigned to a Screen-ID everybody will be displayed with / protrude into the trunk Online Help package. We assume that this approach is working fine for Plugins that are well encapsulated like a virtual classroom, etherpad or flashcards. We are fully aware that this approach is not supporting those Plugins that infiltrate the trunk like the Main Menue Plugin.

3 Suggested Process for Plugin Help

Writing, testing and publishing a help for the Plugins is not part of the tasks of the ILIAS Online Help editorial team. Preparing Plugin Help packages is the responsibility of the users of the plugin, they have to team up with the maintainer of the plugin. The following process is a mere suggestion: 
  1. The Plugin-Maintainer sets up a dedicated Plugin Help infrastructure and installs the Plugin.  
  2. The Plugin-Maintainer adds Screen-IDs to the Plugin-screens. 
  3. The Plugin-Help-Editor creates a learning module for the Plugin Help.
  4. The Plugin-Help-Editor writes help texts and assigns them to the Screen-IDs and ensures permission-sensitivity. 
  5. The Plugin-Help-Editor exports the Plugin Help package once it is considered done.
  6. The Plugin-Help-Editor publishes the Plugin Help package somewhere. The most convenient place for users would be the Online Help section at ilias.de. 
  7. Users download the Plugin Help package.
  8. Users install and activate the Plugin Help package along with the standard Help Package on their ILIAS. 

Last edited: 22. Apr 2022, 11:11, Tödt, Alexandra [atoedt]