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

[Nicolas Malin (Jira)]

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


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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461336 ]
           
Scott Gray commented on OFBIZ-571:
----------------------------------

Hi Jacopo

I'm working on moving the minilang guide at the moment, I'll let you know when I'm done.

Regards
Scott

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461339 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Scott,

Have you thought about notifying deprecated ops ("env-..." for instance) and adding new ones ("set" for instance) ?

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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461342 ]
           
Scott Gray commented on OFBIZ-571:
----------------------------------

While that certainly needs to be done, I'm not familiar enough with minilang to do it.  At this stage I'll just get the doc migrated then someone who knows more about it can update the page

> 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
>
> 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)]

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

Jacques Le Roux reassigned OFBIZ-571:
-------------------------------------

    Assignee: Jacques Le Roux

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461348 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

OK, 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461437 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Scott,

I forgot to mention that I will take the relay. So please let me know when you have finished this task

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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461449 ]
           
David E. Jones commented on OFBIZ-571:
--------------------------------------

Just an FYI: MiniLang Guide final resting place has been discussed a number of times but only very little progress has been made toward the decided end. The introductory parts of it should be moved to the Confluence server, but ALL of the reference bits for the various operations and such should be moved to annotations in the simple-methods.xsd file. The newer items have been added there (the XSD file) instead of in the MiniLang Guide, and it would be nice to get it all moved over so it's in one place again, and in a place that's natural to use in an XML editor.

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461462 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

David,

I will take some time to look and think about this because even if I agree that annotations should be placed in an unique place I'm not sure that the right place for this is ans XSD file. Perhaps I'm missing something here but it seems to me that it's really easier to look at a doc like the old one for a newbie (and generaly docs are for newbies ;o) than to search annotations in an XSD file. What I'm missing is only perhaps a way of using XML editor because completion is not doing it there,  am'I wrong ? At least XML Buddy is not helping me a lot here, maybe Oxygen or IntelliJ(plugin?) are ?

Thanks for comment !

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461488 ]
           
Jacopo Cappellato commented on OFBIZ-571:
-----------------------------------------

One idea about the links to the xsd files that are in the documents.html page: what about using direct links to the svn server like this one

http://svn.apache.org/repos/asf/ofbiz/trunk/framework/base/dtd/ofbiz-containers.xsd

?

The only small issue I see is that my browser (Firefox) asks me to download the file instead of showing it on screen... but maybe we can  find a workaround for this.

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461494 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Jacopo,

I tried with Opera and IE 6. Opera does the same than Firefox. IE 6 open the file in a flat view form. But I can't see the point here, my question was about how to render the informations for a newbie. I'm sure you agree that an XSD file is not the top for that ? Except of course if you find a (free ;o) tool that facilitates the vision.

BTW I have used Visual Studio 2003 .NET last year hence it's the default viewer for XSD files on my machine. So I tried to watch was it's capable of. But even with a "sophisticated" viewer like that (yes Microsoft have some, they even claim to have invented XML ;o) it's really  not easy to find/use the documentation inside. I also tried their updated XML Notepad, but I has not notably changed since 1997 (implemented in C# with pretty colors but not much more).

From my POV it should be better to have all the doc in a more standard form than XSD. And even better to have the doc in a sole format. Confluence seems good to me in this aspect.

WDYT ?

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461496 ]
           
Jacopo Cappellato commented on OFBIZ-571:
-----------------------------------------

Jacques,

I see what you mean.
In my opinion keeping the documentation inside the xsd definition has many advantages, but I agree with you that right now it is not very user friendly.
I think that someone with good scripting skills (perl?) could easily write some scripts to extract the information from xsd and format it in a more human readable way.
What do you think?

However, what I was suggesting is that, instead of keeping a copy of the *.xsd under the site directory, it would be easier to reference it directly to the svn site...

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461498 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Jacopo,

Yes I agree a reference should be sufficient *if* we can find/create a tool that we may recommend to *newbies* for them experiencing the documentation in XSD format ... I look forward for a such tool :o)

What adavantages do you see for documentation users by keeping the doc in XSD ? Of course here I do not consider advantages for documentation authors, IMHO this is secondary ;o)

For a tool to be used/spread I believe that it have to have a real good documentation even if I agree with you that in the case of OFBiz it's simply just not enough !

If we can keep the way to have a functionnal *and* a technic documentation this will also ease newbies experience with OFBiz (I know what I'm talking about ;o)

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461509 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Comment about https://issues.apache.org/jira/browse/OFBIZ-571#action_12461462

David,

I see know how Oxygen is showing annotations (I'm looking at the advanced framework at end of widget fields) and this is surely great (and I hope/suppose that it's the same with a tool like IntelliJ) but for a newbie who will surely use a *free* tool (ie here mostly XMLBuddy in Eclipse for instance) there are no annotations poping up. I tried also in NetBeans 5.5 and it seems that there also a plugin is needed (got "no suggestions" by default). I don't know what to think now... But I'm sure that's this is something important !

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461521 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

OK, I see now that I was no the 1st to ask this question (http://lists.ofbiz.org/pipermail/users/2006-January/009966.html) and that there is already a response. Perhaps we may promote Oxygen as a 1st step. IntelliJ seems to deal with annotations, don't know for other environnements (mostly NetBeans I guess). It's only US$ 64(48 with promotion theses days) for personnal use and is not too expansive for a professionnal.

WDYT ?

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461529 ]
           
Chris Howe commented on OFBIZ-571:
----------------------------------

There is a free editor available for eclipse that does offer annotations. I believe I'm using the WTP (Web Tools Platform) XML Editor, but I cannot be certain since it only lists itself as "XML Editor".  It was bundled with one of the Callisto custom distributions.

> 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
>
> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461537 ]
           
Jacques Le Roux commented on OFBIZ-571:
---------------------------------------

Thanks Chris I will try !

A little bit disapointed with IntelliJ because does not seem to support annotations. The most I achieved may be seen in attached screencopy.

> 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
>
> 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)]

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

Jacques Le Roux updated OFBIZ-571:
----------------------------------

    Attachment: AScreenCopy.PNG

> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461557 ]
           
Chris Howe commented on OFBIZ-571:
----------------------------------

After seeing your screenshot, WTP either doesn't support annotations or I don't have it configured properly.  It does show the content model though.  However, you may try your screenshot for an element that has an annotation.  "actions" in the form widget doesn't have any documentation for it to find.  You may want to try the type attribute from the form element (ie <form type="single">) to see if your editor supports it.

> 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)]

    [ http://issues.apache.org/jira/browse/OFBIZ-571?page=comments#action_12461558 ]
           
Chris Howe commented on OFBIZ-571:
----------------------------------

make that the list-name attribute <form list-name="">.  For the type the annotation is on the constraint and not on the attribute

> 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