Система и способ формирования справки

Иллюстрации

Показать все

Изобретение относится к вычислительной технике, к устройствам и способам обработки данных, а более конкретно к системам и способам формирования справки, и может быть использовано для формирования справки в компьютерных приложениях. Техническим результатом является уменьшение трудоемкости и увеличение быстродействия при формировании справки. Заявленные система и способ позволяют скрывать или показывать содержимое страницы справки, изменять представление этого содержимого (например, текст заменить гиперссылкой на другую страницу с описанием), а также переносить это содержимое на любую страницу справки файла справки без изменения страниц справки и повторной сборки файла справки. В способе за основу берется конфигурационный файл приложения, в котором отражена структура и параметры настройки приложения, необходимые для отражения в файле справки. Таким образом, изменение всего одного файла конфигурации автоматически приводит к изменению любого файла справки для данного приложения. 2 н.и 8 з.п. ф-лы, 3 ил.

Реферат

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

Страницы справки, в том числе в формате HTML (CHM файлы), в настоящее время широко используются в приложениях операционных систем (ОС), в том числе ОС Windows. Основные преимущества таких страниц справки заключаются в следующем: широкие графические возможности, просмотр HTML документов, которые знакомы большинству пользователей, удобное разделение текста на части по тематикам, поддержка перекрестных ссылок, возможность встраивания небольших программ (Java Script, Visual Basic Script и т.д.), доступность средств улучшения, что упрощает улучшение HTML документов и построение CHM файлов.

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

Файл справки Windows представляет собой набор страниц справки в формате HTML

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

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

Известны некоторые решения данной проблемы, в частности техническое решение, изложенное в опубликованной заявке KR №2004-61421[1], которое предлагает способ и систему формирования файла справки ("help file") на основе полевых значений заданного параметра. При этом основным недостатком такого решения является то, что оно не обладает достаточной оперативностью, т.е. достаточной скоростью выполнения задач, позволяющей в режиме реального времени формировать справку в отношении произвольно заданного широкого круга вопросов.

Наиболее близкими к заявленному изобретению являются способ и устройство формирования справки, описанные в выложенной заявке на патент США №20050125729 [2], в которых записывают конфигурационные данные в отдельный файл настройки и формируют по этим конфигурационным данным внешнего представления информации файл справки в виде кода HTML путем сокрытия или отображения части данных. Данные система и способ выбраны в качестве прототипа заявленного изобретения.

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

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

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

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

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

- компилированный файл справки выполнен с возможностью активации страницы справки;

- страница справки выполнена с возможностью активации средства формирования справки;

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

Для функционирования системы важно, чтобы внешний конфигурационный файл был выполнен в формате XML.

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

Для функционирования системы важно, чтобы элемент управления был выполнен в виде ActiveX-объекта MSXML.

Для функционирования системы важно, чтобы внутренний конфигурационный файл был выполнен в формате XSLT.

Для функционирования системы важно, чтобы страница справки была выполнена в формате HTML.

Поставленная задача решена также путем создания способа формирования справки, в котором при поступлении запроса о предоставлении справки

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

- активируют с помощью компилированного файла справки страницу справки;

- активируют с помощью страницы справки средство формирования справки;

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

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

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

- записывают с помощью средства формирования справки в код страницы справки полученный результат преобразования;

- отображают страницу справки.

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

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

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

Для лучшего понимания заявленного изобретения далее приводится его подробное описание с соответствующими чертежами.

Фиг.1. Схема системы и пошагового выполнения способа формирования справки, выполненные согласно изобретению.

Фиг.2. Схема примера использования способа формирования справки, выполненная согласно изобретению.

Фиг.3. Схема примера использования способа формирования справки, выполненная согласно изобретению.

Рассмотрим функционирование заявленных системы и способа формирования справки для приложения операционной системы Windows (Фиг.1-3).

Система формирования справки содержит соединенные между собой внешний конфигурационный файл 1, компьютерное приложение 2 и компилированный файл 3 справки, который содержит, по меньшей мере, одну страницу 4 справки, по меньшей мере, один внутренний конфигурационный файл 5, а также средство 6 формирования справки.

Причем внешний конфигурационный файл 1 выполнен в формате XML, страница 4 справки выполнена в формате HTML, конфигурационный файл 3 справки выполнен в формате XSLT и средство 6 формирования справки выполнено в виде программы JavaScript.

Способ формирования справки для описанной выше системы работает следующим образом (Фиг.1-3). При поступлении запроса о предоставлении справки активируют с помощью компьютерного приложения 2 компилированный файл 3 справки и записывают в него среди параметров командной строки путь к внешнему конфигурационному файлу 1 XML, в котором отражена структура и параметры настройки приложения, необходимые для отражения запрашиваемой информации в странице справки (шаг 1). Активируют с помощью компилированного файла 3 справки страницу 4 справки (шаг 2). Активируют с помощью страницы 4 справки средство 6 формирования справки, выполненное в виде программы JavaScript (шаг 3). С помощью средства 6 формирования справки (программы JavaScript) создают первый элемент управления в виде ActiveX-объекта MSXML и загружают в него внешний конфигурационный файл 1 XML, находящийся по указанному пути (шаг 4), а также создают еще один, второй элемент управления в виде ActiveX-объекта MSXML и загружают в него внутренний конфигурационный файл 5 XSLT, который содержит схемы преобразования страницы 4 справки и находится внутри компилированного файла 3 справки (шаг 5). Активируют с помощью средства 6 формирования справки (программы JavaScript) функцию первого элемента управления (ActiveX-объект MSXML) (шаг 6), в который загружен конфигурационный файл 1 XML, отвечающий за преобразование форматов (XML в HTML), и передают в эту функцию второй элемент управления (ActiveX-объект MSXML), в который загружен внутренний конфигурационный файл 5 XSLT. Производят преобразование с помощью функции первого элемента управления. Записывают с помощью средства 6 формирования справки (программы JavaScript) в код HTML страницы 4 справки полученный результат преобразования (шаг 7). Отображают страницу 4 справки (шаг 8).

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

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

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

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

2. Система по п.1, отличающаяся тем, что внешний конфигурационный файл выполнен в формате XML.

3. Система по п.1, отличающаяся тем, что средство формирования справки выполнено в виде программы JavaScript.

4. Система по п.1, отличающаяся тем, что элемент управления выполнен в виде ActiveX-объекта MSXML.

5. Система по п.1, отличающаяся тем, что внутренний конфигурационный файл выполнен в формате XSLT.

6. Система по п.1, отличающаяся тем, что страница справки выполнена в формате HTML.

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

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

9. Способ по п.7, отличающийся тем, что записывают в код страницы справки полученный результат преобразования с помощью метода write объекта document.

10. Способ по п.7, отличающийся тем, что записывают в код страницы справки полученный результат преобразования путем непосредственно записи кода в предопределенный элемент страницы справки.