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.

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

[FEATURE] PlantUML Processing - Parameter Support #31

Open
SieDa opened this issue Sep 15, 2024 · 3 comments
Open

[FEATURE] PlantUML Processing - Parameter Support #31

SieDa opened this issue Sep 15, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@SieDa
Copy link

SieDa commented Sep 15, 2024

Description
Instead of only providing a [Refresh]-Button it would be nice to influence the processing similar to some PlantUML Command Line features.

  1. Run Simple Instructions directly without entering this code.
@startuml
instruction
@enduml

That can be achieved in the command line by calling:

java -jar plantuml.jar -instruction

So open a Pull Down Area that shows further buttons in the Preview Pane:
[Author], [Version], [Stdlib]

  1. Run more complex instructions without needing to go to the command line.
    Add addition Buttons, that use the PlantUML command line to provide
    [Help], [Language], [Printfonts]

  2. Process the the source code similar to using the commandline

  • Provide a Button [Process] besides [Refresh]
  • In the drop down area described before, provide a list of PlantUML Command Line parameters to select and may be enable to choose or enter a value (setting the standard parameters for Processing)
  • Show the resulting Command line to copy paste it to Git Bash or any other shell.

Stepwise you can support -nometadata, -charset, ... all that make sense for a single source file.

With different preview styles you can do this for
-teps, -teps:text, -thtml, -tlatex, -tlatex:nopreamble, -tpdf, -tpng, -tscxml, -tsvg, -ttxt, -tutxt, -tvdx, -txmi, ...

Solution
On Processing - different to Refresh - the PlantUML Processing ist used to deliver a result into the output area.
[View Code] might be an option to provide a button to show the source code of some of those (svg, txt, latex, ...) in notepad, if that makes sense.

@SieDa SieDa added the enhancement New feature or request label Sep 15, 2024
@Fruchtzwerg94
Copy link
Owner

Fruchtzwerg94 commented Sep 16, 2024

Hi @SieDa ,

note that PlantUmlViewer aims to be a simple GUI integration to preview diagrams. It shall not be some kind of code or command generator.
What exactly is your use case behind this request? What is the reason not just to use the CLI directy for advanced usage like this? I don't see how this could improve the PlantUmlViewer plugin.

BR, Philipp

@SieDa
Copy link
Author

SieDa commented Sep 16, 2024

Hi Philipp, well done so far.

There are three major reasons in case you only have N++ to edit the code, then

  1. it provides to preview directly the SVG to be readable in any scaling.
  2. it provides to directly produce the same result as if the command line is used, just to avoid switching between n++ edit, shell process and browser preview (or what ever is needed).
  3. it provides faster access to CLI Informations in the "simple GUI".

Does that make sense to you?
Best regards
SieDa

@Fruchtzwerg94
Copy link
Owner

Hi @SieDa ,

I don't see which parameters / arguments you want so set in a specific way and read out here. PlantUML is called straight forward without any specific arguments. The only thing difference to a standard call is using pipes and splitting the diagram pages into several generation steps. This means there are potentially multiple commands to be executed.
Maybe nppexec is what you are looking for here? Using the plugin you can call PlantUML directly to generate and open the SVG.

BR,
Philipp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants