[xwiki-devs] SRD (Scripting Reference Documentation) Annoucement
Hi, I'm happy to announce the first release of the Scripting Reference Documentation (SRD). The objective of this documentation is to have a quick access to the relevant javadoc or documentation page to perfom XWiki scripting. The SRD is available at: http://platform.xwiki.org/xwiki/bin/view/SRD/Navigation?xpage=embed It contains: - javadoc links to Velocity and Groovy bindings, including the main API ($xwiki, $doc, $request, $response, $context) as well as XWiki services and plugins, as well as Velocity Tools. - links to the Velocity and Groovy language documentation This documentation is currently available for XWiki 4.1.x an 4.2.x. This is a very good tools for beginners with XWiki scripting. We do still recommend the development tutorials on the XWiki Dev Guide (http://platform.xwiki.org/xwiki/bin/view/DevGuide/WebHome). Please let us know on the dev list for any feedback on this new documentation. Ludovic -- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
Hi, My feedback is that it is incredibly nice to have all this information in one location :) Maybe it would be even nicer if the page had a more explicit title than "Navigation", something like "Scripting Reference Documentation Navigation" for example, would be more easy to find among firefox tabs ;-)
This documentation is currently available for XWiki 4.1.x an 4.2.x. I'm not sure to understand how it translate, for example on $doc it opens javadoc of com.xpn.xwiki.api.Document, but which version ?
Many thanks, Jeremie 2012/10/10 Ludovic Dubost <ludovic@xwiki.com>:
Hi,
I'm happy to announce the first release of the Scripting Reference Documentation (SRD). The objective of this documentation is to have a quick access to the relevant javadoc or documentation page to perfom XWiki scripting.
The SRD is available at: http://platform.xwiki.org/xwiki/bin/view/SRD/Navigation?xpage=embed
It contains:
- javadoc links to Velocity and Groovy bindings, including the main API ($xwiki, $doc, $request, $response, $context) as well as XWiki services and plugins, as well as Velocity Tools. - links to the Velocity and Groovy language documentation
This documentation is currently available for XWiki 4.1.x an 4.2.x.
This is a very good tools for beginners with XWiki scripting. We do still recommend the development tutorials on the XWiki Dev Guide (http://platform.xwiki.org/xwiki/bin/view/DevGuide/WebHome).
Please let us know on the dev list for any feedback on this new documentation.
Ludovic
-- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost _______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
Hi 2012/10/10 Jeremie BOUSQUET <jeremie.bousquet@gmail.com>
Hi,
My feedback is that it is incredibly nice to have all this information in one location :)
Maybe it would be even nicer if the page had a more explicit title than "Navigation", something like "Scripting Reference Documentation Navigation" for example, would be more easy to find among firefox tabs ;-)
You can type SRD to find it quickly :) I've change the title page so it should help.
This documentation is currently available for XWiki 4.1.x an 4.2.x. I'm not sure to understand how it translate, for example on $doc it opens javadoc of com.xpn.xwiki.api.Document, but which version ?
There is a select box which sets the cookie for the version. Once you have chosen a version it stays in this version. If you change the select box it will reload the page with the appropriate version. One thing that is not done yet is to have the search list only bindings available in the current version. We don't yet have the information in the pages for that. Once we have generated the documentation for 3.5.x I will add this. Ludovic
Many thanks, Jeremie
2012/10/10 Ludovic Dubost <ludovic@xwiki.com>:
Hi,
I'm happy to announce the first release of the Scripting Reference Documentation (SRD). The objective of this documentation is to have a quick access to the relevant javadoc or documentation page to perfom XWiki scripting.
The SRD is available at: http://platform.xwiki.org/xwiki/bin/view/SRD/Navigation?xpage=embed
It contains:
- javadoc links to Velocity and Groovy bindings, including the main API ($xwiki, $doc, $request, $response, $context) as well as XWiki services and plugins, as well as Velocity Tools. - links to the Velocity and Groovy language documentation
This documentation is currently available for XWiki 4.1.x an 4.2.x.
This is a very good tools for beginners with XWiki scripting. We do still recommend the development tutorials on the XWiki Dev Guide (http://platform.xwiki.org/xwiki/bin/view/DevGuide/WebHome).
Please let us know on the dev list for any feedback on this new documentation.
Ludovic
-- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost _______________________________________________ devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
devs mailing list devs@xwiki.org http://lists.xwiki.org/mailman/listinfo/devs
-- Ludovic Dubost Founder and CEO Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
participants (2)
-
Jeremie BOUSQUET -
Ludovic Dubost