Modify

Opened 3 years ago

Last modified 3 years ago

#9958 new task

Release version 2.0

Reported by: rjollos Owned by: rjollos
Priority: normal Component: PlantUmlMacro
Severity: normal Keywords:
Cc: airadier Trac Release: 0.11

Description

This ticket will be used to gather feedback and finally release version 2.0.

Attachments (1)

SystemInformation.png (29.6 KB) - added by rjollos 3 years ago.

Download all attachments as: .zip

Change History (16)

comment:1 Changed 3 years ago by rjollos

(In [11477]) Refs #9958: Set version to 2.0dev. Created a tags directory.

comment:2 Changed 3 years ago by AdrianFritz

  1. Tested all examples available at. (
    1. http://plantuml.sourceforge.net/sequence.html
    2. http://plantuml.sourceforge.net/usecase.html
    3. http://plantuml.sourceforge.net/classes.html
    4. http://plantuml.sourceforge.net/activity.html
    5. http://plantuml.sourceforge.net/component.html
    6. http://plantuml.sourceforge.net/state.html
    7. http://plantuml.sourceforge.net/objects.html
    8. The only one which dind´t work (and neither did before updating) is the "Complete example" found at http://plantuml.sourceforge.net/usecase.html
    • Environment: on Trac 0.12, Graphviz (version 2.20.2), PlantUML (version 7726), Java (64-Bit Server VM, 1.6.0_31-b04) on Linux OS (Ubuntu latest LTS)
  2. Updated PlantUmlMacro detailed install instructions and others. Please, perform a peer review.
  3. I must say: it is approved

comment:3 Changed 3 years ago by rjollos

The Complete example on the usecase page renders on my Trac install. I have Graphviz 2.28 on CentOS 5:

[~]$ yum list installed graphviz
Loaded plugins: fastestmirror
base                                                                  3591/3591
graphviz-stable                                                         195/195
jenkins                                                                 132/132
Installed Packages
graphviz.x86_64                      2.28.0-1.el5                      installed

That's not the version that ships with CentOS 5 though, I had to from the repository listed at: http://graphviz.org/Download..php

Changed 3 years ago by rjollos

comment:4 follow-up: Changed 3 years ago by rjollos

Replying to AdrianFritz:

  1. Updated PlantUmlMacro detailed install instructions and others. Please, perform a peer review.

Looks really great. Thanks for doing that. I made some minor changes, so you may want to check again and see if they look okay. I particularly like the installation validation steps.

You've given me a couple of ideas that could help with debugging an installation:

  • Add the PlantUML jar version to the logs as you've demonstrated (java -jar plantuml.jar -version).
  • Add the Java version to the logs.
  • Add the Graphviz version to the logs (not sure how to get at this yet).

Or, maybe we can display these version on the System Information section of the About page. I'm not sure how to do that, so I'll have to look into the issue.

comment:5 follow-up: Changed 3 years ago by rjollos

Also, we could take the nice documentation you've written, possibly mark it up using ReST, and add it to the repository so that the installation instructions are part of the source. coderanger did this on the IncludeMacro page: [[Include(source:includemacro/0.11/README)]].

comment:6 in reply to: ↑ 5 Changed 3 years ago by AdrianFritz

Replying to rjollos:

... add it to the repository so that the installation instructions are part of the source. ...

I think including instructions in source is viable when instructions are totally mature and don´t require anymore changes (let´s say after a "cure" period of time). Keeping instructions under wiki allows more people to contribute in less bureaucratic way. By now I´m on the idea of keeping inside wiki only.

comment:7 in reply to: ↑ 4 ; follow-ups: Changed 3 years ago by AdrianFritz

Replying to rjollos:

Replying to AdrianFritz:

... I made some minor changes, so you may want to check again and see if they look okay.

Done. Looks good. Made more cosmetic on PlantUmlMacro

  • I´m in doubt if the example for plantuml_jar = /project-resources/trac/plugins is the most usual one

Related to comment:5: I think, as a first movement we should extract and up-date current newly created hacks template.

comment:8 in reply to: ↑ 7 Changed 3 years ago by rjollos

Replying to AdrianFritz:

  • I´m in doubt if the example for plantuml_jar = /project-resources/trac/plugins is the most usual one

That doesn't seem like a likely install location. I was advised by a sysadmin that I trust, to install it to /opt/plantuml/plantuml.jar. That might be a typical Linux install location, but I wouldn't even begin to assume what might be a standard install location on Windows or any other platform.

comment:9 in reply to: ↑ 7 Changed 3 years ago by rjollos

Replying to AdrianFritz:

Done. Looks good. Made more cosmetic on PlantUmlMacro?version=10

Btw, thank you for your valuable documentation contributions here, as well as for DateFieldPlugin and CodeExampleMacro. I've previously noticed the nice work you've done around trac-hacks and appreciate it!

comment:10 Changed 3 years ago by AdrianFritz

I thank you because your work and commitment maintaining plugins and macros. That´s just my to cents to lower the entry barrier for users (and widespread Trac and Trac Hacks).

I advanced I little more on the template idea at Install (versions 5 to 8), having tested concept on TicketCreateButtonsPlugin -versions 3 to 6- and then applied to PlantUmlMacro

comment:11 Changed 3 years ago by JasonWinnebeck

I love this plugin and it works great for me, especially now with the comma fix. I use it actually mostly for graphviz diagrams rather than plantuml, though. My only thought is that the size of the diagrams are all too large, and I didn't see a way to affect the rendered size. The text in the diagram seems to be about twice the size of the text, and in wiki pages it doesn't take too much of a diagram to visually "overtake" the page.

comment:12 Changed 3 years ago by rjollos

I hadn't really thought much about it, but I suppose that GraphvizPlugin and PlantUmlMacro could probably share a large amount of codebase.

If you want to scale the entire diagram, we could probably provide options patterned after the t:WikiMacros#image-macro for controlling the image width in px or %. I was looking at this yesterday and thinking that the best solution might be to just call the ImageMacro after generating the image. I'm not sure if this is possible yet, but I'm looking into it.

comment:13 follow-up: Changed 3 years ago by JasonWinnebeck

I would say the resizing is a low priority. I just upgraded PlantUML and the diagrams are better now, for some reason a little smaller. The biggest ones are the pure graphviz ones. The graphviz plug I know about but since PlantUML can do everything graphviz dot does there's no point (I just use the @startdot/@enddot feature of PlantUML). I'm not sure I quite understand the comment about sharing codebase there...

I'm new to PlantUML, it's also possible there's a way to specify the image size in the PlantUML "language" itself...

comment:14 in reply to: ↑ 13 Changed 3 years ago by rjollos

Replying to JasonWinnebeck:

I'm not sure I quite understand the comment about sharing codebase there...

I was just saying that it might not make sense to have two plugins that do almost exactly the same thing if it was possible to support both Graphviz and PlantUML with the same plugin.

I'm new to PlantUML, it's also possible there's a way to specify the image size in the PlantUML "language" itself...

I haven't yet found that image size can be controlled, but changing the font size is on page 11 of the language reference guide.

comment:15 Changed 3 years ago by JasonWinnebeck

But it is possible. PlantUML plugin today already supports both (using @startdot feature at http://plantuml.sourceforge.net/dot.html). That's what I was trying to say, I don't know if I made that clear. I installed PlantUML so I could make graphviz plugins from Trac in addition to PlantUML.

These two are the same:

{{{
#!plantuml
@startdot
digraph G {a->b}
@enddot
}}}
{{{
#!graphviz
digraph G {a->b}
}}}

Although, looking at the wiki page, you also support URLs in graphviz as Trac links, that is pretty cool, I doubt that would work from PlantUML's graphviz. So then to support #!graphviz as well as #!plantuml in one plugin could be cool. But I wonder for now if the graphviz plugin is worthwhile enough to install in addition to PlantUML so I don't need @startdot and also in case I want to use those links...

Add Comment

Modify Ticket

Action
as new The owner will remain rjollos.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.