[xwiki-users] [docs] draft: XE main documentation page
Hello, currently the xwiki documentation runs on several wiki instances and spaces. Unfortunately it's not structured well too, so it's really very hard to find required information. It's my experience. I think something like a Table of Content could help indeed. Probably it would be fix & dirty solution, but nevertheless a solution. Please look at the current draft for that page: http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain Any feedback/help would be appreciated. Regards, Roman
quick & dirty :) Am Samstag, den 10.10.2009, 17:59 +0200 schrieb Roman Friesen:
Hello,
currently the xwiki documentation runs on several wiki instances and spaces. Unfortunately it's not structured well too, so it's really very hard to find required information. It's my experience.
I think something like a Table of Content could help indeed. Probably it would be fix & dirty solution, but nevertheless a solution.
Please look at the current draft for that page: http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain
Any feedback/help would be appreciated.
Regards, Roman
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
Hi Roman, Nice initiative, we need to organize better and generally improve our docs. Quick remark : the valid english is "Common Usage", "Advance Usage", not "Using". I think the "Common Usage" (should we say "Basic Usage" ?) section would benefit from a short introduction explaining that XWiki is a wiki, and what a wiki is, before the list of links. I would say the "Understanding XWiki" section could be located just after "Common Usage", as it is still information "basic users" can/should read (as opposed to "Advance Usage"). "Programming of the Content" sounds a bit weird, but the idea is there. Why not "Programming in the wiki" ? Hope this helps, Jerome On 10/10/09 6:59 PM, Roman Friesen wrote:
Hello,
currently the xwiki documentation runs on several wiki instances and spaces. Unfortunately it's not structured well too, so it's really very hard to find required information. It's my experience.
I think something like a Table of Content could help indeed. Probably it would be fix& dirty solution, but nevertheless a solution.
Please look at the current draft for that page: http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain
Any feedback/help would be appreciated.
Regards, Roman
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
We could use the Table of Content which is managed by the collections plugin. I could do some modifications to it to make it more usable for xwiki.org. We would need to decide exactly how we would like it to behave: 1/ Start from the Space home page or only start from the parent of the current page 2/ How many levels do we want to go down 3/ Do we want to follow all links down or do we want to filter some - filter the one that are not in the same space - follow only direct childs (that have the page as parent) - do not follow links that would be marked as a "reference" (in this case we need to add a property to these links) Ludovic Roman Friesen a écrit :
Hello,
currently the xwiki documentation runs on several wiki instances and spaces. Unfortunately it's not structured well too, so it's really very hard to find required information. It's my experience.
I think something like a Table of Content could help indeed. Probably it would be fix & dirty solution, but nevertheless a solution.
Please look at the current draft for that page: http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain
Any feedback/help would be appreciated.
Regards, Roman
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
-- Ludovic Dubost Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost
done :) Thanks, Roman -----Ursprüngliche Nachricht----- Von: [email protected] [mailto:[email protected]] Im Auftrag von Jerome Velociter Gesendet: Samstag, 10. Oktober 2009 18:12 An: [email protected] Betreff: Re: [xwiki-users] [docs] draft: XE main documentation page Hi Roman, Nice initiative, we need to organize better and generally improve our docs. Quick remark : the valid english is "Common Usage", "Advance Usage", not "Using". I think the "Common Usage" (should we say "Basic Usage" ?) section would benefit from a short introduction explaining that XWiki is a wiki, and what a wiki is, before the list of links. I would say the "Understanding XWiki" section could be located just after "Common Usage", as it is still information "basic users" can/should read (as opposed to "Advance Usage"). "Programming of the Content" sounds a bit weird, but the idea is there. Why not "Programming in the wiki" ? Hope this helps, Jerome On 10/10/09 6:59 PM, Roman Friesen wrote:
Hello,
currently the xwiki documentation runs on several wiki instances and spaces. Unfortunately it's not structured well too, so it's really very hard to find required information. It's my experience.
I think something like a Table of Content could help indeed. Probably it would be fix& dirty solution, but nevertheless a solution.
Please look at the current draft for that page: http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain
Any feedback/help would be appreciated.
Regards, Roman
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
Hi Ludovic, this page should be just an entry point (main overview) for the available documentation. Therefore, I think, only humans can decide whether links are good or bad :) But probably this plugin can be used to create a page index - an additional page. This page could be very helpful, not only for users, but also to see what is the current structure of the documentation => this could help to restructure that. What do you think? P.S. current documentation runs on different wikis: - platform.xwiki.org - dev.xwiki.org - enterprise.xwiki.org - code.xwiki.org Can the collections plugin handle that? Or just for every wiki one index page? Thanks, Roman -----Ursprüngliche Nachricht----- Von: [email protected] [mailto:[email protected]] Im Auftrag von Ludovic Dubost Gesendet: Sonntag, 11. Oktober 2009 21:14 An: XWiki Users Betreff: Re: [xwiki-users] [docs] draft: XE main documentation page We could use the Table of Content which is managed by the collections plugin. I could do some modifications to it to make it more usable for xwiki.org. We would need to decide exactly how we would like it to behave: 1/ Start from the Space home page or only start from the parent of the current page 2/ How many levels do we want to go down 3/ Do we want to follow all links down or do we want to filter some - filter the one that are not in the same space - follow only direct childs (that have the page as parent) - do not follow links that would be marked as a "reference" (in this case we need to add a property to these links) Ludovic Roman Friesen a écrit :
Hello,
currently the xwiki documentation runs on several wiki instances and spaces. Unfortunately it's not structured well too, so it's really very hard to find required information. It's my experience.
I think something like a Table of Content could help indeed. Probably it would be fix & dirty solution, but nevertheless a solution.
Please look at the current draft for that page: http://dev.xwiki.org/xwiki/bin/view/Drafts/XEDocMain
Any feedback/help would be appreciated.
Regards, Roman
_______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
-- Ludovic Dubost Blog: http://blog.ludovic.org/ XWiki: http://www.xwiki.com Skype: ldubost GTalk: ldubost _______________________________________________ users mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/users
participants (4)
-
Jerome Velociter -
Ludovic Dubost -
Roman Friesen -
roman.friesen＠ropardo.de