Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 190347

Summary: [Improve emitters] Add support for emitter UI extenion
Product: z_Archived Reporter: CDE Administration <cdeadmin>
Component: BIRTAssignee: Zhiqiang Qian <zqian>
Status: VERIFIED FIXED QA Contact: Xiaodan Wang <xwang>
Severity: enhancement    
Priority: P3 CC: camle, clin, kitlo, mindan.xu, rkanguri, wenfeng.fwd, wyan, xwang, zqian
Version: 2.2.0Keywords: plan
Target Milestone: 2.5.0 M7   
Hardware: PC   
OS: Linux-GTK   
URL: 525
Whiteboard: Obsolete
Bug Depends on:    
Bug Blocks: 189107, 246259    
Attachments:
Description Flags
04.002000.jpg none

Description CDE Administration CLA 2007-05-31 17:17:28 EDT
<response_by> Moravia IT at 2007.05.31.15.54.48 </response_by>
Subject: pl: View Report -> items not externalized
OS: Linux only
Build date: 20070530
Component name: BIRT
Blocking: no
Tester Name: Kamil Ignacak (PL)

Steps to recreate the problem:
- open any report, click in editor area to set focus on editor
- go to main menu -> File -> View Report

Problem description:
Following strings are not externalized:
DOC
XLS PROTOTYPE
HTML
PDF
POSTSCRIPT

Please externalize them.

Kamil

<response_by> Cam-Thu Le at 2007.05.31.16.06.51 </response_by>
This article was reassigned from Category:''TVT Testcases''.

<response_by> Moravia IT at 2007.05.31.16.15.08 </response_by>
this problem is for both Windows and Linux
Comment 1 CDE Administration CLA 2007-05-31 17:17:34 EDT
Created attachment 69620 [details]
04.002000.jpg
Comment 2 CDE Administration CLA 2007-05-31 17:17:40 EDT
<cde:tctdetail>
Testcase: 04.002000
Project: WSW33
Component: CDE - BIRT/Report Designer
Priority: 3
Subject: pl: View Report -> items not externalized
Article ID: 525
Originator: tctbroadcast@pl.moraviaworldwide.com
</cde:tctdetail>
Comment 3 CDE Administration CLA 2007-05-31 17:54:16 EDT
<response_by> Bryan Green at 2007.05.31.16.24.06 </response_by>
Changing status in TCT.
Comment 4 Wei Yan CLA 2007-06-05 01:36:42 EDT
190347 TVT33:TCT525: pl: View Report -> items not externalized 
189107 [Accessibility] There is no short cut for View Report [00] 

I think all those issue should resolved by UI as: 

1. The UI/localization is not the core task for emitter. 
2. The emitter may used by multiple applications, such as Report Designer, WEB-VIEWER, IV. Different applications have different requests for the UI resources.

3. The emitter may be develped by third party contributor, which may not concern about the UI operations. 
4. The emitter developer has no resource to resolve the UI issues, such as localization, ICON etc. 

UI can handle those issues as: 

1. UI defines a repository which contains all those visual datas, the reporsitory should support localization and interlization:has following strcutures:

        emitter id. 
                locale 
                        display name 
                        icon 
                        shortcut key 
                        description etc. 

2. UI get all supported emitters from report engine, for each emitter, searchs the displayed information from 
the reporsitory, uses the localized information to define the UI components, such as meanu, dialog etc. 



3. UI needs create a default implementation for all extened emitters which has no pre-defined resources. 

Comment 5 Dazheng Gao CLA 2007-07-02 23:15:11 EDT
I think in this case, engine need also add a "display name" item in the emitter extension schema, as it already has an "icon" entry. This information is not bound to any particular designer implementation, it can be used by any emitter consumers.
Comment 6 Zhiqiang Qian CLA 2007-07-04 22:07:52 EDT
A complete solution need UI introduce a new extension point, which will provide all the info UI need. Ideally, it includes all the localized messages, icon, shortcut key, a new configuration dialog, etc.
Comment 7 Zhiqiang Qian CLA 2008-04-20 22:55:16 EDT
*** Bug 227722 has been marked as a duplicate of this bug. ***
Comment 8 Zhiqiang Qian CLA 2008-08-21 22:12:47 EDT
We plan add this in next major release as it contains big UI behavior change.
Comment 9 Wenfeng Li CLA 2008-12-08 14:14:43 EST
(In reply to comment #6)
> A complete solution need UI introduce a new extension point, which will provide
> all the info UI need. Ideally, it includes all the localized messages, icon,
> shortcut key, a new configuration dialog, etc.

IS this extension for the entire designer UI or only for the emitter/output format list?

I think it is better for the emitter to return the output format display name based on locale, since it is the emitter itself to decide what the output format name should be for each locale.   The emitter has to externalize error message too, can we use the same mechanism to externalize output format display name?
Comment 10 Zhiqiang Qian CLA 2008-12-08 21:46:05 EST
(In reply to comment #9)
> IS this extension for the entire designer UI or only for the emitter/output
> format list?
> 
> I think it is better for the emitter to return the output format display name
> based on locale, since it is the emitter itself to decide what the output
> format name should be for each locale.   The emitter has to externalize error
> message too, can we use the same mechanism to externalize output format display
> name?
> 
This extension is for emitter/output format. So ideally it can be used for both designer and viewer UI.

The extension will be responsible for the text localization. The extension interface will contain refined methods to query miscellaneous display information from each emitter.
Comment 11 Wenfeng Li CLA 2008-12-08 21:55:01 EST
How about enhance the emitter extension to return a output format display name based on locale?   The emitter extension needs to return localized error message anyway, so it should already have the infrastructure to return localized output format display name.

try to avoid adding an extension just for a display name.
Comment 12 Zhiqiang Qian CLA 2008-12-08 22:28:47 EST
(In reply to comment #11)
> How about enhance the emitter extension to return a output format display name
> based on locale?   The emitter extension needs to return localized error
> message anyway, so it should already have the infrastructure to return
> localized output format display name.
> 
> try to avoid adding an extension just for a display name.
> 
This interface not only provides the display name, it also provides other information like detailed description, optional icon, configurable emitter options. Each emitter option can define the option type, description, default value, etc. In nature, it's a complementary of current emitter interface. Regarding the design, I think it's also ok to enhance current emitter extension. We can add an optional "descriptor" element under current emitter extension, this element defines an IEmitterDescriptor instance which returns above information.
Comment 13 Zhiqiang Qian CLA 2009-04-21 02:04:16 EDT
The new extension point is added.
Comment 14 Xiaodan Wang CLA 2009-04-30 02:49:57 EDT
The new extension point is added.

Verified.