Wiki source code of Creating a FAQ Application
Version 59.3 by coyote21 on 2013/01/10
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | This tutorial will show you how to build a Frequently Asked Questions (FAQs) Application 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. It also uses a technique that you may frequently use as the basis for several different kinds of applications. | ||
| 6 | |||
| 7 | = Pre Requisites for following the tutorial = | ||
| 8 | |||
| 9 | You should have [[installed XWiki>>AdminGuide.Installation]] and have a [[basic understanding of how to use it>>Features.WebHome]]. | ||
| 10 | |||
| 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 | |||
| 13 | = Application Overview = | ||
| 14 | |||
| 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. | ||
| 16 | |||
| 17 | Let us begin by taking a look at what we are going to build. The system has the following views. Click any view link below to preview a screenshot. (Note: Firefox users can middle click or click down on the mouse scroll-wheel to open the links in a new tab.) | ||
| 18 | |||
| 19 | * [[The FAQs Summary View>>attach:FAQsSummary.png]] | ||
| 20 | * [[A Question and Answer Page in Display Mode>>attach:FAQSheetView.png]] | ||
| 21 | * [[A Question and Answer Page in Edit Mode>>attach:FAQSheetEdit.png]] | ||
| 22 | |||
| 23 | = Authoring Templates and Page Design Sheets = | ||
| 24 | |||
| 25 | 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. | ||
| 26 | |||
| 27 | 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. | ||
| 28 | |||
| 29 | 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. | ||
| 30 | |||
| 31 | 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. | ||
| 32 | |||
| 33 | = Go to the Class Editor Wizard = | ||
| 34 | |||
| 35 | Five pages, which collectively make up a Class Editor Wizard application, have been developed to assist you in this process. Be sure you have imported the default set of XWiki pages available in the XAR matching your [[XWiki Enterprise installation>>xwiki:Main.Download#HXWikiEnterprise]]. Remember also that the XWiki space is only visible for authenticated users with administrative privileges or with the "advanced user" option turned on in their profile. 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. | ||
| 36 | |||
| 37 | = Create the FAQ Class = | ||
| 38 | |||
| 39 | * On the Class Editor wizard entry page (XWiki.XWikiClasses), under the heading "Create a new data type", enter the following web space and class name: | ||
| 40 | ** Space: FAQ | ||
| 41 | ** Class: FAQ((( | ||
| 42 | image:CreateANewClass.PNG | ||
| 43 | ))) | ||
| 44 | * Click the "Create this Class" button. You should then see a code page with the following code:((( | ||
| 45 | {{code language="none"}} | ||
| 46 | {{velocity}} | ||
| 47 | ## Replace Main with the Space where you want your documents to be created. | ||
| 48 | ## Replace the default parent with the one of your choice and save the document. | ||
| 49 | ## | ||
| 50 | #set($className = $doc.name.substring(0, $doc.name.indexOf("Class"))) | ||
| 51 | #set($defaultParent = "${doc.space}.${className}Class") | ||
| 52 | #set($defaultSpace = 'Main') | ||
| 53 | {{/velocity}} | ||
| 54 | {{include document="XWiki.ClassSheet"/}} | ||
| 55 | {{/code}} | ||
| 56 | ))) | ||
| 57 | |||
| 58 | In the code, change the word "Main" with the name of the space where you want you FAQ pages to be created as the commented instructions in the page code suggest. Replace the word "Main" with the word "FAQ". The line of code should now look like this: | ||
| 59 | |||
| 60 | {{code language="none"}} | ||
| 61 | #set($defaultSpace = 'FAQ') | ||
| 62 | {{/code}} | ||
| 63 | |||
| 64 | You can also change the default parent of the new FAQ documents that are going to be created. To do so, replace the variables with the name of your document. The line of code should now look like this: | ||
| 65 | |||
| 66 | {{code language="none"}} | ||
| 67 | #set($defaultParent = 'FAQ.WebHome') | ||
| 68 | {{/code}} | ||
| 69 | |||
| 70 | 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: | ||
| 71 | |||
| 72 | image:FAQClass1.PNG | ||
| 73 | |||
| 74 | = Add Properties to the Class = | ||
| 75 | |||
| 76 | 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! | ||
| 77 | |||
| 78 | * Click on the 'class editor' link: a list of existing XClasses will be displayed | ||
| 79 | * Note that the link trail in the header is something like "FAQ: XWiki Space » Data types » FAQClass". This shows you that you are indeed on the class page. | ||
| 80 | |||
| 81 | In our document, we'll store both a //question// and an //answer//. So we need a property for each. | ||
| 82 | |||
| 83 | * Enter the text //question// in the "NAME" field of the Class Editor panel: the "ADD PROPERTY" panel is in the right column. | ||
| 84 | * Choose a TextArea type for the property and then click the "ADD PROPERTY" button. The TextArea will ultimately give us a multi-line text field in our authoring template.((( | ||
| 85 | image:AddQuestionProperty.PNG | ||
| 86 | ))) | ||
| 87 | * Configure this property with the following values (actually, if you are using the current XWiki version, you don't need to change anything but the Pretty name ? all the rest are the default values):((( | ||
| 88 | image:QuestionProperty.PNG | ||
| 89 | ))) | ||
| 90 | * Now add a property called //answer// in the same way that you did for the "question" property (choosing TextArea for the property type) | ||
| 91 | * Choose it from the property list on the left and configure this property with the same values as the "question" property, except for the //name// and //pretty name// which will, obviously, match the new property we're creating | ||
| 92 | * When you are done adding and configuring the properties, click the "Save & View" button. | ||
| 93 | |||
| 94 | = Create the Page Design Sheet = | ||
| 95 | |||
| 96 | * After the previous step you are now on the FAQClass page which should look like this:((( | ||
| 97 | image:FAQClass2.PNG | ||
| 98 | ))) | ||
| 99 | * 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. | ||
| 100 | * Click on "View the sheet document" | ||
| 101 | * Edit that page in Object edition mode | ||
| 102 | * Using the menu on the right, add a XWiki.SheetClass object to the page | ||
| 103 | ** **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** | ||
| 104 | * Click "Save & View" | ||
| 105 | * If you edit the page in wiki mode, you will see the following code:((( | ||
| 106 | {{code language="none"}} | ||
| 107 | {{velocity}} | ||
| 108 | ## You can modify this page to customize the presentation of your object. | ||
| 109 | ## At first you should keep the default presentation and just save the document. | ||
| 110 | = Document $doc.name = | ||
| 111 | |||
| 112 | #set($class = $doc.getObject('FAQ.FAQClass').xWikiClass) | ||
| 113 | |||
| 114 | #foreach($prop in $class.properties) | ||
| 115 | ; $prop.prettyName | ||
| 116 | : $doc.display($prop.getName()) | ||
| 117 | #end | ||
| 118 | {{/velocity}} | ||
| 119 | {{/code}} | ||
| 120 | )))Let's take a moment now and analyze this code: | ||
| 121 | |||
| 122 | * The first line retrieves the FAQ.FAQClass from the wiki | ||
| 123 | * Then we iterate through all its properties and display their values for the current document in a definition list. | ||
| 124 | |||
| 125 | As we mentioned, XWiki provides a mechanism that help us create sheets used for both view and edit mode: this is the display function used in the line: | ||
| 126 | |||
| 127 | {{code language="none"}}: $doc.display($prop.getName()){{/code}}. It detects the current mode (edit or view) and displays the property referenced by its argument as the mode dictates: | ||
| 128 | |||
| 129 | * In view mode it will display the value of the property | ||
| 130 | * In edit mode it will display a form field that will allow the user to edit it | ||
| 131 | |||
| 132 | 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. | ||
| 133 | |||
| 134 | * Click "Save & View" | ||
| 135 | |||
| 136 | = Create the Authoring Template = | ||
| 137 | |||
| 138 | * Click on "FAQClass" in the breadcrumb. The document should look like this:((( | ||
| 139 | image:FAQClass3.PNG | ||
| 140 | ))) | ||
| 141 | * Notice that now, there is a link for the FAQSheet in place of the button that was previously there | ||
| 142 | * Click on the "CREATE THE DOCUMENT TEMPLATE" button. The Authoring Template will be automatically created. If you click on "View the template document" and edit that page in wiki mode, you will see the following code:((( | ||
| 143 | {{code language="none"}} | ||
| 144 | {{include document="FAQ.FAQClassSheet"/}} | ||
| 145 | {{/code}} | ||
| 146 | ))) | ||
| 147 | * 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 | ||
| 148 | * 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. | ||
| 149 | |||
| 150 | Now we need to associate the prototype object with this document to turn it into a true authoring template. | ||
| 151 | |||
| 152 | * If you're on the template page, click on "FAQClass" in the breadcrumb to get back to the FAQ Class page | ||
| 153 | * 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 »." | ||
| 154 | * Click on "Add a FAQ object to the template »" | ||
| 155 | * Congratulations: you just created an Authoring Template! You're almost done now.((( | ||
| 156 | image:FAQClass4.PNG | ||
| 157 | ))) | ||
| 158 | |||
| 159 | = Create a home page for the FAQ application = | ||
| 160 | |||
| 161 | 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. | ||
| 162 | |||
| 163 | * Use the Create top level menu (when using the Colibri skin) or the Create Panel to create the FAQ.WebHome page (Space = FAQ, Page = WebHome). Alternatively you can navigate to the wiki dashboard page (the home page) and click on the FAQ space which should have a question mark (that's because you've created documents in the FAQ space above but there's no WebHome page created yet). | ||
| 164 | * Edit the page in Wiki model and input a title such as "FAQs" in the title field | ||
| 165 | |||
| 166 | == Displaying existing FAQ entries == | ||
| 167 | |||
| 168 | You have 2 options when it comes to displaying existing FAQ entries. You can either use the livetable component or write custom code in order to display them. | ||
| 169 | |||
| 170 | === Using the Livetable component === | ||
| 171 | |||
| 172 | In this section, we will show how to use the [[Livetable Macro>>extensions:Extension.Livetable Macro]] to display the existing questions and answers. | ||
| 173 | |||
| 174 | The livetable component will give users the ability to easily list and filter through existing FAQ documents. The macro is made of 3 parts: | ||
| 175 | |||
| 176 | * 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 | ||
| 177 | * 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 | ||
| 178 | * 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) | ||
| 179 | |||
| 180 | Here is the resulting code: | ||
| 181 | |||
| 182 | {{code language="none"}} | ||
| 183 | {{velocity}} | ||
| 184 | #set($columns = ["question", "doc.creationDate", "_actions"]) | ||
| 185 | #set($columnsProperties = { | ||
| 186 | "question" : { "type" : "text", "link" : "view", "html" : "true", "sortable":true }, | ||
| 187 | "_actions" : {"actions": ["edit","delete"]} | ||
| 188 | }) | ||
| 189 | #set($options = { | ||
| 190 | "className":"FAQ.FAQClass", | ||
| 191 | "translationPrefix" : "faq.", | ||
| 192 | "tagCloud" : true, | ||
| 193 | "rowCount": 10 | ||
| 194 | }) | ||
| 195 | #livetable("faq" $columns $columnsProperties $options) | ||
| 196 | {{/velocity}} | ||
| 197 | {{/code}} | ||
| 198 | |||
| 199 | * Copy that code and paste it in your page | ||
| 200 | * Click "Save and View" | ||
| 201 | * New FAQ entries will now be displayed on the page once you create them | ||
| 202 | |||
| 203 | === Using custom code === | ||
| 204 | |||
| 205 | You will need to write the following code: | ||
| 206 | |||
| 207 | * A HQL query that will find all your FAQ documents | ||
| 208 | ** The HQL query looks for all documents that have a FAQ.FAQClass object other than the template | ||
| 209 | ** If no document has been created yet, a warning message is displayed | ||
| 210 | * A piece of velocity code to display all those documents | ||
| 211 | ** The velocity code loops in that list | ||
| 212 | ** For each item, the full document is loaded in memory so that values can be retrieved from it | ||
| 213 | ** For each document, the question is retrieved and displayed as a link towards the FAQ entry | ||
| 214 | |||
| 215 | Here's the resulting code: | ||
| 216 | |||
| 217 | {{code language="none"}} | ||
| 218 | = Existing FAQ entries = | ||
| 219 | |||
| 220 | {{velocity}} | ||
| 221 | #set($sql = ", BaseObject as obj where obj.name = doc.fullName and obj.className = 'FAQ.FAQClass' and obj.name <> 'FAQ.FAQTemplate'") | ||
| 222 | #set($results = $xwiki.searchDocuments($sql)) | ||
| 223 | #if($results.empty) | ||
| 224 | No FAQ has been created yet! | ||
| 225 | #else | ||
| 226 | #foreach ($item in $results) | ||
| 227 | #set($faq = $xwiki.getDocument($item)) | ||
| 228 | * [[${faq.display("question").replace("<p>", "").replace("</p>", "")}>>${item}]] | ||
| 229 | #end | ||
| 230 | #end | ||
| 231 | {{/velocity}} | ||
| 232 | {{/code}} | ||
| 233 | |||
| 234 | * Copy that code and paste it in your page | ||
| 235 | * Click "Save and View" | ||
| 236 | * New FAQ entries will now be displayed on the page once you create them | ||
| 237 | |||
| 238 | == Creating new FAQ entries == | ||
| 239 | |||
| 240 | There are 2 ways for you to let your users create new FAQ entries. You can either declare the FAQ as a template or add a custom creation form. | ||
| 241 | |||
| 242 | === Using a Template === | ||
| 243 | |||
| 244 | You will have to define a template provider [[as explained on this page>>http://extensions.xwiki.org/xwiki/bin/view/Extension/Administration+Application#HCreatethetemplateprovider]] | ||
| 245 | |||
| 246 | Go to your wiki's administration interface, in the "Templates" section. Create a new template provider in the "FAQ" space and name it "FAQTemplateProvider" | ||
| 247 | |||
| 248 | You can then use the following values: | ||
| 249 | |||
| 250 | * Provider name: "FAQ Template Provider" | ||
| 251 | * Template name "New FAQ entry" | ||
| 252 | * Template to use: "FAQ.FAQClassTemplate" | ||
| 253 | |||
| 254 | 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 >> Create page" button will now have the option to create a new page using the FAQ template. | ||
| 255 | |||
| 256 | === Custom creation form === | ||
| 257 | |||
| 258 | 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: | ||
| 259 | |||
| 260 | * The first part of the code checks whether the page has a parameter. If so: | ||
| 261 | ** The name of the document that will be created is computed | ||
| 262 | ** The name is cleaned to remove extra characters | ||
| 263 | ** A check is done to verify the document doesn't exist yet | ||
| 264 | ** If everything's ok, the user is sent to the new document in inline edition mode | ||
| 265 | * The second part of the code is the actual FAQ creation form | ||
| 266 | ** It builds the name of the document to create it in the "FAQ" space | ||
| 267 | ** It sets the document parent as being the current document | ||
| 268 | ** It defines the template to use to create the new document | ||
| 269 | |||
| 270 | {{code language="none"}} | ||
| 271 | {{velocity}} | ||
| 272 | #if("$!request.docName" != '') | ||
| 273 | ## Request for creating a new instance | ||
| 274 | #set($docName = $util.clearName(${request.docName})) | ||
| 275 | #set($targetDocName = "${request.spaceName}.${docName}") | ||
| 276 | #if(!$xwiki.exists($targetDocName) && $xwiki.hasAccessLevel('edit', $context.user, $targetDocName)) | ||
| 277 | $response.sendRedirect($xwiki.getURL($targetDocName, 'inline', "template=${request.template}&parent=${request.parent}")) | ||
| 278 | ## Stop processing, since we already sent a redirect. | ||
| 279 | #stop | ||
| 280 | #end | ||
| 281 | #end | ||
| 282 | |||
| 283 | = Add a new question = | ||
| 284 | |||
| 285 | #if("$!targetDocName" != '' && $xwiki.exists($targetDocName)) | ||
| 286 | {{warning}}The target document already exists. Please choose a different name, or [[view the existing document>>$targetDocName]]{{/warning}} | ||
| 287 | #elseif("$!targetDocName" != '') | ||
| 288 | {{warning}}You don't have permission to create that document{{/warning}} | ||
| 289 | #end | ||
| 290 | |||
| 291 | {{html}} | ||
| 292 | <form action="" id="newdoc" method="post"> | ||
| 293 | <div> | ||
| 294 | <input type="hidden" name="parent" value="${doc.fullName}"/> | ||
| 295 | <input type="hidden" name="template" value="FAQ.FAQTemplate"/> | ||
| 296 | <input type="hidden" name="sheet" value="1"/> | ||
| 297 | <input type="hidden" name="spaceName" value="FAQ"/> | ||
| 298 | Document: <input type="text" name="docName" value="Enter your question here" class="withTip" size="50"/> | ||
| 299 | <span class="buttonwrapper"><input type="submit" value="Create this FAQ" class="button"/></span> | ||
| 300 | </div> | ||
| 301 | </form> | ||
| 302 | {{/html}} | ||
| 303 | {{/velocity}} | ||
| 304 | {{/code}} | ||
| 305 | |||
| 306 | * Copy that code and paste it in your page, below the code that's already there | ||
| 307 | * Click "Save and View" | ||
| 308 | * A form to create new FAQ entries is now available on the page | ||
| 309 | |||
| 310 | = Test the Application = | ||
| 311 | |||
| 312 | Now let's just create a new document in our application to test it out. | ||
| 313 | |||
| 314 | * Under the "Add a new question" header, enter a document title in the //Document// field and click //Create this FAQ//. For example, enter //What is the meaning of life?//. | ||
| 315 | * You can then enter your question in longer form using the //Question// field on the template, like this:((( | ||
| 316 | image:FAQSheetEdit.PNG | ||
| 317 | ))) | ||
| 318 | * Click //Save & View// and then you will see the newly created document, like this:((( | ||
| 319 | image:FAQSheetView.PNG | ||
| 320 | ))) | ||
| 321 | * Go back to the "FAQ.WebHome" page to see the list of existing questions | ||
| 322 | |||
| 323 | = Conclusion = | ||
| 324 | |||
| 325 | This tutorial has shown how to use the Class Wizard app and it has detailed the concepts of classes, objects, properties and introduced the authoring templates and page design sheets. 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. | ||
| 326 | |||
| 327 | 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. |
