[xwiki-users] The FAQ Tutorial Manual is somewhat out of date, not sure how to proceed
I am attempting to follow the guidance at http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorialManual The idea of this page is to walk one through the creation of a new data type. However the page is out of date. For example on the xwiki/bin/view/XWiki/XWikiClasses page, things are not the same as the tutorial image in the "Create a new data type" section. The tutorial says one could fill out the space and class fields with "FAQ" but the 8.4.3 xwiki does not offer a space field. The most recent comment made in Nov 2016 states This example no longer works correctly in 8.4. However, it will if... After you create the WebHome (FAQs) page. Delete the FAQClass object from WebHome For a new xwiki user this kind of stuff is confusing. I am hesitant to proceed because I don't know what the missing "space" field implies and am not sure if I'll get tripped up by the FAQClass issue. I already ran the "Apps within Minutes" FAQ tutorial, so I'm concerned that I'll have a namespace collision with this new FAQ application unless I know what the space issue implies. -- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
Hi,
On 17 Jan 2017, at 05:18, novnovice <[email protected]> wrote:
I am attempting to follow the guidance at
http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorialManual
The idea of this page is to walk one through the creation of a new data type. However the page is out of date. For example on the xwiki/bin/view/XWiki/XWikiClasses page, things are not the same as the tutorial image in the "Create a new data type" section. The tutorial says one could fill out the space and class fields with "FAQ" but the 8.4.3 xwiki does not offer a space field. The most recent comment made in Nov 2016 states
I’ve now fully updated the tutorial. Please check it out and let me know if you succeed in following it: http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorialManual Thanks -Vincent
This example no longer works correctly in 8.4. However, it will if... After you create the WebHome (FAQs) page. Delete the FAQClass object from WebHome
For a new xwiki user this kind of stuff is confusing. I am hesitant to proceed because I don't know what the missing "space" field implies and am not sure if I'll get tripped up by the FAQClass issue. I already ran the "Apps within Minutes" FAQ tutorial, so I'm concerned that I'll have a namespace collision with this new FAQ application unless I know what the space issue implies.
-- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
Thanks for that. Now, since I already created a mini FAQ using the "Apps within Minutes" FAQ tutorial, do I have the risk of namespace collision if I follow the more advanced tutorial that you just edited? Or are they somehow isolated? Many new users will do the "Apps within Minutes" FAQ tutorial and next the tutorial that works with XWikiClasses...it might be worth adding a note that it's ok to have the two identially named artifacts in the wiki; or change the name of one of the tutorials if they can't co-exist as named. -- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
Oh, and a note about *why* it's ok to have the two tutorials which create an application named FAQ would be useful, if it is the case. -- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
On 17 Jan 2017, at 17:49, novnovice <[email protected]> wrote:
Thanks for that. Now, since I already created a mini FAQ using the "Apps within Minutes" FAQ tutorial, do I have the risk of namespace collision if I follow the more advanced tutorial that you just edited? Or are they somehow isolated? Many new users will do the "Apps within Minutes" FAQ tutorial and next the tutorial that works with XWikiClasses...it might be worth adding a note that it's ok to have the two identially named artifacts in the wiki; or change the name of one of the tutorials if they can't co-exist as named.
Good point. If you follow exactly both tutorials instructions you’ll have collisions since they both create the FAQ app in the FAQ space. Since I didn’t have the time to update the FAQ tutorials (would have needed to redo several screenshots, etc), I’ve added a warning at the top of both tutorials. Please check it out and let me know if it’s ok and understandable. Thanks -Vincent
-- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
On 17 Jan 2017, at 17:52, novnovice <[email protected]> wrote:
Oh, and a note about *why* it's ok to have the two tutorials which create an application named FAQ would be useful, if it is the case.
Sorry I don’t understand the point. The reason for having 2 tutorials is explained here: http://platform.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorial/ Thanks -Vincent
-- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
Your note with warning does the trick. What I meant by my last posting here was if it happened to be true that one could do both tutorials and NOT have a namespace collision, it would be interesting to know why, just from a learning perspective. There would have been a namespace collision so the point is solved. I had guessed that the issue would have come up before if there was a namespace collision (my guess was wrong). I posited that there might be a hidden namespace separation which would have allowed the two tutorials to co-exisit. For example what if apps built via the Apps within Minutes wizard had a special name space. They don't, it seems, but I wanted to know. Anyways, it's clear now so thanks. -- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
On 18 Jan 2017, at 04:10, novnovice <[email protected]> wrote:
Your note with warning does the trick.
What I meant by my last posting here was if it happened to be true that one could do both tutorials and NOT have a namespace collision, it would be interesting to know why, just from a learning perspective. There would have been a namespace collision so the point is solved.
I had guessed that the issue would have come up before if there was a namespace collision (my guess was wrong). I posited that there might be a hidden namespace separation which would have allowed the two tutorials to co-exisit. For example what if apps built via the Apps within Minutes wizard had a special name space. They don't, it seems, but I wanted to know.
Anyways, it's clear now so thanks.
Ok thanks, I understand now :) -Vincent
-- View this message in context: http://xwiki.475771.n2.nabble.com/The-FAQ-Tutorial-Manual-is-somewhat-out-of... Sent from the XWiki- Users mailing list archive at Nabble.com.
participants (2)
-
novnovice -
Vincent Massol