Opened 4 years ago

Closed 13 months ago

DeprecatedNotice macro

Reported by: Owned by: rjollos rjollos normal TracHacksPlugin normal hasienda, jun66j5, otaku42 0.12

Here is an example of a deprecated notice at the top of the WikiStatsPlugin page:

Notice: This macro is deprecated. Please see the WikiMacros provided by the AccountManagerPlugin and the features provided by the TracStatsPlugin if you need this functionality.

I'm envisioning a very simple macro to replace this markup:

{{{
#!html
<div class="system-message" float="left" overflow="auto">
<b>Notice:</b> This macro is deprecated. Please see the WikiMacros provided by the <a href=http://trac-hacks.org/wiki/AccountManagerPlugin/WikiMacros>AccountManagerPlugin</a> and the features provided by the <a href=http://trac-hacks.org/wiki/TracStatsPlugin>TracStatsPlugin</a> if you need this functionality.
</div>
}}}


with this:

[[DeprecatedNotice(This macro is deprecated. Please see the WikiMacros
provided by the AccountManagerPlugin and the features provided by the
TracStatsPlugin if you need this functionality.)]]

Perhaps there is also room to make this a bit fancier and catch people's attention.

comment:1 Changed 4 years ago by rjollos

• Description modified (diff)

comment:2 Changed 3 years ago by rjollos

• Component changed from TracHacks to TracHacksPlugin
• Status changed from new to assigned

comment:3 Changed 21 months ago by rjollos

We could use one of the #!box WikiProcessors from the WikiExtrasPlugin.

comment:4 follow-up: ↓ 5 Changed 21 months ago by rjollos

WikiExtrasPlugin installed, documentation can be found at WikiMacros#box-macro. Just the one component enabled for now: tracwikiextras.boxes.boxes = enabled.

One page edited so far: RenameUsersScript@11. Thoughts, particularly on the style? We might want to use different styles depending on the reason for deprecating the plugin, and which version of Trac it is deprecated for relative to the current stable release of Trac. For example, TicketDeletePlugin is deprecated but still useful for Trac < 0.12. LineNoMacro is deprecated as of Trac 1.1.2.

comment:5 in reply to: ↑ 4 Changed 21 months ago by hasienda

WikiExtrasPlugin installed, documentation can be found at WikiMacros#box-macro. Just the one component enabled for now: tracwikiextras.boxes.boxes = enabled.

One page edited so far: RenameUsersScript@11.

Thoughts, particularly on the style? We might want to use different styles depending on the reason for deprecating the plugin, and which version of Trac it is deprecated for relative to the current stable release of Trac. For example, TicketDeletePlugin is deprecated but still useful for Trac < 0.12. LineNoMacro is deprecated as of Trac 1.1.2.

I see. First make sure to have Trac version tagging correct according to such recommendations.

Other than that it could probably be enough to adopt a clear note style like (examples for versioned deprecation and another note without link to a specific Trac version):

• This <hack_type> is deprecated <short reason and link to better alternative, if available>.
• Deprecated for Trac > 1.1.2 - this <hack_type> is still useful for older Trac applications.

comment:6 Changed 21 months ago by rjollos

I'll soon make an enhancement to the Maintainer macro so that it displays none (deprecated) rather than none (needsadoption) when the deprecated tag is present on the page.

comment:7 Changed 17 months ago by rjollos

Use of box WikiProcessor is documented on the TracHacks/SiteMaintenance page.

comment:8 Changed 13 months ago by rjollos

• Resolution set to fixed
• Status changed from assigned to closed

In 14776:

3.0.0dev: Maintainer macro indicates deprecated hacks.

Maintainer macro outputs none (deprecated) when the hack doesn't have an owner. Fixes #10499.