Wiki source code of Creating a FAQ Application

Version 89.1 by Vincent Massol on 2017/01/17

version	line-number	content
52.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
1.1	4
83.1	5	This tutorial will show you how to build a Frequently Asked Questions (FAQs) [[Application>>platform:Features.Applications]] much like the one you can find on the [[FAQ page>>xwiki:FAQ.WebHome]]. 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.
1.1	6
80.1	7	= Prerequisites for following the tutorial =
54.2	8
	9	You should have [[installed XWiki>>AdminGuide.Installation]] and have a [[basic understanding of how to use it>>Features.WebHome]].
	10
54.3	11	All through this tutorial you should refer to the [[XWiki Data Model>>DevGuide.DataModel]] for information on XWiki's data model. You might also use the [[XWiki Scripting Guide>>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.
	12
48.2	13	= Application Overview =
1.1	14
42.1	15	The FAQ application allows users to post a question by entering the question into a simple form field and then submitting the form. The question then appears in a list along with all other questions that have been previously posted. Users can click on the questions to view both the question and answer in a consistently styled view. If the question has not yet been answered, any user can post an answer to the question by editing the page. In edit mode, the page will display a web form that is the same for every FAQ page.
1.1	16
80.1	17	Let us begin by taking a look at what we are going to build. The new application will have the following views:
1.1	18
84.1	19	* The FAQ [[Class>>xwiki:FAQ.WhatIsAClass]]
80.1	20	{{image reference="FAQsSummary.png"/}}
84.1	21	* An FAQ entry in View mode
80.1	22	{{image reference="FAQSheetView.PNG"/}}
84.1	23	* An FAQ entry in Edit mode
80.1	24	{{image reference="FAQSheetEdit.PNG"/}}
1.1	25
48.2	26	= Authoring Templates and Page Design Sheets =
48.1	27
14.1	28	An Authoring Template is a template for creating documents of a specific type. Unlike a regular content page in edit mode with one field for freeform editing, an Authoring Template presents a custom set of form fields for creating a document with specific type of data. These form elements are defined by the properties of a class.
1.1	29
48.1	30	In object oriented programming, remember that a //class// is a template for an object. Using the analogy of a cookie cutter, the //class// is the //cookie cutter// and the //objects// are the actual //cookies//. An Authoring Template provides one way to represent a class visually so that users can fill out a form to set unique properties (values in form fields). When the user submits the form, they are creating a unique //object// of the //class// type.
1.1	31
14.1	32	Precisely, an Authoring Template is a prototype document used to create other specific instances of documents of the same type, along with a method of exposing the creation process to the user: the properties edit form. Remember that a XWiki Document can contain objects and this is the case of an authoring template: it is a XWiki Document with an empty object of a specific class, which is duplicated to create more and more documents based on that model, using the data inserted by the user in the editing form as specific values for the particular object instance in the current copy.
1.1	33
31.6	34	The Page Design Sheet is like a style sheet that defines what each document will look like when rendered. Even though the unique object instances will have different values for their properties, they will always have a consistent presentation display because they will be rendered through the Page Design Sheet. The XWiki API available in scripting languages provides a mechanism that will help us use the same sheet for both editing and view modes. We will see how we can achieve this once we get to the FAQ Design Sheet section.
1.1	35
48.2	36	= Go to the Class Editor Wizard =
31.6	37
62.2	38	Five pages, which collectively make up a [[XClass application>>extensions:Extension.XClass Application]] (a.k.a Class Wizard or Class Editor Wizard), have been developed to assist you in this process. Those page are technical pages hidden by default. To navigate to the wizard home page, go to your profile page, select the Preferences tab, edit the page and choose to view Hidden Documents. Enter a search query for the keyword "XWikiClasses". This should return a document called ##XWikiClasses## in the ##XWiki## space (i.e. ##XWiki.XWikiClasses##). This is the homepage of the class wizard creator: you are now ready to start building your FAQs application.
1.1	39
48.2	40	= Create the FAQ Class =
1.1	41
84.3	42	* On the Class Editor wizard entry page (XWiki.XWikiClasses), under the heading "Create a new data type", in the "Title" field, enter ##FAQ## as the name of the page to create:(((
	43	{{image reference="CreateANewClass1.png"/}}
