Практикум

Общие сведения по редактированию XML-документов

Для редактирования лекций можно использовать любой специализированный XML-редактор, способный проверять соответствие документа DTD (проводить валидацию), например Bonfire Studio.

Необходимость использования специализированного редактора вызвана жесткими требованиями к отсутствию в нем синтаксических ошибок (например, опечаток в названии тегов, или ошибках в их вложенности), а также соответствию документа представлениям программистов. Для выполнения данной проверки требуется проводить валидацию документа после окончания верстки. После нажатия F8 (Bonfire Studio) редактор либо сообщит, что документ успешно прошел проверку, либо укажет на ошибку. Чтобы снизить вероятность появления ошибок, необходимо действовать строго в соответствии со спецификацией; при появлении сомнений в правильности выбранного решения рекомендуется сразу после попытки его применить выполнить валидацию документа. При возникновении необходимости в добавлении новых возможностей верстки, либо при невозможности составить валидный документ без потери информации, необходимо связаться по адресу webmaster@intuit.ru.

Предварительный просмотр лекций

Для просмотра сверстанного материала требуется открыть xml-файл с лекцией в окне браузера Internet Explorer либо закладке "browse" Bonfire Studio.

Порядок представления результатов выполнения задания

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

Все материалы курса должны быть упакованы с помощью архиватора 7-Zip.

Обработанные материалы и вопросы отправляются по электронной почте на адрес nou@intuit.ru. В теме письма необходимо указать "Практикум XML".

Важно!

Структура файла lecture.xml

В ходе работы над лекцией необходимо решить следующие задачи:

В начале лекции может быть эпиграф, который оформляется как цитата.

Файл должен соответствовать следующему шаблону:

<?xml version="1.0" encoding="windows-1251" standalone="no"?>
<!DOCTYPE lecture SYSTEM "http://www.intuit.ru/xml/course/lecture.dtd">
<?xml-stylesheet type="text/xsl" href="http://www.intuit.ru/xml/course/lecture_preview.xsl" ?>
<lecture>
<title>Название лекции</title>
<annotation>Описание лекции</annotation>

<section>
    <title>заголовок</title>
  ... тело лекции ...
</section>

<tasks />
</lecture>

Шаблон лекции можно найти также в файле . Файл состоит из нескольких частей:

Верстка лекций служит исключительно для создания логической структуры лекции. Запрещается использование тегов логической разметки для создания визуальных эффектов, расходящихся с назначением тега (например, использование тега <em> при желании отобразить не являющийся акцентом текст жирным шрифтом). Это не имеет смысла, т.к. отображение тегов может быть изменено программистами в любой момент (например, отображение текста внутри тегов <em> может измениться на курсивное). Но если очень нужно, можно пользоваться конструкцией <em type="italic">ваш наклонный текст</em>

Структура лекции. Главы

Лекция состоит из глав. Каждая глава заключается внутрь тега <section>; название главы помечается тегом <title>, который должен следовать сразу после открывающего тега <section>. Главы могут содержать в произвольном порядке:

Максимальный уровень вложенности глав – 5. Заголовки глав-подразделов будут выводиться шрифтом уменьшенного размера.

Пример:

<section>
   <title>Программирование</title>
   <section>
      <title>Программирование для Unix</title>
      ...
   </section>
   <section>
       <title>Программирование для Web</title>
       <section>
           <title>Perl</title>
      <p>текст о Perl – параграф 1</p>
      <p>текст о Perl – параграф 2</p>
        ...
     </section>
     ...
   </section>
   ...
</section>

Абзацы

Текст каждого абзаца заключается в теги <p>:

<p>текст о Perl – параграф 1</p>

Листинги

Листингом называется блок программного кода на каком-либо языке программирования или разметки, формула, математическое выражение и т. д. Листиг может быть многострочный, либо находящийся на отдельной строке. Фрагменты кода или формул, находящиеся внутри текста (например, внутри абзаца), листингом не считаются (см. ниже). Для выделения листинга существует тег <example>:

<example [number="1.1"] [title="название"] [visible="yes|no]
      [type="example|listing"]>
...
</example>

Если задан атрибут number, на данный листинг будут разрешены ссылки из других лекций курса. Номер отображается сразу после листинга. В зависимости от значения атрибута type, листинг помечается словом "Листинг" (type="listing") или "Пример" (type="example"). Если задан атрибут title, его значение отображается там же. Текст листинга записывается "как есть", т.е. в теле листинга учитываются все пробелы и переводы строк.

Пример:

<example number="1.1" title="Простейшая программа на C"
       type=" listing">
int main()
{
  printf("Hello, world!\n");
}
</example>

Данный текст может быть отображен в виде:

int main()
  {
    printf("Hello, world!\n");
  }
 

Атрибут visible отвечает за отображение листинга на странице лекции. Если visible="no", листинг на странице не отображается, выводится только его название и ссылка, позволяющая открыть текст листинга в отдельном окне.

Списки

Для обозначения упорядоченных и неупорядоченных списков используется контейнер list:

<list [type="none|number"]>
<li>...</li>
<li>...</li>
...
</list>

Внутри контейнера находятся только теги <li>...</li>, в которые заключается для каждая позиция списка.

В зависимости от значения атрибута type список является упорядоченным (type="number") или неупорядоченным (type="none", необязательно). Позиции упорядоченных списков нумеруются, в неупорядоченных списках каждая позиция помечается пулькой (точкой).

Пример 1:

<list type="number">
<li>perl</li>
<li>java</li>
</list>

Данный текст может быть отображен в виде:

Пример 2:

<list>
<li>perl</li>
<li>java</li>
</list>

Данный текст может быть отображен в виде:

Цитаты

Блок текста отмечается как цитата при помощи тега <quote>. Если цитата содержит несколько абзацев текста, все абзацы выделяются в 1 тег <quote>. Примеры:

<quote>Было бы ошибкой думать...</quote>

<quote>
<p>Первый абзац цитаты</p>
<p>Второй абзац цитаты</p>
</quote>

Цитаты также можно использовать для отображения эпиграфа.

<quote author="Стендаль, quot;Жизнь Анри Брюлараquot;">
Мсье Дюпюи [учитель математики] произносил напыщенные фразы об этом предмете, 
но ни разу не сказал этих простых слов: это разделение труда, которое, 
как и всякое другое разделение труда производит чудеса и позволяет уму 
сконцентрировать все свои силы только на одной стороне объектов, только на одном из их качеств.
</quote>

Вставки

Блок текста отмечается как вставка при помощи тега <inset>. У вставки может быть необязательный атрибут icon (предполагается картинка в левом верхнем углу вставки для акцентирования внимания). Значение атрибута icon – URL картинки. Примеры:

<inset>Было бы ошибкой думать...</inset>

<inset icon="impotant.gif">
<p>Первый абзац вставки</p>
<p>Второй абзац вставки</p>
</inset>

Таблицы

Как и в HTML, таблица заключается в тег <table>:

<table [number="1.1"]>
[<caption>Название таблицы</caption>]
<tr>
<th [colspan="1"] [rowspan="1"]>Шапка таблицы</th>
<th [colspan="1"] [rowspan="1"]>Шапка таблицы</th>
</tr>
<tr>
<td [colspan="1"] [rowspan="1"]>Содержимое ячеек</td>
<td [colspan="1"] [rowspan="1"]>Содержимое ячеек</td>
</tr>
</table>

Если задан атрибут number, на таблицу можно будет ссылаться по этому номеру из других лекций. Кроме того, рядом с названием таблицы будет отображен ее номер. Название таблицы размещается в необязательном теге <caption>.

Каждая строка таблицы размещается между тегами <tr>. Ячейки таблицы представлены тегами <th> (ячейка помечается как содержащая заголовок колонки/строки) и <td> (обычная ячейка). Ячейка может быть растянута на несколько ячеек по вертикали (при помощи атрибута rowspan) или по горизонтали (атрибут colspan).

Пример:

<table number="1.1">
  <caption>Тестовая таблица</caption>
  <tr>
<th>Заголовок 1</th>
<th>Заголовок 2</th>
<th>Заголовок 3</th>
  </tr>
  <tr>
<td rowspan="2">высокая ячейка</td>
<td colspan="2">широкая ячейка</td>
  </tr>
  <tr>
<td>просто ячейка 1</td>
<td>просто ячейка 2 </td>
  </tr>
</table>

Данный пример может быть отображен следующим образом:

Разметка текстовых областей

Любой блок текста (параграф, элемент списка, цитата, ячейка таблицы) может содержать следующие строчные элементы (т.е. элементы, которые могут располагаться внутри строки текста, не разрывая ее):

Верхние и нижние индексы, акценты, конструкции языка программирования

Набор математических формул в LaTeX’е

Производится с помощью тега math.

Ссылки на литературу и примеры набора формул можно найти здесь – http://lib.mexmat.ru/forum/viewtopic.php?p=901

Пример:

<math>\int\limits_a^b f(x) dx \oint\limits_a^b f(x) dx </math>

<math>\tilde\alpha, \tilde\beta, \dots, \tilde\omega</math>

<math>\widehat{ABC}</math>

<math>\sqrt[n]{\pi}+\sqrt{\pi+2}</math>

<math mode="block">\mathbf{X} = 
\left( \begin{array}{ccc} 
x_{11}  x_{12}  \ldots \\ 
x_{21} amp; x_{22}  \ldots \\ 
\vdots amp; \vdots  \ddots 
\end{array} \right)
</math>

Для нумерации формул используется атрибут tag, пример

<math tag="3" mode="block">2+2=4</math>

Будет выглядеть так

Для ликвидации TeXовской нумерации формул, необходимы дополнительное изменение LaTeX кода, например, конструкцию

\begin{…}..формула..\end{…}

заменить на

\begin{…*}..формула..\end{…*}

Важно! При переводе ТеХ’овских формул в XML, необходимо произвести замены символов:

Для отладки формул LaTeX пользуйтесь скриптом

http://www.intuit.ru/cgi-bin/tex2png.cgi

Замену символов также можно осуществлять с помощью скрипта.

ID курса надо узнать дополнительно. Если формулы не отображаются, необходимо связаться с администрацией. При ошибках, сообщайте

Иногда необходима дополнительная настройка TeX’а для конкретного курса.

Как набирать текст лекций, набранные в LaTeX’е

\[.. LaTeX формула..\]

<math mode="block">.. LaTeX формула.. </math>

Индексы

Пример:

<p>В этом параграфе приводится пример расстановки <sup>верхних индексов</sup>, 
<sub>нижних индексов</sub>, <em>акцентов</em> и выводится название оператора <code>print</code>. 
А переменную X<sub>2</sub> с чертой наверху стоит выводить так: 
<code><vector>X<sub>2</sub></vector></code>.</p>

Ссылки

В тексте могут быть размещены ссылки на веб-ресурсы, курсы и лекции на сайте INTUIT.ru, листинги, изображения, таблицы или литературные источники. Для формирования ссылок применяется тег <ref>:

<ref src="URL or number" type="url|example|literature|image|table">…</ref>

или

<ref src="URL or number" type="url|example|literature|image|table" />

Значение атрибута type определяет тип сущности, на которую размещается ссылка, в атрибуте src указывается URL (для type="url") или значение поля number данной сущности (для всех других случаев). Если тег не пустой, ссылка применяется к его содержимому, иначе текст для ссылки формируется автоматически. По возможности следует применять пустые теги.

Если дается ссылка на источник литературы, номер источника необходимо взять в описании курса.

Примеры:

Добро пожаловать на сайт <ref src="http://www.intuit.ru"
       type="url" />
Посмотрите <ref src="1.1" type="example">пример кода 1.1</ref>

Для ссылок на лекции и курсы сайта INTUIT.ru значение атрибута type равно lecture и course, соответственно. Значение атрибута src равно

Именованные ссылки:

<list>
<li><ref src="2" type="lecture">на 2-ю лекцию в текущем курсе</ref></li>
<li><ref src="htmlintro::2" type="lecture">на 2-ю лекцию курса <em>htmlintro</em></ref></li>
<li><ref src="htmlintro::2/2.html" type="lecture">на 2-ю лекцию курса <em>htmlintro</em>, 2-ю страницу </ref></li>
<li><ref src="htmlintro" type="course">на курс <em>htmlintro</em></ref></li>
</list>

Ссылки без текста:

<list>
<li>на 2-ю лекцию в текущем курсе: <ref src="2" type="lecture" /></li>
<li>на 2-ю лекцию курса <em>htmlintro</em>: <ref src="htmlintro::2" type="lecture" /></li>
<li>на 2-ю лекцию курса <em>htmlintro</em>, 2-ю страницу: <ref src="htmlintro::2/2.html" type="lecture" /></li>
<li>на курс <em>htmlintro</em>: <ref src="htmlintro" type="course" /></li>
</list></p>

Отображаться этот код будет приблизительно так:

Именованные ссылки:

Ссылки без текста:

Сноски

Сноска обозначается в тексте при помощи тега <footnote>:

<footnote>
<term>слово</term>
<def>Текст сноски</def>
</footnote>

При отображении сноски содержимое тега <term> может быть помечено как ссылка, при нажатии на которую всплывает окно с содержимым тега <def>; возможны и другие варианты отображения.

Пример:

Перед тем как верстать лекцию, прочтите, пожалуйста, <footnote><term>спецификацию</term>
<def>Спецификацию можно найти по адресу <ref src="http://www.intuit.ru/job/" type="url" />
</def>
</footnote>.

Возможный вариант отображения (при нажатии на ссылку в сноске всплывает окно с разъяснением сноски):

Перед тем как верстать лекцию, прочтите, пожалуйста, спецификациюСпецификацию можно найти по адресу <ref src="http://www.intuit.ru/job/" type="url" />.

Изображения

Изображения вставляются в текст при помощи тега <image>:

<image src="name.gif" title="Название" [number="1.1"] />

Приведенный пример может отобразиться так:

[здесь выводится изображение из файла name.gif]
Рис. 1.1. Название

Для того чтобы предварительный просмотр лекции с изображениями работал правильно, файлы с изображением должны лежать в одной папке с файлом лекции (lecture.xml).

Для отображения изображения в тексте (а не в отдельном параграфе) используется атрибут type со значением inline. По умолчанию, type=block.

После этого, нажмите на кнопку <image src="knopka.gif" title="Кнопка" type="inline" />

Если необходима специальная разметка в подписи к рисунку, то можно использовать следующию конструкцию

<image src="name.gif" title="" number="1.1">Название <em>рисунка</em></image>

Если некий текст необходимо оформить, как рисунок, то текст пишем в теге image, а атрибут src делаем пустым. Пример:

<image src="" title="Подпись к рисунку" number="1.1">Текст, который оформляется, как рисунок</image>

Атрибут align позволяет управлять выравниванием расположения вынесенной картинки, допустимые значения:

Пример

<image src="name.gif" align="center" title="Название" number="1.1" />

Для отображения рисунков большого размера используется атрибут full-size.

Если рисунок (например,11_03.jpg) имеет размер более 620 пикселей по высоте или ширине, то необходимо:

<image src="11_03sm.jpg" full-size="11_03.jpg" …/>

Страницы

При необходимости текст лекции может быть разбит на страницы при помощи тега <page-break/>. Тег рекомендуется помещать перед началом очередной главы, но в случае, если страницы при этом получаются слишком громоздкими, от этого правила разрешено отступать. В случае глав небольшого размера несколько глав могут быть размещены на одной странице. Критериями, говорящими о необходимости разбивки лекции на страницы являются:

Структура файла теста

Тест представляет собой набор задач, относящихся к одной лекции. Для каждой задачи существует несколько ее вариантов (вопросов). Например, если в тесте 3 задачи, это означает, что для прохождения теста пользователь должен будет ответить на 3 вопроса. Конкретные вопросы, предложенные пользователю, будут выбираться из набора вариантов: первый вопрос – это один из вариантов к первой задаче, второй – один из вариантов ко второй, и т. д. У каждого варианта задачи существует набор ответов, каждый из которых помечается при верстке как правильный или неправильный. В зависимости от варианта, при ответе на вопрос пользователь может выбрать только один из ответов (режим single), или ему будет предоставлена возможность выбрать несколько ответов (режим multiple). Режим также устанавливается верстальщиком на основании простого правила: если правильный ответ строго один – это single, если правильных ответов нет, или их больше 1 – это multiple.

В ходе работы над тестом необходимо решить следующие задачи:

При решении задачи (2) следует руководствоваться набором тегов, описанным выше для файла lecture.xml.

Файл теста должен иметь имя вида X.xml (где X – номер лекции) и должен соответствовать следующему шаблону:

<?xml version="1.0" encoding="windows-1251" standalone="no" ?>
<!DOCTYPE tasks SYSTEM "http://www.intuit.ru/xml/course/tasks.dtd">
<?xml-stylesheet type="text/xsl" href="http://www.intuit.ru/xml/course/tasks_preview.xsl" >

<tasks>
<task code="1">
<variant code="1" answer-type="single">
<question>Вопрос №1 задачи №1></question>
<answers>
  <answer code="1" correct="yes">Ответ 1 правильный</answer>
  <answer code="2" correct="no">Ответ 2 неправильный</answer>
  <answer code="3" correct="no">Ответ 3 неправильный</answer>
</answers>
</variant>

<variant code="2" answer-type="multiple">
<question>Вопрос №2 задачи 1 – 2 прав. ответа</question>
<answers>
  <answer code="1" correct="yes">прав. ответ 1</answer>
  <answer code="2" correct="yes">прав. ответ 2</answer>
…
</answers>
</variant>
</task>
<task code="2">
…
</task>
…
</tasks>

При верстке нового теста значения атрибутов code тегов task заполняются последовательно (1, 2, 3…). Значения атрибутов code для каждой задачи начинаются с единицы и также заполняются последовательно. То же верно и для ответов.

Специальные символы (сущности)

Cимволы, имеющие особое значение в языке XML

К данным символам относятся:

Если в тексте содержатся данные символы, есть риск того, что он не пройдет валидацию, т.к. например символ < будет считаться открывающим тег – даже если это на самом деле не так. В этом случае его нужно будет заменить на lt;. Другой частый случай – знак кавычек в значении атрибута. Если ввести его "как есть", программа "запутывается" в кавычках и документ также не проходит валидацию. Вместо этого необходимо ввести quot;. Ну и наконец, если потребовалось ввести символ амперсанда (), скажем, в названии "ProcterGamble", программа, обрабатывающая документ, начинает искать сущность Gamble;, но не находит ее. Вместо этого следует вводить название как "Procteramp;Gamble".

Cпециальные символы, символы других языков

Набираются с помощью ТЕХа.

Оформление списка литературы

Список литературы записывается в файле формата электронных таблиц .XLS Microsoft Excel. Поля таблицы -

cid – ID курса, узнать у администрации или оставить пустым.

synonym - имя ссылки _ synonym_, которое используется в конструкции вида

<ref src="_ synonym_" type="literature" />

Как правило, совпадает с номером num (смотрите файл Liter302.xls для примера) , но в случае, если литература в оригинальном курсе прилагается отдельно к каждой лекции, то для synonym следует использовать нумерацию вида <номер лекции>.<номер пункта литературы в списке литературы к лекции> (смотрите файл Liter308.xls для примера). Возможно для ссылок использовать имена для литературы, которые использует автор курса, оригинальная нумерация пунктов литературы часто встречается в книгах набранных в LaTeX’е.

authors – авторы

title – название

date_line – выходные данные

url – URL, если есть

Примеры списков литературы смотрите в файлах Liter302.xls и Liter308.xls.

Пример выполнения задания

Пример индивидуального задания находится в файле.

Пример выполненного индивидуального задания находится в файле.