Blog. Just Blog

Плагин Open PHP Documentation для Sublime Text

Версия для печати Добавить в Избранное Отправить на E-Mail | Категория: Мои программы | Автор: ManHunter
Плагин Open PHP Documentation для Sublime Text
Плагин Open PHP Documentation для Sublime Text

Плагин предназначен для получения контекстной справки по функциям PHP. Поддерживается только Windows-версия Sublime Text, так как для работы с файлом справки в плагине используется программа HtmlHelp Wrapper. Через настройки плагина вы можете по мере надобности скачивать актуальную версию документации или настроить автообновление при каждом запуске Sublime Text.

Краткая инструкция по установке плагина:
  1. Распакуйте архив с плагином в папку редактора \Data\Packages с сохранением структуры каталогов.
  2. Скачайте файл php_manual_??.chm на нужном языке с официального сайта PHP.
  3. Распакуйте скачанный файл в папку с установленным плагином и переименуйте его в php_manual.chm
  4. Настройте в свойствах редактора нужную комбинацию клавиш на вызов справки, например:
    { "keys": ["ctrl+f1"], "command": "open_php_documentation" }
Если используете расширение Package Control, то добавьте в него ссылку на мой репозиторий и устанавливайте расширение Open PHP Documentation через него. В этом случае все следующие обновления плагина будут устанавливаться автоматически. Репозиторий:

https://www.manhunter.ru/autoupdate/packages.json
После установки плагина переместите курсор в окне редактора на название нужной функции PHP и нажмите выбранную комбинацию клавиш. Если все сделано правильно, то откроется файл справки на странице с описанием функции.

Плагин Open PHP Documentation для Sublime TextПлагин Open PHP Documentation для Sublime Text

Open.PHP.Documentation.Plugin.for.Sublime.Text.zip (8,827 bytes)


Поделиться ссылкой ВКонтакте
Просмотров: 13120 | Комментариев: 36

Метки: Sublime Text
Внимание! Статья опубликована больше года назад, информация могла устареть!

Комментарии

Отзывы посетителей сайта о статье
Александр (07.04.2022 в 10:43):
ManHunter, моя ошибка, думал в прикрепленном архиве к статье лежит все свежее. После того как враппер сменил, все стало как надо. Спасибо
ManHunter (07.04.2022 в 10:30):
Я что, пишу как-то непонятно? Враппер htmlhelp должен быть версии 2.2, тогда окно справки будет открываться так, как оно было закрыто последний раз.
Александр (07.04.2022 в 10:16):
ManHunter, помнить то он помнит, но разворачивает на весь экран. Если нажать на иконку "свернуть в окно", то да, становится именно там где последний раз закрыли и с теми же размерами.
ManHunter (07.04.2022 в 09:47):
Последняя версия враппера сохраняет размеры окон справки
Александр (07.04.2022 в 09:07):
Хороший плагин. Только при вызове открывается окно на весь экран. Можно ли как то настроить размер окна?
ManHunter (01.12.2021 в 15:46):
Версия 2.5. Добавлена возможность работать со справкой WinAPI в формате CHM, взять ее можно на сайте http://laurencejackson.com/win32/ . Поиск по WinAPI расширен на структуры. Исправлены все необходимые ссылки на https.
ManHunter (09.04.2019 в 14:47):
Очередное обновление. Самая свежая версия враппера.
ManHunter (30.11.2016 в 17:14):
Ценно замечание. Поправил, спасибо! В репе тоже обновил.
Петр (30.11.2016 в 16:54):
Неплохо, но вот на что хотелось бы обратить Ваше внимание:
В файлах плагина, типа, Main.sublime-menu не стоит указывать явно название меню, т.е. "id": "package-settings" и "id": "preferences" <-- этого уже достаточно для того, чтобы редактор указал название меню, ссылаясь на свой основной Default/Main.sublime-menu. К чему такие нюансы? К тому, что стоит к примеру, русифицированное меню и каждый вот такой "явный" способ интеграции выбивает порядок меню, дописывая, к примеру, "Package Settings" или "Preferences". Честно, бесит пиздец как. И после каждого обновления плагина, все по кругу. До Вас, думаю, достучусь, а вот долбоебам из основного репозитория писать бесполезно. А в целом, спасибо, за 3 плагина.
ManHunter (30.11.2016 в 13:25):
Версия 2.4. Обновлен враппер, теперь документация закрывается по Esc. Место хранения файлов по дефолту переназначено в папку пользователя, а не в папку плагина, чтобы не раздувать бэкапы при обновлении плагина через Package Control. Справка автоматически загружается при первом запуске, если файл отсутствует. Прочие доработки и улучшения.
h (18.10.2016 в 19:33):
Премного благодарен. Очень полезный плагин
ManHunter (22.06.2016 в 15:35):
Версия 2.3. Документация обновляется штатными средствами Python, сторонние утилиты больше не используются. Добавлен репозиторий для плагина. Мелкие доработки.
ManHunter (04.05.2016 в 11:14):
На следующей версии будет нормальная репа со всеми релизами.
ManHunter (18.04.2016 в 20:50):
Как вариант, добавить в список пакетов в файле Package Control.sublime-settings строчку "Open PHP Documentation" и/или прописать там же "remove_orphaned": false
citysoul (18.04.2016 в 19:16):
Из консоли ST3:
---
Package Control: Removed directory for orphaned package Open PHP Documentation
Package Control: Skipping automatic upgrade, last run at {datetime}, next run at {datetime} or after
reloading Packages/Open PHP Documentation/Open PHP Documentation.sublime-settings
unloading plugin Open PHP Documentation.open_php_documentation
---
1) Кто виноват? Package Control прибивает "осиротевший", по его мнению, пакет. 2) Что делать? :)
ManHunter (24.12.2015 в 09:47):
У меня портативная ST3, скорее всего дело в этом. Инсталлированная версия любит удалять всякое, на ее взгляд, лишнее. С инсталлированной я никогда не работал. Может быть Package Control как-то поможет.
Александр (24.12.2015 в 08:33):
Все сделано правильно, но никакой help не открывается. Кроме того ST3 удаляет папку "Open PHP Documentation" без лишних вопросов.
Есть другие способы инсталлировать этот плагин?
ManHunter (21.12.2015 в 09:03):
Версия 2.2. Теперь автообновление документации PHP выполняется не при каждом запуске редактора, а максимум раз в сутки. Принудительное обновление через меню работает как и раньше.
ManHunter (15.12.2015 в 08:25):
Гвоздь себе в голову забей, тогда трояны перестанут мерещиться.
Роман (15.12.2015 в 04:28):
ТРОЯН в htmlhelp.exe Dr.Web 11 последний
ManHunter (13.05.2015 в 21:40):
Версия 2.1. Добавлена возможность автоапдейта справки PHP при каждом запуске ST (смотрите файл настроек). Мелкая оптимизация кода.
ManHunter (13.03.2015 в 15:22):
Мизантропия на месте, никуда не делась. А полезные предложения можно реализовывать, не вижу в этом противоречия.
VonMI (13.03.2015 в 14:51):
Благодарю.А то мизантропия,мизантропия...:)
Kirill (13.03.2015 в 14:14):
Большое спасибо
ManHunter (13.03.2015 в 11:21):
Версия 2.0. Переписан алгоритм. Добавлена возможность указывать произвольный путь для хранения данных (файлы справки) и ссылку на закачку документации (по умолчанию файл на русском языке). Добавлено обновление документации PHP через вспомогательную утилиту wget. Добавлена поддержка справки по WinAPI для синтаксиса Assembler, для этого поместите файл win32.hlp (Microsoft Win32 Programmer's Reference) в папку со всеми данными плагина. Эта фича была добавлена для личных нужд, поэтому название плагина остается прежним. Полная версия плагина со всеми справками тут: https://yadi.sk/d/fIfNlcu3fDhbo
ManHunter (04.03.2015 в 11:47):
Хорошо, сделаю в ближайшее время.
Kirill (04.03.2015 в 10:59):
Я с собой флешку не ношу. После того как посеял одну хоть и зашифрованную, но важную флешку. Для этого на компах настроил синхронизацию. "То ли лыжи не едут, то ли ..." (короче вы меня поняли), синхронизация дает сбои. Возможно из-за большого размера папки. Хочу максимально убрать лишнее.
ManHunter (04.03.2015 в 09:54):
Сделать не проблема, не могу понять зачем. Ведь с нынешней структурой он прекрасно работает в портативном виде, с флешки, например. Привязка к путям ограничит такую свободу.
Kirill (04.03.2015 в 02:37):
Если Вас не затруднит, добавить в расширение настройку, с путем где будет лежать php_manual.chm и htmlhelp.exe (если не указа, то пусть система ищет файл в PATH и запускает).
ManHunter (05.02.2014 в 16:20):
Больше ни на чем.
al3xey (05.02.2014 в 16:19):
ManHunter, кроме асма на чем пишете приложения для Win?
спасибо!
ManHunter (03.02.2014 в 00:27):
Да, но еще и плагин придется допилить, чтобы он понимал нужный синтаксис. Пока он заточен только на PHP.
SergVic (03.02.2014 в 00:13):
Если я правильно понял  Таким образом можно сделать не только для PHP  но и для любого другого языка  если вместо PHP Documentation    вписать нужный тип документации
леонид (01.02.2014 в 01:58):
неплохо
ManHunter (31.01.2014 в 20:53):
Никому - это имеется в виду тебе? Пиши тоже, у тебя ж голова как Дом Советов, столько полезных навыков, а опытом не делишься :)
Voffka (31.01.2014 в 20:46):
ManHunter, сдаешь... Куча никому не интересных кодов.

Добавить комментарий

Заполните форму для добавления комментария
Имя*:
Текст комментария (не более 2000 символов)*:

*Все поля обязательны для заполнения.
Комментарии, содержащие рекламу, ненормативную лексику, оскорбления и т.п., а также флуд и сообщения не по теме, будут удаляться. Нарушителям может быть заблокирован доступ к сайту.
Наверх
Powered by PCL's Speckled Band Engine 0.2 RC3
© ManHunter / PCL, 2008-2024
При использовании материалов ссылка на сайт обязательна
Время генерации: 0.07 сек. / MySQL: 2 (0.002 сек.) / Память: 4.5 Mb
Наверх