Основные элементы конфигурации
Этот пример показывает значения по умолчанию в файле config.xml сформированном командой CLI create, описанной в разделе Интерфейс командной строки:
Следующие элементы конфигурации появляются в файле верхнего уровня config.xml и поддерживаются на всех существующих платформах Cordova:
Атрибут
id
элемента<widget>
указывает идентификатор приложения в обратном формате доменных имен и атрибутversion
его полный номер версии в нотации майор/минор/патч.Тег widget также может также иметь атрибуты, которые определяют альтернативные версии, а именно versionCode для Android и CFBundleVersion для iOS. Смотри раздел «Дополнительное управление версиями» ниже для подробностей.
Элемент
<name>
определяет официальное имя приложения, как оно отображается на главном экране устройства и в интерфейсе магазина приложений.Элементы
<description>
и<author>
определяют метаданные и контактную информацию, которые могут отображаться в каталоге магазина приложений.Необязательный элемент
<content>
определяет стартовую страницу приложения в каталоге веб ресурсов верхнего уровня . Значением по умолчанию являетсяindex.html
, которая обычно находится в каталоге верхнего уровняwww
проекта.Элементы
<access>
определяют набор внешних доменов, с которым приложение имеет право взаимодействовать. Значение по умолчанию, показанное выше позволяет осуществлять доступ к любому серверу. Смотрите раздел «Инструкция по доступу к внешним ресурсам» для подробностей.Элемент
<preference>
задает различные параметры как пару атрибутовname
/value
. Имя каждого параметра, указанного в атрибутеname
указывается без учета регистра. Многие параметры являются уникальными для конкретных платформ, как это указано в начале этой страницы. В следующих разделах подробно описаны настройки, которые применяются к более чем одной платформе.
Глобальные настройки
Следующие глобальные настройки применяются для всех платформ:
Дополнительное управление версиями
Так, Android и iOS поддерживает вторую строку версии (или номер) помимо видимой в app магазины, versionCode для Android и CFBundleVersion для iOS. Ниже приведен пример, который явно задает versionCode и CFBundleVersion
Если альтернативная версия не указана, будет использоваться следующие значения по умолчанию:
Использование flex-config.xml
Всем привет!
Коротенький пост для новичков, о том как использовать конфигурационный файл для установки параметров компилятора.
Что такое конфигурационный файл и для чего он нужен? Данный файл это ни что иное как xml файл, содержащий параметры компилятора. И нужен он собственно для того чтобы управлять компилятором. Указать путь к конфигурационному файлу можно используя параметр компилятора -load-config.
По умолчанию Flex SDK включает в себя конфигурационный файл с именем flex-config.xml.
Этот файл содержит параметры компилятора по умолчанию для приложения и компонентов компилятора. Файл flex-config.xml располагается в директории flex_install_dir/frameworks вашего Flex SDK. Т.е при осуществлении сборки из командной строки, по умолчанию используется именно он.
Flash Builder не использует файл flex-config.xml из Flex SDK, и во время сборки он генерирует свой конфигурационный файл, на основании настроек проекта. Увидеть содержимое с генерированного файла конфигурации, можно использовав параметр компилятора -dump-config myapp-config.xml. Тогда при компиляции проекта, будет создан в файл myapp-config.xml который будет содержать текущую конфигурацию компилятора.
Для примера, создадим свой конфигурационный файл с именем my-flex-config.xml в котором определим пару констант для условной компиляции:
В созданном файле, опишем базовую структуру файла:
<?xml version="1.0"?>
<flex-config xmlns="http://www.adobe.com/2006/flex-config">
<compiler>
<define>
<name>CONFIG::debug</name>
<value>true</value>
</define>
<define>
<name>CONFIG::console</name>
<value>true</value>
</define>
</compiler>
</flex-config>
Описание синтаксиса конфигурационного файла
Ровно тоже самое можно сделать указав из командной строки параметр компилятора
-define=CONFIG::debug,true -define=CONFIG::console,true.
По сути конфигурационный файл позволяет указать все параметры компилятора в одном файле.
Для того чтобы добавить параметр компилятора -load-config во Flash Builder’е, нажмите правой кнопкой мыши на проекте, выберите пункт Properties (Свойства), далее пункт Action Script Compiler и в текстовой области Additional Compiler Argumets, добавьте -load-config =my-flex-config.xml
В данном случае» = » означает что мы дополняем основной конфигурационный файл своим конфиг. файлом. Если нужно полностью заменить файл конфигурации, то указываем его через » = «.
Много-платформенный настройки
Следующие параметры применяются для более чем одной платформы, но не ко всем из них:
DisallowOverscroll
(логическое значение, по умолчаниюfalse
): Установите вtrue
если вы не хотите чтобы интерфейс отображал каких-либо обратной связи, когда пользователи прокручивают за начало или конец содержимого.Применяется к Android и iOS. На iOS, совершение перелистывание за границу контента (overscroll) плавно возвращает положение контента назад в исходное положение. На Android это действие производит более тонкий светящийся эффект вдоль верхнего или нижнего края контента.
BackgroundColor
: Задайте цвет фона приложения. Поддерживает шестнадцатеричное значение размером 4 байта, где первый байт представляющий альфа-канал и стандартные значения RGB для следующих трех байтов. В этом примере указывается голубой цвет:Применяется к Android и BlackBerry. Переопределяет CSS, который доступен для всех платформ, например:
body{background-color:blue}
.HideKeyboardFormAccessoryBar
(логическое значение, по умолчаниюfalse
): Установите вtrue
чтобы скрыть дополнительную панель инструментов, которая появляется над клавиатурой, помогая пользователям перемещаться из одной формы ввода на другой.Применяется к iOS и BlackBerry.
Orientation
(строка, по умолчаниюdefault
): позволяет вам заблокировать ориентацию и предотвратить интерфейс от вращения в ответ на изменения в ориентации. Возможные значенияdefault
,landscape
, илиportrait
. Пример:Кроме того можно указать любое значение платформо-зависимое значение для ориентации, если вы разместите элемент
<preference>
внутри элемента<platform>
:Применяется к Android, iOS, WP8, Amazon Fire OS и Firefox OS.
Примечание: Значение
default
означает что Cordova удалит предпочитаемое значение orientation из файла конфигурации/манифеста платформы позволяя платформе использовать свое поведение по умолчанию.Для iOS, чтобы указать как портретный так и альбомный режим вы будете использовать платформо-специфическое значение
all
:Для iOS ориентацией можно программно управлять путем определения функции обратного вызова javascript в объекте
window
:/**
- @param {Number} degree
- UIInterfaceOrientationPortrait: 0,
- UIInterfaceOrientationLandscapeRight: 90,
- UIInterfaceOrientationLandscapeLeft: -90,
- UIInterfaceOrientationPortraitUpsideDown: 180 *
- @returns {Boolean} Определяет допускается ли поворот. */ function shouldRotateToOrientation(degrees) { return true; }
Создатели config.xml трудности
Проблемы Config.xml вызваны поврежденным или отсутствующим Config.xml, недопустимыми ключами реестра, связанными с Office, или вредоносным ПО.
Точнее, ошибка config.xml, вызванная:
Типичные ошибки config.xml
Проблемы, возникающие с config.xml и Office, включают:
Проблемы с config.xml возникают во время запуска или завершения работы, во время запуска программы, связанной с config.xml, или иногда во время обновления или установки Windows. При возникновении ошибки config.xml запишите вхождения для устранения неполадок Office и HelpMicrosoft найти причину.
Элемент feature
При использовании командной строки для построения приложений, используйте команду plugin, чтобы включить API устройства. Это не изменяет файл config.xml верхнего уровня, так что элемент <feature> не применяется к вашему рабочему процессу.
Если вы работаете непосредственно в SDK и используете специфический для платформы файл config.xml в качестве источника, используйте <feature> тег, чтобы включить API устройства и внешних плагинов. Эти элементы обычно присутствуют с разными значениями в платформо-зависимых файлах config.xml. К примеру, таким образом можно указать Device API для проектов Android:
Вот как появляется элемент в проектах iOS:
Элемент hook
Представляет ваш пользовательский сценарий, который будет вызываться Cordova при возникновении определенных действий (например, после того, как плагин добавлен или логика подготовки платформы вызвана). Это полезно, когда вам нужно расширить функциональность Cordova по умолчанию. Смотрите «Руководство по хукам» для детальной информации.
Элемент platform
При использовании командной строки для построения приложений, иногда бывает необходимо указать параметры или другие элементы, специфичные для конкретной платформы. Используйте элемент <platform> для указания конфигурации которая должна применяться только в файле config.xml определенной платформы. Например, вот как можно указать, что только на платформе Android следует использовать параметр Fullscreen: