Language Pack Installation

OpenOffice.org 2.0 affiliate

Document - ID	Specification Owner	Last Change	Status
	Falko Tesch	12.11.2004	Final
Conforms to	Language Packs
Applies to	Language packs specification
Task ID(s)	i34221
Category	G11N

Abstract

With the introduction of the ability of OpenOffice.org to add languages by using language packs (see also Language packs specification) an installation routine becomes necessary to apply such packs.

This installation routing is added/wrapped around the language pack data to allow installation and de-installation.

All Windows routines are based on Windows Installer GUI specification.

i-Team Members (The specification owner is part of the i-Team)

	Name	E-mail Address
User Experience	Falko Tesch	Falko@sun.com
Development	Ingo Schmidt	Ingo.schmidt@sun.com
Quality Assurance	Olaf Felka	Olaf.felka@sun.com
Documentation	Uwe Fischer	Uwe.fischer@sun.com

Approved for Implementation

	Approved by	Date
User Experience	Falko Tesch	12.11.2004
Development	Ingo Schmidt	12.11.2004
Quality Assurance	Olaf Felka	12.11.2004
Documentation	Uwe Fischer	12.11.2004
String Review	Falko Tesch	12.11.2004

Document Change History

Rev. Level	Change	Initials	Date
1.0	Initial spec written	FT	14.10.2004
1.1	Added definitions and strings based on feedback	FT	11.11.2004
1.2	Added "Future Task" section	FT	12.11.2004
1.3	Make it final	FT	12.11.2004

Contents

Glossary	1

1	Motivation	1

2	User Scenarios	1

3	Goals	1

4	Requirements and Dependencies	1

4.1	Requirements	1

4.2	Technical Dependencies	1

5	Competitive Analyses	1

6	Detailed Specification	1

6.1	Windows	1

6.2	Unix	17

6.3	String list	18

6.4	G11n	19

6.5	Error Conditions	19

6.6	Migration	19

7	Future Tasks	19

8	Notes	19

9	References	19

Glossary

Term	Description
<Term 1>	

Motivation

Since introduction of the ability of OpenOffice.org 2.0 to add more language to it by simply adding language packs it becomes necessary to wrap an installation routine “around” these packages.

User Scenarios

Please refer to Windows Installer GUI for generic User Scenarios.

Goals

Provide installation routines for language packs.

Requirements and Dependencies

Requirements

Windows Installer GUI specification.

Technical Dependencies

See Windows Installer GUI specification.

Competitive Analyses

See Windows Installer GUI specification.

Detailed Specification

General

For both platforms, Unix and Windows, every installation set will only contain one language pack.

Linux

For Linux this has a technical background. Under Linux RPM-packages, wrapped by a shell script, are used to install language packs. Since one RPM-package can only contain one installation set (= language pack), with every single installation routine only one single language pack will be installed.

Windows

Under Windows the Windows MSI Installer is used.

Even that this installer support multiple (language) packages is was decided to install always only a single language pack with each installer.

Reason: For the user it is much simpler to organise (like de-install etc.) installed programs within the Windows' 'Control Panel' if every language has its own entry within the installed programs list.

Windows

There two installation routines:

There is no language pack installed yet (first flow chart)

An language pack is already installed (second flow chart)

Please refer to the flow charts below for setup cycles.

FlowChart: Initial Installation Please click on a graphic/thumbnail for more details.
7
6
5
4
3

FlowChart: already Installed Please click on a graphic/thumbnail for more details.

Welcome Screen

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

License Agreement

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Module Installation

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

In case the user de-selects all available installation modules the “Next >” button will be disabled, thus not allowing the user to continue installation without installing anything.

In case no %PRODUCTNAME %PRODUCTVERSION installation is found (example: the user installs a language package from OpenOffice.org on a system with StarOffice 8 installed) the default installation path will be

C:\Program Files\%VENDOR\%PRODUCTNAME %PRODUCTVERSION\

If the user does not abort or redirect the installation the setup routine will install the language package to the default installation path.

Even that in this case the integration routine into %PRODUCTNAME will fail no error message will thrown and the setup will close without errors.

Note: The above is done to allow users to install compatible language packages from different sources on different flavours of the product (as stated in the example above). It is assumed that this benefit is valued higher than a non-working installation.

Installiert Unterstützung für Deutsch in StarOffice 8.

► Return to FlowChart

Module Selection

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

