Файл текущей версии библиотеки RuScenery состоит из последовательных строчек, с разделителем «0D 0A». Файл используется для управления программой установки и обновления библиотеки RuScenery. Имя файла фиксированное — «ruscenery.ver»
Строка, начинающаяся с символа «#» является комментарием и при обработке игнорируется.
Пример:
Строка, начинающаяся с символа «;» является управляющей командой.
Второй символ в строке — буква латинского алфавита, определяет вид команды. Символ команды регистронезависимый. Все команды являются необязательными. Команды уникальны и не должны несколько раз повторяться в файле. Взамимное положение команд, комментариев и строк описания файлов не фиксируется, однако для удобства чтения глазами рекомендуется команды размещать в начале файла.
Доступны следующие виды команд:
Указывает папку, в которой следует искать файл текущей версии при следующей закачке. Значение должно сохраняться на стороне клиента и использоваться при следующем подключении. Может применяться при планировании смены хост-провайдера или структуры сайта.
Пример:
При отсутствии команды используется значение:
Указывает папку, в которой находится структура файлов обновления. Значение должно использоваться в текущем сеансе. Может применяться при смене структуры сайта или для балансирования нагрузки, если вместо файла текущей версии будет работать скрипт, выдающий каждому пользователю разные серверы для скачивания.
Пример:
При отсутствии команды используется значение:
Указывает текущую версию программы обновления, хранимую на сайте обновлений. В том случае, если версия программы у клиента ниже, чем последняя — пользователю должно выводиться сообщение с предложением обновить программу. При этом запущенная в этом сеансе закачка обновлений не должна блокироваться.
Пример:
При отсутствии команды сравнение версий не производится.
Указывает текстовую строчку в кодировке Win-1251, которая выводится у пользователя в течение всего обновления. Использование управляющих символов в строчке не допускается.
Пример:
При отсутствии команды сообщение у клиента не выводится.
Указывает текстовую строчку в кодировке Win-1251, которая выводится у пользователя перед началом обновления. Использование управляющих символов в строчке не допускается.
Пример:
При отсутствии команды сообщение у клиента не выводится.
Указывает текстовую строчку в кодировке Win-1251, которая выводится у пользователя после завершения обновления. Использование управляющих символов в строчке не допускается.
Пример:
При отсутствии команды сообщение у клиента не выводится.
Строчки содержат разделенные одним пробелом поля. В полях категорически не допускается использование управляющих символов и символов пробела.
Пример:
При разработке программы установки и обновления следует учесть, что в последующих версиях файла обновления может быть добавлены разделенные пробелом другие поля.
Пример: