Skip to content

Writing documentation

Jump to bottom
Michał Wiatr edited this page Aug 2, 2016 · 2 revisions

#UML embedding

  • All UML should be written in PlantUML and be stored in ./doc/uml as a .puml file. This will be for revisioning diagrams as well.
  • UML diagrams will be automaticly compiled and embedeed to FlowR wiki page using this tehnique:

I found it is possible to do this using plantuml-gist on http://uml.mvnsearch.org/

Just put a valid puml file in the repository and include a link to this site in the documentation.

For example, for the file https://github.com/linux-china/plantuml-gist/blob/master/src/main/uml/plantuml_gist.puml in GitHub, you would use http://uml.mvnsearch.org/github/linux-china/plantuml-gist/blob/master/src/main/uml/plantuml_gist.puml as your link.

So our embeded UML img will be like: http://uml.mvnsearch.org/github/wiatrM/FlowR/blob/development/doc/uml/**<UML name.puml>**

##Example: Inside /doc/uml there is a test.puml file with source:

@startuml
package "PlantUML Repository" {
     [Gitlab]
     [Github]
     [Github Gist]
     [中文仓库]
}
[PlantUMLRenderServlet] --> [Gitlab]
[PlantUMLRenderServlet] --> [Github]
[PlantUMLRenderServlet] --> [Github Gist]
HTTP <-- [PlantUMLRenderServlet]
@enduml

So the link to image will be: http://uml.mvnsearch.org/github/wiatrM/FlowR/blob/development/doc/uml/test.puml

Embeded:

Clone this wiki locally