[#VWR-6396] XUI file verification tool

1. Second Life Viewer - VWR

XUI file verification tool

Created: 11/Apr/08 09:13 AM Updated: 05/Mar/09 10:53 AM

Return to search

Component/s:

Internationalization, Source Code, User Interface

Affects Version/s:

1.20 Release Candidate

Fix Version/s:

None

File Attachments:

Names.java (11 kB)

Issue Links:

Relates

This issue Relates to:

~~VWR-5929~~ Some UI translation texts are ignored because of missing names in XUI files

~~VWR-4125~~ Duplicate names in XUI files make some translated UI texts to show inappropriately

~~VWR-6386~~ Duplicate names in base (en-us) XUI files again

~~VWR-6384~~ "xui/en-us/floater_joystick.xml" is not well formed

~~VWR-6385~~ "xui/en-us/floater_about_land.xml" contains a garbage

VWR-1719 Need for a better mechanism to add new UI translation

Last Triaged:	01/Jan/09 09:24 AM
Linden Lab Issue ID:	DEV-16536
Patch attached:	Patch attached

Description

« Hide

SL viewer uses sets of XUI files to define UI components and UI translation.

For whatever reason (probably due to some careless edits?), XUI files supplied by LL are often broken in various ways. Use of a simple verification tool during the development (i.e., adding new XUI files and/or updating existing XUI files) will eliminate such problems in future releases of the viewer.

The attached file, "Names.java", is the source program written in Java of the diagnostic tool that I (Alissa Sabre) am currently using. The tool

verifies the given XUI file is a well-formed XML file,
makes sure all names of sibling elements are unique, and
makes sure all elements that contain (possibly) translatable texts have name attributes.

I hope this tool (or something similar to it) helps the LL and community developer's UI design/translation works to be more stable.

NOTE: I used Java because it is my primary programming language. It may contain some bugs, but I believe it works reasonably well.

All

Comments

Change History

Sort Order:

[ Permlink | « Hide ]

Alissa Sabre added a comment - 11/Apr/08 09:17 AM

Although the attached file is a standalone program but a patch, I checked "Patch attached" so that this issue attracts LL developers attention...

[ Permlink | « Hide ]

Ramzi Linden added a comment - 11/Apr/08 06:40 PM

It's great that you've reported this. As of 1.19.1, we do attempt to validate the XML before the publish of an RC0, but sometimes we have failed to do so before RC1, and/or some nodes are missed due to limitations of our internal tool.

I am linking this to a similar internal project, in which we do plan to improve these tools and possibly make them available to the developer community. Very much agreed that clean and thorough naming of the XML nodes is essential to localization efforts by both LL, developers and residents.

[ Permlink | « Hide ]

Felix Duesenburg added a comment - 14/May/08 05:06 AM

Not sure how well this is related, but I recently posted a patch to VWR-1719 which also is a standalone tool. The goal was slightly different, refactoring rather than validating, but maybe it can be of interest here, too.

[ Permlink | « Hide ]

Q Linden added a comment - 26/Jun/08 09:36 AM

We're actually doing a pretty extensive rework of our internal translation tools this summer. We have a couple of people thinking about it full-time and at least some of those tools will end up either part of the viewer or at least part of the external build. Plans are still being worked out – more details as we have them.

[ Permlink | « Hide ]

Rob Linden added a comment - 16/Oct/08 09:19 AM

Bumping last triage date forward. Hopefully, we'll have something more definitive the next time we cycle through to talk about this issue.

[ Permlink | « Hide ]

Soft Linden added a comment - 05/Mar/09 10:53 AM

@Alissa – We're not adding the java app to the source tree, as we won't be using this ourselves. Frustratingly - the tool we're using right now is proprietary.

This tool looks extremely useful. I'd encourage you to add links back to this JIRA to any wiki pages where you think translators could make use of it.