<![CDATA[Latest posts for the topic "Creating documentation in XSD's"]]> http://forums.visual-paradigm.com/posts/50.html JForum - http://www.jforum.net Creating documentation in XSD's
I am trying to put an if/then switch in for a document block. I currently have some code:

$indenter.getIndentation()
$indenter.getIndentation()
$class.t_getDocumentation($indenter.getIndentation())
$indenter.getIndentation()

which generates a nice documentation block in one of my schema.

What I would like to know is the following:

1) How can I test for the presence of documentation?

If documentation <>""
....write document block...
end

2) In the $class.t_getDocumentation($indenter.getIndentation()) call is it ossible to remove the CDATA code that is automatically added?]]> http://forums.visual-paradigm.com/posts/2328#18573.html http://forums.visual-paradigm.com/posts/2328#18573.html Re:Creating documentation in XSD's
I will consult our engineers and then come back to you. By the way, have you tried the early access I sent you with regards to the modeling and generation of XSD?

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18577.html http://forums.visual-paradigm.com/posts/2328#18577.html Creating documentation in XSD's
Its working perfectly! because of how your engineers have implemented it as a feature I can add any restriction I like from strings to integers.

I have added a couple of default params to make it a bit easier so anything that is stereotyped as xsdSimpleType automatically has a base and restriction added. The only thing missing (and no, I dont expect you to add it) would be to allow inheritance - a superclass with string and a subclass with length=10 or something similar.....

The reason for the code request above is so that I can publish the modified instant generator code for others to use in the future.

Please pass on my thanks to your dev's for a fine piece of work!]]> http://forums.visual-paradigm.com/posts/2328#18586.html http://forums.visual-paradigm.com/posts/2328#18586.html Re:Creating documentation in XSD's
With regard to your two questions...

1) We have made a fix (See below for the URL of fix). You can check $utilities.getOriginalDocumentation($THE_OBJECT, $args.get("property"))

For example:
#set( $originalDocumentation = $utilities.getOriginalDocumentation($THE_OBJECT, $args.get("property")) )
#if ( $originalDocumentation && $originalDocumentation != "" )
...
#end

2) It is not possible to remove CDATA from t_getDocumentation()
but you can get the original documentation by $utilities.getOriginalDocumentation($THE_OBJECT, $args.get("property"))

Here is the URL for the fix of the first template problem:
http://files3.visual-paradigm.com/200707/Patch/sp2_20070712u/VP_Suite_Windows_3_0_sp2_20070712u.exe

Please download this and install by overwriting the current installation. Notice that this is a patch for the current release. If you want a patch for the early access release I sent you earlier, please let me know and we will arrange it for you.

Best regards,
Jick


]]> http://forums.visual-paradigm.com/posts/2328#18598.html http://forums.visual-paradigm.com/posts/2328#18598.html Creating documentation in XSD's
BTW - you do realize that its Saturday!]]> http://forums.visual-paradigm.com/posts/2328#18600.html http://forums.visual-paradigm.com/posts/2328#18600.html Re:Creating documentation in XSD's
Yes, I do aware ;-)

Oh, I just didn't aware that you use the Mac version. Please wait...

Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18601.html http://forums.visual-paradigm.com/posts/2328#18601.html Re:Creating documentation in XSD's
Here is the Mac version:
http://files3.visual-paradigm.com/200707/Patch/sp2_20070712u/VP_Suite_MacOSX_3_0_sp2_20070712u.dmg

Enjoy! Feel free to let me know if there are any questions.

Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18602.html http://forums.visual-paradigm.com/posts/2328#18602.html Re:Creating documentation in XSD's
With regard to the comment you posted earlier:
The only thing missing (and no, I dont expect you to add it) would be to allow inheritance - a superclass with string and a subclass with length=10 or something similar.....
 


Do you mean the ability to model the following in class diagram?

