Skip to content

Commit

Permalink
Item9693: Category rationalisation and deleting some useless topics
Browse files Browse the repository at this point in the history
  • Loading branch information
Crawford Currie committed Jun 16, 2015
1 parent f2335e3 commit b7c151d
Show file tree
Hide file tree
Showing 89 changed files with 299 additions and 587 deletions.
9 changes: 3 additions & 6 deletions PatternSkin/data/System/WebLeftBarExample.txt
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1431315343" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="WebHome"}%
%INCLUDE{"%IF{"context can_login" then="%SYSTEMWEB%.WebLeftBarLogin" else="<nop>"}%" warn="off"}%

Expand Down Expand Up @@ -34,11 +34,8 @@
* %WEBPREFSTOPIC%

* <b>%MAKETEXT{"Categories"}%</b>
* [[AdminDocumentationCategory][Admin Documentation]]
* [[AdminToolsCategory][Admin Tools]]
* [[DeveloperDocumentationCategory][Developer Doc]]
* [[UserDocumentationCategory][User Documentation]]
* [[UserToolsCategory][User Tools]]
%SEARCH{"parent.name='Category' AND name!='%BASETOPIC%'" web="%BASEWEB%" type="query"
nonoise="on" format=" * [[$topic]]"}%
%ENDSECTION{"topics"}%

%INCLUDE{ "%SYSTEMWEB%.WebLeftBarWebsList" }%
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/BulkRegistration.txt
@@ -1,5 +1,5 @@
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICPARENT{name="ManagingUsers"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminToolsCategory"}%
---+ Bulk Registration

Administrators can use this topic to register (i.e. create logins and user topics) for a group of people in one batch.
Expand Down
6 changes: 3 additions & 3 deletions TopicUserMappingContrib/data/System/BulkResetPassword.txt
@@ -1,8 +1,8 @@
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICPARENT{name="ChangePassword"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminToolsCategory"}%
---+ Bulk Reset Passwords

*Administrators can use this topic to reset any number of user passwords.*
Administrators can use this topic to reset any number of user passwords.

Users whose passwords are reset with this will be sent an e-mail at the address recorded in the %WIKITOOLNAME% password system. The administrator will *not* be told the new passwords.
Each user will receive an email with a new random password, along with a link they can then use to reset the password.
Expand Down
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/ChangeEmailAddress.txt
@@ -1,7 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1426278433" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="UserToolsCategory"}%
---+ %MAKETEXT{"Change E-mail Address"}%

Change registered email address
%IF{
"context passwords_modifyable"
then="$percentINCLUDE{\"%TOPIC%\" section=\"secretEmailEnabled\"}$percent"
Expand Down
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/ChangePassword.txt
@@ -1,7 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1426278452" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="UserToolsCategory"}%
---+ %MAKETEXT{"Change Password"}%

Change your password
%IF{
"context passwords_modifyable"
then="$percentINCLUDE{\"%TOPIC%\" section=\"changePassword\"}$percent"
Expand Down
@@ -1,4 +1,5 @@
%META:TOPICINFO{author="ProjectContributor" date="1432874667" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminToolsCategory"}%
<noautolink>
<!--
Read general customisation instructions in %SYSTEMWEB%.UserAuthentication
Expand Down Expand Up @@ -470,4 +471,4 @@ format="<option>$pattern(^\| *(.*?) *\|.*)</option>"
-->
</noautolink>

%META:FILEATTACHMENT{name="validate.js" attr="h" comment="" user="ProjectContributor" date="1432874667" size="2027" version="1"}%
%META:FILEATTACHMENT{name="validate.js" attr="h" comment="" user="ProjectContributor" date="1434484983" size="2027" version="1"}%
6 changes: 3 additions & 3 deletions TopicUserMappingContrib/data/System/ManagingUsers.txt
@@ -1,9 +1,9 @@
%META:TOPICINFO{author="ProjectContributor" date="1426278493" format="1.1" version="1"}%
%META:TOPICPARENT{name="ReferenceManual"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
%STARTINCLUDE%
---+ Manage Users

_Register users on your Foswiki site; change/reset/install passwords; remove user accounts_
Register users on your Foswiki site; change/reset/install passwords; remove user accounts

%TOC%

Expand Down
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/UserForm.txt
@@ -1,5 +1,5 @@
%META:TOPICINFO{author="ProjectContributor" date="1404873298" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminDocumentationCategory"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminToolsCategory"}%
---+ User Form

This is a maintenance topic, used by the Wiki administrator.
Expand Down
6 changes: 4 additions & 2 deletions TopicUserMappingContrib/data/System/UserRegistration.txt
@@ -1,4 +1,6 @@
%META:TOPICINFO{author="ProjectContributor" date="1427079357" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="UserToolsCategory"}%
Register on this site
<!--
* Set REGISTRATION_DISABLED = %IF{"context registration_supported" then="%IF{"context registration_enabled" then="" else="DISABLED"}%" else="DISABLED"}%
-->
Expand All @@ -22,4 +24,4 @@ To create a custom UserRegistration page for your site:
Note: You cannot set macros in an included topic. Users visiting %SYSTEMWEB.UserRegistration will be viewing the results of an INCLUDE.
</div>'}%

%META:FILEATTACHMENT{name="js.js" attr="h" comment="" user="ProjectContributor" date="1427079357" size="198" version="1"}%
%META:FILEATTACHMENT{name="js.js" attr="h" comment="" user="ProjectContributor" date="1434484983" size="198" version="1"}%
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/UserSetting.txt
@@ -1,5 +1,5 @@
%META:TOPICINFO{author="ProjectContributor" date="1418937051" format="1.1" version="1"}%
%META:TOPICPARENT{name="DefaultPreferences"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="UserDocumentationCategory"}%
---+++ User Settings -- preference settings customizable by users
Some of the preference settings are explicitly intended to be customized by users, though a default is provided in [[%SYSTEMWEB%.%WIKIPREFSTOPIC%]] and site wide customisation can take place in [[%LOCALSITEPREFS%]].

Expand Down
28 changes: 4 additions & 24 deletions TopicUserMappingContrib/data/System/UserToolsCategory.txt
@@ -1,27 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1421599902" format="1.1" version="1"}%
%META:TOPICPARENT{name="WebHome"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="Category"}%
---+ A List of User Tools

$ [[ChangeEmailAddress]] : Change your email address
$ [[ChangePassword]] : Change your password
$ [[UserRegistration]] : Register as a user on this wiki
$ [[ResetPassword]] : Reset your password
$ [[SiteChanges]] : Recently Changed Topics in all Webs
$ [[WebAtom]] : When viewed this topic returns an ATOM feed of the changes in the web. There is a WebAtom topic in each web
$ [[WebChanges]] : This topic list all the changes in the current web. There is a WebChanges topic in each web
$ [[WebCreateNewTopic]] : This topic shows a form from which the user can create a new topic in the current web. There is a WebCreateNewTopic in each web
$ [[%HOMETOPIC%]] : %HOMETOPIC% is the default landing page for a web. There is always a %HOMETOPIC% in a web
$ [[WebIndex]] : This topic provides an alphabetical list of all topics in the current web. There is a WebIndex topic in each web. The list is more verbose than the WebTopicList
$ [[WebNotify]] : This is a subscription service to be automatically notified by e-mail when topics change in this web. Each has its own WebNotify topic. Users can add their names to this topic and be notified by email about changes in the web
$ [[WebRss]] : When viewed this topic returns an RSS feed of the changes in the web. There is a WebRss topic in each web
$ [[WebSearchAdvanced]] : Same as WebSearch except it starts in the advanced tab
$ [[WebSearch]] : Search this web for text. Each web has a WebSearch topic. You can search in current web or all webs
$ <noautolink>%IF{"istopic '%STATISTICSTOPIC%'" then="[[%STATISTICSTOPIC%]]" else="%STATISTICSTOPIC%"}% : Statistics for the use of the current web</noautolink>
$ [[WebTopicList]] : List of all topics in the current web. Displays only the topic names. WebIndex shows a more verbose list. There is a WebTopicList in each web
List of tools the user may need for setting and resetting passwords, changing email address etc.

---++ Related Topics

$ [[AdminDocumentationCategory]] : List of documents relevant for the installer and administrator of the Foswiki installation
$ [[AdminToolsCategory]] : List of tools available to the Foswiki administrator
$ [[UserDocumentationCategory]] : List of documents for the everyday user from beginner to advanced user
$ [[DeveloperDocumentationCategory]] : List of documents for application developers as well as developers of skins and extensions.
%INCLUDE{"Category"}%
4 changes: 2 additions & 2 deletions TopicUserMappingContrib/data/System/UsersTemplate.txt
@@ -1,5 +1,5 @@
%META:TOPICINFO{author="ProjectContributor" date="1418937051" format="1.1" version="1"}%
%META:TOPICPARENT{name="%25SYSTEMWEB%25.UserToolsCategory"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
%META:TOPICPARENT{name="AdminToolsCategory"}%
%STARTSECTION{"header"}%
---+ List of <nop>%WIKITOOLNAME% users

Expand Down
17 changes: 3 additions & 14 deletions core/data/System/ACRONYM.txt
@@ -1,28 +1,17 @@
%META:TOPICINFO{author="ProjectContributor" date="1426810437" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1434484983" 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._
Linking topics using acronyms.

When you type an Acronym, you establish a possible hyperlink. It's as easy as that.
An acronym is an abbreviation that is typically made up of the first letter or letters of a phrase. An acronym of 3 or more letters will be automatically linked if (and only if) a topic of that name already exists in the current web.

Just like !WikiWord linking, acronym linking is easy to use:
* You don't have to know the full path to where the topic is stored - you just type the name
* You don't need to write HTML
* Without HTML, the topic text is easier to read when editing
* 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>

---++ Examples of Acronyms

* HTML
Expand Down
4 changes: 2 additions & 2 deletions core/data/System/AccessControl.txt
@@ -1,9 +1,9 @@
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1426810437" format="1.1" reprev="2" version="1"}%
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1434484983" format="1.1" reprev="2" version="1"}%
%META:TOPICPARENT{name="UserDocumentationCategory"}%
%STARTINCLUDE%
---+ Access Control

_Restricting read and write access to topics and webs, by users and groups_
Restricting read and write access to topics and webs, by users and groups

Access Control allows you restrict access to single topics and entire webs, by individual user and by user Groups. Access control, combined with UserAuthentication, lets you easily create and manage an extremely flexible, fine-grained privilege system.

Expand Down
36 changes: 0 additions & 36 deletions core/data/System/AccessKeys.txt

This file was deleted.

0 comments on commit b7c151d

Please sign in to comment.