По роду своей службы я очень часто пользуюсь справкой по PostgreSQL, начиная с 8.х версий. И если раньше на странице документации сайта можно было найти для скачивания CHM файл справки, то для версии 9.0 (полагаю, что и далее) такой возможности нет.

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

Мой хороший друг, страстный любитель Perl'a и по совместительству хабраюзер habazlam взялся за создание утилиты, способной из набора html/sgml файлов, что поставляются в исходниках с сервером, скомпилировать справку в CHM формате. Удалось ему это на славу. Единственное, что требует доработки, — это Индексы (поиск по ключевым словам). Однако даже без этого пользоваться таким мануалом во сто крат удобней, нежели онлайн аналогом.

Для всех страждущих линк: postgresql-9.0.chm

UPD: Главный цимус CHM формата для 1036-темных мануалов — это полнотекстовый индекс, без которого Донцову читать в самый раз, а мануалищще постгрессовый — чокнешься! ©habazlam

UPD: У кого не получается запустить файл, правой кнопкой на нём, затем Properties -> Unlock. Проблема CHM файла, «скачанного из интернета». Моя вина — надо было в архив положить.

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

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

Предположим, что у нас готова или почти готова некоторая .NET библиотека для разработчиков (они же конечные пользователи). API библиотеки безупречен, количество багов впечатляюще мало, да и вообще это не библиотека, а просто кладезь совершенного кода. Дело за малым – объяснить пользователям, как работать с этим замечательным продуктом.

Есть разные подходы к написанию документации. Некоторые команды предпочитают начинать создание документации в момент начала создания продукта. Другие откладывают написание мануалов на окончание работ. В некоторых командах документацию пишут специальные люди, которые ходят от разработчика к разработчику и от менеджера к менеджеру, аккумулируя знания о продукте. Во многих небольших командах таких специальных людей нет, а потому документацию часто пишет разработчик или разработчики. Кто-то использует сторонние средства вроде Help & Manual, в которых, как в заправском текстовом редакторе, можно создавать очень сложную верстку и на выходе получать документацию в многообразии форматов. Многие используют другой подход, широко пропагандируемый в последнее время – написание документации прямо в коде программы/библиотеки.

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

• Быстрый поиск. Достаточно приписать к адресу мануала запрос. Например, http://manual.pohape.ru/str_replace
• Кнопки «Назад» и «Печать»
• Иерархические ссылки к каждой странице. Например, зайдя на страницу с описанием числа pi, можно быстро перейти на её родительские страницы: функции и математические функции
• Был подправлен css страниц мануала, выкинуто лишнее, теперь они больше «дышат»
• Suggest в списке функций был переписан. Теперь нету неприятных косяков, да и некоторые браузеры могут работать быстрее

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

• Дизайн в стиле chm-справки понравится тем, кто успел привыкнуть к такой версии в ОС Windows
• Английская версия мануала вмещает больше статей, чем её chm-аналог
• Русская версия вообще стала раритетом, так как её более полугода назад убрали с php.net. В мануале же она присутствует.
• Нет проблем с русским языком в интерфейсе, какие наблюдались с chm-файле
• Для каждой страницы присутствуют комментарии с сайта php.net

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

Пользуйтесь на здоровье, адрес прежний: http://manual.pohape.ru/

Уже пару лет использую Notepad++ в качестве основного текстового редактора. До него была ColdFusion Studio 4.5.2, которая очень даже устраивала. Вот только она небесплатная и несколько тяжеловесная. Лицензионнной Студии нынче у меня нет, а пользоваться варезом при наличии фришных альтернатив давно кажется мне неправильным. Кроме того, ломалка к Студии (loader) определяется антивирусами как малварь (разбираться желания не было, к тому же антивирусы вечно норовят этот лоадер снести, что не добавляет комфорта в работе). Переходить на всякие варианты на базе Eclipse желания не было и нет: терпеть не могу тяжеловесный софт. По совету друзей попробовал Notepad++ aka NPP, понравилось. Особенно порадовало, что несколькими движениями NPP превращается в близкое подобие любимой CFStudio. Время от времени пробовал ряд других редакторов (например, несколько из этого списка: http://en.wikipedia.org/wiki/Comparison_of_text_editors), ничто не приглянулось. Вернулся к уже привычному Notepad Plus Plus.

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

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

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

1. Плагин Explorer, чтобы ходить по файловой системе, не вылезая из NPP (привык в CFStudio, удобно)
2. Клавиатурные шорткаты для часто используемых конструкций вроде   и HTML-тегов.
3. Подсветка синтаксиса (мне нужен синтаксис CFML, помимо прочих).
   
4. Контекстная справка (по тому же CFML).
   
5. Автоматическое закрытие тегов.
   

Альтернативный мануал к PHP обновился. Напомню, он хорош для тех PHP-разработчиков, кто привык пользоваться chm-версией справочника, ведь он решает некоторые проблемы:

• Корректная кодировка русскоязычных разделов
• Решение проблем с открытием chm-файлов под Линуксом и Макосью

Хотя наплыв пользователей одной известной операционной системы компании «Майкрософт» показал, что мануал приглянулся не только целевой аудитории.

В новой версии произошли довольно полезные изменения:

• К каждому разделу справочника теперь прикреплены полезные комментарии с сайта php.net, которые просили хабраузеры в своё время
• Добавились быстрые ссылки на конкретные разделы для обмена с друзьями
• Английская версия мануала обновилась до версии PHP 5.3. На сайте php.net с некоторых пор русская документация отсутствует. Я решил оставить её, зато по дефолту сделал открытие английской версии, в любом случае это настраивается
• Переезд на новый хостинг и сжатие данных дало прирост в скорости открытия

http://manual.pohape.ru

Пользуйтесь за здоровье, все фючер реквесты приму с удовольствием.

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

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

• xchm (cross-platform)
• gnochm (Gnome)
• kchmviewer (KDE)
• upd: chmsee
• upd: okular
• upd: плагин для Firefox

Итак, все программы прошли простое испытание на прочность и лидер показал свое лицо.

Так уж получилось, что я люблю читать книги в электронном формате. И достаточно много книг у меня в формате Compiled HTML Help. Довольно давно столкнулся с проблемой, когда необходимые мне файлы *.chm отказывались открываться. Они то открываются, но не отображают содержимое, хотя меню работает

то не открываются вовсе


Сначала я предположил, что файлы могут быть битыми, ведь все скачивались с интернета. Но распаковка файлов из CHM проходила успешно, а следовательно ошибку нужно было искать в другом месте.
Не долго думая, я попробовал дать неоткрывающемуся файлу более простое имя, как то C:\1.chm, и оказалось, что это решает проблему — файлы открываются. Т.е. я попал в точку, проблема в имени файла. Но какая?
После изучения имён всех проблемных файлов выяснилось, что это почти все книги по C Sharp, а если быть более точным, то по C#, т.к. проблему создаёт именно решётка в имени файла… А что такого в этом символе? Я чуть было не лишился пары десятков книг! =)

Но решётка — не единственный источник проблем. С символом решётки в своём имени файлы открываются, но не работают, а вот если встречается последовательность символов ".col", то выдается сообщение, что файл открыть не удаётся.

И кто его знает, что там намудрили разработчики в Microsoft, ибо сторонняя читалка xCHM всё без проблем открывает, и я бы рекомендовал на нее перейти, но есть у нее один большой минус — она не понимает кириллицы в менюшках.

Т.о. если полный путь к файлу в формате .chm содержит символ "#" или последовательность символов ".col", не спешите этот файл удалять, просто переименуйте ;)
Надеюсь, эта информация будет кому-нибудь полезной.

P.S.: проблемы были под Windows XP SP3.
P.P.S.: если Вы знаете о других проблемах, связанных с открытием CHM-файлов, отпишитесь пожалуйста в комментах.

Для тех у кого интернет не всегда под рукой, да и просто для любителей локальных мануалов, я скомпилировал руководство пользователя по CodeIgniter (code-igniter.ru) в отдельный файл chm.

Скачать его можно отсюда: www.iforyou.ru

UPD 1: Добавлена страничка с классом Image Manipulation.
UPD 2: Добавлена страничка с классом Typography.
UPD 3: Удалено выпадающее содержание (то что на Javascript), панель справа теперь в юникоде.
UPD 4: Страница с содержанием теперь в две колонки.
UPD 5: Исправлена ошибка с кодом в одну линию. Теперь код как в оригинале.