Plantuml Cheat Sheet
- Plantuml Cheat Sheet 2020
- Plantuml Cheat Sheets
- Plantuml Sequence Diagram Cheat Sheet
- Plantuml Foreach
- Plantuml Cheat Sheet Pdf
PlantUML cheatsheet. The one-page guide to PlantUML: usage, examples, links, snippets, and more. This is Cheatsheets - W3cubDocs— a collection of cheatsheets.
Every reST (.rst) file should use these underlining styles. In reST, you can use differentstyles in any order you want. These are our conventions for TYPO3 documentation.
- PlantUML; Overview. Drawing the Unified Modeling Language of Rack. Browse the documentation. Add this line to your application’s Gemfile: gem 'drawuml' And then execute: $ bundle Usage. Add this line to your config/routes.rb: mount DrawUml::Engine, at: '/rails/draw/uml' Draw by selecting the model: Use. PlantUML; PlantUML Cheat.
- Usage Command Palette. Open the Markdown file; Press F1 or Ctrl+Shift+P; Type export and select below. Markdown-pdf: Export (settings.json) markdown-pdf: Export (pdf) markdown-pdf: Export (html).
line 1-3: This is the doc title. Every .rst file should have one.
line 7: header label. This can be used for cross-referencing to this section:
9-10: Header level 1
etc.
See also
External links¶
method 1:
(with one or two underscores at the end, if in doubt, use two)
method 2: “External Hyperlink Targets”:
This may be more convenient if you use a link several times.
Cross references¶
When linking within docs.typo3.org, you should use this method of cross-referencing.
Use it to link to a section in this manual:
A section with the label intersphinx must exist! It is placed before the header:
Or, when cross-referencing to other manuals:
When you are linking to another manual, make sure theshortcut (here: “h2document”) is included in Settings.cfg:
We use the same conventions for naming the shortcuts in Settings.cfg
,see Settings.cfg. Not used manuals are commented out.
Tip
This is a cool feature, where reST & Sphinx shines: Even when a section ismoved to another page (which effectively changes the URL), the link will still work!
Link to: Same manual | Link to: Other manual | |
---|---|---|
Explicit anchor text | :ref:`CrossReferencing<intersphinx>` | :ref:`CrossReferencing<t3docwrite:intersphinx>` |
Automatic anchor text | :ref:`intersphinx` | :ref:`t3docwrite:intersphinx` |
See also
- Link targets (labels)
To create a bullet list:

- add a blank line before and after the list
- indent the list item text by 3 spaces - including the item sign
- to create a nested list:
- indent the items by 3 spaces (left-align with parent item text)
- apply rules of parent list (blank lines, item text indentation, ..)
More text.
To create a numbered list:
- add a blank line before and after the list
- indent the list item text by 3 spaces - including the item sign
- to create a nested list:
- indent the items by 3 spaces (left-align with parent item text)
- apply rules of parent list (blank lines, item text indentation, ..)
More text.
Important
Use syntactically correct code in your code blocks.
Code block directive¶
How it looks:
Source:
This uses the directive “code-block” (line 1)
Important
Make sure to indent correctly. The lines of the code-block (line 3+)must be indented (3 spaces).
Literal Block (::
)¶
Or, use the literal block markup ::
if PHP is already set as defaultwith highlight
directive and you want to combine a text with a colon,followed by the code block.
How it looks:
Assign the variable a:
Source:
For inline code or for other semantic markup of special texts, use text roles.
Examples:
$result=$a+23;
(PHP snippet)lib.hello.value=HelloWorld!
(TypoScript snippets)/etc/passwd
(file)- ctrl + s (keyboard strokes)
Source (inline text with text roles):
Normal text, bold text and italic text.
Source (bold & italic):
Source (image):
Another example:
See also
Source (YouTube):
This is often used, for a Quick Start section, involving a few numbered steps:
With Big Numbers¶
This is an example with a code block (::
) embedded in the sections.
Source:
How it looks:
Embed an image
Source:
Two
Do something else …
With Big Numbers XXL¶
Source:
Plantuml Cheat Sheet 2020
How it looks:
Embed an image
Source:
Two
Do something else …
Plantuml Cheat Sheets
Tips, hints, important (Admonitions)¶
Tip
Plantuml Sequence Diagram Cheat Sheet
To look at the reST source of this rendered page, scroll to the bottomand click on “View page source”.
- Source (tip):
Diagrams¶
Plantuml Foreach
Source:
Plantuml Cheat Sheet Pdf
How it looks:
