Item5006: Interwiki rule: change Bugs: to Foswikitask:, and Rev: to Foswikirev:

Priority: Normal
Current State: Closed
Released In: 1.0.0
Target Release: patch
Applies To: Extension
Component: InterwikiPlugin
Branches:
Reported By: TWiki:Main.PeterThoeny
Waiting For:
Last Change By: KwangErnLiew
Both rules have been added recently. They clobber up the namespace on deploted TWikis. Let's free up the namespace by renaming the Bugs rule to TWikibug (singular, non WikiWord in case rule disabled) and Rev to TWikirev (non WikiWord)

I suggest to fix that in the 4.2 release.

Related, many plugins have hardcoded bug links that are now broken because they contain ~develop, such as http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item645 in TwistyContrib. Affected extensions:

I suggest to fix those links for the 4.2 release to TWikibug: rules.

-- TWiki:Main/PeterThoeny - 22 Nov 2007

I have already seen a few examples at work where people have a topic template with Rev: and they will be screwed up.

Bugs: is less obvious but the Rev: thing need to be fixed asap because that will for sure screw up things because it is used in common business environments. We'd better do it sooner than later before we have used it everywhere.

-- TWiki:Main.KennethLavrsen - 24 Nov 2007

I don't understand why TWiki should be a second-class citizen when it comes to namespaces. Bugs: has been in use for a long time. Changing that rule would break a heck of a lot more than it fixes. Fair point on the absolute URLs, though; that's why I have been incrementally fixing them over time to use the interwiki rule. I originally only used absolute URLs because someone suggested that InterWiki couldn't be relied on.

-- TWiki:Main.CrawfordCurrie - 24 Nov 2007

The Bugs: rule is developer centric. It makes sense to have the rule here on develop.twiki.net and on twiki.org. Outside of this context there is very little use for this rule except for TWiki internal documentation. Hence the suggestion to fix that with a TWiki specific rule. If it breaks something, then only for pointers to develop.twiki.org and twiki.org, something we have control over.

TWiki is typically used in engineering organizations. If we clobber up the Bugs: rule they can't use it for their own products.

-- TWiki:Main.PeterThoeny - 24 Nov 2007

FYI, the Bugs: and Rev: rules are new, they are not in the latest production release 4.1.2.

-- TWiki:Main.PeterThoeny - 25 Nov 2007

Please don't do this. Despite not being in 4.1.2, the Bugs: rule has been in use for quite some time, and is widely used in IRC, Codev and Plugins topics. The Rev: rule is new, and can survive redefinition, though you will have to update all the scripts (in tools/develop) that maintain the links in Bug topics, and regenerate all the references in old bugs (reset ~/lastupdate to 0 and re-run post-commit), and update all the plugins that use the rule.

If you want to remove the Bugs: rule you should deprecate it to allow time for developers to adapt. I was never keen on 'Bugs:' as a rule. As you point out, it is TWiki specific and also suggests you are referring to a problem report where in fact most reports are for enhancement. If you want to change the rule I'd be happier with a change to "TWikitrack:"

Raised to Urgent, as I'm really not happy about this last-minute change.

CC

I made the change to the InterwikiPlugin. I used singular "TWikibug" rule instead of plural "TWikibugs" because TWikibug:Item5006 looks more natural.

I leave this bug item open. Remaining tasks:
  • Add TWikibug and TWikirev rule to twiki.org - DONE
  • Add old Bugs and Rev rule to develop.twiki.org. Could someone help out with this? A new rules topic needs to be created, and pointed to in SitePreferences with a INTERWIKIPLUGIN_RULESTOPIC setting.
  • Above mentioned plugin topics need to be updated with the TWikibug:ItemXXXX rule. - all DONE

Reprioritizing bug back to "normal" for remaining items.

-- TWiki:Main.PeterThoeny - 25 Nov 2007

Peter, I asked you nicely not to do this, and gave my reasons. You have ignored my concerns without explanation, and re-rated the report to "Normal". As you pointed out above, by removing the Bugs: rule you have broken the following plugin topics:

  • PublishPlugin - DONE
  • CommentPlugin - DONE
  • ExtendedSelectPlugin - DONE
  • MultiEditPlugin
  • MailPageAddOn
  • FormQueryPlugin
  • VotePlugin
  • MailerContrib
  • ClassicSkin
  • JSCalendarContrib
  • NotificationPlugin
  • GenPDFAddOn
  • ImmediateNotifyPlugin
  • DBCacheContrib
  • NatSkin
  • BuildContrib
  • FlowchartPlugin
  • InterwikiPlugin
  • HolidaylistPlugin
  • WysiwygPlugin
  • MailInContrib
  • ActionTrackerPlugin
  • DatabasePlugin
  • TagMePlugin
  • OrphansPlugin
  • KupuContrib
  • SubscribePlugin
  • TinyMCEPlugin
  • EditRowPlugin
  • SkillsPlugin
  • SearchSummaryPlugin
  • DpSyntaxHighlighterPlugin
  • AutoCompletePlugin
  • HostnamePlugin
  • ApprovalPlugin

It is a lot of work for plugins authors to update these topics. Note that the BuildContrib also has to be modified to use the new rule, as do the tools/develop scripts. Of course if you are proposing to do all the work yourself, I can have no argument in this respect.

Raised to urgent again, as I consider this change only 10% done.This requires input from the release manager as to whether the change is acceptable at this late stage in the release process. I would remind you that by leaving a list of "to dos" behind, you are simply throwing work over the wall to other people, who may not be all that keen to catch it.

CC

Bugs I could live with because it a bit of an unusual thing to write Bugs followed by a colon. Rev followed by colon I have seen several places on our TWiki, and it has to be changed (and was in itself a last minute change and a developer only thing).

The interests of the customers should always have higher weight than the interests of the few active programmers. Especially since it is not such a big deal to do a search and replace on develop.twiki.org and twiki.org.

And since we are changing the Rev - why not change the Bugs as well. I think Peter's names much better reflect that these are special TWiki related functions.

-- TWiki:Main.KennethLavrsen - 25 Nov 2007

OK. It appears that Peter is following through on changing all the plugins topics, so I am somewhat less nervous as a result. However I think this should remain as a release blocker until the change is complete.

-- TWiki:Main.CrawfordCurrie - 25 Nov 2007

All broken ~develop links are now fixed. The "Bugs:" links are pending.

Crawford, I did not "ignored your concerns", please re-read my reply. It does not break anything in production. Assuming, "Bugs:" rules would not be fixed in plugin topics, it "only" means that bug items are not linked anymore in installed TWikis (they work on twiki.org)

Crawford, it looks like the BuildContrib adds the bug number automagically in the history section. Could you please change the code to use TWikibug interwiki links instead of hardcoded links?

-- PeterThoeny - 25 Nov 2007

All that's needed is to grep in the code for "Bugs:" and change it to "TWikibug:". That was one of my concerns. I haven't got time now, sorry. You are welcome to leave a bug open and I will do it next time I make changes to the BuildContrib.

-- TWiki:Main.CrawfordCurrie - 25 Nov 2007

Fixed in Foswiki scope so Bugs: is now Foswikitask:

Headline updated for release note

-- KennethLavrsen - 18 Dec 2008
Topic revision: r64 - 08 Jan 2009, KwangErnLiew
 
The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement. Creative Commons License