Item13883: docu fixes

- do not hardcode table colors as this looks odd in dark mode - use relative %INCLUDEs in the System web - make sure headings are looking fine
foswiki · Jun 22, 2022 · bf6a335 · bf6a335
1 parent 8f3e8f6
commit bf6a335
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 58 deletions.
diff --git a/CommentPlugin/data/System/CommentPlugin.txt b/CommentPlugin/data/System/CommentPlugin.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Plugins"}%
 ---+!! Comment Plugin
 %FORMFIELD{"Description"}%
@@ -28,7 +28,7 @@ Uses Javascript (if available) to ensure feedback is as rapid as possible.
 ---++ Syntax
 #StandardAttrs
 Write =%<nop>COMMENT{<i>attributes</i>}%= anywhere in a topic.
-%INCLUDE{"%SYSTEMWEB%.VarCOMMENT" section="comment_attributes"}%
+%INCLUDE{"VarCOMMENT" section="comment_attributes"}%
 (See also [[#MoreAttrs][additional attributes]])
 
 ---+++ Positioning the comment

diff --git a/EditTablePlugin/data/System/EditTablePlugin.txt b/EditTablePlugin/data/System/EditTablePlugin.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Plugins"}%
 ---+!! Edit Table Plugin
 %FORMFIELD{"Description"}%
@@ -14,7 +14,7 @@ Multiple tables per topic are editable, but only one at a time can be edited.
 ---++ Per Table Settings
 
 Add a =%<nop>EDITTABLE{...}%= macro just before an existing table to make it editable, or add the variable anywhere in a topic to start a new table.
-%INCLUDE{"%SYSTEMWEB%.VarEDITTABLE" section="edittable_attributes"}%
+%INCLUDE{"VarEDITTABLE" section="edittable_attributes"}%
 
 ---+++ Using Macros in the Format Parameter
 
@@ -270,15 +270,15 @@ Test if the Plugin is correctly installed:
 %META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/%TOPIC%"}%
 %META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/%TOPIC%"}%
 %META:FIELD{name="Version" title="Version" value="%$VERSION%"}%
-%META:FILEATTACHMENT{name="EditTablePluginCalendarExample.gif" attr="h" comment="" date="1655468868" size="7823" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="ScreenshotEditCell1.gif" attr="h" comment="" date="1655468868" size="2017" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="ScreenshotEditCell2.gif" attr="h" comment="" date="1655468868" size="3199" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="img.gif" attr="h" comment="" date="1655468868" size="145" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="menuarrow.gif" attr="h" comment="" date="1655468868" size="68" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="edittable.gif" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="btn_move.gif" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="btn_delete.gif" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="btn_delete_disabled.gif" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="edittable.css" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="edittable.js" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="move_done_bg_anim.gif" attr="h" comment="" date="1655468868" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="EditTablePluginCalendarExample.gif" attr="h" comment="" date="1655899072" size="7823" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="ScreenshotEditCell1.gif" attr="h" comment="" date="1655899072" size="2017" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="ScreenshotEditCell2.gif" attr="h" comment="" date="1655899072" size="3199" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="img.gif" attr="h" comment="" date="1655899072" size="145" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="menuarrow.gif" attr="h" comment="" date="1655899072" size="68" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="edittable.gif" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="btn_move.gif" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="btn_delete.gif" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="btn_delete_disabled.gif" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="edittable.css" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="edittable.js" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="move_done_bg_anim.gif" attr="h" comment="" date="1655899072" size="298" user="ProjectContributor" version="1"}%
diff --git a/HistoryPlugin/data/System/HistoryPlugin.txt b/HistoryPlugin/data/System/HistoryPlugin.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="" date="1605548606" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Plugins"}%
 ---+ History Plugin
 
@@ -19,7 +19,7 @@ This plugins is designed to work together with !CompareRevisionsAddOn and !RevCo
 ---++ Syntax Rules
 Syntax: =%<nop>HISTORY{ _attributes_ }%=
 
-%INCLUDE{"%SYSTEMWEB%.VarHISTORY" section="history_attributes"}%
+%INCLUDE{"VarHISTORY" section="history_attributes"}%
 
 ---++ Custom settings:
 
@@ -49,13 +49,11 @@ Example screenshot of the topic history with !HistoryPlugin enabled and working
 ---++ Installation Instructions
 %$INSTALL_INSTRUCTIONS%
 
-
 Test if the installation was successful:
    * Here should appear the history of this document inline:
      %HISTORY{"r1.$rev - $date - $wikiusername"}% <!-- -->
    * [[%SCRIPTURLPATH{oops}%/%USERSWEB%/%WIKIUSERSTOPIC%?template=oopshistory][Show the history of %USERSWEB%.%WIKIUSERSTOPIC%]]
 
-
 ---++ Dependencies
 %$DEPENDENCIES%
 
@@ -86,12 +84,12 @@ Test if the installation was successful:
 
 %META:FORM{name="PackageForm"}%
 %META:FIELD{name="Author" title="Author" value="Foswiki:Main.KennethLavrsen"}%
-%META:FIELD{name="Copyright" title="Copyright" value=" 2006, !JChristophFuchs; 2008-2020 Kenneth Lavrsen and Foswiki Contributors"}%
-%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
-%META:FIELD{name="Home" title="Home" value="https://foswiki.org/Extensions/HistoryPlugin"}%
+%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
 %META:FIELD{name="Release" title="Release" value="%25$RELEASE%25"}%
+%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
+%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
+%META:FIELD{name="Copyright" title="Copyright" value=" 2006, !JChristophFuchs; 2008-2020 Kenneth Lavrsen and Foswiki Contributors"}%
 %META:FIELD{name="License" title="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
-%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
+%META:FIELD{name="Home" title="Home" value="https://foswiki.org/Extensions/HistoryPlugin"}%
 %META:FIELD{name="Support" title="Support" value="https://foswiki.org/Support/HistoryPlugin"}%
-%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
-%META:FILEATTACHMENT{name="screenshot.png" attr="h" comment="" date="1605548606" size="72043" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="screenshot.png" attr="h" comment="" date="1655899072" size="72043" user="ProjectContributor" version="1"}%
diff --git a/HistoryPlugin/data/System/VarHISTORY.txt b/HistoryPlugin/data/System/VarHISTORY.txt
@@ -1,10 +1,10 @@
-%META:TOPICINFO{author="ProjectContributor" date="1434650530" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Macros"}%
 ---+ HISTORY -- control attributes of tables and sorting of table columns
 The =%<nop>HISTORY{}%= macro is handled by the HistoryPlugin
 ---++ Parameters
      %STARTSECTION{"history_attributes"}%
-     %TABLE{tablewidth="100%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+     %TABLE{tablewidth="100%" sort="off"}%
      | *Parameter*         | *Description*  | *Default*  |
      | ="format"= <br /> =format="format"= | Format of one line, may include any variable which is supported by macro [[%SYSTEMWEB%.VarREVINFO][REVINFO]] | <code>r$rev - $date - $wikiusername</code> |
      | =topic= | Topic name, can be in =web.topic= format | current topic |
@@ -24,7 +24,7 @@ The =%<nop>HISTORY{}%= macro is handled by the HistoryPlugin
      | =footer="text"= | Text to print after the list. May contain the tokens =$next= and =$previous= (see =header=) | =$previous= |
 
 Deprecated (but supported) parameters:
-     %TABLE{tablewidth="100%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+     %TABLE{tablewidth="100%" sort="off"}%
      | *Parameter*         | *Description*  | *Default*  |
      | =nrev= | Number of revisions to show. Ignored if =versions= is specified, or if both =rev1= and =rev2= are specified. | =10= |
      | =rev2= | Newest revision to show | =rev1+nrev= if =rev1= is specified, latest revision otherwise |

diff --git a/InterwikiPlugin/data/System/InterWikis.txt b/InterwikiPlugin/data/System/InterWikis.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="" date="1525396870" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="InterwikiPlugin"}%
 ---+ <nop>Inter-Wiki Link Rules (or Links to other Sites)
 
@@ -10,10 +10,10 @@ Whenever you write ==ExternalSite:Page== it will be linked automatically to the
 
 ---+++ How to define Inter-Wiki Links
 
-Inter-wiki links are defined in the tables below.  %INCLUDE{"%SYSTEMWEB%.InterwikiPlugin" section="aliasformat"}%
+Inter-wiki links are defined in the tables below.  %INCLUDE{"InterwikiPlugin" section="aliasformat"}%
 
 The optional INTERLINKFORMAT override can incorporate the following tokens
-which are expanded when the link is generated:%INCLUDE{"%SYSTEMWEB%.InterwikiPlugin" section="formattokens"}%
+which are expanded when the link is generated:%INCLUDE{"InterwikiPlugin" section="formattokens"}%
 
 See %SYSTEMWEB%.InterwikiPlugin for more details on specifiying the INTERLINKFORMAT.
 

diff --git a/TablePlugin/data/System/TablePlugin.txt b/TablePlugin/data/System/TablePlugin.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Plugins"}%
 ---+ Table Plugin
 %FORMFIELD{"Description"}%
@@ -15,7 +15,7 @@ Gives extra control of table display:
 ---++ Table Attributes
 
 Attributes are defined as a =TABLEPLUGIN_TABLEATTRIBUTES= [[%SYSTEMWEB%.PreferenceSettings][preference]], or on the line before the table using =%<nop>TABLE{...}%=:
-%INCLUDE{"%SYSTEMWEB%.VarTABLE" section="table_attributes"}%
+%INCLUDE{"VarTABLE" section="table_attributes"}%
 
 ---+++ Specifying and overriding attributes
 Table attributes can be set in different ways. In top down order:

diff --git a/TablePlugin/data/System/VarTABLE.txt b/TablePlugin/data/System/VarTABLE.txt
@@ -1,10 +1,10 @@
-%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Macros"}%
 ---+ TABLE -- control attributes of tables and sorting of table columns
 The =%<nop>TABLE{}%= macro is handled by the TablePlugin
 %STARTSECTION{"table_attributes"}%
 ---++++ Attributes for tables
-%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off"}%
      | *Parameter*         | *Description*  | *Default*  | *Example*  |
      | =tableborder=      | Table border width (pixels). | ="1"= | =tableborder="2"= |
      | =tablebordercolor= | Table border color. | <span class="foswikiGrayText">unspecified</span> | =tablebordercolor="#333"= |
@@ -20,15 +20,15 @@ The =%<nop>TABLE{}%= macro is handled by the TablePlugin
      | =class=            | Add specified class to the default =foswikiTable= class. | <span class="foswikiGrayText">unspecified</span> | =class="mytable"= |
 
 ---++++ Attributes for table sorting
-%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off"}%
      | *Parameter*       | *Description*  | *Default*  | *Example*  |
      | =sort=           | Set the table sorting user interface (clickable column headers) ="on"= or ="off"=. | <span class="foswikiGrayText">unspecified</span> | =sort="on"= |
      | =initsort=       | Column to sort initially (use ="1"= for the first column). If specified, sorting is enabled; by setting =sort="off"= the sorting interface can be hidden. | <span class="foswikiGrayText">unspecified</span> | =initsort="2"= |
      | =initdirection=  | Initial sorting direction for =initsort=, set to  ="up"= (descending, or decreasing in value) or ="down"= (ascending, or increasing in value). | =down= | =initdirection="up"= |
      | =disableallsort= | Disable all sorting, both initsort and header sort. This is mainly used by plugins such as the EditTablePlugin to disable sorting in a table while editing the table. | <span class="foswikiGrayText">unspecified</span> | =disableallsort="on"= |
 
 ---++++ Attributes for table cells
-%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off"}%
      | *Argument*       | *Description*  | *Default*  | *Example*  |
      | =cellpadding=    | Cell padding (pixels). | <span class="foswikiGrayText">unspecified</span> | =cellpadding="0"= |
      | =cellspacing=    | Cell spacing (pixels). | <span class="foswikiGrayText">unspecified</span> | =cellspacing="3"= |
@@ -37,7 +37,7 @@ The =%<nop>TABLE{}%= macro is handled by the TablePlugin
      | =columnwidths=   | Column widths: Comma delimited list of column widths, percentage or absolute pixel value. | <span class="foswikiGrayText">unspecified</span>  | =columnwidths="80%,20%"= |
 
 ---++++ Attributes for data cells
-%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off"}%
      | *Parameter*       | *Description*  | *Default*  | *Example*  |
      | =datarules=    | Set to ="none"= (no rules), ="rows"= (rules will appear between rows only), ="cols"= (rules will appear between columns only), ="all"= (rules will appear between all rows and columns). Overrides =tablerules= for data cells. | <span class="foswikiGrayText">unspecified</span>  | =datarules="none"= |
      | =datavalign=     | Vertical alignment of data cells; overrides =valign=. | <span class="foswikiGrayText">unspecified</span>  | =datavalign="top"= |
@@ -47,7 +47,7 @@ The =%<nop>TABLE{}%= macro is handled by the TablePlugin
      | =datacolor=      | Data cell text colour, a comma separated list. | <span class="foswikiGrayText">unspecified</span> | =datacolor="#00c, #000"= |
 
 ---++++ Attributes for headers
-%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off"}%
      | *Parameter*       | *Description*  | *Default*  | *Example*  |
      | =headerrules=    | Set to ="none"= (no rules), ="rows"= (rules will appear between rows only), ="cols"= (rules will appear between columns only), ="all"= (rules will appear between all rows and columns). Overrides =tablerules= for header cells. | <span class="foswikiGrayText">unspecified</span>  | =headerrules="none"= |
      | =headerbg=       | Header cell background colour. Specify ="none"= for no colour, that is to use the colour/background of the page the table is on. | ="#6b7f93"= | =headerbg="#999"= |
@@ -56,9 +56,9 @@ The =%<nop>TABLE{}%= macro is handled by the TablePlugin
      | =headervalign=   | Vertical alignment of header cells; overrides =valign=. | <span class="foswikiGrayText">unspecified</span>  | =headervalign="top"= |
      | =headeralign=    | Header cell alignment, one value for all columns, or a comma separated list for different alignment of individual columns. Set to ="left"=, ="center"=, ="right"= or ="justify"=. Overrides individual cell settings. | <span class="foswikiGrayText">unspecified</span>  | =headeralign="left,right"= |
      | =headerrows=     | See: Attributes for tables |||
-     
+
 ---++++ Other attributes
-%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off" headerbg="#f5f5f5" databg="#ffffff" headercolor="#333333"}%
+%TABLE{tablewidth="100%" columnwidths="10%,45%,20%,25%" sort="off"}%
      | *Parameter*       | *Description*  | *Default*  | *Example*  |
      | =include=        | Other topic defining the =TABLE= parameters. The first =%<nop>TABLE%= in the topic is used. This is useful if you have many topics with the same table format and you want to update the format in one place. Use =topic= or =web.topic= notation. | <span class="foswikiGrayText">unspecified</span> | =include="%USERSWEB%.%HOMETOPIC%"= |
 

diff --git a/TopicUserMappingContrib/data/System/UserForm.txt b/TopicUserMappingContrib/data/System/UserForm.txt
@@ -1,11 +1,11 @@
-%META:TOPICINFO{author="ProjectContributor" date="1447730097" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="AdminToolsCategory"}%
 ---+ User Form
 
 This is a maintenance topic, used by the Wiki administrator.
 
 ---++ Data form definition of user topics
-%INCLUDE{"%SYSTEMWEB%.UserFormHelp" section="note"}%
+%INCLUDE{"UserFormHelp" section="note"}%
 
 |*Name*  |*Type*  |*Size*  |*Values*  |*Tooltip message*  |*Attributes*  |
 | <nop>FirstName | text | 40 | | | |
@@ -24,5 +24,5 @@ This is a maintenance topic, used by the Wiki administrator.
 | <nop>HomePage | text | 40 | | | |
 | Comment | textarea | 50x6 | | | |
 
-%INCLUDE{"%SYSTEMWEB%.UserFormHelp" section="customform"}%
+%INCLUDE{"UserFormHelp" section="customform"}%
 %META:PREFERENCE{name="ALLOWTOPICVIEW" title="ALLOWTOPICVIEW" type="Set" value="*"}%
diff --git a/WysiwygPlugin/data/System/WysiwygPlugin.txt b/WysiwygPlugin/data/System/WysiwygPlugin.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655899072" format="1.1" version="1"}%
 %META:TOPICPARENT{name="Plugins"}%
 ---+!! Wysiwyg Plugin
 %FORMFIELD{"Description"}%
@@ -125,7 +125,7 @@ Converts the TML text to HTML. =topic= *must* be specified. The response is a =t
 ---++ Plugin Configuration Settings
 
 ---+++ Translator control
-%INCLUDE{"%SYSTEMWEB%.WysiwygPluginSettings"}%
+%INCLUDE{"WysiwygPluginSettings"}%
 
 *Implementors note* if you are using your own before/after edit handlers, you can call =Foswiki::Plugins::WysiwygPlugin::isWysiwygEditable()= to check these controls.
 

diff --git a/core/data/System/FAQViewTemplate.txt b/core/data/System/FAQViewTemplate.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" date="1505958329" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1655897812" format="1.1" version="1"}%
 %META:TOPICPARENT{name="FAQForm"}%
 %{
 ---+ FAQ topic templates
@@ -19,7 +19,7 @@ Override the content template DEFinition. This normally just contains %TEXT%,
 but we add some more here to help decorate all the [[FAQForm]] topics in the
 same way.
 <verbatim class="tml">
-}%%TMPL:DEF{"content"}%
+}%%TMPL:DEF{"content"}%<!-- -->
 ---+ Question: %FORMFIELD{"TopicSummary"}%
 ---++ Answer
 %TEXT%