Code: 
<xsd:simpleType name="foo">
        <xsd:restriction base="xsd:string">
        </xsd:restriction>
 </xsd:simpleType>
 <xsd:simpleType name="bar">
        <xsd:restriction base="foo">
          <xsd:length value="2"/>
        </xsd:restriction>
 </xsd:simpleType>


Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18606.html http://forums.visual-paradigm.com/posts/2328#18606.html Creating documentation in XSD's
I do have a problem with the other fix for documentation. I have the following as code:

$indenter.getIndentation()
$indenter.push($indentation)##
$indenter.getIndentation()
$indenter.getIndentation()
$utilities.getOriginalDocumentation($class, $args.get("property"))
$indenter.getIndentation()
$indenter.getIndentation()
$indenter.push($indentation)##

and I get an output which looks like:



$utilities.getOriginalDocumentation($class, $args.get("property"))


Can you highlight what I am doing wrong please?]]> http://forums.visual-paradigm.com/posts/2328#18612.html http://forums.visual-paradigm.com/posts/2328#18612.html Re:Creating documentation in XSD's
The information is not enough for us to identify the problem. Could you send us your log file? You can find it under the bin folder of VP Suite. I would be grateful if you can send me your project as well. If you can't post here, you can send to my Email address directly:
jick@visual-paradigm.com

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18614.html http://forums.visual-paradigm.com/posts/2328#18614.html Re:Creating documentation in XSD's
I have included a zip file with the vp.log, the project and the modified XSD
generator files.

Sorry for the basic mail but my email server is under a bit of water at the
moment; for some reason the British summer seems to be a little on the wet
side so I am having to send this via my mobile phone.

One thing that I have noticed is there are two versions of VP - 20070716a (to
allow for schema types and restrictions) and 20070712u (to fix the
documentation). Not sure if it makes a difference....

Thanks again for such fantastic support over this; trust me when I say that I
have never had this level of support from a commercial company in 15 years of
IT!

Regards

T]]> http://forums.visual-paradigm.com/posts/2328#18615.html http://forums.visual-paradigm.com/posts/2328#18615.html Creating documentation in XSD's http://forums.visual-paradigm.com/posts/2328#18616.html http://forums.visual-paradigm.com/posts/2328#18616.html Re:Creating documentation in XSD's
Have you run in both 20070716a and 20070712u? Both failed?

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18620.html http://forums.visual-paradigm.com/posts/2328#18620.html Creating documentation in XSD's
Let me know if you want me to run any more tests]]> http://forums.visual-paradigm.com/posts/2328#18622.html http://forums.visual-paradigm.com/posts/2328#18622.html Re:Creating documentation in XSD's
20070712u should include the bug fix required for making it works. We suspect that you have overwritten $utilities, $class or $args.

To test if $utilities is overwritten or not, print $utilities in the .vm to see the result. It should display something like vp.com.instantgenerator.xsd.XsdUtilities@...

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18638.html http://forums.visual-paradigm.com/posts/2328#18638.html Creating documentation in XSD's
I have added $utilities to package.vm and it generates the following output: com.vp.instantgenerator.xsd.XsdUtilities@dd90c3

Hope this helps

T]]> http://forums.visual-paradigm.com/posts/2328#18700.html http://forums.visual-paradigm.com/posts/2328#18700.html Re:Creating documentation in XSD's
It seems that the only possible reason is you have overwritten $class. E.g.:

#set( $class = "" )
$utilities.getOriginalDocumentation($class, $args.get("property"))

To test if $utilities is overwritten or not, print $class in the .vm to see the result. It should be something like com.vp.instantgenerator.xsd.XsdClass@...

Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18712.html http://forums.visual-paradigm.com/posts/2328#18712.html Creating documentation in XSD's
I will load up 12 into a test platform and try it later on.....]]> http://forums.visual-paradigm.com/posts/2328#18720.html http://forums.visual-paradigm.com/posts/2328#18720.html Creating documentation in XSD's http://forums.visual-paradigm.com/posts/2328#18734.html http://forums.visual-paradigm.com/posts/2328#18734.html Re:Creating documentation in XSD's
Can I say that 20070716a works well, while 20070712u doesn't? If yes, please try this release:
http://files3.visual-paradigm.com/200708/Patch/sp2_20070724c/VP_Suite_Windows_3_0_sp2_20070724c.exe

