Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision 7181d6b0

Von Moritz Bunkus vor etwa 8 Jahren hinzugefügt

  • ID 7181d6b0dee520b04698b36841708b7fb2fd2e11
  • Vorgänger f7540837
  • Nachfolger 43a3d479

Hilfesystem: Doku für Aktivierung des Hilfesystems

Unterschiede anzeigen:

doc/help_system.md
2 2

  
3 3
Im Layout wird immer ein Hilfe-Link gerendert. Dieser öffnet ein Popupfenster und ruft darin die Action `Help/show` auf. Ihr wird eine Kontextinformation übergeben, mit der der Controller entscheiden kann, welche Hilfeseite angezeigt wird. Diese Kontextinformation wird automatisch aus dem aktuellen Controller und der aktuellen Action abgeleitet, kann aber im Controller überschrieben werden.
4 4

  
5
## Aktivierung
6

  
7
Da ein Hilfesystem ohne Inhalt wenig Sinn ergibt, ist es momentan per default deaktiviert. Um es einzuschalten, muss man in der `kivitendo.conf` einen Schalter setzen:
8

  
9
```
10
[devel]
11
enable_help_system = 1
12
```
13

  
14
Nur wenn es aktiviert, wird auch ein Hilfelink auf jeder Seite in der Kopfzeile angezeigt.
15

  
5 16
## Popup-Fenster
6 17

  
7 18
Hilfetexte werden in einem Popup-Fenster angezeigt. Das Link-Target für dieses Popup lautet `_kivitendo_help`.

Auch abrufbar als: Unified diff