48.4	44	)))
84.3	45	* As you can see in the Breadcrumb below the new page will be created at location ##XWiki > FAQ##. Now it would be nice to have it created in a new location such as ##FAQ > FAQ##. Since the ##FAQ## 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 ##FAQ##:(((
	46	{{image reference="CreateANewClass2.png"/}}
	47	)))
	48	* In technical terms you're creating a page named ##FAQ## located in a space also called ##FAQ## and the reference is ##FAQ.FAQ##.
80.1	49	* Click the "Create this Class" button. You should then see a page with the following content:(((
48.1	50	{{code language="none"}}
41.1	51	{{velocity}}
60.6	52	## Replace the default space with the space where you want your documents to be created.
41.1	53	## Replace the default parent with the one of your choice and save the document.
	54	##
60.6	55	#set($defaultSpace = $doc.space)
	56	#set($defaultParent = $doc.fullName)
41.1	57	{{/velocity}}
48.1	58	{{/code}}
48.4	59	)))
14.1	60
80.1	61	In the code, change the word "$doc.space" with the name of the space where you want you FAQ pages to be created as the commented instructions in the page code suggest.
	62	The line of code should look like this:
1.1	63
52.1	64	{{code language="none"}}
	65	#set($defaultSpace = 'FAQ')
	66	{{/code}}
14.1	67
80.1	68	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.
	69	The line of code should look like this:
1.1	70
52.1	71	{{code language="none"}}
	72	#set($defaultParent = 'FAQ.WebHome')
	73	{{/code}}
1.1	74
42.1	75	Click the "Save & View" button. The class is now created and you should be looking at a page titled "Class: FAQ" that looks like this:
28.1	76
80.1	77	{{image reference="FAQClass1.PNG"/}}
29.1	78
48.2	79	= Add Properties to the Class =
1.1	80
48.3	81	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!
1.1	82
80.1	83	* Click on the 'class editor' link
	84	* Note that the link trail in the header is something like "Wiki Home / XWiki Space / Data types / FAQ Class". This shows you that you are indeed on the FAQ class page in Class edit mode.
1.1	85
80.1	86	In our document, we'll store both a //question// and an //answer//. So we need to create a property for eachof them.
1.1	87
80.1	88	* Enter the text //question// in the "name" field
	89	* Choose a TextArea type for the property and then click on "Add". The TextArea will ultimately give us a multi-line text field in our authoring template.(((
	90	{{image reference="AddQuestionProperty.PNG"/}}
48.4	91	)))
80.1	92	* Click on the "+" icon to expand the options for the newly created property
	93	* Change the value of the "Pretty Name" field to "Question"(capital Q):(((
	94	{{image reference="QuestionProperty.PNG"/}}
48.4	95	)))
80.1	96	* Now create another property called //answer// the same way that you did for the previous "question" property (choose TextArea for the property type)
	97	* Expand it from the property list and change the value of the "Pretty Name" field to "Answer"
	98	* When you are done adding and configuring the properties, click the "Save & View" button
1.1	99
48.2	100	= Create the Page Design Sheet =
1.1	101
52.1	102	* After the previous step you are now on the FAQClass page which should look like this:(((
80.1	103	{{image reference="FAQClass2.PNG"/}}
48.4	104	)))
80.1	105	* 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.
44.1	106	* Click on "View the sheet document"
83.1	107	* Edit that page in Object mode (make sure your user is an [[Advanced user>>platform:Features.PageEditing\|\|anchor="HAdvancedMode"]])
80.1	108	* Add a XWiki.SheetClass object to the page
48.1	109	Adding the XWiki.SheetClass object is important. It's because of this object that users will be sent to form edition mode when editing FAQ entries**
44.1	110	* Click "Save & View"
52.1	111	* If you edit the page in wiki mode, you will see the following code:(((
48.1	112	{{code language="none"}}
41.1	113	{{velocity}}
	114	## You can modify this page to customize the presentation of your object.
	115	## At first you should keep the default presentation and just save the document.
14.1	116
41.1	117	#set($class = $doc.getObject('FAQ.FAQClass').xWikiClass)
12.1	118	#foreach($prop in $class.properties)
41.1	119	; $prop.prettyName
	120	: $doc.display($prop.getName())
12.1	121	#end
41.1	122	{{/velocity}}
48.1	123	{{/code}}
52.1	124	)))Let's take a moment now and analyze this code:
14.1	125
42.1	126	* The first line retrieves the FAQ.FAQClass from the wiki
	127	* Then we iterate through all its properties and display their values for the current document in a definition list.
	128
