Start
We are thinking about a slightly new way of creating PlantUML documentation.
Right now, this website is still under testing. 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 whichever they prefer since the wiki converts users' contributions on the fly.
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 plantuml Documentation project) are now implemented, and the PlantUML team will be adding more.
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:
Recommendation and Best practice
- Avoid adding font styles to titles (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 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
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
|