|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE reference |
|
11 PUBLIC "-//OASIS//DTD DITA Reference//EN" "reference.dtd"> |
|
12 <reference id="GUID-DB220677-5998-529C-BE35-0D66F588E057" xml:lang="en"><title>Dependency</title><abstract><p>A dependency statement is used to indicate that the component |
|
13 being installed depends on another installed component that is not embedded |
|
14 in the current SIS file. It also indicates the hardware and platform dependency |
|
15 of the component to be installed. For information on embedded files, see <xref href="GUID-7A7254E3-A03A-5B38-B2B5-FFEEE70F5E93.dita">Embedded SIS Files</xref> </p> <p>The |
|
16 following sections detail the syntax for specifying: </p> <ul> |
|
17 <li id="GUID-61209597-EC44-5493-B20D-01018E51B382"><p><xref href="GUID-DB220677-5998-529C-BE35-0D66F588E057.dita#GUID-DB220677-5998-529C-BE35-0D66F588E057/GUID-B771213C-29EE-5F51-A051-66121E213B0D">Component dependency</xref> </p> </li> |
|
18 <li id="GUID-7BDFC4D3-098D-5020-A3FC-E7E03BB83686"><p><xref href="GUID-DB220677-5998-529C-BE35-0D66F588E057.dita#GUID-DB220677-5998-529C-BE35-0D66F588E057/GUID-4BCEC177-B386-5EE7-8483-76F18A0B87D4">Hardware/UI platform dependency</xref> </p> </li> |
|
19 </ul></abstract><prolog><metadata><keywords/></metadata></prolog><refbody> |
|
20 <section id="GUID-B771213C-29EE-5F51-A051-66121E213B0D"><title>Component dependency</title> <p>For |
|
21 a component with a dependency to be installed, the component it depends on |
|
22 must already be installed on the Symbian device. In addition to this, the |
|
23 version number of the required component must be same as or greater than the |
|
24 version number specified in the dependency statement, or if a range is specified, |
|
25 it must be within the range. If even one of these conditions is not met, the |
|
26 installation fails. </p> <p><b>Syntax</b> </p> <codeblock id="GUID-6D03FB00-5402-53ED-B0E6-3EBD485FC89B" xml:space="preserve">(package-UID), version-range, {"Component name for language 1","Component name for language n",...}</codeblock> <p> <b>version-range</b> can consist of a single set of major, minor and |
|
27 build numbers, for example, </p> <codeblock id="GUID-2C1AA1CE-C705-5D0C-997E-3A5035532E9C" xml:space="preserve">(0x10000003), 2, 2, 3, {"Depend-EN"}</codeblock> <p>Or |
|
28 it can specify two sets of numbers, representing lower and upper bounds, separated |
|
29 by a tilde character, for example, </p> <codeblock id="GUID-C48AAB0E-E1E7-5017-BB59-550D3335258E" xml:space="preserve">(0x10000003), 2, 2, 3 ~ 3, 0, 0, {"Depend-EN"}</codeblock> <p>A wildcard character can occur in any part of <codeph>version-range</codeph>. <codeph>*</codeph> or <codeph>-1</codeph> can |
|
30 be used as wildcard characters, for example, </p> <codeblock id="GUID-44C7B193-D158-5875-8AF6-AD606A3BFC0E" xml:space="preserve">(0x10000003), *, *, * ~ 2, 2, 3, {"Depend-EN"}</codeblock> <p>which means any version less than and including 2, 2, 3 is acceptable. </p> <p>The |
|
31 component names are used for reporting than for matching; the required component |
|
32 is identified by the package UID, as specified in its package header. For |
|
33 more information see, <xref href="GUID-D9D20EE0-AC86-512A-91C0-EA0ACF3912A7.dita">Package |
|
34 Header</xref>. </p> <p><b>Example</b> </p> <p>This example demonstrates a |
|
35 PKG file that another PKG file depends on. </p> <codeblock id="GUID-EBCBC851-8C97-5C66-A101-C44ECE6497DB" xml:space="preserve">; A simple PKG file upon which others depend |
|
36 |
|
37 ; Languages |
|
38 &EN,FR |
|
39 |
|
40 ; Header |
|
41 #{"Depend-EN", "Depend-FR"}, (0x80000003), 1, 2, 3 |
|
42 |
|
43 %{"Vendor-EN","Vendor-FR"} |
|
44 :"Vendor" |
|
45 |
|
46 ;Ordinary language-specific file to system drive |
|
47 { |
|
48 "text\englishfile.txt" |
|
49 "text\frenchfile.txt" |
|
50 }-"$:\private\80000004\import\dep-lang.txt" |
|
51 |
|
52 ;Ordinary language-neutral file to system drive |
|
53 "file.txt" - "$:\private\80000004\file.txt"</codeblock> </section> |
|
54 <section id="GUID-4BCEC177-B386-5EE7-8483-76F18A0B87D4"><title>Hardware/UI |
|
55 platform dependency</title> <p><b>Syntax</b> </p> <codeblock id="GUID-BB1C0ADB-CCD5-5B0A-88EB-A6D46DD8514D" xml:space="preserve">[productUID], version-range, {"ProductName"}</codeblock> <p> <b>productUID</b> is a UID that identifies a specific Symbian device |
|
56 or a UI platform. For lists of product UIDs, see the device creator website |
|
57 or SDK documentation. The product UID is specified within square brackets |
|
58 to distinguish a hardware dependency from a component dependency. </p> <p> <b>version-range</b> identifies |
|
59 the required version of the target Symbian device or UI platform. It is used |
|
60 in the same way as in a component dependency statement. It can specify a single |
|
61 set of major, minor and build numbers, or may specify upper and lower bounds, |
|
62 for a range of versions. </p> <p>It is recommended that versioning information |
|
63 be supplied using <codeph>version-range</codeph>, for example, UI platform |
|
64 versions. However, in practice, the target hardware version may be inherent |
|
65 in the product UID, in which case the <codeph>version-range</codeph> can consist |
|
66 of wildcards. </p> <p>The component name is used for reporting rather than |
|
67 matching purposes. See the Symbian device or UI platform manufacturer's technical |
|
68 documentation for the recommended text to use. </p> <p>For example, the following |
|
69 statement defines a dependency on UIQ v2.1: </p> <codeblock id="GUID-B0E328FE-EB31-530A-8411-5DAE71E87077" xml:space="preserve">[0x101F61CE], *, *, *, {"UIQ21ProductID"}</codeblock> <p>and this statement defines a dependency on the Series 60 platform second |
|
70 edition: </p> <codeblock id="GUID-4C0084D4-64B7-5BB8-B466-4057776D5C38" xml:space="preserve">[0x101f7960], *, *, *, {"Series60ProductID"}</codeblock> <p><b>Example</b> </p> <p>This example package file demonstrates a UI platform dependency. |
|
71 The platform name and UID used are for illustration only. </p> <codeblock id="GUID-A284FFB7-DB13-56F5-A063-0FA7E8049355" xml:space="preserve">; Example package file showing a dependency on "Platform1" |
|
72 |
|
73 ; Languages supported |
|
74 &EN |
|
75 |
|
76 ; Localised vendor name |
|
77 %{"Nokia Corporation"} |
|
78 |
|
79 ; Global vendor name |
|
80 :"Nokia Corporation" |
|
81 |
|
82 ; Standard PKG file header |
|
83 #{"ExampleForPlatform1"}, (0x12345678), 1, 2, 3 |
|
84 |
|
85 ; Can only be installed on a Platform1 device, any version. |
|
86 ; The UID, (0x00001000) identifies the target hardware/UI platform. |
|
87 |
|
88 ; UI Dependency: Refer to the device creator's or UI platform's website for real values. |
|
89 [0x00001000], *, *, *, {"Platform1ProductID"} |
|
90 |
|
91 ; File to install |
|
92 "ExampleForPlatform1.txt"-"!:\private\12345679\import\ExampleForPlatform1.txt"</codeblock> </section> |
|
93 </refbody></reference> |