Login | Register
My pages Projects Community openCollabNet

Discussions > users > Re: Re: [argouml-users] Diagram Descriptions in ArgoUML

argouml
Discussion topic

Back to topic list

Re: Re: [argouml-users] Diagram Descriptions in ArgoUML

Author phidias
Full name Mark Fortner
Date 2011-09-12 16:30:40 PDT
Message I have a temporary workaround that's a little hacky but does the trick. I
created a method in the DiagramUtils class that extracts comments from a
diagram. Here's how it works:

(1) You add a short comment (usually the diagram title) to the diagram.
(2) In the properties panel you set the name to "description" (or any other
relevant name). This lets me extract a specific comment from the diagram if
there are multiple comments in the diagram.
(3) In the documentation tab, you can be as verbose as you like with your
diagram description. This does not appear in the diagram.
(4) In the template you add this call
$DiagramUtils.getDi​agramDescription($d​iagram, "description") and this
extracts the diagram description.

When you generate documentation, you get a nice diagram description along
with the diagram.

Mark

On Wed, Aug 31, 2011 at 4:21 PM, Mark Fortner <phidias51 at gmail dot com> wrote:

>
> Hi Bob,
> Thanks for the info. I've created an issue for diagram descriptions:
> http://argouml.tigri​s.org/issues/show_bu​g.cgi?id=6360
>
> I looked into GEF and it seems that Diagrams have comments which could be
> used, but there's no support in ArgoDiagram for it.
>
> Regards,
>
> Mark
>
>
> On Wed, Aug 31, 2011 at 3:32 PM, Bob Tarling <bob.tarling@gmai​l.com>wrote:
>
>> There is no feature to hide stereotypes.
>>
>> Have you created an issue to add a diagram description to the PGML via
>> the diagram property panel?
>>
>> Bob
>>
>> On 31 August 2011 20:53, Mark Fortner <phidias51 at gmail dot com> wrote:
>> > There's a potential workaround for this that I've been experimenting
>> with.
>> > I added a comment to the diagram, and in the Properties panel, entered
>> the
>> > Body of the comment. This doesn't appear in the diagram, but can be
>> > extracted by ArgoPrint for documentation. I was looking for some way to
>> > distinguish these types of diagram descriptions from ordinary comments,
>> and
>> > the only way I found to do this is to create a "Diagram Description"
>> > stereotype. Unfortunately, there doesn't seem to be a way to turn off
>> > stereotype visualization for model elements. Which means that my small,
>> > discrete little hack, looks big and ugly on the diagram.
>> > Is there some other workaround for this that I'm not aware of?
>> > Mark
>> >
>> >
>> > On Fri, Aug 5, 2011 at 11:50 AM, Bob Tarling <bob dot tarling at gmail dot com>
>> wrote:
>> >>
>> >> Hi Laurant/Mark
>> >>
>> >> To be honest I really don't have time to dig into the diagram
>> >> interchange stuff for UML2 together with all the other stuff that we
>> >> need to complete for UML2 diagram presentation and modelling. That
>> >> will have to follow later. There is some doubt as to whether this
>> >> format will survive anyway so maybe we save ourselves some effort.
>> >>
>> >> For pgml vs .argo I would say to save in the pgml as this is diagram
>> >> level data rather than project level.
>> >>
>> >> Bob
>> >>
>> >> On 5 August 2011 19:21, Laurent BRAUD <bd1664 at yahoo dot fr> wrote:
>> >> > Hi,
>> >> > Bob you are true, if we do this, we need to do it first with PGML
>> rather
>> >> > than XMI.
>> >> >
>> >> > But, if some "standard" tag documentation exists (shortDescription,
>> >> > author, date, ...), use the same and show them to user even if we
>> store not
>> >> > in "standard".
>> >> > And When we will start UML DI, even if there is a long time, it will
>> be
>> >> > easier.
>> >> >
>> >> > However, I haven't find a such "standard" tag .
>> >> > So which one can we add to have usefull tool. Of course, user can
>> uses
>> >> > others.
>> >> >
>> >> > What I found:
>> >> > a) http://www.omg.org/s​pec/UMLDI/1.0/PDF/
>> >> >
>> >> > There is a class Diagram and a XSD for diagram
>> >> >
>> >> > In "8.5 Properties": Non-standard properties could be added but are
>> not
>> >> > part of any standardization. Properties provide an extension
>> >> > mechanism for adding non-standardized elements to the diagram
>> >> > interchange metamodel.
>> >> >
>> >> >
>> >> > => If I have well understand, we can add all properties we want. But
>> >> > there aren't standard. Could be a choice.
>> >> >
>> >> >
>> >> > b)I try TopCased:
>> >> > <diagrams xmi:id="_2PG_gK1HEeC​3fKGlWAkmOg" position="0,0"
>> >> > size="100,100" name="StateMachine" viewport="0,0">
>> >> > <eAnnotations xmi:id="_ssPV4L-BEeC​UNbPIxj8eBQ"
>> >> > source="http://www.topcased.​org/documentation">
>> >> > <details xmi:id="_ssUOYL-BEeC​UNbPIxj8eBQ"
>> key="documentation"
>> >> > value="HERE DIAGRAM COMMENT"/>
>> >> > </eAnnotations>
>> >> > <property xmi:id="_2PahgK1HEeC​3fKGlWAkmOg"
>> key="pageFormatName"
>> >> > value="A4"/>
>> >> > ...
>> >> > => I don't see yet where "eAnnotations" is defined in UML-DI (in
>> XSD).
>> >> >
>> >> >
>> >> > Mark, you ask for paragraph (and I agree): If we find something (in
>> >> > norm), it must be an XML element, not an attribute. So what I found
>> isn't
>> >> > enought. I keep your idea in my mind.
>> >> >
>> >> > I don't know if what you asked Bob is possible.
>> >> >
>> >> > Regards,
>> >> >
>> >> > --------------------​--------------------​--------------
>> >> >
>> >> >
>> http://argouml.tigri​s.org/ds/viewMessage​.do?dsForumId=449​&dsMessageId=280976​2
>> >> >
>> >> > To unsubscribe from this discussion, e-mail:
>> >> > [users-unsubscribe@a​rgouml.tigris.org].
>> >> >
>> >>
>> >> --------------------​--------------------​--------------
>> >>
>> >>
>> http://argouml.tigri​s.org/ds/viewMessage​.do?dsForumId=449​&dsMessageId=280976​8
>> >>
>> >> To unsubscribe from this discussion, e-mail:
>> >> [users-unsubscribe@a​rgouml.tigris.org].
>> >
>> >
>>
>> --------------------​--------------------​--------------
>>
>> http://argouml.tigri​s.org/ds/viewMessage​.do?dsForumId=449​&dsMessageId=283342​8
>>
>> To unsubscribe from this discussion, e-mail: [
>> users-unsubscribe@ar​gouml.tigris.org].
>>
>
>
Attachments

