KS-Entry: Reporting Panel

1 Guideline

• DOM, LESS, JS / Screenshot*:

• PHP Class:
• PHP Example:
• External Library:
• Status of Entry: To be revised
• Status of Implementation: to be implemented
•  Description:
  • Purpose: Bulletins display user-generated data combining text in lists, tables and sometimes  charts. Bulletins always draw from two distinct sources: the structure / scaffolding of the Bulletins stems from user-generated content (i.e a question of a survey, a competence with levels) and is filled with user-generated content harvested by that very structure (i.e. participants’ answers to the question, self-evaluation of competence).
  • Composition: They comprise the structured content used to harvest input and the harvested input alongside: the text of the harvesting structure is given in full length with a headline, label of subitems, text of subitems in bulleted lists. This may be followed by a table comprising or aggregating the harvested input. This might be followed by a picture or a graph.
  • Effect: Bulletinss are predominantly used for displaying data. They may however comprise Links or Buttons.
• Rival Elements:
• Background:
• Feature Wiki Reference:
• Context*: Review Blocks are to be used in the Results-tab of the survey, in the stamped-in Competences of a portfolio, in the Layout section of the Administration.
• Rules:
  • Interaction:
    1. Links MAY be used in Bulletins to open new views.
    2. Buttons MAY trigger actions or inline editing
  • Wording: Review Block MUST use the following information hierarchy

• • Style:
  • Ordering: The Sections in the Bulletin MUST be ordered as follows: 1. Text, 2. Table, 3. Chart or picture
  • Responsiveness:
  • Accessibility:

• Relations:
  • Is A: Container Collection
  • Must Use: Heading Panel
  • May Use: Link, Button
• Todo in ILIAS 5.2: The following projects will use the bulletin concept 
  • KS: Integration in Layout and Styles
  • Bulletin presentation for Survey Results
  • Competence Management - presentation of competence results

2 Status

• Effective from release: { not approved yet | x.y }
• Approved by Jour Fixe at: { link to Jour Fixe agenda }
  
• Implementation status: { implemented completely | partly implemented | needs implementation }
• Funding for streamlining existing features: { name of organisation }
• Implementation of guideline: { all developers | name of responsible developer }

3 Components that are not compliant with the Guideline

• …

4 Discussion

2016-04-18: For the little Context-Block in the Testual element the code from the wiki for th metadata-block could be pushhed.  

JourFixe, ILIAS [jourfixe], June 20, 2016: We highly appreciate this suggestion and schedule the feature for 5.2.