80.1	129	As we mentioned, XWiki provides a mechanism that helps us create sheets used for both View and Edit mode.
	130	This is the display function used in the line:
48.1	131
83.1	132	{{code language="none"}}
	133	: $doc.display($prop.getName())
	134	{{/code}}
48.1	135
80.1	136	It detects the current mode (Edit or View) and displays the property referenced by its argument as the mode dictates:
	137
42.1	138	* In view mode it will display the value of the property
	139	* In edit mode it will display a form field that will allow the user to edit it
	140
48.1	141	This way we can use a single Design Sheet to both display and edit our FAQ entries. See the [[XWiki API reference>>DevGuide.API]] and [[XWiki Scripting>>DevGuide.Scripting]] pages for more details about this.
42.1	142
	143	* Click "Save & View"
	144
82.1	145	== Bind the Class to the Sheet ==
	146
80.1	147	Next, we neet to bind our class document (FAQ.FAQClass) to this new sheet (FAQ.FAQSheet):
83.1	148
80.1	149	* Edit FAQ.FAQClass in Object mode and add a new object of type XWiki.ClassSheetBinding
	150	* Type in FAQSheet inside the field
	151	* Save & View
	152
48.2	153	= Create the Authoring Template =
1.1	154
52.1	155	* Click on "FAQClass" in the breadcrumb. The document should look like this:(((
80.1	156	{{image reference="FAQClass3.PNG"/}}
48.4	157	)))
80.1	158	* Notice that now there is a link for the FAQSheet instead of the button that was previously there
	159	* Click on the "Create the document template" button. The Authoring Template will be automatically created.
1.1	160
80.1	161	Note that we changed the space name preceding the page name also because we want all of our FAQ pages to reside in the same XWiki space
	162	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 FAQs documents and will execute the Design Sheet code in the context of the current document. See the [[dedicated page>>DevGuide.IncludeInVelocity]] for more information regarding this technique.
42.1	163	Now we need to associate the prototype object with this document to turn it into a true authoring template.
	164
	165	* If you're on the template page, click on "FAQClass" in the breadcrumb to get back to the FAQ Class page
	166	* At the bottom of the page, look for the following error message: "The template does not contain an object of type FAQClass. Add a FAQ object to the template »."
80.1	167	* Click on "Add a FAQ object to the template »":(((
	168	{{image reference="FAQObject.png"/}}
	169	)))
83.1	170
	171	Next we need to remove the title for the newly created template:
	172
	173	* Navigate to FAQ.FAQTemplate
	174	* Edit this document in Wiki mode
	175	* Inside the Title field you have "FAQ Template" written -> delete this text
	176	* Save & View
	177
	178	This step is needed so that all of our future entries don't have "FAQ Template" as their title.
	179
	180	Congratulations: you just created an Authoring Template! You're almost done now.
80.1	181	{{image reference="FAQClass4.PNG"/}}
52.1	182
48.2	183	= Create a home page for the FAQ application =
38.1	184
42.1	185	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.
80.1	186	We need to create the FAQ.WebHome page
1.1	187
80.1	188	* Click on "FAQClass" in the breadcrumb
	189	* Click on the "+ Add" green button
	190	* Choose FAQ as the "Space name" and type WebHome for the "Page name" field
	191	* Click "Create"
	192	* Type in the title "FAQs" in the title field
	193	* Click "Save & View"
1.1	194
48.2	195	== Displaying existing FAQ entries ==
1.1	196
80.1	197	You have 2 options when it comes to displaying existing FAQ entries:
55.2	198
80.1	199	1. Use the livetable component
	200	1. Write custom code in order to display them
	201
55.2	202	=== Using the Livetable component ===
	203
	204	In this section, we will show how to use the [[Livetable Macro>>extensions:Extension.Livetable Macro]] to display the existing questions and answers.
	205
56.1	206	The livetable component will give users the ability to easily list and filter through existing FAQ documents. The macro is made of 3 parts:
	207
	208	* 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
	209	* 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
	210	* 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)
	211
	212	Here is the resulting code:
	213
	214	{{code language="none"}}
	215	{{velocity}}
55.2	216	#set($columns = ["question", "doc.creationDate", "_actions"])
	217	#set($columnsProperties = {
	218	"question" : { "type" : "text", "link" : "view", "html" : "true", "sortable":true },
56.1	219	"_actions" : {"actions": ["edit","delete"]}
55.2	220	})
	221	#set($options = {
	222	"className":"FAQ.FAQClass",
	223	"translationPrefix" : "faq.",
	224	"tagCloud" : true,
	225	"rowCount": 10
	226	})
	227	#livetable("faq" $columns $columnsProperties $options)
57.1	228	{{/velocity}}
55.2	229	{{/code}}
	230
80.1	231	* Copy this code and paste it as Wiki content inside FAQ.WebHome
56.1	232	* Click "Save and View"
	233	* New FAQ entries will now be displayed on the page once you create them
	234
80.1	235	The FAQ.WebHome page should look similar to this:
	236
	237	{{image reference="FAQsLivetable.png"/}}
	238
	239	Notice how there are some translation keys displayed inside the livetable.
	240	Let's create a translations document and change those keys to actual text:
83.1	241
80.1	242	* Create a new page inside the FAQ space called Translations
	243	* Edit it in Wiki mode and paste this content inside:(((
	244	{{code language="none"}}
	245	faq.question=Question
	246	faq.doc.creationDate=Creation Date
	247	faq._actions=Actions
83.1	248	{{/code}}
	249	)))
80.1	250	* Save & View
	251	* Edit FAQ.Translations in Object mode and add a new XWiki.TranslationDocumentClass object
	252	* Save & View again
	253
	254	Now the FAQ.WebHome page should look like this (notice the translations instead of the keys):
	255
	256	{{image reference="FAQsLivetableWithTranslations.png"/}}
	257
55.2	258	=== Using custom code ===
	259
42.1	260	You will need to write the following code:
1.1	261
42.1	262	* A HQL query that will find all your FAQ documents
	263	** The HQL query looks for all documents that have a FAQ.FAQClass object other than the template
	264	** If no document has been created yet, a warning message is displayed
59.2	265	* A piece of velocity code to display all those documents
42.1	266	** The velocity code loops in that list
	267	** For each item, the full document is loaded in memory so that values can be retrieved from it
	268	** For each document, the question is retrieved and displayed as a link towards the FAQ entry
1.1	269
80.1	270	Here is the resulting code:
1.1	271
48.1	272	{{code language="none"}}
42.1	273	= Existing FAQ entries =
1.1	274
42.1	275	{{velocity}}
50.1	276	#set($sql = ", BaseObject as obj where obj.name = doc.fullName and obj.className = 'FAQ.FAQClass' and obj.name <> 'FAQ.FAQTemplate'")
42.1	277	#set($results = $xwiki.searchDocuments($sql))
	278	#if($results.empty)
49.1	279	No FAQ has been created yet!
42.1	280	#else
49.1	281	#foreach ($item in $results)
	282	#set($faq = $xwiki.getDocument($item))
51.1	283	* [[${faq.display("question").replace("<p>", "").replace("</p>", "")}>>${item}]]
49.1	284	#end
42.1	285	#end
	286	{{/velocity}}
48.1	287	{{/code}}
1.1	288
80.1	289	* Copy this code and paste it as Wiki content inside FAQ.WebHome
42.1	290	* Click "Save and View"
	291	* New FAQ entries will now be displayed on the page once you create them
1.1	292
80.1	293	The FAQ.WebHome page should look similar to this:
	294
	295	{{image reference="FAQsCustomCode.png"/}}
	296
48.2	297	== Creating new FAQ entries ==
1.1	298
80.1	299	There are 2 ways for you to let your users create new FAQ entries:
83.1	300
80.1	301	1. Declare the FAQ as a template
	302	1. Add a custom creation form
14.1	303
55.1	304	=== Using a Template ===
	305
