Skip to Content

Version 18.1 by Andy Tripp on 2020/06/10
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 This tutorial will show you how to build a Contact Manager application.  It's very similar to the [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] tutorial. The only difference (so far) is that the FAQ tutorial involves a very trivial object: a FAQ object contains just two things: a "question" and an "answer", while this example uses a Person object that has more properties ("name", "age", "sex", etc.) .This is a very simple application that makes use of XWiki's [[classes, properties, and objects>>platform:DevGuide.DataModel||anchor="HXWikiClasses2CObjects2CandProperties"]]. It also uses a technique that you may frequently use as the basis for several different kinds of applications.
6
7 Also, this tutorial explains things a little differently than the FAQ tutorial. If something here doesn't make sense to you, try going through the FAQ tutorial and maybe it will make more sense.
8
9 = Prerequisites for following the tutorial =
10
11 You should have [[installed XWiki>>platform:AdminGuide.Installation]] and have a [[basic understanding of how to use it>>platform:Features.WebHome]].
12
13 All through this tutorial you should refer to the [[XWiki Data Model>>platform:DevGuide.DataModel]] for information on XWiki's data model. You might also use the [[XWiki Scripting Guide>>platform:DevGuide.Scripting]] to get you started with scripting in XWiki and manipulating XWiki objects. In addition, this tutorial will introduce the concepts of Authoring Templates and Page Design Sheets, patterns that you will find particularly useful in creating XWiki applications. Completing this tutorial is a recommended prerequisite for anyone who wants to build custom applications on the XWiki engine. And by "custom application", we mean a huge variety of web applications.
14
15 {{warning}}
16 Make sure that your user is an [[Advanced user>>platform:Features.PageEditing||anchor="HAdvancedMode"]] before following this tutorial since you'll need for example to use the wiki editor (##Wiki > Edit## menu).
17 {{/warning}}
18
19 = Application Overview =
20
21 The Person Manager application will allow users to create a "Person object" by entering data (name, age, sex, etc) into a simple form and then submitting the form. Let's sketch out what roughly what those two pages should look like on a "napkin", using [[Balsamiq>>https://balsamiq.com/]]:
22
23 image:personDialog.PNG
24
25 Our page won't look exactly like that, but the point is that a website user can create a Person by filling out a "form" page like this.
26
27 Note all the various types of "widgets" shown here:
28
29 * "name" is a single-line text field
30 * "email" is also a single-line text field, but we'd like it to be validated (e.g. give an error if it doesn't have a "@" in it)
31 * "address" is a multi-line text field
32 * "phone" is a single-line text field (perhaps some validation here, too)
33 * "sex" is a drop-down list
34 * "married" is a checkbox: the only allowed values are "true" and "false"
35 * "image" is actually the name of some image file, but we actually display the image itself. Nice!
36 * "age" is Number field, which looks like a single-line text field, but has validation.
37 * "related people" is one more more links to other web pages. Very nice!
38
39 The Person then appears in a table with all other Person objects that have been previously created. Users can click on the Person in the table to see all the information about the Person. He may also edit that information or delete the Person. The table might look something like this:
40
41 image:personTable.PNG
42
43 When the user clicks on a row in the table, he will get a page that shows the information about the Person, which will look similar to the "Create Person" page, but without the ability to change anything.
44
45 == Objects Overview And Terminology ==
46
47 Next, let's summarize the terminology for "Objects". For full details, see [[Data Model>>https://www.xwiki.org/xwiki/bin/view/Documentation/DevGuide/DataModel/#HXWikiClasses2CObjects2CandProperties]]. There is nothing fancy happening here, but it's important to get our terminology straight.
48
49 A Person is an example of some "Object" or "class". We will use XWiki to define what "properties" are in a "Person" object. For example, we will say that there's a property called "name" of type "String". There's also a property called "age" of type "Number", and an "address" property that's type "TextArea" (a string that can be multiple lines).
50
51 When a user creates a new Person, we call that an "instance" of the "class". So we might say something like "I've created an instance of the Person class, with name 'Joe Smith'". And we would say that our table shows all the instances of the Person class. And instances can not only be created, but also edited or deleted.
52
53 We, the creators of the website, define the "Person" class. We define that once, and we're done. Our users use our website to create, edit, and delete instances of our Person class.
54
55 == Overview Of What We Will Do ==
56
57 In this tutorial, we'll do the following steps:
58
59 * Define our Person class, using the XWiki "Data Types" page.
60 * Specify the properties of our Person class, using the XWiki "Class Editor" page.
61 * Define how a Person instance should be displayed, by creating a "Person Sheet" page.
62 * Create a Template and a Template Provider (whatever they are) for our Person class.
63 * Create a web page that displays a table of people.
64 * Create a web page that displays a Person instance.
65
66 Note that we don't need to define a page for creating or editing a Person, just a page for *displaying* a Person. XWiki will automatically do that for us!
67
68 Once we are done with these steps, our application will be finished. A user of our website can see a page containing the table of Person objects, view the page for an existing person, add a new Person, edit an existing Person, or delete a Person.
69
70 = Go to the Special "Data Types" Page =
71
72 The "Data Types" page is a special XWiki page that lets us define classes like "Person". It'sactually hidden by default. To be "unhide" it, go to your profile page, select the Preferences tab, edit the page and choose to view Hidden Documents.
73
74 To find the "Data Types" page, enter a search query for the keyword "D". This should return a document titled "Data Types".
75
76 = Create the Person Class =
77
78 * On the "Data Types" page, under the heading "Create a new data type", in the "Title" field, enter ##Person## as the name of the page to create:(((
79 {{image reference="personClass.PNG"/}}
80 )))
81 * As you can see in the Breadcrumb below the new page will be created at location ##XWiki > Person##. In practice the "Data Types" page will automatically prefix the page name with ##Class## (you could also enter ##PersonClass## as the page name directly).
82 * Now it would be nice to have it created in a new location such as ##PersonSpace > Person Class##. Since the ##PersonSpace## parent doesn't exist we cannot use the Tree picker button. Thus click the Pencil button as shown in the following image and replace ##XWiki## by ##PersonSpace##.(((
83 {{image reference="personLocation.PNG"/}}
84 )))
85 * In technical terms you're creating a page named ##PersonClass## (with a title of "Person Class") located in a space also called ##PersonSpace## and thus the technical reference is ##PersonSpace.PersonClass##.
86 * Click the "Create this Class" button. You should then see a page with the following content:(((
87 {{code language="none"}}
88 {{velocity}}
89 ## Replace the default space with the space where you want your documents to be created.
90 ## Replace the default parent with the one of your choice and save the document.
91 ##
92 #set($defaultSpace = $doc.space)
93 #set($defaultParent = $doc.fullName)
94 {{/velocity}}
95 {{/code}}
96 )))
97
98 In the code, change the word "$doc.space" with the name of the space where you want your pages to be created: "PersonSpace".
99 The line of code should look like this:
100
101 {{code language="none"}}
102 #set($defaultSpace = 'PersonSpace')
103 {{/code}}
104
105 You can also change the default parent of the new FAQ documents that are going to be created. To do so, replace the "$defaultParent" variable with the name of your document.
106 The line of code should look like this:
107
108 {{code language="none"}}
109 #set($defaultParent = 'PersonSpace.WebHome')
110 {{/code}}
111
112 Click the "Save & View" button. The class is now created and you should be looking at a page titled "Class: Person" that looks like this:
113
114 {{image reference="newPersonClass.PNG"/}}
115
116 = Add Properties to the Class =
117
118 Under the page title, you should see the words "The class does not have any properties yet. You can use the //__class editor__// to define them." Let's just follow those instructions!
119
120 * Click on the 'class editor' link
121 * Note that the link trail in the header is something like "Wiki Home / PersonSpace / Person Class". This shows you that you are indeed on the Person class page in Class edit mode.
122
123 Now, we need to specify all the properties of a Person. Let's have the following properties:
124
125 |=Property Name|=Property Type
126 |name|String
127 |email|EMail
128 |address|TextArea
129 |phone|String
130 |sex|static list
131 |married|Boolean
132 |image|Image
133 |age|Number
134 |relatedPeople|Page (Multiple)
135
136 * Enter the text //name// in the "name" field
137 * Choose "String" for the type of the property and then click on "Add". By using a String type, when a user goes to enter the //name// of a new Person, he will be prompted with a single-line text field.(((
138 {{image reference="name.PNG"/}}
139 )))
140 * Click on the "+" icon to expand the options for the newly created property
141 * Change the value of the "Pretty Name" field to "Name"(capital N). With this done, the user sees the label "Name" rather than "name" when prompted for the name of a Person. This doesn't make a huge difference for this property, but when it comes to the property with the name "relatedPeople", it's nice to show the user something a little more friendy like "Related People". Also, you could later decide to change that label to "Similar People" without actually renaming the property (and thereby probably breaking something).
142 * Now repeat this to add each of the properties shown in the table above.
143 ** Note that the "EMail" type is like a String, except that it has a "Validation Expression" (e.g. to make sure it has an "@" character).
144 ** If we wanted to, we could add a "Validation Expression" to the "phone" property to make sure it's in a particular format.
145 ** For the "sex" property, in the "Display Type" field, enter "Select". This will give the user a drop-down menu.
146 ** As we define the "sex" property as type "static list", we specify the values for the field like this:(((
147 {{image reference="staticList.PNG"/}}
148 )))
149 ** Note that there is no "Image" type. That's unfortunate. Let's just define it as a String here, and deal with that later.
150 ** Note that the "size" of our "age" field is 30 digits. Three digits should be plenty, so feel free to change that.
151 ** For our "relatedPeople" property, we want to allow multiple values, not just one. So find the "Multi Select" checkbox and check it.
152 * When you are done, you should see all your properties like this:(((
153 {{image reference="properties.PNG"/}}
154 )))
155 * When you are done adding and configuring the properties, click the "Save & View" button
156
157 = Create the Page Design Sheet =
158
159 * After the previous step you are now on the FAQClass page which should look like this:(((
160 {{image reference="personClass2.PNG"/}}
161 )))
162 * Click the first button ("Create the document sheet") to create the document sheet (the Page Design Sheet). This sheet determines how your page's objects will be rendered to the user. The document is automatically created.
163 * You should see a warning message with the text "The sheet is not bound to the class so it won't be applied automatically when a page that has an object of this class is displayed". Click the "Bind the sheet to the class" link that appears after the text. Basically, this ties the Person Class to the Person Sheet.
164 * Now click on "View the sheet document". This takes you to the ##PersonSpace.PersonSheet## page which you can edit in wiki mode and see its default content. This content is Velocity code which simply goes through all the properties and displays each one. For example, it will see that our Person class has a "married" property of type "Boolean", and will show a checkbox with a label of "married" (or perhaps "Married" if we specified that as our "pretty name" for the property). See [[Documentation.DevGuide.Tutorials.FAQTutorial.FAQTutorialManual]] for more details about this code. This code is actually very close to working as-is. The only thing that would be ugly is that our "image" property would display as just a String, whereas we probably want to display the image itself, not some URL.
165
166 * Click "Save & View"
167
168 = Create the Authoring Template =
169
170 * Navigate back to the ##PersonSpace.PersonClass## document (you can use the arrows in the breadcrumb to do so).
171 * Click on the "Create the document template" button. The Authoring Template will be automatically created.
172
173 Note that earlier, we changed the space name preceding the page name because we wanted all of our Person pages to reside in a space named PersonSpace. Remember that all our documents will be copies of the Authoring Template used as a prototype so the content will be copied in all our Person documents and will execute the Design Sheet code in the context of the current document. See the [[dedicated page>>platform:DevGuide.IncludeInVelocity]] for more information regarding this technique.
174
175 Now we need to associate the prototype object with this document to turn it into a true authoring template:
176
177 * If you're on the template page, navigate back to the ##PersonSpace.PersonClass## document.
178 * At the bottom of the page, look for the following warning message: "The template does not contain an object of type PersonClass. Add a Person object to the template »."
179 * Click on "Add a Person object to the template »":(((
180 {{image reference="personClass3.PNG"/}}
181 )))
182
183 Next, we want to remove the title for the newly created template:
184
185 * Navigate to the ##PersonSpace.PersonTemplate## document (you can click on the "View the template page (PersonSpace / Person Template)" link for doing that for example.
186 * Edit this document in Wiki mode
187 * Inside the Title field you have "Person Template" written -> delete this text
188 * Save & View
189
190 This step is needed so that all of our future entries don't have "Person Template" as their title.
191
192 Congratulations: you just created an Authoring Template! You're almost done now.
193
194 = Create the Template Provider =
195
196 After the template was created and the object was added, a new section appears with a button to create a template provider to use the existing template.
197 The template provider is created with some default values, but those can be updated to match the needs.
198
199 {{gallery}}
200 image:3-missingTemplateProvider.png
201 image:4-addedTemplateProvider.png
202 image:5-templateProviderView.png
203 {{/gallery}}
204
205
206
207 = Create a home page for the FAQ application =
208
209 You want your users to be able to see a list of all existing questions and answers and to add new questions. The best way to do this is to put the FAQ application in its own space and to use that space's homepage to display existing questions.
210
211 Thus we now need to create the ##FAQ.WebHome## page
212
213 * Click on "FAQ" in the breadcrumb to navigate to ##FAQ.WebHome## and notice that the page doesn't exist.
214 * Edit it in wiki mode
215 * Type in the title "FAQs"
216
217 == Displaying existing FAQ entries ==
218
219 You have 2 options when it comes to displaying existing FAQ entries:
220
221 1. Use the livetable component
222 1. Write custom code in order to display them
223
224 === Using the Livetable component ===
225
226 In this section, we will show how to use the [[Livetable Macro>>extensions:Extension.Livetable Macro]] to display the existing questions and answers.
227
228 The livetable component will give users the ability to easily list and filter through existing FAQ documents. The macro is made of 3 parts:
229
230 * The list of columns: for each entry, we will display the question, the date when it was created and a special column that lets users quickly modify entries
231 * The properties of each column: for each column, we will define how it should be displayed, whether it should link to the entry and whether it should be filterable
232 * The livetable options: those are options related to the display of the livetable (in this case we will to display a tag cloud and 10 rows by default)
233
234 Here is the resulting code:
235
236 {{code language="none"}}
237 {{velocity}}
238 #set($columns = ["question", "doc.creationDate", "_actions"])
239 #set($columnsProperties = {
240     "question" : { "type" : "text", "link" : "view", "html" : "true", "sortable":true },
241     "_actions" : {"actions": ["edit","delete"]}
242 })
243 #set($options = {
244    "className":"FAQ.FAQClass",
245    "translationPrefix" : "faq.",
246    "tagCloud" : true,
247    "rowCount": 10
248 })
249 #livetable("faq" $columns $columnsProperties $options)
250 {{/velocity}}
251 {{/code}}
252
253 * Copy this code and paste it as Wiki content (inside ##FAQ.WebHome##)
254 * Click "Save and View"
255 * New FAQ entries will now be displayed on the page once you create them
256
257 The ##FAQ.WebHome## page should look similar to this:
258
259 {{image reference="FAQsLivetable.png"/}}
260
261 Notice how there are some translation keys displayed inside the livetable. Let's create a translations document and change those keys to actual text:
262
263 * Create a new page inside the FAQ space called Translations, i.e. at ##FAQ.Translations## (using the "+" button)
264 * Edit it in Wiki mode and paste this content inside:(((
265 {{code language="none"}}
266 faq.question=Question
267 faq.doc.creationDate=Creation Date
268 faq._actions=Actions
269 {{/code}}
270 )))
271 * Click "Save & View"
272 * Edit it again in Object mode and add a new ##XWiki.TranslationDocumentClass## object to mark the page as a page containing translations. Make sure to select the right scope. Using "Global" means the translations would be visible to all wikis (and it requires having Programming Rights!) and "Wiki" means it's visible to the current wiki only. Choose "Wiki" as the scope.
273 * Click "Save & View" again
274
275 Now the ##FAQ.WebHome## page should look like this (notice the translations instead of the keys):
276
277 {{image reference="FAQsLivetableWithTranslations.png"/}}
278
279 === Using custom code ===
280
281 You will need to write the following code:
282
283 * A XWQL query that will find all your FAQ documents. Check the [[Query API documentation>>extensions:Extension.Query Module]] to know more about it.
284 ** The XWQL query looks for all documents that have a ##FAQ.FAQClass## object other than the template
285 ** If no document has been created yet, a warning message is displayed
286 * A piece of velocity code to display all those documents
287 ** The velocity code loops in that list
288 ** For each item, the full document is loaded in memory so that values can be retrieved from it
289 ** For each document, the question is retrieved and displayed as a link towards the FAQ entry
290
291 Here is the resulting code:
292
293 {{code language="none"}}
294 = Existing FAQ entries =
295
296 {{velocity}}
297 #set($xwql = "from doc.object(FAQ.FAQClass) as faq where doc.fullName <> 'FAQ.FAQTemplate'")
298 #set($results = $services.query.xwql($xwql).execute())
299 #if($results.empty)
300   No FAQ has been created yet!
301 #else
302   #foreach ($item in $results)
303     #set($faq = $xwiki.getDocument($item))
304     * [[${faq.display("question").replace("<p>", "").replace("</p>", "")}>>${item}]]
305   #end
306 #end
307 {{/velocity}}
308 {{/code}}
309
310 * Copy this code and paste it as Wiki content inside ##FAQ.WebHome##
311 * Click "Save and View"
312 * New FAQ entries will now be displayed on the page once you create them
313
314 The ##FAQ.WebHome## page should look similar to this:
315
316 {{image reference="FAQsCustomCode.png"/}}
317
318 == Creating new FAQ entries ==
319
320 There are 2 ways for you to let your users create new FAQ entries:
321
322 1. Declare the FAQ as a template
323 1. Add a custom creation form
324
325 === Using a Template ===
326
327 You will have to define a template provider [[as explained on this page>>extensions:Extension.Administration Application||anchor="HCreatethetemplateprovider"]]
328
329 Go to your wiki's administration interface, in the "Templates" section (Administration -> Content -> Templates). Create a new template provider in the
330 ##FAQ## space and name it ##FAQTemplateProvider##
331
332 You can then use the following values:
333
334 * Provider name: ##FAQ Template Provider##
335 * Template name: ##New FAQ entry##
336 * Template to use: ##FAQ.FAQTemplate##
337
338 If you'd like, you can restrict FAQ entries so that they're created only in the ##FAQ## space. Once you're done, click "Save & View". Your template is now ready to be used! Users who click on the "Add >> Page" button will now have the option to create a new page using the FAQ template.
339
340 === Custom creation form ===
341
342 If you choose this option, you will need to write some code to let your users create new FAQ entries. To do this, you will have to create a form in which the user can enter the name of the questions she wants to create. Once typed in, the form calls the same page to trigger the new document creation based on the parameters entered by the user:
343
344 * The first part of the code checks whether the page has a parameter. If so:
345 ** The name of the document that will be created is computed
346 ** A check is done to verify the document doesn't exist yet
347 ** If everything's ok, the user is sent to the new document in inline edition mode
348 * The second part of the code is the actual FAQ creation form
349 ** It builds the name of the document to create it in the ##FAQ## space
350 ** It sets the document parent as being the current document
351 ** It defines the template to use to create the new document
352
353 {{code language="none"}}
354 {{velocity}}
355 #if("$!request.docName" != '')
356   ## Request for creating a new instance
357   #set($docName = ${request.docName})
358   #set($targetDocName = "${request.spaceName}.${docName}")
359   #if(!$xwiki.exists($targetDocName) && $xwiki.hasAccessLevel('edit', $xcontext.user, $targetDocName))
360     $response.sendRedirect($xwiki.getURL($targetDocName, 'inline', "template=${escapetool.url($request.template)}&parent=${escapetool.url($request.parent)}"))
361     ## Stop processing, since we already sent a redirect.
362     #stop
363   #end
364 #end
365
366 = Add a new question =
367
368 #if("$!targetDocName" != '' && $xwiki.exists($targetDocName))
369   {{warning}}The target document already exists. Please choose a different name, or [[view the existing document>>$targetDocName]]{{/warning}}
370 #elseif("$!targetDocName" != '')
371   {{warning}}You don't have permission to create that document{{/warning}}
372 #end
373
374 {{html}}
375   <form action="" id="newdoc" method="post">
376     <div>
377       <input type="hidden" name="parent" value="${doc.fullName}"/>
378       <input type="hidden" name="template" value="FAQ.FAQTemplate"/>
379       <input type="hidden" name="sheet" value="1"/>
380       <input type="hidden" name="spaceName" value="FAQ"/>
381       Document: <input type="text" name="docName" value="Enter your question here" class="withTip" size="50"/>
382       <span class="buttonwrapper"><input type="submit" value="Create this FAQ" class="button"/></span>
383     </div>
384   </form>
385 {{/html}}
386 {{/velocity}}
387 {{/code}}
388
389 * Copy this code and paste it as Wiki content inside ##FAQ.WebHome##, below the code that's already there
390 * Click "Save and View"
391 * A form to create new FAQ entries is now available on the page:(((
392 {{image reference="FAQsWithForm.png"/}}
393 )))
394
395 = Test the Application =
396
397 Now let's just create a new document in our application to test it out.
398
399 If you previously chose to use a "Custom creation form" for creating new FAQ entries, follow these steps:
400
401 * Go to ##FAQ.WebHome##
402 * Below the "Add a new question" header, enter a question (which will also be used as the document title) in the //Document// field
403 * Click //Create this FAQ//
404 * You can then enter your question in longer form using the //Question// field on the template, like this:(((
405 {{image reference="FAQSheetEdit.PNG"/}}
406 )))
407 * Click //Save & View// and then you will see the newly created document, like this:(((
408 {{image reference="FAQSheetView.PNG"/}}
409 )))
410 * Go back to the ##FAQ.WebHome## page (you can use the breadcrumbs) to see the list of existing questions(((
411 {{image reference="FAQsWithEntry.png"/}}
412 )))
413
414 = Conclusion =
415
416 This tutorial has taught you how to use the Class Wizard app and it has detailed the concepts of classes, objects and properties and introduced the authoring templates and page design sheets.
417
418 You may also have learned a little bit about Velocity scripting in documents. You can use these basic concepts to build custom applications at the document or presentation layer of XWiki without having to compile or deploy code.
419
420 As always, please take the time to make this document better for other users if you find ways that it can be improved as you read it for the first time.

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected