descriptiveText improvements from Daniel Chalef <daniel@jamwarehouse.com>

git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4629 c91229c3-7414-0410-bfa2-8a42b809f60b

descriptiveText improvements from Daniel Chalef <daniel@jamwarehouse.com>
git-svn-id: https://kt-dms.svn.sourceforge.net/svnroot/kt-dms/trunk@4629 c91229c3-7414-0410-bfa2-8a42b809f60b
bshuttle
1 parent dfb394f2
Showing 16 changed files with 24 additions and 31 deletions
templates/ktcore/folder/roles.smarty
templates/ktcore/folder/roles_managegroups.smarty
templates/ktcore/metadata/editFieldset.smarty
templates/ktcore/metadata/listFieldsets.smarty
templates/ktcore/principals/addgroup.smarty
templates/ktcore/principals/adduser.smarty
templates/ktcore/principals/editgroup.smarty
templates/ktcore/principals/edituser.smarty
templates/ktcore/principals/groupadmin.smarty
templates/ktcore/principals/groups_managesubgroups.smarty
templates/ktcore/principals/groups_manageusers.smarty
templates/ktcore/principals/password.smarty
templates/ktcore/principals/preferences.smarty
templates/ktcore/principals/unitadmin.smarty
templates/ktcore/principals/updatepassword.smarty
templates/ktcore/principals/usergroups.smarty
@@ -7,7 +7,7 @@
 {/i18n}</p>
  
 <div class='ktInfo'><p><strong>{i18n}Warning:{/i18n}</strong>{i18n} Please note that changing
-role allocations can take very long time, depending on the number of folders below this one.{/i18n}</p></div>
+role allocations may take a some time, depending on the number of folders below this one.{/i18n}</p></div>
  
 <table class="listing">
 <thead>
@@ -48,4 +48,4 @@ role allocations can take very long time, depending on the number of folders bel
 <tr><td colspan="4" class="ktInfo"><p>{i18n}No roles defined in the Role Administration area.{/i18n}</p></td></tr>
 {/if}
 </tbody>
-</table>
 \ No newline at end of file
+</table>
@@ -18,7 +18,7 @@
  
    <fieldset>
       <legend>{i18n}Allocate Groups to Role{/i18n}</legend>
-      <p class="descriptiveText">{i18n}Select the groups which should be part of this role.{/i18n} <strong>FIXME</strong> this helptext is v. awkward.</p>
+      <p class="descriptiveText">{i18n}Select the groups which should be part of this role.{/i18n}</p>
  
 <table border="0" width="600">
    <thead>
@@ -13,7 +13,7 @@
 <legend>{i18n}Fieldset properties{/i18n}</legend>
  
 <p class="descriptiveText">
-  <strong>FIXME</strong> add help text for fieldset editing.
+  {i18n}Please complete the following fields to edit the fieldset's properties and then click <strong>Change</strong>. Required fields are marked with a red square.{/i18n}
 </p>
  
 <input type="hidden" name="fFieldsetId" value="{$oFieldset->getId()}" />
@@ -110,7 +110,7 @@ field can depend on the user&#39;s selections for the others.{/i18n}
 <h3>{i18n}Fieldset members{/i18n}</h3>
  
 <p class="descriptiveText">
-  <strong>FIXME</strong> add help text for fieldset members.
+  {i18n}A fieldset is a collection of fields that comprise a defined set of document metadata. You may add, edit or delete members of this fieldset collection below.{/i18n}
 </p>
  
  
@@ -144,7 +144,7 @@ href=&quot;{$smarty.server.PHP_SELF}?action=editField&amp;fFieldId={$oField-&gt;getId()}&amp;fFi
 <fieldset>
 <legend>{i18n}Add a new field{/i18n}</legend>
  
-<p class="descriptiveText"><strong>FIXME</strong> add help text for field creation.</p>
+<p class="descriptiveText">{i18n}To add a new field, enter the field's name, description and field type below and then click <strong>Add field</strong>. If the field type requires additional lookup values you will be prompted to enter them.{/i18n}</p>
  
 <input type="hidden" name="fFieldsetId" value="{$oFieldset->getId()}">
 <input type="hidden" name="action" value="newfield">
 <h2>{i18n}Document Fieldsets{/i18n}</h2>
  
-<p class="descriptiveText"><strong>FIXME</strong> add documentation about what fieldsets are, and how to use them.</p>
+<p class="descriptiveText">{i18n}Collections of fields are associated into fieldsets.  These represent a set of related information which can be associated with a document and thus comprise part of the document's metadata.{/i18n}</p>
  
 { if $fieldsets}
 <h3>{i18n}Existing document fieldsets{/i18n}</h3>
@@ -53,8 +53,6 @@
 <form method="POST" action="{$smarty.server.PHP_SELF}">
 <fieldset><legend>{i18n}Create a new document fieldset{/i18n}</legend>
  
