четверг, 15 марта 2012 г.

Scriptish. Общие ключи

Итак начнем мы рассказ об блоке MetaData с рассказа об общих ключах, которые совместно используются в Scriptish и GreezeMonkey.Эти ключи определяют настройки юзерского скрипта, а так же дают информацию об его устройстве и авторстве. Правда есть несколько ключей которые появились только в Scriptish, но относятся так же к общей описательной части, и поэтому с явным указанием их, что они только для последнего - я внесу их описание в эту заметку
@name
Имя сценария. Оно отображается для пользователей в Scriptish меню панели инструментов и в блоке настройке дополнений
// @name my-script
@id**
Идентификатор, уникальное имя скрипта, которое в Scriptish используется как имя паки и имя файлов самих скриптов и их версий, Кроме того, идентификатор используется при отображении в сообщении об ошибке на веб-консоли в качестве префикса для сообщения
// @id user-script@domain.name
// @id identificator
Предпочтение отдается первой форме, причем здесь надо использовать латиницу
@namespace
Пространство имен. Используется в качестве дополнительного параметра при создании уникального идентификатора скрипта. В Scriptish не используется, но добавлен для совместимости с другими системами
// @namespace http://someplace.com
@version
Текущая версия скрипта.
@description
Описание скрипта и его работы. Приводится в вкладке специального дополнения
@author
Автор проекта. Желательно это поле заполнять строго по ниже приведенной форме, чтобы манагер скриптов мог однозначно определять поле на подполя. Формат приведен ниже, причем он должен соблюдаться для всех других подобных полей.
// @author Fname MNames LName http://website-url.com/
@developer
Разработчик, соавтор пользовательского сценария.
@contributor
Спонсор разработки
@сontributionURL**
Адрес страницы, если пользователь желает, сделать денежный вклад. Это будет отображаться в описании пользовательского сценария во вкладке смотри более, доступ к которой открывается в менеджере дополнений.
@contributionAmount**
Размер вклада, если указан предедущий параметр. Внос вклада не обязателен.
@homepage,@homepageURL,@website**
Ссылка на домашнюю страницу скрипта. Выводится в манагере дополнений после описания скрипта
@icon,@iconURL,@defaulticon**
Ссылка на иконку в манагере дополнений
@icon64,@icon64URL**
Ссылка на большую иконку, еоторая используется в описательной части манагера дополнений, в случае отсутствия применяется предедущая иконка
@screenshot**
Ссылка на скин - сайта с использованием сценария. Выводится в описательной части манагера дополнений
@supportURL**
Ссылка на сайт поддержке - не используется
@updateURL**
Ccылка на обновление сценаоия. Здесь есть обязательное требование. Ссылка должна обязательно иметь протокол https://, а так же в настройках на сам Scriptish - должно быть указано что обновление разрешается. При этом можно использовать промежуточный файл meta.js, в котором записаны только обновляемые версии, и сценария, и после проверки на нестыковку по версиям, будет загружена новая версия из файла с наименованием .user.js. Такая техника обновления позволяет ускорить проверку обновления в момент загрузки браузера страницы использования и сократить трафик при обмене

** указывает что данный параметр-ключ используется только в Scriptish