Macro name should be CamelCased
|Reported by:||Ryan J Ollos||Owned by:||Ryan J Ollos|
|Cc:||Steffen Hoffmann, Álvaro Iradier, Adrian Fritz||Trac Release:||0.11|
The macro should probably be renamed from
PlantUml, since CamelCased macro names are the generally accepted standard for Trac.
The macro name change has the possibility to break compatibility for existing users. A couple of ways to address this are:
- Allow both
PlantUml. The downside is that prior to 0.12 the documentation would be displayed for each on the WikiMacros page, which is messy. In 0.12 and later, the documentation would be displayed once, and show one of the two allowed names as an alias.
PlantUmlthe default, and allow
PlantUMLas an alias with an option to disable it.
- Make the hard-switchover at a major version num, and suggest to users that the WikiRenamePlugin can be used to change existing macro invokation if they wish to upgrade.
The ideal would be if we could allow
PlantUML to be a valid macro name, but hide it from the WikiMacros page. That way the WikiMacros page would stay clean, and nothing would be broken for existing users. Maybe that is a worthwhile Trac feature request.
Maybe I'm just making too big of deal about this and should leave it as is. For now, I'm opening this ticket to request inputs, and I'll let it sit for a while before taking any action.