| Предыдущая версия справа и слева
Предыдущая версия
Следующая версия
|
Предыдущая версия
|
ru:content:description.xml [2015/02/02 18:55]
Константин |
ru:content:description.xml [2018/05/16 15:21] (текущий)
Konstantin Goncharik |
| ====== Описание параметров файла description.xml ====== | ====== Описание файла description.xml ====== |
| | Файл представляет собой тег ''addon'' со следующими атрибутами: |
| | * ''addonSize'' --- размер дополнения в байтах (0, если размещается у нас). |
| | * ''address1'', ''address2'', ... --- адрес региона, карты которого содержатся в дополнении, в соответствии с административно-территориальным делением. Например, если дополнение содержит карты какого-то региона России, значения атрибутов могут быть следующими: ''address1'' --- название страны, ''address2'' --- название федерального округа, ''address3'' --- название региона. Атрибуты ''address'' используются для создания структуры каталога карт в разделе "Дополнения". |
| | * ''date'' --- дата последнего обновления данных в дополнении в формате ''YYYY-MM-DDThh:mm:ss'' или ''YYYY-MM-DD''. |
| | * ''descFiles'' --- список имён файлов, которые используются в описании дополнения (картинки, звуковой файл). |
| | * ''description'' --- описание содержимого дополнения и ключевые слова для поиска. |
| | * ''feedbackURL'' --- URL для отправки [[ru:content:feedback|отзыва]] от пользователя дополнения. |
| | * ''os'' --- список ОС, на которых доступно дополнение, перечисленных через '';''. Названия ОС: ''Android'', ''CE'', ''iOS'', ''LINUX'', ''NT'', ''RT''. Если атрибут не указан, дополнение доступно на всех ОС. |
| | * ''programVer'' --- версия программы, для которой было сделано дополнение, в виде ''x.y''. |
| | * ''provider'' --- наименование поставщика дополнения. |
| | * ''title'' --- наименование дополнения. |
| | * ''type'' --- список типов ресурсов, содержащихся в дополнении. Возможные типы: ''language'', ''map'', ''skin'', ''sound'', ''speedcam''. |
| | * ''url'' --- URL для загрузки дополнения. Альтернативные адреса могут быть заданы в атрибутах ''url0'', ''url1'', ..., ''url9'', но имя файла должно быть везде одно и то же. |
| | * ''zipSize'' --- размер zip-архива с дополнением в байтах (0, если размещается у нас). |
| | У платных дополнений есть дополнительные атрибуты: |
| | * ''expiredKeyMsg'' --- текст, который выводится в окне активации, если у пользователя есть ключ, но его срок действия закончился. |
| | * ''keyId'' --- идентификатор ключа, которым зашифровано дополнение. |
| | * ''keyRequestURL'' --- URL, используемый для [[ru:content:activateUrl|загрузки]] ключа пользователя. |
| | * ''keySoftExpireMsg'' --- текст, который выводится в окне активации, если у пользователя есть ключ, но его срок действия заканчивается. |
| | * ''noKeyMsg'' --- текст, который выводится в окне активации, если у пользователя нет ключа. |
| | * ''productIds'' --- список названий продуктов, покупка одного из которых открывает доступ к дополнению. |
| | * ''providerId'' --- идентификатор поставщика. |
| | * ''purchaseCodeFileName'' --- имя файла, в котором программе следует искать код покупки. |
| | * ''requestFileMsg'' --- текст, который выводится после создания файла запроса. |
| | * ''requestFileName'' --- имя файла запроса (без расширения). |
| |
| <code xml> | Атрибуты ''title'', ''type'' и ''url'' являются обязательными. |
| <addon | |
| title="All Russia" title:ru="Вся Россия" // наименование контейнера | |
| description="Russian Federation map based on OSM sources.\n[picture=test_screen1]\n Cityes: Moscow, " | |
| description:ru="Территрия Российской Федерации на основе карт OSM.\n[picture=test_screen1]\n Города: " // описание содержимого контейнера и ключевые слова для поиска | |
| descFiles="test_screen1.png" // медиафайлы для контейнера | |
| type="map" // тип содержимого контейнера черз ; | |
| date="2014-03-24T08:56:18" //Дата обновления данных в контейнере | |
| zipSize="26312104" // размер архива с контейнером (+-100байт) | |
| addonSize="37073123" // размер дополнения (файла *.7wz) | |
| bounds="" // границы карты | |
| subsIds="embedded001y;embedded001m" // идентификатор подписок | |
| system="" // ограничение по операционным системам | |
| locklanguage="false" // ограничение по возможным языкам - true - только для языков использующихся в этом файле | |
| address1="Russia" // адрес для типа карт | |
| address1:ru="Россия" | |
| provider="megamaps.org" // наименование провайдера | |
| url="192.168.100.1/russia_all/russia.zip" // url для загрузки дополнения | |
| /> | |
| </code> | |
| |
| Данный текст необходимо также сохранить в контейнер в файл description.xml. | Атрибуты ''address'', ''description'', ''expiredKeyMsg'', ''keySoftExpireMsg'', ''noKeyMsg'', ''provider'', ''requestFileMsg'', ''title'' являются мультиязычными, т.е. можно указать несколько атрибутов с одним названием, добавив к названию '':xx'', где ''xx'' --- код языка по стандарту ISO 639-1. При этом обязательно должен быть указан атрибут без суффикса --- его значение будет использоваться, когда нет атрибута с подходящим языковым суффиксом. |
| Вот некоторые правила по его созданию: | |
| Мультиязычными полями являются ''title'', ''description'', ''addressN'', ''provider'' (обязательно должно быть значение без языкового суффикса).\\ | |
| Атрибут ''type'' - перечисление через точку с запятой ''map'', ''skin'', ''language'', ''sound'', ''speedcam''. | |
| Кроме ''url'', может быть ''url1'', ''url2'', ..., ''url9'', но имя файла должно быть везде одинаковое. | |
| Атрибуты ''addressN'' должны быть указаны для карт. Имеется ввиду что цифра указывает уровень адресной иерархии, т.е. 1 - Страна, 2 - Регион, 3 - Район, 4 - Населенный пункт | |
| Необходимо иметь ввиду что наибольший индекс окончательно характеризует конечный адрес содержимого контейнера. | |
| |
| | В атрибутах, содержащих список, элементы разделяются точкой с запятой. |
| | |
| | FIXME |
| | <file xml description.xml> |
| | <addon |
| | title="All Russia" title:ru="Вся Россия" |
| | description="Russian Federation map based on OSM sources.\n[picture=test_screen1]\n Cites: Moscow" |
| | description:ru="Территория Российской Федерации на основе карт OSM.\n[picture=test_screen1]\n Города: " |
| | descFiles="test_screen1.png" |
| | type="map" |
| | date="2014-03-24T08:56:18" |
| | zipSize="26312104" |
| | addonSize="37073123" |
| | address1="Russia" |
| | address1:ru="Россия" |
| | provider="megamaps.org" |
| | url="navikey.ru/russia_all/russia.zip" |
| | feedbackURL="navikey.ru/russia/feedback.php" |
| | programVer="1.04" |
| | productIds="embedded001y;embedded001m" |
| | requestFileName="file-request" |
| | providerId="11111" |
| | keyId="65520" |
| | keyRequestURL="sibreg.org/activate.php" |
| | noKeyMsg="" |
| | keySoftExpireMsg="" |
| | expiredKeyMsg="" |
| | requestFileMsg="" |
| | /> |
| | </file> |
