KS-Entry: Round-Trip Modal

1 Guideline

• Name: Round-Trip Modal
• DOM, LESS, JS / Screenshot*:

• PHP Class: ilModalGUI
• PHP Example:
• External Library: Bootstrap Modal
• Status of Entry: Proposed
• Status of Implementation: to be implemented
• Description*:
  • Purpose: Round-Trip Modals are to be used if the context would be lost by performing this action otherwise. Round-Trip Modals accommodate sub-workflows within an overriding workflow. The Round-Trip Modal ensures that the users does not leave the trajectory of the overriding workflow. This is typically the case if an ILIAS service is called for while in working in an object.
  • Composition: Round-Trip Modals are completed by a small well defined sequence of 2 steps max. that might be displayed on a sequence of different modals connected through some “next” Button.
  • Effect: Round-Trip Modals perform sub-workflow involving some kind of user input. Sub-workflow is completed and user is returned to starting point allowing for continuing the overriding workflow.
• Background:
• Context*: Adding an Internal Link in the ILIAS Page Editor is done with a Modal. The overriding workflow is “page editing” the sub-workflow is “adding internal link”.
• Rules:
  • Round-Trip Modals MUST contain at least two buttons at the bottom of the modals: a button to cancel (right) the workflow and a button to finish or reach the next step in the workflow (left).
  • Round-Trip Modals SHOULD be used, if the user would lose the context otherwise. If the action can be performed within the same context (e.g. add a post in a forum, edit a wiki page), a Round-Trip Modal MUST NOT be used.
  • When the workflow is completed, Round-Trip Modals SHOULD show the same view as was displayed when initiating the Modal.
  • Round-Trip Modals SHOULD NOT be used to add new items of any kind since adding item is a linear workflow redirecting to the newly added item setting- or content-tab.
  • Round-Trip Modals SHOULD NOT be used to perform complex workflows.

• Relations
  • Is A: KS-Entry: Modal

2 Todo in ILIAS 5.2

• “Write New Mail” from the Members-tab in courses or groups should be implemented as Round-Trip Modals. The reduction of the mail functionality (no recipients picking i.e.) is acceptable.
• Add taxonomies (f.e. metadata)

• Test question type “close question” uses modals to write in the answer text. But not all functionalities (f.e. Type of the gap) can be set here.

3 Status

• Effective from release: ILIAS 5.2
  
• Approved by Jour Fixe at: JourFixe-2015-12-07
• Implementation status: needs implementation
  
• Funding for streamlining existing features: { name of organisation }
• Implementation of guideline: { all developers | name of responsible developer }

4 Components that are not compliant with the Guideline

• …

5 Discussion

JourFixe, ILIAS [jourfixe], Dec 07, 2015: Accepted by Jour Fixe. Related feature requests should be added to wiki (todo...) and presented to JF for final acceptance.