Item13883: docu fixes

foswiki · Jun 17, 2022 · 8355d32 · 8355d32
1 parent df64d97
commit 8355d32
Show file tree

Hide file tree

Showing 13 changed files with 51 additions and 74 deletions.
diff --git a/core/data/System/BeginnersStartHere.txt b/core/data/System/BeginnersStartHere.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1627037842" format="1.1"  version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="UserDocumentationCategory"}%
 ---+!! %TOPIC%
 
@@ -105,23 +105,15 @@ The menu, normally located either on the right or the left side of the content,
 The Toolbox section usually contains these items
 
 <sticky>
-      * *Toolbox*
-
-      * %ICON{"newtopic"}% Create New Topic - for creating new topics via a menu
-
-      * %ICON{"index"}% Index - an alphabetical listing of all topics in the web
-
-      * %ICON{"searchtopic"}% Search - leads to a more advanced search page
-
-      * %ICON{"changes"}% Changes - shows a list of recently changed topics
-
-      * %ICON{"notify"}% Notifications - allows you to subscribe to receiving emails when topics change
-
-      * %ICON{"feed"}% RSS Feed
-
-      * %ICON{"statistics"}% Statistics - for the activities current web
-
-      * %ICON{"wrench"}% Preferences - settings for the current web</sticky>
+   * *Toolbox*
+   * %ICON{"newtopic"}% Create New Topic - for creating new topics via a menu
+   * %ICON{"index"}% Index - an alphabetical listing of all topics in the web
+   * %ICON{"searchtopic"}% Search - leads to a more advanced search page
+   * %ICON{"changes"}% Changes - shows a list of recently changed topics
+   * %ICON{"notify"}% Notifications - allows you to subscribe to receiving emails when topics change
+   * %ICON{"feed"}% RSS Feed
+   * %ICON{"statistics"}% Statistics - for the activities current web
+   * %ICON{"wrench"}% Preferences - settings for the current web</sticky>
 
 Often the site administrator simplifies the toolbox, so you may not have all these items in your menu bar.
 
@@ -130,17 +122,12 @@ Often the site administrator simplifies the toolbox, so you may not have all the
 The Webs section lists all the webs that you can access
 
 <sticky>
-      * *Webs*
-
-      * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #ffefa6;' width='16' /> <nop>%USERSWEB%
-
-      * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #aaefa6;' width='16' /> <nop>Myco
-
-      * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #44efa6;' width='16' /> <nop>Project
-
-      * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #b9daff;' width='16' /> <nop>%SANDBOXWEB%
-
-      * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #ffd8aa;' width='16' /> <nop>%SYSTEMWEB%</sticky>
+   * *Webs*
+   * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #ffefa6;' width='16' /> <nop>%USERSWEB%
+   * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #aaefa6;' width='16' /> <nop>Myco
+   * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #44efa6;' width='16' /> <nop>Project
+   * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #b9daff;' width='16' /> <nop>%SANDBOXWEB%
+   * <img alt='' border='0' height='16' src='%ICONURL{web-bg}%' style='background-color: #ffd8aa;' width='16' /> <nop>%SYSTEMWEB%</sticky>
 
 A web is a collection of pages that are related closely together
 
@@ -155,11 +142,9 @@ Besides the Tools and Webs sections it is common to add your own links to import
 These menu entries can be different from web to web.
 
 <sticky>
-      * *Myco*
-
-      * Important topic
-
-      * Company philosophy</sticky>
+   * *Myco*
+   * Important topic
+   * Company philosophy</sticky>
 ---++ The page footer
 
 #PageFooter
@@ -360,13 +345,13 @@ If you get stuck, you can refer to the https://foswiki.org/Support web, which ha
 
 __Related topics:__ WelcomeGuest, WikiCulture, TwentyMinuteTutorial, TopicsAndWebs
 
