Cheatsheets:PlantUML - Revision history

RonzzWikiCowriterAI: Add Headings/special chars + Links to example, add Code to explanation (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

2026-08-31T15:32:12Z

Add Headings/special chars + Links to example, add Code to explanation (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 15:32, 31 August 2026
Line 535:		Line 535:
	<syntaxhighlight lang="text" copy>		<syntaxhighlight lang="text" copy>
	@startuml		@startuml
	Alice -> Bob: ~~Hello~~ <:1f600:>		title "The ""answer"" is <U+221E>"
			Alice -> Bob: <:1f600:> [[http://plantuml.com docs]]
	Alice -> Bob: Recolor: <#green:sunny:>		Alice -> Bob: Recolor: <#green:sunny:>
	note right		note right
	<code>		= Heading
	main() {		== Sub heading
	printf("Hello world");		<code>
	}		main() {
	</code>		printf("Hello world");
			}
			</code>
	end note		end note
	@enduml		@enduml
Line 549:		Line 552:
	<uml>		<uml>
	@startuml		@startuml
	Alice -> Bob: ~~Hello~~ <:1f600:>		title "The ""answer"" is <U+221E>"
			Alice -> Bob: <:1f600:> [[http://plantuml.com docs]]
	Alice -> Bob: Recolor: <#green:sunny:>		Alice -> Bob: Recolor: <#green:sunny:>
	note right		note right
	<code>		= Heading
	main() {		== Sub heading
	printf("Hello world");		<code>
	}		main() {
	</code>		printf("Hello world");
			}
			</code>
	end note		end note
	@enduml		@enduml
Line 568:		Line 574:

	'''Headings & special chars''' — inside quoted multi-line labels: <syntaxhighlight lang="text" inline>= Head</syntaxhighlight>, <syntaxhighlight lang="text" inline>== Sub</syntaxhighlight>, <syntaxhighlight lang="text" inline>=== Sub-sub</syntaxhighlight>. Any Unicode char works directly, or as <syntaxhighlight lang="text" inline><U+221E></syntaxhighlight> (hex) / <syntaxhighlight lang="text" inline>∞</syntaxhighlight> (decimal).		'''Headings & special chars''' — inside quoted multi-line labels: <syntaxhighlight lang="text" inline>= Head</syntaxhighlight>, <syntaxhighlight lang="text" inline>== Sub</syntaxhighlight>, <syntaxhighlight lang="text" inline>=== Sub-sub</syntaxhighlight>. Any Unicode char works directly, or as <syntaxhighlight lang="text" inline><U+221E></syntaxhighlight> (hex) / <syntaxhighlight lang="text" inline>∞</syntaxhighlight> (decimal).

			'''Code''' — <syntaxhighlight lang="text" inline><code>…</code></syntaxhighlight> shows source code without syntax highlighting.

	'''Legacy HTML''' — colors, sizes, images, sub/superscripts: <syntaxhighlight lang="text" inline><color:red>…</color></syntaxhighlight>, <syntaxhighlight lang="text" inline><back:cadetblue>…</back></syntaxhighlight>, <syntaxhighlight lang="text" inline><size:18>…</size></syntaxhighlight>, <syntaxhighlight lang="text" inline><img:https://…></syntaxhighlight>, <syntaxhighlight lang="text" inline><sub></syntaxhighlight> / <syntaxhighlight lang="text" inline><sup></syntaxhighlight>.		'''Legacy HTML''' — colors, sizes, images, sub/superscripts: <syntaxhighlight lang="text" inline><color:red>…</color></syntaxhighlight>, <syntaxhighlight lang="text" inline><back:cadetblue>…</back></syntaxhighlight>, <syntaxhighlight lang="text" inline><size:18>…</size></syntaxhighlight>, <syntaxhighlight lang="text" inline><img:https://…></syntaxhighlight>, <syntaxhighlight lang="text" inline><sub></syntaxhighlight> / <syntaxhighlight lang="text" inline><sup></syntaxhighlight>.

Rongzhou: /* Creole */

2026-08-31T15:28:23Z

Creole

← Older revision		Revision as of 15:28, 31 August 2026
Line 456:		Line 456:
	<blockquote>		<blockquote>
	'''In double-quoted strings''' — <syntaxhighlight lang="text" inline>""monospaced""</syntaxhighlight> works in quoted content — titles, notes, message labels — but not in quoted element names like <syntaxhighlight lang="text" inline>participant "Alice ..."</syntaxhighlight> or <syntaxhighlight lang="text" inline>state "Waiting ..." as W</syntaxhighlight>: the <syntaxhighlight lang="text" inline>""</syntaxhighlight> collides with the string delimiter and the diagram fails to parse. Use the HTML form there instead:		'''In double-quoted strings''' — <syntaxhighlight lang="text" inline>""monospaced""</syntaxhighlight> works in quoted content — titles, notes, message labels — but not in quoted element names like <syntaxhighlight lang="text" inline>participant "Alice ..."</syntaxhighlight> or <syntaxhighlight lang="text" inline>state "Waiting ..." as W</syntaxhighlight>: the <syntaxhighlight lang="text" inline>""</syntaxhighlight> collides with the string delimiter and the diagram fails to parse. Use the HTML form there instead:
	~~</blockquote>~~

	{\| class="wikitable"		{\| class="wikitable"
Line 478:		Line 477:
	</uml>		</uml>
	\|}		\|}

	~~<blockquote>~~
	'''Lists''' — <syntaxhighlight lang="text" inline></syntaxhighlight> bullet, <syntaxhighlight lang="text" inline>#</syntaxhighlight> numbered; repeat the marker to nest (<syntaxhighlight lang="text" inline>*</syntaxhighlight>, <syntaxhighlight lang="text" inline>##</syntaxhighlight>). You cannot mix bullets and numbers in one list.

	'''Horizontal lines''' — <syntaxhighlight lang="text" inline>----</syntaxhighlight> single, <syntaxhighlight lang="text" inline>====</syntaxhighlight> double, <syntaxhighlight lang="text" inline>____</syntaxhighlight> strong, <syntaxhighlight lang="text" inline>..My title..</syntaxhighlight> dotted with title, <syntaxhighlight lang="text" inline>==Title==</syntaxhighlight> / <syntaxhighlight lang="text" inline>--Another title--</syntaxhighlight> with a title.

	'''Links''' — <syntaxhighlight lang="text" inline>[[http://plantuml.com]]</syntaxhighlight>, <syntaxhighlight lang="text" inline>[[http://plantuml.com This label is printed]]</syntaxhighlight>, with tooltip <syntaxhighlight lang="text" inline>[[http://plantuml.com{Optional tooltip} This label is printed]]</syntaxhighlight> — three brackets link to a field or method on class diagrams.
	</blockquote>		</blockquote>

Line 528:		Line 520:
	@enduml		@enduml
	</uml>		</uml>
			\|}


			'''Lists''' — <syntaxhighlight lang="text" inline></syntaxhighlight> bullet, <syntaxhighlight lang="text" inline>#</syntaxhighlight> numbered; repeat the marker to nest (<syntaxhighlight lang="text" inline>*</syntaxhighlight>, <syntaxhighlight lang="text" inline>##</syntaxhighlight>). You cannot mix bullets and numbers in one list.

			'''Horizontal lines''' — <syntaxhighlight lang="text" inline>----</syntaxhighlight> single, <syntaxhighlight lang="text" inline>====</syntaxhighlight> double, <syntaxhighlight lang="text" inline>____</syntaxhighlight> strong, <syntaxhighlight lang="text" inline>..My title..</syntaxhighlight> dotted with title, <syntaxhighlight lang="text" inline>==Title==</syntaxhighlight> / <syntaxhighlight lang="text" inline>--Another title--</syntaxhighlight> with a title.



			{\| class="wikitable"
			! Source (.puml) !! Rendered
	\|-		\|-
	\|		\|
Line 559:		Line 562:
	\|}		\|}

	<~~blockquote~~>
			'''Links''' — <syntaxhighlight lang="text" inline>[[http://plantuml.com]]</syntaxhighlight>, <syntaxhighlight lang="text" inline>[[http://plantuml.com This label is printed]]</syntaxhighlight>, with tooltip <syntaxhighlight lang="text" inline>[[http://plantuml.com{Optional tooltip} This label is printed]]</syntaxhighlight> — three brackets link to a field or method on class diagrams.

	'''Emoji & icons''' — Twemoji emoji are always available (no font dependency) and already colored: <syntaxhighlight lang="text" inline><:1f600:></syntaxhighlight>, recolored <syntaxhighlight lang="text" inline><#green:sunny:></syntaxhighlight>. OpenIconic icons: <syntaxhighlight lang="text" inline><&heart></syntaxhighlight>. List them with the special commands <syntaxhighlight lang="text" inline>emoji</syntaxhighlight> and <syntaxhighlight lang="text" inline>listopeniconic</syntaxhighlight>.		'''Emoji & icons''' — Twemoji emoji are always available (no font dependency) and already colored: <syntaxhighlight lang="text" inline><:1f600:></syntaxhighlight>, recolored <syntaxhighlight lang="text" inline><#green:sunny:></syntaxhighlight>. OpenIconic icons: <syntaxhighlight lang="text" inline><&heart></syntaxhighlight>. List them with the special commands <syntaxhighlight lang="text" inline>emoji</syntaxhighlight> and <syntaxhighlight lang="text" inline>listopeniconic</syntaxhighlight>.

Line 565:		Line 570:

	'''Legacy HTML''' — colors, sizes, images, sub/superscripts: <syntaxhighlight lang="text" inline><color:red>…</color></syntaxhighlight>, <syntaxhighlight lang="text" inline><back:cadetblue>…</back></syntaxhighlight>, <syntaxhighlight lang="text" inline><size:18>…</size></syntaxhighlight>, <syntaxhighlight lang="text" inline><img:https://…></syntaxhighlight>, <syntaxhighlight lang="text" inline><sub></syntaxhighlight> / <syntaxhighlight lang="text" inline><sup></syntaxhighlight>.		'''Legacy HTML''' — colors, sizes, images, sub/superscripts: <syntaxhighlight lang="text" inline><color:red>…</color></syntaxhighlight>, <syntaxhighlight lang="text" inline><back:cadetblue>…</back></syntaxhighlight>, <syntaxhighlight lang="text" inline><size:18>…</size></syntaxhighlight>, <syntaxhighlight lang="text" inline><img:https://…></syntaxhighlight>, <syntaxhighlight lang="text" inline><sub></syntaxhighlight> / <syntaxhighlight lang="text" inline><sup></syntaxhighlight>.
	~~</blockquote>~~

	~~'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> prints the next special character literally; unescaped, PlantUML interprets it as creole markup:~~

	{\| class="wikitable"		{\| class="wikitable"
Line 602:		Line 604:
	</uml>		</uml>
	\|}		\|}

			'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> prints the next special character literally; unescaped, PlantUML interprets it as creole markup:

	Full reference: [https://plantuml.com/creole PlantUML Creole].		Full reference: [https://plantuml.com/creole PlantUML Creole].

RonzzWikiCowriterAI: Move escaping (creole) out of Common syntax into Creole section (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

2026-08-31T15:08:27Z

Move escaping (creole) out of Common syntax into Creole section (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

@@ Line 393: / Line 393: @@
 Alice -> Bob: Ship order
 Bob --> Alice: OK
 @enduml
 </uml>

RonzzWikiCowriterAI: Fix double-escaped HTML snippets, move escaping into Creole, add quoted-strings note (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

2026-08-31T15:08:21Z

Fix double-escaped HTML snippets, move escaping into Creole, add quoted-strings note (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

@@ Line 477: / Line 477: @@
 ! Creole !! Renders as !! HTML equivalent
 |-
-| <syntaxhighlight lang="text" inline>**bold**</syntaxhighlight> || bold || <syntaxhighlight lang="text" inline>&lt;b&gt;…&lt;/b&gt;</syntaxhighlight>
+| <syntaxhighlight lang="text" inline>**bold**</syntaxhighlight> || bold || <syntaxhighlight lang="text" inline><b>…</b></syntaxhighlight>
 |-
-| <syntaxhighlight lang="text" inline>//italics//</syntaxhighlight> || italic || <syntaxhighlight lang="text" inline>&lt;i&gt;…&lt;/i&gt;</syntaxhighlight>
+| <syntaxhighlight lang="text" inline>//italics//</syntaxhighlight> || italic || <syntaxhighlight lang="text" inline><i>…</i></syntaxhighlight>
 |-
-| <syntaxhighlight lang="text" inline>""monospaced""</syntaxhighlight> || monospaced || <syntaxhighlight lang="text" inline>&lt;font:monospaced&gt;…&lt;/font&gt;</syntaxhighlight>
+| <syntaxhighlight lang="text" inline>""monospaced""</syntaxhighlight> || monospaced || <syntaxhighlight lang="text" inline><font:monospaced>…</font></syntaxhighlight>
 |-
-| <syntaxhighlight lang="text" inline>--stricken-out--</syntaxhighlight> || strikethrough || <syntaxhighlight lang="text" inline>&lt;s&gt;…&lt;/s&gt;</syntaxhighlight>
+| <syntaxhighlight lang="text" inline>--stricken-out--</syntaxhighlight> || strikethrough || <syntaxhighlight lang="text" inline><s>…</s></syntaxhighlight>
 |-
-| <syntaxhighlight lang="text" inline>__underlined__</syntaxhighlight> || underlined || <syntaxhighlight lang="text" inline>&lt;u&gt;…&lt;/u&gt;</syntaxhighlight>
+| <syntaxhighlight lang="text" inline>__underlined__</syntaxhighlight> || underlined || <syntaxhighlight lang="text" inline><u>…</u></syntaxhighlight>
 |-
-| <syntaxhighlight lang="text" inline>~~wave-underlined~~</syntaxhighlight> || wavy underline || <syntaxhighlight lang="text" inline>&lt;w&gt;…&lt;/w&gt;</syntaxhighlight>
+| <syntaxhighlight lang="text" inline>~~wave-underlined~~</syntaxhighlight> || wavy underline || <syntaxhighlight lang="text" inline><w>…</w></syntaxhighlight>
 |}
@@ Line 571: / Line 596: @@
 <blockquote>
-'''Emoji &amp; icons''' — Twemoji emoji are always available (no font dependency) and already colored: <syntaxhighlight lang="text" inline>&lt;:1f600:&gt;</syntaxhighlight>, recolored <syntaxhighlight lang="text" inline>&lt;#green:sunny:&gt;</syntaxhighlight>. OpenIconic icons: <syntaxhighlight lang="text" inline>&lt;&amp;heart&gt;</syntaxhighlight>. List them with the special commands <syntaxhighlight lang="text" inline>emoji</syntaxhighlight> and <syntaxhighlight lang="text" inline>listopeniconic</syntaxhighlight>.
+'''Emoji &amp; icons''' — Twemoji emoji are always available (no font dependency) and already colored: <syntaxhighlight lang="text" inline><:1f600:></syntaxhighlight>, recolored <syntaxhighlight lang="text" inline><#green:sunny:></syntaxhighlight>. OpenIconic icons: <syntaxhighlight lang="text" inline><&heart></syntaxhighlight>. List them with the special commands <syntaxhighlight lang="text" inline>emoji</syntaxhighlight> and <syntaxhighlight lang="text" inline>listopeniconic</syntaxhighlight>.
-'''Headings &amp; special chars''' — inside quoted multi-line labels: <syntaxhighlight lang="text" inline>= Head</syntaxhighlight>, <syntaxhighlight lang="text" inline>== Sub</syntaxhighlight>, <syntaxhighlight lang="text" inline>=== Sub-sub</syntaxhighlight>. Any Unicode char works directly, or as <syntaxhighlight lang="text" inline>&lt;U+221E&gt;</syntaxhighlight> (hex) / <syntaxhighlight lang="text" inline>&amp;#8734;</syntaxhighlight> (decimal).
+'''Headings &amp; special chars''' — inside quoted multi-line labels: <syntaxhighlight lang="text" inline>= Head</syntaxhighlight>, <syntaxhighlight lang="text" inline>== Sub</syntaxhighlight>, <syntaxhighlight lang="text" inline>=== Sub-sub</syntaxhighlight>. Any Unicode char works directly, or as <syntaxhighlight lang="text" inline><U+221E></syntaxhighlight> (hex) / <syntaxhighlight lang="text" inline>&#8734;</syntaxhighlight> (decimal).
-'''Legacy HTML''' — colors, sizes, images, sub/superscripts: <syntaxhighlight lang="text" inline>&lt;color:red&gt;…&lt;/color&gt;</syntaxhighlight>, <syntaxhighlight lang="text" inline>&lt;back:cadetblue&gt;…&lt;/back&gt;</syntaxhighlight>, <syntaxhighlight lang="text" inline>&lt;size:18&gt;…&lt;/size&gt;</syntaxhighlight>, <syntaxhighlight lang="text" inline>&lt;img:https://…&gt;</syntaxhighlight>, <syntaxhighlight lang="text" inline>&lt;sub&gt;</syntaxhighlight> / <syntaxhighlight lang="text" inline>&lt;sup&gt;</syntaxhighlight>.
+'''Legacy HTML''' — colors, sizes, images, sub/superscripts: <syntaxhighlight lang="text" inline><color:red>…</color></syntaxhighlight>, <syntaxhighlight lang="text" inline><back:cadetblue>…</back></syntaxhighlight>, <syntaxhighlight lang="text" inline><size:18>…</size></syntaxhighlight>, <syntaxhighlight lang="text" inline><img:https://…></syntaxhighlight>, <syntaxhighlight lang="text" inline><sub></syntaxhighlight> / <syntaxhighlight lang="text" inline><sup></syntaxhighlight>.
-Escape a special character with <syntaxhighlight lang="text" inline>~</syntaxhighlight> — see [[#Common syntax|Common syntax]].
+'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> prints the next special character literally; unescaped, PlantUML interprets it as creole markup:
-</blockquote>
 Full reference: [https://plantuml.com/creole PlantUML Creole].

RonzzWikiCowriterAI: Add Creole reference link (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

2026-08-31T14:39:47Z

Add Creole reference link (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 14:39, 31 August 2026
Line 896:		Line 896:
	plantuml *.puml # whole directory		plantuml *.puml # whole directory
	</syntaxhighlight>		</syntaxhighlight>

	~~== For more ==~~

	* [https://plantuml.com/ PlantUML] — official site; every diagram type has its own page (sequence-diagram, class-diagram, use-case-diagram, …)		* [https://plantuml.com/ PlantUML] — official site; every diagram type has its own page (sequence-diagram, class-diagram, use-case-diagram, …)
	* [https://plantuml.com/starting Quick Start Guide] — install, first diagram		* [https://plantuml.com/starting Quick Start Guide] — install, first diagram
	* [https://plantuml.com/guide PlantUML Language Reference Guide] — the full syntax		* [https://plantuml.com/guide PlantUML Language Reference Guide] — the full syntax
			* [https://plantuml.com/creole PlantUML Creole] — styled text in any diagram
	* [https://plantuml.com/theme PlantUML Themes] — built-in themes, one-line look change		* [https://plantuml.com/theme PlantUML Themes] — built-in themes, one-line look change
	* [https://plantuml.com/style PlantUML Styles] — CSS-like styling, the skinparam replacement		* [https://plantuml.com/style PlantUML Styles] — CSS-like styling, the skinparam replacement
	* [https://kroki.io/ Kroki] — render PlantUML inside Markdown, AsciiDoc, reStructuredText, …		* [https://kroki.io/ Kroki] — render PlantUML inside Markdown, AsciiDoc, reStructuredText, …
	* [https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml PlantUML VS Code extension]		* [https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml PlantUML VS Code extension]

RonzzWikiCowriterAI: Add Creole section (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

2026-08-31T14:39:39Z

Add Creole section (AI-assisted RonzzWikiCowriter) (via update-page on MediaWiki MCP Server)

Show changes

RonzzWikiCowriterAI: Common syntax: show the ~ escape rule as Source/Rendered contrast examples (unescaped vs escaped HTML and ) instead of prose only (AI-assisted (RonzzWikiCowriter)) (via update-page on MediaWiki MCP Server)

2026-08-30T02:42:52Z

Common syntax: show the ~ escape rule as Source/Rendered contrast examples (unescaped vs escaped HTML and [[ ]]) instead of prose only (AI-assisted (RonzzWikiCowriter)) (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 02:42, 30 August 2026
Line 343:		Line 343:
	<blockquote>		<blockquote>
	Start '''Comments''' <syntaxhighlight lang="text" inline>'</syntaxhighlight> at the beginning of a new line. '''Avoid trailing comments''': <syntaxhighlight lang="text" inline>title Order flow ' diagram title</syntaxhighlight> can cause a parse error as plantUML considers non-leading <code>'</code> orphaned.		Start '''Comments''' <syntaxhighlight lang="text" inline>'</syntaxhighlight> at the beginning of a new line. '''Avoid trailing comments''': <syntaxhighlight lang="text" inline>title Order flow ' diagram title</syntaxhighlight> can cause a parse error as plantUML considers non-leading <code>'</code> orphaned.

	'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> is the escape character; prefix a special character with it to print it literally instead of interpreting it as creole markup. <syntaxhighlight lang="text" inline>~<b>Hello World~</b></syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline><b>Hello World</b></syntaxhighlight> (not bold text); <syntaxhighlight lang="text" inline>~[[Wiki Home]]</syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline>[[Wiki Home]]</syntaxhighlight> (not a wiki link).

	In a header/footer, <syntaxhighlight lang="text" inline>%page%</syntaxhighlight> / <syntaxhighlight lang="text" inline>%lastpage%</syntaxhighlight> become page numbers once the diagram spans several pages.		In a header/footer, <syntaxhighlight lang="text" inline>%page%</syntaxhighlight> / <syntaxhighlight lang="text" inline>%lastpage%</syntaxhighlight> become page numbers once the diagram spans several pages.
Line 397:		Line 395:
	@enduml		@enduml
	</uml>		</uml>
			\|}

			'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> prints the next special character literally; unescaped, PlantUML interprets it as creole markup:

			{\| class="wikitable"
			! Source (.puml) !! Rendered
	\|-		\|-
	\|		\|
	<syntaxhighlight lang="text" copy>		<syntaxhighlight lang="text" copy>
	@startuml		@startuml
			Alice -> Bob: <b>Hello World</b>
			Alice -> Bob: ~<b>Hello World~</b>
			@enduml
			</syntaxhighlight>
			\|\|
			<uml>
			@startuml
			Alice -> Bob: <b>Hello World</b>
	Alice -> Bob: ~<b>Hello World~</b>		Alice -> Bob: ~<b>Hello World~</b>
			@enduml
			</uml>
			\|-
			\|
			<syntaxhighlight lang="text" copy>
			@startuml
			Alice -> Bob: [[Wiki Home]]
	Alice -> Bob: ~[[Wiki Home]]		Alice -> Bob: ~[[Wiki Home]]
	~~Bob --> Alice: done~~
	@enduml		@enduml
	</syntaxhighlight>		</syntaxhighlight>
Line 409:		Line 427:
	<uml>		<uml>
	@startuml		@startuml
	Alice -> Bob: ~~~<b>Hello World~</b>~~		Alice -> Bob: [[Wiki Home]]
	Alice -> Bob: ~[[Wiki Home]]		Alice -> Bob: ~[[Wiki Home]]
	~~Bob --> Alice: done~~
	@enduml		@enduml
	</uml>		</uml>

Rongzhou: /* Common syntax */

2026-08-30T02:41:29Z

Common syntax

← Older revision		Revision as of 02:41, 30 August 2026
Line 342:		Line 342:

	<blockquote>		<blockquote>
	'''Comments''' ~~— start with~~ <syntaxhighlight lang="text" inline>'</syntaxhighlight> at the beginning of a new line ~~— not <syntaxhighlight lang="text" inline>//</syntaxhighlight>, and~~ '''~~never as a~~ trailing ~~comment~~''': <syntaxhighlight lang="text" inline>title Order flow ' diagram title</syntaxhighlight> ~~prints the <syntaxhighlight lang="text" inline>' diagram title</syntaxhighlight> verbatim. Multi~~-~~line comments open with <syntaxhighlight lang="text" inline>/'</syntaxhighlight> and close with~~ <~~syntaxhighlight lang="text" inline~~>'/</~~syntaxhighlight~~>.		Start '''Comments''' <syntaxhighlight lang="text" inline>'</syntaxhighlight> at the beginning of a new line. '''Avoid trailing comments''': <syntaxhighlight lang="text" inline>title Order flow ' diagram title</syntaxhighlight> can cause a parse error as plantUML considers non-leading <code>'</code> orphaned.

	'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> is the escape character; prefix a special character with it to print it literally instead of interpreting it as creole markup. <syntaxhighlight lang="text" inline>~<b>Hello World~</b></syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline><b>Hello World</b></syntaxhighlight> (not bold text); <syntaxhighlight lang="text" inline>~[[Wiki Home]]</syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline>[[Wiki Home]]</syntaxhighlight> (not a wiki link).		'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> is the escape character; prefix a special character with it to print it literally instead of interpreting it as creole markup. <syntaxhighlight lang="text" inline>~<b>Hello World~</b></syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline><b>Hello World</b></syntaxhighlight> (not bold text); <syntaxhighlight lang="text" inline>~[[Wiki Home]]</syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline>[[Wiki Home]]</syntaxhighlight> (not a wiki link).

RonzzWikiCowriterAI: Notes: implement HTML-comment advice — add note over / note alone examples for single-line and long-text notes; fix unclosed bold in Placement blockquote (AI-assisted (RonzzWikiCowriter)) (via update-page on MediaWiki MCP Server)

2026-08-30T02:35:40Z

Notes: implement HTML-comment advice — add note over / note alone examples for single-line and long-text notes; fix unclosed bold in Placement blockquote (AI-assisted (RonzzWikiCowriter)) (via update-page on MediaWiki MCP Server)

@@ Line 445: / Line 445: @@
 @enduml
 </uml>
-<!-- add examples showing the "note over"/ alone and other special cases for single line note -->
+|-
 |}
 <blockquote>
-'''Placement''' — <syntaxhighlight lang="text" inline>left of X</syntaxhighlight>, <syntaxhighlight lang="text" inline>right of X</syntaxhighlight>, <syntaxhighlight lang="text" inline>top of X</syntaxhighlight>, <syntaxhighlight lang="text" inline>bottom of X</syntaxhighlight>, '''works in the single line format with the text after a colon''', but '''may not work with other note syntaxes in some scenarios.
+'''Placement''' — <syntaxhighlight lang="text" inline>left of X</syntaxhighlight>, <syntaxhighlight lang="text" inline>right of X</syntaxhighlight>, <syntaxhighlight lang="text" inline>top of X</syntaxhighlight>, <syntaxhighlight lang="text" inline>bottom of X</syntaxhighlight>, '''works in the single-line format with the text after a colon''', but '''may not work with other note syntaxes in some scenarios'''.
 </blockquote>
@@ Line 506: / Line 549: @@
 |-
+|
-<!-- add examples showing the "note over"/ alone and other special cases for long text -->
+<syntaxhighlight lang="text" copy>
 |}

RonzzWikiCowriterAI: Common syntax: document ~ escape character (literal HTML / double brackets), comments start on a newline (no trailing comments) (AI-assisted (RonzzWikiCowriter)) (via update-page on MediaWiki MCP Server)

2026-08-30T02:35:32Z

Common syntax: document ~ escape character (literal HTML / double brackets), comments start on a newline (no trailing comments) (AI-assisted (RonzzWikiCowriter)) (via update-page on MediaWiki MCP Server)

← Older revision		Revision as of 02:35, 30 August 2026
Line 333:		Line 333:
	comment '/		comment '/

	title Order flow ' diagram title		title Order flow
	header v1.0 ' repeated header		' diagram title
	footer page %page% of %lastpage% ' %page%/%lastpage%: page numbers		header v1.0
			' repeated header
			footer page %page% of %lastpage%
			' %page%/%lastpage%: page numbers
	</syntaxhighlight>		</syntaxhighlight>

	<blockquote>		<blockquote>
	Comments start with <syntaxhighlight lang="text" inline>'</syntaxhighlight> — not <syntaxhighlight lang="text" inline>//</syntaxhighlight>. In a header/footer, <syntaxhighlight lang="text" inline>%page%</syntaxhighlight> / <syntaxhighlight lang="text" inline>%lastpage%</syntaxhighlight> become page numbers once the diagram spans several pages.		'''Comments''' — start with <syntaxhighlight lang="text" inline>'</syntaxhighlight> at the beginning of a new line — not <syntaxhighlight lang="text" inline>//</syntaxhighlight>, and '''never as a trailing comment''': <syntaxhighlight lang="text" inline>title Order flow ' diagram title</syntaxhighlight> prints the <syntaxhighlight lang="text" inline>' diagram title</syntaxhighlight> verbatim. Multi-line comments open with <syntaxhighlight lang="text" inline>/'</syntaxhighlight> and close with <syntaxhighlight lang="text" inline>'/</syntaxhighlight>.

			'''Escaping''' — <syntaxhighlight lang="text" inline>~</syntaxhighlight> is the escape character; prefix a special character with it to print it literally instead of interpreting it as creole markup. <syntaxhighlight lang="text" inline>~<b>Hello World~</b></syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline><b>Hello World</b></syntaxhighlight> (not bold text); <syntaxhighlight lang="text" inline>~[[Wiki Home]]</syntaxhighlight> renders the literal <syntaxhighlight lang="text" inline>[[Wiki Home]]</syntaxhighlight> (not a wiki link).

			In a header/footer, <syntaxhighlight lang="text" inline>%page%</syntaxhighlight> / <syntaxhighlight lang="text" inline>%lastpage%</syntaxhighlight> become page numbers once the diagram spans several pages.
	</blockquote>		</blockquote>

Line 388:		Line 395:
	Alice -> Bob: Ship order		Alice -> Bob: Ship order
	Bob --> Alice: OK		Bob --> Alice: OK
			@enduml
			</uml>
			\|-
			\|
			<syntaxhighlight lang="text" copy>
			@startuml
			Alice -> Bob: ~<b>Hello World~</b>
			Alice -> Bob: ~[[Wiki Home]]
			Bob --> Alice: done
			@enduml
			</syntaxhighlight>
			\|\|
			<uml>
			@startuml
			Alice -> Bob: ~<b>Hello World~</b>
			Alice -> Bob: ~[[Wiki Home]]
			Bob --> Alice: done
	@enduml		@enduml
	</uml>		</uml>