|
1 |
| -# A Visual Paradigm plugin for PlantUML import and export |
| 1 | +# **Visual Paradigm Plugin for PlantUML Import and Export** |
2 | 2 |
|
3 |
| -## Supported Diagram Types |
| 3 | +## **Supported Diagram Types** |
4 | 4 |
|
5 |
| -The plugin currently supports conversion from/to: |
| 5 | +The plugin currently supports conversion to and from: |
6 | 6 |
|
7 | 7 | - Class Diagram
|
8 | 8 | - Use Case Diagram
|
9 | 9 | - Sequence Diagram
|
10 | 10 | - Component Diagram
|
11 | 11 | - Deployment Diagram
|
12 |
| -- State (Machine) diagram |
| 12 | +- State (Machine) Diagram |
13 | 13 | - Activity Diagram (new syntax)
|
14 | 14 |
|
15 |
| -## Installation Guide |
| 15 | +--- |
16 | 16 |
|
17 |
| -To install the plugin into Visual Paradigm: |
| 17 | +## **Installation Guide** |
18 | 18 |
|
19 |
| -- Download the `.zip` release |
20 |
| -- Launch Visual Paradigm and go to the **Help** tab |
21 |
| -- Click **Install Plugin** |
22 | 19 |
|
23 |
| -- Select **Install from a zip of plugin** and click **Next** |
24 |
| -- Choose the downloaded `.zip` folder |
25 |
| -- Restart Visual Paradigm |
| 20 | +### **Automatic Installation** |
| 21 | +1. **Download the `.zip` release** of the plugin. |
| 22 | +2. **Open Visual Paradigm** and navigate to the **Help** tab. |
| 23 | +3. Select **Install Plugin**. |
| 24 | +4. Choose **Install from a zip of plugin** and click **Next**. |
| 25 | +5. Browse to the downloaded `.zip` file and select it. |
| 26 | +6. **Restart Visual Paradigm** to complete the installation. |
26 | 27 |
|
27 |
| -Alternatively, you can manually copy the folder into the `/plugins` directory indicated by the **Install Plugin** dialog and restart the application. |
| 28 | +### **Manual Installation** |
| 29 | +1. Extract the plugin folder from the `.zip` file. |
| 30 | +2. Copy the folder into the `/plugins` directory specified by the **Install Plugin** dialog. |
| 31 | +3. **Restart Visual Paradigm**. |
| 32 | + |
| 33 | +--- |
| 34 | + |
| 35 | +## **PlantUML Plugin CLI** |
| 36 | + |
| 37 | + |
| 38 | +The CLI is packaged with the plugin and does not require a separate installation. |
| 39 | + |
| 40 | +### To allow usage: |
| 41 | +1. Locate the script file (`Plugin.bat` / `Plugin.sh`) in: |
| 42 | + ``` |
| 43 | + VP_installation_dir/scripts |
| 44 | + ``` |
| 45 | +2. Copy the file to the binaries folder: |
| 46 | + ``` |
| 47 | + VP_installation_dir/bin |
| 48 | + ``` |
| 49 | +
|
| 50 | +### **Example 1: Exporting diagrams** |
| 51 | +Export all diagrams under project: |
| 52 | +```bash |
| 53 | +Plugin.bat -project "C:/Demo/demo_project.vpp" -pluginid "plugins.plantUML" -pluginargs -action "export" -path "C:/Demo/output" -target "all" |
| 54 | +``` |
| 55 | + |
| 56 | +List all diagrams and ids and export specific target: |
| 57 | +```bash |
| 58 | +Plugin.bat -project "C:/Demo/demo_project.vpp" -pluginid "plugins.plantUML" -pluginargs -action "export" -list |
| 59 | +``` |
| 60 | + |
| 61 | +```bash |
| 62 | +Plugin.bat -project "C:/Demo/demo_project.vpp" -pluginid "plugins.plantUML" -pluginargs -action "export" -path "C:/Demo/output" -target "lAJWSCmGAqACKRNG" |
| 63 | +``` |
| 64 | + |
| 65 | +### **Example 2: Importing a folder of diagrams** |
| 66 | +```bash |
| 67 | +Plugin.bat -project "C:/Demo/demo_project.vpp" -pluginid "plugins.plantUML" -pluginargs -action "import" -path "C:/Demo/plant_diagrams" |
| 68 | +``` |
0 commit comments