| Version 2 (modified by henk, 5 years ago) (diff) |
|---|
TOC(Heading=Helpcontext instellen)? TOC(heading=Procedures, sectionindex, compact, depth=3, allactive, Documentatie/Ontwikkelaar/Procedures/)? TOC(heading=Ontwikkelaar, sectionindex, compact, depth=2, allactive, Documentatie/Ontwikkelaar/)? TOC(heading=Documentatie, sectionindex, compact, depth=1, allactive, Documentatie/)?
Helpcontext instellen
OpenAC 3 kent een contextgevoelige hulpfunctie. Een gebruiker kan een relevante helppagina openen met [F1] of door de (i) knop rechtsboven in het scherm te gebruiken. Deze pagina beschrijft hoe je in de front-end een scherm kunt aanmelden voor contextgevoelige hulp.
Je meldt een scherm aan met de functie setHelpcontext. Deze functie is een mutatiefunctie in de vuex app-store. Om deze functie te kunnen gebruiken moet je mapMutations importeren uit vuex als dit nog niet is gedaan:
Vervolgens moet je de functie declareren bovenin de methods sectie van het scherm:
Daarna kun je de helpcontext instellen met een aanroep van setHelpcontext in de created sectie:
De helpcontext is alles na https://www.fenac.nl/openac/wiki/Documentatie/ uit de url van de helppagina.
Werk-, controle- en planlijsten
Hoewel alle werklijsten een scherm delen, is het toch mogelijk om een aparte helpcontext in te stellen per lijst. Dat gebeurt in de back-end bij de LijstConfig van de betreffende lijst:
config = new LijstConfig
{
Soort = Lijstsoort.Controlelijst,
Id = "s040.CBS",
Letter = "I",
Naam = "Bestanden met een statuskleur",
Omschrijving = "Bestanden met een statuskleur.",
Helpcontext = "Gebruiker/Controlelijsten/StatusKleur"
};
Aan de front-end hoef je niets te doen. Als je geen helpcontext instelt voor een lijst dan stelt OpenAC de helpcontext automatisch op Gebruiker/Controlelijsten voor controlelijsten, Gebruiker/Planlijsten voor planlijsten en Gebruiker/Werklijsten voor werklijsten. Voor de meeste lijsten is dit ok omdat ze (nu nog?) op één pagina worden beschreven.