Item14814: lots of features and bugfixes

Item14352: add limit and skip parameters to RENDERMETADATA Item13827: hideempty parameter not working in RENDERMETADATA Item14693: depend on new TopicTitlePlugin * added solr index handler to make individual meta data searchable * fixed =hideempty= parameter * added parameters =anchor=, =enabledactions=, =fieldheader=, =fieldfooter=, =hidden=, =limit=, =skip= and =navigation= * added random sorting * now depend on !TopicTitlePlugin removing redundant local !TopicTitle implementation * added prev-next navigation among metadata records * improved localization * make metadata.js a valid jQuery module, properly separating view and edit code
foswiki · Jan 30, 2019 · 8fa5991 · 8fa5991
1 parent 750e79a
commit 8fa5991
Show file tree

Hide file tree

Showing 67 changed files with 99,074 additions and 251 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,8 @@
+*,v
 *.gz
 *.swp
 igp_*
+locale/**/*~
 pub/System/MetaDataPlugin/metadata.js
 pub/System/MetaDataPlugin/metadata.css
 /MetaDataPlugin.md5

diff --git a/data/Sandbox/EffortForm.txt b/data/Sandbox/EffortForm.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="reprev"date="1346844819"format="1.1" version="3"}%
+%META:TOPICINFO{author="ProjectContributor" comment=""date="1548859142"format="1.1" version="1"}%
 %META:TOPICPARENT{name="TimeTracker"}%
 ---+!! %TOPIC%
 

diff --git a/data/Sandbox/TimeTracker.txt b/data/Sandbox/TimeTracker.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1347455820" format="1.1" version="4"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1548859142" format="1.1" version="1"}%
 ---+!! %TOPIC%
 
 %TWISTY{

diff --git a/data/Sandbox/TimeTrackerEditTemplate.txt b/data/Sandbox/TimeTrackerEditTemplate.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1332761584" format="1.1" reprev="1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1548859142" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="TimeTracker"}%
 %{<verbatim class="tml">}%
 %TMPL:INCLUDE{"editform"}%

diff --git a/data/Sandbox/TimeTrackerTemplate.txt b/data/Sandbox/TimeTrackerTemplate.txt
@@ -1,3 +1,3 @@
-%META:TOPICINFO{author="ProjectContributor" date="1332760252" format="1.1" version="1"}%
+%META:TOPICINFO{author="ProjectContributor" date="1548859142" format="1.1" version="1"}%
 %META:TOPICPARENT{name="TimeTracker"}%
 %META:PREFERENCE{name="WEBMETADATA" title="WEBMETADATA" type="Set" value="EffortForm"}%
diff --git a/data/Sandbox/TimeTrackerViewTemplate.txt b/data/Sandbox/TimeTrackerViewTemplate.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1335361593" format="1.1" reprev="1" version="3"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1548859142" format="1.1"  version="1"}%
 %META:TOPICPARENT{name="TimeTracker"}%
 %{<verbatim class="tml">}%
 %TMPL:INCLUDE{"view"}%

diff --git a/data/System/MetaDataPlugin.txt b/data/System/MetaDataPlugin.txt
@@ -1,4 +1,4 @@
-%META:TOPICINFO{author="ProjectContributor" comment="reprev" date="1398761969" format="1.1" reprev="2" version="4"}%
+%META:TOPICINFO{author="ProjectContributor" comment="" date="1548859142" format="1.1"  version="1"}%
 ---+!! %TOPIC%
 %FORMFIELD{"Description"}%
 
@@ -23,7 +23,7 @@ In short: !MetaDataPlugin marries !DataForms with custom =%META= data.
 !MetaDataPlugin comes with an example UI to list records and make them editable. See the Sandbox.TimeTracker
 application for example.
 
-Below screenshot 3 shows an integration with Foswiki:Extensions/HolidayListPlugin and Foswiki:Extensions/ICalPlugin
+Below screenshot 3 shows an integration with Foswiki:Extensions/HolidaylistPlugin and Foswiki:Extensions/ICalPlugin
 to render a ical driven resource view where all events are stored in =%<nop>META:EVENT{}%= records.
 
 %X% Note: this plugin requires a Foswiki engine >= 1.1.0.
@@ -49,6 +49,7 @@ topic edit screen.
 | "..." | key of the !MetaData type to be rendered; this name is derived from the topic name holding the !DataForm definition (see below) | |
 | name | name of one !MetaData record to be rendered; special name is =id= to render a form for a new !MetaData record to be created | |
 | action | indicates the action to perform on the records, can be =edit= or =view= | view |
+| anchor | anchor string appended to action urls | |
 | field(s) | list of formfields to render the interface for | all known formfields of a !DataForm |
 | name | select the id of a !MetaData record to be extracted | all records attached to the given topic |
 | topic | the topic to extract the !MetaData from | the current topic |
@@ -68,15 +69,19 @@ topic edit screen.
            note that the given =filter= will be used to perform a [[%SYSTEMWEB%.QuerySearch][query search]] by constructing a query of the form ='topic'/key[filter].name'=\
            where ='topic'= is the topic containing the meta data records, =key= is the name of the meta data. \
            example: =filter="FirstName='Raffael' or !FirstName='Judith'"=  | |
-| sort | name of attribute used for sorting | name |
+| sort | name of attribute used for sorting, or "random" for randomized ordering | name |
 | reverse | boolean flag to reverse the sorting order | off |
 | mandatory | string to be inserted when a field is mandatory | <span class='foswikiAlert'>**</span> |
 | hiddenformat | format string to be used to render hidden formfields | |
-| hideempty | boolean flag to hide/show empty formfields | off |
+| hideempty | boolean flag to hide/show empty formfields; note this only works in "single mode" that is when a =name= param was specified | off |
 | hidden | list of fields that are rendered hidden | |
 | warn | boolean flag to suppress error messages | on |
-| autolink | boolean flag to enable/prevent !WikiWord linking | on |
+| enabledactions | list of enabled actions for a record | edit,delete,move,duplicate |
+| navigation | boolean flag to enable/disable navigation between metadata records in the edit dialog | on |
+| autolink | boolean flag to enable/disable !WikiWord linking | on |
 | fieldformat | format string for a single formfield value in a row | =$value= |
+| fieldheader | header string prepended to the =fieldformat= result | |
+| fieldfooter | footer string appended to the =fieldformat= result | |
 | &lt;field_name>_attributes, %BR% \
   &lt;field_name>_autolink, %BR% \
   &lt;field_name>_default, %BR% \
@@ -189,6 +194,15 @@ have a database of efforts recorded on that tracker.
 %$DEPENDENCIES%
 
 ---++ Change History
+%TABLE{columnwidths="7em" tablewidth="100%"}%
+|  30 Jan 2019: | added solr index handler to make individual meta data searchable; \
+                  fixed =hideempty= parameter; \
+                  added parameters =anchor=, =enabledactions=, =fieldheader=, =fieldfooter=, =hidden=, =limit=, =skip= and =navigation=; \
+                  added random sorting; \
+                  now depend on !TopicTitlePlugin removing redundant local !TopicTitle implementation; \
+                  added prev-next navigation among metadata records; \
+                  improved localization; \
+                  make metadata.js a valid jQuery module, properly separating view and edit code |
 |  16 Jan 2017: | added =showindex=, =hidden= options to =%RENDERMETADATA=; \
                   added a "single record" mode to render one specific meta data record; \
                   better integration with <nop>SocialFormfieldsPlugin; \
@@ -229,16 +243,16 @@ have a database of efforts recorded on that tracker.
 |  25 Apr 2012: | initial release | 
 
 
-%META:FILEATTACHMENT{name="MetaDataPluginSnap1.png" attachment="MetaDataPluginSnap1.png" attr="" comment="" date="1335356137" size="27517" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="MetaDataPluginSnap2.png" attachment="MetaDataPluginSnap2.png" attr="" comment="" date="1335354029" size="18653" user="ProjectContributor" version="1"}%
-%META:FILEATTACHMENT{name="MetaDataPluginSnap3.png" attachment="MetaDataPluginSnap3.png" attr="" comment="" date="1335354684" size="33426" user="ProjectContributor" version="1"}%
 %META:FORM{name="PackageForm"}%
 %META:FIELD{name="Author" title="Author" value="Michael Daum"}%
-%META:FIELD{name="Copyright" title="Copyright" value="&copy; 2011-2017 Michael Daum http://michaeldaumconsulting.com"}%
+%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="Home" title="Home" value="Foswiki:Extensions/%TOPIC%"}%
+%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/%25TOPIC%25"}%
+%META:FIELD{name="Copyright" title="Copyright" value="&copy; 2011-2019 Michael Daum http://michaeldaumconsulting.com"}%
 %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="%$RELEASE%"}%
-%META:FIELD{name="Repository" title="Repository" value="https://github.com/foswiki/%TOPIC%"}%
-%META:FIELD{name="Support" title="Support" value="Foswiki:Support/%TOPIC%"}%
-%META:FIELD{name="Version" title="Version" value="%$VERSION%"}%
+%META:FIELD{name="Home" title="Home" value="Foswiki:Extensions/%25TOPIC%25"}%
+%META:FIELD{name="Support" title="Support" value="Foswiki:Support/%25TOPIC%25"}%
+%META:FILEATTACHMENT{name="MetaDataPluginSnap1.png" attachment="MetaDataPluginSnap1.png" attr="" comment="" date="1548859142" size="27517" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="MetaDataPluginSnap2.png" attachment="MetaDataPluginSnap2.png" attr="" comment="" date="1548859142" size="18653" user="ProjectContributor" version="1"}%
+%META:FILEATTACHMENT{name="MetaDataPluginSnap3.png" attachment="MetaDataPluginSnap3.png" attr="" comment="" date="1548859142" size="33426" user="ProjectContributor" version="1"}%
diff --git a/lib/Foswiki/Plugins/MetaDataPlugin.pm b/lib/Foswiki/Plugins/MetaDataPlugin.pm
@@ -1,6 +1,6 @@
 # Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
 #
-# MetaDataPlugin is Copyright (C) 2011-2017 Michael Daum http://michaeldaumconsulting.com
+# MetaDataPlugin is Copyright (C) 2011-2019 Michael Daum http://michaeldaumconsulting.com
 #
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
@@ -35,8 +35,8 @@ BEGIN {
   }
 }
 
-our $VERSION = '5.00';
-our $RELEASE = '16 Jan 2017';
+our $VERSION = '6.00';
+our $RELEASE = '30 Jan 2019';
 our $SHORTDESCRIPTION = 'Bring custom meta data to wiki apps';
 our $NO_PREFS_IN_TOPIC = 1;
 our $core;
@@ -50,7 +50,6 @@ sub earlyInitPlugin {
   return 0;
 }
 
-
 ##############################################################################
 sub initPlugin {
 
@@ -65,6 +64,7 @@ sub initPlugin {
   });
 
   # register meta definitions
+  # SMELL: can't register meta data by now as some plugins aren't initialized yet
   registerMetaData();
 
 #  Foswiki::Contrib::JsonRpcContrib::registerMethod("MetaDataPlugin", "get", sub {
@@ -92,6 +92,13 @@ sub initPlugin {
     return $core->jsonRpcUnlockTopic(@_);
   });
 
+  if ($Foswiki::cfg{Plugins}{SolrPlugin} && $Foswiki::cfg{Plugins}{SolrPlugin}{Enabled}) {
+    require Foswiki::Plugins::SolrPlugin;
+    Foswiki::Plugins::SolrPlugin::registerIndexTopicHandler(sub {
+      return $core->solrIndexTopicHandler(@_);
+    });
+  }
+
   return 1;
 }
 
@@ -121,10 +128,14 @@ sub registerMetaData {
 
   my $session = $Foswiki::Plugins::SESSION;
   my $baseWeb = $session->{webName};
+  my $baseTopic = $session->{topicName};
 
   $topics = Foswiki::Func::getPreferencesValue("WEBMETADATA") || ''
     unless defined $topics;
 
+  $topics =~ s/%TOPIC%/$baseTopic/g;
+  $topics =~ s/%WEB%/$baseWeb/g;
+
   foreach my $item (split(/\s*,\s*/, $topics)) {
     my ($web, $topic) = Foswiki::Func::normalizeWebTopicName($baseWeb, $item);
     my $metaDef = getMetaDataDefinition($web, $topic);

diff --git a/lib/Foswiki/Plugins/MetaDataPlugin/Config.spec b/lib/Foswiki/Plugins/MetaDataPlugin/Config.spec
@@ -0,0 +1,10 @@
+# ---+ Extensions
+# ---++ JQueryPlugin
+# ---+++ Extra plugins
+# **STRING**
+$Foswiki::cfg{JQueryPlugin}{Plugins}{MetaDataPlugin}{Module} = 'Foswiki::Plugins::MetaDataPlugin::JQuery';
+# **BOOLEAN**
+$Foswiki::cfg{JQueryPlugin}{Plugins}{MetaDataPlugin}{Enabled} = 1;
+1;
+
+