OFBiz › OFBiz - Dev

[jira] Created: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

57 messages Options

123

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461577 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Chris,

After your comment I dowloaded WTP. I had already WTP in (actually saying "WST XML UI" in Manage Configuration) but was unable to use it (XML editor hangs). Also have a message saying "XML editor (locked by content type)" in the editor associations preferences. So Googled for it and find something explaining that I have to dowload all the stuff (argh 210 Mo...).
So I will not use it, though perhaps I will try, I'm too curious

Thanks for your suggestion but it's too complicated so I tried with simple-method token which have a documentation (and actually my concern here is more for simple-methods.xsd) . I'm now sure that IntelliJ is not working properly with XML documentation during completion : same message than above while there is a documentation for this token in simple-methods.xsd.

Conclusion of my searches about IDE or IDE/plugins couples aware of documentation during XML completion :

Eclipse 3.2/plugins
XMLBuddy : not
WTP : not
Oxygen : yes

Netbeans 5.5 : not (but I'm not a specialist, perhaps there are plugins ?)

IntelliJ 6.02 : not (but I'm not a specialist, perhaps there are plugins ?)

So it seems that for now we must only relay on Eclipse 3.2/Oxygen for functionnality. Moreover it cost at least US$ 64(temporary promo to US$ 48 apart).

So what people think about all that ? Are we sure that we must constraint people to use this tools (Eclipse/Oxygen) ?
Of course if in the future maybe some enhancement will be found for this in IDE or plugins but today that's the situation. I will be happy to be corrected of course...

I thing that this is really important, please give your opinions or advices.

Thanks

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: http://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461581 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

I found this old issue by chance OFBIZ-90. In 1st comment I was talking about semantic missing in "Oxygen popup annotations". But now that I have reloaded (with another email ;o) Oxygen I can see the documentation associated with the tokens and it fills the gap. But really I find their professionnal licence expansive (US$ 225).

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461583 ]

Chris Howe commented on OFBIZ-571:
----------------------------------

By reading this bug report, it should be in WTP:

https://bugs.eclipse.org/bugs/show_bug.cgi?id=118425

I have yet been able get it to work though. I'm using 2.0 M3 and the bug report alludes that a certain part of it was fixed in 1.5. I will play some more and report back if it ends up working :)

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461624 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

I put here the same comment than in http://issues.apache.org/jira/browse/OFBIZ-402#action_12461623 to keep things clear :

I just checked before moving annotations
from
http://incubator.apache.org/ofbiz/docs/minilang.html
to
http://svn.apache.org/repos/asf/ofbiz/trunk/framework/minilang/dtd/simple-methods.xsd

There are no more any
env-to-field
field-to-env
string-to-field
field-to-field
env-to-env
used in *.xml files of OFBiz but some commented snippets that seems unused and should be perhaps removed.

Scott, Im' ready to help on this topic (ie moving annotations to simple-methods.xsd). Please let me know what you have already done, thanks.
If you have not already began I propose that you move only the introductory part as usggested by David https://issues.apache.org/jira/browse/OFBIZ-571#action_12461449 and I will take of the annotations. Thanks to let me know.

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461632 ]

Scott Gray commented on OFBIZ-571:
----------------------------------

Hi Jacques, David

The work I have begun is here: http://docs.ofbiz.org/display/OFBIZ/Mini-Language+Guide

But personally I would prefer to have the guide remain in the docs, even if I have to maintain it in the wiki section. Jacques, if you want to take the introduction from this page that's fine but please create a new page rather than deleting the work I have done on the rest of the guide.

Also if you guys decide to keep the full guide in OFBTECH then please don't move it until I have finished tidying it up.

Thanks
Scott

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461638 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Jacopo,

To refer to XSD files we may use something like this

http://svn.apache.org/viewvc/ofbiz/trunk/framework/minilang/dtd/simple-methods.xsd?revision=490457

But we will have to update the link when the file change :(

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461639 ]

Scott Gray commented on OFBIZ-571:
----------------------------------

Hi Jacques

You can just use revision=HEAD like:
http://svn.apache.org/viewvc/ofbiz/trunk/framework/minilang/dtd/simple-methods.xsd?revision=HEAD
to keep up to date.

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461640 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Scott,

I saw your work, quite impressive. Of course if we keep it there we will have to update it. For instance
. there is no more an ofbiz/core/docs/xmldefs/ofbiz/simple-methods.dtd file (hence my comment just above).
. env-to-field
field-to-env
string-to-field
field-to-field
env-to-env are deprecated and no more used in OFBiz (see my comment above)

I thought a bit about that. IMHO it's better to have only one source of information (more reliable, because things change) and I finally agree with the ones that think that this source should be in XSD files. But for that we have to find an universal(?) tool usable by everyone. Even if we don't use it because we prefer our proper tool (Oxygen being a good but not free candidate here). If we can't find and recommend a tool like this it will be difficult for newbies to apprehend the minlang and such specif using XSD documentations.

My 2 cents ;o)

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461641 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Jacopo,

I will ask viewVC users ML if there is solution to view last version (and not a number) and if not ask for enhancement... will see...

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461642 ]

Jacopo Cappellato commented on OFBIZ-571:
-----------------------------------------

Jacques,

I think that Scott's suggestion will do the trick for now (i.e. using the http://svn.apache.org/viewvc/ofbiz/trunk/framework/minilang/dtd/simple-methods.xsd?revision=HEAD link).

Thanks to both of you for your help, I've committed the modified links in rev. 491626

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461646 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Great Scott,

Our posts did cross. I already subscribed to viewVC users ML, I will sure unsubscribe, already enough mails ;o)

Thanks for your help.

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ http://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461751 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

I have commited in revision 491819 a 1st step to let know that I take care of documentation in simple-method.xsd. I tested locally, seems fine.

BTW this thread http://www.nabble.com/Re%3A-svn-commit%3A-r491626---in--ofbiz-site%3A-documents.html-dtds--tf2905413.html#a8117889 seems to have closed the discussion above about how to deal with documentations such as minlang doc (best viewed chronogically)

Thanks to all

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461892 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Scott,

I made some modifications in http://docs.ofbiz.org/display/OFBIZ/Mini-Language+Guide, still a work in progress...

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461893 ]

Scott Gray commented on OFBIZ-571:
----------------------------------

Hi Jacques

I like Chris and David's ideas about using XSLT, so do you think we should discard this page?

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461915 ]

Chris Howe commented on OFBIZ-571:
----------------------------------

I don't have time at the moment to work on an xslt for xsd. I know there are some out there, I didn't see one on an initial search that was that great (and even ones that looked promising, licensing wasn't mentioned). It seems the better ones use a generator similar to javadocs to actually produce an html page along with javascript ( xsddoc - http://xframe.sourceforge.net/xsddoc/index.html and another is xs3p - the link is currently dead http://titanium.dstc.edu.au/xml/xs3p/) Both the generators do some pretty work, but fall to the same problem javadoc does in that they actually have to be generated (this is a good solution if someone can keep up with it). Because they're generated there is a possibility for them to be stale. As opposed to a pure xslt stylesheet approach that is just applying a template to a file and will apply no matter how often you change the source.

For those that would like to play with xslt this extremely brief example should let you get a feeling of how to get started.

xslt file:

<?xml version="1.0"?>
<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema"
exclude-result-prefixes="xs">

<xsl:output method="html"/>

<xsl:template match="xs:element[@name]">
<table border="1" width="100%">
<tr>
<td width="25%">
<xsl:value-of select="@name"/>
</td>
<td width="75%">
<xsl:apply-templates select="xs:annotation"/>
</td>
</tr>
</table>
</xsl:template>

</xsl:transform>

This will do a simple two column table. The first one giving the name of the element, the second one printing out all of the annotations (in most of ofbiz's xsd files this will only be the documentation text). This example does fail slightly as it will print the doucumentation for xs:choices when available, but because xs:choices is not xs:element nothing will print in the first column for that row.

In your xsd file simply place at the top:

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xml" href="available_path_to_your_xslt_file"?>

I'd be more than happy to help with questions as they come up, but I will not be able to work on a complete solution. I have next to zero artistic ability and too much OCD for any amount of styling to be a small task ;)

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461919 ]

David E. Jones commented on OFBIZ-571:
--------------------------------------

I think we should continue on the path of an XSLT file to help generate a reference, but in response to Scott's question we still shouldn't totally eliminate the MiniLang guide. It should just be reduced to introductory and overview text, and examples and such. It is only the _reference_ material that should go into the XSD file.

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461926 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Yes, XSLT solution seems the smarter indeed. I will continue to update both XSD and HTML (meaning also delete some part of HTML as suggested by David) and I agree with David about not totally eliminate the MiniLang guide because we can't put all stuffes from there in the XSD.

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

Chandresh Turakhia

OpenBusinessScriptingLang :) Re: [jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

> [
> https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461926 ]
>
> Jacques Le Roux commented on OFBIZ-571:
> ---------------------------------------
>
> Yes, XSLT solution seems the smarter indeed. I will continue to update
> both XSD and HTML (meaning also delete some part of HTML as suggested by
> David) and I agree with David about not totally eliminate the MiniLang
> guide because we can't put all stuffes from there in the XSD.

my 2 cents... MiniLang is most interesting stuff and heart of why "ofbiz
should click" in my ppt to management. Fed ( Head office ) increase the
"interest" by 2 %.

Plus Points
=======
Business Scripting Language - Intepreted is all cool these days :)

http://markproctor.blogspot.com/2006/11/jfdi-new-business-action-scripting.html

We need to package it as OpenBusinessScriptingLang OBSL :)

Also check http://www.theserverside.com/news/thread.tss?thread_id=43600

Can we join Hands with JBoss.

Drtools ; scheduler etc is good but there is define NEED for such scripting.
Chand

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12461964 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

I continue my work on XSD annotations takeen from minilang guide (ie delete them in Confluence minilang guide). Of course I will appreciate reviews of this work as it's an important piece of the documentation.

Thanks

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

Nicolas Malin (Jira)

[jira] Commented: (OFBIZ-571) Move the various documentation pages to the OFBTECH space on docs.ofbiz.org

In reply to this post by Nicolas Malin (Jira)

[ https://issues.apache.org/jira/browse/OFBIZ-571?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12462219 ]

Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Si,

I foresee a problem with http://www.opensourcestrategies.com/ofbiz/ofbiz_eclipse.php in your recommendation to use f XMLbuddy as this plugin is not able to deal with XSD annotations/documentation. AFAIK only Oygen is able for the moment.

BTW this is always a pb for us as Oxygen is not free after 30 days of evaluation :(

Thanks

> Move the various documentation pages to the OFBTECH space on docs.ofbiz.org
> ---------------------------------------------------------------------------
>
> Key: OFBIZ-571
> URL: https://issues.apache.org/jira/browse/OFBIZ-571
> Project: Apache OFBiz (The Open for Business Project)
> Issue Type: Sub-task
> Components: site
> Reporter: Jacopo Cappellato
> Assigned To: Jacques Le Roux
> Attachments: AScreenCopy.PNG
>
>
> Move the various documentation pages and even the main Docs & Books page to the OFBTECH space on docs.ofbiz.org

123