Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Recent changes    Wiki Toc    View page history    Add new chapter    Reorder page    Raw

Start

We are thinking about a slightly new way of creating PlantUML documentation.

This is an attempt to replace the existing Dokuwiki site.

Right now, this website is still under test. At some point, the existing wiki will be imported here.

We have decided to support several syntaxes of wikis. Right now you can use:

And you can Vote for your syntax!

Each user can really use whatever he prefers: the wiki convert user's contributions on the fly.
PlantUML Team
Welcome !
All contributions made here are public.
Thanks for helping us to improve PlantUML documentation !

Your Help Needed!

Thanks to Arnaud, it's really easy for people to contribute doc additions and fixes using their favorite syntax. Most of the important Wanted Features (initially discussed at the plantuml Documentation project issue are now implemented, and Arnaud will be adding more.

So now it's time for the community to step up and help Arnaud document this wonderful program better! Here is how you can help:

  • Document your favorite features
  • Go through the list of Undocumented plantuml features and work out some of them. It's a categorized list of 100-200 tasks that need your help
  • Post questions, issues and finding in the forum
  • Participate in Slack
PlantUML Team
You can use this chat to ask questions or to give any feedback on Your Help Needed!

Recommendation and Best practice

  • Avoid to put style on title (no raw, italic or bold...)
PlantUML Team
You can use this chat to ask questions or to give any feedback on Recommendation and Best practice

Wanted Features

  • Fully anonymous access: you won't have to create an account to edit contents
    DONE
  • Advanced SPAM protection: we use branches when people edit content, so spam contributions will not have to be cancelled, they will just be never merged and we won't even have to delete them.
    DONE
  • Automatic page creation: just go to http://alphadoc.plantuml.com/doc/en/any-page-you-want
    DONE
  • Possibility that each contributor uses its favorite wiki syntax.
    DONE
    : asciidoc, dokuwiki, markdown
  • Duplication of plantuml code
    DONE
    : shows as source and as diagram
  • Automatic generation of PlantUML diagrams
    DONE
    : see next section
  • Possibility to create named user/login for serious contributors
    TODO
  • PDF generation through LaTeX
    TODO
  • Automatic consistence between translated versions
    TODO
  • Automatic synchronization with some GitHub repository
    TODO
  • Automatic TOC/site map on the alphadoc site
    TODO
  • Automatic TOC/site map on the final site (not only on this alphadoc site)
    TODO
  • Sync to/from web site
    TODO
  • Link checking
    TODO
    #361
  • Ability to Update title/desc*
    TODO
    (currently gives exception #363)
  • Use named anchors (perhaps even automatically anchor <h1>, <h2>, <h3>, ... tag) so you can have stable # links within the documentation and linking from the outside
    TODO
PlantUML Team
You can use this chat to ask questions or to give any feedback on Wanted Features

Demo diagrams

You can use a new special tag <plantuml> for diagrams.

<plantuml>
@startuml
...
@enduml
</plantuml>

The result is that the PlantUML source is shown, followed by the diagram:

@startuml
User -> Wiki : document, document, document...
@enduml

PlantUML Team
You can use this chat to ask questions or to give any feedback on Demo diagrams


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.