Show Advanced KnowledgeHide Advanced Knowledge

Online Help: Index

AT 2015-05-22: Please note that the original article "Online Help: Search and Index" was split into two sepearate items. The Index project did not get sufficient funding for implementation in ILIAS 5.1. 
The Search project will be implemented for ILIAS 5.1 

1 Requirements

Index

Using the index:
The index should be available at a prominent place in the little workflow help panel.

• People may find it helpful to get an index organising the content of the workflow help. It might be organiszed in a tree as trees are very common in ILIAS. But the tree will eat up very much of the small creen estate available.
• An alphabet should be displayed to choose a letter from.
• Major topics for a selected letter should be listed and can clicked to display the the related page's titles will unfold when clicking on it.
• Clicking on the page title will open the respective page.
• People can read the page.

Creating the index:
The index has to generated from the key words taged to a page in the online help infrastructure.

• Underneath the Learning Module page authors can tag the page with one or more terms. They can enter and save the terms.
• Help Editors should be able to mark terms as 'related', so looking for one term will produce results of the other related term as well.
• In a luxury version one could choose from a list of controlled vocabulary.
• In a medium version people should be displayed with a list of index tags already in use
• In a plain version people just enter any term without any indication what other people have already entered.
• We would need some overview page that allows to see the index as it has been created.
• Maybe it would be helpful to be able to change or add or remove terms in the overview page.

Since the index requires extra work from translators it should be possible to switch the index off for an installation.

2 Status

• Idea / concept: Alexandra Tödt toedt (at) leifos.com
• Funding: Partly funded by FH Dortmund
• Maintainer: Alexander Killing, Leifos
• Implementation of the feature is done by Alexander Killing, Leifos
• Testcases: tbd

3 Additional Information

• Idea / concept: Alexandra Tödt toedt (at) leifos.com
• Interest in funding: (please indicate if you are interested/able to fund this feature)
• Maintainer: (will be set by Jour Fixe / maintainer)
• Implementation of the feature is done by (will be set by Jour Fixe / maintainer)
• Testcases by: (please add your name if you want to create the testcases for this feature)

4 Discussion

Alex Killing 13 Apr 2014: I support both features. The editing of the keywords for the index should just be the current metadata editing of LOM keywords. I would postpone the mulitlanguage discussion for now.

Matthias Kunkel, 13 Apr 2014: I support the requests for a search and an index in the online help, too. Based on the recommendations by the maintainer and the head of development I schedule the feature for 4.5.

Matthias Kunkel, 28 Feb 2015: This  feature was already scheduled for a previous ILIAS version but not implemented due to missing funding or time. We re-schedule it automatically for 5.1 to save time for discussing new feature requests.

JourFixe, ILIAS [jourfixe], 20 July 2015: We still appreciate this feature and reschedule it for 5.1.

Zenzen, Enrico [ezenzen], 02 SEP 2022: This request no longer fulfills the requirements of the Feature Wiki. In consultation with the maintainer I change the status of the feature request to "Redundant / outdated". If the request is still relevant, please update template and mockups.

5 Implementation

...