Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 82749 - [CheatSheet] Cheatsheet xml contains chkpii warning (param3)
Summary: [CheatSheet] Cheatsheet xml contains chkpii warning (param3)
Status: RESOLVED DUPLICATE of bug 102366
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.1   Edit
Hardware: PC All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Dejan Glozic CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2005-01-13 10:07 EST by David W Hare CLA
Modified: 2007-02-19 17:20 EST (History)
4 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David W Hare CLA 2005-01-13 10:07:04 EST
chkpii yields:

ECLIPSE\PLUGINS\ORG.ECLIPSE.PDE\CHEATSHEETS\
  UPDATES.XML     XML-WELCOM  969   (W) XML tag attribute (param3) may contain 
             
                                        translatable text which cannot be 
                                        translated.  Line: 53

The line is:

    param3="XYZ Feature"

(it looks like line 57 in my editor)


I changed the 'param3' tag to 'title', and that (title="XYZ Feature) passes
chkpii.  It appears that param3 needs to be changed to something approved by
chkpii.  Is this a change that can be made?
Comment 1 David W Hare CLA 2005-03-22 14:15:04 EST
Any status on this?

3.1 is coming up and we have to work around this until a fix is made...
Comment 2 David W Hare CLA 2005-04-11 13:58:42 EDT
trying another component to get a response

This is still causing problems...
Comment 3 Cam-Thu Le CLA 2005-05-23 16:32:41 EDT
Please have this problem fixed as we are unable to send this file for 
translation for 3.1. We keep on having to delete it out of the PII package.
Comment 4 Dejan Glozic CLA 2005-05-23 18:41:30 EDT
The chkpii warning is bogus. Cheatsheet files are translated as a whole, 
instead of providing a matching properties file (similar to HTML or JSP files).
Comment 5 Cam-Thu Le CLA 2005-05-25 14:35:01 EDT
I think there is a misunderstanding here. The cheatsheet.xml can be kept as 
is. The only variable which needs to be fixed in this xml is param3="XYZ 
Feature". Please update variable param3 to something different,such as 
title3="XYZ Feature" for example. This way, translation can be performed for 
this variable. Else by default this field will be blocked because variable 
param is used, which indicates the constant is not translatable. We had been 
handling this translation through the back door for previous release. I would 
like to see the problem fixed once for all for this release and for future 
releases.
Comment 6 Dejan Glozic CLA 2005-05-25 14:38:00 EDT
We cannot make this change. Name of the arguments is API i.e. cannot be 
changed without breaking our clients.
Comment 7 Steven Wasleski CLA 2005-05-25 15:07:50 EDT
If I recall correctly, the param3="XYZ Feature" is just an initial value for a 
field on the cheatsheet that the user will probably change.  I don't think it 
is critical to translate it but we do need the file to be completely CHKPII 
clean (errors and warnings) in order to get any of the file translated and 
there is other content in the file that we want translated.  I know this is a 
bit strange, but what if we changed "XYZ Feature" to something CHKPII will not 
detect as being translatable text in a non-translatable field?  I believe the 
hueristic the CHKPII is using trips up on this one due to the embedded blank.

Cam, could you run a quick test to see if changing it to "XYZ-Feature" 
or "XYZ_Feature" or "FeatureName" would get rid of the warning?

Dejan, would one of these values or some other you suggest be an acceptable 
fix to this issue?
Comment 8 Dejan Glozic CLA 2005-05-25 15:32:10 EDT
I am curious that CHKPII flags a blank in an attribute as a problem, but has 
no problem with blanks in element bodies.

We can apply various hacks here but at the end of the day we want to use a 
sentence in the attribute and 'param3' is API for that particular element. I 
assume CHKPII has a list of attributes for which it expects blanks in 
attributes (e.g. title, name etc.), so param3 trips it.

You are free to change the title to whatever you want just to get CHKPII to 
pass, but when you translate, try to mentally 'remove' the tweak.
Comment 9 Sonia Dimitrov CLA 2005-06-15 14:10:54 EDT
Moving to affected component.
Comment 10 Chris Goldthorpe CLA 2007-02-19 17:20:35 EST
This is the same bug as Bug 102366 which is now FIXED on the cheat sheet side. The cheat sheet content file spec now contains a translation hint and I have been assured that CHKPII will be modified to look for the translation hint.

*** This bug has been marked as a duplicate of bug 102366 ***