Feature Wiki
Tabs
Include Help Package in Release
Page Overview
[Hide]1 Initial Problem
Help package need to be known of and downloaded.
2 Conceptual Summary
If there is a Help Package for a specific ILIAS Release it should be included into the release package. The hep package will be prepare later in the release cycle, thus it cannot be included befor x.x.6 or later.
The entire zip Help package should be manually uploaded to the git as a binary file.
3 User Interface Modifications
3.1 List of Affected Views
Administration > Help
3.2 User Interface Details
Administration > Help
- The help administration screen gets a new button to activate the included help package. "Load Default Help Package"
3.3 New User Interface Concepts
{If the proposal introduces any completely new user interface elements, you might consult UI Kitchen Sink in order to find the necessary information to propose new UI-Concepts. Note that any maintainer might gladly assist you with this.}
4 Technical Information
{The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues.}
5 Contact
- Author of the Request: Tödt, Alexandra [atoedt]
- Maintainer: Killing, Alexander [alex]
- Implementation of the feature is done by: {The maintainer must add the name of the implementing developer.}
6 Funding
If you are interest in funding this feature, please add your name and institution to this list.
- …
7 Discussion
Kunkel, Matthias [mkunkel], 27 MAY 2019 : I do not understand this request. What is the benefit of having the help package as a zip file within my ILIAS software package? At the time being, the zip file needs to be uploaded from one's own hard disk to ILIAS. There is currently no procedure to upload it from a server's local directory (or from getting it straight from GitHub or somewhere else). Such a new procedure is not suggested in this request either. I fully agree with the idea to make it easier for users getting the help running on their installation. But the request in the current version won't be a step towards this goal.
Kunkel, Matthias [mkunkel], 28 MAY 2019 : Thanks for the additional information about the button to load (or better "Install"?) the online help package. This makes much more sense.
JourFixe, ILIAS [jourfixe], 03 JUN 2019 : We highly appreciate this suggestion and schedule it for 6.0. We prefer not to add the help package to Git but to offer them on the ILIAS server. A final solution should be presented in the Implementation chapter below.
8 Implementation
{The maintainer has to give a description of the final implementation and add screenshots if possible.}
Test Cases
Test cases completed at {date} by {user}
- {Test case number linked to Testrail} : {test case title}
Approval
Approved at {date} by {user}.
Last edited: 3. Jun 2019, 16:16, Kunkel, Matthias [mkunkel]