Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

upd: fix some typos and add some ref on README #492

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

upd: fix some typos and add some ref on README #492

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e582112
upd: fix some typos and add some ref on README
The-Lum Jun 8, 2022
4f89d8e
upd: fix minor typo, change font for version
The-Lum Jun 8, 2022
b33d7b5
upd: fix some typos and add Shortcut on README
The-Lum Jun 8, 2022
b62102c
Update README.md
The-Lum Jun 8, 2022
acd35ac
upd: fix title between CHANGELOG and README
The-Lum Jun 9, 2022
d27b678
upd: fix title between CHANGELOG and README
The-Lum Jun 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# VSCode PlantUML Changelog
# PlantUML VSCode Extension Changelog

## 2.17.2

- Not fallback to get if post was at least once successful, **@z77ma**, [#470](https://github.com/qjebbs/vscode-plantuml/pull/470)
- Update translations, [#467](https://github.com/qjebbs/vscode-plantuml/pull/467)
- Update embedded jar to 1.2022.0
- Update embedded jar to `1.2022.0`

## 2.17.0

- Add ability to copy image in preview, [#462](https://github.com/qjebbs/vscode-plantuml/pull/462)
- Update syntax highlighting, [#457](https://github.com/qjebbs/vscode-plantuml/pull/457)
- Update embedded jar to 1.2021.16
- Update embedded jar to `1.2021.16`

## 2.16.1

- Add setting `plantuml.lintDiagramNoName`
- Fix plantuml fence detect ([#455](https://github.com/qjebbs/vscode-plantuml/issues/455))
- Update syntax highlighting ([#454](https://github.com/qjebbs/vscode-plantuml/pull/454))
- Update embedded jar to 1.2021.14
- Update embedded jar to `1.2021.14`

## 2.16.0

Expand All @@ -30,7 +30,7 @@
## 2.15.1

- Fix: Error in console while typing include ([#412](https://github.com/qjebbs/vscode-plantuml/issues/412))
- Update embedded jar to 1.2021.7
- Update embedded jar to `1.2021.7`

## 2.15.0

Expand Down Expand Up @@ -77,27 +77,27 @@ Update embedded jar

## 2.13.13

- Improvement: Imporve syntax highlighting in dark theme for messages of note, header, legend, footer.[#285](https://github.com/qjebbs/vscode-plantuml/pull/285)
- Improvement: Change language id to plantuml.[#306](https://github.com/qjebbs/vscode-plantuml/pull/306)
- Improvement: Imporve syntax highlighting in dark theme for messages of note, header, legend, footer. [#285](https://github.com/qjebbs/vscode-plantuml/pull/285)
- Improvement: Change language id to plantuml. [#306](https://github.com/qjebbs/vscode-plantuml/pull/306)
- Fix: Preview should not be scrollable when load

## 2.13.12

- Improvement: Adopt 'asWebviewUri' API,[#319](https://github.com/qjebbs/vscode-plantuml/pull/319)
- Improvement: Update extensionKind,[#304](https://github.com/qjebbs/vscode-plantuml/pull/304)
- Improvement: Adopt 'asWebviewUri' API, [#319](https://github.com/qjebbs/vscode-plantuml/pull/319)
- Improvement: Update extensionKind, [#304](https://github.com/qjebbs/vscode-plantuml/pull/304)

## 2.13.11

- Update embedded jar to 1.2020.10
- Update embedded jar to `1.2020.10`

## 2.13.10

- Bug fixes

## 2.13.9

- Fix: the include preprocessor creating nested diagrams,[#314](https://github.com/qjebbs/vscode-plantuml/pull/314)
- Improvement: Fall back to GET optimize,[#300](https://github.com/qjebbs/vscode-plantuml/pull/300)
- Fix: the include preprocessor creating nested diagrams, [#314](https://github.com/qjebbs/vscode-plantuml/pull/314)
- Improvement: Fall back to GET optimize, [#300](https://github.com/qjebbs/vscode-plantuml/pull/300)

## 2.13.8

Expand All @@ -112,7 +112,7 @@ Update embedded jar
## 2.13.6

- Improvement: Add `extensionKind`, better remote dev support, [#282](https://github.com/qjebbs/vscode-plantuml/pull/282)
- Improvement: Support syntax highlighting of class diagram functions and fields which contains more than `ascii` character, [#279](https://github.com/qjebbs/vscode-plantuml/pull/279)
- Improvement: Support syntax highlighting of class diagram functions and fields which contains more than `ASCII` character, [#279](https://github.com/qjebbs/vscode-plantuml/pull/279)

## 2.13.5

Expand Down
83 changes: 46 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PlantUML README
# PlantUML VSCode Extension Readme

Rich PlantUML support for Visual Studio Code.

Expand Down Expand Up @@ -26,7 +26,7 @@ If not, like the official <https://www.plantuml.com/plantuml>, the extension fal

## Features

- Preview Diagram, Press <kbd>Alt</kbd> + <kbd>D</kbd> to start PlantUML preview (<kbd>option</kbd> + <kbd>D</kbd> on MacOS).
- Preview Diagram, Press <kbd>Alt</kbd> + <kbd>D</kbd> to start PlantUML preview (<kbd>Option</kbd> + <kbd>D</kbd> on MacOS).
- Auto update.
- Zoom & scroll support.
- Multi-Page Diagram support.
Expand All @@ -41,14 +41,14 @@ If not, like the official <https://www.plantuml.com/plantuml>, the extension fal
- From local or server.
- Image map (cmapx) support.
- Editing Supports
- Format PlantUML code. (**Deprecated**)
- Format PlantUML code ([**Deprecated**](#about-format)).
- All type syntax highlight.
- All type snippets.
- Basic auto completion & macro signature support
- Symbol List support.
- Others
- Multi-root Workspace Support.
- MarkDown integrating support. [View Demo](#markdown-integrating)
- MarkDown integrating support ([View Demo](#markdown-integrating)).
- Extracting source from images support.

> Notice: If you use customize `plantuml.jar`, please update to the latest version to enable `Multi-Page Diagram support`. (Later than `V1.2017.15`)
Expand All @@ -61,7 +61,7 @@ If not, like the official <https://www.plantuml.com/plantuml>, the extension fal

## How to install

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Launch VS Code Quick Open (<kbd>Ctrl</kbd>+<kbd>P</kbd>), paste the following command, and press enter.

`ext install plantuml`

Expand All @@ -77,8 +77,8 @@ A plantuml server. See [Use PlantUML Server as render](#use-plantuml-server-as-

It's necessary to have following installed:

- [Java][Java] : Platform for PlantUML running.
- [Graphviz][Graphviz] : PlantUML requires it to calculate positions in diagram.
- [Java][Java]: Platform for PlantUML running.
- [Graphviz][Graphviz]: PlantUML requires it to calculate positions in diagram.

[Java]: http://java.com/en/download/ "Download Java"
[Graphviz]: http://www.graphviz.org/download/ "Download Graphviz"
Expand All @@ -92,7 +92,7 @@ brew install graphviz

#### Quick Install for Windows

The plugin has an integrated copy of plantuml.jar and GraphViz, so you are normally good to go.
The plugin has an integrated copy of `plantuml.jar` and GraphViz, so you are normally good to go.
But if you want to use your own jar or a different version of GraphViz (maybe a newer version, or with many dependent jars):

- download the latest `plantuml.jar` or install it using chocolatey (see below).
Expand All @@ -114,7 +114,7 @@ choco install plantuml
## Typical Files Organization

- Default extension settings works for independent Plantuml projects.
- If Plantuml files are only part of your project (as documetation), use `plantuml.diagramsRoot` and `plantuml.exportOutDir` to setting up the organization, for example:
- If Plantuml files are only part of your project (as documentation), use `plantuml.diagramsRoot` and `plantuml.exportOutDir` to setting up the organization, for example:

```json
"plantuml.diagramsRoot": "docs/diagrams/src",
Expand Down Expand Up @@ -160,18 +160,18 @@ To new projects, it's recommended not to rely on `diagramsRoot` and configure al

Preview page provides various zoom/pan actions and snap feature:

- Zoom operations (since version 2.7.0):
- Zoom operations _(since version 2.7.0)_:
- Zoom to select area
- Pinch to zoom (TouchPad)
- Click to zoom in, alt + click to zoom out
- Ctrl + mouse scroll to zoom in/out
- Click to zoom in, <kbd>Alt</kbd> + <kbd>click</kbd> to zoom out
- <kbd>Ctrl</kbd> + <kbd>mouse scroll</kbd> to zoom in/out
- Middle mouse button click to toggle zoom
- Zoom in / zoom out / toggle buttons of the controls bar.
- Pan operations (since version 2.7.0):
- Pan operations _(since version 2.7.0)_:
- Right mouse button drag
- Two-finger move to pan (TouchPad)
- Mouse scroll
- Snap to border (since v2.8.0):
- Snap to border _(since v2.8.0)_:
- Scroll to most bottom/right/top/left, preview will snap to that border.
> e.g. Snap to Bottom is useful while writing long activity diagrams, which helps you keep focus in the latest part in the bottom.

Expand All @@ -180,7 +180,7 @@ Auto update:

![audo update demo](images/auto_update_demo.gif)

zoom & scroll:
Zoom & scroll:

![zoom demo](images/zoom_demo.gif)

Expand All @@ -206,7 +206,7 @@ Export diagram:

![format demo](images/format_demo.gif "demo")

> PlantUML formatter is disabled (since v2.8.3) if `editor.formatOnSave` is on.
> PlantUML formatter is disabled _(since v2.8.3)_ if `editor.formatOnSave` is on.
Because the formatter is not reliable enough according to user feedbacks.

## About Snippets
Expand All @@ -215,19 +215,19 @@ Because the formatter is not reliable enough according to user feedbacks.

This plugin integrates all type diagram snippets. They are splitted into 9 sections:

- `diagram`: snippets for general diagrams elements.
- `activity`: snippets for activity diagrams.
- `class`: snippets for class diagrams.
- `component`: snippets for component diagrams.
- `state`: snippets for state diagrams.
- `usecase`: snippets for usecase diagrams.
- `sequence`: snippets for sequence diagrams.
- `ui`: snippets for salt diagrams.
- `egg`: snippets for some funny diagrams, like sudoku, earth.
1. `diagram`: snippets for general diagrams elements.
1. `activity`: snippets for activity diagrams.
1. `class`: snippets for class diagrams.
1. `component`: snippets for component diagrams.
1. `state`: snippets for state diagrams.
1. `usecase`: snippets for usecase diagrams.
1. `sequence`: snippets for sequence diagrams.
1. `ui`: snippets for salt diagrams.
1. `egg`: snippets for some funny diagrams, like sudoku, earth.

For exsample, type `acife` (short version) to trigge following snippet (`activity➤if・else`):
For example, type `acife` (short version) to trigger following snippet (`activity➤if・else`):

```plantumlcode
```plantuml
if (cond1?) then (val1)

else (val2)
Expand All @@ -239,11 +239,13 @@ endif

![list_symbol_demo.png](images/list_symbol_demo.png)

Press `Ctrl+Shift+O` to list all diagrams in the file. You can name the diagram when diagram starts.
Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>O</kbd> to list all diagrams in the file. You can name the diagram when diagram starts.

> @startuml diagram name
> sudoku
> @enduml
```plantuml
@startuml diagram name
sudoku
@enduml
```

## About Render

Expand All @@ -252,8 +254,8 @@ Plugin supports two renders: `Local` and `PlantUMLServer`.
Local is the default and traditional way. If you care more about export speed, you should try PlantUMLServer.

```text
Local: 6 documents, 9 digrams, 14 files exported in 24.149 seconds
PlantUMLServer: 6 documents, 9 digrams, 14 files exported in 1.564 seconds
Local: 6 documents, 9 diagrams, 14 files exported in 24.149 seconds
PlantUMLServer: 6 documents, 9 diagrams, 14 files exported in 1.564 seconds
```

## Advantages and Disadvantages of PlantUMLServer Render
Expand Down Expand Up @@ -288,7 +290,7 @@ Disadvantages:

- Open user setting, and configure like:

```text
```json
"plantuml.server": "http://192.168.1.100:8080",
"plantuml.render": "PlantUMLServer",
```
Expand All @@ -303,7 +305,14 @@ Translations are welcome. [lang.nls.json](https://github.com/qjebbs/vscode-plant

![markdown demo](images/markdown_demo.png)

`@startuml / @enduml` is still recommended, so that PlantUML code in Markdown can be managed by other function of this plugin.
`@startuml` / `@enduml` is still recommended, so that PlantUML code in Markdown can be managed by other function of this plugin.

## Keyboard Shortcut

| Shortcut<br />(Windows / Linux) | Shortcut<br />(macOS) | Description |
| :--: | :--: | -- |
| <kbd>Alt</kbd> + <kbd>D</kbd> | <kbd>Option</kbd> + <kbd>D</kbd> | Start PlantUML preview |
| <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>O</kbd> | <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>O</kbd> | List all diagrams in the file |

## Extension Settings

Expand Down Expand Up @@ -347,7 +356,7 @@ Other Settings:

## Known Issues

Please post and view issues on [GitHub][issues]
Please post and view issues on [GitHub][issues].

[issues]: https://github.com/qjebbs/vscode-plantuml/issues "Post issues"

Expand All @@ -363,7 +372,7 @@ Please post and view issues on [GitHub][issues]
- Japanese: [Kohei Arao](https://github.com/koara-local), [kannkyo](https://github.com/kannkyo)
- Tranditional Chinese: [Alan Tsai](https://github.com/alantsai)
- German: [Fabian F.](https://github.com/fur6y)
- French: [Zepmanbc](https://github.com/Zepmanbc), [FlorianKempenich](https://github.com/FlorianKempenich)
- French: [Zepmanbc](https://github.com/Zepmanbc), [FlorianKempenich](https://github.com/FlorianKempenich), [The-Lum](https://github.com/The-Lum)
- Danish: [Mikkel O. Laursen](https://github.com/mikkel-ol)

## Donators
Expand Down