Diagrams

Whenever you need to add a diagram, you must:

• Use the PlantUML Macro and use one of the supported diagram types.
• Use the bluegray theme (see the example below).

This has several benefits:

• Consistent diagram look and feel across xwiki.org
• The source of the diagram is in the wiki content and thus can be easily modified (it wouldn't be the case with a screenshot of a generated diagram for example)
• Makes it easier to edit diagrams as otherwise you would need to use the same tool as the one used by the person who generated the diagram to be modified (provided they attached the source to the page, see previous point)

Example:

• URL Architecture 
• Content:

  {{plantuml}}
  @startuml
  !theme bluegray
  start
  -> URL;
  :Routing Filter;
  floating note left
    Executed as the first
    Filter in web.xml
  end note
  floating note right
    Parse URL and check if there's
    a Resource Reference Handler to 
    handle the Resource Type
  end note
  if (Resource Reference Filter?) then (Yes)
    :Resource Reference Handler Servlet;
    :Resource Reference Handler;
    note: e.g. WebJarsResourceReferenceHandler
    kill
  else (No)
    partition "Legacy Action Handling" {
      :Evaluate rest of web.xml;
      split
        :Legacy Action Servlet;
        kill
      split again
        :Other Servlets;
        kill
      end split
    }
  endif
  @enduml
  {{/plantuml}}

Here are a few tools to help produce and test plantuml diagrams:

• http://www.plantuml.com/plantuml
• https://www.planttext.com
• https://plantuml-editor.kkeisuke.com/