Item11394: Documentation updates

Make any references to WebStatistics non-linking if the topic is
missing. Update documentation on the new feature.

git-svn-id: http://svn.foswiki.org/trunk@13522 0b4bb1d4-4e5a-0410-9cc4-b2b747904278

PatternSkin/data/Main/WebLeftBarExample.txt

@@ -9,7 +9,7 @@
    * [[WebChanges][ %ICON{"changes"}% %MAKETEXT{"Changes"}%]]
    * [[WebNotify][ %ICON{"notify"}% %MAKETEXT{"Notifications"}%]]
    * [[WebRss][ %ICON{"feed"}% %MAKETEXT{"RSS Feed"}%]]
-   * [[WebStatistics][ %ICON{"statistics"}% %MAKETEXT{"Statistics"}%]]
+   * %IF{"istopic '%STATISTICSTOPIC%'" else=" $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt" then="[[$percntSTATISTICSTOPIC$percnt][ $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt]]"}%
    * [[WebPreferences][ %ICON{"wrench"}% %MAKETEXT{"Preferences"}%]]
    * %IF{"istopic '%USERSWEB%.%WIKIUSERSTOPIC%'" else=" $percntICON{\"person\"}$percnt $percntMAKETEXT{\"Users\"}$percnt" then="[[$percntUSERSWEB$percnt.$percntWIKIUSERSTOPIC$percnt][ $percntICON{\"person\"}$percnt $percntMAKETEXT{\"Users\"}$percnt]]"}%
    * [[%USERSWEB%.WikiGroups][ %ICON{"group"}% %MAKETEXT{"Groups"}%]]

PatternSkin/data/Sandbox/WebLeftBarExample.txt

@@ -9,7 +9,7 @@
    * [[WebChanges][ %ICON{"changes"}% %MAKETEXT{"Changes"}%]]
    * [[WebNotify][ %ICON{"notify"}% %MAKETEXT{"Notifications"}%]]
    * [[WebRss][ %ICON{"feed"}% %MAKETEXT{"RSS Feed"}%]]
-   * [[WebStatistics][ %ICON{"statistics"}% %MAKETEXT{"Statistics"}%]]
+   * %IF{"istopic '%STATISTICSTOPIC%'" else=" $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt" then="[[$percntSTATISTICSTOPIC$percnt][ $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt]]"}%
    * [[WebPreferences][ %ICON{"wrench"}% %MAKETEXT{"Preferences"}%]]
 
 %INCLUDE{ "%SYSTEMWEB%.WebLeftBarWebsList" }%

PatternSkin/data/System/WebLeftBarExample.txt

@@ -10,7 +10,7 @@
    * [[WebChanges][ %ICON{"changes"}% %MAKETEXT{"Changes"}%]]
    * [[WebNotify][ %ICON{"notify"}% %MAKETEXT{"Notifications"}%]]
    * [[WebRss][ %ICON{"feed"}% %MAKETEXT{"RSS Feed"}%]]
-   * [[WebStatistics][ %ICON{"statistics"}% %MAKETEXT{"Statistics"}%]]
+   * %IF{"istopic '%STATISTICSTOPIC%'" else=" $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt" then="[[$percntSTATISTICSTOPIC$percnt][ $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt]]"}%
    * [[WebPreferences][ %ICON{"wrench"}% %MAKETEXT{"Preferences"}%]]
 
    * <b>%MAKETEXT{"User Reference"}%</b>

PatternSkin/data/_default/WebLeftBar.txt

@@ -8,7 +8,7 @@
    * [[WebChanges][ %ICON{"changes"}% %MAKETEXT{"Changes"}%]]
    * [[WebNotify][ %ICON{"notify"}% %MAKETEXT{"Notifications"}%]]
    * [[WebRss][ %ICON{"feed"}% %MAKETEXT{"RSS Feed"}%]]
-   * [[WebStatistics][ %ICON{"statistics"}% %MAKETEXT{"Statistics"}%]]
+   * %IF{"istopic '%STATISTICSTOPIC%'" else=" $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt" then="[[$percntSTATISTICSTOPIC$percnt][ $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt]]"}%
    * [[WebPreferences][ %ICON{"wrench"}% %MAKETEXT{"Preferences"}%]]
 
 ---

TWikiCompatibilityPlugin/data/TWiki/WebLeftBarExample.txt

