Authoring templates and design sheets not working for custom class
Hi All,I'm really disappointed by the lack of in depth XWiki developer tutorial.XWiki has been around for a while -- and the only good material I can find is here:http://www.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorialhttp://www.xwiki.org... above links are the level of tutorial I'm looking for -- but they don't go far/long enough....I've followed the FAQTutorial steps and cannot get the example to work as described.I've performed all steps as described -- without error/warning -- but when I try to create a new custom FAQ document -- my class properties (question & answer) are not being shown on the edit/creation page ? It's just blank space with two rows of Cancel/Save-Continue/Save-View etc buttons.* I'm using XWIKI: 1.1-milestone-3.3933* On Windows XP with Apache Tomcat 5.5.12* I'm using MySQL as the database - I think it's UTF8 - Server version: 5.0.13-rc-nt1) When I'm querying the database -- the tables: xwikiproperties - is being populated -- but newly added entries seem to have negative values for XWO_ID column. xwikiobjects - is being populated -- but newly added entries seem to have negative values for XWO_ID column. xwikiclasses - is empty ? why ?2) I would be very grateful to a link to some decent tutorial/documentation -- even if I have to pay for it...It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/Properties are actually related....I can't believe this stuff isn't better documented :(Hope someone can help me out...ThanksFrank _________________________________________________________________ Explore the seven wonders of the world http://search.msn.com/results.aspx?q=7+wonders+world&mkt=en-US&form=QBRE
Hi Frank, On Aug 9, 2007, at 9:43 PM, Frank Misa wrote:
Hi All,
I'm really disappointed by the lack of in depth XWiki developer tutorial. XWiki has been around for a while -- and the only good material I can find is here: http://www.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorial http://www.xwiki.org/xwiki/bin/view/DevGuide/CreatingPlugins
This is a great opportunity for you to set this right! :) Once you understand it, could we count on you to improve the documentation on the xwiki.org wiki?
The above links are the level of tutorial I'm looking for -- but they don't go far/long enough.... I've followed the FAQTutorial steps and cannot get the example to work as described.
I've performed all steps as described -- without error/warning -- but when I try to create a new custom FAQ document -- my class properties (question & answer) are not being shown on the edit/ creation page ? It's just blank space with two rows of Cancel/Save- Continue/Save-View etc buttons.
* I'm using XWIKI: 1.1-milestone-3.3933 * On Windows XP with Apache Tomcat 5.5.12 * I'm using MySQL as the database - I think it's UTF8 - Server version: 5.0.13-rc-nt
1) When I'm querying the database -- the tables: xwikiproperties - is being populated -- but newly added entries seem to have negative values for XWO_ID column. xwikiobjects - is being populated -- but newly added entries seem to have negative values for XWO_ID column. xwikiclasses - is empty ? why ?
2) I would be very grateful to a link to some decent tutorial/ documentation -- even if I have to pay for it... It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/ Properties are actually related.... I can't believe this stuff isn't better documented :(
Documentation is done by the community, i.e. people like you. I agree it's a little bit disappointing that lots of users do not participate more to documentation since they get a software for free, ask a lot of questions and when they get their answers they don't even bother to reinject their knowledge into the documentation for the benefit of others. I hope you're not like these users! :) I can help if you're ok to work on improving the tutorials with the missing information. WDYT? Thanks -Vincent
2) I would be very grateful to a link to some decent tutorial/documentation -- even if I have to pay for it... It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/Properties are actually related.... I can't believe this stuff isn't better documented :(
Documentation is done by the community, i.e. people like you. I agree it's a little bit disappointing that lots of users do not participate more to documentation since they get a software for free, ask a lot of questions and when they get their answers they don't even bother to reinject their knowledge into the documentation for the benefit of others. I hope you're not like these users! :) I have some small suggestions : One is can we have some logical structure in place, say, empty links, which others can edit and add content to it. For example, one of those can be, Search tips: people can add different scenarios and the queries that apply in that scenario.
Another is to classify the FAQ into proper sections. There are a whole lot of information in the mailing list which can make way to FAQs so that a new comer will be at ease. If structured properly, FAQ will be of much use, I guess. Another is a tutorial more elaborate than the current FAQ tutorial. A mini application which will give a new comer a feel of what can be done using xwiki. Regards Roopesh ------------------ DigitalGlue, India
On Aug 9, 2007, at 9:43 PM, Frank Misa wrote:
Hi All,
[snip]
2) I would be very grateful to a link to some decent tutorial/ documentation -- even if I have to pay for it... It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/ Properties are actually related.... I can't believe this stuff isn't better documented :(
Yep we need to rewrite that tutorial on Class/Object/Templates/ Classsheets. Would be great if you can help. Here's a short version: * Classes contain definition of a concept. A definition is made of properties. A property can be a string, a text area, a combo box, a radio button choice, etc. A class is created inside a document. There's a class tab in the edit view of a document. * An Object is the instantiation of a Class in a document. This means that several documents can all instantiate the same class but have different values of the class properties. When you edit a document there's an Object tab that allows you to view all existing objects associated with a document and modify their properties values or add new objects. * A classsheet is some generic code to display the content of an object. Classsheets are meant to be used by being included in a document containing an instance of the object they're meant to display. The include is done using #includeInContext("classsheet name"). * A classtemplate is simply an "empty" page that already has the include to the classsheet and an object added. It's meant to be used in forms and be copied when user ask to create a new document easily. The 2 important core concepts are classes and objects. The rest (i.e. classsheet and classtemplates) are just easy ways to display object content and create new documents. Hope it helps, -Vincent
Hi Roopesh, On Aug 10, 2007, at 4:31 PM, Roopesh P Raj wrote: [snip]
Documentation is done by the community, i.e. people like you. I agree it's a little bit disappointing that lots of users do not participate more to documentation since they get a software for free, ask a lot of questions and when they get their answers they don't even bother to reinject their knowledge into the documentation for the benefit of others. I hope you're not like these users! :) I have some small suggestions : One is can we have some logical structure in place, say, empty links, which others can edit and add content to it. For example, one of those can be, Search tips: people can add different scenarios and the queries that apply in that scenario.
I'm ok with this for some special pages. But not for all pages. It's a double-edged sword. I think it's important that xwiki.org offers a professional view of XWiki. If we have empty links everywhere, it doesn't look "finished" (and btw people mistakenly follow the link and save the empty page thereafter leading to confusion for other users who don't understand why there's an empty page!) Search tips is a good idea? Where would you see this page located on xwiki.org?
Another is to classify the FAQ into proper sections. There are a whole lot of information in the mailing list which can make way to FAQs so that a new comer will be at ease. If structured properly, FAQ will be of much use, I guess.
yes, that would be nice. Any idea of how to do this?
Another is a tutorial more elaborate than the current FAQ tutorial. A mini application which will give a new comer a feel of what can be done using xwiki.
Like this: http://jira.xwiki.org/jira/browse/XWIKI-732 ? :) So who's doing it? :) Thanks -Vincent
On 8/9/07, Frank Misa <[email protected]> wrote:
Hi All,
I'm really disappointed by the lack of in depth XWiki developer tutorial. XWiki has been around for a while -- and the only good material I can find is here: http://www.xwiki.org/xwiki/bin/view/DevGuide/FAQTutorial http://www.xwiki.org/xwiki/bin/view/DevGuide/CreatingPlugins
The above links are the level of tutorial I'm looking for -- but they don't go far/long enough.... I've followed the FAQTutorial steps and cannot get the example to work as described.
I've performed all steps as described -- without error/warning -- but when I try to create a new custom FAQ document -- my class properties (question & answer) are not being shown on the edit/creation page ? It's just blank space with two rows of Cancel/Save-Continue/Save-View etc buttons.
* I'm using XWIKI: 1.1-milestone-3.3933 * On Windows XP with Apache Tomcat 5.5.12 * I'm using MySQL as the database - I think it's UTF8 - Server version: 5.0.13-rc-nt
1) When I'm querying the database -- the tables: xwikiproperties - is being populated -- but newly added entries seem to have negative values for XWO_ID column.
This is normal. XWO_ID can be any number, not necessarily positive or consecutive.
xwikiobjects - is being populated -- but newly added entries seem to have negative values for XWO_ID column.
The same as above.
xwikiclasses - is empty ? why ?
We don't use this anymore, because the classes/properties were very fragile at the moment, with many new properties, and it was easy to forget to update the mapping files. Thus, all the classes are stored in the xwikidoc table, as XML.
2) I would be very grateful to a link to some decent tutorial/documentation -- even if I have to pay for it...
Me too, me too... We lack documentation, and we know it, and this is why we lose many users.
It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/Properties are actually related.... I can't believe this stuff isn't better documented :(
Hope someone can help me out... Thanks Frank
Sergiu -- http://purl.org/net/sergiu
Hi Vincent, Just got back from vacation -- sorry for the long delay..... I'd like to pickup where we left off. As you know -- I've followed your suggestions -- but I'm still getting the same error. I've placed the PDF file on a public server as you requested. I've taken screen shots of every step of a simple document type and instance creation scenario..... Please see: http://206.130.58.54/xwikiHelp/XWikiHowToHelp.pdf I'd really appreciate some feedback -- I'm asking very basic questions I think -- hope you can help me get past go with XWiki. Thanks Frank From: [email protected] Date: Sat, 11 Aug 2007 22:05:22 +0200 To: [email protected] Subject: Re: [xwiki-users] Authoring templates and design sheets not working for custom class On Aug 9, 2007, at 9:43 PM, Frank Misa wrote: Hi All,[snip]2) I would be very grateful to a link to some decent tutorial/documentation -- even if I have to pay for it... It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/Properties are actually related.... I can't believe this stuff isn't better documented :( Yep we need to rewrite that tutorial on Class/Object/Templates/Classsheets. Would be great if you can help.Here's a short version:* Classes contain definition of a concept. A definition is made of properties. A property can be a string, a text area, a combo box, a radio button choice, etc. A class is created inside a document. There's a class tab in the edit view of a document.* An Object is the instantiation of a Class in a document. This means that several documents can all instantiate the same class but have different values of the class properties. When you edit a document there's an Object tab that allows you to view all existing objects associated with a document and modify their properties values or add new objects.* A classsheet is some generic code to display the content of an object. Classsheets are meant to be used by being included in a document containing an instance of the object they're meant to display. The include is done using #includeInContext("classsheet name").* A classtemplate is simply an "empty" page that already has the include to the classsheet and an object added. It's meant to be used in forms and be copied when user ask to create a new document easily.The 2 important core concepts are classes and objects. The rest (i.e. classsheet and classtemplates) are just easy ways to display object content and create new documents.Hope it helps,-Vincent _________________________________________________________________ Discover the new Windows Vista http://search.msn.com/results.aspx?q=windows+vista&mkt=en-US&form=QBRE
Hi Franck, On Sep 5, 2007, at 4:39 PM, Frank Misa wrote:
Hi Vincent,
Just got back from vacation -- sorry for the long delay..... I'd like to pickup where we left off.
As you know -- I've followed your suggestions -- but I'm still getting the same error.
I've placed the PDF file on a public server as you requested. I've taken screen shots of every step of a simple document type and instance creation scenario..... Please see: http://206.130.58.54/xwikiHelp/XWikiHowToHelp.pdf
I'd really appreciate some feedback -- I'm asking very basic questions I think -- hope you can help me get past go with XWiki.
Slide 2: When you click on "Create this class" button, it creates an new document with the space and name provided and add some boilerplate content to it. So: * yes it"s just a document * there's no class data created at this point * a document can have only one class but it can have many objects * a document belongs to only one space Slide 3: Spaces have a main page called WebHome. If none exist then the space name is shown with a question mark. See http:// www.xwiki.org/xwiki/bin/view/UserGuide/Spaces Slides 4, 5, 6, 7: ok Slide 7: yes this is the page to include in topic #includeInTopic() Slide 8: IMPORTANT: You have made a mistake in that page. You must have: WhatAmIMissingSpace.WhatAmIMissingDocClass. There's no WhatAmIMissingDoc document! Slides 9, 10: ok Slide 11: On the WhatAmIMissingDocClass document you'll see a warning box saying "The template does not have an object of class WhatAmIMissingDocClass. Click here to add it.". Simply click on "here" to add the object. Yes it could be improved in the future. Slide 12: will work fine when you correct slide 8... :) So what you're missing is that it should be WhatAmIMissingDocClass and NOT WhatAmIMissingDoc which is a document that doesn't exist... Thanks -Vincent
From: [email protected] Date: Sat, 11 Aug 2007 22:05:22 +0200 To: [email protected] Subject: Re: [xwiki-users] Authoring templates and design sheets not working for custom class
On Aug 9, 2007, at 9:43 PM, Frank Misa wrote:
Hi All,
[snip]
2) I would be very grateful to a link to some decent tutorial/ documentation -- even if I have to pay for it... It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/ Properties are actually related.... I can't believe this stuff isn't better documented :(
Yep we need to rewrite that tutorial on Class/Object/Templates/ Classsheets. Would be great if you can help.
Here's a short version:
* Classes contain definition of a concept. A definition is made of properties. A property can be a string, a text area, a combo box, a radio button choice, etc. A class is created inside a document. There's a class tab in the edit view of a document.
* An Object is the instantiation of a Class in a document. This means that several documents can all instantiate the same class but have different values of the class properties. When you edit a document there's an Object tab that allows you to view all existing objects associated with a document and modify their properties values or add new objects.
* A classsheet is some generic code to display the content of an object. Classsheets are meant to be used by being included in a document containing an instance of the object they're meant to display. The include is done using #includeInContext("classsheet name").
* A classtemplate is simply an "empty" page that already has the include to the classsheet and an object added. It's meant to be used in forms and be copied when user ask to create a new document easily.
The 2 important core concepts are classes and objects. The rest (i.e. classsheet and classtemplates) are just easy ways to display object content and create new documents.
Hope it helps, -Vincent
Discover the new Windows Vista Learn more!
That was it Vincent.... it worked !! Thanks very much ;) OK -- Ball is in my court now... I'll try to record the "wink" screen-cast video (draft version) and forward to you early next week..... I've never used wink before -- hope it's easy.... Once I have my trial run-through recorded..... I'll ask you a couple more questions. Maybe it's just me -- but the data model does not seem very intuitive ? even for someone that has been programming OO for a while.... I still have some questions regarding the: 1) relationship of class/sheet/template and how they relate to xwikidoc/xwikiobjects tables.... why hasn't xwikiclasses table been removed ? it's never used.... how are class/object properties stored ? 2) relationship of XWiki.TagClass and the various SpaceX.ClassX entries in the xwikiobjects table.... 3) beyond $doc, $context, $xwiki -- any documentation on what other velocity context variables are available to me? BUT...let me get you that video you requested first..... Talk Soon Thanks Cheers Frank CC: [email protected] From: [email protected] Subject: Re: [xwiki-users] Authoring templates and design sheets not working for custom class Date: Wed, 5 Sep 2007 23:06:21 +0200 To: [email protected] Hi Franck, On Sep 5, 2007, at 4:39 PM, Frank Misa wrote:Hi Vincent,Just got back from vacation -- sorry for the long delay.....I'd like to pickup where we left off.As you know -- I've followed your suggestions -- but I'm still getting the same error.I've placed the PDF file on a public server as you requested. I've taken screen shots of every step of a simple document type and instance creation scenario.....Please see:http://206.130.58.54/xwikiHelp/XWikiHowToHelp.pdfI'd really appreciate some feedback -- I'm asking very basic questions I think -- hope you can help me get past go with XWiki.Slide 2: When you click on "Create this class" button, it creates an new document with the space and name provided and add some boilerplate content to it. So:* yes it"s just a document* there's no class data created at this point* a document can have only one class but it can have many objects* a document belongs to only one spaceSlide 3: Spaces have a main page called WebHome. If none exist then the space name is shown with a question mark. See http://www.xwiki.org/xwiki/bin/view/UserGuide/SpacesSlides 4, 5, 6, 7: okSlide 7: yes this is the page to include in topic #includeInTopic()Slide 8: IMPORTANT: You have made a mistake in that page. You must have: WhatAmIMissingSpace.WhatAmIMissingDocClass. There's no WhatAmIMissingDoc document!Slides 9, 10: okSlide 11: On the WhatAmIMissingDocClass document you'll see a warning box saying "The template does not have an object of class WhatAmIMissingDocClass. Click here to add it.". Simply click on "here" to add the object. Yes it could be improved in the future.Slide 12: will work fine when you correct slide 8... :)So what you're missing is that it should be WhatAmIMissingDocClass and NOT WhatAmIMissingDoc which is a document that doesn't exist...Thanks-VincentFrom: [email protected]: Sat, 11 Aug 2007 22:05:22 +0200To: [email protected]: Re: [xwiki-users] Authoring templates and design sheets not working for custom classOn Aug 9, 2007, at 9:43 PM, Frank Misa wrote:Hi All,[snip]2) I would be very grateful to a link to some decent tutorial/documentation -- even if I have to pay for it...It would be great to see something along the lines of the "FAQTutorial" but with more indepth look at available Velocity objects/macros and discussion of how Documents/Classes/Objects/Properties are actually related....I can't believe this stuff isn't better documented :(Yep we need to rewrite that tutorial on Class/Object/Templates/Classsheets. Would be great if you can help.Here's a short version:* Classes contain definition of a concept. A definition is made of properties. A property can be a string, a text area, a combo box, a radio button choice, etc. A class is created inside a document. There's a class tab in the edit view of a document.* An Object is the instantiation of a Class in a document. This means that several documents can all instantiate the same class but have different values of the class properties. When you edit a document there's an Object tab that allows you to view all existing objects associated with a document and modify their properties values or add new objects.* A classsheet is some generic code to display the content of an object. Classsheets are meant to be used by being included in a document containing an instance of the object they're meant to display. The include is done using #includeInContext("classsheet name").* A classtemplate is simply an "empty" page that already has the include to the classsheet and an object added. It's meant to be used in forms and be copied when user ask to create a new document easily.The 2 important core concepts are classes and objects. The rest (i.e. classsheet and classtemplates) are just easy ways to display object content and create new documents.Hope it helps,-VincentDiscover the new Windows Vista Learn more! _________________________________________________________________ Invite your mail contacts to join your friends list with Windows Live Spaces. It's easy! http://spaces.live.com/spacesapi.aspx?wx_action=create&wx_url=/friends.aspx&...
participants (4)
-
Frank Misa -
Roopesh P Raj -
Sergiu Dumitriu -
Vincent Massol