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.

Recommendation and Best practice

  • Avoid to put style on title (no raw, italic or bold...)

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 to create named user/login for serious contributors
    TODO
  • Possibility that each contributor uses its favorite wiki syntax (markdown, dokuwiki, ...)
    TODO
  • PDF generation through LaTeX
    TODO
  • Automatic consistence between translated versions
    TODO
  • Automatic generation of PlantUML images
    TODO
  • Automatic synchronization with some GitHub repository
    TODO
  • automatic TOC/ site map
    TODO
  • duplication of plantuml code
    DONE
  • and sync to/from web site
    TODO
  • add possibility to add anchor and link on the wiki (perhaps even automaticaly anchor for titles (<h1>, <h2>, <h3>, ... tag)) in order to link out on the wiki and outside the wiki (with use of #)
    TODO
  • automatic TOC / site map on the final site (not only on this alphadoc site)
    TODO

Demo diagrams

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

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

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


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