[xwiki-devs] Scripting Documentation application released
Hi devs,
From an API initiated during the last XWiki seminar from the fun and ambitious idea that it should be possible to retrieve from a running XWiki instance all the useful entry points for providing a good and extensible XWiki Scripting API reference documentation, the Scripting Documentation application is now finally released in version 1.0.
See for some screenshot and more detailed information: http://extensions.xwiki.org/xwiki/bin/view/Extension/Scripting+Documentation... This application is compatible with XWiki 6.2.5 and later 6.2.x, with full support in XWiki 6.4.1 or later 6.4.x, and support only the Flamingo skin. It is based on a AngularJS development. To allows you to discover it, and in the aim to provide online the documentation of our Scripting API for the latest stable version, I have also installed it on: http://platform.xwiki.org/xwiki/bin/view/ScriptingDocumentation I hope you will found this a good idea, and if nobody complains, I will link that application from the actual API documentation. Please let me know your remarks about the application. It is a 1.0 version and there is obviously room for many improvements. Your comments is therefore very welcomed. Thanks, -- Denis Gervalle SOFTEC sa - CEO
On Fri, Mar 13, 2015 at 11:43 PM, Denis Gervalle <[email protected]> wrote:
Hi devs,
From an API initiated during the last XWiki seminar from the fun and ambitious idea that it should be possible to retrieve from a running XWiki instance all the useful entry points for providing a good and extensible XWiki Scripting API reference documentation, the Scripting Documentation application is now finally released in version 1.0.
See for some screenshot and more detailed information:
http://extensions.xwiki.org/xwiki/bin/view/Extension/Scripting+Documentation...
This application is compatible with XWiki 6.2.5 and later 6.2.x, with full support in XWiki 6.4.1 or later 6.4.x, and support only the Flamingo skin. It is based on a AngularJS development.
To allows you to discover it, and in the aim to provide online the documentation of our Scripting API for the latest stable version, I have also installed it on: http://platform.xwiki.org/xwiki/bin/view/ScriptingDocumentation
The right link is: http://platform.xwiki.org/xwiki/bin/view/ScriptingDocumentation/
I hope you will found this a good idea, and if nobody complains, I will link that application from the actual API documentation.
Please let me know your remarks about the application. It is a 1.0 version and there is obviously room for many improvements. Your comments is therefore very welcomed.
Thanks,
-- Denis Gervalle SOFTEC sa - CEO
-- Denis Gervalle SOFTEC sa - CEO
Hi Denis, On 13 Mar 2015 at 23:44:14, Denis Gervalle ([email protected](mailto:[email protected])) wrote:
Hi devs,
From an API initiated during the last XWiki seminar from the fun and ambitious idea that it should be possible to retrieve from a running XWiki instance all the useful entry points for providing a good and extensible XWiki Scripting API reference documentation, the Scripting Documentation application is now finally released in version 1.0.
See for some screenshot and more detailed information: http://extensions.xwiki.org/xwiki/bin/view/Extension/Scripting+Documentation...
This application is compatible with XWiki 6.2.5 and later 6.2.x, with full support in XWiki 6.4.1 or later 6.4.x, and support only the Flamingo skin. It is based on a AngularJS development.
To allows you to discover it, and in the aim to provide online the documentation of our Scripting API for the latest stable version, I have also installed it on: http://platform.xwiki.org/xwiki/bin/view/ScriptingDocumentation
I hope you will found this a good idea, and if nobody complains, I will link that application from the actual API documentation.
Please let me know your remarks about the application. It is a 1.0 version and there is obviously room for many improvements. Your comments is therefore very welcomed.
This is a great app and nicely done. Well done! Now I wonder how it positions itself vs the current SRD at http://platform.xwiki.org/xwiki/bin/view/SRD/Navigation?xpage=embed Should we keep both? Do we keep only your version? AFAIK we haven’t updated the SRD for a while and the process of doing so is very hacky/manual so I’m in favor of removing the SRD (or keeping it for a while since your app only supports XWiki 6.2+ but with a disclaimer message that it’s now deprecated and will be gone soon and direct users to the new app), and instead asking users to install your app. WDYT? Regarding your app, some ideas: * Show the value of evaluated scripting variables when you hover over their description. * More visible progress bar (in the middle of the page) on first load (right now it’s tinyish under the menu bar and I almost missed it) Thanks -Vincent
Thanks,
-- Denis Gervalle SOFTEC sa - CEO
On 16 Mar 2015 at 14:05:12, [email protected] ([email protected](mailto:[email protected])) wrote:
Hi Denis,
On 13 Mar 2015 at 23:44:14, Denis Gervalle ([email protected](mailto:[email protected])) wrote:
Hi devs,
From an API initiated during the last XWiki seminar from the fun and ambitious idea that it should be possible to retrieve from a running XWiki instance all the useful entry points for providing a good and extensible XWiki Scripting API reference documentation, the Scripting Documentation application is now finally released in version 1.0.
See for some screenshot and more detailed information: http://extensions.xwiki.org/xwiki/bin/view/Extension/Scripting+Documentation...
This application is compatible with XWiki 6.2.5 and later 6.2.x, with full support in XWiki 6.4.1 or later 6.4.x, and support only the Flamingo skin. It is based on a AngularJS development.
To allows you to discover it, and in the aim to provide online the documentation of our Scripting API for the latest stable version, I have also installed it on: http://platform.xwiki.org/xwiki/bin/view/ScriptingDocumentation
I hope you will found this a good idea, and if nobody complains, I will link that application from the actual API documentation.
Please let me know your remarks about the application. It is a 1.0 version and there is obviously room for many improvements. Your comments is therefore very welcomed.
This is a great app and nicely done. Well done!
Now I wonder how it positions itself vs the current SRD at http://platform.xwiki.org/xwiki/bin/view/SRD/Navigation?xpage=embed
Should we keep both? Do we keep only your version?
AFAIK we haven’t updated the SRD for a while and the process of doing so is very hacky/manual so I’m in favor of removing the SRD (or keeping it for a while since your app only supports XWiki 6.2+ but with a disclaimer message that it’s now deprecated and will be gone soon and direct users to the new app), and instead asking users to install your app.
WDYT?
For now, I’ve modified http://platform.xwiki.org/xwiki/bin/view/DevGuide/API to list your extension and the version installed on xwiki.org Thanks -Vincent
Regarding your app, some ideas: * Show the value of evaluated scripting variables when you hover over their description. * More visible progress bar (in the middle of the page) on first load (right now it’s tinyish under the menu bar and I almost missed it)
Thanks -Vincent
Thanks,
-- Denis Gervalle SOFTEC sa - CEO
participants (2)
-
Denis Gervalle -
vincent＠massol.net