Multilingual Wiki Documentation
In an attempt to improve
Please do not use this website for your own diagrams.
click here and use the online server here for your own documentation.
Wiki Toc Recent changes View page history Add new chapter Reorder page Raw
Back to top Start
We are thinking about a slightly new way of creating PlantUML documentation.
This is an attempt to replace the existing
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.
Back to top Your Help Needed!
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 ) are now implemented, and the PlantUML team will be adding more.
plantuml Documentation project
So now it's time for the community to step up and to help documenting this wonderful program better!
Here is how you can help:
Back to top Recommendation and Best practice
Avoid to put style on title (no raw, italic or bold...)
Back to top Wanted Features
Fully anonymous access: you won't have to create an account to
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.
Automatic page creation: just go to
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
PDF generation through LaTeX
Automatic consistence between translated versions
Automatic synchronization with some GitHub repository
Automatic TOC/site map on the alphadoc site
Automatic TOC/site map on the final site (not only on this alphadoc site)
Sync to/from web site
#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
Back to top Demo diagrams
You can use a new special tag
<plantuml> for diagrams.
The result is that the PlantUML source is shown, followed by the diagram:
User -> Wiki : document, document, document...
This website is still in beta testing.