@@ -8,7 +8,7 @@
    * [[%BASEWEB%.WebChanges][ %ICON{"changes"}% %MAKETEXT{"Changes"}%]]
    * [[%BASEWEB%.WebNotify][ %ICON{"notify"}% %MAKETEXT{"Notifications"}%]]
    * [[%BASEWEB%.WebRss][ %ICON{"feed"}% %MAKETEXT{"RSS Feed"}%]]
-   * [[%BASEWEB%.WebStatistics][ %ICON{"statistics"}% %MAKETEXT{"Statistics"}%]]
+   * %IF{"istopic '%BASEWEB%.%STATISTICSTOPIC%'" else=" $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt" then="[[$percntBASEWEB%percnt.$percntSTATISTICSTOPIC$percnt][ $percntICON{\"statistics\"}$percnt $percntMAKETEXT{\"Statistics\"}$percnt]]"}%
    * [[%BASEWEB%.WebPreferences][ %ICON{"wrench"}% %MAKETEXT{"Preferences"}%]]
 
 ---

TopicUserMappingContrib/data/System/UserToolsCategory.txt

@@ -16,7 +16,7 @@
    $ [[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
-   $ [[WebStatistics]] : Statistics for the use of the current web
+   $ <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
 
 ---++ Related Topics

core/data/Main/WebHome.txt

@@ -17,6 +17,6 @@ and [[%USERSWEB%.SitePreferences]]). Replace this text with a description of you
    * [[WebTopicList]] - all topics in alphabetical order
    * [[WebChanges]] - recent topic changes in this web
    * [[WebNotify]] - subscribe to an e-mail alert sent when topics change
-   * [[WebRss]], [[WebAtom]] - RSS and ATOM news feeds of topic changes
-   * [[WebStatistics]] - listing popular topics and top contributors
+   * [[WebRss]], [[WebAtom]] - RSS and ATOM news feeds of topic changes %IF{"istopic '%STATISTICSTOPIC%'" then="
+   * [[%STATISTICSTOPIC%]] - listing popular topics and top contributors"}%
    * [[WebPreferences]] - preferences of this web

core/data/System/AdminDocumentationCategory.txt

@@ -41,7 +41,7 @@
    $ [[ReleaseNotes01x01]] : Release note for all Foswiki 1.1.X releases including lists of all enhancements and bugfixes
    $ [[FAQSearchDoesNotWork]] : Description of a possible root cause in case no searches work
    $ [[SiteMap]] : An overview of all the webs incl links to search, recent changes, and notifications. Mainly targetted for the administrators but can also be useful for the users
-   $ [[SiteTools]] : Describes the utilities for searching, navigation, and monitoring site activity. It describes WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports. It also describes how to use the RSS and Atom feeds. Mainly targetted for the administrator
+   $ [[SiteTools]] : Describes the utilities for searching, navigation, and monitoring site activity. It describes WebNotify, to e-mail alerts when topics are edited, and %STATISTICSTOPIC%, to generate detailed activity reports. It also describes how to use the RSS and Atom feeds. Mainly targetted for the administrator
    $ [[Skins]] : An introduction to skins and skin development
    $ [[StandardColors]] : The 216 browser safe standard colors. Use colors from this list when choosing the color for a new web
    $ [[SystemRequirements]] : Server and client requirements for Foswiki

core/data/System/AdminToolsCategory.txt

@@ -16,7 +16,7 @@
    $ [[ManagingWebs]] : An introduction to webs. Includes the tool for the administrator to add new webs
    $ [[SiteMap]] : An overview of all the webs incl links to search, recent changes, and notifications. Mainly targetted for the administrators but can also be useful for the users
    $ [[SitePermissions]] : Overview of permissions settings of the webs on this Foswiki site
-   $ [[SiteTools]] : Describes the utilities for searching, navigation, and monitoring site activity. It describes WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports. It also describes how to use the RSS and Atom feeds. Mainly targetted for the administrator
+   $ [[SiteTools]] : Describes the utilities for searching, navigation, and monitoring site activity. It describes WebNotify, to e-mail alerts when topics are edited, and %STATISTICSTOPIC%, to generate detailed activity reports. It also describes how to use the RSS and Atom feeds. Mainly targetted for the administrator
    $ [[SkinBrowser]] : Skin Browser which allows you to can try out the Skins currently installed on this system
 
 ---++ Related Topics

core/data/System/CommandAndCGIScripts.txt

@@ -400,7 +400,10 @@ It is not possible to call =save= from an =&lt;a href ...&gt;= link.</blockquote
 This cgi script has been deprecated. When called, it will redirect to the WebSearch topic, and the parameters will be passed on.
 
 ---+++ =statistics=
-Refresh the %STATISTICSTOPIC% topics in range of webs.
+<!--
+   * Set ISSTATISTICSTOPIC = %IF{"istopic '%STATISTICSTOPIC%'" else="!WebStatistics" then="[[$percntSTATISTICSTOPIC$percnt][WebStatistics]]"}%
+-->
+Refresh the %ISSTATISTICSTOPIC% topics in range of webs.
 | *Parameter* | *Description* | *Default* |
 | =logdate= | YYYYMM to generate statistics for | _current month_ |
 | =webs= | comma-separated list of webs to run stats on | _all accessible webs_ |
@@ -413,7 +416,7 @@ for example:
    5 from command line bin/statistics -webs=Userweb,%SANDBOXWEB% updates _Userweb,%SANDBOXWEB%_
    6 from command line bin/statistics %WEB%.<nop>WebHome updates %WEB%
 
-see SiteTools#WebStatistics for more details on %STATISTICSTOPIC% and how to update statistics using cron.
+see SiteTools#WebStatistics for more details on %ISSTATISTICSTOPIC% and how to update statistics using cron.
 
 ---+++ =upload=
 Uploads an attachment to a topic. The HTTP request is expected to be in =multipart/form-data= format.

core/data/System/EditingShorthand.txt

@@ -351,8 +351,8 @@ To link to a topic in a subweb write =Otherweb.Subweb.TopicName=.%BR%
 
 It's generally a good idea to use the [[%SYSTEMWEB%.Macros][macros]] %<nop>SYSTEMWEB%, %<nop>SANDBOXWEB% and %<nop>USERSWEB% instead of %SYSTEMWEB%, %SANDBOXWEB% and %USERSWEB%.
 </td><td>
-<pre class="tml">
-WebStatistics
+<verbatim class="tml">
+%STATISTICSTOPIC%
 
 %SANDBOXWEB%.WebNotify
 
@@ -362,7 +362,7 @@ WebStatistics
 </pre>
 </td><td>
 
-WebStatistics
+%STATISTICSTOPIC%
 
 %SANDBOXWEB%.WebNotify
 

core/data/System/InstallationGuidePart2.txt

@@ -34,13 +34,14 @@ In many cases enabling a security feature prevents other features. It is a balan
 
 A new administrator is encouraged to read Foswiki:Support.SecurityFeatures which gives a walkthrough of the different security aspects and how to set the appropriate configuration settings. Note that that some security settings are only visible in configure in "expert mode" which you enter by clicking the "Yes, I've read all the documentation" button at the top of the configure screen.
 
+#EmailConfig
 ---++++ Enable Email Notification
 
 Each web has an automatic email notification service that sends you an email with links to all of the topics modified since the last alert. To enable this service:
    1 Confirm the Mail and Proxies settings on the =configure= page.
    1 Setup a cron job (or equivalent) to call the =tools/mailnotify= script, as described in the [[%SYSTEMWEB%.MailerContrib]] topic.
 
-#SMIME
+#SMimeInfo
 ---++++ Enable Signed Email Notification
 
 Foswiki administrative emails are an attractive target for SPAM generators and phishing attacks. One good way to protect against this possibility to enable S/MIME signatures on all administrative e-mails. To do this, you need an an X.509 certificate and private key for the the ={WebMasterEmail}= email account. Obtain these as you would for any other S/MIME e-mail user.
@@ -70,7 +71,7 @@ By default Foswiki cleans out expired session and lease files each time any topi
 
 ---++++ Enable !WebStatistics
 
-You can manually or automatically generate a listing of the most popular pages for each web, based on number of visits. For information on setting up this feature, see the [[%SYSTEMWEB%.SiteTools]] topic.
+You can manually or automatically generate a listing of the most popular pages for each web, based on number of visits. For information on setting up this feature, see the [[%SYSTEMWEB%.SiteTools#WebStatistics]] topic.
 
 ---++++ Enable Localisation
 

core/data/System/SiteChanges.txt

@@ -38,7 +38,7 @@
     pagesize="%URLPARAM{"limit" default="25"}%"
     showpage="1"
     web="%URLPARAM{"web" default="all"}%"
-    excludetopic="WebStatistics"
+    excludetopic="%STATISTICSTOPIC%"
     reverse="on"
     order="modified"
     format="| $date | <nop>$web | [[%SCRIPTURLPATH{"view"}%/$web/$topic#foo_$rev][$percentFORMFIELD{$quotSummary$quot topic=$quot$web.$topic$quot format=$quot$topic: $value$quot default=$quot$topic$quot alttext=$quot$topic$quot}$percent]] | [[$wikiusername][$wikiname]] | [[%SCRIPTURLPATH{"rdiff"}%/$web/$topic#_foo=$rev][%MAKETEXT{"diff"}%]], [[%SCRIPTURLPATH{"rdiff"}%/$web/$topic?type=last&render=sequential&context=9000&_foo=$rev#diff001][%MAKETEXT{"last change"}%]] | "

core/data/System/SiteMap.txt

@@ -16,7 +16,7 @@ This table is updated automatically based on <nop>WebPreferences settings of the
 	type="query" 
 	nototal="on" 
 	nosearch="on" 
-	format="<tr><td><img src=\"%ICONURL{web-bg}%\" alt=\"\" style=\"background-color:$pattern(.*?\* Set WEBBGCOLOR\s*=\s*([^\s]*).*)\" /><b>[[$web.%HOMETOPIC%][$web]]</b></td><td>[[$web.%HOMETOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/home.gif\" alt=\"Home of $web web\" />]][[$web.WebSearch][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/searchtopic.gif\" alt=\"Search $web web\" />]][[$web.WebChanges][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/recentchanges.gif\" alt=\"Recent changes in the $web web\" />]][[$web.%NOTIFYTOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/notify.gif\" alt=\"Get notified of changes to the $web web\" />]][[$web.%WEBPREFSTOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/wrench.gif\" alt=\"Preferences of $web web\" />]][[$web.%STATISTICSTOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/statistics.gif\" alt=\"Statistics of $web web\" />]][[$web.WebTopicList][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/indexlist.gif\" alt=\"Bullet list of all topics\" />]][[$web.WebIndex][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/index.gif\" alt=\"Index of all topics\" />]]</td><td>$percentEXPAND{\"$dollarpercentWEBSUMMARY$dollarpercent\" scope=\"$web.$topic\"}$percent $pattern(.*?\* Set SITEMAPUSETO\s*=([^\n\r]*).*)</td></tr>" 
+	format="<tr><td><img src=\"%ICONURL{web-bg}%\" alt=\"\" style=\"background-color:$pattern(.*?\* Set WEBBGCOLOR\s*=\s*([^\s]*).*)\" /><b>[[$web.%HOMETOPIC%][$web]]</b></td><td>[[$web.%HOMETOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/home.gif\" alt=\"Home of $web web\" />]][[$web.WebSearch][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/searchtopic.gif\" alt=\"Search $web web\" />]][[$web.WebChanges][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/recentchanges.gif\" alt=\"Recent changes in the $web web\" />]][[$web.%NOTIFYTOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/notify.gif\" alt=\"Get notified of changes to the $web web\" />]][[$web.%WEBPREFSTOPIC%][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/wrench.gif\" alt=\"Preferences of $web web\" />]]$percntIF{\"istopic '$web.%STATISTICSTOPIC%'\" then=\"[[$web.%STATISTICSTOPIC%][<img src='%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/statistics.gif' alt='Statistics of $web web' />]]\"}$percnt[[$web.WebTopicList][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/indexlist.gif\" alt=\"Bullet list of all topics\" />]][[$web.WebIndex][<img src=\"%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/index.gif\" alt=\"Index of all topics\" />]]</td><td>$percentEXPAND{\"$dollarpercentWEBSUMMARY$dollarpercent\" scope=\"$web.$topic\"}$percent $pattern(.*?\* Set SITEMAPUSETO\s*=([^\n\r]*).*)</td></tr>"
     pager="on"
     pagesize="%DEFAULTPAGESIZE%"
 }%
@@ -27,7 +27,7 @@ This table is updated automatically based on <nop>WebPreferences settings of the
    * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/recentchanges.gif" alt="Recent changes in the web" />WebChanges
    * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/notify.gif" alt="Get notified of changes to the web" />WebNotify 
    * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/wrench.gif" alt="Preferences of web" />WebPreferences 
-   * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/statistics.gif" alt="Statistics of web" />WebStatistics 
+   * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/statistics.gif" alt="Statistics of web" />%STATISTICSTOPIC%
    * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/indexlist.gif" alt="Bullet list of all topics" />WebTopicList
    * <img src="%PUBURLPATH%/%SYSTEMWEB%/DocumentGraphics/index.gif" alt="Index of all topics" />WebIndex
 </div>