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

Добавил пользователь Дмитрий К.
Обновлено: 05.10.2024

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


Методы создания справок

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

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

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

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

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

Для создания раскрывающегося списка применяется код JavaScript. Вы можете освоить JavaScript и создавать код раскрывающихся списков самостоятельно.
Или Вы можете применить специальные программы, способные создавать раскрывающиеся списки в визуальном режиме, например Sothink DHTML Menu, Xara Menu Maker, Easy CSS Menu, HTML TreeView Generator и другие (см. Навигация - Обзор программ ).
В этом случае достаточно вставить созданный спецпрограммой раскрывающийся список на страницу - и оглавление справки практически готово - см. Пример (раскрывающий список создан в бесплатной программе HTML TreeView Generator).

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

Некоторые программы позволяют добавлять к справке эффекты, используя jQuery (например - создается справка с временно исчезающим оглавлением, чтобы освободить место на экране компьютера).

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

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

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

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

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

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

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

Контекстно-зависимая справка позволяет пользователям легко переходить к разделам справки, касающимся выполняемых ими операций в той или иной программе.

Для создания контекстно-зависимой справки используются справки формата CHM (для этого нужно, чтобы справка была "прикручена" к программе).
Справка программы обычно вызывается при щелчке по кнопке Help (Справка), которая имеется в большинстве программ, или с помощью клавиши F1. При этом открывается справка программы со всем ее содержимым.

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

Справка состоит из нескольких элементов:

Содержание справки - набор страниц справки

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

Индекс (Index) - список индексированных (ключевых) слов. В список включаются слова (сочетания слов), которые облегчают пользователям справки переход к нужному разделу справки или к разъяснению некоторых слов и терминов. Список индексированных слов создается автором справки.

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

Избранное (Favorites или Bookmark) - Создается пользователем справки. В список избранного пользователь может включить все нужные ему разделы справки.

Примечания :
1. В более широком смысле к программам для создания справок можно отнести также программы, которые способны создавать видео-обучающие материалы ( так называемые скринкасты ) - см. Снимки экрана. В данный обзор включены некоторые из программ, подобного рода.
2. Вы можете создать справочник по любой теме, используя специальные программы - Записные книжки . Но такие справки нельзя разместить в Интернете, т.к. они просматриваются в программах-создателях. Поэтому эти справки создаются только для личного пользования.

Перед рассказом я бы хотел узнать, кто до этого имел опыт разработки под мобильное приложение. Поднимите руки, кто разрабатывал мобильные приложения на 1С? А кто разрабатывал под iOS? Ни одной руки я не увидел, поэтому думаю, что это будет вам интересно.


План презентации. Я расскажу:

  • про предпосылки к созданию этого мобильного приложения – почему я начал его создавать, и почему, возможно, оно будет вам полезно;
  • что необходимо изучить для разработки мобильного приложения под iOS или под Android;
  • какие есть особенности разработки приложения;
  • и как вы сможете использовать это уже разработанное приложение в своей компании, если вам это будет интересно и полезно.

Предпосылки к созданию мобильного приложения Phonebook offline


Почему я начал создавать это приложение?

  • Я работаю в крупной организации с разветвленной филиальной сетью. У нас более 1500 сотрудников, более 50 подразделений: в России – от Калининграда до Владивостока, за границей – от Кубы до Сингапура.
  • Наши сотрудники довольно часто ездят в командировки в наши филиалы или представительства.
  • Из-за этого возникает необходимость связаться с различными контактными людьми – будь то водитель, или директор филиала, или главный бухгалтер филиала. И есть проблема – когда приезжаешь в новый город, может не быть возможности зайти в телефонный справочник на сайте из-за того, что нет роуминга или нет доступа к мобильному интернету в роуминге. Поэтому будет полезно иметь оффлайновую версию, которая работает без подключения к интернету, и где можно посмотреть такую контактную информацию.
  • Также будет полезна дополнительная связанная информация – например, адрес местонахождения подразделения, режим работы подразделения – когда там обед, когда начало работы. И также полезна информация о днях рождения сотрудников – руководителю отдела полезно знать, когда дни рождения у его подчиненных, чтобы иметь с ними хорошие отношения.

Почему нужно было написать приложение именно под iOS? Зачастую в различных компаниях топ-менеджмент ходит с iPhone, а обычные люди ходят с Android-устройствами – соответственно, полезно уметь разрабатывать под iOS.

Что было в наличии?


Что у меня было в наличии?

  • я, как уже говорил выше, умел хорошо разрабатывать для десктопной версии 1С;
  • у меня было несколько стартмани на Инфостарте – я там оставлял несколько комментариев, и за каждый комментарий мне давали чуть-чуть стартмани;
  • мне на работе дали MacBook, которому несколько лет – если макбук не совсем новый, важно туда поставить SSD, чтобы все быстрее компилировалось;
  • у меня был мой Android-телефон;
  • и бюджет в 100$.

Чего не хватало?


Чего мне не хватало?

Документация


Как я преодолевал трудности?

Алгоритм создания приложения для iPhone с нуля


Какой я выбрал алгоритм создания приложения для iPhone?

  • Сначала я решил сделать приложение на 1С для десктопной версии – стандартный телефонный справочник для компьютера и посмотреть в десктопном варианте. Там все отладить.
  • И следующим шагом я захотел это все воспроизвести на Android – уже мобильное приложение для Android. Почему именно для Android? Потому что на Android не нужно ставить ничего дополнительного, кроме Android SDK, и можно очень удобно переслать приложение по WhatsApp другому человеку. Там нет никаких сложностей, которые есть с iPhone.Приложение на Android удобно отлаживать – у меня есть телефон, и его можно использовать. Когда я сделал приложение для Android, я показал его своему начальнику – он посмотрел на возможности приложения, проверил, как оно работает, и согласовал его публикацию в таком виде.
  • Следующим этапом после его акцепта я уже скачал бесплатный тестовый сертификат разработчика, и с ним я уже мог демонстрировать приложение на iPhone.
  • И следующим этапом после того, как есть бесплатный сертификат, и все продемонстрировано на iPhone, можно загрузить приложение на AppStore. Никаким другим способом, кроме как, выложив на AppStore, вы, к сожалению, загрузить приложение на iPhone не сможете. С тестовым сертификатом вы приложение можете собрать и продемонстрировать, но там есть недостатки – вы не сможете со своим аккаунтом подключить больше 2-х телефонов. И приложение через какое-то время перестанет работать – с тестовым сертификатом оно работает две недели максимум. Потом сертификат отзывается, нужно получать новый, и приложение перестает работать. Плюс – чтобы поставить такое приложение, нужно лезть в настройки телефона и там устанавливать, что вы доверяете разработчику.

Первые трудности


При установке у меня появились некоторые проблемы:

Процесс сборки и публикации приложения под iOS


Собрать приложение под Android вам поможет книжка Хрусталевой – там нет ничего про iOS, но про Android там хорошо написано. Справа на слайде вы можете увидеть фрагмент главного меню моего приложения.

Соответственно, за 1$m вы получаете классную инструкцию в формате pdf, при помощи которой вы сможете собрать приложение для iOS.


После того как приложение для iOS готово, его нужно опубликовать на AppStore. Есть еще вариант сделать Jailbreak на iPhone – это позволит передавать приложение с MacBook на телефон. Но это нелегальный способ, после которого теряется гарантия – топ-менеджер вас не поймет, если вы ему скажете, что собираетесь взломать его iPhone и поставить на него классное приложение, но для этого телефон придется снять с поддержки.

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

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

В этих статьях есть вся связанная информация о том, как нужно заполнять анкету – там много пунктов. И эти пункты есть на хабре. Я прямо скопировал и по пунктам все заполнил.

Трудности при публикации в AppStore


При публикации на AppStore были свои трудности.

Снижение стоимости публикации в магазине приложений


Каким образом я снижал стоимость разработки?

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

Я внимательно прочитал лицензионное соглашение с 1С и с Apple и понял, что для частных разработчиков, которые не относятся к корпорациям, лицензия стоит 99$.

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

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

Если это бесплатное приложение для массового пользователя, то оно идет бесплатно, и никаких обязательств перед 1С не возникает.

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

Телефонный справочник оффлайн


Сейчас немного расскажу про этот телефонный справочник – чем он удобен.

Дополнительные возможности для Android


Какие есть дополнительные возможности для Android?

Для Android можно читать журнал звонков и переносить эти данные в приложение. Вам удобно – номер позвонил, вы не хотите его заносить в телефон, но хотите, чтобы это где-то хранилось. Можно использовать. Единственное, что Android, скорее всего, закроет эту возможность в скором времени – в iPhone, например, нельзя читать журнал звонков и нельзя использовать журнал контактов.

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

Особенности работы с приложением


Есть удобная функция уведомлений – приходит push-уведомление о днях рождения сотрудников.


