Voorbeelden van configuratie instellingen op het gedrag van de Model Export Enhancer
Voorbeelden van configuratie instellingen op het gedrag van de Model Export Enhancer
Het converteren van modellen en het genereren van documentatie is voor een belangrijk deel aan te passen. Het uitgangspunt is dat het verhaal dat je wilt vertellen centraal staat en niet de mogelijkheden van een hulpmiddel om te modeleren of een standaard voor modeleren.
Eenvoudig voorbeeld: gedrag van een relatie
Hiernaast staat een diagram van een eenvoudig model van drie elementen van het type 'action'.
Dit model wordt aangemaakt met een standaard moxen bestand en vervolgens verwerkt zonder aanpassingen in de configuratie.
Het model aanmaken
Het moxen bestand hiervoor maakt de drie elementen aan met de relaties.
De relaties krijgen de naam 'flow'.
Het moxen bestand staat in: 'text-model\archives\voorbeelden\instructies'.
Opgelet: In het moxen bestand staat het absolute minimum om een model te maken.
De standaard gegenereerde documentatie
De gegenereerde webpage laat de informatie zien over de 'Activiteit' en de de relaties.
Over relaties zelf is geen informatie te zien. Je wilt zien in welke richting de relatie loopt en op basis van die informatie de webpage verrijken.
De naam van begin en eindpunt aanpassen
De configuratie instelling 'enhance_dependencyName' geeft de mogelijkheid om namen van relaties aan te passen.
Het bestand staat in: '\bat\base\agile\profiles\enhance'. In deze folder staan tal van opties om het gedrag van de generator aan te passen.
Door in het bestand de volgende regel op te nemen, zorg je ervoor dat het begin en het eindpunt van de relatie wordt aangepast.
Op te nemen instelling: 'flow , flow-to ; flow-from'.
Met deze instructie krijgen relaties met de naam 'flow' als beginpunt de naam 'flow-to' en als eindpunt de naam 'flow-from'.
Het gevolg hiervan is dat gegenereerd informatie er anders kan uitzien.
Gevolg voor het verrijkte model
Hiernaast staat een diagram van het verrijkte model van drie elementen van het type 'action'.
Dit model wordt gebruikt voor het genereren van documentatie.
De aangepaste gegenereerde documentatie
De gegenereerde webpage laat nu de informatie over het begin en eindpunt zien van 'Activiteit 2'.
De optie wordt specifiek gestuurd. Er is geen algemeen begin of eindpunt. In het geval van een 'flow' wil je de teksten 'Gestart door:' en 'Start:' zien. Dit is afhankelijk van de naam van het begin en eindpunt en kan in de configuratie van de layout van de pagina worden aangepast.
De gegevens in de gegenereerde documentatie
De inhoud van de gegenereerde documentatie is gedefinieerd in een configuratie bestand in de folder '\bat\base\agile\profiles\layout'.
Je kunt per type element een specifieke configuratie opnemen. In dit voorbeeld is het type van de gebruikte element 'action'. Wanneer in deze folder een bestand aanwezig is met de naam 'topicdescription-action-template.txt'. Bestaat er geen bestand met deze naam dan wordt het bestand 'topicdescription-template.txt' gebruikt. Dit is het bestand dat in de voorbeeld situatie wordt gebruikt.
Wanneer je een type wilt toepassen die niet in de standaard download zit kun je dit bestand aanpassen of zelf een indeling samenstellen.
Definitie gegevens in gegenereerde documentatie
In het bestand om de webpage samen te stellen zijn secties opgenomen voor de namen van relaties. In dit voorbeeld zijn die namen 'flow-to' en 'flow-from'.
De secties worden met de naam 'topicElements' aangeduid.
Elke sectie bevat een stukje HTML die in een webpage wordt geplaatst als een specifieke relatie bestaat. In dit voorbeeld hebben de secties de headers 'Gestart door:' en 'Start:'. Deze secties zijn reeds opgenomen in de configuratie bestanden in de download.
De aanpassing aan de namen van de relaties hebben meteen effect in de gegenereerde documentatie.