Как составить справочную систему

Каждый
приличный программный продукт должен
иметь справочную систему, которая дает
возможность пользователям понять как
работает и какие возможности имеет
определенная программа. Справочная
система или просто справка может быть
разработана в двух форматах: .hlp и
.chm. Данные форматы созданы компанией
Microsoft. Формат .hlp уже не является актуальным,
но все равно иногда встречается. В
настоящее время большей популярностью
пользуется формат .chm [30].

Справка,
которая имеет формат .chm, представляет
собой набор веб-страниц, написанных с
помощью языка HTML. Такая справка может
содержать помимо текста, также таблицы,
рисунки и ссылки.

Перед
тем, как начинать разрабатывать
CHM-справку, необходимо скачать программу,
которая называется HTML Help Workshop. Данная
программа распространяется бесплатно
и ее можно найти на официальном сайте
компании Microsoft. С помощью возможностей
программы HTML Help Workshop набор HTML-файлов, в
которых содержится справочный материал,
компилируется в итоговую CHM-справку
[30].

Сама
по себе CHM-справка очень похожа на
электронную книгу, которая имеет
различные интерактивные возможности,
например, гиперссылки, поиск. CHM-справка
содержит в себе дерево каталогов, которое
является также и содержанием, список
идентификаторов тем и функцию поиска
по всему содержанию справки
[30].

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

– спроектировать
общую структуру справки, то есть
определить темы, которые будут содержаться
в справке;

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

– текстовые
файлы со справочным материалом следует
преобразовать в файлы формата .html; чтобы
конвертировать текстовый файл в HTML-файл
необходимо, во-первых, открыть программу
Microsoft Word 2010 или выше, во-вторых, в диалоговом
окне сохранения файла в выпадающем
списке типов файлов выбрать строчку с
надписью «Документ HTML»;

– запустить
программу HTML Help Workshop, создать новый
проект справки и добавить в него
HTML-файлы со справочным материалом
[30].

После
открытия программы HTML Help Workshop необходимо
создать проект. Делается это следующим
образом: в главном меню нужно выбрать
«File», а затем «New»; откроется окно создания
различных объектов; выделить строчку
с надписью «Project»; нажать кнопку «OK». В
итоге создастся файл проекта, который
будет иметь расширение .hhp. Окно создания
новых объектов представлено на рисунке
3.6.

Рисунок
3.6 – Окно создания нового объекта в HTML
Help Workshop

Помимо
нового проекта в окне создания можно
выбрать следующие объекты, которые
являются элементами единой справки:

– «Text» – обычный
текстовый файл;

– «HTML
File» – веб-страница с базовой
разметкой;

– «Table
of Contents» – файл, в котором находится
содержание справки;

– «Index» – файл
с указателями на темы справочного
материала
[30].

После
того, как был создан главный файл проекта
нужно создать файл содержания справки,
для этого нужно создать объект «Table
of Contents».
Окно, в котором создается дерево каталогов
или содержание справки, продемонстрировано
на рисунке 3.7.

Рисунок
3.7 – Окно создания содержания в HTML
Help Workshop

После
создания файла с содержанием справки,
который имеет расширение .hhc,
необходимо создать объект «Index»,
который содержит список идентификаторов
тем. Данный файл будет иметь расширение
.hhk
[30]. Окно,
в котором создаются идентификаторы тем
справочного материала, представлено
на рисунке 3.8.

Рисунок
3.8 – Окно создания индекса тем в HTML
Help Workshop

Как
только созданы основные объекты справки
необходимо перейти к настройке CHM-файла.
Завершим настройку CHM-файла, нужно
сохранить проект при помощи меню, в
котором нужно выбрать «File» и «Save Project».

Последним
шагом в процессе создания справочной
системы будет компиляция CHM-файла.
Для этого необходимо в главном меню
выбрать «File», а после «Compile». Если до
этого момента все было сделано верно,
то на экране появится отчет об успешно
выполненной компиляции.

Наконец
необходимо подключить CHM-справку
к программному продукту. Для начала
следует файл справки поместить в папку
с программой. Затем нужно создать новый
TMenuItem,
у которого в событии OnClick
прописать следующий код: shellexecute
(handle,
‘open’, ‘help.chm’,
nil, nil, sw_shownormal).
В завершении
всего нужно прописать функцию SHELLAPI
в разделе
USES. Это
нужно для того, чтобы функция shellexecute
работала.

Создание справочной системы. Часть 1

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

• Руководства по системе. Такое руководство можно представлять, как совокупность книг, каждая из которых содержит разделы и, возможно, вложенные книги. Раздел является терминальным элементом справочного руководства и описывает ту или иную конкретную тему. Содержательная сторона создания таких разделов остается за разработчиком системы. Инструментальные средства позволяют не только помочь в создании отдельных разделов, но и позволяют объединить все разделы в едином справочном руководстве, обладающем широкими возможностями поиска нужной темы. Можно предусмотреть возможность поиска темы по содержанию, по индексу, можно включить полномасштабный текстовый поиск, можно создать папку “Избранное”, хранящую часто используемые разделы. Наконец, при некоторой дополнительной работе можно использовать возможности Answer Wizard, для того чтобы использовать Office Assistant и формулировать запрос на поиск в справочной системе на естественном языке, как это делается в самом Office 2000.
• Справочной системы по интерфейсу. С каждым элементом интерфейса может быть связан соответствующий раздел справки. Например, для всех элементов управления, появляющихся в разнообразных формах и предназначенных для организации взаимодействия с пользователем системы, желательно иметь возможность получать справку о назначении и особенностях работы этого элемента управления. Это вид справки называют справкой “Что это такое?” (What’s This Help).
• Справочная система программного проекта. Программный проект является неотъемлемой частью сложных офисных решений. Поэтому не менее важно иметь хорошую справку и по этой части системы. Это означает создание справки по свойствам и методам объектов для классов, созданных программистом. Необходимость в выдаче справки возникает и при выполнении некоторых функций, например, InputBox, в диалоговом окне которых предусмотрена специальная кнопка Help. Справку, поясняющую ситуацию, следует выдавать при возникновении исключительных ситуаций, возбуждаемых методом Raise, при работе объекта Err и в других случаях.
• Всплывающие подсказки. Особо выделим еще один вид справок – всплывающие подсказки (pop up help).

Таким образом, можно видеть, что справочная подсистема многообразна и создание ее дело совсем не простое. Тем не менее, попробуем во всем этом разобраться и начнем с создания руководства по системе.

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

Как создать руководство по системе?

Инструментальная поддержка создания справочного руководства была предусмотрена еще в предыдущей версии Office 97 и позволяла построить систему Windows Help файлов, имеющих уточнение “.hlp”. Специальный инструментарий WinHelp позволял строить такие файлы. В Office 2000 произошло серьезное изменение принципов построения справочной системы. Это касается как собственной справочной системы Office 2000, так и инструментария, создающего справочную систему для офисных решений. Эти изменения отражают общую тенденцию работы с офисными документами – миграцию в Интернет и переход к хранению документов, в том числе и справочного руководства в формате HTML.

Инструментарий Microsoft HTML Help – новое поколение авторизованных справочных систем позволяет построить справочное руководство, страницы которого обладают всеми возможностями Web-страниц. Такое руководство по системе офисных документов, разработанных программистом, может быть частью этой системы и поставляться вместе с ней, также как система справки по Office 2000 является частью этой системы. Есть и другая возможность, – развернуть справочное руководство на Web-узле корпоративной сети.

Разделы справочного руководства создаются как отдельные HTML – файлы и могут быть созданы в любом Редакторе, позволяющем работать с таким форматом, например, в Word или FrontPage. Подобный Редактор входит и в состав специального инструментального средства, используемого для создания справочных руководств, – HTML Help Workshop (HHW). Нам еще предстоит подробное рассмотрение этого инструмента. Для отображения (просмотра) справочного руководства используется специальный HTML Help Viewer, который в своей работе использует стандартные средства Web-браузера (Internet Explorer). Благодаря новому подходу расширяются стандартные возможности описания раздела справки. Разделы справки теперь могут содержать все элементы, присущие Web-страницам – гиперссылки, script-код, DHTML, элементы ActiveX, графические элементы, аудио и видео.