« Previous message in topic | 10 of 10 | Next message in topic »

Messages

Show all messages in topic

[argouml-users] Diagram Descriptions in ArgoUML phidias Mark Fortner 2011-08-04 11:20:47 PDT
     RE: [argouml-users] Diagram Descriptions in ArgoUML elbedd Laurent BRAUD 2011-08-05 10:27:41 PDT
         Re: [argouml-users] Diagram Descriptions in ArgoUML bobtarling Bob Tarling 2011-08-05 10:37:44 PDT
             Re: [argouml-users] Diagram Descriptions in ArgoUML phidias Mark Fortner 2011-08-05 10:56:26 PDT
                 RE: Re: [argouml-users] Diagram Descriptions in ArgoUML elbedd Laurent BRAUD 2011-08-05 11:21:37 PDT
                     Re: Re: [argouml-users] Diagram Descriptions in ArgoUML bobtarling Bob Tarling 2011-08-05 11:50:38 PDT
                         Re: Re: [argouml-users] Diagram Descriptions in ArgoUML phidias Mark Fortner 2011-08-31 12:53:51 PDT
                             Re: Re: [argouml-users] Diagram Descriptions in ArgoUML bobtarling Bob Tarling 2011-08-31 15:32:13 PDT
                                 Re: Re: [argouml-users] Diagram Descriptions in ArgoUML phidias Mark Fortner 2011-08-31 16:21:59 PDT
                                     Re: Re: [argouml-users] Diagram Descriptions in ArgoUML phidias Mark Fortner 2011-09-12 16:30:40 PDT
Messages per page: