Tool registration files no longer respected for tool name changes

Description

I appears that recently i18n and l20n efforts have had a negative impact on a common approach for renaming tools site-wide.

Prior to 2.7, you could rename a tool site-wide by editing the tool registration file in /tools/sakai.toolname.xml

You could do this directly in tomcat/webapps without needing to rebuild.

However, it appears that this is no longer the case. Now, you must edit a file in /config and rebuild . I'm happy that this file is not in kernel, but this still feels like downgrade in terms of features... should the tool registration files be pared down to reflect their new purpose (if they now have any at all) so that deployers don't get confused.

Oh, and the sakai.properties setting in KNL-241, legacyPageTitleCustom has no affect when either set to true or false.

Activity

Show:

Matthew Jones April 24, 2018 at 10:33 AM

Bulk closing issues that have not been updated since 2015 and earlier. Please reopen if this is still an issue and you have new information or if this is a feature you'd like to still have consideration for.

Matthew Buckett April 4, 2012 at 2:07 AM
Edited

For those looking the magic file is: config/localization/bundles/src/bundle/org/sakaiproject/localization/bundle/tool/tools.properties

My concern with this change is that tools are no longer very self contained. To get an i18n supported tool name your contrib tool has to update files in the core of Sakai which seems a little broken. Ah, ok, so you can put properties files in the webapp/tools folder and these get loaded for a tool.

As a side note we had tool names that had changed locally in 2.4, these continued to work in 2.6 but now in 2.8 it's broken. This doesn't make upgrading very easy.

Looking back through the Jira's I don't seem much discussion about why this route was taken, was embedding i18n titles/descriptions in the tool registration file ruled out?

Matthew Jones April 27, 2011 at 11:25 AM

I see what you're saying Nicola, the only (easy) way to change tool names now locally is with the tools.properties file. As after to Tool.java the logic changed from:

if tool.title is defined in tools.properties
return this tool.title
else
return the tool.title in the tool registration file

– TO –

if tool.title is for this tool.id defined in tool.properties
return this title
else
if tool.title is defined in users locale bundle
return this title
if tool.name is defined in DEFAULT local bundle
return this title
return the tool.title in the tool registration file //Will never get here unless you the tool isn't defined in the bundles.

It feels like this should be marked as a won't fix with the appropriate documentation on how to override it. I know you can do it by modifying the tools.properties in the config tool (a pretty easy change) or possibly in 2.9 from the database with KNL-563.

Nicola Monat-Jacobs April 26, 2011 at 10:03 AM

Matthew -

I know it's been a while, but I was just looking at this ticket anew, and I must admit some confusion. Yes, I can see the benefit of Tania's patch for what she needs, but it doesn't seem to solve the issue in this JIRA, which is that Sakai no longer respects the tool registration file when it comes to determining the name of the tool (regardless of where that file may live). Don't hesitate to let me know if I've misunderstood your suggestion of how this patch could help mitigate the extra steps and overhead now required in renaming tools.

Matthew Jones December 20, 2010 at 8:57 AM

FYI Tania attached patch in that does exactly what I was describing.

Won't Fix

Details

Priority

Affects versions

Components

Assignee

Reporter

Created December 16, 2010 at 3:29 PM
Updated April 24, 2018 at 10:33 AM
Resolved April 24, 2018 at 10:33 AM