Skip to content

Commit

Permalink
Item13883: docu fixes
Browse files Browse the repository at this point in the history
- normalized extension pages
- removed exessive use of chili
  • Loading branch information
MichaelDaum committed Jun 17, 2022
1 parent 346a589 commit 3ddaa8d
Show file tree
Hide file tree
Showing 133 changed files with 1,791 additions and 1,901 deletions.
24 changes: 10 additions & 14 deletions AutoViewTemplatePlugin/data/System/AutoViewTemplatePlugin.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%META:TOPICINFO{author="ProjectContributor" date="1460168492" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
---+ <nop>AutoViewTemplatePlugin
%SHORTDESCRIPTION%
%FORMFIELD{"Description"}%

---++ Description
This plugin sets the VIEW_TEMPLATE and EDIT_TEMPLATE variables according to a
Expand Down Expand Up @@ -67,16 +67,11 @@ The following settings can be defined in configure
| {Plugins}{AutoViewTemplatePlugin}{Override} | Form defined templates override VIEW_TEMPLATE and EDIT_TEMPLATE settings | Default: Off |
| {Plugins}{AutoViewTemplatePlugin}{Mode} | The mode the plugin uses for defining templates. <br /> =exist= for deriving the template name from the form name <br /> =section= for defining the template in a section of the form definition topic | Default: =exist= |

---++ Plugin Installation Instructions
---++ Installation Instructions
%$INSTALL_INSTRUCTIONS%


---++ Plugin Info
<!--
* Set SHORTDESCRIPTION = Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
%JQREQUIRE{"chili"}%
-->
| Change History: | <!-- versions below in reverse order -->&nbsp; |
---++ Change History
%TABLE{columnwidths="7em" tablewidth="100%"}%
| 8 Apr 2016: | Released with Foswiki 2.1.1. Foswikitask:Item14014: Template files not working in hierarchical webs. |
| 7 Dec 2015: | Released with Foswiki 2.1. Foswikitask:Item13554: Enable non-ascii template names. |
| 18 Aug 2015: | Foswikitask:Item13625: AutoViewTemplatePlugin: reports Invalid template name ( Warning: Can't find named section viewtemplate in topic...) when used in "section" mode and no section exists. |
Expand All @@ -101,11 +96,12 @@ The following settings can be defined in configure
| Other Dependencies: | none |

%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="Foswiki:Main.OliverKrueger, Foswiki:Main.MichaelDaum"}%
%META:FIELD{name="Copyright" title="Copyright" value="&copy; 2008-2009, Oliver Krueger"}%
%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
%META:FIELD{name="Home" title="Home" value="Foswiki:Extensions/AutoViewTemplatePlugin"}%
%META:FIELD{name="Version" title="Version" value="%$VERSION%"}%
%META:FIELD{name="License" title="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
%META:FIELD{name="Author" title="Author" value="Foswiki:Main.OliverKrueger, Foswiki:Main.MichaelDaum"}%
%META:FIELD{name="Release" title="Release" value="%$RELEASE%"}%
%META:FIELD{name="Copyright" title="Copyright" value="&copy; 2008-2009, Oliver Krueger"}%
%META:FIELD{name="Support" title="Support" value="Foswiki:Extensions/AutoViewTemplatePlugin"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Support" title="Support" value="Foswiki:Extensions/AutoViewTemplatePlugin"}%
%META:FIELD{name="Version" title="Version" value="%$VERSION%"}%
5 changes: 2 additions & 3 deletions BuildContrib/data/System/BuildContrib.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1651080173" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
%META:TOPICPARENT{name="Contribs"}%
---+!! Foswiki Developer Environment
<img src="%ATTACHURLPATH%/logo.gif" alt="logo" class="foswikiRight" />
Expand Down Expand Up @@ -643,15 +643,13 @@ histories are preserved.

If you want your installer to do anything else then you will need to write a [[#InstallScripts][POSTINSTALL script]].

<!-- %JQREQUIRE{"chili"}% -->

---++ Installation Instructions
You are strongly recommended to use this Contrib to help split your code development away from your live Foswiki environment, as described [[#DevelopmentModel][above]].

%$INSTALL_INSTRUCTIONS%


%META:FILEATTACHMENT{name="logo.gif" attr="" comment="logo" date="1651080173" size="14169" user="ProjectContributor" version="1"}%
%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="[[http://c-dot.co.uk][Crawford Currie]]"}%
%META:FIELD{name="Copyright" title="Copyright" value="Foswiki Contributors 2004-2022, All Rights Reserved"}%
Expand All @@ -662,3 +660,4 @@ You are strongly recommended to use this Contrib to help split your code develop
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/BuildContrib"}%
%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
%META:FILEATTACHMENT{name="logo.gif" attr="" comment="logo" date="1655468868" size="14169" user="ProjectContributor" version="1"}%
22 changes: 9 additions & 13 deletions CommentPlugin/data/System/CommentPlugin.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1602600476" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
%META:TOPICPARENT{name="Plugins"}%
---+!! Comment Plugin
%FORMFIELD{"Description"}%

Comment Plugin lets users quickly post comments to a page without an edit/preview/save cycle.

Expand Down Expand Up @@ -251,10 +252,6 @@ If default permissions are not configured, then commenting will be permitted.
</div>

---++ Settings
<!-- Not used by the plugin
* Set SHORTDESCRIPTION = %$SHORTDESCRIPTION%
%JQREQUIRE{"chili"}%
-->
Two [[%SYSTEMWEB%.PreferenceSettings][preference settings]] are recognised by the CommentPlugin:
| *Preference* | *Default* | *Description* |
| =%<nop>COMMENTPLUGIN_TEMPLATES%= | =comments= | Name of template file in the 'templates' directory that contains the comment templates. The default 'comments.tmpl' automatically includes user templates from %SYSTEMWEB%.CommentPluginTemplate, which in turn includes %SYSTEMWEB%.UserCommentsTemplate. |
Expand All @@ -275,9 +272,8 @@ This plugin has been significantly changed from the =10 April 2011= version ship
* The plugin uses a =rest= handler to update topics. By default this script does not require authentication, and can now permit anonymous commenting. Examine the [[%SCRIPTURL{"configure"}%]] ( =Security and Authentication= tab, =Login= sub-tab ) configuration ={AuthScripts}= setting, and the scripts requiring authentication in the Apache configuration.
* The plugin no longer processes %COMMENT macros during save. If you have developed any forms using the [[%SANDBOXWEB%.CommentPluginExamples#NoForm][=noform= and =templatetopic= examples]] they must be revised.

---++ Info

| Change History: | |
---++ Change History
%TABLE{columnwidths="7em" tablewidth="100%"}%
| 2.94 (13 Oct 2020) | Foswikitask:Item14941: only load comment.js and comment.css on pages where it is required |
| 2.93 (22 Jan 2018) | Foswikitask:Item14554: remove link to unused wikiring.com domain.<br/>\
Foswikitask:Item14605: Unescaped brace in Regular Expression, Perl 5.27.8. |
Expand Down Expand Up @@ -325,13 +321,13 @@ This plugin has been significantly changed from the =10 April 2011= version ship
| 16 Dec 2008 | Foswiki version |
| 06 Mar 2002 | initial commit |


%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="Foswiki:Main.CrawfordCurrie http://www.c-dot.co.uk inspired by the work of TWiki:Main.DavidWeller and TWiki:Main.PeterMasiar"}%
%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
%META:FIELD{name="Release" title="Release" value="%25$RELEASE%25"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Copyright" title="Copyright" value="&copy; 2004, Foswiki:Main.CrawfordCurrie<br />&copy; 2004-2020 Foswiki:%25SYSTEMWEB%25.ProjectContributor"}%
%META:FIELD{name="License" title="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
%META:FIELD{name="Home" title="Home" value="http://foswiki.org/Extensions/CommentPlugin"}%
%META:FIELD{name="License" title="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
%META:FIELD{name="Release" title="Release" value="%25$RELEASE%25"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/CommentPlugin"}%
%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
28 changes: 12 additions & 16 deletions CompareRevisionsAddOn/data/System/CompareRevisionsAddOn.txt
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
%META:TOPICINFO{author="ProjectContributor" comment="" date="1493947845" format="1.1" version="1"}%
<!--
One line description, required for extensions repository catalog.
* Set SHORTDESCRIPTION = %$SHORTDESCRIPTION%
%JQREQUIRE{"chili"}%
-->
%SHORTDESCRIPTION%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
---+!! %TOPIC%
%FORMFIELD{"Description"}%

%TOC%

Expand Down Expand Up @@ -130,10 +126,11 @@ This Add-On comes pre-installed on Foswiki. You should only need to re-install i
* This plugin will support the HistoryPlugin, if it is enabled
* If you disable this plugin, the skin will behave like standard <nop>PatternSkin again

---++ Add-On Info
---++ Dependencies
%$DEPENDENCIES%

| Copyright &copy;: | 2006, !JChristophFuchs; 2008-2015 Kenneth Lavrsen and Foswiki Contributors |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
---++ Change History
%TABLE{columnwidths="7em" tablewidth="100%"}%
| 04 May 2017 (1.115) | Foswikitask:Item14366: <code>use CGI::Carp</code> in bin scripts BEGIN block cannot be found via LocalLib.cfg override. |
| 14 Jun 2015 (1.114) | Foswikitask:Item13423: Perl 5.22 deprecations. Foswikitask:Item13378: Support utf-8 internally. |
| 18 Dec 2014 (1.113) | Foswikitask:Item13068: Remove the CompareRevisionsAddOn demo, don't ship revision history<br />\
Expand Down Expand Up @@ -172,19 +169,18 @@ This Add-On comes pre-installed on Foswiki. You should only need to re-install i
| 02 Mar 2005 | Corrected bug concerning uninitialized elements |
| 03 Feb 2005 | Removed blank paragraphs before comparing |
| 20 Jan 2005 | Initial version |
| Dependencies: | %$DEPENDENCIES% |
| Add-on Home: | http://foswiki.org/Extensions/%TOPIC% |
__Related Topic:__ %SYSTEMWEB%.ContributedAddOns

__Related Topic:__ %SYSTEMWEB%.ContributedAddOns

%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="Foswiki:Main.KennethLavrsen"}%
%META:FIELD{name="Copyright" title="Copyright" value="Foswiki Contributors, 2008-2015 All Rights Reserved"}%
%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
%META:FIELD{name="Home" title="Home" value="http://foswiki.org/Extensions/%25$ROOTMODULE%25"}%
%META:FIELD{name="License" title="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
%META:FIELD{name="Release" title="Release" value="%25$RELEASE%25"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/%25$ROOTMODULE%25"}%
%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FILEATTACHMENT{name="interweave.png" attr="h" comment="" date="1493947845" size="28786" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="sidebyside.png" attr="h" comment="" date="1493947845" size="48991" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="interweave.png" attr="h" comment="" date="1655468868" size="28786" user="ProjectContributor" version="1"}%
%META:FILEATTACHMENT{name="sidebyside.png" attr="h" comment="" date="1655468868" size="48991" user="ProjectContributor" version="1"}%
27 changes: 15 additions & 12 deletions CompareRevisionsAddOn/data/System/CompareRevisionsAddonPlugin.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
%META:TOPICINFO{author="ProjectContributor" date="1491685944" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
%META:TOPICPARENT{name="CompareRevisionsAddOn"}%

---+ !CompareRevisionsAddOn Plugin
%FORMFIELD{"Description"}%

This is an helper plugin for the CompareRevisionsAddOn on Foswiki

Expand All @@ -24,14 +24,8 @@ It should be enabled (if necessary) with the configure script.

Test: <nop>CompareRevisionsAddOnPlugin is %IF{"context CompareRevisionsAddOnPluginEnabled" then="" else="*not* "}%installed and enabled.

---++ Plugin Info

| Plugin Author: | Foswiki:Main.KennethLavrsen |
| Copyright &copy;: | 2006, !JChristophFuchs; 2008-2014 Kenneth Lavrsen and Foswiki Contributors |
| License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
| Version: | %$VERSION% |
| Release: | %$RELEASE% |
| Change History: | <!-- versions below in reverse order -->&nbsp; |
---++ Change History
%TABLE{columnwidths="7em" tablewidth="100%"}%
| 08 Apr 2017 (1.115) | Foswikitask:Item14366: Reorder initialization to allow local CGI::Carp. |
| 01 May 2014 (1.112) | Foswikitask:Item12407: Don't decode entities during comparson. Convert to simple decimal version. |
| 10 Feb 2014 | Foswikitask:Item12741: Formatting parameters not passed on the referenced scripts |
Expand Down Expand Up @@ -61,7 +55,16 @@ Test: <nop>CompareRevisionsAddOnPlugin is %IF{"context CompareRevisionsAddOnPlug
| CPAN Dependencies: | none |
| Other Dependencies: | none |
| Perl Version: | 5.008 |
| Plugin Home: | http://foswiki.org/Extensions/CompareRevisionsAddOn |
| Support: | http://foswiki.org/Support/CompareRevisionsAddOn |

__Related Topics:__ DeveloperDocumentationCategory, AdminDocumentationCategory, %SYSTEMWEB%.%WIKIPREFSTOPIC%, %LOCALSITEPREFS%, [[%SYSTEMWEB%.Plugins][Plugins]]

%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="Foswiki:Main.KennethLavrsen"}%
%META:FIELD{name="Copyright" title="Copyright" value="2006, !JChristophFuchs; 2008-2014 Kenneth Lavrsen and Foswiki Contributors"}%
%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
%META:FIELD{name="Home" title="Home" value="http://foswiki.org/Extensions/CompareRevisionsAddOn"}%
%META:FIELD{name="License" title="License" value="GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]])"}%
%META:FIELD{name="Release" title="Release" value="%$RELEASE%"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/%TOPIC%"}%
%META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/CompareRevisionsAddOn"}%
%META:FIELD{name="Version" title="Version" value="%$VERSION%"}%
3 changes: 2 additions & 1 deletion ConfigurePlugin/data/System/ConfigurePlugin.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
%META:TOPICINFO{author="ProjectContributor" date="1612081462" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
%META:TOPICPARENT{name="Plugins"}%
---+!! Configure Plugin
%FORMFIELD{"Description"}%
Expand Down Expand Up @@ -42,6 +42,7 @@ The plugin uses the =JsonRpcContrib=, which must be installed.

---++ Change History

%TABLE{columnwidths="7em" tablewidth="100%"}%
| 31 Jan 2021: | (1.11) Foswikitask:Item15014: Prevent password fields form being auto-filled |
| 17 Apr 2020: | (1.10) Foswikitask:Item14901: Add support for XML and CERT data types in configure pages |
| 08 Dec 2017: | (1.09) Foswikitask:Item14536: Configure leaves "wait" cursor spinning while waiting for user action.<br/>\
Expand Down
27 changes: 13 additions & 14 deletions EditRowPlugin/data/System/EditRowPlugin.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1655377101" format="1.1" version="1"}%
%META:TOPICINFO{author="ProjectContributor" date="1655468868" format="1.1" version="1"}%
---+!! !EditRowPlugin
%FORMFIELD{"Description"}%

<!--
One line description, required for extensions repository catalog.
* Set SHORTDESCRIPTION = Replacement for some of !EditTablePlugin, some of !EditTablerowPlugin and some of !TablePlugin.
%JQREQUIRE{"UI"}%
* Set UICON = <button type="button" class="ui-icon erp-button ui-icon-
* Set NOCIU = " ></button>
Expand All @@ -13,8 +14,6 @@ One line description, required for extensions repository catalog.
</style>
</literal>

%SHORTDESCRIPTION%

%TOC%

<img src="%ATTACHURLPATH%/screenshot1.png" alt="screenshot" />
Expand Down Expand Up @@ -267,9 +266,11 @@ All parameters to an applicable =%TABLE= macro are respected. If the same settin
Provides the vertical row editing interface like
!EditTablerowPlugin, with the row being edited shown in context in the table.

---++ Plugin Info
---++ Dependencies
%$DEPENDENCIES%

| Change History: | <!-- versions below in reverse order -->&nbsp; |
---++ Change History
%TABLE{columnwidths="7em" tablewidth="100%"}%
| 3.40 (16 Jun 2022) | Foswikitask:Item15146: performance fixes |
| 3.330 (29 Sep 2020) | Foswikitask:Item14929: fixed single zero char not rendered in table cell |
| 3.321 (05 Feb 2018) | Foswikitask:Item14537: The plugin makes tables "shaky". |
Expand Down Expand Up @@ -345,17 +346,15 @@ Provides the vertical row editing interface like
| 2.0.1 (24 Feb 2009) | Foswikitask:Item1139: fixed restoration of labels after an edit Foswikitask:Item1140: fixed loading of multi-valued parameters |
| 2.0.0 (15 Feb 2009) | Foswikitask:Item451: ported to foswiki Foswikitask:Item5757: not respecting footer rows when saving Foswikitask:Item5681: help not fully rendered before inclusion in a TML table Foswikitask:Item1086: Macros were being expanded before editing Foswikitask:Item5924: refactor for reusability |
| Earlier version history can be found in the Subversion repository |
| Dependencies: | %$DEPENDENCIES% |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please use the Foswiki support pages to ask questions and report problems instead. -->

%META:FIELD{name="Description" title="Description" value=""}%
%META:FORM{name="PackageForm"}%
%META:FIELD{name="Author" title="Author" value="Crawford Currie http://c-dot.co.uk"}%
%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=""}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Copyright" title="Copyright" value="&copy; 2007-2011 Wind<nop>River Inc.<br/> &copy; 2008-2022 Foswiki Contributors"}%
%META:FIELD{name="License" title="License" value="[[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]]"}%
%META:FIELD{name="Description" title="Description" value="%25$SHORTDESCRIPTION%25"}%
%META:FIELD{name="Home" title="Home" value="http://foswiki.org/Extensions/EditRowPlugin"}%
%META:FIELD{name="License" title="License" value="[[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]]"}%
%META:FIELD{name="Release" title="Release" value="%25$RELEASE%25"}%
%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/distro"}%
%META:FIELD{name="Support" title="Support" value="http://foswiki.org/Support/EditRowPlugin"}%
%META:FIELD{name="Version" title="Version" value="%25$VERSION%25"}%
Loading

0 comments on commit 3ddaa8d

Please sign in to comment.