Git Product home page Git Product logo

dokuwiki_plantuml's Introduction

This plugin is not maintained anymore


This plugin integrates PlantUML into the DukuWiki wiki engine. It allows to generate UML graph images from simple description text block.

Features

  • Create any UML graph supported by PlantUML.
  • Generated images are PNGs.
  • Generated images are cached and regenerated when needed.
  • Toolbar button (optional)
  • Control the display witdh, height and alignment.
  • Works with the PlantUML webservice and/or a local installation.

Local Rendering

Requirements (for local PlantUML installation):

See PlantUML Installation Notes for troubleshooting.

Remote Rendering

The plugin can use PlantUML server to generate diagrams. So nothing is required to be installed on the server running DokuWiki. However, the server must have a access to the Web. This can be an issue if you're on a Corporate network for example.

If you set java and plantuml location in the configuration (in the Administration section of DokuWiki), then java will be used to compress the url.

Sample

This block describes a sequence diagram:

<uml>
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
</uml>

and results in:

Sample

Control display size

Inside the start tag <uml>, you can specify the width and/or height of the image using one of the following ways:

<uml w=100>
<uml width=100>
<uml w=80%>
<uml width=80%>
<uml 100x200>

Image Title

By default, html img title attribute is set to "PlantUML Graph". You can specify your own graph title like this:

<uml title="This will be the title">
<uml t=Diagram>

Note: Multiple words need to be placed in double quotes.

Contributors

dokuwiki_plantuml's People

Contributors

andreone avatar zengjuly avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.