Перечислим инструментальные средства, составляющие Microsoft HTML Help и используемые при создании справочного руководства:

• HTML Help Workshop (hhw.exe) – средство, позволяющее создавать как отдельные файлы, являющиеся частями справочной системы, так и объединять все части в единое целое – законченную справочную систему. Элементы справочной системы, как правило, хранятся в отдельных файлах и могут быть разного типа. К ним относятся HTML – файлы с разделами справочной системы, файл с таблицей содержания, файл с индексами, файлы с рисунками и другими мультимедийными элементами, вспомогательные файлы, наконец, файл проекта, хранящий всю информацию о частях справочной системы. Если говорить о том, в каком виде создается справочное руководство, то здесь есть две основные возможности. Инструмент HHW позволяет скомпилировать справочную систему в виде единого файла (.chm), подобно компилируемому Windows Help файлу (.hlp). Другая возможность состоит в создании специального Web-узла справки.
• HTML Help ActiveX (HHCtrl.ocx) – элемент управления, организующий навигацию по справочной системе и поддерживающий функциональность вторичных окон. Одним из методов этого элемента является функция HtmHelp, реализующая многие из возможностей этого элемента. Эту функцию, как функцию API в ряде случаев приходится вызывать в программном коде lдля организации выдачи контекстных справок. Подробно эти вопросы будут рассмотрены в следующей лекции.
• HTML Help Java applet (HHCtrl.class) – альтернативный элемент управления, используемый вместо предыдущего элемента ActiveX, когда предпочтение отдается языку Java.
• Microsoft HTML Help Image Editor (Flash.exe) – средство, позволяющее выполнять различные операции с графикой.
• HTML Help Viewer – уже упоминавшееся средство, предназначенное для отображения справочной системы со всеми многочисленными возможностями доступа к ней.
• HTML Help compiler – компилятор, позволяющий справочное руководство, состоящее из различных файлов, скомпилировать в один специальный файл с уточнением “.chm”, сжав, при этом, используемую информацию. Более того, компилятор способен выполнять и обратную операцию, позволяя декомпилировать chm-файл и получить файлы, хранящие отдельные элементы справочной системы.
• HTML Help executable program – программа, предназначенная для запуска и выполнения справочного руководства. Получив справочное руководство в виде специального скомпилированного файла, необходимо, конечно, иметь и программу, которая может выполнить этот файл.

Содержание:

ВВЕДЕНИЕ

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

В настоящее время на рынке представлено великое множество программных средств и обучающих приложений, а также справочных средств, предназначенных для изучения языков программирования. На текущий момент одним из распространенных языков программирования до сих пор является язык программирования С++.

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

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

Темой курсовой работы было «Разработать справочную систему по стандартным функциям выбранного языка программирования».

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

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

Стояли задачи:

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

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

В первом разделе дана характеристика справочного руководства и его форматов, обоснована необходимость решения задачи, выполнен анализ существующих программных средств для её создания, выбран язык программирования и определенны набор стандартных функций. [4], [5], [7].

Во втором разделе выполнена постановка задачи на разработку нового продукта (справки), описана организация решения, представлен проект и программная разработка задач, выполнена оценка качества программы [4], [6], [8].

Оформление отчета в текстовом редакторе согласно требованиям стандартов и ГОСТ Р 7.0.5-2008 (Библиографическая ссылка); ГОСТ 7.32-2001 в ред. Изменения №1 от 01.12.2005, ИУС №12, 2005 (Отчет о научно-исследовательской работе); ГОСТ 7.1-2003 (Библиографическая запись. Библиографическое описание. Общие требования и правила составления)[1],[2],[3].

1 ПОНЯТИЕ СПРАВОЧНОЙ СИСТЕМЫ

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

Одним из примеров справочной системы является справка программного продукта: для платформы MS Windows это HTMLHelp, для Unix-подобных операционных системах это man и ряд других описанных далее.

Другой тип справочных — это вопросно-ответные системы, дающие один краткий ответ на поставленный вопрос. Примером может служить электронный телефонный справочник.

Основная задача справочной системы – это предоставление необходимой информации в удобной для использования форме.

Справки можно создавать вручную или использовать для этого специализированные программы.

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

Еще более простой способ создания справок – применить программы, специально для этого предназначенные. В этом случае не нужно знать html, css, javascript – работа во всех спецпрограммах по созданию справок ведется в визуальном режиме, и программа сама создает исходный код. Некоторые программы позволяют добавлять к справке эффекты, используя jQuery (например – создается справка с временно исчезающим оглавлением, чтобы освободить место на экране компьютера).

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

• 1. Разновидности форматов

Справки могут создаваться в нескольких форматах, из которых наиболее распространены форматы CHM, Web Help и HTML.

– CHM (Compiled HTML Help) или HTML Help, или Windows CHM – формат Microsoft. Чаще всего формат используется, чтобы создать справки для программ (так называемые контекстные справки), работающих в системах Windows. Формат CHM позволяет объединить несколько отдельных файлов в один файл. Справка используется без подключения к Интернету [4].

Рисунок 1 – Справка формата СНМ

– Web Help или Browser-based Help – формат справки, которая размещается в Интернете  (на сайте). Как уже понятно из названия, для того чтобы можно было пользоваться справкой, нужно подключение к Интернету.

Рисунок 2 – Справка формата Web Help

– HTML – Справка формата HTML может располагаться на Вашем сайте, и пользователи могут ее рассмотреть через свой браузер. При создании справки использованы фреймовая структура, html, css и нет javascript. Оглавление представляет из себя обычный (не раскрывающийся) список, нет поиска, списка индексированных слов и избранного.

Рисунок 3 – Справка формата HTML

Также применяются и другие форматы справок – PDF, в формате документов Word, e-Book, JavaHelp и другие.

Рисунок 4 – Справка формата PDF

Рисунок 5 – Справка формата JavaHelp

Рисунок 6 – Справка формата e-Book

При необходимости можно преобразовать один формат справки в другой, например преобразовать формат CHM к формату Microsoft Word (или наоборот).

• 1. Программное обеспечение создания справки

На текущий момент существует огромное количество программных средств позволяющих создавать справочные системы:

– HelpNDoc;

– Devesar Book Editor;

– CHM Editor;

– HelpScribble;

– HelpCruiser;

– OneClickHelp;

– PowerCHM;

– CHM Builder;

– HtmlInRes;

– Syntext Serna Free;

– DRExplain.

Рассмотрим более детально и обоснуем выбор программного средства для создания справочного руководства [5].

Приложение HelpNDoc – использует форматы CHM, HTML, PDF или совместимых с Word.

Присутствует интерактивная проверка орфографии, возможность визуального редактирования, генерация кода для различных языков программирования (C/C++, Delphi/Pascal, Fortran 90/95, Power Basic и Visual Basic), поддержка шаблонов и многое другое.

Работает на операционной системе Windows 10-Vista, программа бесплатная.

Рисунок 7- Рабочее окно приложения HelpNDoc

Приложение Devesar Book Editor – система управления содержанием документа. В ней присутствует:

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

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

– Быстрая вставка графических файлов популярных форматов (png, jpg, gif, bmp, tif), спецсимволов, разделительных линий и др. объектов.

-Вставка ссылок и закладок для удобной навигации по разделам вашего проекта и внешним интернет-ресурсам.

-Продуманный, современный «ленточный» интерфейс, аналогичный интерфейсу программ Microsoft Office.

-Экспорт готовых документов в форматы CHM и DOCX (список доступных форматов будет пополняться) одной кнопкой и др.

Работает на операционной системе Windows 10-Vista. Программа условно-бесплатная с ограничением на 30 дней.

Рисунок 8 – Рабочее окно приложения Devesar Book Editor

Приложение CHM Editor -может создавать или редактировать уже созданные документы, изменять форматирование, вставлять рисунки, ссылки, а также есть возможность переводить документы. При необходимости перевод может осуществляться при помощи интернет-сервисов, с которыми работает программа.

