Opened 12 years ago
Closed 9 years ago
#10499 closed enhancement (fixed)
DeprecatedNotice macro
Reported by: | Ryan J Ollos | Owned by: | Ryan J Ollos |
---|---|---|---|
Priority: | normal | Component: | TracHacksPlugin |
Severity: | normal | Keywords: | |
Cc: | Steffen Hoffmann, Jun Omae, Michael Renzmann | Trac Release: | 0.12 |
Description (last modified by )
Here is an example of a deprecated notice at the top of the WikiStatsPlugin page:
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.
Attachments (0)
Change History (8)
comment:1 Changed 12 years ago by
Description: | modified (diff) |
---|
comment:2 Changed 11 years ago by
Cc: | Jun Omae Michael Renzmann added |
---|---|
Component: | TracHacks → TracHacksPlugin |
Status: | new → assigned |
comment:3 Changed 10 years ago by
comment:4 follow-up: 5 Changed 10 years ago by
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 Changed 10 years ago by
Replying to 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.
Added two more: RenameTracUsersScript and RenameUserPlugin
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 10 years ago by
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 10 years ago by
Use of box
WikiProcessor is documented on the TracHacks/SiteMaintenance page.
We could use one of the
#!box
WikiProcessors from the WikiExtrasPlugin.