Last modified by Simon Urli on 2023/10/10

<
From version < 95.1 >
edited by Vincent Massol
on 2017/01/17
To version < 96.2 >
edited by Vincent Massol
on 2017/01/30
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,6 +2,10 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
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.
6 +
7 += Prerequisites for following the tutorial =
8 +
5 5  {{warning}}
6 6  If you've already followed the [[AWM FAQ Tutorial>>DevGuide.FAQTutorial.FAQTutorialAWM]] or installed the [[FAQ Application>>extensions:Extension.FAQ Application]] you'll need to do one of 2 things before you can take this tutorial:
7 7  * Delete the ##FAQ## space (if you've followed the AWM FAQ Tutorial) or uninstall the FAQ Application (if you've installed the FAQ Application)
... ... @@ -8,10 +8,6 @@
8 8  * or simply follow the tutorial below but replace the space ##FAQ## with another value everywhere it's used. For example use ##MyFAQ## as the space name instead.
9 9  {{/warning}}
10 10  
11 -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.
12 -
13 -= Prerequisites for following the tutorial =
14 -
15 15  You should have [[installed XWiki>>AdminGuide.Installation]] and have a [[basic understanding of how to use it>>Features.WebHome]].
16 16  
17 17  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.
... ... @@ -48,10 +48,11 @@
48 48  * 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:(((
49 49  {{image reference="CreateANewClass1.png"/}}
50 50  )))
51 -* 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##:(((
51 +* As you can see in the Breadcrumb below the new page will be created at location ##XWiki > FAQ##. In practice the Class Wizard will automatically prefix the page name with ##Class## (you could also enter ##FAQClass## as the page name directly).
52 +* Now it would be nice to have it created in a new location such as ##FAQ > FAQ Class##. 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##:(((
52 52  {{image reference="CreateANewClass2.png"/}}
53 53  )))
54 -* In technical terms you're creating a page named ##FAQ## located in a space also called ##FAQ## and the reference is ##FAQ.FAQ##.
55 +* In technical terms you're creating a page named ##FAQClass## (with a title of "FAQ Class") located in a space also called ##FAQ## and thus the technical reference is ##FAQ.FAQClass##.
55 55  * Click the "Create this Class" button. You should then see a page with the following content:(((
56 56  {{code language="none"}}
57 57  {{velocity}}

Get Connected