This is a newer version of patch.

Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18735.html http://forums.visual-paradigm.com/posts/2328#18735.html Re:Creating documentation in XSD's
The new VM files work rather well, I have added my alternate documentation code and it works with no problem (as long as I remember to replace $class with $attribute in the right place ;-)



xs:restriction@base must come before any restriction. there is an implicit sort order in the Tagged Values (the top one is processed first, then the 2nd etc)

The namespace "xs:" is automatically added to any value (in the early access I had to have a value of "xs:string" which now gives "xs:xs:string". Whilst not a problem for the data types it means that any maxLength or other value for xs:restriction/xs:maxLength@value gives "xs:3" which is a big problem!

I have looked through the VM code and it is not being generated from XsdXmlNode.vm so it must be part of the $node library.


Hope this makes sense....]]> http://forums.visual-paradigm.com/posts/2328#18754.html http://forums.visual-paradigm.com/posts/2328#18754.html Re:Creating documentation in XSD's http://forums.visual-paradigm.com/posts/2328#18759.html http://forums.visual-paradigm.com/posts/2328#18759.html Re:Creating documentation in XSD's
The problem of appending "xs" incorrectly has been fixed. Please download the patch at:
http://files3.visual-paradigm.com/200708/Patch/6-1-0_20070801u/VP_Suite_Windows_3_1_20070801u.exe

Enjoy!

Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18789.html http://forums.visual-paradigm.com/posts/2328#18789.html Creating documentation in XSD's http://forums.visual-paradigm.com/posts/2328#18790.html http://forums.visual-paradigm.com/posts/2328#18790.html Re:Creating documentation in XSD's
Sure. Here is the download link of the Mac version:
http://files3.visual-paradigm.com/200708/Patch/6-1-0_20070801y/VP_Suite_MacOSX_3_1_20070801y.dmg

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18798.html http://forums.visual-paradigm.com/posts/2328#18798.html Re:Creating documentation in XSD's
One more for your engineers:

When I have a class with a one way association to another (only one Navigatable=true statement in the role) I cannot get any documentation. If I use the normal $attribute.t_getDocumentation($indenter.getIndentation()) statement then I can get it but with the CDATA section but if I use $utilities.getOriginalDocumentation($OBJECTNAME, $args.get("property")) then it does not return anything.

Having looked at the other examples for other languages I have tried association, assoicationEnd but there is a reference to $class.toAssociationIterator() which I am not sure how it works...

Am I sort of on the right track or have I just confused you? ;-)

First diagram is a simple class model, the second file is the VP xsd routine the third is mine using $utilities.

I will post up my vm file in the next post

]]> http://forums.visual-paradigm.com/posts/2328#18803.html http://forums.visual-paradigm.com/posts/2328#18803.html Re:Creating documentation in XSD's http://forums.visual-paradigm.com/posts/2328#18804.html http://forums.visual-paradigm.com/posts/2328#18804.html Re:Creating documentation in XSD's
I will talk to our engineers about this problem. Thank you.

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18805.html http://forums.visual-paradigm.com/posts/2328#18805.html Re:Creating documentation in XSD's
The problem has been fixed. Please try, and let me know if it works. Thank you. Here is the patch:
http://files3.visual-paradigm.com/200708/Patch/6-1-0_20070812a/VP_Suite_MacOSX_3_1_20070812a.dmg

Best regards,
Jick]]> http://forums.visual-paradigm.com/posts/2328#18851.html http://forums.visual-paradigm.com/posts/2328#18851.html Creating documentation in XSD's
The next topic to play with is packages so expect some feedback in the coming days.

Another good result. I'll let you know if I run into any problems.

I am off to a new project in September and will try to persuade them to adopt my tool of choice rather than the normal Visio or Rose.....

]]> http://forums.visual-paradigm.com/posts/2328#18861.html http://forums.visual-paradigm.com/posts/2328#18861.html Re:Creating documentation in XSD's
I couldn't find out our conversation that discusses the request of in line. Could you direct me to the appropriate post? Sorry for any inconveniences it may cause you.

