Почитайте!

Нас читают

Статьи о программировании и не только

Mail.Ru

Rambler's Top100

Programming Blogs - BlogCatalog Blog Directory

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

28.11.2007 от Иван Ширко

Всё! Завершено гениальное творение не менее гениального программиста. Программное детище проверено, отлажено и перепроверено. Все найденные друзьями-тестерами "баги" благополучно устранены. А значит, пришло время распространить программу среди пользователей, которые раньше как-то умудрялись без неё обходиться... И вдруг понимаешь, что, несмотря на интуитивно-понятный интерфейс, в мире обязательно найдутся не интуитивно-понятливые "юзеры", которые не смогут насладиться всеми функциями данного произведения искусства, а то и вовсе (о, ужас!) удалят программу БЕЗВОЗВРАТНО. Смахнув со лба капли холодного пота и преисполнившись жалостью к таким "юзерам", всерьёз задумываешься о сопроводительной документации. На ум сразу же приходят мысли о файле "readme.txt" или о небольшой html-страничке, но тут же отметаются: в солидном проекте всё должно быть солидно. Так что придётся делать общепринятый файл *.hlp, который будет гордо называться "справочной системой". Как создавать файлы такого формата рассказывает данная статья.
Прежде всего, нам понадобится программа Microsoft Help Workshop. Найти её можно по адресу http://download.microsoft.com/download/0/a/9/0a939ef6-e31c-430f-a3df-dfae7960d564/htmlhelp.exe, также она распространяется вместе с популярными средами программирования (Delphi, VC++). Помимо этой "софтины", нам потребуется текстовый процессор для создания файла в формате RTF (rich-text format), Word от всё той же Microsoft вполне подойдёт.
Теперь можно приступить к процессу создания справочной системы, который состоит из трёх важных составляющих:
– подготовка RTF-файла;
– создание и компилирование файлов справочной системы;
– создание содержания справки.

Создание RTF-файла

Оформление разделов
Как известно, справка обычно разбивается на разделы. В RTF-файле каждый раздел должен начинаться заголовком и заканчиваться символом "разрыв страницы" ("Вставка\Разрыв..."). Кроме этого, раздел должен содержать уникальный идентификатор. Для его установки поместите текстовый курсор перед первым символом заголовка и из меню "Вставка" выберите пункт "Сноска...". В появившемся диалоговом окне (рис.1) в разделе нумерация установите радиокнопку в положение "Другая" и введите символ диеза ('#'). После нажатия на кнопку "OK", Word предложит ввести текст сноски, что и необходимо сделать. Следует заметить, что если текст сноски начинается с префикса IDH_, то во время компиляции справочной системы будет проверена корректность всех ссылок данного раздела.
Ссылки на другие разделы
Для связывания разных разделов используются слова-ссылки, при нажатии на которые осуществляется переход к нужной ветке справки. Для того, чтобы сделать слово ссылкой, нужно выделить его и подчеркнуть двойной линией ("Формат\Шрифт\Подчёркивание/Двойное"). После этого, сразу за словом-ссылкой, требуется поместить идентификатор нужного раздела (текст сноски). При запуске справки ссылка будет выделена цветом и одинарным подчёркиванием.
Комментарии
В документе можно использовать не только ссылки на другие разделы, но и ссылки на комментарии (например, для объяснения какого-нибудь заумного термина). Во время работы справочной системы такие ссылки выделяются цветом и подчёркиванием пунктирной линией, при нажатии на них появляется вплывающее окно с текстом комментария. В RTF-файле комментарии оформляются так же, как и разделы, но они не должны начинаться с заголовка. Ссылку на комментарий нужно подчеркнуть одной линией и сразу за ней написать его идентификатор скрытым текстом.
Ключевые слова и поиск по разделам
Для каждого раздела справки можно создать список ключевых слов. Для этого нужно перед заголовком раздела установить сноску K, а в текст сноски нужно записать все ключевые слова, разделив их точкой с запятой. При работе справочной системы ключевые слова всех разделов будут отображены в закладке "Указатель". Рядом с ней находится закладка "Поиск", в которой осуществляется поиск по справке. Для того, чтобы включить возможность поиска по какому-либо разделу, нужно перед его заголовком поставить сноску $, текстом которой должно служить название раздела в поисковой системе.
Вставка графики
Для вставки картинки в раздел, достаточно просто поместить её туда в Word'e ("Вставка\Рисунок").

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

Теперь, когда RTF-файл набран, можно приступить к созданию справки на основе этого файла. Запустите программу Microsoft Help Workshop и создайте новый проект, выбрав пункт меню "File\New/Help Project". В правой части окна программы нажмите на кнопку "Files..." и в появившемся диалоговом окне при помощи кнопки "Add" добавьте к проекту RTF-файл. Теперь пройдёмся по опциям справочной системы (кнопка "Options...").
General
Эта закладка содержит основные настройки справки:
Default topic – идентификатор основного раздела справки. Этот раздел появляется при запуске справочной системы (если она не имеет содержания) и в случае, если пользователь нажал на ссылку на несуществующий раздел.
Help title – заголовок справки, который отображается на заголовке окна.
Copyright information – текст, отображаемый в диалоговом окне "Версия" и текст, который автоматически добавляется при печати и копировании справки (подпись).
Сompression
Здесь находятся настройки сжатия справочной системы.
None – не использовать сжатие.
Maximum – максимальное сжатие (дольше компилируется, но занимает меньше места на диске).
Custom – позволяет выбрать алгоритмы сжатия справочной системы.
Files
Файлы, составляющие справочную систему.
Help File – имя файла справки (*.hlp);
Log File – имя log-файла (отчёт о компиляции справочной системы);
Rich Text Format (RTF) files – RTF-файлы (*.rtf);
Contents file – содержание справочной системы (*.cnt);
FTS (full-text search)
Настройки поисковой системы справки.
Generate full text search index – генерировать содержание поиска по справке. Если этот параметр выбран, то при компиляции справочной системы сгенерируется файл имя_справки.fts, который нужен для текстового поиска. Как правило, этот файл занимает намного больше места на диске, чем сама справка (*.hlp).
Теперь осталось сделать содержание для нашей справочной системы.

Создание содержания

Выберите "File\New/Help Contents" и введите имя и заголовок содержания. При помощи кнопок "Add Above" ("Добавить над") и "Add Below" ("Добавить под") создайте нужные папки (Heading) и пункты содержания (Topic). При добавлении пункта, введите его название в поле "Title", в "Topic ID" – идентификатор раздела справки, на который ссылается этот пункт, в "Help File" – имя файла справки, в котором находится этот раздел. Кнопки "Move Right" и "Move Left" служат для изменения иерархии пунктов. После сохранения содержания, откройте проект справки (*.hpj), нажмите на кнопку "Options", активизируйте закладку "Files" и в поле "Contents file" введите имя файла содержания либо выберите его при помощи кнопки "Browse". Откомпилируйте проект.
На этом создание полноценной справочной системы завершено. Наш маленький, но очень гордый "хелп" имеет удобное содержание и мощную поисковую систему, содержит как текстовую, так и графическую информацию, и даже подписывается при цитировании и распечатке!

Иван Ширко
ishyrko@gmail.com

Постовой: Делайте сайты для людей - услуги копирайтинга

Рубрики: Прочее, Сделай сам | Комментарии (4) »

Караоке в домашних условиях

28.11.2007 от Иван Ширко

Бывают в жизни моменты, когда душа требует песни, притом собственного исполнения. Но обеспечить себе достойное музыкальное сопровождение могут далеко не все, да и слова не всегда вспоминаются в нужный момент. А если и слова знаешь и можешь примерно в тему побренчать на гитаре, то в минуты особого веселья бывает трудновато перемещать непослушные пальцы по грифу в поисках нужного аккорда… Все эти проблемы решает караоке: музыка играет без твоего участия, слова перед глазами, к тому же показывается, когда эти слова нужно петь. Караоке можно организовать по-разному: начиная с сопровождающего оркестра с бегающими перед носом людьми с плакатами с текстом и заканчивая крутым музыкальным автоматов, который даст почувствовать себя талантливым певцом даже при полном отсутствии музыкального слуха. Мы же рассмотрим реализацию караоке на домашнем компьютере в виде специальных программ. Сейчас песни-караоке наиболее часто встречаются в виде файлов *.kar, но бывают, разумеется, и альтернативные форматы. Например, довольно популярным является формат *.st3.
vanBasco's Karaoke Player
Эта программа для проигрывания караоке, несмотря на свою нулевую стоимость и маленький размер, обладает довольно большими возможностями. Присутствуют все основные возможности хорошего аудио-плеера: управление проигрыванием (пауза, перемотка и т.п.), работа с playlist'ами, анализатор спектра. Кроме этого есть и "навороты": притягивание окон (как в Winamp'e), управление скоростью воспроизведения, преобразование караоке в midi-файл, есть даже виртуальное пианино… Правда, программа умеет проигрывать только файлы форматов *.kar и *.mid, но проблему воспроизведения других караошек можно решить при помощи специальных программ-преобразователей. Скачать этот плеер можно здесь: www.vanBasco.com (796 кБ).
Karakan
Этот пакет состоит из двух бесплатных программ:
1) KPlay – служит для воспроизведения караошек в формате *.kar. В отличие от vanBasco's KarPlayer, это очень простенький проигрыватель, который делает только свою основную функцию. В принципе, довольно удобный. На мой взгляд, отображение слов песни у него реализовано даже лучше, чем у вышеописанного конкурента, но возможность перемотки караошки была бы, конечно, не лишней.
2) Karakan – а это уже редактор караошек, точнее не редактор, а создатель, т.к. редактирование готовых *.kar не поддерживается. Караошки создаются на основе midi-файлов, а текст и разметка песни вводятся в формате STF (Song Text Format). С этим форматом легко разобраться после прочтения его описания в системе помощи программы, но всё же создание караоке здесь напоминает создание HTML-документа в Блокноте. Как говорится, дело вкуса, но некая автоматизация всё же не помешала бы…
"Весит" этот пакет 540 кБ – www.geocities.com/takawadanl/karakan.html
VocalJam
Эта программа не похожа на предыдущие. Нет, здесь тоже играет музыка, и нужные слова появляются в нужный момент на экране. И дело даже не в том, что за полную версию программы надо платить, нет… VocalJam не просто даёт возможность спеть какую-нибудь песню, но она может ещё и научить петь и даже выслушать певца, а потом выставить ему оценку за исполнение. Разумеется, никакого сложного анализа пения пользователя не происходит: баллы ставятся лишь за попадание в такт музыке и за правильность высоты пения. Конечно, не очень приятно от компьютера получать нелестные отзывы о своих певческих способностях, поэтому можно в настройках программы отключить вывод всяких комментариев, а оставить одни баллы. Только не забудьте оставить вылючённой для записи все громкости, кроме микрофона, иначе за ваше пение будет приниматься музыка. В демо-версии программы также есть поддержка "скинов" интерфейса, анализатор частот и даже нотная интерпретация песни. Также имеется немаленькая (несколько десятков) подборка популярных композиций, а если понадобится ещё, то зайдите на сайт программы – www.VocalJam.narod.ru. Идея VocalJam хорошая, но мне программа показалась скорее любительской, чем профессиональной разработкой. Демо-версия VocalJam занимает 7.7 МБ.
Когда мне попалась на глаза ещё одна программа для проигрывания караоке – RealOrche – то я понял, что что-то здесь не так. Дело в том, что это практически программы близнецы: одинаковый интерфейс, примерно одинаковые возможности, VocalJam даже не запускается вместе с RealOrche, считая её своей копией, и наоборот! Либо работают над программами одни и те же люди, либо плагиат налицо. На мой взгляд RealOrche выглядит намного профессиональней, чем VocalJam, но если хочется петь русские песни, то придётся выбрать вторую программу, ведь она "сделана в России". Кстати, RealOrche умеет не только проигрывать все популярные форматы караошек, но и редактировать их. Скачать RealOrche можно на сайте программы: www.realorche.com.br, размер, в зависимости от версии, 4-5 МБ.
Где взять караошки?
В большом количестве песни в виде караоке можно найти на www.karaoke.ru. Но если этого окажется мало, то загляните сюда: www.parkov6.narod.ru (иностранные песни) и www.parkov7.narod.ru (русские песни).
Ну что ж, остаётся только пожелать приятных вам песнопений и терпения вашим соседям.
Иван Ширко
ishirko@gmail.com

Рубрики: Прочее | Комментариев нет »