Changeset 4295

Timestamp:

06/24/09 21:13:57 (3 years ago)

Author:

MichaelTempest

Message:

Item1770: Update documentation; add more unit tests

Location:

trunk/WysiwygPlugin

Files:

• data/System/WysiwygPlugin.txt (modified) (1 diff)
• lib/Foswiki/Plugins/WysiwygPlugin.pm (modified) (2 diffs)
• test/unit/WysiwygPlugin/ExtendedTranslatorTests.pm (modified) (1 diff)

trunk/WysiwygPlugin/data/System/WysiwygPlugin.txt

@@ -137 +137 @@
 Plugins that extend the syntax using macros, such as =%MYMACRO%=, should work fine.
 
-*Implementors note* plugins that use XML-like tags may call Foswiki::Plugins::WysiwygPlugin::addXMLTag() to make WysiwygPlugin protect the content between XML-like tags, just like it does for macros. 
+*Implementors note* plugins that use XML-like tags may call [[%SCRIPTURLPATH{view}%/%SYSTEMWEB%/PerlDoc?module=Foswiki::Plugins::WysiwygPlugin][Foswiki::Plugins::WysiwygPlugin::addXMLTag()]] from their =initPlugin= handlers to make WysiwygPlugin protect the content between XML-like tags, just like it does for macros. 
 
 ---+++ Overlapping styles

trunk/WysiwygPlugin/lib/Foswiki/Plugins/WysiwygPlugin.pm

@@ -551 +551 @@
 =pod
 
----++ Function addXMLTag($tag, \&fn)
+---++ StaticMethod addXMLTag($tag, \&fn)
 
 Instruct WysiwygPlugin to "lift out" the named tag 
 and pass it to &fn for processing.
 &fn may modify the text of the tag.
-&fn should return 0 is the tag is to be re-embedded immediately,
+&fn should return 0 if the tag is to be re-embedded immediately,
 or 1 if it is to be re-embedded after all processing is complete.
 The text passed (by reference) to &fn includes the 
 =<tag> ... </tag>= brackets.
+
+The simplest use of this function is something like this:
+=Foswiki::Plugins::WysiwygPlugin::addXMLTag( 'mytag', sub { 1 } );=
 
 A plugin may call this function more than once 
@@ -565 +568 @@
 However, only the *original plugin* may change the processing
 for a tag.
+
+Plugins should call this function from their =initPlugin=
+handlers so that WysiwygPlugin will protect the XML-like tags
+for all conversions, including REST conversions.
+Plugins that are intended to be used with older versions of Foswiki
+(e.g. 1.0.6) should check that this function is defined before calling it,
+so that they degrade gracefully if an older version of WysiwygPlugin
+(e.g. that shipped with 1.0.6) is installed.
 
 =cut

trunk/WysiwygPlugin/test/unit/WysiwygPlugin/ExtendedTranslatorTests.pm

@@ -117 +117 @@
             Foswiki::Plugins::WysiwygPlugin::addXMLTag( 'customtag',
                 sub { 1 } );
+        },
+        html => '<p>'
+          . $protecton
+          . '&lt;customtag&gt;some&nbsp;&gt;&nbsp;&nbsp;text&lt;/customtag&gt;'
+          . $protectoff . '</p>',
+        tml => '<customtag>some >  text</customtag>',
+    },
+    {
+        exec  => $TML2HTML | $ROUNDTRIP,
+        name  => 'CustomXmlTagCallbackChangesText',
+        setup => sub {
+            Foswiki::Plugins::WysiwygPlugin::addXMLTag( 'customtag',
+                sub { $_[0] =~ s/some/different/; return 1; } );
+        },
+        html => '<p>'
+          . $protecton
+          . '&lt;customtag&gt;different&nbsp;&gt;&nbsp;&nbsp;text&lt;/customtag&gt;'
+          . $protectoff . '</p>',
+        tml      => '<customtag>some >  text</customtag>',
+        finaltml => '<customtag>different >  text</customtag>',
+    },
+    {
+        exec  => $TML2HTML | $ROUNDTRIP,
+        name  => 'CustomXmlTagDefaultCallback',
+        setup => sub {
+            Foswiki::Plugins::WysiwygPlugin::addXMLTag( 'customtag' );
         },
         html => '<p>'