Skip to content
This repository has been archived by the owner on Jan 10, 2024. It is now read-only.

#2 allow to export properties to C4 PlantUML files #12

Merged
merged 3 commits into from
Jul 4, 2022

Conversation

klu2
Copy link
Contributor

@klu2 klu2 commented Apr 6, 2022

This PR would be a solution for #2 by adding properties to elements and relationships.

The resulting diagram would look like that:

image

This functionality needs to be explicitely enabled by setting com.structurizr.export.plantuml.AbstractPlantUMLExporter#PLANTUML_ADD_PROPERTIES_PROPERTY to true

@klu2
Copy link
Contributor Author

klu2 commented Jun 6, 2022

The content of this pull request is part of https://github.com/cloudflightio/structurizr-export-c4plantuml now which can be used as a replacement to this library. As soon as this PR is merged and released, I can remove the code from the other repository again.

There is also other code in that repo (i.e. for tagging/styling), which I could also offer as a PR then.

@simonbrowndotje
Copy link
Contributor

Thanks for this. Some initial thoughts:

  • Since this seems to be C4-PlantUML specific, perhaps the view set property would be better named c4plantuml.addProperties to avoid any confusion that the feature is not available for the regular PlantUML export.
  • On that note though, it might make sense to have two view set properties (e.g. c4plantuml.elementProperties and c4plantuml.relationshipProperties) so that users can choose which are shown ... I can imagine some people will be less inclined to see relationship properties.

@klu2
Copy link
Contributor Author

klu2 commented Jun 13, 2022

Thanks for this. Some initial thoughts:

  • Since this seems to be C4-PlantUML specific, perhaps the view set property would be better named c4plantuml.addProperties to avoid any confusion that the feature is not available for the regular PlantUML export.
  • On that note though, it might make sense to have two view set properties (e.g. c4plantuml.elementProperties and c4plantuml.relationshipProperties) so that users can choose which are shown ... I can imagine some people will be less inclined to see relationship properties.

changed the PR accordingly

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants