OPML 2.0
Внешний язык маркирования процессоров
OPML 2.0 |
|
|
Внешний язык маркирования процессоров
|
22/11/07 DW - Это опубликованный документ, который, пожалуйста, следует реализовать, формат OPML 2.0 заморожен.
Французский перевод Дени Суро для .fr.
Спецификации на английском языке - OPML 1.0
В этом документе описывается формат для хранения планов в XML 1.0 под названием Outline Processor Markup Language или OPML (на французском языке - Tags de Processor de Plan).
Цель этого формата состоит в том, чтобы обеспечить способ обмена информацией между плановым ПО и интернет-сервисами, которые могут быть доступны или контролироваться плановым ПО.
OPML также является форматом файла для приложения плана, что объясняет, почему файлы OPML могут содержать информацию о размере, положении и состоянии расширения окна, в котором отображается план.
OPML также стала популярной как формат обмена подписными листами между читателями потоков и агрегаторами.
Цель конструкции заключается в том, чтобы иметь простой формат прозрачности, самоконтроля, расширяемая и читаемая человеком, способная представлять самые разные данные, которые можно легко просматривать и редактировать.
Это открытый формат, а значит, другим разработчикам планового ПО и сервисов предлагается использовать этот формат для совместимости с Radio Userland, OPML Editor или для любых других целей.
Плоскость - это дерево, где каждый узел содержит набор именованных атрибутов со значениями, которые являются строками символов.
<opml> является XML-элементом с одним необходимым атрибутом версии; элемент «head» и элемент «body», оба из которых необходимы.
Атрибут version является строкой символа версии формы x.y, где x и y являются цифровыми строками.
Значение версии может быть 1.0, если оно соответствует предыдущей версии этой спецификации, опубликованной в 2000 году; или 2.0, если он соответствует настоящей спецификации.
Если ты видишь файл с версией 1.1, то относись к нему так, как будто это файл версии 1.0.
<head> содержит 0 или более дополнительных элементов, как описано ниже.
<title> - название документа.
<dateCreated> - дата-время, указывающее, когда был создан документ.
<dateModified> - дата-время, указывающее, когда документ был изменен в последний раз.
<ownerName> - строка, владелец документа.
<ownerEmail> - строка, адрес владельца документа.
<ownerId> - http-адрес веб-страницы, содержащий информацию, позволяющую человеческому читателю общаться с автором документа по электронной почте или другим способом. Он также может использоваться для идентификации автора. Два автора не могут иметь одинаковый ownerID.
<docs> - http-адрес документации для формата, используемого в файле OPML. Вероятно, это указатель на этой странице для людей, которые могли бы наткнуться на файл через 25 лет оттуда и задаться вопросом, что это такое.
<expansionState> - это список, разделенный запятыми номеров развернутых строк. Номер строки в списке говорит, какие заголовки развивать. Порядок важен. Для каждого элемента в списке X, стартуя на первой вершине, мы двигаемся X раз и развиваем. Повторяем для каждого элемента списка.
<greenScrollState> - число, указывающее, какая строка плана отображается в первой строке окна. Это число рассчитывается с учетом уже применяемого состояния развития.
<windowsTop> - число, позиция пикселя верхнего края окна.
<windowsLeft> - число, позиция пикселя левого края окна.
<windowsBottom> - число, позиция пикселя нижнего края окна.
<windowsRight> - число, позиция пикселя правого края окна.
<body> содержит элемент «outline» или более поздний.
<outline> - элемент XML, содержащий по крайней мере один необходимый, текстовый и нулевой дополнительные атрибуты. <outline> может содержать ноль подэлементов <outline> или больше. Атрибуты не могут быть повторены в одном и том же элементе <outline>.
Атрибут текста 
Каждый элемент outline должен иметь хотя бы один текстовый атрибут, который отображается при открытии файла OPML программой plan. Отсутствие атрибута текста сделает отображение плана бесполезным в программном обеспечении плана. Это то, что должен видеть пользователь - явно недопустимая ситуация.
Отсутствующий в плане атрибут текста является ошибкой.
Атрибуты текста могут содержать HTML-кодировку.
type - это строка символов, в ней говорится, как интерпретируются другие атрибуты в <outline>.
isComment является строкой, то есть «true» или «false» (true или false), указывающей, комментируется план или нет. По договоренности, если какой-то план комментируется, то все подведомственные планы тоже считаются комментированными. Если его нет, значение ошибается.
isBreakpoint является строкой, то есть «true» или «false», указывающей, помещается ли точка остановки на плоскости. Этот атрибут особенно необходим для планов, используемых для редактирования сценариев. Если значение отсутствует, оно ошибается.
created - дата-время создания узла плана.
Категория - это строка символов, состоящая из строк, ограниченных слешами и разделенных запятыми, в формате, заданном элементом категории RSS 2.0. Для представления «тега» строка категории не должна содержать слешей.
Примеры :
1. категория = «/Boston/Weather ».
2. категория = «/Гарвард/Беркман ,/Политика ».
Подписной список может быть многоуровневым подписным списком потоков. Каждый подэлемент в теле документа OPML - это узел типа rss или элемент плана, содержащий узлы типа rss.
Сейчас большинство подписных списков являются простыми последовательностями узлов rss, но некоторые агрегаторы позволяют классифицировать подписные списки, которые структурированы произвольно. Средство проверки может сообщать об этих файлах, предупреждая, что процессоры могут не понимать и не сохранять структуру.
Необходимые атрибуты: type, text, xmlUrl. Для элементов плана, тип которых - rss, изначально предполагается, что атрибут text должен быть элементом заголовка верхнего уровня выделенного потока, однако, поскольку он может редактироваться пользователем, процессоры не всегда должны зависеть от того, что содержит название потока.
xmlUrl - http-адрес потока.
Дополнительные атрибуты - описание, htmlUrl, язык, заголовок, версия. Эти атрибуты полезны для представления пользователю списка подписки. За исключением версий, все они получены из информации, поступающей из самого потока.
описание - элемент описания верхнего уровня потока.
htmlUrl - элемент ссылки верхнего уровня.
язык - значение элемента языка более высокого уровня.
title - это, вероятно, то же самое, что и текст, его не следует опускать, title содержит титульный элемент высшего уровня потока.
версия варьируется в зависимости от версии предоставленного RSS-канала. Это было придумано в то время, когда считалось, что могут быть процессоры, которые будут обрабатывать только определенные версии, но это уже не стало важной проблемой. Значения, которые могут быть RSS1 для RSS 1.0; RSS за 0.91, 0.92 или 2.0; scriptNews для формата scriptNews. Известных значений для потоков Atom нет, но они наверняка могли быть предоставлены.
Элемент плана, типом которого является ссылка, должен иметь атрибут url, значение которого является http-адресом. Текст, как обычно, отображается в программном обеспечении плана; Это также отображается механизмом рендеринга HTML.
Когда связь разрабатывается плановым ПО, если адрес заканчивается на «.opml», план развивается на месте. Это называется инклюзией.
Если адрес не заканчивается на «.opml», ссылка должна указывать на то, что браузер не может показать.
В OPML 2.0 вводится новый тип. Элемент плана с включенным типом должен иметь атрибут url, указывающий на файл OPML, который необходимо включить.
Разница между ссылками и включениями заключается в том, что ссылка может указывать на то, что отображается в браузере, и всегда включать подсказки на файле OPML.
Каталог (каталог) может содержать произвольную структуру элементов плана включённого типа, ссылки или rss и, возможно, других типов. Для просмотра каталогов можно использовать самые разные программы, включая такие плановые программы, как OPML Editor.
Расширить OPML
Файл OPML может содержать элементы и атрибуты, не описанные на этой странице, только если эти элементы определены в пространстве имен, заданном W3C.
OPML также можно расширить путем добавления новых значений для типа атрибута. При указании такого расширения, следуя примеру этой спецификации, ты говоришь, какие атрибуты нужны, а какие необязательны, и объяснишь, какую роль играет каждый атрибут, их отношения и какие правила они должны соблюдать. В редакторе OPML есть механизм, который основан на такой форме расширения.
Разработчики должны, насколько это возможно, использовать возможности, уже используемые другими, или включенные в эту спецификацию, или рекомендации, или правила.
Примеры
subscribtionList.opml
states.opml
SimpleScript .opml
placesLived.opml
regory.opml
category.opml
1. Все даты-время должны соответствовать спецификации RFC 822 Даты и Времени, за исключением года, который может быть выражен двумя или четырьмя символами (желательно четыре).
2. Страница в <ownerId> может содержать ссылки на другие документы, содержащие информацию о владельце. Например, можно иметь элемент ссылки, указывающий на документ FOAF с описанием владельца и его сети друзей; или RSS-канал с новостями владельца, возможно даже относящимися элементами категории RSS 2.0 к частям документа OPML. Иными словами, в игру могут вступить все механизмы расширения HTML.
3. Значение типовых атрибутов не зависит от регистра, поэтому type = «LINK» представляет то же самое, что и type = «link».
4. Атрибуты плана, как правило, не содержат кода HTML-разметки, если они явно не говорят о включении тега.
5. Процессоры должны иметь все атрибуты, которые они не узнают.
6. Нет задокументированного ограничения на количество атрибутов, которые может иметь элемент «outline», или количество элементов «outline», которые он может содержать, или размер любого атрибута.
7. Каждый подэлемент <head> может появиться один раз или вообще нет. Ни один подэлемент <head> не может быть повторен.
8. Если HTML-страница создается из документа OPML, можно использовать элемент HTML-ссылки для «автооткрытия» OPML. Значение атрибута rel - «outline», тип «text/x-opml», и, конечно, атрибут href содержит адрес документа OPML.
9. Можно включить элементы OPML 2.0 в другие форматы на основе XML. URI пространства имен: http://opml.org/spec2. Объявление пространства имен должно выглядеть так: xmlns: opml =» http://opml.org/spec2».
Однако для совместимости по восходящей стороне основные элементы (определенные этим спецификацией) документа OPML 2.0 не находятся в пространстве имен. Вот пример файла RSS 2.0, который содержит плоскость в одном из его элементов.
Дорожная карта
Версия 2.0 - последняя версия OPML. В соответствии с разделом «Расширение OPML» этой спецификации все будущие разработки не будут осуществляться с помощью пространств имен и новых типов планов; или в форматах, полученных из OPML с разными именами.
Авторское право и авторизация
© Авторские права 2000 UserLand Software, Inc. Все права защищены.
© Авторское право 2006-2007 Script News, Inc. Все права защищены.
Этот документ и его переводы могут быть скопированы и предоставлены другим, и работы, производные для комментария или объяснения или содействия реализации, могут быть написаны, скопированы, опубликованы и распространены полностью или частично без ограничений любого рода, при условии, что уведомление об авторском праве выше и эти абзацы включены в эти копии или производные произведения.
Документ никоим образом не может быть изменен удалением уведомления об авторском праве или ссылок на UserLand или другие организации. Кроме того, поскольку эти ограничения на авторское право применяются к написанию спецификации OPML, ПользовательLand не предъявляет никаких претензий на право собственности в том формате, который он описывает. Любой может по коммерческим или некоммерческим причинам реализовать этот протокол без лицензионных прав или роялти, причитающихся ПользователюLand. Вышеуказанные ограниченные разрешения являются бессрочными и не могут быть отозваны ПользователемLand или его преемниками или представителями.
Вышеуказанный документ и информация предоставляются на основании «как есть» и USERLAND DECLINE ВСЕ ГАРАНТИИ, ЭКСПРЕССЫ ИЛИ СВЯЗАННЫЕ С НИМИ, ВКЛЮЧАЯ ЛЮБЫЕ ГАРАНТИИ ТОГО, ЧТО ИСПОЛЬЗОВАНИЕ ВЫШЕУКАЗАННОЙ ИНФОРМАЦИИ НЕ НАРУШИТ НИКАКИХ ПРАВ ИЛИ ЛЮБЫЕ ГАРАНТИИ, СВЯЗАННЫЕ С МАРКЕТИНГОМ ИЛИ ПРИМЕНИМОСТЬЮ ДЛЯ ЛЮБОГО ИСПОЛЬЗОВАНИЯ
© Авторское право 2000-2008, Script News, Inc.
OPML является торговым знаком Script News, Inc.
Последнее обновление: четверг, ноябрь 22, 2007 в 11:40:34 AM.
© Авторское право 2008 Дени Суро для французского перевода. Ссылка: https://www.iqlevsha.ru/xml/OPML-2.0.html.
Лицензия на французский перевод: Этот перевод можно печатать и использовать свободно при условии сохранения авторских уведомлений, включая вышеуказанное авторское право на перевод. Этот документ нельзя разместить на другом веб-сайте, вместо этого нужно разместить ссылку на приведенный выше URL - перевод выложен 7 мая 2008 года.