@maccesar/titools 2.2.3 → 2.2.8

package/skills/ti-guides/references/tiapp-config.md

@@ -1,8 +1,8 @@
-# tiapp.xml and timodule.xml Configuration
+# tiapp.xml and timodule.xml configuration
 
-Complete reference for Titanium app configuration files. `tiapp.xml` is the main config file for Titanium apps. `timodule.xml` is for custom modules.
+Reference for Titanium app configuration files. `tiapp.xml` is the main config file for Titanium apps. `timodule.xml` is for custom modules.
 
-## tiapp.xml Structure
+## tiapp.xml structure
 
 ```xml
 <ti:app xmlns:ti="http://ti.tidev.io">
@@ -39,39 +39,43 @@ Complete reference for Titanium app configuration files. `tiapp.xml` is the main
 </ti:app>
 ```
 
-**WARNING**: tiapp.xml properties are encrypted when building for production.
+tiapp.xml properties are encrypted when building for production.
 
 ---
 
-## Top-Level Elements
+## Top-level elements
 
-### Required Elements
+### Required elements
 
 #### `<guid>`
-**Required.** Unique ID generated by CLI. Do not modify unless you know what you're doing.
+
+Required. Unique ID generated by the CLI. Do not modify unless you know why.
 
 #### `<id>`
-**Required.** Application ID.
 
