Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: installer/src/documentation/source_code.dox

Issue 6202981292703744: Whole installer (Closed)
Patch Set: Created June 24, 2014, 7:27 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 /*!
2
3 \page source_code Source Code
4
5 ## Localization Source ##
6
7 See \subpage localization for all the relevant MSI data structures.
8
9 \par WiX `.loc` localization files
10
11 - WiX
12 [WixLocalization Element] (http://wixtoolset.org/documentation/manual/v3/xsd/w ixloc/wixlocalization.html)
13
14 \par WiX sources for SIS strings
15
16 The WiX documentation isn't always very explicit about how it maps WiX elements and attributes to MSI values.
17 Most of them are in the WiX elements `Product` and `Package`.
18 The documentation for `Package` elements states that it is "properties about the package to be placed in the Summary Information Stream."
19 That, however, is misleading, since it's not the only source of such properties.
20 nor does quite every attribute in the element appear in the SIS.
21
22 - MSDN
23 [Summary Property Descriptions] (http://msdn.microsoft.com/en-us/library/windo ws/desktop/aa372049%28v=vs.85%29.aspx)
24 - WiX
25 [Product Element] (http://wixtoolset.org/documentation/manual/v3/xsd/wix/produ ct.html)
26 - WiX
27 [Package Element] (http://wixtoolset.org/documentation/manual/v3/xsd/wix/packa ge.html)
28
29 This section enumerates the properties in the SIS and shows where they originate in the source code.
30 They are listed in order of their property index numbers, the same order used by the `msiinfo`.
31 The properties in the SIS appear in the Control Panel tool _Programs and Feature s_.
32
33 - **Codepage**.
34 In the attribute `Package/@SummaryCodepage`.
35 This is the code page used to display strings in the Summary Information.
36 - **Title**.
37 The fixed string "Installation Database".
38 - **Subject**.
39 In the attribute `Package/@Description`.
40 Appears as the "Name" field in the tabular listing in Programs and Features.
41 - **Author**.
42 In the attribute `Package/@Manufacturer`.
43 If omitted, (apparently) defaults to `Product/@Manufacturer`.
44 Appears as the "Publisher" field in the tabular listing in Programs and Featur es.
45 Related to this, there's a property "Manufacturer" in the installer database.
46 - **Keywords**.
47 In the attribute `Package/@Keywords`.
48 Appears at the bottom of Programs and Features when the package is selected. ( ?)
49 - **Comments**.
50 In the attribute `Package/@Comments`.
51 Appears at the bottom of Programs and Features when the package is selected.
52 - **Template**.
53 This single SIS property is the concatenation of two fields.
54 The first is the value of the `-arch` command line option of the compiler `can dle`.
55 If that's not specified, it's in `Package/@Platform` or `Package/@Platforms`.
56 The second is in `Package/@Languages`.
57 - **Revision**.
58 Used to store the package GUID
59 In attribute `Package/@Id`, but is automatically generated if absent,
60 which is the recommended usage.
61 - **Last Printed**.
62 Used for administrative images.
63 Not a concern for us, but set by a tool.
64 - **Create Time/Date**.
65 The linker sets this value.
66 So does the embedding tool, which is arguably a defect in the Automation inter face.
67 - **Last Saved Time/Date**.
68 The linker sets this value, as do the other tools that modify the MSI.
69 - **Page Count**.
70 Used to store the minimum installer version required to install.
71 In the attribute `Package/@InstallerVersion`.
72 - **Word Count**.
73 A bit field in attributes `Package/@ShortNames`, `Package/@Compressed`, `Packa ge/@AdminImage`, and `Package/@InstallPrivileges`.
74 - **Creating Application**.
75 Set by the linker to "Windows Installer XML" and a version number.
76 - **Security**.
77 A bit field in attribute `Package/@ReadOnly`.
78
79 \par Localization of the WiX UI extension.
80
81 We are using the WiX UI extension for the installer.
82 It already has localizations for many languages,
83 including most of the ones that we already support in the plugin.
84 There are a few, however, that do not have localizations, yet, and we'll have to provide them.
85 The source code location for these WiX localizations is `src/ext/UIExtension/wix lib`
86 with files named `WixUI_<language-code>.wxl`.
87 These lists were checked against both WiX 3.7 and WiX 3.8.
88
89 The WiX UI extension DOES NOT support the following languages that we do.
90
91 - fil-PH. Filipino - Phillipines.
92 - kn-IN. Kanada - India.
93 - mr-IN. Maratha - India.
94 - ms. Malaysian - generic.
95 - nn-NO. Nynorsk - Norway.
96 - ur-PK. Urdu - Pakistan.
97
98 The WiX UI extension supports the following languages that we do not yet support .
99
100 - kk-KZ. Kazakh - Kazakhstan.
101 - ko-KR. Korean - Korea.
102 - lt-LT. Lithuanian - Lithuania.
103 - lv-LV. Latvian - Latvia.
104 - sl-SI. Slovenian - Slovenia.
105 - sr-Latn-CS. Serbian, Latin alphabet - Serbia and Montenegro.
106 - zh-HK. China - Hong Kong
107
108 */
OLDNEW

Powered by Google App Engine
This is Rietveld