Здесь на слайде показан исходный код создания такого push-уведомления. Все довольно просто – этот код есть на ИТС, его можно легко написать самому или посмотреть – там вся документация есть. В этом нет ничего сложного.


Как вы можете пользоваться этим приложением?

Для iPhone вы можете скачать приложение PhoneBook Offline бесплатно – ищите в поиске AppStore по ключевым словам PhoneBook Offline.


Справа вы видите окошко с настройками – вы видите адрес сайта с таблицами.

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

Почему используется формат JSON? В этом случае файл с сотрудниками можно выгружать не только из ЗУП, но и из УТ. Например, если вы работаете в торговой компании, где есть менеджеры, и менеджерам важно знать номера телефонов своих клиентов, в этом случае вы можете сами написать обработку, которая будет выгружать для конкретного менеджера его актуальных клиентов. И, соответственно, менеджеры смогут загружать себе в телефон актуальный список контактных номеров, чтобы в офлайне, без необходимости доступа к интернету, всегда видеть контактные данные своих клиентов.


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

Помните тот случай, когда секретарь вбивала 170 телефонов? Как можно оптимизировать? Загрузить эти телефоны в мобильное приложение и дальше секретарь смогла бы переносить контакты из приложения в телефон по кнопке.

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


Выводы


Вкратце расскажу о выводах

Вопросы

Данная статья написана по итогам доклада (видео), прочитанного на конференции INFOSTART EVENT 2019. Больше статей можно прочитать здесь.

В 2020 году приглашаем всех принять участие в 7 региональных митапах, а также юбилейной INFOSTART EVENT 2020 в Москве.


СОВРЕМЕННЫЕ ПРОБЛЕМЫ ШКОЛЬНОГО ОБРАЗОВАНИЯ





Автор работы награжден дипломом победителя III степени

Текст работы размещён без изображений и формул.
Полная версия работы доступна во вкладке "Файлы работы" в формате PDF

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

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

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

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

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

Актуальность:

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

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

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

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

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

1 Методика проектирования и создания электронного справочника 1.1 Отличительные признаки электронного справочника

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

По форме носителя справочники подразделяют:

Отличие электронного справочника от бумажного состоит в том, что:

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

2) Многие электронные справочники являются по своей структуре открытыми системами. Их можно дополнять, корректировать, модифицировать в процессе эксплуатации.

1.2 Основные этапы проектирования электронного справочника

В проектировании электронного справочника можно выделить следующие основные направления деятельности:

разработка структуры справочника (Приложение 1),

реализация на компьютере,

апробация и корректировка.

При построении интерфейса справочника необходимо учитывать следующее: 1. Дизайн и оформление не должны отвлекать от поиска необходимого материала;2. Шрифт электронного справочника не должен быть слишком мелким или слишком крупным;3. Ни в коем случае нельзя делать светлый текст на темной фоне. От этого устают глаза, и теряется внимание. 4. Анимация, используемая в справочнике должна как можно нагляднее демонстрировать способы решения поставленных проблем.5. Электронный справочник должен максимально облегчить процесс решения поставленных проблем.

2 Создание электронного справочника 2.1 Анализ программных средств создания электронных книг

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

К недостаткам данной программы я могу отнести следующие проблемы:

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

нет возможности настроить гиперссылку конкретно к абзацу страницы (Приложение 2 открыть папку Public_html, index вход)

2) SunRav BookOffice - пакет, состоящий из двух программ: SunRav BookEditor - программа для создания и редактирования книг и учебников и

SunRav BookReader - программа для просмотра книг и учебников.

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

Возможно распространение электронных книг на CD и DVD дисках вместе с бесплатной программой для просмотра SunRav BookReader, которая может озвучивать книги, проводить индексный и полнотекстовый поиск, автоматически пролистывать страницы, читать текстовые, HTML, RTF и MS Office документы, изменять внешний вид, используя темы, организовывать наиболее часто используемые книги и главы в избранное.

По своим функциональным возможностям данная программа наиболее привлекательна. Однако бесплатная версия программы позволяет работать не более чем с 10 главами (разделами), что явно недостаточно для данного справочника./10/

2.2 Актуальность выбранной темы справочника

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

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

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

инфицированных MRSA (метициллин-устойчивые бактерии) на 64% выше по сравнению с людьми с лекарственно-неустойчивой формой инфекции. Устойчивость приводит к увеличению длительности пребывания в стационарах и предполагает необходимость более интенсивного лечения.

Согласно рекомендациям ВОЗ необходимо:

использовать антибиотики только в том случае, когда они назначаются врачом;

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

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

2.3Разработка структуры электронного справочника

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

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

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

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

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

во-вторых, школа получила в свое распоряжение и сможет использовать электронный справочник;

в – третьих была оказана помощь в проектной работе ученикам 6 класса.

Выводы:

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

Литература:

Домашний медицинский справочник: Универсальная энциклопедия. Под редакцией доктора С.М.Зайцева изд.Махаон Москва 2000

Травы жизни и их искатели. профессор Г.В.Крылов Западно – сибирское книжное издательство. Новосибирск 1972

Травник от всех болезней. А Лагерь.из Рипол классик. Москва 1999

Приложение 1

Планируемая структура справочника

Раздел 1.Рецепты.

1.2Инфекции респираторные вирусные

Раздел2. Лекарственные растения.

2.1 Дикорастущие лекарственные растения

2.1.1 Аир болотный

2.1.2 Алтей лекарственный

2.1.3 Душица обыкновенная

2.1.9 Мята полевая

2.1.10 Ромашка лекарственная

2.1.11 Солодка гладкая

2.2 Культурные растения

Раздел 3.Состав и применение чаев и сборов лекарственного сырья

3.2 Потогонные чаи

3.3 Сборы для полоскания горла

взаимосвязь между разделами и подразделами осуществляется независимо, через содержание;

при обращении к рецепту по ссылке можно перейти к описанию лекарственного растения;

при обращении к описанию растения по ссылке можно перейти к рецепту, в котором оно применяется.

Приложение 2

Инструкция по созданию электронного учебника TurboSite

Установка программы Turbo Site

Создаём новый проект

Запускаем программу Turbo Site. И видим окно приветствия.

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

Выбираем оформление для электронного учебника

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

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

Основные настройки электронного учебника

На вкладке Параметры сайта можно установить основные настройки электронного учебника.

Добавляем страницы учебника

Нажать кнопку Добавить. В левом окошке появится новая страница. Теперь в правую часть можно вставить свой текст.

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

Расставляем ссылки на страницы

Выделить пункт оглавления – нажать кнопку ссылка – на страницу проекта – указать ту страницу, на которую нужно ссылаться.

Получился электронный учебник:

Он находится в папке public_html. Чтобы его открыть, достаточно запустить внутри этой папки файл index.html.

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

Приложение 3

Формат HTML Help или CHM был разработан компанией Microsoft в 1997 г. Сегодня CHM остается стандартом справки для приложений, работающих в ОС Windows. Средство для просмотра CHM-файлов есть во всех версиях Windows 10. Более того, наличие справки в приложении часто рассматривается как один из показателей качества приложения. В этой статье я расскажу о том, как создать справку в формате CHM.

Справка в формате HTML Help (CHM) представляет собой скомпилированный HTML — автономный веб-сайт, сжатый и упакованный в файл формата CHM. Наряду со стандартным функционалом, таким как динамическое оглавление, указатель и полнотекстовый поиск, HTML Help может содержать и дополнительный функционал, например, избранное и т.д. Подробное описание формата можно посмотреть в статье Формат HTML Help. Создать CHM справку можно при помощи специальных программ, как платных, так и бесплатных.

Бесплатные программы для создания CHM-справки

MS HTML Help Workshop

Компания Microsoft, разработчик формата CHM, предоставила для создания справки бесплатный инструмент, HTML Help Workshop. Его можно свободно скачать с сайта компании по данной ссылке. В составе программы имеется максимально подробный файл справки на английском языке. На сайте есть подробное описание формата, также в оригинале.

Очевидный, и, на мой взгляд, единственный плюс программы HTML Help Workshop — бесплатность. Создание более-менее серьезной справки в HTML Help Workshop — очень трудоемкая задача, выполнение которой растягивается на многие месяцы. При этом вы получите справку с базовыми возможностями формата CHM: текст, рисунки, ссылки. Регулярное обновление справки на базе проекта, созданного в HTML Help Workshop, практически нереально. Я пользуюсь данной программой исключительно для компиляции / декомпиляции CHM-файлов. В более продвинутых бесплатных и профессиональных программах, предназначенных для разработки справочных систем, HTML Help Workshop используется в качестве компилятора. Это говорит о солидном потенциале формата, скрывающемся под непростым пользовательским интерфейсом инструмента.

Рассмотрим еще несколько более продвинутых программ, при помощи которых можно создать справку в формате CHM: HelpNDoc и Help+Manual.

HelpNDoc

HelpNDoc — это условно-бесплатная программа от французского разработчика, компании IBE Software. Пользовательский интерфейс программы выполнен в стиле MS Office, поэтому работу с программой можно быстро и легко освоить. Для работы с текстом, рисунками, таблицами, ссылками и другим контентом в HelpNDoc используется простой и интуитивно понятный визуальный редактор. HelpNDoc работает по принципу единого источника и поддерживает экспорт проекта в ряд форматов справки, в том числе, CHM. Подробное описание программы на русском языке можно посмотреть здесь.

На момент написания статьи выпускается 3 редакции программы:

  • Standard — платная редакция, позволяющая генерировать CHM и Web-Help в коммерческих целях. Выходные файлы в остальных форматах (DOCX, PDF, EPUB и др.) будет содержать отметку о том, что они созданы некоммерческой версии программы.
  • Professional — платная редакция без отметок во всех выходных форматах.
  • Personal — полнофункциональная программа, бесплатная для личного, некоммерческого использования. Во всех выходных форматах в нижней части всех страниц добавляется отметка о том, что файл создан с использованием некоммерческой версии HelpNDoc.

CHM-файл, созданный в бесплатной версии HelpNDoc

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

Как создать профессиональную справку в формате CHM

Несмотря на то, что первой профессиональной программой для разработки справки, с которой я познакомился в 2003 году, был RoboHelp Х4 (в связке с RoboDemo 4 они использовались в проекте локализации библиотеки пользовательской документации, включая справку и электронный обучающий видеокурс), с 2005 года я предпочитаю работать с Help&Manual. Сегодня это программный комплекс Help+Manual 7, в котором, на мой взгляд, есть всё необходимое для автора пользовательской документации.

Help+Manual 7 Pro — это самый популярный программный комплекс для создания справки, пользовательской и различной технической документации. Он предназначен для разработки и локализации профессиональных справочных систем, руководств пользователя, баз знаний, электронных книг и другой документации в форматах CHM, WebHelp, PDF, DOCX, EPUB, MOBI и др. для настольных и мобильных приложений, iOS и Android, Windows и Linux.

Бесплатная книга по Help+Manual 7 Pro на русском языке

Большинство обучающих материалов и инструкций по Help&Manual написано на английском и немецком языках. Предлагаемая вашему вниманию книга на русском. В ней изложены основы работы с Help&Manual. Какая версия программного комплекса подходит для работы с кириллицей? Где взять Help&Manual? Как установить? Что и как настроить для начала работы? Ответы на эти и многие другие вопросы вы найдете в данной книге.

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

  • установить и подготовить Help+Manual к работе;
  • создать проект с нуля и импортировать все необходимые материалы;
  • наполнить проект контентом: текстом, рисунками, таблицами и т.д.;
  • создать справку в формате CHM.

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

Чтобы бесплатно скачать книгу, пожалуйста, заполните форму:

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

Установка Dr.Explain


Создание и настройка нового проекта


Создание тематических разделов в файле справки


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


Рисунок 4. Ключевые слова



Рисунок 6. Результат выполнения захвата объекта

Настройка значений Help ID


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

Экспорт проекта в CHM-файл



Рисунок 9. Редактор форм среды разработки Microsoft Visual Studio


Рисунок 10. Редактор кода среды разработки Microsoft Visual Studio

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

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

Открытие определенных разделов файла справки с помощью компонента Help Provider

·TableOfContents — открывает оглавление;

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

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

Код вызова стартовой страницы справки:

Код вызова оглавления:

Код вызова поиска по первым буквам ключевого слова:

где me — сочетание букв для поиска

Код вызова поиска по ключевому слову:

где FAQ — ключевое слово

Код вызова раздела по его названию:

где Overview.htm — название раздела (ключевое слово всегда указывается в формате Topic.htm)

Код вызова раздела по его HelpID:

где 1500 — значение HelpID интересующего раздела

Код вызова списка разделов, содержащих ключевое слово:

где menu — ключевое слово для поиска разделов.

Смотрите также



СКАЧАТЬ
БЕСПЛАТНО
195 Mb, Windows 11/10/8/7 - 64 Bit

Пользовательские истории успеха


Dr.Explain экономит ресурсы отдела техподдержки Бастион Груп


Dr.Explain значительно облегчил пользователям астрологической программы "Вега Матрица" процесс обучения и освоения


Создание наглядной документации в Dr.Explain помогло компании 2V сократить нагрузку на техподдержку: пользователи легко осваивают продукты без помощи операторов


Компания OrangeCat Software давно забыла о создании документации без Dr.Explain как о плохом сне


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

Читайте также: