search

peele / plantuml-preview

Atom package.
MIT License
23 stars 13 forks source link

plantum.jar file location. #37

Open AtosNicoS opened 6 years ago

AtosNicoS commented 6 years ago

Hi, I am trying to use this atom package to render my plantuml diagram. I've placed the plantuml.jar file directly in the root of my git, where also my .pu files are currently located. The problem is that plantuml-preview does not recognize this .jar file.

If I use an absolut path, it is recognized correct: C:\git\\plantuml.jar

Am I missunderstanding something? Cant I use a relative location to the docfile itself? I plan to always ship a .jar file along with my docs, so it is simpler to regenerate them.

peele commented 6 years ago

Didn’t expect that use case. My view was the plugin configuration was own by the atom installation and not based on project/working directory.

Seems straight forward to support looking for the jar based on current uml file parent directory or maybe even project folder. Not sure how atom handles things when you use the “open project” option. This would probably still fallback to the global configured path if it fails.

Not really considering making all the plugin settings local the project.

On Fri, Apr 13, 2018 at 04:24 AtosNicoS notifications@github.com wrote:

Hi, I am trying to use this atom package to render my plantuml diagram. I've placed the plantuml.jar file directly in the root of my git, where also my .pu files are currently located. The problem is that plantuml-preview does not recognize this .jar file.

If I use an absolut path, it is recognized correct: C:\git\plantuml.jar

Am I missunderstanding something? Cant I use a relative location to the docfile itself? I plan to always ship a .jar file along with my docs, so it is simpler to regenerate them.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/peele/plantuml-preview/issues/37, or mute the thread https://github.com/notifications/unsubscribe-auth/ANCTzAH7xVKsptJRu8_Wj5JNryhakRfFks5toGDQgaJpZM4TTCvZ .

AtosNicoS commented 6 years ago

Yes I also understood how it is intendet to be used. Maybe some more text as information should be added (either to the readme or to the setting menu itself). An example path for windows(C:\Program Files\PlantUML\plantuml.jar), and an example path for linux users (/usr/bin/plantuml) where to place the .jar file/where to look at. Same for the graphviz package.

About the relativ path: Now that I understood the intended usage, I am not sure if this is a good idea to use. However a relative path to the project/git root would make most sense i guess. If you have a general layout like gitproject/doc/tools/plantuml.jar it could work.

naesean commented 5 years ago

@peele I'm confused... where is the plantuml.jar file supposed to be located? There is nothing in the documentation and I'm getting an error: plantuml-preview: plantuml.jar is not a file.

marcochin-tile commented 3 years ago

@naesean Old comment, but for future reference for others. Download the plantuml jar from here https://plantuml.com/download and then just add the path to it on your computer in the package settings.