Tags:
create new tag
, view all tags

TextSectionPluginDev Discussion: Page for developer collaboration, enhancement requests, patches and improved versions on TextSectionPlugin contributed by the TWikiCommunity.
• Please let us know what you think of this extension.
• For support, check the existing questions, or ask a new support question in the Support web!
• Please report bugs below

TextSectionPlugin Dev discussion

For discussing development ideas and issues on the TextSectionPlugin.

-- NorbertWindrich - 6 Aug 2004

I've very excited about this plugin! I've been thinking about the possibility of a TWiki-based outliner for some time and this looks like a step in that direction. I immediately downloaded it and will be testing it and giving you feedback.

Not knowing anything about what's involved in the coding, I'll just throw out a couple of my immediate wish-lists items for consideration:

  • Rather than creating special tags, how about simply having a tag that brackets a range of regular headings (i.e. ---+ format)?
  • Rather than having a special button for each section, simply use the heading text, but add your +- symbols to indicate expanded or not.

If this were possible and if we could combine this plugin with SectionalEditPlugin, we have a workable outliner! I think that might just be a "killer application" for TWiki!

My apologies if I'm jumping ahead and thanks again for developing this!

-- LynnwoodBrown - 06 Aug 2004

Since loading up this plugin, I've noticed the following error showing up in my log files:
[Tue Aug 10 20:25:55 2004] view: \1 better written as $1 at /path/to/my/lib/TWiki/Plugins/TextSectionPlugin.pm line 143

-- LynnwoodBrown - 11 Aug 2004

Thank you for your hint. Iam writing on a new version which will have tokens like the editsection plugin. And also a functionality for the "---+" lines. I hope it will be finished in the next few days.

-- NorbertWindrich - 12 Aug 2004

The new Version is finished and available in TextSectionPlugin.

-- NorbertWindrich - 16 Aug 2004

I installed the new version today and was delighted to see that you implemented the "---+" type functionality! We need a name for this mode and for now, I'll just refer to it as "heading mode" (versus, say, "section mode").

Here's some further feedback from my experience and general thoughts:

  • It took me a while to figure out how to apply the heading mode. I finally looked at your code and figured it from your comments there. It appears the the docs in TextSectionPlugin topic are incomplete/wrong. (More on the docs in a minute).
  • Regarding the switch in syntax from % to <: I get your intent to make it consistant with SectionalEditPlugin but I'm not it's a good role model to follow in this regard. I remember discussions somewhere (can't find it right now) admonishing plugin authors to stick with the prevailing TWiki syntax and I think this is wise. It's hard enough for users to remember special characters without confusing them with inconsistency. I would encourage you to go back to the % syntax and let's try to get SectionalEditPlugin to switch over too.
  • From your comments in the script, I figured that the current syntax for using heading mode is to put in <textsections> (with "s" added) at beginning and <textsectionend> at the end. In the interest (again) of keeping the syntax simple and similar to other plugins, how about using something like <textsection{mode="heading"}>?
  • I'm still getting an occasional error log entries along the lines of: "view: Argument "0.1." isn't numeric in numeric ne (=) at /path/to/lib/TWiki/Plugins/TextSectionPlugin.pm line 149." This was during the time when I was trying to figure out the syntax and seems to have stopped when I got it right so that might have been the cause. Just throught I'd pass it on in case it's useful data.

Regarding the documentation, I'd like to offer to help with that since it's something I can do. Once I'm clear about the syntax, I'd be glad to flesh out the instructions in TextSectionPlugin. It's the least I can do to support your effort! Thanks again for developing this!

One last thought: I wonder if TextSectionPlugin is the best name for this plugin? It seems like something along the lines of CollapsableSectionPlugin would be more descriptive of its essential features. Again, just my 2 here. smile

-- LynnwoodBrown - 16 Aug 2004

I made some changes in the plugin documentation for a better use of the heading mode. Please feel free to modify it.

To change the syntax from "<"...">" to "%"..."%" is just a replace in the code and the documentation. I think its the better way in twiki. Is there any syntax rule for new plugin tokens?

I made an new version to move to the twiki token syntax. The view error in the log is also fixed.

-- NorbertWindrich - 17 Aug 2004

This morning, it occurred to me that TextSectionPlugin could potentially offer a nice way to create collapsable menus in WebLeftBar. I wrote about this in HowToHaveTwoLevelsInLeftBar. I also tried it out and it almost works. The only problem was that when one clicks on the expand/collapse link, it jumps you to the menu topic itself. I wonder how hard it would be to modify TextSectionPlugin to allow this to work?

-- LynnwoodBrown - 22 Oct 2004

checked .zip into CVS

-- WillNorris - 19 Jul 2005

I added SectionalEditPlugin to the RelatedTopics in the WebForm.

Excellent idea for a plugin. I can't wait to try it out.

-- RobertDeForest - 08 Feb 2006

Norbert, I made some changes to the Plugins topic. Please feel free to roll them back into the next release. Also, how about measuring and documenting the PluginBenchmarks numbers?

I have seen that you attached a TextSectionPlugin-dakar.zip to the Plugins topic. I contains a topic in Dakar specific format="1.1". To make it easier for users it is better to have just one Plugin to download, a Plugin that runs on Cairo and Dakar. Learn more at HandlingCairoDakarPluginDifferences on how to make Plugins compatible for Cairo and Dakar.

-- PeterThoeny - 10 Feb 2006

Peter, thank you for your hint, the plugin is changed to use the same code in cairo and dakar.

The PluginBenchmarks need ./geturl in the TWiki bin dir, but there none. I will benchmark it manually.

-- NorbertWindrich - 14 Feb 2006

Thanks Norbert for making the Plugin run on Dakar and Cairo smile

The changes to the Plugins topic I made are gone, I redid them. Please feel free to roll them back into the next release.

Good point on the benchmarks. I added a Dakar specific note to PluginBenchmarkAddOn.

-- PeterThoeny - 14 Feb 2006

Oops, just realized that the topic text is of format="1.1", that is this Plugin topic does not render properly in Cairo. Please see HandlingCairoDakarPluginDifferences on how to fix that.

-- PeterThoeny - 14 Feb 2006

Edit | Attach | Watch | Print version | History: r18 < r17 < r16 < r15 < r14 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r18 - 2006-02-14 - PeterThoeny
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.