Imvertor / Imvertor-Maven

Mavenized version of Imvertor
http://www.imvertor.org
7 stars 12 forks source link

Plaatjes kunnen uitlezen en verwerken in de Respec catalogus #467

Open ArjanLoeffen opened 3 months ago

ArjanLoeffen commented 3 months ago

Imvertor kan de XMI en de diagrammen, wanneer correct aangeleverd, verwerken in aangeboden catalogus documentatievorm (op dit moment Respec en MsWord). Onderzoek of het mogelijk is ook andere plaatjes, gebonden aan een construct in de UML en/of aan de notities daarop, op te nemen in de uiteindelijke catalogus info.

Neem hierbij ook mee dat deze plaatjes vanuit Enterprise Architect zouden kunnen worden aangeleverd.

ArjanLoeffen commented 3 months ago

Het is niet mogelijk om plaatjes direct op te nemen in een notitie in EA. Vanuit de notities moet dus worden verwezen naar een plaatje dat op en andere manier is opgenomen in EA, en dat daarvandaan door Imvertor kan worden ingevoegd op de juiste plek.

Mogelijk aanpak zoeken in:

Diagram plaatje

Plaatjes drag&drop op een diagram dat speciaal daarvoor is geïntroduceerd. Dit "diagram plaatje" kan dan worden ingevoegd op de plek waar er naar verwezen is, door middel van een Hyperlink/Diagram image.

Link naar File

Alle plaatjes kunnen á la Documentor worden verzameld op een vaste plek en meegeleverd in het Respec documentatie proces. Naar betreffende plaatje kan worden verwezen via Hyperlink/File.

Link naar Image manager

Het plaatje kan worden ingeladen via de image manager (Settings/Images). De image manager kan worden aangevuld met Add new.

Via properties dialoog

Je kunt ook een file (plaatje) toevoegen in de "Properties" dialoog van bv een Class/Objectype. Het is hiermee echter niet mogelijk te verwijzen vanuit een plek in notities naar dat plaatje.

Te kiezen oplossing?

Er lijken twee oplossingen acceptabel:

Er is nog wel wat uit te zoeken m.b.t. omvang en plaatsing van de plaatjes.

ArjanLoeffen commented 3 months ago

Binnen de EA Ad-in is een voorziening opgenomen om alle files die zich bevinden in een zgn. modeldoc folder mee te leveren aan Imvertor. Imvertor selecteert de MsWord bestanden uit deze (sub)folder(s) en zet ze om naar hoofdstukken in de Respec documentatie (mits zo geconfigureerd). image

Wanneer men besluit andere info in betreffende modeldoc folder op te nemen wordt die ook meegeleverd. Dus zonder de add-in te hoeven aanpassen wordt het Imvertor proces aangestuurd met aanlevering van al deze files.

In notities kan men op willekeurige plekken een koppeling naar een van deze files opnemen, zoals in eerder commentaar besproken. Imvertor is erop in te richten deze referenties te interpreteren en dit om te zetten in een acceptabele weergave in de Respec documentatie. Voor de hier besproken eisen is dat: plaats het plaatje (PNG, JPG o.i.d.) op betreffende plek in de Respec catalogus. Voor andere typen bestanden zijn andere functies bespreekbaar maar nu out of scope.

Deze functionaliteit wordt dan onderdeel van Documentor. Dat is dus nog géén onderdeel van Imvertor OS maar van een Armatiek functionaliteit die wel is geïntegreerd met Imvertor, maar als aparte server applicatie beschikbaar is. Deze is voor alle Imvertor gebruikers die via de Armatiek SaaS Imvertor aanspreken beschikbaar.

NB Op termijn wordt overwogen deze functie onderdeel te maken van Imvertor OS.

ArjanLoeffen commented 3 months ago

Eerste resultaat voor deze aanpak stemt hoopvol: image

Vereist is (nog) wel dat Documentor wordt gebruikt voor het samenstellen van de Respec content.

ArjanLoeffen commented 2 months ago

Deze is nu ook geïmplementeerd:

Beste optie voor iedereen: gebruik de image manager.

De images die als base64 worden geleverd in de XMI export worden aan het begin van het verwerkingsproces uitgelezen en omgezet naar een plaatje in de /Images folder. Hierdoor is de XMI niet zo omvangrijk zodat er hierdoor geen geheugenproblemen zullen optreden.

Beide oplossingen zijn nu beschikbaar en kunnen worden getest.