-<p class="descriptiveText"><strong>FIXME</strong> add documentation about what fieldsets are, and how to use them.</p>
-
  
 <input type="hidden" name="action" value="new" />
  
 <h2>{i18n}Add a new group{/i18n}</h2>
  
-<p class="descriptiveText">{i18n}Add a new group{/i18n}</p>
+<p class="descriptiveText">{i18n}Users may be classed together as Groups and these groups may be used to set security privileges throughout the document management system.{/i18n}</p>
  
 <form action="{$smarty.server.PHP_SELF}" method="POST">
    <input type="hidden" name="action" value="createGroup" />
  
    <fieldset>
       <legend>{i18n}Specify group details{/i18n}</legend>
-      <p class="descriptiveText"><strong>FIXME</strong> brief overview of group editing.</p>
+      <p class="descriptiveText">{i18n}Please enter the Group's details below and then click <strong>create group</strong>. Fields marked with a red square are required.{/i18n}</p>
       {foreach item=oWidget from=$add_fields}
         {$oWidget->render()}
       {/foreach}
 <h2>{i18n}Add a user{/i18n}</h2>
  
-<p class="descriptiveText"><strong>FIXME</strong> brief overview of user management.</p>
+<p class="descriptiveText">{i18n}Please complete the form below to add a new user. Fields marked with a red square are required. By default, users are created using KnowledgeTree's builtin authentication provider. Should you wish to use an external authentication provider such as LDAP, please ensure that the provider's plugin is registered and enabled.{/i18n}</p>
  
 {if $authentication_sources}
    <form action="{$smarty.server.PHP_SELF}" method="POST">
@@ -8,7 +8,7 @@ the system&#39;s information about group &lt;strong&gt;#name&lt;/strong&gt;{/i18n}&lt;/p&gt;
    <input type="hidden" name="group_id" value="{$edit_group->getId()}" />
    <fieldset>
       <legend>{i18n}Change Group Details{/i18n}</legend>
-      <p class="descriptiveText"><strong>FIXME</strong> brief overview of group editing.</p>
+      <p class="descriptiveText">{i18n}Users may be classed together as Groups and these groups may be used to set security privileges throughout the document management system.{/i18n}</p>
       {foreach item=oWidget from=$edit_fields}
         {$oWidget->render()}
       {/foreach}
@@ -5,7 +5,7 @@
    <input type="hidden" name="user_id" value="{$edit_user->getId()}" />
    <fieldset>
       <legend>{i18n}Change User Details{/i18n}</legend>
-      <p class="descriptiveText"><strong>FIXME</strong> brief overview of user editing.</p>
+<p class="descriptiveText">{i18n}Please complete the form below to edit the user. Fields marked with a red square are required. By default, users are created using KnowledgeTree's builtin authentication provider. Should you wish to use an external authentication provider such as LDAP, please ensure that the provider's plugin is registered and enabled.{/i18n}</p>
       {foreach item=oWidget from=$edit_fields}
  
         {$oWidget->render()}
@@ -9,7 +9,7 @@
 <p class="descriptiveText">{i18n}Since there may be many groups in the
 system, please type a few letters from the group's name to begin.
 Alternatively, <a href="?show_all=1">view all groups</a> (note that this
-may be very slow if you have many groups.{/i18n}</p>
+action may take some time if you have many groups).{/i18n}</p>
  
 {foreach item=oWidget from=$search_fields}
   {$oWidget->render()}
@@ -5,9 +5,7 @@
 {$context->oPage->requireJSResource('thirdpartyjs/MochiKit/Iter.js')}
 {$context->oPage->requireJSResource('thirdpartyjs/MochiKit/DOM.js')}
  
-<p class="descriptiveText"><strong>FIXME</strong> help text for group-editing.  
-<strong>FIXME</strong> there are potential unexpected
-side-effects to this when used by unitAdmins.</p>
+<p class="descriptiveText">{i18n}Groups may contain other groups, allowing for a convenient way to build tree's of users and efficiently assign security privileges.{/i18n}</p>
  
 <form action="{$smarty.server.PHP_SELF}" method="POST" id="usergroupform">
    <input type="hidden" name="action" value="updateGroupMembers" />
@@ -20,7 +18,7 @@ side-effects to this when used by unitAdmins.&lt;/p&gt;
  
    <fieldset>
       <legend>{i18n arg_name=$edit_group->getName()}Change Sub-Groups in #name#{/i18n}</legend>
-      <p class="descriptiveText">{i18n}Select the groups which should be part of this group.{/i18n} <strong>FIXME</strong> this helptext is v. awkward.</p>
+      <p class="descriptiveText">{i18n}Select the groups from the left-hand list that you would like to add to this group and then click the <strong>right pointing arrows</strong>. Once you have added all the groups that you require, press <strong>save changes</strong>. Only groups that are logically capable of being included in this group will be available to be added.{/i18n}</p>
  
 <table border="0" width="600">
    <thead>
@@ -5,7 +5,7 @@
 {$context->oPage->requireJSResource('thirdpartyjs/MochiKit/Iter.js')}
 {$context->oPage->requireJSResource('thirdpartyjs/MochiKit/DOM.js')}
  
-<p class="descriptiveText"><strong>FIXME</strong> help text for group-editing.  
+<p class="descriptiveText">{i18n}Users may be associated with Groups which are then used to grant these users security privileges.{/i18n}</p>  
  
 <form action="{$smarty.server.PHP_SELF}" method="POST" id="usergroupform">
    <input type="hidden" name="action" value="updateUserMembers" />
@@ -18,7 +18,7 @@
  
    <fieldset>
       <legend>{i18n arg_name=$edit_group->getName()}Manage Users in #name#{/i18n}</legend>
-      <p class="descriptiveText">{i18n}Select the users which should be part of this group.{/i18n} <strong>FIXME</strong> this helptext is v. awkward.</p>
+      <p class="descriptiveText">{i18n}Select the users which should be part of this group from the left-hand list and then click the <strong>right pointing arrows</strong>. Once you have added all the users that you require, press <strong>save changes</strong>.{/i18n}</p>
  
 <table border="0" width="600">
    <thead>
 <h2>Password</h2>
  
-<p class="descriptiveText"><strong>FIXME</strong> better helptext. Change your password.</p>
+<p class="descriptiveText">{i18n}You may change your password by entering it in the fields below. Your system administrator may have defined certain rules (such as minimum password length) that your password must abide by.{/i18n}</p>
  
 <form action="{$smarty.server.PHP_SELF}" method="POST">
 <input type="hidden" name="action" value="updatePassword" />
 <h2>Preferences</h2>
  
-<p class="descriptiveText">{i18n}From here you can adjust certain basic
-preferences about how you work with KnowledgeTree.{/i18n}</p>
+<p class="descriptiveText">{i18n}You may change details about yourself by editing the entries below. Once you have completed the form, click on <strong>Update your details</strong>.{/i18n}</p>
  
 <form action="{$smarty.server.PHP_SELF}" method="POST">
 <input type="hidden" name="action" value="updatePreferences" />
 <h2>{i18n}Unit Administration{/i18n}</h2>
  
-<p class="descriptiveText"><strong>FIXME</strong> Overview of units.</p>
+<p class="descriptiveText">{i18n}KnowledgeTree allows administrators the ability to create <strong>Units</strong> that model the organisation's business units. Units may have their own administrators and users and groups may be assigned to these units.{/i18n}</p>
  
 {if ($for_edit === false)}
  
@@ -5,7 +5,7 @@
    <input type="hidden" name="user_id" value="{$edit_user->getId()}" />
    <fieldset>
       <legend>{i18n}Change User's Password{/i18n}</legend>
-      <p class="descriptiveText">{i18n}Change the user's password.{/i18n}</p>
+      <p class="descriptiveText">{i18n}Change the user's password. Password rules may have been defined that this new password must abide by.{/i18n}</p>
       {foreach item=oWidget from=$edit_fields}
         {$oWidget->render()}
       {/foreach}
@@ -5,9 +5,7 @@
 {$context->oPage->requireJSResource('thirdpartyjs/MochiKit/Iter.js')}
 {$context->oPage->requireJSResource('thirdpartyjs/MochiKit/DOM.js')}
  
-<p class="descriptiveText"><strong>FIXME</strong> help text for group-editing.  
-<strong>FIXME</strong> there are potential unexpected
-side-effects to this when used by unitAdmins.</p>
+<p class="descriptiveText">{i18n}Users may be classed together as Groups and these groups may be used to set security privileges throughout the document management system.{/i18n}</p>
  
 <form action="{$smarty.server.PHP_SELF}" method="POST" id="usergroupform">
    <input type="hidden" name="action" value="updateGroups" />
@@ -20,8 +18,8 @@ side-effects to this when used by unitAdmins.&lt;/p&gt;
  
    <fieldset>
       <legend>{i18n arg_name=$edit_user->getName()}Change #name#'s Groups{/i18n}</legend>
-      <p class="descriptiveText">{i18n}Select the groups which should
-contain this user.{/i18n} <strong>FIXME</strong> this helptext is v. awkward.</p>
+
+<p class="descriptiveText">{i18n}Select the groups which this user should belong to from the left-hand list and then click the <strong>right pointing arrows</strong>. Once you have added all the groups that you require, press <strong>save changes</strong>.{/i18n}</p>
  
 <table border="0" width="600">
    <thead>