Have you been sending us suggestion/feature request about handling package? As I remember, there isn't any discussion related to package support. Perhaps I missed again?

Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#18864.html http://forums.visual-paradigm.com/posts/2328#18864.html Creating documentation in XSD's
The documentation thing was the Role description being used in the XSD generation; this seems to be implemented in the current VM set for XSD and from the look of it the files I am using are VP files rather than my own. Either way, it generates exactly what I would expect!

Currently I have nothing outstanding with you other than my gratitude for the work that you and your engineers have put in to solve my problems.]]> http://forums.visual-paradigm.com/posts/2328#18865.html http://forums.visual-paradigm.com/posts/2328#18865.html Re:Creating documentation in XSD's http://forums.visual-paradigm.com/posts/2328#18879.html http://forums.visual-paradigm.com/posts/2328#18879.html Re:Creating documentation in XSD's
I need to extract the content of a documentation of a java class operation without CDATA too. I downloaded and installed the patch you provided (the 20070724c one, the last version for this problem) and I still can't make it work.
Here the template for JavaOperation.vm (just added $utilities and $class prints and the access call to the documentation content)
Code: 
  $operation.t_prepare($args.get("property"))#*
 *### ===== Output =====
 $utilities
 $class
 $utilities.getOriginalDocumentation($operation, $args.get("property")) 
 $operation.t_getDocumentation("$baseIndentation$indentation")$baseIndentation$indentation$operation.t_getVisibility()
 $operation.t_getNative()$operation.t_getSynchronized()$operation.t_getScope()$operation.t_getFinal()$operation.t_getAbstract()
 $operation.t_getReturnTypeName($rootClass)$operation.t_getReturnTypeModifier()#**#$operation.getName()(#set( $parameterIndex = 0 )
 #foreach($parameter in $operation.parameterIterator())#if ( $parameterIndex > 0 ), #end#parse("$template-dir/JavaParameter.vm")
 #set( $parameterIndex = $parameterIndex + 1 )
 #end
 )#set( $exceptionIndex = 0 )
 #foreach($exception in $operation.raisedExceptionIterator())#if ( $exceptionIndex == 0 ) throws #else, #end#parse("$template-dir/JavaException.vm")
 #set( $exceptionIndex = $exceptionIndex + 1 )
 #end
 #if ( $operation.isAbstract() || $operation.t_isParentInterface() );#else {
 #if( $operation.hasReference() == true )
 #parse("$template-dir/$operation.getReference().getRefTemplate()")
 #else
 $baseIndentation$indentation$indentation#**#throw new RuntimeException("Not yet implemented");
 #end
 $baseIndentation$indentation}#end


generates the following code :
Code: 
 com.vp.instantgenerator.java.JavaUtilities@1ccb1ae
 com.vp.instantgenerator.java.JavaClass@1a5469e
 $utilities.getOriginalDocumentation($operation, $args.get("property")) 
 	/**
 	 * test_comment
 	 */
 	public boolean test_operation(double a, short b) {
 		throw new RuntimeException("Not yet implemented");
 	}


I don't understand why the call to $utilities.getOriginalDocumentation($operation, $args.get("property")) still doesn't work ?

Regards
]]> http://forums.visual-paradigm.com/posts/2328#18993.html http://forums.visual-paradigm.com/posts/2328#18993.html Re:Creating documentation in XSD's
Your problem is different from Toby's as getOriginalDocumentation was made only for XSD. But it is now ready for Java as well. Please download the patch at:
http://files3.visual-paradigm.com/200708/Patch/6-1-0_20070821q/VP_Suite_Windows_3_1_20070821q.exe

Please run it and overwrite the existing installation. Sample code:

Code: 
$object = ... // retrieve something
 
 $utilities.getOriginalDocumentation($object, $args.get("property"))
 // Will return the documentation of the object without any modification


Best regards,
Jick
]]> http://forums.visual-paradigm.com/posts/2328#19025.html http://forums.visual-paradigm.com/posts/2328#19025.html