Размер файла меньше, чем у обычного HTML – автоматическое сжатие (архивирование) содержимого при компиляции chm. Используются все возможности форматирования доступные для Web-страниц (все возможности, имеющиеся в HTML и CSS). Возможность создать вкладку «Избранное» (пользователь сможет делать «закладки», запоминать актуально значимые для него страницы справки, чтобы потом в одно мгновение находить их). Возможность создать «Указатель» (список ключевых слов, которые вы можете назначить для разных разделов справки). Возможность просмотра множества .chm-файлов как один, с общим содержанием и предметным указателем. Она поддерживает операционную систему Windows 10-XP, программа условно-бесплатная.

Рисунок 9 – Рабочее окно приложения CHM Editor

Приложение HelpScribble – может делать WinHelp (.hlp) файлы, HTML Help (.chm) файлы, руководства и онлайн документацию. Программа может использовать HPJ и RTF файлы созданные другой утилитой. Приложение не является надстройкой над MS Word. Программа может создать: WinHelp, HTML Help, WebHelp и печатную документацию. Она поддерживает операционную систему Windows 10-2000, программа условно-бесплатная.

Рисунок 10 – Рабочее окно приложения HelpScribble

Приложение HelpCruiser – работает с форматами: HTML, CHM, PDF, RTF и XML, а также графическими файлами в формате JPEG и PNG, также можно настроить такие параметры как: степень компрессии, метод деинтерлейсинга, цвет прозрачности, градации серого и некоторые другие. Для каждого раздела создаваемого документа можно задать и набор ключевых слов. Программа дает и возможность использования внутренних ссылок, ведущих в тот или иной раздел создаваемого документа, и внешних ссылок, связывающих документ с другими текстами, программами или URL. Есть возможность защитить документ как от изменения, так и от изменения содержимого. Работает на операционной системе Windows 7-2000, программа условно-бесплатная.

Рисунок 11- Рабочее окно приложения HelpCruiser

OneClickHelp – программа может создавать различные справочные материалы и электронные книги посредством конвертирования документов подготовленных при помощи MS Word в форматы Chm, Aspx, HxS, Web, Html с сохранением исходного форматирования. Кроме того присутствует возможность добавления таких дополнительных элементов, как колонтитулы, навигацию, раскрывающиеся пункты, слайд-шоу и прочее.

Ключевые особенности OneClickHelp:

-Преобразование doc файлов в форматы Chm Html, Aspx, hxs.

-Конвертирование Chm в doc.

-Преобразование содержимого папок в справку (dir в Help, Chm, Aspx, HxS, Web).

-Создание коллекций справок.

-Декомпиляция справки.

Рисунок 12 – Рабочее окно приложения OneClikHelp

PowerCHM – программа может создать файлы справки в формате .chm из форматов .doc, .pdf, .txt, .htm, .html и .mht. Есть возможность декомпиляции ранее созданного .chm файла на составные части. Может автоматически генерировать заголовок по заголовку или названию файла.

Рисунок 13 – Рабочее окно приложения PowerCHM

CHM Builder – программа предназначена для создания CHM-файлов (компилированных HTML-документов). Содержит в себе все файлы предназначенные для создания CHM-файлов поэтому для работы не требуется устанавливать специальные библиотеки и модули.

Рисунок 14 – Рабочее окно приложения CHM Builder

HtmlInRes – утилита не требует установки, предназначена для создания ресурсных файлов (*.RES) из набора HTML и других типов файлов. При обработке HTML-файлов заменяются все ссылки для внутренних переходов.

Рисунок 15.-. Рабочее окно приложения HtmlInRes

Syntext Serna Free – XML редактор который может создать документы таких форматов как техническая документация, руководства пользователя, статьи, книги, листинги программ и т.п.

Рисунок 16 – Рабочее окно приложения Syntext Serna Free

DRExplain – программа может создать документы таких форматов как: HTML, CHM, RTF, RDF.

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

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

Функциональные возможности:

-Возможность экспорта проекта в основные форматы справочной документации;

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

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

-Также можно указать статус для раздела документации. Всего существует четыре статуса:

-Не начато – активен по умолчанию, ничем не выделяется;

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

-Закончено – выделяется зелёным цветом, для выделения уже законченных разделов документации;

-Ожидается – выделяется красным цветом, для выделения тех разделов, которые планируется редактировать.

-Очень легко можно поменять название темы и получаемого при экспорте файла, настройки экспорта и статус. Для этого достаточно в левой нижней части главного окна Dr.Explain выбрать соответствующую строку и изменить заданные параметры;

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

-Также во вкладке Инструменты можно проверить проект на ошибки, в результате чего можно выявить:

-Наличие имен файлов в темах;

-Невалидные (недействующие) ссылки;

-Непривязанные термины. Может возникнуть в том случае, если ключевое слово не привязано к какой-либо теме.

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

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

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

-Также Dr.Explain можно использовать для быстрого создания документации, а также для автоматизации этого процесса за счёт использования импорта настроек проекта. Работа над проектом завершена, но хочется использовать его настройки в будущем? Элементарно, Dr.Explain позволяет осуществить это. Для этого потребуется сделать всего три клика мышкой, и новый проект будет иметь точно такие же настройки, как и предыдущий;

-Более того, можно одновременно работать с несколькими проектами. Для этого нужно лишь расположить окна проектов рядом или каскадом, что очень легко осуществить, используя вкладку Окно;

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

-Возможность экспорта карты сайта и индекса карты сайта. Для этого достаточно нажать на вкладку Инструменты и выбрать один из пунктов, после чего появится диалоговое окно, в котором будет предложено выбрать место сохранения карты сайта или индекса карты сайта;

-Если на рабочем месте нет Adobe Reader или MS HTML Help Workshop, то, к сожалению, будет отсутствовать возможность экспорта в PDF и CHM формат соответственно. Тем не менее, не нужно разочаровываться, поскольку Dr.Explain предлагает ссылки на скачивание данных продуктов, являющихся бесплатными, с официальных сайтов.

Рисунок 17 – Рабочее окно приложения DRExplain

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

• 1. Обоснование выбора языка программирования

В мире существует огромное количество языков программирования. Они предоставляют программисту набор инструментов, с помощью которых и создаются программы. Самые популярные языки, на данный момент, это :C/C++, C#, Java, Python, Swift, Kotlin.

Рассмотрим их более детально.

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

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

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

Поскольку язык Java предназначен для использования в сетевой или распределенной среде, то вопросам его безопасности было уделено большое внимание. На данный момент язык Java позволяет создавать системы, надежно защищенные от вирусов и несанкционированного доступа.Язык Java разрабатывался как чисто объектно-ориентированный язык, в отличие от С++, объектная парадигма которого «ослабляется» возможностями, оставшимися от языка С. В Java отсутствуют такие структуры С++, как struct, union и procedure; они заменены на методы, интерфейсы и более развитые классы.Функции и процедуры в Java заменены на конструкции, называемые методами. Методы очень напоминают процедуры языка С++ за исключением того, что методы не могут быть независимыми от класса (кроме методов из интерфейсов).В Java, как и в С++, возможны множественные конструкторы, дающие программисту возможность инициализировать объект различными способами. При объявлении конструкторов существуют два основных правила: имя конструктора и название класса должны совпадать; при объявлении конструктора не указывается возвращаемый тип. Как и другие ссылочные переменные, классы создаются динамически при помощи ключевого слова new.

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

Python поддерживает структурное, объектно-ориентированное, функциональное, императивное и аспектно-ориентированное программирование. Основные архитектурные черты — динамическая типизация, автoматическое управление памятью, полная интроспекция, механизм обработки исключений, поддержка многопоточных вычислений, высокоуровневые структуры данных. Поддерживается разбиение программ на модули, которые, в свою очередь, могут объединяться в пакеты.

Python — активно развивающийся язык программирования, новые версии с добавлением/изменением языковых свойств выходят примерно раз в два с половиной года. Язык не подвергался официальной стандартизации, роль стандарта де-факто выполняет CPython, разрабатываемый под контролем автора языка.

– Язык программрования Swift — открытый мультипарадигмальный компилируемый язык программирования общего назначения. Создан компанией Apple в первую очередь для разработчиков iOS и macOS. Swift работает с фреймворками Cocoa и Cocoa Touch и совместим с основной кодовой базой Apple, написанной на Objective-C. Swift задумывался как более лёгкий для чтения и устойчивый к ошибкам программиста язык, нежели предшествовавший ему Objective-C. Программы на Swift компилируются при помощи LLVM, входящей в интегрированную среду разработки Xcode 6 и выше. Swift может использовать рантайм Objective-C, что делает возможным использование обоих языков (а также С) в рамках одной программы.

