diff --git a/README.md b/README.md index 1c74c23..a357a03 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,9 @@ PlantUML Server is a web application to generate UML diagrams on-the-fly. [PlantUML is **not** affected by the log4j vulnerability.](https://github.com/plantuml/plantuml/issues/826) -![PlantUML Server](https://raw.githubusercontent.com/plantuml/plantuml-server/master/screenshots/screenshot.png) +![PlantUML Server](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/screenshot.png) + +More examples and features about the Web UI can be found in [docs/WebUI](https://github.com/HeinrichAD/plantuml-server/tree/master/docs/WebUI). To know more about PlantUML, please visit https://plantuml.com. diff --git a/docs/WebUI/README.md b/docs/WebUI/README.md new file mode 100644 index 0000000..c65fedc --- /dev/null +++ b/docs/WebUI/README.md @@ -0,0 +1,24 @@ +# PlantUML Server Web UI + +## Alice and Bob + +![alice-bob](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/alice-bob.gif) + +## Multipaging + +Just see what you want. +And if its the second diagram page, so be it. + +![multipaging](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/multipaging.gif) + +## Split Screen + +You have multiple monitors? You want to share your Window but only show the diagram and not the code? Than do it! + +![multipaging](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/split-screen.gif) + +## More + +- [Settings](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/settings.md) +- [PlantUML Language Features](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/language-features.md) +- [Mobile Version](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/mobile.md) diff --git a/docs/WebUI/gifs/alice-bob.gif b/docs/WebUI/gifs/alice-bob.gif new file mode 100644 index 0000000..b2b7a99 Binary files /dev/null and b/docs/WebUI/gifs/alice-bob.gif differ diff --git a/docs/WebUI/gifs/auto-completion-icons.gif b/docs/WebUI/gifs/auto-completion-icons.gif new file mode 100644 index 0000000..e770323 Binary files /dev/null and b/docs/WebUI/gifs/auto-completion-icons.gif differ diff --git a/docs/WebUI/gifs/auto-completion-themes+icons.gif b/docs/WebUI/gifs/auto-completion-themes+icons.gif new file mode 100644 index 0000000..f45834b Binary files /dev/null and b/docs/WebUI/gifs/auto-completion-themes+icons.gif differ diff --git a/docs/WebUI/gifs/auto-completion-themes.gif b/docs/WebUI/gifs/auto-completion-themes.gif new file mode 100644 index 0000000..6c539c4 Binary files /dev/null and b/docs/WebUI/gifs/auto-completion-themes.gif differ diff --git a/docs/WebUI/gifs/mobile-alice-bob.gif b/docs/WebUI/gifs/mobile-alice-bob.gif new file mode 100644 index 0000000..0ec4647 Binary files /dev/null and b/docs/WebUI/gifs/mobile-alice-bob.gif differ diff --git a/docs/WebUI/gifs/mobile-settings.gif b/docs/WebUI/gifs/mobile-settings.gif new file mode 100644 index 0000000..38ff0d9 Binary files /dev/null and b/docs/WebUI/gifs/mobile-settings.gif differ diff --git a/docs/WebUI/gifs/multipaging.gif b/docs/WebUI/gifs/multipaging.gif new file mode 100644 index 0000000..a4b298c Binary files /dev/null and b/docs/WebUI/gifs/multipaging.gif differ diff --git a/docs/WebUI/gifs/settings-rendering-type.gif b/docs/WebUI/gifs/settings-rendering-type.gif new file mode 100644 index 0000000..4ce7136 Binary files /dev/null and b/docs/WebUI/gifs/settings-rendering-type.gif differ diff --git a/docs/WebUI/gifs/settings-theme.gif b/docs/WebUI/gifs/settings-theme.gif new file mode 100644 index 0000000..474fc13 Binary files /dev/null and b/docs/WebUI/gifs/settings-theme.gif differ diff --git a/docs/WebUI/gifs/split-screen.gif b/docs/WebUI/gifs/split-screen.gif new file mode 100644 index 0000000..4a84a9f Binary files /dev/null and b/docs/WebUI/gifs/split-screen.gif differ diff --git a/docs/WebUI/gifs/validation-start-end.gif b/docs/WebUI/gifs/validation-start-end.gif new file mode 100644 index 0000000..ac452cf Binary files /dev/null and b/docs/WebUI/gifs/validation-start-end.gif differ diff --git a/docs/WebUI/language-features.md b/docs/WebUI/language-features.md new file mode 100644 index 0000000..71a4879 --- /dev/null +++ b/docs/WebUI/language-features.md @@ -0,0 +1,31 @@ +# PlantUML Language Features + +## Auto Completion + +### Icons + +- type `<&` to get a list of PlantUML available icons +- see a preview of the suggested icon in its description + +![icons](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/auto-completion-icons.gif) + +### Themes + +- type `!t` to get the suggestion `theme` +- type `!theme ` to get a list of (local) available PlantUML themes. + +![themes](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/auto-completion-themes.gif) + + +## Validation + +### `@start...` and `@end...` + +- `@start...` should always be the first command +- `@end...` should alway be the last command +- `@start...` should only exists once +- `@end...` should only exists once +- `@end...` should have the same type as `@start...` + e.g.: `@startjson ... @endjson` + +![start-end](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/validation-start-end.gif) diff --git a/docs/WebUI/mobile.md b/docs/WebUI/mobile.md new file mode 100644 index 0000000..98e6496 --- /dev/null +++ b/docs/WebUI/mobile.md @@ -0,0 +1,12 @@ +# Mobile Version + +PlantUML Server is mobile ready. + +## Alice and Bob + +![alice-bob](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/mobile-alice-bob.gif) + + +## Settings + +![settings](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/mobile-settings.gif) diff --git a/docs/WebUI/settings.md b/docs/WebUI/settings.md new file mode 100644 index 0000000..f528da3 --- /dev/null +++ b/docs/WebUI/settings.md @@ -0,0 +1,15 @@ +# Settings + +## Rendering Type + +You want always to work and see only the SVG version? Not Problem. +Choose the rendering type you want to see. + +![rendering-type](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/settings-rendering-type.gif) + +## Theme + +The sun is too bright? You live on the dark side or only in the basement? +Choose between the `dark` and `light` theme. + +![theme](https://raw.githubusercontent.com/plantuml/plantuml-server/master/docs/WebUI/gifs/settings-theme.gif) diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..75bc3da Binary files /dev/null and b/docs/screenshot.png differ diff --git a/screenshots/screenshot.png b/screenshots/screenshot.png deleted file mode 100644 index 8e3f82a..0000000 Binary files a/screenshots/screenshot.png and /dev/null differ