The “Change Program” section is superfluous as long as there is only a single language pack available for each installer. For time reasons this is not removed in first round and therefore to be found a Future Tasks section.

► Return to FlowChart

Installation Agreement

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Reparation Agreement

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

De-Installation Agreement

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Installation Progress

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

De-Installation Progress

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Installation Success

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

De-Installation Success

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Cancellation Dialogue

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Installation Abort

All strings come from the Master Setup Routine specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Installation Option – Path

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Installation Option – Space

All strings come from the Windows Installer GUI specification.

Note: The “%PRODUCTNAME %PRODUCTVERSION” must be replaced by “%PRODUCTNAME %PRODUCTVERSION Language Pack (%LANGUAGE)” (see string list below)

► Return to FlowChart

Unix

Under Unix no UI will be provided by a shell wrapper written around the language pack. The language pack in itself will be available as a RPM file.

Invoking the shell-script must be done as root, otherwise installation (of RPM package) will fail.

Note: The Unix setup is not subject to translation! It will only be available in English.

The following installation routine is done when invoking the shell script:

Checking if ran as root, if not exit with
You need to have super-user rights to install this language package

If run as root, display the license agreement with “more”

After the user scrolled down the license agreement or pressed 'q' a message appears asking
Do you agree to the above license terms? [yes or no]

In case the user types 'no' or any other key combination that does not equal 'y' or 'yes' installation will abort and return to command line

In case the user types 'y' or 'yes' the installation routine will try to find a valid %PRODUCTNAME installation.
This will be documented by echoing
“Searching for the %PRODUCTNAME installation ...”
on the command line

Regardless if an installation is found or not, the user will be allowed to choose a directory himself as the target for installation. In case a valid %PRODUCTNAME installation is found, the path will be placed into square brackets after the user interface text:
Where do you want to install the language pack? Press enter to use default in brackets[/opt/staroffice8-ea]

The user can now press enter and the path within the brackets is used for installation -or- the user can input any other directory manually and the language pack is installed to this target.

While the RPM package is extracted and installed the command line outputs
Unpacking and installing...
Note: The RPM package must always be installed with option –force to ensure that is doesn't fail installing just because of fonts TO BE DISCUSSED!!!

Once successfully done the setup will output a
Done
and return to the command line

In case the installation fails the setup will output any possible error output from the application and will finish with a
Failed!

String list

Item	English	German	Comments
Product Description	Language Package	Sprachpaket	This is the string to be added wherever %PRODUCTNAME %PRODUCTVERSION appears in the setup
Product Description	%LANGUAGE	%LANGUAGE	Language name of the to-be-installed language module, e.g. “Deutsch” for German language pack. Note: In case more than one language pack is included, the strings will be separated by commas and a space)
Product Description	Installs %LANGUAGE support in %PRODUCTNAME %PRODUCTVERSION.	Installiert Unterstützung für %LANGUAGE in %PRODUCTNAME %PRODUCTVERSION.	Extended product description
For all other Windows UI strings please refer to Windows Installer GUI specification
Command Line	You need to have super-user rights to install this language package	N/a	No localisation/translation needed!
Command Line	Do you agree to the above license terms? [yes or no]	N/a	No localisation/translation needed!
Command Line	“Searching for the %PRODUCTNAME installation ...”	N/a	No localisation/translation needed!
Command Line	Where do you want to install the language pack? Press enter to use default in brackets[/opt/staroffice8-ea]	N/a	No localisation/translation needed!
Command Line	Unpacking and installing...	N/a	No localisation/translation needed!
Command Line	Done	N/a	No localisation/translation needed!
Command Line	Failed!	N/a	No localisation/translation needed!

Tab Order

See Master Setup Routine specification.

Key Board Shortcuts

See Master Setup Routine specification.

G11n

See Master Setup Routine specification.

Error Conditions

See Master Setup Routine specification.

Migration

See Master Setup Routine specification.

Future Tasks

As long as there is only one language pack installed within the MS Windows Installer (MSI) the option “Change Program” is not sensible.

So in case there is no change applicable this part of the installer must be hidden.

Notes

References

<Give references to related documentation, such as engineering designs, technical specs, and other sources for related units. Also include links to documents that other sections in this spec need to refer to, such as user opinions usability test reports.>

Language Pack Installation

Page 21

Http://specs.openoffice.org//g11n/lang_pax/language_packs_installation.sxw

Language Pack Installation

Falko Tesch

2004-10-08T08:14:48