Реализация расширяемого эссе
(расширяемое эссе)

Предлагается гипертекстовая схема расширяемого эссе, т.е. краткого изложения материала - учебного, научного, познавательного, справочного - с дополняющими, библиографическими, иллюстративными и т.д. опциональными расширениями; возможны также расширения, содержащие контрольные вопросы по прочитанному.

Расширяемое эссе первоначально выглядит как расположенный на экране довольно короткий текст, который дает первое представление о предмете. Если содержание какого-то абзаца этого текста вызывает интерес и если при этом абзац помечен на полях знаком расширения того или иного типа, то абзац можно расширить. Полученный расширенный вариант сам может допускать расширения и т.д. От любого выполненного расширения можно отказаться и вернуться к предыдущему варианту текста. Итоговый вариант можно распечатать.

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

Используются следующие расширения и их знаки:

    +   - сказать подробнее,

    :     - привести пример,

  [   ]   - указать, где об этом можно прочесть,

    T   - задать контрольный вопрос с проверкой ответа.

  ←   - скрыть ранее сделанное расширение.

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

Знаку T соответствует особый вид расширения. Предполагается прием и проверка ответа читателя на заданный контрольный вопрос.

Как только какое-то расширение раскрыто, его знак на полях абзаца сразу заменяется знаком свертывания расширения ←, что позволяет при желании вернуться к нерасширенному абзацу. Если расширение раскрывалось автоматически в следствие подчиненности расширений, знак свертывания имеет несколько другой вид: ⇐. Здесь необходима оговорка: свертывание головного расширения блокируется, пока остается раскрытым хотя бы одно подчиненное ему расширение (это поведение можно увидеть на примере этого и предыдущего расширения). Так сделано для того, чтобы видимый текст был в любой момент полноценным эссе.

С.А.Абрамов, Е.А.Бордаченкова, Д.Е.Хмельнов. "Расширяемое эссе как схема гипертекстового информационного и учебного материала" (Журнал вычислительной математики, принято к печати)

В основу реализации расширяемого эссе нами положена технология XML, позволяющая создавать структурированные данные в текстовом формате, при этом структура задается с помощью специальных текстовых пометок - тегов. Как правило, элемент данных оформляется с помощью открывающего и закрывающего тега, а текст между этими тегами определяет содержание элемента. Открывающий тег представляется в виде <name>, а закрывающий тег - в виде </name>, где name - имя тега, которое определяет семантику элемента данных. Некоторые элементы данных не требуют содержимого (например, элемент, задающий отступ перед последующим текстом), в этом случае открывающий и закрывающий тег соединяются в один, и тег имеет вид <name/>.

Элементы данных могут иметь дополнительные атрибуты, которые могут уточнять семантику данных. Атрибут добавляется к открывающему тегу в виде пары имя атрибута и его значение, например <name atr="value">, что означает, что у элемента данных, задаваемого тегом name имеется дополнительный атрибут atr, значение которого равно строке "value".

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

Нами подготовлен XSL-файл, который преобразует XML-файл эссе в HTML-файл, этот последний затем может быть открыт любым современным браузером (например, Internet Explorer, Safari или Chrome).

Отметим, что большинство современных браузеров выполняют преобразование XML с помощью XSL самостоятельно, поскольку имеют в своем составе соответствующий модуль. Благодаря этому файл XML можно открывать прямо таким бразузером, при условии, что файл XSL также доступен браузеру (отметим, что в случае получения запроса о необходимости разрешить активное содержание и/или скрипты надо дать такое разрешение).

Из наиболее распространенных современных браузеров особенностью обладает Chrome - он работает корректно только с файлами XML и XSL, расположенными на сервере, а файлы расположенные локально на компьютере, он не обрабатывает. В случае использования этого браузера преобразование из XML в HTML надо сделать явно с помощью отдельной программы (например, свободно распространяемой программы Microsoft XML Notepad 2007) и открывать браузером уже заранее сформированный и сохраненный HTML файл.

Из наиболее распространенных современных браузеров особенностью обладает Chrome - он работает корректно только с файлами XML и XSL, расположенными на сервере, а файлы, расположенные локально на компьютере, он не обрабатывает. В случае использования этого браузера преобразование из XML в HTML надо сделать явно с помощью отдельной программы (например, свободно распространяемой программы Microsoft XML Notepad 2007) и открывать браузером уже заранее сформированный и сохраненный HTML файл.

Microsoft XML Notepad 2007 можно установить, загрузив дистрибутив с сайта Microsoft: http://www.microsoft.com/en-us/download/details.aspx?id=7973

Результирующий HTML-файл содержит необходимые элементы, обеспечивающие раскрытие и свертывание расширений, в том числе подчиненных, показ контрольных вопросов и проверку правильности выбранных ответов. Для реализации этой механики в HTML встраиваются специальные процедуры на языке JavaScript, а также вызовы этих процедур в ответ на действия пользователя с элементами управления в эссе.

Внутри каждого элемента Paragraph может присутствовать элемент Basic, содержимое которого задает основной текст данного абзаца, и дополнительно может присутствовать элемент Extension, его содержимое задает расширение данного абзаца. С помощью атрибута type элемента Extension определяется тип расширения: “More”, “Cite” и “Example” для расширений с дополнительной информацией, библиографической ссылкой или примером соответственно.

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

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

Например: <Paragraph>      <Basic>           Базовый текст.      </Basic>      <Extension type="More">           <Paragraph>                <Basic>                     Базовый текст.И текст расширения.                </Basic>           </Paragraph>      </Extension> </Paragraph>

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

Также отметим, что возможна ситуация, когда внутри элемента Paragraph нет элемента Basic, а есть только элемент Extension. Например, с помощью такого варианта можно оформить опциональную ссылку на литературу, относящуюся ко всей части (пункту) эссе, а не к конкретному абзацу. Для этого последний элемент Paragraph в этой части эссе будет иметь вид: <Paragraph>      <Extension type="Cite">           <Paragraph>                <Basic>                     См. И.И.Иванов. "Ивановы". Издательство "Иван", Иваново, 2012.                </Basic>           </Paragraph>      </Extension> </Paragraph>

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

Пример одного из самых маленьких эссе из одной части с одним абзацем и одним его расширением приведен ниже (обратите внимание на первые две строки, которые необходимы для правильного оформления XML файла и ссылки на XSL файл преобразования EssExt.xsl):

<?xml version="1.0"?>

<?xml-stylesheet type="text/xsl" href="EssExt.xsl"?>

<Essay>

     <Title>

          Простое эссе.

     </Title>

     <Part>

          <Number>

               1

          </Number>

          <Paragraph>

               <Basic>

                    Базовый текст.

               </Basic>

               <Extension type="More">

                    <Paragraph>

                         <Basic>

                              Базовый текст.И текст расширения.

                         </Basic>

                    </Paragraph>

               </Extension>

          </Paragraph>

     </Part>

</Essay>

Внутри элемента Task должен быть элемент Question (формулировка контрольного вопроса), элемент Options (с помощью набора элементов Option задаются варианты ответов на вопрос), элемент Answer (порядковый номер правильного варианта ответа среди вариантов внутри элемента Options), и элемент Comment (пояснение к правильному ответу).

Пример записи простой задачи с помощью описанной структуры элементов:

<Task>

     <Question>

          Сколько будет дважды два?

     </Question>

     <Options>

          <Option>

               Четыре

          </Option>

          <Option>

               Двадцать два

          </Option>

     </Options>

     <Answer>

          1

     </Answer>

     <Comment>

          Дважды два это два раза по два, то есть два плюс два, а это четыре.

     </Comment>

</Task>

Для реализации подчиненности расширений (текст подчиненного расширения требует раскрытия соответствующего головного расширения, поскольку использует представленную в нем информацию) привлекается механизм меток. Абзац, расширение которого может повлечь расширение другого абзаца, снабжается меткой, для этого в соответствующий элемент Paragraph добавляется атрибут label, значение которого будет использоваться при указании подчиненности. Например,

<Paragraph label="10.1">

задает абзацу метку "10.1".

Метка абзаца используется в подчиненном расширении - для этого элемент Extension получает дополнительный атрибут linked со значением, соответствующим метке того абзаца, расширение которого должно быть раскрыто вместе с данным подчиненным расширением. Например, в случае зависимости от расширения абзаца, метка которого была приведена в примере выше:

<Extension type="Example" linked="10.1">

Обратите внимание, что данное расширение является зависимым от расширения первого абзаца этого пункта эссе, и если это расширение первого абзаца не было раскрыто ранее, то оно раскрывается при раскрытии этого расширения.

Помимо расширений абзацев, подчиненность может распространяться и на контрольные вопросы, если, например, формулировка вопроса или комментарий к правильному ответу использует информацию, которая представлена только в некотором расширении. Для этого случая предусмотрено, что элемент Task может приобретать дополнительный атрибут linked со значением, соответствующим метке абзаца, расширение которого должно быть раскрыто при выборе данного контрольного вопроса. Например, в случае зависимости от расширения абзаца, метка которого была приведена в примере выше:

<Task linked="10.1">

Обратите внимание, что данное расширение является зависимым от расширения первого абзаца этого пункта эссе, и если это расширение первого абзаца не было раскрыто ранее, то оно раскрывается при раскрытии этого расширения.

Расширение, головное по отношению к некоторому другому расширению, само может быть подчиненным по отношению к какому-то расширению. В этом случае будут раскрываться все подчиненные расширения по цепочке. Также может оказаться, что некоторое головное расширение является вложенным. В этом случае будут раскрываться и объемлющие расширения.

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

em - указывает, что текст должен быть выделен курсивом.

Например,

Часть текста <em>выделена курсивом</em>

дает следующий результат:

Часть текста выделена курсивом

bf - указывает, что текст должен быть выделен жирным шрифтом.

Например,

Часть текста <bf>выделена жирным шрифтом</bf>

дает следующий результат:

Часть текста выделена жирным шрифтом

p - указывает, что текст должен начинаться с новой строки.

Например,

<p>Строка 1.</p> <p>Строка 2.</p>

дает следующий результат:

Строка 1.

Строка 2.

center - указывает, что текст должен располагаться по центру.

Например,

<center>Центрированный текст</center>

дает следующий результат:

Центрированный текст

indent - указывает, что перед текстом должен быть сделан отступ (несколько таких тегов подряд задают двойной, тройной и т.д. отступ);.

Например,

<indent />Текст с отступом

<indent /><indent />Текст с двойным отступом

дает следующий результат:

     Текст с отступом

          Текст с двойным отступом

img позволяет вставить в текст изображение, расположенное в файле по за- данному в атрибуте src адресу; в частности таким образом можно вставлять в текст изображения сложных формул, которые не записываются простым текстом (для этого изображения формул должны быть подготовлены заранее).

Пусть файлы essay_picture_1.png и essay_picture_2.png должны располагаться в той же папке (директории), что и файл XML, который их использует, либо значение атрибута должно включать не только имя файла, но и путь к файлу. Первый пример

<center><img src="EssayOnEssay_files/essay_picture_1.png" /></center>

дает следующий результат:

Второй пример

Формула может вставляться в текст в виде изображения: <img src="EssayOnEssay_files/essay_picture_2.png" />.

дает следующий результат:

Формула может вставляться в текст в виде изображения: .

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

Самая свежая версия этого документа в формате XML и HTML, также как и самая свежая версия преобразующего XSL-файла ExtEss.xsl, доступны по адресу:

http://www.ccas.ru/ca/essay/

Также по этому адресу доступно расширяемое эссе “Cложность алгоритмов”.