Libo_PlantUML

30 6

This extension enables PlantUML directly in your Writer documents.

Project Description

PlantUML in LibreOffice

Get the extension

The extension can be found on the extension website: https://extensions.libreoffice.org/extensions/libo_plantuml or on Github.com: https://github.com/lodahl/Libo_PlantUML/ .

Getting started

The extension implements a new toolbar by the name PlantUML. If the toolbar doesn't appear automatically, you can easily find it under View → Toolbars → PlantUML.

Generate image

All you have to do is to write your PlantUML syntax right into you document. You can have one or several diagrams in each document. Be aware that PlantUML syntax can not be inside a table or a text frame.

@startuml

Demo1 -> Demo2

Demo2 -> Demo3

Demo3 -> Demo1

Demo1 -> Demo3

@enduml

You have two options:

If you cursor is placed inside a PlantUML code, you will generate only that diagram. If the cursor is outside PlantUML code, that will generate all PlantUMLs in the document.

Click on the first icon called Make UML.

The result is that the image of the diagram is added and the document now shows both the PlantUML code and the diagram.

You can at any time change the code and regenerate an updated diagram image.

@startuml

start

:Demo 1;

:Demo 2;

:Demo 3;

stop

@enduml

The code will at this time be assigned the paragraph style by the name PlantUML.

Hiding the code

You can toggle viewing the code on and off with a click on the second button called Toggle source.

Paragraph styles

Hiding and showing the code is based on the style applied to the code first time you create an image. This style is controlling hiding and viewing the code.

If you want to, you can change the look and feel of any PlantUML code by changing the paragraph style.

Diagram from external file

Insert

It is possible to insert PlantUML code from external sources.

If you just want to insert the code directly, you can insert the code by using Insert → Text from file... and then navigate to where your PlantUML code is stored. This will just insert the code from the file.

Link

If you want to make a generic link to an external PlantUML source file, you need to insert a Section in you document with Insert → Section.

In the Insert Section dialog you must check Link and then navigate to your PlantUML source code from the File name field. This will insert a section with the source from the file.

The section will contain the code that can be converted to a diagram image and toggled just as if it was written directly in the document.

Known isues

Encoding

When inserting PlantUML from external source you might meet some issues with encoding. Default encoding the source as UTF-8 will import and link with errors, as LibreOffice is considering the content as ISO (in my case ISO 8859-1) and the diagram will be wrong encoded.

If you encode the source file with the same encoding than LibreOffice, the the imported or linked files will render correctly.

On Windows I use Notepad++ and encoding in UTF-8 BOM without problems.

Graphwiz missing

On Windows I have discovered that sometimes PlantUML is complaining about Graphwiz not being present.

Download Graphwiz from here and install it. That solved the problem for me.

Compile

Just run ./make.sh Libo_PlantUML (on linux)

Test

This extension has been tested with LibreOffice 6.0 and 6.1 on Windows and Linux.

History

  • 04.11.2018: 121
    • Checking for cursor is in a textframe.
    • Supports other types than PlantUML e.g., @startsalt and @startdot
  • 17.10.2018: 1.2.0:
    • Added support for LibreOffice 6.1
    • Checking for cursor is in a table
    • Some minor fixes to UI.
  • 27.04.2017: 1.1.0
    • Create new develop branch
    • Removed progress dialog and replaced with status bar.
  • 23.04.2017: 1.0.0: 1.0.0

Category/Categories

Macro, Writer Extension

Homepage of the Project

https://github.com/lodahl/Libo_PlantUML

Logo

Current Release

Libo_PlantUML - 1.2.1

Released Nov 04, 2018 — tested with:

LibreOffice 4.0, LibreOffice 4.1, LibreOffice 4.2, LibreOffice 4.3, LibreOffice 4.4, LibreOffice 5.0, LibreOffice 5.1, LibreOffice 5.2, LibreOffice 5.3, LibreOffice 5.4, LibreOffice 6.0, LibreOffice 6.1,

Checking for cursor is in a textframe. Supports other types than PlantUML e.g., @startsalt and @startdot
More about this release…

Libo_PlantUML.oxt
All platforms
File size: 6785 kb

All Releases

Version

Released

Platform(s)

Compatibility

Description

License(s)

Status

1.2.1

Nov 04, 2018
  • All platforms
  • LibreOffice 4.0
  • LibreOffice 4.1
  • LibreOffice 4.2
  • LibreOffice 4.3
  • LibreOffice 4.4
  • LibreOffice 5.0
  • LibreOffice 5.1
  • LibreOffice 5.2
  • LibreOffice 5.3
  • LibreOffice 5.4
  • LibreOffice 6.0
  • LibreOffice 6.1
Checking for cursor is in a textframe. Supports other types than PlantUML e.g., @startsalt and @startdot
  • LGPL-v2.1 (GNU Lesser General Public License Version 2.1)
final

1.2.0

Oct 18, 2018
  • All platforms
  • LibreOffice 5.3
  • LibreOffice 5.4
  • LibreOffice 6.0
  • LibreOffice 6.1
Added support for LibreOffice 6.1 Checking for cursor is in a table Some minor fixes to UI (Error messages)
  • GNU-GPL-v3 (General Public License Version 3)
final

1.1.0

May 06, 2017
  • All platforms
  • LibreOffice 5.0
  • LibreOffice 5.1
  • LibreOffice 5.2
  • LibreOffice 5.3
Most important feature is that plantuml.jar now is embedded in the extension.
  • LGPL-v2.1 (GNU Lesser General Public License Version 2.1)
final

1.0.0

Apr 24, 2017
  • Linux
  • Linux-x64
  • Windows
  • LibreOffice 5.0
  • LibreOffice 5.1
  • LibreOffice 5.2
  • LibreOffice 5.3
Inital release. Exactly as the original file from https://plantuml.com
  • LGPL-v2.1 (GNU Lesser General Public License Version 2.1)
final

Legal Disclaimer and Limitations for Downloads

The Document Foundation has not reviewed, and cannot review, all of the material, including computer software, available on or by means of The Document Foundation's
websites, and cannot therefore be responsible for that material's content, use or effects. By operating its websites, The Document Foundation does not represent or imply that it endorses the material there available, or that it believes such material to be accurate, useful or nonharmful. You are responsible for taking precautions as necessary to protect yourself and your computer systems from viruses, worms, Trojan horses and other harmful or destructive content. The Document Foundation's websites may contain content that is offensive, indecent or otherwise objectionable, as well as content containing technical inaccuracies, typographical mistakes and other errors. The Document Foundation's websites may also contain material that violates the privacy or publicity rights, or infringes the proprietary rights, of third parties, or the downloading, copying or use of which is subject to additional terms and conditions, stated or unstated. The Document Foundation disclaims any responsibility for any harm resulting from the use by The Document Foundation's visitors of The Document Foundation's websites, or from any downloading by those visitors of content available on or by means of The Document Foundation's websites.

Changes

Content contained on The Document Foundation's websites, including these Legal Disclaimers and Limitations, may be changed at the sole discretion of The Document Foundation and without notice. You are bound by any such updates or changes, and so should periodically review these Legal Disclaimers and Limitations.

If you believe any file is present on the site contrary to any TDF rule or applicable law, please supply full details to info@documentfoundation.org for impartial consideration.