puml(9)

SYNOPSIS

puml - Graphviz Dot Diagram Language File.

FILES

hkpuml.emf - PlantUML diagram file hook definition
puml.eaf - PlantUML diagram abbreviation file
puml.etf - PlantUML diagram template file

EXTENSIONS

.puml, .pml - PlantUML file

DESCRIPTION

The PlantUML file macro provides simple hilighting of PlantUML diagram files.

File recognition is performed using the standard file extension .puml or .pml.

Editing Environment


Beside of syntax highlighting the file hook offers as well abbreviations, folding for the style section of the file. Further is is possible to expand abbreviations either via short strings using the expand-abbrev-handle(3) command and visual inserting abbreviations using the mouse by the abbrev-list(3) macro.

Abbreviations


The installation comes with a default abbreviation file for PlantUML code editing which can be used by writing short abbreviations like "um" (start/enduml environment) "mm" (mindmap environment) or "st" (style section) - and then pressing the key-binding for the expand-abbrev-handle(3) command. The list of abbreviations can be used interactively in the GUI version of MicroEmacs using the abbrev-list(3) command.

Folding and Information Hiding


Generic folding is enabled within the PlantUML files. The folds occur about the style sectionss located on the left-hand margin at the beginning of the line and the closing style tag. The following commands are supported to show and hide the function bodies. collapse-all(3) (un)folds all regions in the file, collapse-current(3) (un)folds the current region.

Short Cuts


The short cut keys used within the buffer are:

C-c C-c - Comment out the current line.
C-c C-d - Uncomment the current line.
C-c C-e - Comment to the end of the line with stars (*).
A-C-i - Restyle the current region.
f2 - (un)fold the current region
f3 - (un)fold all regions

NOTES

The hilighting is typically extended using a file mypuml.emf.

BUGS

No serious known so far.

SEE ALSO

abbrev-list(3), collapse-all(3), collapse-current(3), dot(9), expand-abbrev-handle(3), restyle-buffer(3), restyle-region(3),

Supported File Types

Ref: puml(9) File: m9typ077.9 Date: 2026/01/21

(c) Copyright JASSPA 2026