Changes for page Creating A Person Manager Application

Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -85,7 +85,8 @@
85	85	* XWiki has now created a "**space**" called PersonSpace. A "space" is a directory (or "folder") where pages live. All of our pages will go in this space.
86	86	* In technical terms you're creating a page named ##PersonClass## (with a title of "Person Class") located in a space called ##PersonSpace## and thus the technical reference for the page is ##PersonSpace.PersonClass##.
87	87	* Click the "Create this Class" button. You should then see a page with the following content:(((
88		-{{code language="none"}}called
	88	+{{code language="none"}}
	89	+called
89	89	{{velocity}}
90	90	## Replace the default space with the space where you want your documents to be created.
91	91	## Replace the default parent with the one of your choice and save the document.
...	...	@@ -120,6 +120,7 @@
120	120	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." Click on that link.
121	121	Now, we need to specify all the properties of a Person. Let's have the following properties:
122	122
	124	+(% style="width:50%" %)
123	123	|=Property Name|=Property Type
124	124	|name|String
125	125	|email|EMail
...	...	@@ -131,37 +131,39 @@
131	131	|age|Number
132	132	|relatedPeople|Page (Multiple)
133	133
	136	+Follow these steps to define our properties of the Person class:
134	134	* Enter the text //name// in the "name" field
135	135	* 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.(((
136	136	{{image reference="name.PNG" width="650px"/}}
137	137	)))
138	138	* Click on the "+" icon to expand the options for the newly created property
139		-* 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	+* 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 without actually renaming the property (and thereby probably breaking something).
140	140	* Now repeat this to add each of the properties shown in the table above.
141	141	** 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).
142	142	** If we wanted to, we could add a "Validation Expression" to the "phone" property to make sure it's in a particular format.
143		-** For the "sex" property, in the "Display Type" field, enter "Select". This will give the user a drop-down menu.
	146	+** For the "sex" property, in the "Display Type" field, enter "Select". This will cause the user to see a drop-down menu.
144	144	** As we define the "sex" property as type "static list", we specify the values for the field like this:(((
145		-{{image reference="staticList.PNG" width="350px"/}}
	148	+{{image reference="staticList.PNG" width="650px"/}}
146	146	)))
147	147	** Note that there is no "Image" type. That's unfortunate. Let's just define it as a String here, and deal with that later.
148		-** Note that the "size" of our "age" field is 30 digits. Three digits should be plenty, so feel free to change that.
	151	+** Note that the "size" of our "age" field is 30 digits. People rarely live longer than 999 years, so feel free to change that to 3.
149	149	** For our "relatedPeople" property, we want to allow multiple values, not just one. So find the "Multi Select" checkbox and check it.
150	150	* When you are done, you should see all your properties like this:(((
151	151	{{image reference="properties.PNG" width="650px"/}}
152	152	)))
153		-* When you are done adding and configuring the properties, click the "Save & View" button
	156	+* When you are done adding the properties, click the "Save & View" button
154	154
155	155	= Create the Page Design Sheet =
	159	+Next, we will create a "Page Design Sheet" to specify what a Person should look like when displayed on a page.
156	156
157	157	* After the previous step you are now on the PersonClass page which should look like this:(((
158	158	{{image reference="personClass2.PNG" width="650px"/}}
159	159	)))
160		-* 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.
	164	+* Click the first button ("Create the document sheet") to create the document sheet (the Page Design Sheet).
161	161	* 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.
162		-* 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.
	166	+* 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 Person 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.
163	163
164		-* Click "Save & View"
	168	+* This code is fine for now, so click "Save & View"
165	165
166	166	= Create the Authoring Template =
167	167
...	...	@@ -168,8 +168,6 @@
168	168	* Navigate back to the ##PersonSpace.PersonClass## document (you can use the arrows in the breadcrumb to do so).
169	169	* Click on the "Create the document template" button. The Authoring Template will be automatically created.
170	170
171		-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.
172		-
173	173	Now we need to associate the prototype object with this document to turn it into a true authoring template:
174	174
175	175	* If you're on the template page, navigate back to the ##PersonSpace.PersonClass## document.
...	...	@@ -197,9 +197,9 @@
197	197	{{image reference="personClass4.PNG" width="650px"/}}
198	198	)))
199	199
200		-= Create a home page for the Person Manager application =
	202	+= Create a Home Page for the Person Manager application =
201	201
202		-Now we are finished defining our Person class, and it's time to create our web pages. Recall that we only have two pages to create:
	204	+Whew! Take a deep breath, grab a cup of coffee, and pat yourself on the back. We are now finished defining our Person class and all its properties, and did a bunch of mysterious stuff relating to Templates. Now it's time to create some web pages. Recall that we only have two pages to create:
203	203
204	204	* A "main" page that contains a table of Person objects.
205	205	* A "Person" page that displays a single Person