Changeset 1304 for trunk/TopicUserMappingContrib/data/System/UserForm.txt

Timestamp:

12/12/08 22:33:29 (3 years ago)

Author:

ArthurClemens

Message:

Item312: updated documentation and added auto-copy buttons

File:

• trunk/TopicUserMappingContrib/data/System/UserForm.txt (modified) (2 diffs)

trunk/TopicUserMappingContrib/data/System/UserForm.txt

@@ -2 +2 @@
 ---+ User Form
 
-__Note:__ This is a maintenance topic, used by the Wiki administrator.
+This is a maintenance topic, used by the Wiki administrator.
 
-This form defines the form of the home pages of registered users listed
-in %USERSWEB%.%WIKIUSERSTOPIC%. *Do not edit this topic* - if you want to customise the
-user form, then:
-   1 Take a copy of this topic and save it to %USERSWEB%.<nop>UserForm
-   1 Customise %USERSWEB%.<nop>UserForm
-   1 Take a copy of NewUserTemplate and save it to %USERSWEB%.<nop>NewUserTemplate
-   1 Modify %USERSWEB%.<nop>NewUserTemplate and change the form to select your new user form.
-
+---++ Data form definition of user topics
+<!--
+Before changing this form, please read the guidelines below at [[%SYSTEMWEB%.UserForm#CustomForm][Customizing the User Form]]
+-->
 |*Name*  |*Type*  |*Size*  |*Values*  |*Tooltip message*  |*Attributes*  |
 | <nop>FirstName | text | 40 | | | |
@@ -29 +25 @@
 | Comment | textarea | 50x6 | | | |
 
-__%X% Note:__ Please keep the %SYSTEMWEB%.UserRegistration form and this form definition in sync. When you update this form you need to edit/save the %SYSTEMWEB%.NewUserTemplate topic. This ensures that the fields are in the right order.
+#CustomForm
+---++ Customizing the User Form
+If you want to change the user form, you would first want to make a copy of this form to the <nop>%USERSWEB% Web. That ensures your changes stay intact after a Foswiki update.
+
+To make a copy, follow these steps:
+
+   * By hand:
+      1 Take a copy of this topic and save it to %IF{"istopic '%USERSWEB%.UserForm'" then="[[%USERSWEB%.UserForm]]" else="%USERSWEB%.<nop>UserForm"}%
+      1 When editing your new !UserForm topic, change the entries in the data form definition. You may remove all explanation around the table.
+   * Automatically: %BR%
+   <form action="%SCRIPTURL{manage}%/%WEB%/"><input type="hidden" name="topic" value="%USERSWEB%.UserForm" ><input type="submit" class="foswikiButton" value="Make a copy for me now" /><input type="hidden" name="action" value="create" /><input type="hidden" name="onlynewtopic" value="on" /><input type="hidden" name="templatetopic" value="%WEB%.%TOPIC%" /><input type="hidden" name="section" value="definition" /><input type="hidden" name="redirectto" value="%WEB%.%TOPIC%" /><input type="hidden" name="nowysiwyg" value="1" /></form> %BR%
+   <span class="foswikiGrayText">you will return here after saving</span>
+
+%X% Note that your form changes will only be visible in a user topic after it has been saved. %BR%
+%X% Please keep the %SYSTEMWEB%.UserRegistration form and this form definition in sync. When you update this form you need to edit/save the %SYSTEMWEB%.NewUserTemplate topic. This ensures that the fields are in the right order.
+
+---+++ A form for new users
+To use your new user form for new (registering) users, create a copy of %IF{"istopic '%USERSWEB%.NewUserTemplate'" then="[[%USERSWEB%.NewUserTemplate]]" else="%USERSWEB%.<nop>NewUserTemplate"}%.
+
+   * By hand:
+      1 Take a copy of [[%SYSTEMWEB%.NewUserTemplate]] and save it to %IF{"istopic '%USERSWEB%.NewUserTemplate'" then="[[%USERSWEB%.NewUserTemplate]]" else="%USERSWEB%.<nop>NewUserTemplate"}%
+      1 Set the topic form to your custom %IF{"istopic '%USERSWEB%.UserForm'" then="%USERSWEB%.UserForm" else="%USERSWEB%.<nop>UserForm"}% topic
+   
+   * Automatically: %BR%
+   <form action="%SCRIPTURL{manage}%/%WEB%/"><input type="hidden" name="topic" value="%USERSWEB%.NewUserTemplate" ><input type="submit" class="foswikiButton" value="Make a copy for me now" /><input type="hidden" name="action" value="create" /><input type="hidden" name="onlynewtopic" value="on" /><input type="hidden" name="templatetopic" value="%SYSTEMWEB%.NewUserTemplate" /><input type="hidden" name="formtemplate" value="%USERSWEB%.UserForm" /><input type="hidden" name="redirectto" value="%WEB%.%TOPIC%" /><input type="hidden" name="nowysiwyg" value="1" /></form> %BR%
+   <span class="foswikiGrayText">you will return here after saving</span>
+
+---
 
 __Related topics:__ %USERSWEB%.%WIKIUSERSTOPIC%, %USERSWEB%.UserViewTemplate, %SYSTEMWEB%.NewUserTemplate, %USERSWEB%.UserHomepageHeader, %SYSTEMWEB%.DataForms, %SYSTEMWEB%.UserRegistration