From e58211229bc7ef08f5dcbb40e3973c2410fb943e Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Wed, 8 Jun 2022 12:34:25 +0200 Subject: [PATCH 1/6] upd: fix some typos and add some ref on README - Fix some typos and add some ref on README --- README.md | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index aa6ace2..375c9bf 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# PlantUML README +# VSCode-PlantUML README Rich PlantUML support for Visual Studio Code. @@ -41,7 +41,7 @@ If not, like the official , 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 @@ -61,7 +61,7 @@ If not, like the official , 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 (Ctrl+P), paste the following command, and press enter. `ext install plantuml` @@ -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). @@ -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", @@ -163,8 +163,8 @@ Preview page provides various zoom/pan actions and snap feature: - 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, alt + click to zoom out + - Ctrl + mouse scroll 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): @@ -180,7 +180,7 @@ Auto update: ![audo update demo](images/auto_update_demo.gif) -zoom & scroll: +Zoom & scroll: ![zoom demo](images/zoom_demo.gif) @@ -225,9 +225,9 @@ This plugin integrates all type diagram snippets. They are splitted into 9 secti - `ui`: snippets for salt diagrams. - `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) @@ -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 Ctrl+Shift+O 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 @@ -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 @@ -288,7 +290,7 @@ Disadvantages: - Open user setting, and configure like: -```text +```json "plantuml.server": "http://192.168.1.100:8080", "plantuml.render": "PlantUMLServer", ``` @@ -303,7 +305,7 @@ 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. ## Extension Settings @@ -347,7 +349,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" @@ -363,7 +365,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 From 4f89d8e750d90da6f21ad47629460b1ce0224595 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Wed, 8 Jun 2022 21:47:34 +0200 Subject: [PATCH 2/6] upd: fix minor typo, change font for version --- CHANGELOG.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6a6866b..591e510 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,23 +1,23 @@ -# VSCode PlantUML Changelog +# VSCode PlantUML 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 @@ -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 @@ -77,18 +77,18 @@ 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 @@ -96,8 +96,8 @@ Update embedded jar ## 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 @@ -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 From b33d7b5f530370d50baeffbae48ff8f22243b440 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Wed, 8 Jun 2022 22:27:10 +0200 Subject: [PATCH 3/6] upd: fix some typos and add Shortcut on README Update and fix some typos: - uniformity of title with changelog - num list - add `Keyboard Shortcut` - version on italic _(since vX.XXX)_ --- README.md | 43 +++++++++++++++++++++++++------------------ 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 375c9bf..5badbe8 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# VSCode-PlantUML README +# VSCode PlantUML Extension README Rich PlantUML support for Visual Studio Code. @@ -26,7 +26,7 @@ If not, like the official , the extension fal ## Features -- Preview Diagram, Press Alt + D to start PlantUML preview (option + D on MacOS). +- Preview Diagram, Press Alt + D to start PlantUML preview (Option + D on MacOS). - Auto update. - Zoom & scroll support. - Multi-Page Diagram support. @@ -41,14 +41,14 @@ If not, like the official , the extension fal - From local or server. - Image map (cmapx) support. - Editing Supports - - Format PlantUML code. ([**Deprecated**](#about-format)) + - 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`) @@ -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 + - Click to zoom in, Alt + click to zoom out - Ctrl + mouse scroll 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. @@ -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 @@ -215,15 +215,15 @@ 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 example, type `acife` (short version) to trigger following snippet (`activity➤if・else`): @@ -307,6 +307,13 @@ Translations are welcome. [lang.nls.json](https://github.com/qjebbs/vscode-plant `@startuml` / `@enduml` is still recommended, so that PlantUML code in Markdown can be managed by other function of this plugin. +## Keyboard Shortcut + +| Shortcut
(Windows / Linux) | Shortcut
(macOS) | Description | +| :--: | :--: | -- | +| Alt + D | Option + D | Start PlantUML preview | +| Ctrl+Shift+O | Cmd+Shift+O | List all diagrams in the file | + ## Extension Settings This extension contributes the following settings. From b62102ceab57e3f3a15c69b40639b9fa13e7cbc8 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Wed, 8 Jun 2022 22:44:44 +0200 Subject: [PATCH 4/6] Update README.md - fix space typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5badbe8..54cfc04 100755 --- a/README.md +++ b/README.md @@ -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" From acd35ace451eb0585def546248e09ec61a22fc87 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Thu, 9 Jun 2022 08:25:02 +0200 Subject: [PATCH 5/6] upd: fix title between CHANGELOG and README - uniformity of title between CHANGELOG and README --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 591e510..06d0868 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# VSCode PlantUML Extension Changelog +# PlantUML VSCode Extension Changelog ## 2.17.2 From d27b678836cb90a884fb268e99cd122b71085783 Mon Sep 17 00:00:00 2001 From: The-Lum <86879521+The-Lum@users.noreply.github.com> Date: Thu, 9 Jun 2022 08:26:44 +0200 Subject: [PATCH 6/6] upd: fix title between CHANGELOG and README - uniformity of title between README and CHANGELOG --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 54cfc04..ad03cbc 100755 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# VSCode PlantUML Extension README +# PlantUML VSCode Extension Readme Rich PlantUML support for Visual Studio Code.