83.1	306	You will have to define a template provider [[as explained on this page>>extensions:Extension.Administration Application\|\|anchor="HCreatethetemplateprovider"]]
55.1	307
80.1	308	Go to your wiki's administration interface, in the "Templates" section (Administration -> Content -> Templates). Create a new template provider in the "FAQ" space and name it "FAQTemplateProvider"
55.1	309
	310	You can then use the following values:
	311
	312	* Provider name: "FAQ Template Provider"
	313	* Template name "New FAQ entry"
60.8	314	* Template to use: "FAQ.FAQTemplate"
55.1	315
80.1	316	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.
55.1	317
	318	=== Custom creation form ===
	319
	320	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:
	321
42.1	322	* The first part of the code checks whether the page has a parameter. If so:
	323	** The name of the document that will be created is computed
	324	** A check is done to verify the document doesn't exist yet
	325	** If everything's ok, the user is sent to the new document in inline edition mode
	326	* The second part of the code is the actual FAQ creation form
	327	** It builds the name of the document to create it in the "FAQ" space
	328	** It sets the document parent as being the current document
	329	** It defines the template to use to create the new document
1.1	330
48.1	331	{{code language="none"}}
42.1	332	{{velocity}}
	333	#if("$!request.docName" != '')
	334	## Request for creating a new instance
62.1	335	#set($docName = ${request.docName})
47.1	336	#set($targetDocName = "${request.spaceName}.${docName}")
62.1	337	#if(!$xwiki.exists($targetDocName) && $xwiki.hasAccessLevel('edit', $xcontext.user, $targetDocName))
61.1	338	$response.sendRedirect($xwiki.getURL($targetDocName, 'inline', "template=${escapetool.url($request.template)}&parent=${escapetool.url($request.parent)}"))
42.1	339	## Stop processing, since we already sent a redirect.
	340	#stop
	341	#end
	342	#end
1.1	343
42.1	344	= Add a new question =
	345
	346	#if("$!targetDocName" != '' && $xwiki.exists($targetDocName))
	347	{{warning}}The target document already exists. Please choose a different name, or [[view the existing document>>$targetDocName]]{{/warning}}
	348	#elseif("$!targetDocName" != '')
	349	{{warning}}You don't have permission to create that document{{/warning}}
	350	#end
	351
	352	{{html}}
	353	<form action="" id="newdoc" method="post">
	354	<div>
	355	<input type="hidden" name="parent" value="${doc.fullName}"/>
	356	<input type="hidden" name="template" value="FAQ.FAQTemplate"/>
	357	<input type="hidden" name="sheet" value="1"/>
	358	<input type="hidden" name="spaceName" value="FAQ"/>
	359	Document: <input type="text" name="docName" value="Enter your question here" class="withTip" size="50"/>
	360	<span class="buttonwrapper"><input type="submit" value="Create this FAQ" class="button"/></span>
	361	</div>
	362	</form>
	363	{{/html}}
	364	{{/velocity}}
48.1	365	{{/code}}
1.1	366
80.1	367	* Copy this code and paste it as Wiki content inside FAQ.WebHome, below the code that's already there
42.1	368	* Click "Save and View"
80.1	369	* A form to create new FAQ entries is now available on the page:(((
	370	{{image reference="FAQsWithForm.png"/}}
	371	)))
14.1	372
48.2	373	= Test the Application =
27.1	374
80.1	375	Now let's just create a new document in our application to test it out.
	376	If you previously chose to use a "Custom creation form" for creating new FAQ entries, follow these steps:
42.1	377
80.1	378	* Go to FAQ.WebHome
	379	* Below the "Add a new question" header, enter a question (which will also be used as the document title) in the //Document// field
	380	* Click //Create this FAQ//
52.1	381	* You can then enter your question in longer form using the //Question// field on the template, like this:(((
80.1	382	{{image reference="FAQSheetEdit.PNG"/}}
48.4	383	)))
52.1	384	* Click //Save & View// and then you will see the newly created document, like this:(((
80.1	385	{{image reference="FAQSheetView.PNG"/}}
48.4	386	)))
80.1	387	* Go back to the "FAQ.WebHome" page to see the list of existing questions(((
	388	{{image reference="FAQsWithEntry.png"/}}
	389	)))
42.1	390
48.2	391	= Conclusion =
1.1	392
80.1	393	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.
	394	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.
1.1	395
	396	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.

Wiki source code of Creating a FAQ Application

Quick Links

Let us know

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected