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.

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


起步

我们正在考虑一种组织 PlantUML 文档的新方式。

这是对替换目前的 Dokuwiki 站点的一次尝试。

当前,网站还处于测试状态。在某个时间点,我们会将现存的 Wiki 导入到这里。

我们决定使用多种格式的 Wiki 文本,目前包括以下几种:

你也可以为你喜爱的格式投票!

每个用户都可以使用自己喜欢的方式:Wiki会自动转换用户的贡献。

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 文档计划)已经实现,PlantUML 团队会不断实现新的需求。

现在正是社区加快并帮助这个令人惊叹的程序更好地编写文档的时机。 你可以提供以下帮助:

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 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 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>来显示图表。

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

结果是显示 PlantUML 源代码,后面跟着图表。

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

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


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