Feature Proposal: SpreadSheetPlugin Nop Function Enhancement

Motivation

The $NOP-Function from the SpreadSheetPlugin provides a replacement for the percent character (%). This is not necessary for all cases to escape the parameter. There is also an need for a replacement of the quote character (").

Description and Documentation

The code change is very simple. Open the file lib/TWiki/Plugins/SpreadSheetPlugin/Calc.pm, search for \$per and you found only one occurrence: $theAttr =~ s/\$per/%/g; Insert the new line $theAttr =~ s/\$quo/"/g; after that.

In the documentaion the new text "The quote character '%' can be escaped with $quo." should be append after "The percent character '%' can be escaped with $per."

That's all!

Examples

Impact

Implementation

-- Contributors: HorstEsser - 2009-11-12

Discussion

I suggest to align it with the syntax of FormattedSearch, e.g. name it $quot instead of $quo.

I suggest also to deprecate (but keep) $per and to implement and document $percnt for the same reason. Untested: $theAttr =~ s/\$per(cnt)?/%/g;

Since this is a plugin, the 14 day wait does not apply.

I think this should go into SVN trunk, as well as TWikiRelease04x03 branch so that we have this available in the next 4.3.x patch release.

-- PeterThoeny - 2009-11-17

Corresponding bug tracker item: Item6364

-- HorstEsser - 2009-11-18

I've checked in the change into SVN thunk, but which TWikiRelease04x03 branch should I use? There isn't a TWikiRelease04x03x03 branch.

And were to change the documentation? Only at TWiki04x03.SpreadSheetPlugin?

-- HorstEsser - 2009-11-18

I have seen the check-in in the trunk, welcome to the dev team, and thank you for contributing! As far as documentation, please update also the plugin topic at SVN:SpreadSheetPlugin/data/TWiki/SpreadSheetPlugin.txt :

1. Document the changes in NOP() section.
2. In Plugin Info table, * Aupdate Plugin Version * Add a table row to the Change History. Add your name, such as | ...| ..., contributed by TWiki:Main/HorstEsser |
3. In META:TOPICINFO, make sure to keep author="TWikiContributor" and version="$Rev$" (fix if you edit topic in your browser).

No need to update TWiki04x03.SpreadSheetPlugin, it will be updated the next time we upgarde TWiki on twiki.org. In return, build and upload the plugin package. Use the BuildContrib to build the package and to upload it to the repository in the Plugins web. This will update the Plugins.SpreadSheetPlugin topic as well. Build plugins always from trunk, not from branch.

The plugins of the TWikiRelease04x03 release branch are at SVN04x03:twikiplugins. As an exception because this plugin is also in the TWiki release package, it should be updated in the 4.3 branch as well.

(BTW, I sent you an e-mail but have not gotten a response. Could you send me an e-mail?)

-- PeterThoeny - 2009-11-18

The only place of the SpreadSheetPlugin I've found in the 4.3 branch, is the one you've linked (http://svn.twiki.org/svn/twiki/branches/TWikiRelease04x03/twikiplugins/SpreadSheetPlugin). Which other one do you mean?

-- HorstEsser - 2009-11-22

Ok, now I understand what you mean. The only place to check in the changes on the branch is /twiki/branches/TWikiRelease04x03/twikiplugins/SpreadSheetPlugin.

But now there is another Problem: there is no file SpreadSheetPlugin/Calc.pm. The other files to change are there (SpreadSheetPlugin/data/TWiki/SpreadSheetPlugin.txt and SpreadSheetPlugin/lib/TWiki/Plugins/SpreadSheetPlugin.pm) but no SpreadSheetPlugin/Calc.pm. Should I take the file Calc.pm from the install/release package download, do my changes and check it in to /twiki/branches/TWikiRelease04x03/twikiplugins/SpreadSheetPlugin/Calc.pm?

-- HorstEsser - 2009-11-29

It's in SVN04x03:twikiplugins/SpreadSheetPlugin/lib/TWiki/Plugins/SpreadSheetPlugin/ - please test code in branch install before checking in.

-- PeterThoeny - 2009-11-29

I've tested the code. I've checked in the code on the branch.

Peter, please do - as discussed by mail - the last step for me: "Use the BuildContrib to build the package and to upload it to the repository in the Plugins web" and then set tem6364 to "Waiting for release".

-- HorstEsser - 2009-11-30

I already built and uploaded package on 2009-11-23 with trunk code. TWikibug:Item6364 is now set to "Waiting for release".

Thanks Horst, this item is now done.

-- PeterThoeny - 2009-12-01