Skip to content

Commit

Permalink
Item9693: Update topics with Wysiwyg
Browse files Browse the repository at this point in the history 
Generally checking for corruption, fixed a few typos, added <sticky>
blocks in areas where needed.
  • Loading branch information
@gac410
gac410 committed Mar 20, 2015
1 parent 1c9cce0 commit af2bf24
Show file tree
Hide file tree
Showing 14 changed files with 245 additions and 244 deletions.
37 changes: 21 additions & 16 deletions TopicUserMappingContrib/data/System/BulkRegistration.txt
View file
@@ -1,14 +1,15 @@
%META:TOPICINFO{author="ProjectContributor" date="1426278417" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICPARENT{name="ManagingUsers"}%
---+ Bulk Registration

Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch.
Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch.

Unlike normal registration the administrator is assumed to have correct e-mail addresses for the users, so *no verification is required.*
Note that the new users are not notified that they have an account. This is so you can prepare and verify the accounts before announcing them.
To announce them use the [[BulkResetPassword]] feature: this will assign a new random password and notify users.
To announce them use the [[BulkResetPassword]] feature: this will assign a new random password and notify users.

---++ Bulk Registration usage

Note: this is an administrator job - only admistrators can run this.

If you are administrator, you will take these actions:
Expand All @@ -21,7 +22,7 @@ If you are administrator, you will take these actions:
Below are the details.

---++ Settings
* Define where to pick up the table of users to register. It can be in any web, but defaults to the %USERSWEB% web.
* Define where to pick up the table of users to register. It can be in any web, but defaults to the %USERSWEB% web.
* Set REGISTERTOPIC = %USERSWEB%.UnprocessedRegistrations
* Use this to define where to log the bulk registration process. It will be saved to the %USERSWEB% web.
* Set LOGTOPIC = %REGISTERTOPIC%Log
Expand All @@ -30,22 +31,24 @@ Below are the details.
* Set OVERWRITEHOMETOPICS = 0

---++ The user table

This table is a template for user data that will be written to the new user topics. If you stick to these basic fields you can just use the first example below. If you want to write more data (like phone number or country) read the section [[#CustomizingUserData][Customizing user data]] as well.

If the =Password= field is not included, then use the BulkResetPasswlrd topic to assign new passwords. If a password is included, it must be a valid password (> minimum length, etc.)
If the =Password= field is not included, then use the BulkResetPasswlrd topic to assign new passwords. If a password is included, it must be a valid password (&gt; minimum length, etc.)
---+++ Example format

The following should be inserted into your %REGISTERTOPIC% as a table. This is the most simple format:
<verbatim class="tml">

<verbatim class='tml'>
<noautolink>
%EDITTABLE{}%
| FirstName | LastName | Email | WikiName |
| Test | User | you@your.domain | TestUser |
</noautolink>
</verbatim>
</noautolink></verbatim>

*Usage:*
1 Copy this text to your clipboard
1 Click through and paste this on %REGISTERTOPIC%.
1 Click through and paste this on %REGISTERTOPIC%.
1 Add and customize entries, save table. Note that the first row must not contain bolded entries, so don't apply any formatting.
1 Return here

Expand All @@ -54,7 +57,7 @@ The following should be inserted into your %REGISTERTOPIC% as a table. This is t

You can write additional data to the new user topics. Do this by enhancing the user table with additional field names as table headers.

Any fields you define in this table will end up in the User's topic. If a form (such as %SYSTEMWEB%.UserForm) is attached to NewUserTemplate then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search.
Any fields you define in this table will end up in the User's topic. If a form (such as %SYSTEMWEB%.UserForm) is attached to NewUserTemplate then the data will go in as META:FIELDS, meaning that you can use SEARCH formfield constructs to search.

If you use the %SYSTEMWEB%.UserForm then ensure that it contains all the fields you define here. Otherwise they will disappear when the user edits their home topic!

Expand All @@ -67,19 +70,21 @@ If you use the %SYSTEMWEB%.UserForm then ensure that it contains all the fields
* =LoginName= - __Required if the system is configured to__ ==AllowLoginName== (Commonly referred to as the UserName).
* =Email= - If not provided, you must set a password, or password reset will not be possible.
* =Password= - If not provided, set passwords later using BulkResetPassword.
* =Confirm= - If provided, it must match the =Password= field. If missing, it will not be checked.
* =Confirm= - If provided, it must match the =Password= field. If missing, it will not be checked.

---++++ Customized table example

Make sure that the extra fields also appear on the %SYSTEMWEB%.UserForm.
<verbatim class="tml">

<verbatim class='tml'>
<noautolink>
%EDITTABLE{}%
| FirstName | LastName | Email | WikiName | CustomFieldThis | SomeOtherRandomField | WhateverYouLike |
| Test | User | you@example.com | TestUser | A | B | C |
</noautolink>
</verbatim>
</noautolink></verbatim>

---

%IF{
"context passwords_modifyable"
then=""
Expand All @@ -90,7 +95,7 @@ Make sure that the extra fields also appear on the %SYSTEMWEB%.UserForm.
%JQREQUIRE{"chili"}%
-->
<form name="bulkRegister" action="%SCRIPTURLPATH{"manage"}%/%REGISTERTOPIC%" method="post">
<input type="hidden" name="action" value="bulkRegister" />&nbsp;
<input type="hidden" name="action" value="bulkRegister" /><sticky>&nbsp;</sticky>
<input %NOTMODIFYABLE% type="submit" class="foswikiSubmit" value="Bulk Register these people" />
<input type="hidden" name="LogTopic" value="%LOGTOPIC%" />
<input type="hidden" name="OverwriteHomeTopics" value="%OVERWRITEHOMETOPICS%" />
Expand All @@ -100,10 +105,10 @@ Make sure that the extra fields also appear on the %SYSTEMWEB%.UserForm.

%INCLUDE{"%REGISTERTOPIC%" warn="%X% Topic does not exist"}%


---++ <nop>%LOGTOPIC%

%INCLUDE{"%LOGTOPIC%" warn="Topic will be created during registration run."}%

---

*%MAKETEXT{"Related topics:"}%* AdminToolsCategory
14 changes: 8 additions & 6 deletions TopicUserMappingContrib/data/System/BulkResetPassword.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1420594682" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICPARENT{name="ChangePassword"}%
---+ Bulk Reset Passwords

Expand All @@ -13,9 +13,9 @@ load the page for all users [[BulkResetPassword?pagesize=;pager=off][click here]
*Follow these two steps:*

<form action="%SCRIPTURLPATH{"manage"}%/%WEB%/%TOPIC%" method="post">
<div class="foswikiFormSteps">
<div class="foswikiFormStep">
---+++ Select users [<a onclick="javascript:$('input[name=&quot;LoginName&quot;]').each(function(_,v){$(v).attr('checked',!$(v).attr('checked'))})">Toggle all</a>]
<div class='foswikiFormSteps'>
<div class='foswikiFormStep'>
---+++ Select users [<a onclick="javascript:$('input[name="LoginName"]').each(function(_,v){$(v).attr('checked',!$(v).attr('checked'))})">Toggle all</a>]
%IF{
"context passwords_modifyable"
then=""
Expand All @@ -38,22 +38,24 @@ load the page for all users [[BulkResetPassword?pagesize=;pager=off][click here]

*Note* if you don't see all the users you expect in this table, make sure their home topic has an attached %SYSTEMWEB%.UserForm. This is used to identify users.
</div>
<div class="foswikiFormStep">
<div class='foswikiFormStep'>
---+++ Write message

*This text will be sent to users in their "reset" e-mail.* The login name and password will be filled in automatically.
<textarea class="foswikiInputField" name="Introduction" rows="4" cols="70" style="width:99%;">
Welcome! The site is ready for your use. Please use the login name and password listed below and contact me if you have any questions.
</textarea>
</div>
<div class="foswikiFormStep foswikiLast">
<div class='foswikiFormStep foswikiLast'>
<input type="hidden" name="action" value="resetPassword">
<input %NOTMODIFYABLE% type="submit" class="foswikiSubmit" value="Reset selected user passwords and send message">
</div>
</div>

</form>

---

*Related Topics:* AdminToolsCategory

* Set ALLOWTOPICVIEW = %USERSWEB%.AdminGroup
Expand Down
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/ResetPassword.txt
View file
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1426278524" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICPARENT{name="ChangePassword"}%
---+ %MAKETEXT{"Reset Password"}%

Expand Down Expand Up @@ -40,5 +40,5 @@
-->

---
*%MAKETEXT{"Related topics:"}%* ChangePassword, ChangeEmailAddress, UserToolsCategory, AdminToolsCategory

*%MAKETEXT{"Related topics:"}%* ChangePassword, ChangeEmailAddress, UserToolsCategory, AdminToolsCategory
15 changes: 7 additions & 8 deletions core/data/System/ACRONYM.txt
View file
@@ -1,6 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1421672591" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICPARENT{name="UserDocumentationCategory"}%
---+!! What is an !ACRONYM?

An acronym is an abbreviation that is typically made up of the first letter or letters of a phrase. A very familiar example would be WWW standing for World
Wide Web. In Foswiki, an acronym of 3 or more letters will be automatically linked _only if a topic of that name already exists in the Web._

Expand All @@ -13,22 +14,19 @@ Just like !WikiWord linking, acronym linking is easy to use:
* Easy linking leads to interesting texts with links placed in context

---++ Syntax of an Acronym

* 3 or more Uppercase letter(s)

Acronym syntax in [[Wikipedia:Extended_Backus_Naur_Form][Extended Backus.Naur form]] (EBNF):

<verbatim>
Acronym = 3*upperLetters ;
upperLetters = "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I"
| "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R"
| "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" ;
</verbatim>
| "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" ;</verbatim>

---++ Examples of Acronyms

* HTML
* RADAR
* RADAR

But _Not_
* HTML5 - A digit breaks the acronym link.
Expand All @@ -40,14 +38,15 @@ When you write an acronym and the acronym topic already exists, it becomes a lin

* To force a link to to an acronym, use bracket notation: =[<nop>[HTML5]]= - this becomes: [[HTML5]] and will display the broken link indicator (?) if the topic does not exist.
* To link to an acronym in *another web*, write: =%SANDBOXWEB%.HTML= - this becomes: %SANDBOXWEB%.HTML
* To link to an acronym on a site like the Acronym Finder, use: =Acronym:HTTP= - this becomes: Acronym:HTTP (sites are defined in the InterwikiPlugin)
* To link to an acronym on a site like the Acronym Finder, use: =Acronym:HTTP= - this becomes: Acronym:HTTP (sites are defined in the InterwikiPlugin)

---++ Hints
* To stop an Acronym from being turned into a hyperlink, insert an exclamation point immediately before the Acronym. For example, write =!<nop>HTML= to get HTML.
* Unlike WikiWords, plural Acronyms are _not_ automatically linked to the singular topic.
* =FAQ= will be linked, but =FAQIndex= will not. Turn acronyms into !WikiWords, i.e. Change =FAQIndex= to =FaqIndex= for a "FAQ index" topic.
* =FAQ= will be linked, but =FAQIndex= will not. Turn acronyms into !WikiWords, i.e. Change =FAQIndex= to =FaqIndex= for a "FAQ index" topic.
* It is possible to turn off the auto-linking and to rely only on the bracket notation using the NOAUTOLINK [[%SYSTEMWEB%.PreferenceSettings][preference setting]].
* You can set NOAUTOLINK in your personal topic, or directly in any topic to change linking behavior for you or an individual topic.

---

*Related Topics:* TopicMarkupLanguage

0 comments on commit af2bf24

Please sign in to comment.