-- **Android**: Package ID following [Java Package Naming Standards](http://download.oracle.com/javase/tutorial/java/package/namingpkgs.html)
-- **iOS**: Must match Bundle ID from Apple Developer Portal
+Required. Application ID.
+
+- Android: package ID following Java package naming standards
+- iOS: must match Bundle ID from Apple Developer Portal
 
 ```xml
 <id>com.mycompany.fakeblock</id>
 ```
 
 #### `<name>`
-**Required.** Application name shown under icon on device.
+
+Required. Application name shown under the icon on device.
 
 ```xml
 <name>Fakeblock</name>
 ```
 
-**Android warning**: If name starts with a digit, prefix activity name with underscore (e.g., `_2Foo`).
+Android warning: if the name starts with a digit, prefix the activity name with an underscore (for example, `_2Foo`).
 
-### Optional Elements
+### Optional elements
 
 #### `<defaultLang>`
+
 Sets the default language for Android i18n `strings.xml`. Android defaults to `en`. If you only use a single non-English i18n file, set this to that language.
 
 ```xml
@@ -79,9 +83,11 @@ Sets the default language for Android i18n `strings.xml`. Android defaults to `e
 ```
 
 #### `<copyright>`
+
 Application copyright.
 
 #### `<description>`
+
 Application description.
 
 ```xml
@@ -89,29 +95,33 @@ Application description.
 ```
 
 #### `<fullscreen>`
-Start app in fullscreen (hides status bar).
+
+Start the app in fullscreen (hides the status bar).
 
 ```xml
 <fullscreen>false</fullscreen>  <!-- default -->
 ```
 
 #### `<icon>`
-Icon filename relative to `Resources/` or platform-specific folder.
+
+Icon filename relative to `Resources/` or a platform-specific folder.
 
 ```xml
 <icon>appicon.png</icon>
 ```
 
 #### `<navbar-hidden>`
-Hide navigation bar.
+
+Hide the navigation bar.
 
 ```xml
 <navbar-hidden>false</navbar-hidden>  <!-- default -->
 ```
 
-**Android**: Removes top action/title bar.
+Android: removes the top action/title bar.
 
 #### `<publisher>`
+
 Application publisher.
 
 ```xml
@@ -119,13 +129,15 @@ Application publisher.
 ```
 
 #### `<statusbar-hidden>`
-**Android only.** Hide status bar.
+
+Android only. Hide the status bar.
 
 ```xml
 <statusbar-hidden>false</statusbar-hidden>  <!-- default -->
 ```
 
 #### `<url>`
+
 Application URL.
 
 ```xml
@@ -133,15 +145,17 @@ Application URL.
 ```
 
 #### `<version>`
+
 Application version.
 
 ```xml
 <version>3.1.4</version>
 ```
 
-**iOS**: Truncated to 3 dot-separated numbers (e.g., `2.1.0.1` → `2.1.0`).
+iOS: truncated to 3 dot-separated numbers (for example, `2.1.0.1` becomes `2.1.0`).
 
 #### `<sdk-version>`
+
 Titanium SDK to build against.
 
 ```xml
@@ -149,6 +163,7 @@ Titanium SDK to build against.
 ```
 
 #### `<deployment-targets>`
+
 IDE deployment menu options.
 
 ```xml
@@ -160,6 +175,7 @@ IDE deployment menu options.
 ```
 
 #### `<modules>`
+
 Include Titanium modules.
 
 ```xml
@@ -172,13 +188,14 @@ Include Titanium modules.
 </modules>
 ```
 
-**Attributes:**
+Attributes:
 - `platform`: `android`, `commonjs`, `iphone`
-- `version`: Specific module version
+- `version`: specific module version
 - `deploy-type`: `development`, `test`, `production` (comma-separated)
 
 #### `<plugins>`
-Include plugins (in `plugins/` folder).
+
+Include plugins (in the `plugins/` folder).
 
 ```xml
 <plugins>
@@ -188,7 +205,7 @@ Include plugins (in `plugins/` folder).
 
 ---
 
-## Application Properties
+## Application properties
 
 Custom properties accessible via `Titanium.App.Properties`. Read-only in production.
 
@@ -196,65 +213,71 @@ Custom properties accessible via `Titanium.App.Properties`. Read-only in product
 <property name="name" type="type">value</property>
 ```
 
-**Types:** `string`, `bool`, `int`, `double`
+Types: `string`, `bool`, `int`, `double`
 
-### Special Properties
+### Special properties
 
 #### `ti.ui.defaultunit`
+
 Default unit for sizes/positions.
 
 ```xml
 <property name="ti.ui.defaultunit">system</property>
 ```
 
-**Values:** `system`, `cm`, `dip`/`dp`, `in`, `mm`, `px`
+Values: `system`, `cm`, `dip`/`dp`, `in`, `mm`, `px`
 
 #### `run-on-main-thread`
-**Since 5.1.0.** Run all JavaScript on the main thread instead of a secondary thread. Disabled by default in existing projects, enabled in new projects. Enabled automatically in SDK 7.0.0+.
+
+Since 5.1.0. Run all JavaScript on the main thread instead of a secondary thread. Disabled by default in existing projects, enabled in new projects. Enabled automatically in SDK 7.0.0+.
 
 ```xml
 <property name="run-on-main-thread" type="bool">true</property>
 ```
 
 #### `allow-custom-keyboards`
-**Since 6.1.0.** Allow or disallow custom iOS 8+ keyboard extensions. Custom keyboards are allowed by default. Set to `false` to disallow them.
+
+Since 6.1.0. Allow or disallow custom iOS 8+ keyboard extensions. Custom keyboards are allowed by default. Set to `false` to disallow them.
 
 ```xml
 <property name="allow-custom-keyboards" type="bool">false</property>
 ```
 
 #### `appc-sourcecode-encryption-policy`
+
 Encryption policy for app assets.
 
 ```xml
 <property name="appc-sourcecode-encryption-policy">remote</property>
 ```
 
-**Values:**
-- `embed`: Key embedded in binary (padded/obfuscated)
-- `remote`: Key stored remotely (requires internet, default)
+Values:
+- `embed`: key embedded in binary (padded/obfuscated)
+- `remote`: key stored remotely (requires internet, default)
 
 #### `appc-security-jailbreak-detect`
+
 Prevent running on jailbroken/rooted devices.
 
 ```xml
 <property name="appc-security-jailbreak-detect">true</property>
 ```
 
-**Requires**: `appc-sourcecode-encryption-policy` set to `remote`
+Requires `appc-sourcecode-encryption-policy` set to `remote`.
 
 #### `appc-security-debugger-detect`
+
 Prevent debugger connections.
 
 ```xml
 <property name="appc-security-debugger-detect">true</property>
 ```
 
-**Requires**: `appc-sourcecode-encryption-policy` set to `remote`
+Requires `appc-sourcecode-encryption-policy` set to `remote`.
 
 ---
 
-## Android Section
+## Android section
 
 ```xml
 <android xmlns:android="http://schemas.android.com/apk/res/android">
@@ -278,17 +301,19 @@ Prevent debugger connections.
 ### Elements
 
 #### `<abi>`
+
 Target ABI architecture (V8 runtime only).
 
 ```xml
 <abi>all</abi>  <!-- default -->
 ```
 
-**Values:** `all`, `arm64-v8a`, `armeabi-v7a`, `x86`, `x86_64`
+Values: `all`, `arm64-v8a`, `armeabi-v7a`, `x86`, `x86_64`
 
-Targeting specific ABI reduces APK size but device compatibility.
+Targeting specific ABIs reduces APK size but also reduces device compatibility.
 
 #### `<activities>`
+
 Custom JavaScript-based Android activities.
 
 ```xml
@@ -300,6 +325,7 @@ Custom JavaScript-based Android activities.
 ```
 
 #### `<services>`
+
 Custom JavaScript-based Android services (background processes).
 
 ```xml
@@ -309,9 +335,10 @@ Custom JavaScript-based Android services (background processes).
 ```
 
 #### `<manifest>`
-Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/manifest-intro.html) elements.
 
-**Set target/minimum SDK:**
+Ad-hoc AndroidManifest.xml elements.
+
+Set target/minimum SDK:
 ```xml
 <android xmlns:android="http://schemas.android.com/apk/res/android">
     <manifest>
@@ -321,7 +348,7 @@ Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/
 </android>
 ```
 
-**Screen density support:**
+Screen density support:
 ```xml
 <manifest>
     <supports-screens
@@ -333,32 +360,32 @@ Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/
 </manifest>
 ```
 
-**WARNING**: Do NOT set `android:anyDensity="false"`.
+Do not set `android:anyDensity="false"`.
 
-**Enable debugging:**
+Enable debugging:
 ```xml
 <manifest>
     <application android:debuggable="true" />
 </manifest>
 ```
 
-**Install location:**
+Install location:
 ```xml
 <manifest android:installLocation="preferExternal">
     <uses-sdk android:minSdkVersion="7" />
 </manifest>
 ```
 
-**Values:** `preferExternal`, `auto`, `internalOnly`
+Values: `preferExternal`, `auto`, `internalOnly`
 
-**Request large heap:**
+Request large heap:
 ```xml
 <manifest>
     <application android:largeHeap="true"/>
 </manifest>
 ```
 
-### Android-Specific Properties
+### Android-specific properties
 
 | Property                               | Type   | Default | Description                                |
 | -------------------------------------- | ------ | ------- | ------------------------------------------ |
@@ -375,7 +402,7 @@ Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/
 
 ---
 
-## iOS Section
+## iOS section
 
 ```xml
 <ti:app>
@@ -406,14 +433,16 @@ Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/
 ### Elements
 
 #### `<team-id>`
-**Since 5.0.0.** Required for app extensions (share, watch, Siri).
+
+Since 5.0.0. Required for app extensions (share, watch, Siri).
 
 ```xml
 <team-id>YOUR_TEAM_ID</team-id>
 ```
 
 #### `<entitlements>`
-**Since 6.1.0.** Target entitlements (merged with internal entitlements).
+
+Since 6.1.0. Target entitlements (merged with internal entitlements).
 
 ```xml
 <entitlements>
@@ -427,7 +456,8 @@ Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/
 ```
 
 #### `<extensions>`
-**Since 5.0.0.** iOS extensions.
+
+Since 5.0.0. iOS extensions.
 
 ```xml
 <extensions>
@@ -444,6 +474,7 @@ Ad-hoc [AndroidManifest.xml](http://developer.android.com/guide/topics/manifest/
 ```
 
 #### `<min-ios-ver>`
+
 Minimum iOS version.
 
 ```xml
@@ -451,6 +482,7 @@ Minimum iOS version.
 ```
 
 #### `<min-sdk-ver>`
+
 Minimum Xcode version.
 
 ```xml
@@ -458,9 +490,10 @@ Minimum Xcode version.
 ```
 
 #### `<plist>`
+
 Settings for generated `Info.plist`. Uses key/value pairs.
 
-**Orientations:**
+Orientations:
 ```xml
 <plist>
 <dict>
@@ -479,7 +512,7 @@ Settings for generated `Info.plist`. Uses key/value pairs.
 </plist>
 ```
 
-**Background modes:**
+Background modes:
 ```xml
 <plist>
 <dict>
@@ -497,7 +530,7 @@ Settings for generated `Info.plist`. Uses key/value pairs.
 </plist>
 ```
 
-**Device capabilities:**
+Device capabilities:
 ```xml
 <plist>
 <dict>
@@ -529,17 +562,17 @@ Settings for generated `Info.plist`. Uses key/value pairs.
 </plist>
 ```
 
-**Persistent WiFi:**
+Persistent WiFi:
 ```xml
 <key>UIRequiresPersistentWiFi</key><true/>
 ```
 
-**Status bar style:**
+Status bar style:
 ```xml
 <key>UIStatusBarStyle</key><string>UIStatusBarStyleBlackTranslucent</string>
 ```
 
-**iOS 9 URL schemes:**
+iOS 9 URL schemes:
 ```xml
 <key>LSApplicationQueriesSchemes</key>
 <array>
@@ -553,31 +586,34 @@ Settings for generated `Info.plist`. Uses key/value pairs.
 ```
 
 #### `<use-app-thinning>`
-**Since 5.1.0.** Enable App Thinning with Asset Catalog.
+
+Since 5.1.0. Enable App Thinning with Asset Catalog.
 
 ```xml
 <use-app-thinning>true</use-app-thinning>
 ```
 
-**NOTE**: Use `Ti.Filesystem.getAsset()` to read images from Asset Catalog.
+Use `Ti.Filesystem.getAsset()` to read images from Asset Catalog.
 
 #### `<use-autolayout>`
-**Since 5.1.0.** Enable iOS auto-layout engine.
+
+Since 5.1.0. Enable iOS auto-layout engine.
 
 ```xml
 <use-autolayout>true</use-autolayout>
 ```
 
 #### `<log-server-port>`
-**Since 6.0.0.** Custom log server port.
+
+Since 6.0.0. Custom log server port.
 
 ```xml
 <log-server-port>27973</log-server-port>
 ```
 
-### Unsupported Info.plist Keys
+### Unsupported Info.plist keys
 
-These are auto-generated by Titanium and CANNOT be overridden:
+These are auto-generated by Titanium and cannot be overridden:
 - `CFBundleDisplayName`
 - `CFBundleExecutable`
 - `CFBundleIconFile`
@@ -594,7 +630,7 @@ These are auto-generated by Titanium and CANNOT be overridden:
 
 ## Google Play Services
 
-**Since 9.0.0.** Automatic validation of Google Play Services. Disable if needed:
+Since 9.0.0. Automatic validation of Google Play Services. Disable if needed:
 
 ```xml
 <property name="ti.playservices.validate.on.startup" type="bool">false</property>
@@ -602,9 +638,9 @@ These are auto-generated by Titanium and CANNOT be overridden:
 
 ---
 
-## timodule.xml (Module Configuration)
+## timodule.xml (module configuration)
 
-Used in custom Titanium modules. Follows same structure as `tiapp.xml` but only contains platform-specific config (mainly Android).
+Used in custom Titanium modules. Follows the same structure as `tiapp.xml` but only contains platform-specific config (mainly Android).
 
 Supports token substitution for app-specific values:
 
@@ -625,27 +661,27 @@ Becomes (for app with ID `com.example.app`):
 android:protectionLevel="signature" />
 ```
 
-**Access properties:**
-- `${tiapp.properties['id']}` - App ID
-- `${tiapp.properties['name']}` - App name
-- `${tiapp.properties['version']}` - App version
-- `${tiapp.properties['publisher']}` - Publisher
+Access properties:
+- `${tiapp.properties['id']}`: app ID
+- `${tiapp.properties['name']}`: app name
+- `${tiapp.properties['version']}`: app version
+- `${tiapp.properties['publisher']}`: publisher
 
 ---
 
-## SDK Version Precedence
+## SDK version precedence
 
 The CLI checks SDK version in this order:
 
 1. `tiapp.xml` `<sdk-version>` tag
 2. `--sdk` CLI option
 3. `app.sdk` config setting (`ti config app.sdk <version>`)
-4. SDK select version (`ti sdk select`)
+4. Selected SDK (`ti sdk select`)
 
 ---
 
 ## References
 
-- [Android Manifest docs](http://developer.android.com/guide/topics/manifest/manifest-intro.html)
-- [iOS Info.plist Key Reference](http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html)
-- [Java Package Naming](http://download.oracle.com/javase/tutorial/java/package/namingpkgs.html)
+- Android Manifest docs: http://developer.android.com/guide/topics/manifest/manifest-intro.html
+- iOS Info.plist Key Reference: http://developer.apple.com/library/ios/#documentation/general/Reference/InfoPlistKeyReference/Articles/iPhoneOSKeys.html
+- Java package naming: http://download.oracle.com/javase/tutorial/java/package/namingpkgs.html