Feature Wiki

Information about planned and released features

Onglets

KS-Entry: Glyph

Aperçu de Page

[Masquer]

1 Guideline

  • DOM, LESS, JS / Screenshot*:
    • Less
      1. Color: link-color
      2. Hover Color: link-hover-color
  • PHP Class: ilGlyphGUI
  • PHP Example:
  • External Library: Bootstrap Glyph
  • Status of Entry: To be revised
  • Status of Implementation: to be implemented
  • Description*:
    • Purpose: Glyphs map a generally known concept or symbol to a specific concept in ILIAS. Glyphs are used when space is scarce.
    • Composition: A Glyph is a typographical character representing something else. As any other typographical character, Glyphs can be manipulated by regular CSS. Upon hovering they change to the link-hover-color to indicate possible interactions.
    • Effect: Glyphs act as trigger for some action such as opening a certain Overlay type or as shortcut.
    • Rival Elements:
      1. Icon: Standalone Icons are not interactive. Icons can be in an interactive container however. Icons merely serve as additional hint of the functionality described by some title. Glyphs are visually distinguished from object icons: they are monochrome.
  • Background: “In typography, a glyph is an elemental symbol within an agreed set of symbols, intended to represent a readable character for the purposes of writing and thereby expressing thoughts, ideas and concepts.” Lidwell states that such symbols are used ”to improve the recognition and recall of signs and controls”.
  • Feature Wiki Reference:
  • Context*:
  • Rules:
    • Usage:
      1. Glyphs MUST NOT be used in Content Titles.
      2. Glyphs MUST be used for cross-sectional functionality as mail or comments for example and NOT for representing objects.
      3. Glyphs SHOULD be used to trigger tasks available at many places throughout the system.
      4. Services such as mail MAY be represented by a glyph and an icon.
    • Style:
      1. All Glyphs SHOULD be taken from the Bootstrap Glyphicon Halflings set.
    • Accessability:
      1. The functionality triggered by the Glyph must be indicated to screen readers with by the attribute aria-label. If the Glyph accompanies some text describing the functionality of the triggered, this MUST be indicated by the aria-labelledby attribute.
  • Relations:
    • Is A: Trigger Element
    • Must Use:
    • May Use:
  • Todo in ILIAS 5.2:
    • Less:
      1. Use link-color and link-hover-color
 

2 Status

  • Effective from release: Release 5.2
  • Approved by Jour Fixe at: Workshop-2016-06-21
  • Implementation status: partly implemented
  • Funding for streamlining existing features: Universität Bern
  • Implementation of guideline: { all developers | name of responsible developer }

3 Components that are not compliant with the Guideline

  • …

4 Discussion

JourFixe, ILIAS [jourfixe], June 21, 2016: Highly appreciated and scheduled for 5.2.

Dernière édition: 21. juin 2016, 11:43, Kunkel, Matthias [mkunkel]