From 794a9cf264b0010a4d08924691cc28e7762752e4 Mon Sep 17 00:00:00 2001 From: George Clark Date: Wed, 24 Feb 2016 21:46:36 -0500 Subject: [PATCH] Item13883: Doc updates Make BulkRegistration topic a bit easier to use. Fix a typo in VarUSERINFO, and also mark the fields considered private data that will be hidden by default. --- .../data/System/BulkRegistration.txt | 8 +++++--- core/data/System/VarUSERINFO.txt | 20 ++++++++++--------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/TopicUserMappingContrib/data/System/BulkRegistration.txt b/TopicUserMappingContrib/data/System/BulkRegistration.txt index a7db69ca9f..c1b14cbca1 100644 --- a/TopicUserMappingContrib/data/System/BulkRegistration.txt +++ b/TopicUserMappingContrib/data/System/BulkRegistration.txt @@ -1,4 +1,4 @@ -%META:TOPICINFO{author="ProjectContributor" date="1448168966" format="1.1" version="1"}% +%META:TOPICINFO{author="ProjectContributor" comment="" date="1456368117" format="1.1" version="1"}% %META:TOPICPARENT{name="AdminToolsCategory"}% ---+ Bulk Registration @@ -14,9 +14,10 @@ Note: this is an administrator job - only admistrators can run this. If you are administrator, you will take these actions: 1 (First time use) Create new bulk registration topics (see [[#Settings][Settings]] below). - 1 In the REGISTERTOPIC topic: create a table of new users. An example table is provided below to copy. - 1 Return to this topic and press the button "Bulk Register" to create the new topics. + 1 In the REGISTERTOPIC (%REGISTERTOPIC%) topic: create a table of new users. An example table is provided below to copy. + 1 Return to this topic and press the [[#RegisterForm]["Bulk Register" button]] to create the new topics. 1 Read %LOGTOPIC% to verify if all has gone well. + 1 Visit WikiGroups if the new users need to be added to any groups. 1 When you are ready, use the [[BulkResetPassword]] page to assign passwords and notify the users of their new accounts. Below are the details. @@ -95,6 +96,7 @@ Make sure that the extra fields also appear on the %SYSTEMWEB%.UserForm. * Set NOTMODIFYABLE = %IF{"context passwords_modifyable" then="" else="DISABLED"}% %JQREQUIRE{"chili"}% --> +#RegisterForm
  diff --git a/core/data/System/VarUSERINFO.txt b/core/data/System/VarUSERINFO.txt index 1640ec2054..203edac883 100644 --- a/core/data/System/VarUSERINFO.txt +++ b/core/data/System/VarUSERINFO.txt @@ -1,25 +1,27 @@ -%META:TOPICINFO{author="ProjectContributor" date="1434650530" format="1.1" version="1"}% +%META:TOPICINFO{author="ProjectContributor" date="1456368117" format="1.1" version="1"}% %META:TOPICPARENT{name="Macros"}% ---+ USERINFO -- retrieve details about a user ---++ Parameters - | *Parameter* | *Description* | *Default* | + | *Parameter* | *Description* | | ="name"= | WikiName or [[UserName][login username]]. May be a group. | current user | | =format= | Format string; see below for supported formatting tokens. | =$username, $wikiusername, $emails= | Format tokens that can be used in =format=: | *Token* | *Description* | - | =$emails= | Comma separated list of email addresses known to the user mapper (this would normally be TopicUserMappingContrib). If expanding for a group, then this will be the email addresses of all members. | - | =$username= | [[UserName][Login username]]. If expanding for a group, this should expand as =unknown= | - | =$wikiname=, =$wikiusername= | The user's =WikiName= and =%USERSWEB%.WikiName=, respectively | - | =$groups= | Comma separated list of group membership. Currently only expands for users | - | =$isadmin= | Has admin privileges (expands to =true= or =false=) | - | =$isgroup= | Is a group (expands to =true= or =false=) | + | =$emails= (*) | Comma separated list of email addresses known to the user mapper (this would normally be TopicUserMappingContrib). If expanding for a group, then this will be the email addresses of all members. | + | =$username= (*) | [[UserName][Login username]]. If expanding for a group, this should expand as =unknown= | + | =$wikiname=, =$wikiusername= | The user's =WikiName= and =%USERSWEB%.WikiName=, respectively | | + | =$groups= (*) | Comma separated list of group membership. Currently only expands for users | + | =$isadmin= (*) | Has admin privileges (expands to =true= or =false=) | + | =$isgroup= | Is a group (expands to =true= or =false=) | | +%T% Tokens flagged '(*)' are considered private and are hidden from other users by default.%BR% The [[FormatTokens][standard format tokens]] are also supported. ---++ Examples * =%USERINFO{"name" format="..."}%= expands to %USERINFO% (lists =$username, $wikiusername, $emails=) With formatted output, using tokens: %USERINFO{ format="$username is really $wikiname" }% Expands to: =%USERINFO{ format="$username is really !$wikiname" }%= -Retrieve information about another user. You can use either a wikiname or a username to identify the user. You can only see information about another user if you are an admin, or the ={AntiSpam}{HideUserDetails}= configuration option is not enabled. %IF{"{AntiSpam}{HideUserDetails}" then=" _(User details are hidden on this site)_ "}%: + +Retrieve information about another user. You can use either a wikiname or a username to identify the user. You can only see the restricted information about another user if you are an admin, or the ={AntiSpam}{HideUserDetails}= configuration option is not enabled. %IF{"{AntiSpam}{HideUserDetails}" then=" _(User details are hidden on this site)_ "}%: %USERINFO{ "WikiGuest" format="$username is really $wikiname" }% Expands to: %USERINFO{ "WikiGuest" format="$username is really !$wikiname" }% %STOPINCLUDE%