Petter Reinholdtsen: PlantUML for text based UML diagram modelling

+@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +

Release 0.3 of free software archive API system Nikita announced @@ -289,7 +451,7 @@ enda bedre?

February (3)

March (2)

March (3)

@@ -627,7 +789,7 @@ enda bedre?

@@ -663,13 +825,13 @@ enda bedre?

multimedia (42)

nice free software (11)

nice free software (12)

offentlig innsyn (36)

@@ -701,7 +863,7 @@ enda bedre?

diff --git a/blog/index.html b/blog/index.html index 822430543c..d42515af4f 100644 --- a/blog/index.html +++ b/blog/index.html @@ -19,6 +19,162 @@ +

PlantUML for text based UML diagram modelling - nice free software

25th March 2019

As part of my involvement with the +Nikita +Noark 5 core project, I have been proposing improvements to the +API specification created by The +National Archives of Norway and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text.

+ +

The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute.

+ +

I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +list +of text mode uml tools, and tested out a few of the tools listed +there. The PlantUML tool seemed +most promising. After verifying that the packages +is available in +Debian and found its +Java source under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +the +Noark 5 Tjenestegrensesnitt specification. I am happy to report +that it could represent them, even thought it have a few warts here +and there.

+ +

After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +the +github issue discussing the need for a text based UML format, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF.

+ +

Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents:

+ +

+@startuml
+skinparam classAttributeIconSize 0
+
+!include media/uml-class-arkivskaper.iuml
+!include media/uml-class-arkiv.iuml
+!include media/uml-class-klassifikasjonssystem.iuml
+!include media/uml-class-klasse.iuml
+!include media/uml-class-arkivdel.iuml
+!include media/uml-class-mappe.iuml
+!include media/uml-class-merknad.iuml
+!include media/uml-class-registrering.iuml
+!include media/uml-class-basisregistrering.iuml
+!include media/uml-class-dokumentbeskrivelse.iuml
+!include media/uml-class-dokumentobjekt.iuml
+!include media/uml-class-konvertering.iuml
+!include media/uml-datatype-elektronisksignatur.iuml
+
+Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv
+Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv
+Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel
+Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel
+Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse
+Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe
+Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering
+Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe
+Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering
+Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe
+Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering
+Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe
+Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse
+Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering
+Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering
+Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse
+Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt
+Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering
+Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt
+@enduml
+

+ +

The format is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +media/uml-class-arkivskaper.iuml:

+ ++@startuml +class Arkivstruktur.Arkivskaper { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml + + +This is what the complete diagram for the PlantUML notation above +look like: + + + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +exiftool. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. +

+ + + + Tags: english, nice free software, noark5, nuug, standard. + + + +

+ + Release 0.3 of free software archive API system Nikita announced 24th March 2019 @@ -1001,66 +1157,6 @@ activities, please send Bitcoin donations to my address - - Learn to program with Minetest on Debian - 15th December 2018 - A fun way to learn how to program -Python is to follow the -instructions in the book -"Learn to program -with Minecraft", which introduces programming in Python to people -who like to play with Minecraft. The book uses a Python library to -talk to a TCP/IP socket with an API accepting build instructions and -providing information about the current players in a Minecraft world. -The TCP/IP API was first created for the Minecraft implementation for -Raspberry Pi, and has since been ported to some server versions of -Minecraft. The book contain recipes for those using Windows, MacOSX -and Raspian. But a little known fact is that you can follow the same -recipes using the free software construction game -Minetest. - -There is a -Minetest module implementing the same API, making it possible to -use the Python programs coded to talk to Minecraft with Minetest too. -I -uploaded -this module to Debian two weeks ago, and as soon as it clears the -FTP masters NEW queue, learning to program Python with Minetest on -Debian will be a simple 'apt install' away. The Debian package is -maintained as part of the Debian Games team, and -the -packaging rules are currently located under 'unfinished' on -Salsa. - -You will most likely need to install several of the Minetest -modules in Debian for the examples included with the library to work -well, as there are several blocks used by the example scripts that are -provided via modules in Minetest. Without the required blocks, a -simple stone block is used instead. My initial testing with a analog -clock did not get gold arms as instructed in the python library, but -instead used stone arms. - -I tried to find a way to add the API to the desktop version of -Minecraft, but were unable to find any working recipes. The -recipes -I found are only -working with a standalone Minecraft server setup. Are there any -options to use with the normal desktop version? - -As usual, if you use Bitcoin and want to show your support of my -activities, please send Bitcoin donations to my address -15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. - - - - - Tags: debian, english. - - - - - - @@ -1076,7 +1172,7 @@ activities, please send Bitcoin donations to my address February (3) -March (2) +March (3) @@ -1414,7 +1510,7 @@ activities, please send Bitcoin donations to my address drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1450,13 +1546,13 @@ activities, please send Bitcoin donations to my address multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1488,7 +1584,7 @@ activities, please send Bitcoin donations to my address skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/index.rss b/blog/index.rss index 69423e0e19..4d8878cb13 100644 --- a/blog/index.rss +++ b/blog/index.rss @@ -6,6 +6,156 @@ http://people.skolelinux.org/pere/blog/ + + PlantUML for text based UML diagram modelling - nice free software + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + Mon, 25 Mar 2019 09:35:00 +0100 + As part of my involvement with the +<a href="https://gitlab.com/OsloMet-ABI/nikita-noark5-core/">Nikita +Noark 5 core project</a>, I have been proposing improvements to the +API specification created by <a href="https://www.arkivverket.no/">The +National Archives of Norway</a> and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +<a href="https://modeling-languages.com/text-uml-tools-complete-list/">list +of text mode uml tools</a>, and tested out a few of the tools listed +there. <a href="http://plantuml.com/">The PlantUML tool</a> seemed +most promising. After verifying that the packages +<a href="https://tracker.debian.org/pkg/plantuml">is available in +Debian</a> and found <a href="https://github.com/plantuml/plantuml">its +Java source</a> under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/">the +Noark 5 Tjenestegrensesnitt specification</a>. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/issues/76">the +github issue discussing the need for a text based UML format</a>, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + +<pre> +@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +</pre> + +<a href="http://plantuml.com/class-diagram">The format</a> is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +<tt>media/uml-class-arkivskaper.iuml<tt>: + +<pre> +@startuml +class Arkivstruktur.Arkivskaper <Arkivenhet> { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml +</pre> + +This is what the complete diagram for the PlantUML notation above +look like: + +<img width="80%" src="http://people.skolelinux.org/pere/blog/images/2019-03-25-noark5-plantuml-diagrameksempel.png"> + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +<tt>exiftool</tt>. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. + + + Release 0.3 of free software archive API system Nikita announced http://people.skolelinux.org/pere/blog/Release_0_3_of_free_software_archive_API_system_Nikita_announced.html @@ -928,60 +1078,6 @@ remaining piece in the puzzle is Open Broadcast Encoder, but it depend on quite a lot of patched libraries which would have to be included in Debian first. -As usual, if you use Bitcoin and want to show your support of my -activities, please send Bitcoin donations to my address -<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. - - - - - Learn to program with Minetest on Debian - http://people.skolelinux.org/pere/blog/Learn_to_program_with_Minetest_on_Debian.html - http://people.skolelinux.org/pere/blog/Learn_to_program_with_Minetest_on_Debian.html - Sat, 15 Dec 2018 15:30:00 +0100 - A fun way to learn how to program -<a href="https://www.python.org/">Python</a> is to follow the -instructions in the book -"<a href="https://nostarch.com/programwithminecraft">Learn to program -with Minecraft</a>", which introduces programming in Python to people -who like to play with Minecraft. The book uses a Python library to -talk to a TCP/IP socket with an API accepting build instructions and -providing information about the current players in a Minecraft world. -The TCP/IP API was first created for the Minecraft implementation for -Raspberry Pi, and has since been ported to some server versions of -Minecraft. The book contain recipes for those using Windows, MacOSX -and Raspian. But a little known fact is that you can follow the same -recipes using the free software construction game -<a href="https://minetest.net/">Minetest</a>. - -There is <a href="https://github.com/sprintingkiwi/pycraft_mod">a -Minetest module implementing the same API</a>, making it possible to -use the Python programs coded to talk to Minecraft with Minetest too. -I -<a href="https://ftp-master.debian.org/new/minetest-mod-pycraft_0.20%2Bgit20180331.0376a0a%2Bdfsg-1.html">uploaded -this module</a> to Debian two weeks ago, and as soon as it clears the -FTP masters NEW queue, learning to program Python with Minetest on -Debian will be a simple 'apt install' away. The Debian package is -maintained as part of the Debian Games team, and -<a href="https://salsa.debian.org/games-team/unfinished/minetest-mod-pycraft">the -packaging rules</a> are currently located under 'unfinished' on -Salsa. - -You will most likely need to install several of the Minetest -modules in Debian for the examples included with the library to work -well, as there are several blocks used by the example scripts that are -provided via modules in Minetest. Without the required blocks, a -simple stone block is used instead. My initial testing with a analog -clock did not get gold arms as instructed in the python library, but -instead used stone arms. - -I tried to find a way to add the API to the desktop version of -Minecraft, but were unable to find any working recipes. The -<a href="https://www.epiphanydigest.com/tag/minecraft-python-api/">recipes</a> -I <a href="https://github.com/kbsriram/mcpiapi">found</a> are only -working with a standalone Minecraft server setup. Are there any -options to use with the normal desktop version? - As usual, if you use Bitcoin and want to show your support of my activities, please send Bitcoin donations to my address <a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. diff --git a/blog/jXplorer__a_very_nice_LDAP_GUI.html b/blog/jXplorer__a_very_nice_LDAP_GUI.html index eec97dc83b..9beab3dd25 100644 --- a/blog/jXplorer__a_very_nice_LDAP_GUI.html +++ b/blog/jXplorer__a_very_nice_LDAP_GUI.html @@ -60,7 +60,7 @@ and remove the failing query. Nothing big, but very annoying. February (3) -March (2) +March (3) @@ -398,7 +398,7 @@ and remove the failing query. Nothing big, but very annoying. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -434,13 +434,13 @@ and remove the failing query. Nothing big, but very annoying. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -472,7 +472,7 @@ and remove the failing query. Nothing big, but very annoying. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/listadmin__the_quick_way_to_moderate_mailman_lists___nice_free_software.html b/blog/listadmin__the_quick_way_to_moderate_mailman_lists___nice_free_software.html index 063d291e36..bc53f663e6 100644 --- a/blog/listadmin__the_quick_way_to_moderate_mailman_lists___nice_free_software.html +++ b/blog/listadmin__the_quick_way_to_moderate_mailman_lists___nice_free_software.html @@ -129,7 +129,7 @@ sure why. February (3) -March (2) +March (3) @@ -467,7 +467,7 @@ sure why. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -503,13 +503,13 @@ sure why. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -541,7 +541,7 @@ sure why. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/sitemap.xml b/blog/sitemap.xml index 3ae17c220b..dbda338290 100644 --- a/blog/sitemap.xml +++ b/blog/sitemap.xml @@ -2470,6 +2470,11 @@ 0.50 weekly + + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + 0.50 + weekly + http://people.skolelinux.org/pere/blog/Pledge_for_funding_to_the_Gnash_project_to_get_AVM2_support.html 0.50 diff --git a/blog/syslog_trusted_timestamp___chain_of_trusted_timestamps_for_your_syslog.html b/blog/syslog_trusted_timestamp___chain_of_trusted_timestamps_for_your_syslog.html index bff330f7f4..a773c7de3f 100644 --- a/blog/syslog_trusted_timestamp___chain_of_trusted_timestamps_for_your_syslog.html +++ b/blog/syslog_trusted_timestamp___chain_of_trusted_timestamps_for_your_syslog.html @@ -153,7 +153,7 @@ activities, please send Bitcoin donations to my address February (3) -March (2) +March (3) @@ -491,7 +491,7 @@ activities, please send Bitcoin donations to my address drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -527,13 +527,13 @@ activities, please send Bitcoin donations to my address multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -565,7 +565,7 @@ activities, please send Bitcoin donations to my address skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/systemd__an_interesting_alternative_to_upstart.html b/blog/systemd__an_interesting_alternative_to_upstart.html index a29654cd71..53f1c27e7a 100644 --- a/blog/systemd__an_interesting_alternative_to_upstart.html +++ b/blog/systemd__an_interesting_alternative_to_upstart.html @@ -78,7 +78,7 @@ with parallel booting enabled by default. February (3) -March (2) +March (3) @@ -416,7 +416,7 @@ with parallel booting enabled by default. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -452,13 +452,13 @@ with parallel booting enabled by default. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -490,7 +490,7 @@ with parallel booting enabled by default. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/3d-printer/index.html b/blog/tags/3d-printer/index.html index 5bb5920cdf..a6a1792bf3 100644 --- a/blog/tags/3d-printer/index.html +++ b/blog/tags/3d-printer/index.html @@ -758,7 +758,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. February (3) -March (2) +March (3) @@ -1096,7 +1096,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1132,13 +1132,13 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1170,7 +1170,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/amiga/index.html b/blog/tags/amiga/index.html index b088843eba..fcb4e06d50 100644 --- a/blog/tags/amiga/index.html +++ b/blog/tags/amiga/index.html @@ -64,7 +64,7 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? February (3) -March (2) +March (3) @@ -402,7 +402,7 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -438,13 +438,13 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -476,7 +476,7 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/aros/index.html b/blog/tags/aros/index.html index 7ec3aa1d1d..f4c7ab9f23 100644 --- a/blog/tags/aros/index.html +++ b/blog/tags/aros/index.html @@ -64,7 +64,7 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? February (3) -March (2) +March (3) @@ -402,7 +402,7 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -438,13 +438,13 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -476,7 +476,7 @@ pakke. Kanskje Aros kunne vÃ¦rt interessant for et NUUG-foredrag? skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/bankid/index.html b/blog/tags/bankid/index.html index 9b2054bae7..f7cb236a86 100644 --- a/blog/tags/bankid/index.html +++ b/blog/tags/bankid/index.html @@ -476,7 +476,7 @@ omtalt over. Anbefalt lesning. February (3) -March (2) +March (3) @@ -814,7 +814,7 @@ omtalt over. Anbefalt lesning. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -850,13 +850,13 @@ omtalt over. Anbefalt lesning. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -888,7 +888,7 @@ omtalt over. Anbefalt lesning. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/betalkontant/index.html b/blog/tags/betalkontant/index.html index 97c2851bce..cd50925733 100644 --- a/blog/tags/betalkontant/index.html +++ b/blog/tags/betalkontant/index.html @@ -1618,7 +1618,7 @@ kontanter for noen dager siden. February (3) -March (2) +March (3) @@ -1956,7 +1956,7 @@ kontanter for noen dager siden. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1992,13 +1992,13 @@ kontanter for noen dager siden. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -2030,7 +2030,7 @@ kontanter for noen dager siden. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/bitcoin/index.html b/blog/tags/bitcoin/index.html index 0aa3d0d4b7..94483541cd 100644 --- a/blog/tags/bitcoin/index.html +++ b/blog/tags/bitcoin/index.html @@ -879,7 +879,7 @@ donations to the address February (3) -March (2) +March (3) @@ -1217,7 +1217,7 @@ donations to the address drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1253,13 +1253,13 @@ donations to the address multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1291,7 +1291,7 @@ donations to the address skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/bootsystem/index.html b/blog/tags/bootsystem/index.html index 4eb64b48bc..08ffb909ff 100644 --- a/blog/tags/bootsystem/index.html +++ b/blog/tags/bootsystem/index.html @@ -1322,7 +1322,7 @@ insserv'. Will need to test if that work. :) February (3) -March (2) +March (3) @@ -1660,7 +1660,7 @@ insserv'. Will need to test if that work. :) drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1696,13 +1696,13 @@ insserv'. Will need to test if that work. :) multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1734,7 +1734,7 @@ insserv'. Will need to test if that work. :) skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/bsa/index.html b/blog/tags/bsa/index.html index 66791beb23..4e2c2886c5 100644 --- a/blog/tags/bsa/index.html +++ b/blog/tags/bsa/index.html @@ -152,7 +152,7 @@ pÃ¥ Slashdot. February (3) -March (2) +March (3) @@ -490,7 +490,7 @@ pÃ¥ Slashdot. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -526,13 +526,13 @@ pÃ¥ Slashdot. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -564,7 +564,7 @@ pÃ¥ Slashdot. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/chrpath/index.html b/blog/tags/chrpath/index.html index 04f0b4bd30..f22778efb5 100644 --- a/blog/tags/chrpath/index.html +++ b/blog/tags/chrpath/index.html @@ -159,7 +159,7 @@ include a testsuite check. February (3) -March (2) +March (3) @@ -497,7 +497,7 @@ include a testsuite check. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -533,13 +533,13 @@ include a testsuite check. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -571,7 +571,7 @@ include a testsuite check. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/debian edu/index.html b/blog/tags/debian edu/index.html index dfef6b14a0..ee396b271e 100644 --- a/blog/tags/debian edu/index.html +++ b/blog/tags/debian edu/index.html @@ -14952,7 +14952,7 @@ be the only one fitting our needs. :/ February (3) -March (2) +March (3) @@ -15290,7 +15290,7 @@ be the only one fitting our needs. :/ drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -15326,13 +15326,13 @@ be the only one fitting our needs. :/ multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -15364,7 +15364,7 @@ be the only one fitting our needs. :/ skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/debian-handbook/index.html b/blog/tags/debian-handbook/index.html index 3a0540b0c2..13dce90140 100644 --- a/blog/tags/debian-handbook/index.html +++ b/blog/tags/debian-handbook/index.html @@ -199,7 +199,7 @@ available for many more languages. February (3) -March (2) +March (3) @@ -537,7 +537,7 @@ available for many more languages. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -573,13 +573,13 @@ available for many more languages. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -611,7 +611,7 @@ available for many more languages. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/debian/index.html b/blog/tags/debian/index.html index 89d8d18428..44837dc28b 100644 --- a/blog/tags/debian/index.html +++ b/blog/tags/debian/index.html @@ -13748,7 +13748,7 @@ be the only one fitting our needs. :/ February (3) -March (2) +March (3) @@ -14086,7 +14086,7 @@ be the only one fitting our needs. :/ drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -14122,13 +14122,13 @@ be the only one fitting our needs. :/ multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -14160,7 +14160,7 @@ be the only one fitting our needs. :/ skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/digistan/index.html b/blog/tags/digistan/index.html index 0dfe034e95..857ef2f95a 100644 --- a/blog/tags/digistan/index.html +++ b/blog/tags/digistan/index.html @@ -1441,7 +1441,7 @@ produkter basert pÃ¥ standarden. February (3) -March (2) +March (3) @@ -1779,7 +1779,7 @@ produkter basert pÃ¥ standarden. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1815,13 +1815,13 @@ produkter basert pÃ¥ standarden. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1853,7 +1853,7 @@ produkter basert pÃ¥ standarden. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/dld/index.html b/blog/tags/dld/index.html index 6125023f91..8f2b2eced1 100644 --- a/blog/tags/dld/index.html +++ b/blog/tags/dld/index.html @@ -1592,7 +1592,7 @@ fÃ¥r snart se om det stemmer. February (3) -March (2) +March (3) @@ -1930,7 +1930,7 @@ fÃ¥r snart se om det stemmer. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1966,13 +1966,13 @@ fÃ¥r snart se om det stemmer. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -2004,7 +2004,7 @@ fÃ¥r snart se om det stemmer. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/docbook/index.html b/blog/tags/docbook/index.html index 743dcb6e52..11436490bb 100644 --- a/blog/tags/docbook/index.html +++ b/blog/tags/docbook/index.html @@ -1724,7 +1724,7 @@ slik at du kan oppdatere direkte. February (3) -March (2) +March (3) @@ -2062,7 +2062,7 @@ slik at du kan oppdatere direkte. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -2098,13 +2098,13 @@ slik at du kan oppdatere direkte. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -2136,7 +2136,7 @@ slik at du kan oppdatere direkte. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/drivstoffpriser/index.html b/blog/tags/drivstoffpriser/index.html index 4fa60abe43..4e3e389d05 100644 --- a/blog/tags/drivstoffpriser/index.html +++ b/blog/tags/drivstoffpriser/index.html @@ -493,7 +493,7 @@ en liste med stasjoner pÃ¥ samme format som PriserVedStasjoner. February (3) -March (2) +March (3) @@ -831,7 +831,7 @@ en liste med stasjoner pÃ¥ samme format som PriserVedStasjoner. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -867,13 +867,13 @@ en liste med stasjoner pÃ¥ samme format som PriserVedStasjoner. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -905,7 +905,7 @@ en liste med stasjoner pÃ¥ samme format som PriserVedStasjoner. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/english/english.rss b/blog/tags/english/english.rss index a772cf5ed1..ac1915ba97 100644 --- a/blog/tags/english/english.rss +++ b/blog/tags/english/english.rss @@ -6,6 +6,156 @@ http://people.skolelinux.org/pere/blog/ + + PlantUML for text based UML diagram modelling - nice free software + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + Mon, 25 Mar 2019 09:35:00 +0100 + As part of my involvement with the +<a href="https://gitlab.com/OsloMet-ABI/nikita-noark5-core/">Nikita +Noark 5 core project</a>, I have been proposing improvements to the +API specification created by <a href="https://www.arkivverket.no/">The +National Archives of Norway</a> and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +<a href="https://modeling-languages.com/text-uml-tools-complete-list/">list +of text mode uml tools</a>, and tested out a few of the tools listed +there. <a href="http://plantuml.com/">The PlantUML tool</a> seemed +most promising. After verifying that the packages +<a href="https://tracker.debian.org/pkg/plantuml">is available in +Debian</a> and found <a href="https://github.com/plantuml/plantuml">its +Java source</a> under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/">the +Noark 5 Tjenestegrensesnitt specification</a>. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/issues/76">the +github issue discussing the need for a text based UML format</a>, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + +<pre> +@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +</pre> + +<a href="http://plantuml.com/class-diagram">The format</a> is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +<tt>media/uml-class-arkivskaper.iuml<tt>: + +<pre> +@startuml +class Arkivstruktur.Arkivskaper <Arkivenhet> { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml +</pre> + +This is what the complete diagram for the PlantUML notation above +look like: + +<img width="80%" src="http://people.skolelinux.org/pere/blog/images/2019-03-25-noark5-plantuml-diagrameksempel.png"> + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +<tt>exiftool</tt>. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. + + + Release 0.3 of free software archive API system Nikita announced http://people.skolelinux.org/pere/blog/Release_0_3_of_free_software_archive_API_system_Nikita_announced.html diff --git a/blog/tags/english/index.html b/blog/tags/english/index.html index f09275d3b0..29e4bc5e11 100644 --- a/blog/tags/english/index.html +++ b/blog/tags/english/index.html @@ -20,6 +20,168 @@ Entries tagged "english". + + + PlantUML for text based UML diagram modelling - nice free software + + + 25th March 2019 + + + As part of my involvement with the +Nikita +Noark 5 core project, I have been proposing improvements to the +API specification created by The +National Archives of Norway and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +list +of text mode uml tools, and tested out a few of the tools listed +there. The PlantUML tool seemed +most promising. After verifying that the packages +is available in +Debian and found its +Java source under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +the +Noark 5 Tjenestegrensesnitt specification. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +the +github issue discussing the need for a text based UML format, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + ++@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml + + +The format is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +media/uml-class-arkivskaper.iuml: + ++@startuml +class Arkivstruktur.Arkivskaper { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml + + +This is what the complete diagram for the PlantUML notation above +look like: + + + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +exiftool. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. + + + + + + Tags: english, nice free software, noark5, nuug, standard. + + + + + + Release 0.3 of free software archive API system Nikita announced @@ -32251,7 +32413,7 @@ be the only one fitting our needs. :/ February (3) -March (2) +March (3) @@ -32589,7 +32751,7 @@ be the only one fitting our needs. :/ drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -32625,13 +32787,13 @@ be the only one fitting our needs. :/ multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -32663,7 +32825,7 @@ be the only one fitting our needs. :/ skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/fiksgatami/index.html b/blog/tags/fiksgatami/index.html index c196d2f2d6..6f80df39b5 100644 --- a/blog/tags/fiksgatami/index.html +++ b/blog/tags/fiksgatami/index.html @@ -1344,7 +1344,7 @@ med dem. Dette blir bra. February (3) -March (2) +March (3) @@ -1682,7 +1682,7 @@ med dem. Dette blir bra. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1718,13 +1718,13 @@ med dem. Dette blir bra. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1756,7 +1756,7 @@ med dem. Dette blir bra. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/fildeling/index.html b/blog/tags/fildeling/index.html index c2e1b83c65..42b860a879 100644 --- a/blog/tags/fildeling/index.html +++ b/blog/tags/fildeling/index.html @@ -1491,7 +1491,7 @@ og fildeling av slike filer er fullt ut lovlig. February (3) -March (2) +March (3) @@ -1829,7 +1829,7 @@ og fildeling av slike filer er fullt ut lovlig. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1865,13 +1865,13 @@ og fildeling av slike filer er fullt ut lovlig. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1903,7 +1903,7 @@ og fildeling av slike filer er fullt ut lovlig. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/freeculture/index.html b/blog/tags/freeculture/index.html index cd196cd09c..22fc433e1e 100644 --- a/blog/tags/freeculture/index.html +++ b/blog/tags/freeculture/index.html @@ -3112,7 +3112,7 @@ slik at du kan oppdatere direkte. February (3) -March (2) +March (3) @@ -3450,7 +3450,7 @@ slik at du kan oppdatere direkte. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -3486,13 +3486,13 @@ slik at du kan oppdatere direkte. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -3524,7 +3524,7 @@ slik at du kan oppdatere direkte. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/freedombox/index.html b/blog/tags/freedombox/index.html index d2f3cb3f98..17cef50af8 100644 --- a/blog/tags/freedombox/index.html +++ b/blog/tags/freedombox/index.html @@ -938,7 +938,7 @@ default password is 'secret'. February (3) -March (2) +March (3) @@ -1276,7 +1276,7 @@ default password is 'secret'. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1312,13 +1312,13 @@ default password is 'secret'. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1350,7 +1350,7 @@ default password is 'secret'. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/frikanalen/index.html b/blog/tags/frikanalen/index.html index ac64a258b9..34db6dee5e 100644 --- a/blog/tags/frikanalen/index.html +++ b/blog/tags/frikanalen/index.html @@ -1526,7 +1526,7 @@ NUUG lykkes med Ã¥ fÃ¥ ut sine opptak med like stor suksess. February (3) -March (2) +March (3) @@ -1864,7 +1864,7 @@ NUUG lykkes med Ã¥ fÃ¥ ut sine opptak med like stor suksess. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1900,13 +1900,13 @@ NUUG lykkes med Ã¥ fÃ¥ ut sine opptak med like stor suksess. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1938,7 +1938,7 @@ NUUG lykkes med Ã¥ fÃ¥ ut sine opptak med like stor suksess. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/h264/index.html b/blog/tags/h264/index.html index 941ba0fe84..4636e5aa34 100644 --- a/blog/tags/h264/index.html +++ b/blog/tags/h264/index.html @@ -2510,7 +2510,7 @@ sure hope it was using the announced Ogg Theora support. :) February (3) -March (2) +March (3) @@ -2848,7 +2848,7 @@ sure hope it was using the announced Ogg Theora support. :) drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -2884,13 +2884,13 @@ sure hope it was using the announced Ogg Theora support. :) multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -2922,7 +2922,7 @@ sure hope it was using the announced Ogg Theora support. :) skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/intervju/index.html b/blog/tags/intervju/index.html index 952df929f0..e7c818a0d8 100644 --- a/blog/tags/intervju/index.html +++ b/blog/tags/intervju/index.html @@ -5132,7 +5132,7 @@ veldig bra utvalg av gratis spill som er av hÃ¸y kvalitet. Veldig lett February (3) -March (2) +March (3) @@ -5470,7 +5470,7 @@ veldig bra utvalg av gratis spill som er av hÃ¸y kvalitet. Veldig lett drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -5506,13 +5506,13 @@ veldig bra utvalg av gratis spill som er av hÃ¸y kvalitet. Veldig lett multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -5544,7 +5544,7 @@ veldig bra utvalg av gratis spill som er av hÃ¸y kvalitet. Veldig lett skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/isenkram/index.html b/blog/tags/isenkram/index.html index 8acdbfeaf5..3e5b8d4747 100644 --- a/blog/tags/isenkram/index.html +++ b/blog/tags/isenkram/index.html @@ -1720,7 +1720,7 @@ please send me an email. :) February (3) -March (2) +March (3) @@ -2058,7 +2058,7 @@ please send me an email. :) drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -2094,13 +2094,13 @@ please send me an email. :) multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -2132,7 +2132,7 @@ please send me an email. :) skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/kart/index.html b/blog/tags/kart/index.html index 1de9f71315..fb886274c1 100644 --- a/blog/tags/kart/index.html +++ b/blog/tags/kart/index.html @@ -1585,7 +1585,7 @@ det viser at behovet for fribruks-sjÃ¸kart er til stedet. February (3) -March (2) +March (3) @@ -1923,7 +1923,7 @@ det viser at behovet for fribruks-sjÃ¸kart er til stedet. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1959,13 +1959,13 @@ det viser at behovet for fribruks-sjÃ¸kart er til stedet. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1997,7 +1997,7 @@ det viser at behovet for fribruks-sjÃ¸kart er til stedet. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/kodi/index.html b/blog/tags/kodi/index.html index bfc270f163..1bfb690d77 100644 --- a/blog/tags/kodi/index.html +++ b/blog/tags/kodi/index.html @@ -401,7 +401,7 @@ activities, please send Bitcoin donations to my address February (3) -March (2) +March (3) @@ -739,7 +739,7 @@ activities, please send Bitcoin donations to my address drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -775,13 +775,13 @@ activities, please send Bitcoin donations to my address multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -813,7 +813,7 @@ activities, please send Bitcoin donations to my address skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/ldap/index.html b/blog/tags/ldap/index.html index b18d184425..f3772fb7be 100644 --- a/blog/tags/ldap/index.html +++ b/blog/tags/ldap/index.html @@ -1054,7 +1054,7 @@ new IETF work group? February (3) -March (2) +March (3) @@ -1392,7 +1392,7 @@ new IETF work group? drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1428,13 +1428,13 @@ new IETF work group? multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1466,7 +1466,7 @@ new IETF work group? skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/lego/index.html b/blog/tags/lego/index.html index 41547ffc71..34d552e3a2 100644 --- a/blog/tags/lego/index.html +++ b/blog/tags/lego/index.html @@ -327,7 +327,7 @@ including links to Lego related packages is now available. February (3) -March (2) +March (3) @@ -665,7 +665,7 @@ including links to Lego related packages is now available. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -701,13 +701,13 @@ including links to Lego related packages is now available. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -739,7 +739,7 @@ including links to Lego related packages is now available. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/lenker/index.html b/blog/tags/lenker/index.html index 441d4b0beb..7014516b95 100644 --- a/blog/tags/lenker/index.html +++ b/blog/tags/lenker/index.html @@ -649,7 +649,7 @@ Word 2007 hÃ¥ndterer ODF dÃ¥rlig February (3) -March (2) +March (3) @@ -987,7 +987,7 @@ Word 2007 hÃ¥ndterer ODF dÃ¥rlig drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1023,13 +1023,13 @@ Word 2007 hÃ¥ndterer ODF dÃ¥rlig multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1061,7 +1061,7 @@ Word 2007 hÃ¥ndterer ODF dÃ¥rlig skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/lsdvd/index.html b/blog/tags/lsdvd/index.html index 6b878b62e4..68a49afeaa 100644 --- a/blog/tags/lsdvd/index.html +++ b/blog/tags/lsdvd/index.html @@ -135,7 +135,7 @@ list. :) February (3) -March (2) +March (3) @@ -473,7 +473,7 @@ list. :) drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -509,13 +509,13 @@ list. :) multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -547,7 +547,7 @@ list. :) skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/ltsp/index.html b/blog/tags/ltsp/index.html index cbcdd03120..6fdb8c357f 100644 --- a/blog/tags/ltsp/index.html +++ b/blog/tags/ltsp/index.html @@ -69,7 +69,7 @@ of these cards. February (3) -March (2) +March (3) @@ -407,7 +407,7 @@ of these cards. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -443,13 +443,13 @@ of these cards. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -481,7 +481,7 @@ of these cards. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/mesh network/index.html b/blog/tags/mesh network/index.html index b2c8a589ac..eeb375cff1 100644 --- a/blog/tags/mesh network/index.html +++ b/blog/tags/mesh network/index.html @@ -719,7 +719,7 @@ mesh system. February (3) -March (2) +March (3) @@ -1057,7 +1057,7 @@ mesh system. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1093,13 +1093,13 @@ mesh system. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1131,7 +1131,7 @@ mesh system. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/multimedia/index.html b/blog/tags/multimedia/index.html index 001148f060..ac593dd21d 100644 --- a/blog/tags/multimedia/index.html +++ b/blog/tags/multimedia/index.html @@ -3498,7 +3498,7 @@ be the only one fitting our needs. :/ February (3) -March (2) +March (3) @@ -3836,7 +3836,7 @@ be the only one fitting our needs. :/ drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -3872,13 +3872,13 @@ be the only one fitting our needs. :/ multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -3910,7 +3910,7 @@ be the only one fitting our needs. :/ skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/nice free software/index.html b/blog/tags/nice free software/index.html index ca881235ed..b17f8dd0e1 100644 --- a/blog/tags/nice free software/index.html +++ b/blog/tags/nice free software/index.html @@ -20,6 +20,168 @@ Entries tagged "nice free software". + + + PlantUML for text based UML diagram modelling - nice free software + + + 25th March 2019 + + + As part of my involvement with the +Nikita +Noark 5 core project, I have been proposing improvements to the +API specification created by The +National Archives of Norway and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +list +of text mode uml tools, and tested out a few of the tools listed +there. The PlantUML tool seemed +most promising. After verifying that the packages +is available in +Debian and found its +Java source under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +the +Noark 5 Tjenestegrensesnitt specification. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +the +github issue discussing the need for a text based UML format, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + ++@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml + + +The format is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +media/uml-class-arkivskaper.iuml: + ++@startuml +class Arkivstruktur.Arkivskaper { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml + + +This is what the complete diagram for the PlantUML notation above +look like: + + + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +exiftool. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. + + + + + + Tags: english, nice free software, noark5, nuug, standard. + + + + + + Measuring the speaker frequency response using the AUDMES free software GUI - nice free software @@ -1221,7 +1383,7 @@ section. February (3) -March (2) +March (3) @@ -1559,7 +1721,7 @@ section. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1595,13 +1757,13 @@ section. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1633,7 +1795,7 @@ section. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/nice free software/nice free software.rss b/blog/tags/nice free software/nice free software.rss index 7655a4fdbe..7d3007bfec 100644 --- a/blog/tags/nice free software/nice free software.rss +++ b/blog/tags/nice free software/nice free software.rss @@ -6,6 +6,156 @@ http://people.skolelinux.org/pere/blog/ + + PlantUML for text based UML diagram modelling - nice free software + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + Mon, 25 Mar 2019 09:35:00 +0100 + As part of my involvement with the +<a href="https://gitlab.com/OsloMet-ABI/nikita-noark5-core/">Nikita +Noark 5 core project</a>, I have been proposing improvements to the +API specification created by <a href="https://www.arkivverket.no/">The +National Archives of Norway</a> and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +<a href="https://modeling-languages.com/text-uml-tools-complete-list/">list +of text mode uml tools</a>, and tested out a few of the tools listed +there. <a href="http://plantuml.com/">The PlantUML tool</a> seemed +most promising. After verifying that the packages +<a href="https://tracker.debian.org/pkg/plantuml">is available in +Debian</a> and found <a href="https://github.com/plantuml/plantuml">its +Java source</a> under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/">the +Noark 5 Tjenestegrensesnitt specification</a>. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/issues/76">the +github issue discussing the need for a text based UML format</a>, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + +<pre> +@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +</pre> + +<a href="http://plantuml.com/class-diagram">The format</a> is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +<tt>media/uml-class-arkivskaper.iuml<tt>: + +<pre> +@startuml +class Arkivstruktur.Arkivskaper <Arkivenhet> { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml +</pre> + +This is what the complete diagram for the PlantUML notation above +look like: + +<img width="80%" src="http://people.skolelinux.org/pere/blog/images/2019-03-25-noark5-plantuml-diagrameksempel.png"> + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +<tt>exiftool</tt>. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. + + + Measuring the speaker frequency response using the AUDMES free software GUI - nice free software http://people.skolelinux.org/pere/blog/Measuring_the_speaker_frequency_response_using_the_AUDMES_free_software_GUI___nice_free_software.html diff --git a/blog/tags/noark5/index.html b/blog/tags/noark5/index.html index a536b4992b..a847c532bf 100644 --- a/blog/tags/noark5/index.html +++ b/blog/tags/noark5/index.html @@ -20,6 +20,168 @@ Entries tagged "noark5". + + + PlantUML for text based UML diagram modelling - nice free software + + + 25th March 2019 + + + As part of my involvement with the +Nikita +Noark 5 core project, I have been proposing improvements to the +API specification created by The +National Archives of Norway and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +list +of text mode uml tools, and tested out a few of the tools listed +there. The PlantUML tool seemed +most promising. After verifying that the packages +is available in +Debian and found its +Java source under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +the +Noark 5 Tjenestegrensesnitt specification. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +the +github issue discussing the need for a text based UML format, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + ++@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml + + +The format is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +media/uml-class-arkivskaper.iuml: + ++@startuml +class Arkivstruktur.Arkivskaper { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml + + +This is what the complete diagram for the PlantUML notation above +look like: + + + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +exiftool. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. + + + + + + Tags: english, nice free software, noark5, nuug, standard. + + + + + + Release 0.3 of free software archive API system Nikita announced @@ -1211,7 +1373,7 @@ meg en epost hvis du har innspill. February (3) -March (2) +March (3) @@ -1549,7 +1711,7 @@ meg en epost hvis du har innspill. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1585,13 +1747,13 @@ meg en epost hvis du har innspill. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1623,7 +1785,7 @@ meg en epost hvis du har innspill. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/noark5/noark5.rss b/blog/tags/noark5/noark5.rss index 111c671e8f..d0670a4149 100644 --- a/blog/tags/noark5/noark5.rss +++ b/blog/tags/noark5/noark5.rss @@ -6,6 +6,156 @@ http://people.skolelinux.org/pere/blog/ + + PlantUML for text based UML diagram modelling - nice free software + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + Mon, 25 Mar 2019 09:35:00 +0100 + As part of my involvement with the +<a href="https://gitlab.com/OsloMet-ABI/nikita-noark5-core/">Nikita +Noark 5 core project</a>, I have been proposing improvements to the +API specification created by <a href="https://www.arkivverket.no/">The +National Archives of Norway</a> and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +<a href="https://modeling-languages.com/text-uml-tools-complete-list/">list +of text mode uml tools</a>, and tested out a few of the tools listed +there. <a href="http://plantuml.com/">The PlantUML tool</a> seemed +most promising. After verifying that the packages +<a href="https://tracker.debian.org/pkg/plantuml">is available in +Debian</a> and found <a href="https://github.com/plantuml/plantuml">its +Java source</a> under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/">the +Noark 5 Tjenestegrensesnitt specification</a>. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/issues/76">the +github issue discussing the need for a text based UML format</a>, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + +<pre> +@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +</pre> + +<a href="http://plantuml.com/class-diagram">The format</a> is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +<tt>media/uml-class-arkivskaper.iuml<tt>: + +<pre> +@startuml +class Arkivstruktur.Arkivskaper <Arkivenhet> { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml +</pre> + +This is what the complete diagram for the PlantUML notation above +look like: + +<img width="80%" src="http://people.skolelinux.org/pere/blog/images/2019-03-25-noark5-plantuml-diagrameksempel.png"> + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +<tt>exiftool</tt>. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. + + + Release 0.3 of free software archive API system Nikita announced http://people.skolelinux.org/pere/blog/Release_0_3_of_free_software_archive_API_system_Nikita_announced.html diff --git a/blog/tags/norsk/index.html b/blog/tags/norsk/index.html index ac309a2740..2705925a2d 100644 --- a/blog/tags/norsk/index.html +++ b/blog/tags/norsk/index.html @@ -27809,7 +27809,7 @@ forsÃ¸k. February (3) -March (2) +March (3) @@ -28147,7 +28147,7 @@ forsÃ¸k. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -28183,13 +28183,13 @@ forsÃ¸k. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -28221,7 +28221,7 @@ forsÃ¸k. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/nuug/index.html b/blog/tags/nuug/index.html index 678a038c24..377f052ac8 100644 --- a/blog/tags/nuug/index.html +++ b/blog/tags/nuug/index.html @@ -20,6 +20,168 @@ Entries tagged "nuug". + + + PlantUML for text based UML diagram modelling - nice free software + + + 25th March 2019 + + + As part of my involvement with the +Nikita +Noark 5 core project, I have been proposing improvements to the +API specification created by The +National Archives of Norway and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +list +of text mode uml tools, and tested out a few of the tools listed +there. The PlantUML tool seemed +most promising. After verifying that the packages +is available in +Debian and found its +Java source under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +the +Noark 5 Tjenestegrensesnitt specification. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +the +github issue discussing the need for a text based UML format, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + ++@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml + + +The format is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +media/uml-class-arkivskaper.iuml: + ++@startuml +class Arkivstruktur.Arkivskaper { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml + + +This is what the complete diagram for the PlantUML notation above +look like: + + + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +exiftool. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. + + + + + + Tags: english, nice free software, noark5, nuug, standard. + + + + + + Release 0.3 of free software archive API system Nikita announced @@ -14482,7 +14644,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. February (3) -March (2) +March (3) @@ -14820,7 +14982,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -14856,13 +15018,13 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -14894,7 +15056,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/nuug/nuug.rss b/blog/tags/nuug/nuug.rss index c0037d8c99..34a5f18242 100644 --- a/blog/tags/nuug/nuug.rss +++ b/blog/tags/nuug/nuug.rss @@ -6,6 +6,156 @@ http://people.skolelinux.org/pere/blog/ + + PlantUML for text based UML diagram modelling - nice free software + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + Mon, 25 Mar 2019 09:35:00 +0100 + As part of my involvement with the +<a href="https://gitlab.com/OsloMet-ABI/nikita-noark5-core/">Nikita +Noark 5 core project</a>, I have been proposing improvements to the +API specification created by <a href="https://www.arkivverket.no/">The +National Archives of Norway</a> and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +<a href="https://modeling-languages.com/text-uml-tools-complete-list/">list +of text mode uml tools</a>, and tested out a few of the tools listed +there. <a href="http://plantuml.com/">The PlantUML tool</a> seemed +most promising. After verifying that the packages +<a href="https://tracker.debian.org/pkg/plantuml">is available in +Debian</a> and found <a href="https://github.com/plantuml/plantuml">its +Java source</a> under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/">the +Noark 5 Tjenestegrensesnitt specification</a>. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/issues/76">the +github issue discussing the need for a text based UML format</a>, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + +<pre> +@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +</pre> + +<a href="http://plantuml.com/class-diagram">The format</a> is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +<tt>media/uml-class-arkivskaper.iuml<tt>: + +<pre> +@startuml +class Arkivstruktur.Arkivskaper <Arkivenhet> { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml +</pre> + +This is what the complete diagram for the PlantUML notation above +look like: + +<img width="80%" src="http://people.skolelinux.org/pere/blog/images/2019-03-25-noark5-plantuml-diagrameksempel.png"> + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +<tt>exiftool</tt>. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. + + + Release 0.3 of free software archive API system Nikita announced http://people.skolelinux.org/pere/blog/Release_0_3_of_free_software_archive_API_system_Nikita_announced.html diff --git a/blog/tags/offentlig innsyn/index.html b/blog/tags/offentlig innsyn/index.html index 04ac509d00..90dd7dce32 100644 --- a/blog/tags/offentlig innsyn/index.html +++ b/blog/tags/offentlig innsyn/index.html @@ -4136,7 +4136,7 @@ til Ã¥ levere hver uke. Har ikke undersÃ¸kt noen av de andre. February (3) -March (2) +March (3) @@ -4474,7 +4474,7 @@ til Ã¥ levere hver uke. Har ikke undersÃ¸kt noen av de andre. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -4510,13 +4510,13 @@ til Ã¥ levere hver uke. Har ikke undersÃ¸kt noen av de andre. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -4548,7 +4548,7 @@ til Ã¥ levere hver uke. Har ikke undersÃ¸kt noen av de andre. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/open311/index.html b/blog/tags/open311/index.html index dc43d4a1e6..88799f249f 100644 --- a/blog/tags/open311/index.html +++ b/blog/tags/open311/index.html @@ -164,7 +164,7 @@ work like the free software project communities I am used to. February (3) -March (2) +March (3) @@ -502,7 +502,7 @@ work like the free software project communities I am used to. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -538,13 +538,13 @@ work like the free software project communities I am used to. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -576,7 +576,7 @@ work like the free software project communities I am used to. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/opphavsrett/index.html b/blog/tags/opphavsrett/index.html index 949a16d2a3..cc9a4086c2 100644 --- a/blog/tags/opphavsrett/index.html +++ b/blog/tags/opphavsrett/index.html @@ -9025,7 +9025,7 @@ database. February (3) -March (2) +March (3) @@ -9363,7 +9363,7 @@ database. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -9399,13 +9399,13 @@ database. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -9437,7 +9437,7 @@ database. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/personvern/index.html b/blog/tags/personvern/index.html index 15ecc7b03a..aac8a85164 100644 --- a/blog/tags/personvern/index.html +++ b/blog/tags/personvern/index.html @@ -10149,7 +10149,7 @@ kontanter for noen dager siden. February (3) -March (2) +March (3) @@ -10487,7 +10487,7 @@ kontanter for noen dager siden. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -10523,13 +10523,13 @@ kontanter for noen dager siden. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -10561,7 +10561,7 @@ kontanter for noen dager siden. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/raid/index.html b/blog/tags/raid/index.html index 02160e462b..81d907a184 100644 --- a/blog/tags/raid/index.html +++ b/blog/tags/raid/index.html @@ -199,7 +199,7 @@ disk(s) is failing when the RAID is running short on disks. February (3) -March (2) +March (3) @@ -537,7 +537,7 @@ disk(s) is failing when the RAID is running short on disks. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -573,13 +573,13 @@ disk(s) is failing when the RAID is running short on disks. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -611,7 +611,7 @@ disk(s) is failing when the RAID is running short on disks. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/reactos/index.html b/blog/tags/reactos/index.html index bb415d30b6..3e48e66280 100644 --- a/blog/tags/reactos/index.html +++ b/blog/tags/reactos/index.html @@ -104,7 +104,7 @@ image. February (3) -March (2) +March (3) @@ -442,7 +442,7 @@ image. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -478,13 +478,13 @@ image. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -516,7 +516,7 @@ image. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/reprap/index.html b/blog/tags/reprap/index.html index 77128f7f8a..a254189d67 100644 --- a/blog/tags/reprap/index.html +++ b/blog/tags/reprap/index.html @@ -531,7 +531,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. February (3) -March (2) +March (3) @@ -869,7 +869,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -905,13 +905,13 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -943,7 +943,7 @@ hÃ¥per det ikke gÃ¥r tapt pÃ¥ samme vis. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/rfid/index.html b/blog/tags/rfid/index.html index 6d2b40e7d9..edde2dc6a1 100644 --- a/blog/tags/rfid/index.html +++ b/blog/tags/rfid/index.html @@ -435,7 +435,7 @@ mer om de nye biometriske passene. February (3) -March (2) +March (3) @@ -773,7 +773,7 @@ mer om de nye biometriske passene. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -809,13 +809,13 @@ mer om de nye biometriske passene. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -847,7 +847,7 @@ mer om de nye biometriske passene. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/robot/index.html b/blog/tags/robot/index.html index c1c54ad906..876d233f05 100644 --- a/blog/tags/robot/index.html +++ b/blog/tags/robot/index.html @@ -598,7 +598,7 @@ firmwaren. :) February (3) -March (2) +March (3) @@ -936,7 +936,7 @@ firmwaren. :) drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -972,13 +972,13 @@ firmwaren. :) multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1010,7 +1010,7 @@ firmwaren. :) skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/rss/index.html b/blog/tags/rss/index.html index 245a3d6f41..ead008d33e 100644 --- a/blog/tags/rss/index.html +++ b/blog/tags/rss/index.html @@ -58,7 +58,7 @@ forsÃ¸k. February (3) -March (2) +March (3) @@ -396,7 +396,7 @@ forsÃ¸k. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -432,13 +432,13 @@ forsÃ¸k. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -470,7 +470,7 @@ forsÃ¸k. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/ruter/index.html b/blog/tags/ruter/index.html index b8fe4a7035..a84dacfdbc 100644 --- a/blog/tags/ruter/index.html +++ b/blog/tags/ruter/index.html @@ -395,7 +395,7 @@ OsloomrÃ¥det. February (3) -March (2) +March (3) @@ -733,7 +733,7 @@ OsloomrÃ¥det. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -769,13 +769,13 @@ OsloomrÃ¥det. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -807,7 +807,7 @@ OsloomrÃ¥det. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/scraperwiki/index.html b/blog/tags/scraperwiki/index.html index be5df0a4b4..5e4b99532c 100644 --- a/blog/tags/scraperwiki/index.html +++ b/blog/tags/scraperwiki/index.html @@ -147,7 +147,7 @@ av Ã¥ dele informasjon med andre uten bruksbegresninger. February (3) -March (2) +March (3) @@ -485,7 +485,7 @@ av Ã¥ dele informasjon med andre uten bruksbegresninger. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -521,13 +521,13 @@ av Ã¥ dele informasjon med andre uten bruksbegresninger. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -559,7 +559,7 @@ av Ã¥ dele informasjon med andre uten bruksbegresninger. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/sikkerhet/index.html b/blog/tags/sikkerhet/index.html index e1e1532d9f..bf7c2539a8 100644 --- a/blog/tags/sikkerhet/index.html +++ b/blog/tags/sikkerhet/index.html @@ -4469,7 +4469,7 @@ betydelige. February (3) -March (2) +March (3) @@ -4807,7 +4807,7 @@ betydelige. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -4843,13 +4843,13 @@ betydelige. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -4881,7 +4881,7 @@ betydelige. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/sitesummary/index.html b/blog/tags/sitesummary/index.html index 4cbbed0a0f..e427f0ee30 100644 --- a/blog/tags/sitesummary/index.html +++ b/blog/tags/sitesummary/index.html @@ -263,7 +263,7 @@ everything is taken care of. February (3) -March (2) +March (3) @@ -601,7 +601,7 @@ everything is taken care of. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -637,13 +637,13 @@ everything is taken care of. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -675,7 +675,7 @@ everything is taken care of. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/skepsis/index.html b/blog/tags/skepsis/index.html index bd6ef418ee..30bc906bfd 100644 --- a/blog/tags/skepsis/index.html +++ b/blog/tags/skepsis/index.html @@ -443,7 +443,7 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. February (3) -March (2) +March (3) @@ -781,7 +781,7 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -817,13 +817,13 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -855,7 +855,7 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/standard/index.html b/blog/tags/standard/index.html index 3071154fc1..c155bc7482 100644 --- a/blog/tags/standard/index.html +++ b/blog/tags/standard/index.html @@ -20,6 +20,168 @@ Entries tagged "standard". + + + PlantUML for text based UML diagram modelling - nice free software + + + 25th March 2019 + + + As part of my involvement with the +Nikita +Noark 5 core project, I have been proposing improvements to the +API specification created by The +National Archives of Norway and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +list +of text mode uml tools, and tested out a few of the tools listed +there. The PlantUML tool seemed +most promising. After verifying that the packages +is available in +Debian and found its +Java source under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +the +Noark 5 Tjenestegrensesnitt specification. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +the +github issue discussing the need for a text based UML format, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + ++@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml + + +The format is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +media/uml-class-arkivskaper.iuml: + ++@startuml +class Arkivstruktur.Arkivskaper { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml + + +This is what the complete diagram for the PlantUML notation above +look like: + + + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +exiftool. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b. + + + + + + Tags: english, nice free software, noark5, nuug, standard. + + + + + + Release 0.3 of free software archive API system Nikita announced @@ -5492,7 +5654,7 @@ Kjenner kun til ufullstendige lÃ¸sninger for slikt. February (3) -March (2) +March (3) @@ -5830,7 +5992,7 @@ Kjenner kun til ufullstendige lÃ¸sninger for slikt. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -5866,13 +6028,13 @@ Kjenner kun til ufullstendige lÃ¸sninger for slikt. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -5904,7 +6066,7 @@ Kjenner kun til ufullstendige lÃ¸sninger for slikt. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/standard/standard.rss b/blog/tags/standard/standard.rss index 1b738663ec..0b1123ac7b 100644 --- a/blog/tags/standard/standard.rss +++ b/blog/tags/standard/standard.rss @@ -6,6 +6,156 @@ http://people.skolelinux.org/pere/blog/ + + PlantUML for text based UML diagram modelling - nice free software + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + http://people.skolelinux.org/pere/blog/PlantUML_for_text_based_UML_diagram_modelling___nice_free_software.html + Mon, 25 Mar 2019 09:35:00 +0100 + As part of my involvement with the +<a href="https://gitlab.com/OsloMet-ABI/nikita-noark5-core/">Nikita +Noark 5 core project</a>, I have been proposing improvements to the +API specification created by <a href="https://www.arkivverket.no/">The +National Archives of Norway</a> and helped migrating the text from a +version control system unfriendly binary format (docx) to Markdown in +git. Combined with the migration to a public git repository (on +github), this has made it possible for anyone to suggest improvement +to the text. + +The specification is filled with UML diagrams. I believe the +original diagrams were modelled using Sparx Systems Enterprise +Architect, and exported as EMF files for import into docx. This +approach make it very hard to track changes using a version control +system. To improve the situation I have been looking for a good text +based UML format with associated command line free software tools on +Linux and Windows, to allow anyone to send in corrections to the UML +diagrams in the specification. The tool must be text based to work +with git, and command line to be able to run it automatically to +generate the diagram images. Finally, it must be free software to +allow anyone, even those that can not accept a non-free software +license, to contribute. + +I did not know much about free software UML modelling tools when I +started. I have used dia and inkscape for simple modelling in the +past, but neither are available on Windows, as far as I could tell. I +came across a nice +<a href="https://modeling-languages.com/text-uml-tools-complete-list/">list +of text mode uml tools</a>, and tested out a few of the tools listed +there. <a href="http://plantuml.com/">The PlantUML tool</a> seemed +most promising. After verifying that the packages +<a href="https://tracker.debian.org/pkg/plantuml">is available in +Debian</a> and found <a href="https://github.com/plantuml/plantuml">its +Java source</a> under a GPL license on github, I set out to test if it +could represent the diagrams we needed, ie the ones currently in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/">the +Noark 5 Tjenestegrensesnitt specification</a>. I am happy to report +that it could represent them, even thought it have a few warts here +and there. + +After a few days of modelling I completed the task this weekend. A +temporary link to the complete set of diagrams (original and from +PlantUML) is available in +<a href="https://github.com/arkivverket/noark5-tjenestegrensesnitt-standard/issues/76">the +github issue discussing the need for a text based UML format</a>, but +please note I lack a sensible tool to convert EMF files to PNGs, so +the "original" rendering is not as good as the original was in the +publised PDF. + +Here is an example UML diagram, showing the core classes for +keeping metadata about archived documents: + +<pre> +@startuml +skinparam classAttributeIconSize 0 + +!include media/uml-class-arkivskaper.iuml +!include media/uml-class-arkiv.iuml +!include media/uml-class-klassifikasjonssystem.iuml +!include media/uml-class-klasse.iuml +!include media/uml-class-arkivdel.iuml +!include media/uml-class-mappe.iuml +!include media/uml-class-merknad.iuml +!include media/uml-class-registrering.iuml +!include media/uml-class-basisregistrering.iuml +!include media/uml-class-dokumentbeskrivelse.iuml +!include media/uml-class-dokumentobjekt.iuml +!include media/uml-class-konvertering.iuml +!include media/uml-datatype-elektronisksignatur.iuml + +Arkivstruktur.Arkivskaper "+arkivskaper 1..*" <-o "+arkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv o--> "+underarkiv 0..*" Arkivstruktur.Arkiv +Arkivstruktur.Arkiv "+arkiv 1" o--> "+arkivdel 0..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" <--o "+arkivdel 1..*" Arkivstruktur.Arkivdel +Arkivstruktur.Klassifikasjonssystem "+klassifikasjonssystem [0..1]" o--> "+klasse 0..*" Arkivstruktur.Klasse +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Arkivdel "+arkivdel 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Klasse "+klasse 0..1" o--> "+mappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Klasse "+klasse 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Mappe --> "+undermappe 0..*" Arkivstruktur.Mappe +Arkivstruktur.Mappe "+mappe 0..1" o--> "+registrering 0..*" Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Mappe +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Basisregistrering -|> Arkivstruktur.Registrering +Arkivstruktur.Merknad "+merknad 0..*" <--* Arkivstruktur.Basisregistrering +Arkivstruktur.Registrering "+registrering 1..*" o--> "+dokumentbeskrivelse 0..*" Arkivstruktur.Dokumentbeskrivelse +Arkivstruktur.Dokumentbeskrivelse "+dokumentbeskrivelse 1" o-> "+dokumentobjekt 0..*" Arkivstruktur.Dokumentobjekt +Arkivstruktur.Dokumentobjekt *-> "+konvertering 0..*" Arkivstruktur.Konvertering +Arkivstruktur.ElektroniskSignatur -[hidden]-> Arkivstruktur.Dokumentobjekt +@enduml +</pre> + +<a href="http://plantuml.com/class-diagram">The format</a> is quite +compact, with little redundant information. The text expresses +entities and relations, and there is little layout related fluff. One +can reuse content by using include files, allowing for consistent +naming across several diagrams. The include files can be standalone +PlantUML too. Here is the content of +<tt>media/uml-class-arkivskaper.iuml<tt>: + +<pre> +@startuml +class Arkivstruktur.Arkivskaper <Arkivenhet> { + +arkivskaperID : string + +arkivskaperNavn : string + +beskrivelse : string [0..1] +} +@enduml +</pre> + +This is what the complete diagram for the PlantUML notation above +look like: + +<img width="80%" src="http://people.skolelinux.org/pere/blog/images/2019-03-25-noark5-plantuml-diagrameksempel.png"> + +A cool feature of PlantUML is that the generated PNG files include +the entire original source diagram as text. The source (with include +statements expanded) can be extracted using for example +<tt>exiftool</tt>. Another cool feature is that parts of the entities +can be hidden after inclusion. This allow to use include files with +all attributes listed, even for UML diagrams that should not list any +attributes. + +The diagram also show some of the warts. Some times the layout +engine place text labels on top of each other, and some times it place +the class boxes too close to each other, not leaving room for the +labels on the relationship arrows. The former can be worked around by +placing extra newlines in the labes (ie "\n"). I did not do it here +to be able to demonstrate the issue. I have not found a good way +around the latter, so I normally try to reduce the problem by changing +from vertical to horizontal links to improve the layout. + +All in all, I am quite happy with PlantUML, and very impressed with +how quickly its lead developer responds to questions. So far I got an +answer to my questions in a few hours when I send an email. I +definitely recommend looking at PlantUML if you need to make UML +diagrams. Note, PlantUML can draw a lot more than class relations. +Check out the documention for a complete list. :) + +As usual, if you use Bitcoin and want to show your support of my +activities, please send Bitcoin donations to my address +<a href="bitcoin:15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b">15oWEoG9dUPovwmUL9KWAnYRtNJEkP1u1b</a>. + + + Release 0.3 of free software archive API system Nikita announced http://people.skolelinux.org/pere/blog/Release_0_3_of_free_software_archive_API_system_Nikita_announced.html diff --git a/blog/tags/stavekontroll/index.html b/blog/tags/stavekontroll/index.html index 0ba650195f..8a174c3ed0 100644 --- a/blog/tags/stavekontroll/index.html +++ b/blog/tags/stavekontroll/index.html @@ -448,7 +448,7 @@ stavekontrollen. February (3) -March (2) +March (3) @@ -786,7 +786,7 @@ stavekontrollen. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -822,13 +822,13 @@ stavekontrollen. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -860,7 +860,7 @@ stavekontrollen. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/stortinget/index.html b/blog/tags/stortinget/index.html index fe1ffff209..6448411c4e 100644 --- a/blog/tags/stortinget/index.html +++ b/blog/tags/stortinget/index.html @@ -1149,7 +1149,7 @@ at vi i NUUG har fÃ¥tt operativ en norsk utgave av February (3) -March (2) +March (3) @@ -1487,7 +1487,7 @@ at vi i NUUG har fÃ¥tt operativ en norsk utgave av drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1523,13 +1523,13 @@ at vi i NUUG har fÃ¥tt operativ en norsk utgave av multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1561,7 +1561,7 @@ at vi i NUUG har fÃ¥tt operativ en norsk utgave av skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/surveillance/index.html b/blog/tags/surveillance/index.html index 993bd4d6e8..161e251b6a 100644 --- a/blog/tags/surveillance/index.html +++ b/blog/tags/surveillance/index.html @@ -5015,7 +5015,7 @@ automatisk over i spesialkartet. February (3) -March (2) +March (3) @@ -5353,7 +5353,7 @@ automatisk over i spesialkartet. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -5389,13 +5389,13 @@ automatisk over i spesialkartet. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -5427,7 +5427,7 @@ automatisk over i spesialkartet. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/sysadmin/index.html b/blog/tags/sysadmin/index.html index 1bc4e4a691..7b3d27646c 100644 --- a/blog/tags/sysadmin/index.html +++ b/blog/tags/sysadmin/index.html @@ -431,7 +431,7 @@ and DHCP updates I wanted to do. February (3) -March (2) +March (3) @@ -769,7 +769,7 @@ and DHCP updates I wanted to do. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -805,13 +805,13 @@ and DHCP updates I wanted to do. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -843,7 +843,7 @@ and DHCP updates I wanted to do. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/usenix/index.html b/blog/tags/usenix/index.html index 90997b5986..1b2e514d8d 100644 --- a/blog/tags/usenix/index.html +++ b/blog/tags/usenix/index.html @@ -233,7 +233,7 @@ for other sites to consider too? February (3) -March (2) +March (3) @@ -571,7 +571,7 @@ for other sites to consider too? drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -607,13 +607,13 @@ for other sites to consider too? multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -645,7 +645,7 @@ for other sites to consider too? skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/valg/index.html b/blog/tags/valg/index.html index f5619cc68b..3717291392 100644 --- a/blog/tags/valg/index.html +++ b/blog/tags/valg/index.html @@ -1006,7 +1006,7 @@ inneholdt i Iran hvis de ikke hadde hemmelige valg? February (3) -March (2) +March (3) @@ -1344,7 +1344,7 @@ inneholdt i Iran hvis de ikke hadde hemmelige valg? drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -1380,13 +1380,13 @@ inneholdt i Iran hvis de ikke hadde hemmelige valg? multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -1418,7 +1418,7 @@ inneholdt i Iran hvis de ikke hadde hemmelige valg? skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/verkidetfri/index.html b/blog/tags/verkidetfri/index.html index 5e676fc855..4e408e250d 100644 --- a/blog/tags/verkidetfri/index.html +++ b/blog/tags/verkidetfri/index.html @@ -3665,7 +3665,7 @@ would like to tax copyrighted work values if they could. February (3) -March (2) +March (3) @@ -4003,7 +4003,7 @@ would like to tax copyrighted work values if they could. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -4039,13 +4039,13 @@ would like to tax copyrighted work values if they could. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -4077,7 +4077,7 @@ would like to tax copyrighted work values if they could. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/video/index.html b/blog/tags/video/index.html index a973620835..667967f722 100644 --- a/blog/tags/video/index.html +++ b/blog/tags/video/index.html @@ -6666,7 +6666,7 @@ larger stick as well. February (3) -March (2) +March (3) @@ -7004,7 +7004,7 @@ larger stick as well. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -7040,13 +7040,13 @@ larger stick as well. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -7078,7 +7078,7 @@ larger stick as well. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/vitenskap/index.html b/blog/tags/vitenskap/index.html index fa888ddfe6..86837821ac 100644 --- a/blog/tags/vitenskap/index.html +++ b/blog/tags/vitenskap/index.html @@ -399,7 +399,7 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. February (3) -March (2) +March (3) @@ -737,7 +737,7 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -773,13 +773,13 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -811,7 +811,7 @@ skyskrapere. Takke meg til en tur til mÃ¥nen. skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/tags/web/index.html b/blog/tags/web/index.html index 1c70ec3dfe..875e2fe7ee 100644 --- a/blog/tags/web/index.html +++ b/blog/tags/web/index.html @@ -3831,7 +3831,7 @@ be the only one fitting our needs. :/ February (3) -March (2) +March (3) @@ -4169,7 +4169,7 @@ be the only one fitting our needs. :/ drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -4205,13 +4205,13 @@ be the only one fitting our needs. :/ multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -4243,7 +4243,7 @@ be the only one fitting our needs. :/ skepsis (5) - standard (60) + standard (61) stavekontroll (6) diff --git a/blog/youtube_dl_for_nedlasting_fra_NRK_med_undertekster___nice_free_software.html b/blog/youtube_dl_for_nedlasting_fra_NRK_med_undertekster___nice_free_software.html index 72628622c4..38994d7b37 100644 --- a/blog/youtube_dl_for_nedlasting_fra_NRK_med_undertekster___nice_free_software.html +++ b/blog/youtube_dl_for_nedlasting_fra_NRK_med_undertekster___nice_free_software.html @@ -104,7 +104,7 @@ komplett liste. February (3) -March (2) +March (3) @@ -442,7 +442,7 @@ komplett liste. drivstoffpriser (4) - english (399) + english (400) fiksgatami (23) @@ -478,13 +478,13 @@ komplett liste. multimedia (42) - nice free software (11) + nice free software (12) - noark5 (11) + noark5 (12) norsk (305) - nuug (193) + nuug (194) offentlig innsyn (36) @@ -516,7 +516,7 @@ komplett liste. skepsis (5) - standard (60) + standard (61) stavekontroll (6)

+ Petter Reinholdtsen + +

Archive

Tags

Entries from March 2019.

Entries tagged "english".

Entries tagged "nice free software".

Entries tagged "noark5".

Entries tagged "nuug".

Entries tagged "standard".