XWiki-Eclipse plug-in
Hi all, Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable). I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you.. - Tharindu
Hi, One suggesting is to have 2 views for the pages tree: - one by spaces - one by parent-child (orphans appear separately) The second one is going to be better for navigation and big wikis.. Ludovic tharindu jayasuriya a écrit :
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu ------------------------------------------------------------------------
This document explains the basic functions and requirements for the XWiki-Eclipse plug-in (v1.0) -----------------------------------------------------------------------------------------
Introduction (UI) -----------------
The main UI component of the plug-in would be a navigator panel which let's the user navigate through various spaces he owns. This panel will contain all the menus and access buttons that would ease the process of administering XWiki pages.
Stories -------
* When the user selects the Xwiki view in Eclipse, the XWiki Navigator panel is displayed (refer to mock UIs).
* There the user can press the 'Connect' button on the navigator panel which will bring up a dialog where he can set the connection parameters.
* Username, Password, Proxy (if applicable) can be provided at the 'Connection Settings' Dialog. Apart from that, the user can select to import all his spaces or some of them into Navigator.
* The default behaviour is to import details about all the spaces into XWiki Navigator, but this can be manipulated at the connect time (refer to mock UIs).
* Clicking on a document on the XWiki Navigator will open up the corresponding document on a browser widget (within the eclipse environment).
Above mentioned are the most urgent requirements that need to be fulfilled first. But they are far from finish-line :)
------------------------------------------------------------------------
-- You receive this message as a subscriber of the [email protected] mailing list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost AIM: nvludo Yahoo: ludovic
On 6/9/07, Ludovic Dubost <[email protected]> wrote:
Hi,
One suggesting is to have 2 views for the pages tree:
- one by spaces
This is what I had in mind. - one by parent-child (orphans appear separately) I too agree, but i'm facing a problem with the XWiki Confluence XML/RPC API<http://confluence.atlassian.com/display/DOC/Remote+API+Specification>where the rpc, Vector getPages(String token, String spaceKey) returns all the pages corresponding to the given space as "PageSummary" objects, but a PageSummary object does not say whether it has children or not. Any suggestions on how to overcome this ? Thanks for pointing this issue... :) - Tharindu <http://confluence.atlassian.com/display/DOC/Remote+API+Specification#RemoteAPISpecification-PageSummary>
The second one is going to be better for navigation and big wikis..
Ludovic
tharindu jayasuriya a écrit :
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu ------------------------------------------------------------------------
This document explains the basic functions and requirements for the XWiki-Eclipse plug-in (v1.0)
-----------------------------------------------------------------------------------------
Introduction (UI) -----------------
The main UI component of the plug-in would be a navigator panel which let's the user navigate through various spaces he owns. This panel will contain all the menus and access buttons that would ease the process of administering XWiki pages.
Stories -------
* When the user selects the Xwiki view in Eclipse, the XWiki Navigator
panel
is displayed (refer to mock UIs).
* There the user can press the 'Connect' button on the navigator panel which will bring up a dialog where he can set the connection parameters.
* Username, Password, Proxy (if applicable) can be provided at the 'Connection Settings' Dialog. Apart from that, the user can select to import all his spaces or some of them into Navigator.
* The default behaviour is to import details about all the spaces into XWiki Navigator, but this can be manipulated at the connect time (refer to mock UIs).
* Clicking on a document on the XWiki Navigator will open up the corresponding document on a browser widget (within the eclipse environment).
Above mentioned are the most urgent requirements that need to be fulfilled first. But they are far from finish-line :)
------------------------------------------------------------------------
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost AIM: nvludo Yahoo: ludovic
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
OK, i think it's possible to manage the page hierarchy using parent-id in PageSummary object. This feature will be included as an advanced feature (implemented later), which let's the user to select between hierarchical view and space->pages view. - Tharindu On 6/10/07, tharindu jayasuriya <[email protected]> wrote:
On 6/9/07, Ludovic Dubost <[email protected]> wrote:
Hi,
One suggesting is to have 2 views for the pages tree:
- one by spaces
This is what I had in mind.
- one by parent-child (orphans appear separately)
I too agree, but i'm facing a problem with the XWiki Confluence XML/RPC API <http://confluence.atlassian.com/display/DOC/Remote+API+Specification>where the rpc, Vector getPages(String token, String spaceKey) returns all the pages corresponding to the given space as "PageSummary" objects, but a PageSummary object does not say whether it has children or not. Any suggestions on how to overcome this ?
Thanks for pointing this issue... :)
- Tharindu
The second one is going to be better for navigation and big wikis..
Ludovic
tharindu jayasuriya a écrit :
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they
work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu
------------------------------------------------------------------------
This document explains the basic functions and requirements for the
XWiki-Eclipse plug-in ( v1.0)
-----------------------------------------------------------------------------------------
Introduction (UI) -----------------
The main UI component of the plug-in would be a navigator panel which let's the user navigate through various spaces he owns. This panel
will
contain all the menus and access buttons that would ease the process of administering XWiki pages.
Stories -------
* When the user selects the Xwiki view in Eclipse, the XWiki Navigator panel is displayed (refer to mock UIs).
* There the user can press the 'Connect' button on the navigator panel which will bring up a dialog where he can set the connection parameters.
* Username, Password, Proxy (if applicable) can be provided at the 'Connection Settings' Dialog. Apart from that, the user can select to import all his spaces or some of them into Navigator.
* The default behaviour is to import details about all the spaces into XWiki Navigator, but this can be manipulated at the connect time (refer to mock UIs).
* Clicking on a document on the XWiki Navigator will open up the corresponding document on a browser widget (within the eclipse environment).
Above mentioned are the most urgent requirements that need to be fulfilled first. But they are far from finish-line :)
------------------------------------------------------------------------
-- You receive this message as a subscriber of the [email protected]
mailing list.
To unsubscribe: mailto:[email protected] For general help: mailto:[email protected] ?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- Ludovic Dubost Blog: http://www.ludovic.org/blog/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost AIM: nvludo Yahoo: ludovic
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto: [email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Hi Tharindu, Good work, the mockups are nice! I've read the use cases too and I think it's missing the key feature: * The ability to edit pages inside the Eclipse editor (as opposed to editing a page inside a browser inside Eclipse). We discussed this in your past emails and we agreed this was important. I think this should be one of the first use cases. Maybe you wish to implement it just a little bit after? * Other important use cases: - ability to save the content of a page in a local eclipse store for working offline - ability to download all pages of a space or the whole wiki to that store - type ctrl-S to save a modified page - warning when trying to save a locally modified page that has also been modified on the server after the last sync was done * I suggest you create a new IDEA page on http://www.xwiki.org/xwiki/ bin/view/Idea/ containing the use cases list and the images so that we can gather all contributions/ideas in one place. * Next steps I'm proposing: A) List all use cases you're planning to implement within the GSOC. We need the full list as much as possible. Please put them all on the wiki page I mentioned. B) Define several milestones containing each a set of use cases. Please try to map each milestone against XWiki releases as much as possible (1.1M2, M3, M4, M5, etc). See http://jira.xwiki.org the planned delivery dates. It's better we all work on the same delivery cycles. C) Create as many JIRA issues as you have use cases + one JIRA issue that is the main issue for your GSOC project. Please set the fix for for these jira issues against the defined milestones in B) above. Note: For now please create the jira issues in the XWiki project. I'll create a separate jira project for your GSOC project in a few days and I'll move the issues over. You can use a component of "Others" for now. WDYT? Let us know if you have other questions. Thanks! -Vincent On Jun 9, 2007, at 2:26 PM, tharindu jayasuriya wrote:
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu <screen-shots.tar.bz2> <basic-requirements.txt>
-- You receive this message as a subscriber of the xwiki- [email protected] mailing list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/ wws
On 6/9/07, Vincent Massol <[email protected]> wrote:
Hi Tharindu, Good work, the mockups are nice!
thanks :) I've read the use cases too and I think it's missing the key feature:
* The ability to edit pages inside the Eclipse editor (as opposed to editing a page inside a browser inside Eclipse). We discussed this in your past emails and we agreed this was important. I think this should be one of the first use cases. Maybe you wish to implement it just a little bit after?
Sorry about not mentioning this. Yes, with Page<http://confluence.atlassian.com/display/DOC/Remote+API+Specification#RemoteAPISpecification-Page> storePage(String token, Page<http://confluence.atlassian.com/display/DOC/Remote+API+Specification#RemoteAPISpecification-Page> page) rpc, i think this is quite possible. My idea is to have two tabs (as in TimTam), one lets you view the browser output and other to edit the page using xwiki syntax. I saw the rpc renderContent(String token, String spaceKey, String pageId, String content) , and was thinking if it's possible to implement this locally (perhaps with some xwiki libs). This would be greate when editing pages in disconnected mode!!! * Other important use cases:
- ability to save the content of a page in a local eclipse store for working offline
- ability to download all pages of a space or the whole wiki to that store
- type ctrl-S to save a modified page
- warning when trying to save a locally modified page that has also been modified on the server after the last sync was done
I was thinking about implementing "connected" mode operations first and then move into local editing stuff, WDYT ? * I suggest you create a new IDEA page on
http://www.xwiki.org/xwiki/bin/view/Idea/ containing the use cases list and the images so that we can gather all contributions/ideas in one place.
I'll do this asap. I also have the help from one of my batch mates(asiri) who is interested in the topic. Since we don't have much of a summer brake in Srilanka, I think I can use some help. * Next steps I'm proposing:
A) List all use cases you're planning to implement within the GSOC. We need the full list as much as possible. Please put them all on the wiki page I mentioned. B) Define several milestones containing each a set of use cases. Please try to map each milestone against XWiki releases as much as possible ( 1.1M2, M3, M4, M5, etc). See http://jira.xwiki.org the planned delivery dates. It's better we all work on the same delivery cycles. C) Create as many JIRA issues as you have use cases + one JIRA issue that is the main issue for your GSOC project. Please set the fix for for these jira issues against the defined milestones in B) above. Note: For now please create the jira issues in the XWiki project. I'll create a separate jira project for your GSOC project in a few days and I'll move the issues over. You can use a component of "Others" for now.
WDYT?
I think i need to set-up a new set of requirements (more complete) and milestones, i'll do this asap. Thanks for your valuable comments. - Tharindu Let us know if you have other questions.
Thanks! -Vincent
On Jun 9, 2007, at 2:26 PM, tharindu jayasuriya wrote:
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu <screen-shots.tar.bz2> <basic-requirements.txt>
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected]<[email protected]> For general help: mailto:[email protected]?subject=help<[email protected]?subject=help> ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Hi list, On 6/9/07, Vincent Massol <[email protected]> wrote:
Hi Tharindu, Good work, the mockups are nice!
I've read the use cases too and I think it's missing the key feature:
* The ability to edit pages inside the Eclipse editor (as opposed to editing a page inside a browser inside Eclipse). We discussed this in your past emails and we agreed this was important. I think this should be one of the first use cases. Maybe you wish to implement it just a little bit after?
* Other important use cases: - ability to save the content of a page in a local eclipse store for working offline - ability to download all pages of a space or the whole wiki to that store - type ctrl-S to save a modified page - warning when trying to save a locally modified page that has also been modified on the server after the last sync was done
* I suggest you create a new IDEA page on http://www.xwiki.org/xwiki/bin/view/Idea/ containing the use cases list and the images so that we can gather all contributions/ideas in one place.
* Next steps I'm proposing: A) List all use cases you're planning to implement within the GSOC. We need the full list as much as possible. Please put them all on the wiki page I mentioned.
I have created the idea page at http://www.xwiki.org/xwiki/bin/view/Idea/XWiki-Eclipse+Plug-in.<http://www.xwiki.org/xwiki/bin/view/Idea/XWiki-Eclipse+Plug-in> Feel free to add you comments... :) - Tharindu B) Define several milestones containing each a set of use cases. Please try
to map each milestone against XWiki releases as much as possible (1.1M2, M3, M4, M5, etc). See http://jira.xwiki.org the planned delivery dates. It's better we all work on the same delivery cycles. C) Create as many JIRA issues as you have use cases + one JIRA issue that is the main issue for your GSOC project. Please set the fix for for these jira issues against the defined milestones in B) above. Note: For now please create the jira issues in the XWiki project. I'll create a separate jira project for your GSOC project in a few days and I'll move the issues over. You can use a component of "Others" for now.
WDYT?
Let us know if you have other questions.
Thanks! -Vincent
On Jun 9, 2007, at 2:26 PM, tharindu jayasuriya wrote:
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu <screen-shots.tar.bz2> <basic-requirements.txt>
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected]<[email protected]> For general help: mailto:[email protected]?subject=help<[email protected]?subject=help> ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
Hi Vincent, On 6/9/07, Vincent Massol <[email protected]> wrote:
Hi Tharindu, Good work, the mockups are nice!
I've read the use cases too and I think it's missing the key feature:
* The ability to edit pages inside the Eclipse editor (as opposed to editing a page inside a browser inside Eclipse). We discussed this in your past emails and we agreed this was important. I think this should be one of the first use cases. Maybe you wish to implement it just a little bit after?
* Other important use cases: - ability to save the content of a page in a local eclipse store for working offline - ability to download all pages of a space or the whole wiki to that store - type ctrl-S to save a modified page - warning when trying to save a locally modified page that has also been modified on the server after the last sync was done
* I suggest you create a new IDEA page on http://www.xwiki.org/xwiki/bin/view/Idea/ containing the use cases list and the images so that we can gather all contributions/ideas in one place.
* Next steps I'm proposing: A) List all use cases you're planning to implement within the GSOC. We need the full list as much as possible. Please put them all on the wiki page I mentioned. B) Define several milestones containing each a set of use cases. Please try to map each milestone against XWiki releases as much as possible ( 1.1M2, M3, M4, M5, etc). See http://jira.xwiki.org the planned delivery dates. It's better we all work on the same delivery cycles. C) Create as many JIRA issues as you have use cases + one JIRA issue that is the main issue for your GSOC project. Please set the fix for for these jira issues against the defined milestones in B) above. Note: For now please create the jira issues in the XWiki project. I'll create a separate jira project for your GSOC project in a few days and I'll move the issues over. You can use a component of "Others" for now.
This is the main JIRA issue of the GSOC project IDE Editor Integration ( http://jira.xwiki.org/jira/browse/XWIKI-1359). This contains links to the other JIRA issues which describes the tasks and the milestones. Thanks, -Tharindu WDYT?
Let us know if you have other questions.
Thanks! -Vincent
On Jun 9, 2007, at 2:26 PM, tharindu jayasuriya wrote:
Hi all,
Here I have attached some mock GUIs and a very intuitive requirements spec that illustrate the basic workings of XWiki-Eclipse plug-in. It's better if we can finalize these drafts soon because I need to go on with the development :). I have few doubts on the java package structure as well as about the icon graphics for the plug-in (i thought of re-using eclipse's ones where suitable).
I went through XWiki XML RPC APIs and am comfortable with thw way they work (had to sharpen my SWT skills too). I'm looking forward to hear from you..
- Tharindu <screen-shots.tar.bz2> <basic-requirements.txt>
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected]<[email protected]> For general help: mailto:[email protected]?subject=help<[email protected]?subject=help> ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
-- You receive this message as a subscriber of the [email protected] list. To unsubscribe: mailto:[email protected] For general help: mailto:[email protected]?subject=help ObjectWeb mailing lists service home page: http://www.objectweb.org/wws
participants (3)
-
Ludovic Dubost -
tharindu jayasuriya -
Vincent Massol