diff --git a/DEV.md b/DEV.md index 0c4922a..e1c9d59 100644 --- a/DEV.md +++ b/DEV.md @@ -23,3 +23,14 @@ Le projet [livingdoc-typescript-plugin](livingdoc-typescript-plugin) librairie p ## CI/CD PR obligatoire. + +## Tips + +### generate image from html + +copy svg content into generated html +```bash +yay -S wkhtmltox-bin +cd sources/living-documentation/livingdoc-examples/microservice +wkhtmltoimage --format png http://localhost:63342/living-documentation/livingdoc-examples/microservice/target/docs/index.html images/example_microservice_index.html.png +``` diff --git a/livingdoc-examples/aggregate/aggregate-cargo/pom.xml b/livingdoc-examples/aggregate/aggregate-cargo/pom.xml index aaae7a0..8698a19 100644 --- a/livingdoc-examples/aggregate/aggregate-cargo/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-cargo/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-cargo @@ -30,4 +30,4 @@ aggregate-sharedhandling - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/aggregate-handling/pom.xml b/livingdoc-examples/aggregate/aggregate-handling/pom.xml index 916d20c..9fb6c95 100644 --- a/livingdoc-examples/aggregate/aggregate-handling/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-handling/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-handling @@ -34,4 +34,4 @@ aggregate-cargo - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/aggregate-location/pom.xml b/livingdoc-examples/aggregate/aggregate-location/pom.xml index 2b07a4a..006faf0 100644 --- a/livingdoc-examples/aggregate/aggregate-location/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-location/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-location @@ -18,4 +18,4 @@ aggregate-shared - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/aggregate-shared/pom.xml b/livingdoc-examples/aggregate/aggregate-shared/pom.xml index 3b687cf..af806e6 100644 --- a/livingdoc-examples/aggregate/aggregate-shared/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-shared/pom.xml @@ -7,8 +7,8 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-shared - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/aggregate-sharedhandling/pom.xml b/livingdoc-examples/aggregate/aggregate-sharedhandling/pom.xml index c609bcf..bb68612 100644 --- a/livingdoc-examples/aggregate/aggregate-sharedhandling/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-sharedhandling/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-sharedhandling @@ -18,4 +18,4 @@ aggregate-shared - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/aggregate-voyage/pom.xml b/livingdoc-examples/aggregate/aggregate-voyage/pom.xml index 981593d..3201ffa 100644 --- a/livingdoc-examples/aggregate/aggregate-voyage/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-voyage/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-voyage @@ -22,4 +22,4 @@ aggregate-location - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/aggregate-zz-livingdoc/pom.xml b/livingdoc-examples/aggregate/aggregate-zz-livingdoc/pom.xml index c0e6629..4f6f80b 100644 --- a/livingdoc-examples/aggregate/aggregate-zz-livingdoc/pom.xml +++ b/livingdoc-examples/aggregate/aggregate-zz-livingdoc/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example aggregate - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate-zz-livingdoc @@ -101,4 +101,4 @@ - \ No newline at end of file + diff --git a/livingdoc-examples/aggregate/pom.xml b/livingdoc-examples/aggregate/pom.xml index edf8c76..1e9f2e7 100644 --- a/livingdoc-examples/aggregate/pom.xml +++ b/livingdoc-examples/aggregate/pom.xml @@ -7,7 +7,7 @@ ch.ifocusit.livingdoc.example livingdoc-examples - 2.4-SNAPSHOT + 2.5-SNAPSHOT aggregate @@ -69,4 +69,4 @@ aggregate-handling aggregate-zz-livingdoc - \ No newline at end of file + diff --git a/livingdoc-examples/ddd-annotated/pom.xml b/livingdoc-examples/ddd-annotated/pom.xml index 79944c6..32bd8a8 100644 --- a/livingdoc-examples/ddd-annotated/pom.xml +++ b/livingdoc-examples/ddd-annotated/pom.xml @@ -6,7 +6,7 @@ ch.ifocusit.livingdoc.example livingdoc-examples - 2.4-SNAPSHOT + 2.5-SNAPSHOT ddd-annotated diff --git a/livingdoc-examples/ddd/pom.xml b/livingdoc-examples/ddd/pom.xml index 6318172..7ce9aaa 100644 --- a/livingdoc-examples/ddd/pom.xml +++ b/livingdoc-examples/ddd/pom.xml @@ -6,7 +6,7 @@ ch.ifocusit.livingdoc.example livingdoc-examples - 2.4-SNAPSHOT + 2.5-SNAPSHOT ddd diff --git a/livingdoc-examples/microservice/pom.xml b/livingdoc-examples/microservice/pom.xml index 4eff8a8..3e684a1 100644 --- a/livingdoc-examples/microservice/pom.xml +++ b/livingdoc-examples/microservice/pom.xml @@ -5,7 +5,7 @@ ch.ifocusit.livingdoc.example livingdoc-examples - 2.4-SNAPSHOT + 2.5-SNAPSHOT microservice jar diff --git a/livingdoc-examples/pom.xml b/livingdoc-examples/pom.xml index 5440d43..2c3b526 100644 --- a/livingdoc-examples/pom.xml +++ b/livingdoc-examples/pom.xml @@ -5,7 +5,7 @@ ch.ifocusit.livingdoc.example livingdoc-examples - 2.4-SNAPSHOT + 2.5-SNAPSHOT pom Living Documentation example diff --git a/livingdoc-maven-plugin/pom.xml b/livingdoc-maven-plugin/pom.xml index 4d9e482..f6cb617 100644 --- a/livingdoc-maven-plugin/pom.xml +++ b/livingdoc-maven-plugin/pom.xml @@ -5,7 +5,7 @@ ch.ifocusit.livingdoc livingdoc-maven-plugin - 2.4-SNAPSHOT + 2.5-SNAPSHOT maven-plugin Living Documentation maven plugin diff --git a/livingdoc-maven-plugin/src/main/java/ch/ifocusit/livingdoc/plugin/DiagramMojo.java b/livingdoc-maven-plugin/src/main/java/ch/ifocusit/livingdoc/plugin/DiagramMojo.java index 6c4e15d..1ec8688 100644 --- a/livingdoc-maven-plugin/src/main/java/ch/ifocusit/livingdoc/plugin/DiagramMojo.java +++ b/livingdoc-maven-plugin/src/main/java/ch/ifocusit/livingdoc/plugin/DiagramMojo.java @@ -68,7 +68,7 @@ public class DiagramMojo extends AbstractDocsGeneratorMojo { * Add link into diagram to glossary */ @Parameter(property = "livingdoc.diagram.link.activate", defaultValue = "false") - private boolean diagramWithLink = true; + private boolean diagramWithLink; /** * Link template to use in diagram. @@ -178,9 +178,6 @@ public void executeMojo() throws MojoExecutionException { diagramWithLink = true; diagramImageType = DiagramImageType.svg; } - if (StringUtils.isNotBlank(diagramLinkPage)) { - diagramWithLink = true; - } // generate diagram String diagram = generateDiagram(); diff --git a/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-adapted.plantuml b/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-adapted.plantuml index 769403e..7937c16 100644 --- a/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-adapted.plantuml +++ b/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-adapted.plantuml @@ -6,49 +6,49 @@ header Microservice classes diagram endheader -abstract class "Access" [[glossary.html#glossaryid-400{400}]] { - phoneNumber : String [[[glossary.html#glossaryid-401{401}]]] - price : BigDecimal [[[glossary.html#glossaryid-402{402}]]] - dateTime : ZonedDateTime [[[glossary.html#glossaryid-403{403}]]] +abstract class "Access" { + phoneNumber : String + price : BigDecimal + dateTime : ZonedDateTime } -class "Bill" [[glossary.html#glossaryid-100{100}]] #pink { - month : YearMonth [[[glossary.html#glossaryid-101{101}]]] - contract : Contract [[[glossary.html#glossaryid-102{102}]]] - accesses : Set [[[glossary.html#glossaryid-103{103}]]] - customerInformed : boolean [[[glossary.html#glossaryid-Bill_customerInformed{Bill.customerInformed}]]] +class "Bill" #pink { + month : YearMonth + contract : Contract + accesses : Set + customerInformed : boolean } -interface "BillRepository" [[glossary.html#glossaryid-BillRepository{BillRepository}]] { +interface "BillRepository" { add(Bill) : Bill clear() get(YearMonth) : Optional retreiveLastBill() : Optional } -class "BillingService" [[glossary.html#glossaryid-BillingService{BillingService}]] { - repository : BillRepository [[[glossary.html#glossaryid-BillingService_repository{BillingService.repository}]]] +class "BillingService" { + repository : BillRepository getBill(String) : Optional } -class "CallAccess" [[glossary.html#glossaryid-500{500}]] { - duration : Duration [[[glossary.html#glossaryid-501{501}]]] +class "CallAccess" { + duration : Duration } -class "Contract" [[glossary.html#glossaryid-200{200}]] { - id : String [[[glossary.html#glossaryid-201{201}]]] - customer : Customer [[[glossary.html#glossaryid-202{202}]]] - effectDate : LocalDate [[[glossary.html#glossaryid-203{203}]]] +class "Contract" { + id : String + customer : Customer + effectDate : LocalDate } -class "Customer" [[glossary.html#glossaryid-300{300}]] { - name : String [[[glossary.html#glossaryid-301{301}]]] - contracts : Set [[[glossary.html#glossaryid-Customer_contracts{Customer.contracts}]]] +class "Customer" { + name : String + contracts : Set } -class "ListBillRepository" [[glossary.html#glossaryid-ListBillRepository{ListBillRepository}]] +class "ListBillRepository" -class "SmsAccess" [[glossary.html#glossaryid-600{600}]] +class "SmsAccess" "Access" <|-- "CallAccess" "Access" <|-- "SmsAccess" @@ -61,4 +61,4 @@ class "SmsAccess" [[glossary.html#glossaryid-600{600}]] "Contract" "*" <-> "Customer" : customer/contracts hide BillingService fields -@enduml \ No newline at end of file +@enduml diff --git a/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-all.adoc b/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-all.adoc index 368580c..57a1e43 100644 --- a/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-all.adoc +++ b/livingdoc-maven-plugin/src/nonreg/example-java-x/src/test/resources/expected/diagram-all.adoc @@ -10,57 +10,57 @@ title All classes diagram -abstract class "AbstractDomain" [[glossary.html#glossaryid-AbstractDomain{AbstractDomain}]] +abstract class "AbstractDomain" -abstract class "Access" [[glossary.html#glossaryid-400{400}]] { - phoneNumber : String [[[glossary.html#glossaryid-401{401}]]] - price : BigDecimal [[[glossary.html#glossaryid-402{402}]]] - dateTime : ZonedDateTime [[[glossary.html#glossaryid-403{403}]]] +abstract class "Access" { + phoneNumber : String + price : BigDecimal + dateTime : ZonedDateTime } -class "Bill" [[glossary.html#glossaryid-100{100}]] #wheat { - month : YearMonth [[[glossary.html#glossaryid-101{101}]]] - contract : Contract [[[glossary.html#glossaryid-102{102}]]] - accesses : Set [[[glossary.html#glossaryid-103{103}]]] - customerInformed : boolean [[[glossary.html#glossaryid-Bill_customerInformed{Bill.customerInformed}]]] +class "Bill" #wheat { + month : YearMonth + contract : Contract + accesses : Set + customerInformed : boolean } -interface "BillRepository" [[glossary.html#glossaryid-BillRepository{BillRepository}]] { +interface "BillRepository" { add(Bill) : Bill clear() get(YearMonth) : Optional retreiveLastBill() : Optional } -class "BillingService" [[glossary.html#glossaryid-BillingService{BillingService}]] { - repository : BillRepository [[[glossary.html#glossaryid-BillingService_repository{BillingService.repository}]]] +class "BillingService" { + repository : BillRepository getBill(String) : Optional } -class "CallAccess" [[glossary.html#glossaryid-500{500}]] { - duration : Duration [[[glossary.html#glossaryid-501{501}]]] +class "CallAccess" { + duration : Duration } -class "Contract" [[glossary.html#glossaryid-200{200}]] { - id : String [[[glossary.html#glossaryid-201{201}]]] - customer : Customer [[[glossary.html#glossaryid-202{202}]]] - effectDate : LocalDate [[[glossary.html#glossaryid-203{203}]]] +class "Contract" { + id : String + customer : Customer + effectDate : LocalDate } -class "Customer" [[glossary.html#glossaryid-300{300}]] { - name : String [[[glossary.html#glossaryid-301{301}]]] - contracts : Set [[[glossary.html#glossaryid-Customer_contracts{Customer.contracts}]]] +class "Customer" { + name : String + contracts : Set } -class "ListBillRepository" [[glossary.html#glossaryid-ListBillRepository{ListBillRepository}]] { - bills : List [[[glossary.html#glossaryid-ListBillRepository_bills{ListBillRepository.bills}]]] +class "ListBillRepository" { + bills : List add(Bill) : Bill clear() get(YearMonth) : Optional retreiveLastBill() : Optional } -class "SmsAccess" [[glossary.html#glossaryid-600{600}]] +class "SmsAccess" "AbstractDomain" <|-- "Access" "AbstractDomain" <|-- "Bill"