Как известно, статьи и новости, размещаемые на нашем сайте, должны представлять собой разновидность XML-документов. Ниже приведены рекомендации, которые следует соблюдать при подготовке статей и новостей.

Кое-какие сведения об XML

Язык XML чувствителен к регистру. Это означает, что теги <a> и <A> - совершенно разные теги. На нашем сайте принято, что все теги пишутся строчными буквами.

В отличие от HTML, все открывающие теги в обязательном порядке должны иметь соответствующий закрывающий тег. Если тег непарный, например, <br>, то он должен писаться вот так: <br/>.

Все атрибуты тегов обязательно должны быть указаны в кавычках, например: <img src="http://www.nowhere.com/images/logo.gif"/>

Подмножество XML, разрешенное в новостях и статьях

Для удобства авторов, теги XML, используемые в новостях и статьях, называются так же, как и аналогичные теги HTML. В новостях и статьях допустимо применение только следующих тегов (остальные будут проигнорированы, либо могут привести к непредсказуемым результатам). В скобках приведены разрешенные атрибуты:

Форматирование текста:

• br (clear) - перенос строки
• p (align) - параграф
• img (hsize, vsize, hspace, vspace, src, alt, border, align) - указание ширины, высоты, и alt обязательно
• h2, h2, h3, h4 - заголовки
• hr
• ul, li - списки
• center - центровка
• em, b - курсив и выделение
• table (height, width, cellpadding, cellspacing, align, valign)
• tr (align, valign)
• td (align, valign)
• a (href, name) - ссылки внутри сайта обязательно относительно корня, без адреса сайта

  Служебные теги

• _r_, _e_, _g_, _f_
• summary, title, keywords, article

Следует заметить, что теги следует применять исключительно по прямому назначению, т.е. недопустимо применять теги b и em для заголовков, тег table для форматирования статьи, и т.д. Это связано с тем, что в зависимости от броузера вышеописанные теги могут транслироваться в совершенно разный html, и попытки форматировать текст непредназначенными для этого тегами могут привести к непредсказуемым (и неудовлетворительным) результатам.

Отличия от стандартного XML

По стандарту, XML-документ должен содержать ровно один корневой тег. Новости и статьи могут содержать сколько угодно корневых тегов. Кроме того, по стандарту, XML-документ должен содержать заголовок вида <?xml version="1.0" encoding="windows-1251"?>. Новости и статьи не должны содержать этого заголовка.

Зачем это было сделано? Чтобы не писать фиктивный тег и заголовок при вводе каждой новости. Впрочем, возможность локальной проверки документа нашей дурмашиной перевешивает это преимущество, так что вскоре мы добавим возможность вставления также и корректных с точки зрения XML новостей и статей.

Требования к оформлению

Статьи и новости должны полностью отображаться при ширине экрана 720 пикселей. Это, в частности, означает, что не следует в ряд располагать картинки, суммарная ширина которых более этого значения, а также показывать широкие таблицы. Горизонтальная полоса прокрутки (скроллер) не допускается.

Как уже было сказано выше, следует избегать попыток форматирования документа с помощью html-тегов. Помимо выбивания из общего стиля сайта, это также может привести к непредсказуемым последствиям в разных броузерах. Заголовки следует выделять тегом h, параграфы тегом p, и т.д.

Все локальные ссылки следует давать от корня сайта, опуская адрес и порт. В картинках следует обязательно указывать ширину, высоту, и содержимое атрибута alt.

Структура статьи

Статья должна быть иметь следующую структуру:

<keywords>список ключевых слов</keywords>
<title>название статьи</title>
<summary>текст, который будет отображен в анонсе статьи и оглавлении сайта</summary>
<article>собственно текст статьи</article>

Структура новости

Новость может иметь любую структуру, удовлетворяющую вышеописанным требованиям к тегам и оформлению.

Иллюстрации

Все файлы картинок, относящиеся к статье, должны лежать в каталоге /images/articles/ARTURLID, где ARTURLID - назначенный Вами URLID статьи. К примеру, если URLID статьи - skystarsoft, то каталог будет /images/articles/skystarsoft.

Все файлы картинок, относящиеся к новостям, должны лежать в каталоге /images/news/DATE, где DATE - дата опубликования новости в формате ГГГГММДД, например, 20020315 - 15 марта 2002 года.

Дурмашина - Среда для написания статей

Для того, чтобы было удобно отлаживать внешний вид статей, мы разработали специальную дурмашину, которая позволяет локально (т.е. без выкладывания на сайт) транслировать XML-текст статьи в HTML. Дурмашина базируется на основе библиотеки XML-парсинга MSXML4.0. Для того, чтобы начать работать с дурмашиной, проделайте следующие действия:

• Скачайте и установите библиотеку MS XML 4.0,
• Скачайте и распакуйте в произвольный каталог дурмашину
• Положите иллюстрации к статье в соответствующий подкаталог каталога images дурмашины.
• Замените файл примера article.xml на файл вашей статьи, с добавленным заголовком и корневым тегом <xml>
• Для просмотра результата откройте в Internet Explorer файл article.html.

Обработка ошибок

Если Ваша статья не показывается, то, скорее всего, она содержит ошибку синтаксиса XML. Откройте файл article.xml в Internet Explorer. В этом случае либо будет показано содержимое файла, либо будет выдано подробное сообщение об ошибке XML.

Дурмашина проверяет правильность выполнения некоторых вышеописанных правил, и в случае их нарушения, вместо нужного тега выводит сообщение об ошибке красным цветом.

Ограничения в реализации

На данный момент англоязычные статьи не поддерживаются. Для просмотра англоязычной версии требуется небольшая модификация файла article.xsl

Разместил: shura
01.01.2002