Swift заимствовал довольно многое из Objective-C, однако он определяется не указателями, а типами переменных, которые обрабатывает компилятор. По аналогичному принципу работают многие скриптовые языки. В то же время, он предоставляет разработчикам многие функции, которые прежде были доступны в C++ и Java, такие как определяемые наименования, обобщения и перегрузка операторов.

Часть функций языка выполняется быстрее по сравнению с другими языками программирования. Например, сортировка комплексных объектов выполняется в 3,9 раз быстрее, чем в Python, и почти в 1,5 раза быстрее, чем в Objective-C.

Код, написанный на Swift, может работать вместе с кодом, написанным на языках программирования C и Objective-C в рамках одного и того же проекта.

– Язык программирования Kotlin представляет статически типизированный язык программирования от компании JetBrains. Kotlin можно использовать для создания мобильных и веб-приложений.

Kotlin работает поверх виртуальной машины Java (JVM) и при компиляции компилируется в байткод. То есть, как и в случае с Java, мы можем запускать приложение на Kotlin везде, где установлена JVM. Хотя также можно компилировать код в JavaScript и запускать в браузере. И, кроме того, можно компилировать код Kotlin в нативные бинарные файлы, которые будут работать без всякой виртуальной машины. Таким образом, круг платформ, для которых можно создавать приложения на Kotlin, чрезвычайно широк – Windows, Linux, Mac OS, iOS, Android.

Первая версия языка вышла 15 февраля 2016 года. Хотя сама разработка языка велась с 2010 года. Текущей версией языка на данный момент является версия 1.2, которая вышла 28 ноября 2017 года.

Kotlin испытал влияние многих языков: Java, Scala, Groovy, C#, JavaScript, Swift и позволяет писать программы как в объектно-ориентированном, так и в функциональном стиле. Он имеет ясный и понятный синтаксис и довольно легок для обучения.

Самым популярным направлением, где применяется Kotlin, является прежде всего разработка под ОС Android. Причем настолько популярным, что компания Google на конференции Google I/O 2017 провозгласила Kotlin одним из официальных языков для разработки под Android (наряду с Java и C++), а инструменты по работе с данным языком были по умолчанию включены в функционал среды разработки Android Strudio начиная с версии 3.0.

C++ — компилируемый, статически типизированный язык программирования общего назначения.

Поддерживает такие парадигмы программирования, как процедурное программирование, объектно-ориентированное программирование, обобщённое программирование. Язык имеет богатую стандартную библиотеку, которая включает в себя распространённые контейнеры и алгоритмы, ввод-вывод, регулярные выражения, поддержку многопоточности и другие возможности. C++ сочетает свойства как высокоуровневых, так и низкоуровневых языков. В сравнении с его предшественником — языком C, — наибольшее внимание уделено поддержке объектно-ориентированного и обобщённого программирования.

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

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

Изначально, Microsoft собиралась выпустить свою версию языка Java (Microsoft Java или J++), однако им пришлось судиться с правообладателями (Sun Microsystems) из-за некоторых спорных моментов. Поэтому руководство приняло решение о необходимости создания собственного языка, который бы отвечал их требованиям и развитие которого они могли бы контролировать. Так и появился С#.

С# был разработан благодаря усилиям Андерса Хейлсберга – создателя компилятора, который лег в основу Turbo Pascal и языка программирования Delphi. Первая версия языка увидел свет в июне 2000 года (возможно, что майкрософт хотела отметить так новое тысячелетие), а окончательная версия вышла в 2002 году вместе с Visual Studio. Сейчас C# стало одним из самых популярных языков программирования, начавшим даже немного опережать своего предшественника.

Плюсы