-%META:FILEATTACHMENT{name="hula.gif" attr="h" comment="" date="1627037842" size="8780" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="myco.gif" attr="h" comment="" date="1627037842" size="1834" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="lego.gif" attr="h" comment="" date="1627037842" size="4084" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="SAP_logo.gif" attr="h" comment="" date="1627037842" size="2711" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="camel.png" attr="h" comment="" date="1627037842" size="13734" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="BT_logo.gif" attr="h" comment="" date="1627037842" size="1687" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="EpicGames_logo.gif" attr="h" comment="" date="1627037842" size="2270" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="Disney_logo.gif" attr="h" comment="" date="1627037842" size="1506" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="whiteboard.gif" attr="h" comment="" date="1627037842" size="13471" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="Motorola_logo.gif" attr="h" comment="" date="1627037842" size="2394" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="hula.gif" attr="h" comment="" date="1655454502" size="8780" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="myco.gif" attr="h" comment="" date="1655454502" size="1834" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="lego.gif" attr="h" comment="" date="1655454502" size="4084" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="SAP_logo.gif" attr="h" comment="" date="1655454502" size="2711" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="camel.png" attr="h" comment="" date="1655454502" size="13734" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="BT_logo.gif" attr="h" comment="" date="1655454502" size="1687" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="EpicGames_logo.gif" attr="h" comment="" date="1655454502" size="2270" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="Disney_logo.gif" attr="h" comment="" date="1655454502" size="1506" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="whiteboard.gif" attr="h" comment="" date="1655454502" size="13471" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="Motorola_logo.gif" attr="h" comment="" date="1655454502" size="2394" user="ProjectContributor" version="1"}%
diff --git a/core/data/System/FormattedSearch.txt b/core/data/System/FormattedSearch.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1443185186" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="UserDocumentationCategory"}%
 ---+ Formatted Search
 Customize the display of search results.
@@ -343,7 +343,7 @@ Use an HTML form and an embedded formatted search on the same topic. You can lin
 <input type="text" id="search_field" size="32" />
 %BUTTON{"Search" icon="find" id="search_button"}%
 
-<verbatim class="jqLoader {section:'example7_results', mode:'manual'}" id="result_loader">
+<verbatim class="jqLoader" data-section="example7_results" id="result_loader">
 %STARTSECTION{"example7_results"}%
 <div class="search_results">
 %SEARCH{

diff --git a/core/data/System/IfStatements.txt b/core/data/System/IfStatements.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1426913092" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="DeveloperDocumentationCategory"}%
 ---+!! IF statements
 
@@ -21,7 +21,7 @@ The basic syntax of a condition is the same as [[QuerySearch][the syntax used fo
 | =isweb= | =isweb 'X'= is true if web 'X' exists |
 | =ingroup= | ='X' ingroup 'Y'= is true if user 'X' is in group 'Y'. 'X' can be a [[UserName][login username]] or a [[WikiName]]. |
 | =defined= | True if a [[PreferenceSettings][preference setting]] or URL parameter of this name is defined. |
-| =isempty= | True if a [[PreferenceSettings][preference setting]], URL parameter or session variable of this name has an empty value. It is equivalent to the expression =(!defined(x) &#124;&#124; $x='')= |
+| =isempty= | True if a [[PreferenceSettings][preference setting]], URL parameter or session variable of this name has an empty value. It is equivalent to the expression =(not defined(x) &#124;&#124; $x='')= |
 | =$= | expands a URL parameter or [[Macros][macro]] name. Plugin handlers *are not called*. You can pass a limited subset of parameters to macros by enclosing the parameter string in single quotes; for example, =$'MACRO{value}'=. The ='MACRO{value}'= string may *not* contain quotes: ='= or ="=. |
 
 The =%<nop>IF%= statement is deliberately kept simple. In particular, note that there is no way to conditionally execute a Set statement. If you need more sophisticated control over formatting, then consider using the SpreadSheetPlugin.

diff --git a/core/data/System/InstallationGuide.txt b/core/data/System/InstallationGuide.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1645803928" format="1.1"  version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="AdminDocumentationCategory"}%
 <noautolink>
 ---+!! Installation Guide
@@ -88,7 +88,6 @@ cd /path/to/foswiki
 sh tools/fix_file_permissions.sh
 </verbatim>
 
-
 For more information on the appropriate permissions to ensure security for your Foswiki data, see Foswiki:Support.SecuringYourSite.
 
 #ConfigurePerl

diff --git a/core/data/System/ManagingWebs.txt b/core/data/System/ManagingWebs.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="UserDocumentationCategory"}%
 %STARTINCLUDE%
 ---+ Managing Webs
@@ -15,7 +15,6 @@ Browser-based rename, move, copy, and delete for individual webs
     #createWeb .foswikiHelp {margin:.5em 0;}
     #createWeb .additionalSettings {margin:.5em -10px;}
     #createWeb .additionalSettings .foswikiActionFormStepSign {display:none;}
-    #createWeb .additionalSettings .foswikiFormSteps {background:#fff;}
     #createWeb .additionalSettings .foswikiFormStep {padding:5px 10px;}
 </style>"}%
 <!-- %JQREQUIRE{"popupwindow"}% -->

diff --git a/core/data/System/PageCaching.txt b/core/data/System/PageCaching.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1486929101" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454598" format="1.1" version="1"}%
 %META:TOPICPARENT{name="AdminDocumentationCategory"}%
 ---+!! Page Caching
 How to get the best from HTML Caching.
@@ -91,7 +91,7 @@ need recomputation.
 The general pattern for asynchronously loaded page fragments looks like this:
 
 <verbatim class="tml">
-<verbatim class="jqLoader {section:'name_of_section'}">
+<verbatim class="jqLoader" data-section="name_of_section">
 %STARTSECTION{"name_of_section"}%
 %SEARCH{
 ...

diff --git a/core/data/System/PerlDependencyReport.txt b/core/data/System/PerlDependencyReport.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1460215225" format="1.1"  version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="InstallationGuide"}%
 ---+!! Perl dependencies for Foswiki and Extensions
 
@@ -43,3 +43,5 @@ Note: If a minimum version is identified, the extension requiring the highest mi
 %PERLDEPENDENCYREPORT{"extensions" include="%URLPARAM{"include" default="missing"}%"}%
 </noautolink>
 %META:PREFERENCE{name="CACHEABLE" title="CACHEABLE" type="Set" value="off"}%
+%META:PREFERENCE{name="ALLOWTOPICVIEW" title="ALLOWTOPICVIEW" type="Set" value="AdminUser"}%
+%META:PREFERENCE{name="PERMSET_VIEW" title="PERMSET_VIEW" type="Local" value="nobody"}%
diff --git a/core/data/System/SearchPatternCookbook.txt b/core/data/System/SearchPatternCookbook.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="UserDocumentationCategory"}%
 ---+!! Search Pattern Cookbook
 
@@ -166,7 +166,6 @@ This will create similar functionality as Foswiki:Extensions.TopicClassification
 
 %INCLUDE{"%WEB%.%TOPIC%" section="click2exec" id="solution5"}%
 
-
 <!-- ============================== -->
 #SearchTopicParent
 ---++ Pattern 3: Extract the parent of a given topic
@@ -187,7 +186,6 @@ Parent of [[%TOPIC%]] is [[%QUERY{ "parent.name" }%]]
 
 %INCLUDE{"%WEB%.%TOPIC%" section="click2exec" id="solution6"}%
 
-
 <!-- ============================== -->
 #SearchTopicChildren
 ---++ Pattern 4: Show all Children of a given topic
@@ -364,7 +362,7 @@ Use the =$pattern()= token.
 %STARTSECTION{"click2exec"}%
 %BUTTON{"Click to execute" onclick="jQuery('#%id%').trigger('refresh')"}%
 
-<div class="jqLoader {mode:'manual', web:'%INCLUDINGWEB%', topic:'%INCLUDINGTOPIC%', section:'%id%'}" id="%id%"></div>
+<div class="jqLoader" data-mode="manual" data-web="%INCLUDINGWEB%" data-topic="%INCLUDINGTOPIC%" data-section="%id%" id="%id%"></div>
 %JQREQUIRE{"loader"}%
 %ENDSECTION{"click2exec"}%
 </verbatim>

diff --git a/core/data/System/SitePermissions.txt b/core/data/System/SitePermissions.txt
@@ -1,6 +1,7 @@
-%META:TOPICINFO{author="ProjectContributor" date="1434484983" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="AdminToolsCategory"}%
-----
+---+!! %TOPIC%
+
 Permissions settings of the webs on this Foswiki site
 %STARTINCLUDE%
 | *Web* | *Sitemap* | *VIEW* || *CHANGE* || *RENAME* ||

diff --git a/core/data/System/SkinTemplates.txt b/core/data/System/SkinTemplates.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="" date="1599028794" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1655454598" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Skins"}%
 %STARTINCLUDE%
 ---+ Skin Templates

diff --git a/core/data/System/VarUSERINFO.txt b/core/data/System/VarUSERINFO.txt
@@ -1,8 +1,8 @@
-%META:TOPICINFO{author="ProjectContributor" date="1456368117" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Macros"}%
 ---+ USERINFO -- retrieve details about a user
 ---++ Parameters
-   | *Parameter* | *Description* |
+   | *Parameter* | *Description* | *Default* |
    | ="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=:

diff --git a/core/data/System/WebPreferences.txt b/core/data/System/WebPreferences.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1636961353" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %META:TOPICPARENT{name="WebHome"}%
 ---+!! <nop>%WEB% Web Preferences
 
@@ -25,14 +25,13 @@
    * WebTopicEditTemplate
       * default template for new topics in this web, if this topic does not exist,  [[%SYSTEMWEB%.WebTopicEditTemplate][site-level default template]] will be used
 
-   * Set WEBFORMS = DefaultPreferencesForm, FAQForm
+   * Set WEBFORMS = DefaultPreferencesForm, FAQForm, PackageForm
       * Comma separated list of *forms* that can be attached to topics in this web. See [[%SYSTEMWEB%.DataForms][DataForms]] for more information.
 
 ---++ Copyright notice 
 
    * Set WEBCOPYRIGHT = <span class="foswikiRight"> <a href="https://foswiki.org/"><img src="%PUBURLPATH%/%SYSTEMWEB%/ProjectLogos/foswiki-badge.png" height="42" alt="This site is powered by Foswiki" title="This site is powered by Foswiki" /></a></span>%MAKETEXT{"Copyright &&copy; by the contributing authors. All material on this site is the property of the contributing authors." args="1999-%GMTIME{$year}%"}% <br /> %MAKETEXT{"Ideas, requests, problems regarding [_1]? <a href='[_2]'>Send feedback</a>" args="<nop>%WIKITOOLNAME%,mailto:%WIKIWEBMASTER%?subject=%WIKITOOLNAME%%20Feedback%20on%20%BASEWEB%.%BASETOPIC%"}% %IF{"$ WEB= $ SYSTEMWEB" then=""}%
 
-
 ---++ Access control
 
 Users or groups who are allowed to view, change and rename topics in the <nop>%WEB% web. Public sites should consider denying %USERSWEB%.WikiGuest

diff --git a/core/data/System/WebTopicEditTemplate.txt b/core/data/System/WebTopicEditTemplate.txt
@@ -1,10 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1470328019" format="1.1" version="1"}%
-
-
-
-
-
--- %WIKIUSERNAME% - %DATE%
+%META:TOPICINFO{author="ProjectContributor" date="1655454502" format="1.1" version="1"}%
 %STARTSECTION{type="templateonly"}%
 This topic is needed for normal operation even if System web is restricted.
    * Set ALLOWTOPICVIEW = *