• поддержка майкрософтом. В отличии от Java, которой не пошел на пользу переход в собственность Oracle, C# хорошо развивается благодаря усилиям Microsoft;
• в последнее время много совершенствуется. Так как C# был создан позже, чем Java и другие языки, то требовалось очень много доработать. Также это касается популяризации и бесплатности – было обещано открыть исходный код, а инструменты (Visual Studio, Xamarin) стали бесплатными для частных лиц и небольших компаний;
• много синтаксического сахара. Синтаксический сахар – это такие конструкции, которые созданы для облегчения написания и понимания кода (особенно если это код другого программиста) и не играют роли при компиляции;
• средний порог вхождения. Синтаксис похожий на C, С++ или Java облегчает переход для других программистов. Для новичков это также один из самых перспективных языков для изучения;
• Xamarin. Благодаря покупке Xamarin на C# теперь можно писать под Android и iOS. Это, несомненно, большой плюс, так как их собственная мобильная ОС (Windows Phone) не завоевала большой популярности;
• добавлено функциональное программирование (F#);
• большое сообщество программистов;
• много вакансий на должность C# программиста в любом регионе.

Минусы

• ориентированность, в основном, только на .NET (на Windows платформу);
• бесплатность только для небольших компании, учащихся и программистов-одиночек. Для больших команд покупка лицензий обойдется недешево. Поэтому если у вас есть своя фирма, то придется раскошелиться;
• сохранили оператор go to.

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

• 1. Эволюция языка программирования

Существует множество реализаций языка C++, как бесплатных, так и коммерческих и для различных платформ. Например, на платформе x86 это GCC, Visual C++, Intel C++ Compiler, Embarcadero (Borland) C++ Builder и другие. C++ оказал огромное влияние на другие языки программирования, в первую очередь на Java и C#.

Язык возник в начале 1980-х годов, когда сотрудник фирмы Bell Labs Бьёрн Страуструп придумал ряд усовершенствований к языку C под собственные нужды. Когда в конце 1970-х годов Страуструп начал работать в Bell Labs над задачами теории очередей (в приложении к моделированию телефонных вызовов), он обнаружил, что попытки применения существующих в то время языков моделирования оказываются неэффективными, а применение высокоэффективных машинных языков слишком сложно из-за их ограниченной выразительности. Так, язык Симула имеет такие возможности, которые были бы очень полезны для разработки большого программного обеспечения, но работает слишком медленно, а язык BCPL достаточно быстр, но слишком близок к языкам низкого уровня и не подходит для разработки большого программного обеспечения.

Вспомнив опыт своей диссертации, Страуструп решил дополнить язык C (преемник BCPL) возможностями, имеющимися в языке Симула. Язык C, будучи базовым языком системы UNIX, на которой работали компьютеры Bell, является быстрым, многофункциональным и переносимым. Страуструп добавил к нему возможность работы с классами и объектами. В результате практические задачи моделирования оказались доступными для решения как с точки зрения времени разработки (благодаря использованию Симула-подобных классов), так и с точки зрения времени вычислений (благодаря быстродействию C). В первую очередь в C были добавлены классы (с инкапсуляцией), наследование классов, строгая проверка типов, inline-функции и аргументы по умолчанию. Ранние версии языка, первоначально именовавшегося «C with classes» («Си с классами»), стали доступны с 1980 года.

Разрабатывая C с классами, Страуструп написал программу cfront[en] — транслятор, перерабатывающий исходный код C с классами в исходный код простого C. Это позволило работать над новым языком и использовать его на практике, применяя уже имеющуюся в UNIX инфраструктуру для разработки на C. Новый язык, неожиданно для автора, приобрёл большую популярность среди коллег и вскоре Страуструп уже не мог лично поддерживать его, отвечая на тысячи вопросов.

При создании C++ Бьёрн Страуструп хотел

• получить универсальный язык со статическими типами данных, эффективностью и переносимостью языка C;
• непосредственно и всесторонне поддерживать множество стилей программирования, в том числе процедурное программирование, абстракцию данных, объектно-ориентированное программирование и обобщённое программирование;
• дать программисту свободу выбора, даже если это даст ему возможность выбирать неправильно;
• максимально сохранить совместимость с C, тем самым делая возможным лёгкий переход от программирования на C;
• избежать разночтений между C и C++: любая конструкция, допустимая в обоих языках, должна в каждом из них обозначать одно и то же и приводить к одному и тому же поведению программы;
• избегать особенностей, которые зависят от платформы или не являются универсальными;
• «не платить за то, что не используется» — никакое языковое средство не должно приводить к снижению производительности программ, не использующих его;
• не требовать слишком усложнённой среды программирования.

Выбор именно C в качестве базы для создания нового языка программирования объясняется тем, что язык C:

– является многоцелевым, лаконичным и относительно низкоуровневым языком;

– подходит для решения большинства системных задач;

– исполняется везде и на всём;

– стыкуется со средой программирования UNIX. 

Несмотря на ряд известных недостатков языка C, Страуструп пошёл на его использование в качестве основы, так как «в C есть свои проблемы, но их имел бы и разработанный с нуля язык, а проблемы C нам известны». Кроме того, это позволило быстро получить прототип компилятора (cfront), который лишь выполнял трансляцию добавленных синтаксических элементов в оригинальный язык C.

По мере разработки C++ в него были включены другие средства, которые перекрывали возможности конструкций C, в связи с чем неоднократно поднимался вопрос об отказе от совместимости языков путём удаления устаревших конструкций. Тем не менее, совместимость была сохранена из следующих соображений: 

•  сохранение действующего кода, написанного изначально на C и прямо перенесённого в C++; 
• исключение необходимости переучивания программистов, ранее изучавших C (им требуется только изучить новые средства C++); 
• исключение путаницы между языками при их совместном использовании («если два языка используются совместно, их различия должны быть или минимальными, или настолько большими, чтобы языки было невозможно перепутать»).

К 1983 году в язык были добавлены новые возможности, такие как виртуальные функции, перегрузка функций и операторов, ссылки, константы, пользовательский контроль над управлением свободной памятью, улучшенная проверка типов и новый стиль комментариев (//). Получившийся язык уже перестал быть просто дополненной версией классического C и был переименован из C с классами в «C++». Его первый коммерческий выпуск состоялся в октябре 1985 года. 

Имя языка, получившееся в итоге, происходит от оператора унарного постфиксного инкремента C ++ (увеличение значения переменной на единицу).

До начала официальной стандартизации язык развивался в основном силами Страуструпа в ответ на запросы программистского сообщества. Функцию стандартных описаний языка выполняли написанные Страуструпом печатные работы по C++ (описание языка, справочное руководство и так далее).

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

В 1989 году состоялся выход C++ версии 2.0. Его новые возможности включали множественное наследование, абстрактные классы, статические функции-члены, функции-константы и защищённые члены. В 1990 году вышло «Комментированное справочное руководство по C++», положенное впоследствии в основу стандарта. Последние обновления включали шаблоны, исключения, пространства имён, новые способы приведения типов и булевский тип. 

Стандартная библиотека C++ также развивалась вместе с ним. Первым добавлением к стандартной библиотеке C++ стали потоки ввода-вывода, обеспечивающие средства для замены традиционных функций C printf и scanf. Позднее самым значительным развитием стандартной библиотеки стало включение в неё Стандартной библиотеки шаблонов. 

В 1998 году был опубликован стандарт языка ISO/IEC 14882:1998 (известный как C++98), разработанный комитетом по стандартизации C++ (ISO/IEC JTC1/SC22/WG21 working group). Стандарт C++ не описывает способы именования объектов, некоторые детали обработки исключений и другие возможности, связанные с деталями реализации, что делает несовместимым объектный код, созданный различными компиляторами. Однако для этого третьими лицами создано множество стандартов для конкретных архитектур и операционных систем. 

В 2003 году был опубликован стандарт языка ISO/IEC 14882:2003, где были исправлены выявленные ошибки и недочёты предыдущей версии стандарта. 

В 2005 году был выпущен отчёт Library Technical Report 1 (кратко называемый TR1). Не являясь официально частью стандарта, отчёт описывает расширения стандартной библиотеки, которые, как ожидалось авторами, должны быть включены в следующую версию языка C++. Степень поддержки TR1 улучшается почти во всех поддерживаемых компиляторах языка C++. 

С 2009 года велась работа по обновлению предыдущего стандарта, предварительной версией нового стандарта сперва был C++09, а спустя год C++0x, сегодня — C++11, куда были включены дополнения в ядро языка и расширение стандартной библиотеки, в том числе большую часть TR1. 

В связи с выше перечисленного свой выбор остановим на языке программирования C++ версии 11. Подвергнутый стандартизации 2009 года в ядро языка внесли дополнения и расширили стандартную библиотеку.

• 1. Основной набор стандартных функций

В стандарте 2009 года произошли изменения в ядре языка:

• Повышена производительность за счет добавления многопоточности, улучшения оптимизацию, добавили ссылки на временные объекты и семантику переноса, обобщили константные выражения, произвели изменения в определении простых данных;
• Ускорена компиляция, за счет изменения во внешних шаблонах;
• Повышение удобства использования за счет изменения в списках инициализации, изменения в универсальной инициализации, изменения в выводе типов, изменения в For-цикле по коллекции, изменения в Лямбде-функции и выражениях, изменения в альтернативном синтаксисе функции, улучшение конструктов объектов, изменения в спецификаторах default и delete, изменения в явном замещении виртуальных функций и финальности, изменения в константе нулевого указателя, изменения в перечислении со строгой типизацией, изменения в угловых скобках, изменения в операторах явного преобразования, изменения в шаблонном typedef, изменения в снятии ограничений с union, изменения в индентификаторах со специальным значением, расширения функциональности;
• Расширение функциональности за счет изменения в шаблонах с переменным числом аргументов, появились новые строки литералы, изменения в пользовательских литералах, изменения в многопоточной модели памяти, изменения в статистике диагностике, изменения в работе sizeof с элементами данных в классах без создания объекта, изменения в управлении выравниванием объектов и запросах на выравнивание и расширение реализации со сбором мусора;
• Изменения стандартной библиотеки C++ повлекли за собой изменения в имеющихся компонентах, написание удобного шаблона, вызывающий конструкторы без выделения памяти, добавлены новые языковые возможности C++11, добавлены методы cbegin и cend, гарантированно создающие константные итераторы, в контейнерах, которые заводят память с запасом, появилась функция shrink_to_fit, для std::list поставлены более жёсткие рамки на то, что выполняется за O(n), а что — за константное время, для std::vector добавился прямой доступ к памяти через data(), запретили нескольким std::string ссылаться на одну и ту же память, изменения в управлении потоками, изменения в Хеш-таблицах, изменения в Регулярных выражениях и изменения в расширяемых классах генерации случайных чисел.

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

2.ТЕХНОЛОГИЯ СОЗДАНИЯ СПРАВОЧНОГО РУКОВОДСТВА

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

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

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

Dr.Explain поддерживает множество форматов вывода для единого источника.

Использует один источник и один инструмент для создания файлов помощи, онлайн-руководств или готовой к печати документации для любого программного обеспечения. Генерирует онлайн-руководства со встроенным поиском без использования программирования, баз данных или скриптов. Компилирует файлы помощи в формате Microsoft HTML в формат CHM для включения их в пакет поставки ПО. Создает готовую к печати кроссплатформенную документацию в форматах RTF и PDF.

2.1 Настройка программы для создания справки

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

Рисунок 2.1 – Стартовое окно приложения

• 1. Создать локальный проект – начать работу над новым локальным проектом
  2. Создать новый общий проект – создать новый общий проект на сервере tiwri.com.
  3. Забрать общий проект – Забрать общий проект с сервера tiwri.com.
  4. Создать локальный проект – Руководство пользователя по ГОСТ 34

Используя эту кнопку, можно создать руководство пользователя в соответствии с требованиями ГОСТ.

Начиная с версии 5.5.1100, программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах.

При включенном режиме поддержки ГОСТ для проекта соответствующие настройки для печатаемых форматов RTFDOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.

• 1. Создать общий проект на tiwri.com – Руководство пользователя по ГОСТ 34

Используя эту кнопку, можно создать руководство пользователя в соответствии с требованиями ГОСТ. Будет создан новый общий проект на сервере tiwri.com.

6. Открыть существующий проект – позволяет открыть ранее созданный проект из папки сохранения проектов

7.Импорт – позволяет выбрать формат для готового проекта из предложенных

Рисунок 2.2 – Окно импорта проекта

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

8. Список проектов – этот раздел содержит список недавних проектов. Общие проекты отмечены синим цветом.

Рисунок 2.3- Окно списка проектов

Для настройки приложения для удачной работы необходимо задать основные настройки. Для этого нужно выполнить команду главного меню «Настройки –Настройки приложения»

Рисунок 2.4 – Окно настроек приложения

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

Для настройки самого проекта и его свойств используют другое окно настроек.

Настройки проекта позволяют изменять параметры только текущего проекта.

Диалог настроек проекта можно открыть тремя способами:

• нажав кнопку на панели инструментов приложения;
• с помощью сочетания клавиш Ctrl+Alt+P;
• перейдя в меню «Настройки» и выбрав пункт «Настройки проекта».

Рисунок 2.5- Окно настроек проекта

В разделе «Настройки проекта» разрешено настраивать следующие параметры:

Общие настройки

В разделе общих настроек можно включить автоматическую поддержку требований ГОСТ 19 и ГОСТ 34, а также задать алгоритм именования новых разделов.

– Автоматическая поддержка требований ГОСТ 19 и ГОСТ 34

Включив эту опцию, можно создать руководство пользователя в соответствии с требованиями ГОСТ.

– Обозначение документа для верхнего колонтитула

Заполнив текст, который выводится в верхнем колонтитуле каждой страницы документа, созданного в режиме поддержки ГОСТ.

– Генерировать имена файлов по относительной нумерации

Выбрав эту опцию, имена файлов генерируются с использованием относительной нумерации (как в старых версиях программы Dr.Explain).

– Генерировать имена файлов по заголовкам разделов

Выбрав эту опцию, программа генерирует имена файлов согласно их заголовкам.

– Автоматическая нумерация разделов

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

– Исключить нумерацию из контента

Установив этот параметр, можно показывать номера разделов только в оглавлении, в списках разделов и в результатах поиска.

– Уровень вложенности разделов

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

– Тип нумерации

В раскрывающемся списке выбирается тип нумерации для выбранного уровня вложенности разделов.

– Тип разделителя

В раскрывающемся списке указывается тип разделителя для выбранного уровня вложенности разделов

– Скрывать разделитель в конце номера

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

– Присоединение предыдущего уровня

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

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

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

• 1. Создание разделов и подразделов руководства

При каждом запуске Dr.Explain автоматически показывается стартовый диалог, который позволяет начать новый проект, импортировать существующий документ или открыть недавний файл проекта.

Главное окно программы Dr.Explain позволяет управлять элементами проекта. Здесь вы можете создавать новые проекты, добавлять новые элементы, а также изменять настройки программы и проекта.

Рисунок 2.6- Главное окно работы над проектом

На главном окне работы над проектом расположены:

– Главное меню;

– Панель инструментов;

– Панель закладок

Главная панель инструментов Dr.Explain обеспечивает быстрый доступ к ключевым функциям программы.

Панель инструментов главного окна имеет вид (см. рисунок 2.7)

Рисунок 2.7- панель инструментов главного окна

где

• — создать новый проект.

• — открыть существующий проект.

• — сохранить текущий проект.

• — зафиксировать все изменения на сервере при совместной работе над проектом.

• — обновить проект и получить изменения с сервера при совместной работе над проектом.

• — главная кнопка программы Dr.Explain. Нажав на нее для захвата нового окна, обработки его структуры и добавления нового скриншота окна и всех его контролов в проект. Выпадающее меню позволяет добавлять скриншот из сохраненного на диске графического файла или буфера обмена.

• — вставить новый раздел или импортировать в проект внешние файлы.

• — вырезать выбранный элемент из дерева разделов проекта и скопировать его в буфер обмена.

• — скопировать выбранный элемент дерева разделов проекта или текст в буфер обмена.

• — вставить элемент из буфера обмена в дерево разделов проекта или редактор контента.

• — экспортировать текущий проект в HTML-справку.

• — экспортировать текущий проект в файл CHM.

• — экспортировать текущий проект в файл RTF.

• — экспортировать текущий проект в файл PDF.

• — настроить параметры текущего проекта. Для получения дополнительной информации обратитесь к разделу Настройки проекта.

• — показать информацию о программе Dr.Explain и регистрации продукта.

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

Рисунок 2.8 – Панель закладок

Редактор контента -это основная рабочая область в Dr.Explain. Редактор позволяет редактировать контент разделов в стиле WYSIWYG.

Дерево разделов – отображает структуру проекта и позволяет быстро переключаться между его элементами: разделами и страницами анотированных экранов.

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

Используйте сочетания клавиш Ctrl+Up и Ctrl+Down для изменения порядка дочерних элементов раздела.

Панель свойств раздела и ключевых слов – эта панель позволяет управлять свойствами раздела и ключевыми словами.

Панель статуса – показывает статус и прогресс по текущим операциям. Панель статуса также отображает подсказки при наведении курсора на кнопки в панели инструментах или пункты меню.

Чтобы создать новый проект, необходимо выполнить один из вариантов действий:

– использовать стартовый диалог;

– нажать кнопку на панели инструментов;

– перейти в меню «Файл» и выбрать команду «Создать»;

– использовать комбинацию Ctrl+N

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

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

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

Создание или добавление разделов – это наиболее частое действие, с которым придется столкнуться при работе с оглавлением. Оно похоже на создание новых документов в обычных текстовых редакторах. После создания раздела можете добавлять в него текст и прочие материалы, а также перемещать его в пределах оглавления.

Чтобы добавить новый раздел на текущем уровне, наведите курсор на раздел более высокого уровня и выберите его. Если выберете произвольный раздел и создадите новый, то новый будет создан как подраздел выбранного раздела.

Существует несколько способов добавления раздела в дерево:

– нажать кнопку на панели инструментов;

– перейти в меню «Настройки» и выбрать пункт «Добавить раздел» ;

– использовать сочетание клавиш Ctrl+T;

– кликнуть по нужному разделу правой кнопкой и выбрать «Добавить…», затем «Добавить раздел»;

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

При работе с проектом рекомендуется время от времени сохранять данные.

В Dr.Explain это можно сделать 4 способами:

-перейдите в меню «Файл» и воспользуйтесь командой «Сохранить»;

-нажмите кнопку на панели инструментов;

– используйя комбинацию Ctrl+S;

– при выходе из программы или закрытии своего проекта утвердительно ответьте на предложение программы сохранить файл:

При первом сохранении проекта Dr.Explain показывает стандартный диалог «Сохранить как…». Нужно указать имя своего проекта. Dr.Explain сохраняет проекты в файлы с расширением .GUI.

После завершения проекта вы можете экспортировать его в файлы помощи в форматах HTML, RTF, PDF или CHM.

Чтобы закрыть проект, нажмите стандартную кнопку в верхнем правом углу диалога или воспользуйтесь командой «Файл -> Закрыть».

• 1. Проверка проекта на ошибки

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

Проверка правописания включена по умолчанию. Чтобы выключить или включить эту функцию, а также настроить параметры проверки, нажмите кнопку:

Помимо проверки правописания, возможна проверка проекта на ошибки

Рисунок 2.9 – Окно настройки утилиты проверки

Данное окно настроек вызывается при помощи команды главного меню «Инструменты – Проверка проекта на ошибки», запустится мастер проверки, при помощи кнопки «Настройки» можно задать необходимые параметры проверки.

• 1. Экспорт в выбранный формат готового проекта

CHM-файл является одним из наиболее удобных способов предоставления пользователям справочных материалов о программном обеспечении в виде одного индексированного файла. HTMLhelp API позволяет открывать в CHM-файле конкретный раздел.  

Опубликовать файл в формате CHM можно следующими способами:

– нажмите на значок на панели инструментов приложения;

– перейдите в меню «Настройки» и выберите команду «Экспорт в CHM»;

– используйте комбинацию Ctrl+M.

После выбора этой опции появится следующий диалог:

Рисунок 2.10- окно экспорта в CHM

• 1. Инструмент проверки – выбрав эту опцию, программа проверит проект перед публикацией CHM-файла.

2. Открыть CHM-файл. Отключив эту опцию (включена по умолчанию), не будет автоматически открывать созданные CHM-файлы после окончания экспорта.

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

4.Индикатор прогресса – эта шкала отражает прогресс процесса публикации.

5.Журнал процесса -этот раздел содержит сообщения, генерируемые программой в процессе публикации.

6. Кнопка Больше…- позволяет открыть диалог Настроек CHM-экспорта, который позволит настроить параметры генерируемых файлов.

7. Кнопка Начать/Остановить экспорт – эта кнопка позволяет запустить или остановить процесс публикации. Во время публикации надпись на кнопке сменяется на Остановить. Кнопка позволяет остановить процесс и внести изменения в проект.

8. Кнопка Закрыть – закрывает диалог экспорта в CHM-файл.

После нажатия кнопки «Начать экспорт» запускается мастер экспорта и мастер проверки на ошибки проекта. По окончанию работы мастеров выдается отчет о проверке и экспорте в выбранном формате

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

Рисунок 2.11- Окно сообщения

Рисунок 2.12 – Результат экспорта с перечнем разделов

После завершения процесса публикации Dr.Explain откроет полученный CHM-файл (если вы не сняли флаг с соответствующей опции)

Рисунок 2.13 – Готовое руководство пользователя

ЗАКЛЮЧЕНИЕ

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

В результате курсовой работы разработано справочное приложение «Стандартные функции языка программирования С++».

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

Стояли задачи:

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

Поставленная цель и задачи успешно достигнуты.

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

Требования, которым удовлетворяет данный продукт:

• надёжность;
• эффективность;
• понятность пользователю;
• защита информации;
• мобильность;

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

Цели и задачи курсового проекта достигнуты полностью.

СПИСОК ИСПОЛЬЗОВАННОЙ ЛИТЕРАТУРЫ

1. ГОСТ Р 7.0.5-2008 Система стандартов по информации, библиотечному и издательскому делу БИБЛИОГРАФИЧЕСКАЯ ССЫЛКА Общие требования и правила составления
2. ГОСТ 7.32-2001 Система стандартов по информации, библиотечному и издательскому делу ОТЧЕТ О НАУЧНО-ИССЛЕДОВАТЕЛЬСКОЙ РАБОТЕ Структура и правила оформления
3. ГОСТ 7.1-2003 Система стандартов по информации, библиотечному и издательскому делу БИБЛИОГРАФИЧЕСКАЯ ЗАПИСЬ. БИБЛИОГРАФИЧЕСКОЕ ОПИСАНИЕ Общие требования и правила составления.
4. http://htmleditors.ru/Rasnoe/help/vvedenie.html – Создание справки
5. https://www.ebookmaestro.com/ru/support_guide2.html – e-Book Maestro: Создание справки-пошаговое руководство.
6. https://techrocks.ru/2019/01/14/10-programming-languages-to-learn-in-2019/ – 10 Языков программирования которые будут востребованы в 2019 году
7. https://www.softportal.com/dlcategory-322-1-0-0-0.html – Разработчику – создание справки
8. https://ru.wikipedia.org/wiki/JavaScript#Возможности_языка – JavaScript – Википедия
9. https://ru.wikipedia.org/wiki/Python – Python – Википедия
10. https://ru.wikipedia.org/wiki/C%2B%2B – C++ – Википедия
11. https://ru.wikipedia.org/wiki/C%2B%2B11 – C++11 – Википедия.
12. http://storage.mstuca.ru/bitstream/123456789/6770/4/УП_Надейкиной.pdf – Предисловие (базовые понятия языка C++)
13. https://www.drexplain.ru – Dr.Explain – программа для создания help файлов, online справки, руководств пользователя и документации
14. https://www.drexplain.com/support/dr_explain_user_guide.pdf – Dr.Explain User Guide

Приложение А

Руководство пользователя по стандартным функциям С++

Время на прочтение
4 мин

Количество просмотров 28K

Всем привет. Наверное, любой разработчик на вопрос, что вам больше всего не нравится в процессе разработки, ответит: «написание документации» или упомянет об этом в самом начале списка проблем. В документировании действительно ничего интересного нет, но, тем не менее, руководство пользователя, как я уже писал в своем первом посте на Хабре, является важным компонентом любого профессионального продукта. Плохо составленная документация будет не только препятствием на пути привлечения новых покупателей, но и является большим минусом к имиджу продукта и разработчика.

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

Сам иногда занимаюсь help-файлами и не понаслышке знаю, что создание справочной системы занимает время и является кропотливой и нудной работой, особенно документирование интерфейса. Однако пару месяцев назад открыл для себя инструмент, который значительно ускоряет этот процесс. Речь идет о программе Dr.Explain от самарской компании Индиго Байт Системз. Она мне понравилась продуманным интерфейсом и возможностью документировать интерфейс ПО в полуавтоматическом режиме.

Dr.Explain vs. Help and Manual

Итак, Dr.Explain позволяет создавать help-файлы в формате CHM для поставки вместе с приложением, справочные системы в HTML для размещения на сайте продукта, а также руководства пользователя в RTF и в PDF с оглавлениями и ссылками. Справочная система генерируется в разных форматах из единого источника, что позволяет быстро обновлять документацию при выходе новых версий ПО. В этом плане Dr.Explain ничем не отличается от Help and Manual, которой я давно пользуюсь.

Интерфейс состоит из двух областей. Первая – это панель навигации с древовидной структурой содержания проекта. А вторая – редактор страниц.

В дереве задается вся структура help-файла, включая заголовки папок и страниц. Редактор страниц состоит из стандартных инструментов для написания и форматирования текста, а также имеются инструменты для вставки гиперссылок, картинок, таблиц и переменных. Все это есть и в Help and Manual, но панель инструментов в Dr.Explain скомпонована, на мой взгляд, более продуманно.

Сравним:

Рисунок 1. Панель инструментов Dr.Explain

Рисунок 2. Панель инструментов Help and Manual

Главная фишка Dr.Explain – это автоматизация самого трудоемкого процесса документирования – создание аннотаций пользовательского интерфейса. Да, вы правильно меня поняли. Больше не нужно делать снимки экрана самому, рисовать выноски и стрелки, вставлять все это хозяйство в проект вручную – программа сама сделает снимок любой части интерфейса по вашему выбору, проанализирует и найдет (сама!) все значимые элементы (кнопки, элементы управления, списки), вставит снимок в проект справки и автоматически расставит стрелки и пояснительные выноски к изображениям. Пользователю остается всего лишь ввести краткое пояснение к каждой выноске и все.

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

Такое полуавтоматическое документирование интерфейса значительно ускоряет и облегчает создание справочной системы, т.к. разработчику остается всего лишь добавить свои описания в выноски. В Help and Manual я все это тоже могу сделать – правда, придется делать это вручную. Обычно я делаю снимки окон в Snagit, обрабатываю края снимка, добавляю тень, рисую стрелки. А для документирования элементов окна вручную создаю табличку, нарезаю снимки кнопок и контролов, обрабатываю их края и вставляю в проект, а затем пишу описания каждой выноски. На это тратится уйма времени и усилий.

Кое-что еще…

В Dr.Explain есть и другие полезные возможности, которых, к сожалению, нет в Help and Manual. Например, есть удобный режим просмотра проекта – одним кликом по соответствующей кнопке можно быстро посмотреть, как будет выглядеть справка в формате CHM или HTML после компиляции. Превью открывается прямо в окне редактора. Поверьте, это очень удобно. Однако нет PDF-превью – это минус. В Help and Manual чтобы посмотреть, как выглядит справка, нужно постоянно компилировать проект.

Также в программе есть возможность интегрировать контекстно-зависимую справку прямо в приложение (F1), управление деревом навигации, набор шаблонов оформления, поддержка CSS, возможность быстрого обновления документации при выходе новой версии программы путем замены иллюстраций, но с сохранением выносок, аннотаций, описаний; функция поиска и индексации в онлайн-справке без программирования (PHP, ASP) или баз данных на стороне сервера.

Резюме

Вот, пожалуй, и все основные моменты, о которых я хотел здесь рассказать. Краткий обзор Dr.Explain я хотел написать еще два месяца назад, когда впервые увидел программу, но потом отложил эту затею на неопределенное время. А недавно снова готовил справку пользователя в Help and Manual и еще раз убедился, что документировать интерфейс все же удобнее в Dr.Explain.

Начинающие разработчики программ, стремящиеся продемонстрировать свое творение миру, рано или поздно столкнуться с проблемой создания для своего детища справочной системы. По собственному опыту знаю, что лучше этим заняться сразу, то есть параллельно с разработкой программы одновременно создавать для нее и справочную систему. Этим вы “убьете сразу двух зайцев”: написание справки для пользователей одновременно превращается и в справочное пособие лично для вас, позволяя не забывать о тех либо иных малоиспользуемых функциях программы. Кроме того, такие справочные системы часто необходимы и просто для нас самих. Аксиомой является тот факт, что все не запомнишь, особенно когда обращаешься к какому-то материалу постоянно, но через достаточно длительный период времени. Естественно, в таких случаях мы начинаем подстраховываться: записываем свои действия вручную (в лучшем случае в ежедневник), либо формируем текстовый файл. При этом хорошо, если бумажки у вас никогда не теряются, и вы всегда их носите при себе. С файлами проще: записал на флэшку и носи их всегда с собой. Но иногда такие файлы непомерно “разрастаются”, и быстро отыскать в них нужную информацию становится проблематично. Вот тут-то и возникает необходимость структурировать свою информацию в удобном виде с возможностью поиска так, как это принято в стандартной справочной системе.

Понятно, что для этого существует соответствующий класс программного обеспечения. Комфортную работу по созданию справочных систем предоставляет разработка HelpMaker компании Vizacc Pte Ltd. Насколько известно автору, это единственная программа такого рода, принадлежащая к классу freeware. Более того, программа имеет активно действующий форум и конференцию новостей. Программа имеет многоязычный интерфейс, включая и русский. С ее помощью можно не только скомпилировать справку для встроенных в операционную систему форматов HTML Help или WinHelp, но и конвертировать ее в файл формата DOC, RTF, HTML, PDF или текстовый.

Для сравнения. Программный продукт Help & Manual Version 5 компании EC Software в зависимости от версии стоит $350-500. А ее возможности сопоставимы с возможностями HelpMaker. В статье рассматривается последняя версия 7.3.51.0 (на момент написания статьи). Скопировать программу можно на сайте разработчика; имеется она и на многих софтверных сайтах и порталах, например, на Softodrom.ru.

Настройка

Настройка самой программы сложностей не представляет и много времени не отнимет. После ее установки сразу же меняем язык, выполнив команду English > Cyrillic (Russia), USSR.

После этого выполните команду Инструменты > Настройки и произведите такие настройки:

1. Вкладка “Общие”. Единицы измерения: замените “Inch” на “Centimeter”.

2. Вкладка “Настройки каталога”. Установите флажок возле действия “Каталог по умолчанию” и определите путь к нему в расположенному ниже поле.

Создание файла проекта

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

1. В главном окне программы щелкнуть кнопку “Создать”.

2. Появится одноименное окно.

3. На первом шаге работы программы-мастера согласиться с вариантом “Create a new HelpMaker Project” (“Создать новый проект”). Щелкнуть кнопку “Далее”.

4. Задать путь и имя для создаваемого проекта. Отмечу: странно, что программа не выбирает по умолчанию каталог, установленный нами по умолчанию. Для файлов-проектов программа использует расширение SH6. В этом же окне следует задать имя проекта, например, “Справка по Visual Fox”. В поле “Имя файла” имя тут же будет сдублировано, причем пробелы заменяются на символ подчеркивания (“_”): “справка_по_visual_fox”. Щелкнуть кнопку “Далее”.

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

6. Щелкните кнопку “Finish”, после чего в правой части окна “Document Маp” (“Карта документа”) появится информация про созданный проект.

7. Сохраните файл проекта, щелкнув на панели инструментов стандартную кнопку “Сохранить”.

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

Наполнение проекта

На приведенном выше рисунке видно, что проект состоит из двух частей: “Help Contents” (Оглавление справки) и “Popus” (Всплывающие окна). Наша задача заключается в их текстовом наполнении. Замечу, что “Оглавление справки” не означает, что содержащаяся в ней информация относится именно к оглавлению. Как раз здесь и размещается все текстовое наполнение справочной системы: содержимое страниц справки, названия глав и разделов.

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

Создание объекта

Для добавления информации в оглавление справки щелкните пункт “Help Contents”. В правой части окна Вам будет предложено создать новую главу (раздел) справки, щелкнув кнопку “Создать главу…”. Щелчок на этой кнопке приводит к открытию окна “Вставить”.

Вообще-то такой вариант используется при создании самого первого объекта справки. В дальнейшем объекты вставляются в самые разные места проекта, поэтому для включения их в проект намного лучше работать с ними в области “Document Маp”. Именно здесь удобно выбирать объект, рядом с которым будет добавлен новый, открыть список кнопки добавления объектов и выбрать вариант вставки.

В окне “Вставить” для новой страницы следует выполнить такие действия.

1. Переключатель “Тип добавляемых”. Выбрать тип добавляемой к проекту информации, установив переключатель в одно из положений: глава, раздел или раздел с текстом. Здесь следует припомнить структуру справочной системы. Оглавление справки, как известно, состоит из разделов, которые в свою очередь разбиваются на главы. Факт наличия в составе справочной системы раздела символизирует наличие пиктограммы и символ “+” перед ней. Разделы состоят из глав, которые отображаются в справке пиктограммой . Именно главы непосредственно содержат текстовую информацию. В свою очередь, разделы могут либо содержать тестовую информацию, либо – нет. В системе они соответственно называются “Разделы с текстом” либо просто “разделы”. Однако и для главы и для раздела следует создавать объект системы. Поэтому далее при необходимости я буду использовать термин “объект” как обобщение понятий “глава” и “раздел”. Возвращаясь к нашему примеру, ясно, что для оглавления следует выбрать тип “Глава”.

2. Ввести информацию в поле “Текст дерева проекта”. Для оглавления введем “Оглавление”. Автоматически этот текст подставляется и в поле “ID (идентификатор) главы”. Текст (в наших условиях) будет вводиться на русском языке, и, если это так, то я рекомендую изменить информацию в поле “ID главы” на английский текст. В противном случае, в дальнейшем могут возникнуть проблемы при создании гиперссылок.

3. В поле “Ключевые слова” вводятся слова, по которым будет осуществляться поиск информации в справке. Каждое ключевое слово водится с новой строки. Заглавные и строчные буквы системою не учитываются, поэтому слова “Текст” и “текст” будут расцениваться системою как одно слово “текст”.

4. Указать, для какого формата справочной системы следует включать данный объект (HTML Help, WinHelp, справка в виде Web-страницы), установив флажок возле нужных форматов.

5. Щелкнуть кнопку “ОК”.

Работа с объектом

После создания объекта работа с ним происходит на трех вкладках.

Вкладка “Управление справкой” отображает непосредственно текст объекта, именно здесь и производится редактирование текста.

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

Система имеет собственный текстовый редактор, позволяющий создавать таблицы, списки, изменять стили, шрифты, абзацы, применять смещение символов вверх либо вниз относительно базовой линии, вставлять рисунки и многое другое. Для создания справки этих возможностей более чем достаточно. Но раз редактор свой, автономный, то логично возникает вопрос: а как насчет проверки русской орфографии? Оказывается, решается и этот вопрос: программа поддерживает проверку русской орфографии. Правда, в стандартной поставке HelpMaker отсутствует русский словарь, однако его, как, кстати, и словари для многих других языков, можно скачать с сайта (на странице сайта ищите пункт “Dictionary”). Словари имеют расширение .ADM. После выкачки словаря из Интернета просто скопируйте его в каталог с загружаемым модулем HelpMaker. При проверке орфографии в окне “Spelling” (“Проверяю”) щелчок на кнопке “Options” (“Параметы”) отображает факт подключения к системе словаря орфографии для русского языка. Все действия для проверки орфографии (“Проверить орфографию”, “Словарь”, “Язык”) содержит пункт главного меню Инструменты.

Вкладка “Глава справки” содержит идентификатор объекта, перечень ключевых слов, формат создания справочного файла и пр.

Наконец, вкладка “HTML Preview” позволяет просмотреть, как будет выглядеть страница справки при ее просмотре.

(Продолжение следует)

Валерий ФЕТИСОВ