Re: Есть ли возможность д елать предварительный просмотр
| From: | Alexey Shein | Date: | Mon, 01 Aug 2011 14:03:36 +0000 |
| Subject: | Re: Есть ли возможность д елать предварительный просмотр | ||
| References: | 1 | Groups: | php.doc.ru |
| Request: | Send a blank email to doc-ru+get-2029@lists.php.net to get a copy of this message | ||
Привет!
Есть возможность сгенерировать выходные файлы в
нескольких форматах,
проще всего это сделать в html-формате, но также можно и в
php-формате
(в этом случае у вас получается локальная копия сайта
php.net).
Должен сразу предупредить, что это потребует
некоторых усилий.
Для начала вам нужно скачать репозиторий локально, как
описано в
статье:http://habrahabr.ru/blogs/php/125341/ в
разделе "Альтернатива".
Далее нужно установить Phd: http://doc.php.net/phd/docs/ - это
утилита, используемая в самом PHP для генерации
документации (Php
Docbook Renderer).
Проще всего это сделать через pear:
$ pear install doc.php.net/phd
$ pear install doc.php.net/phd_php
Phd нужен модуль php-sqlite, так что его нужно установить
заранее,
иначе ничего не получится.
После того как phd установится, нужно собрать билд:
$ php doc-base/configure.php --with-lang=ru
В случае успешного билда должно быть выведено
сообщение All good.
Saving .manual.xml… done.
Если вывелось Don’t worry, Happ shittens, значит, вы допустили
ошибку
и ее нужно исправить.
Далее можно генерировать саму документацию. Для этого
нужно указать команду
$ phd -d doc-base/.manual.xml -P PHP -f xhtml
Если все сработало верно, то у вас в консоли должен
идти лог действий
Phd, генерация занимает около 5 минут. Что-то вроде этого:
[18:56:23 - Rendering Style ] Running full build
[18:56:23 - Indexing ] Indexing...
[18:58:14 - Indexing ] Indexing done
[18:58:15 - Rendering Style ] Running full build
[18:58:15 - Rendering Format ] Starting PHP-Web rendering
[19:01:30 - Rendering Format ] Writing search indexes..
[19:01:30 - Rendering Format ] Index written
[19:01:30 - Rendering Format ] Finished rendering
BUILD FINISHED
Total time: 6 minutes 15.92 seconds
По окончании генерации должна появиться папка output, в
которой уже
будут сгенерированы готовые html-файлы, которые уже
можно смотреть
браузером.
Список всех поддерживаемых форматов Phd можно
посмотреть командой
$ phd -l
Удачи!
1 августа 2011 г. 18:08 пользователь Dmitriy Pakhtinov
<ex.devote@gmail.com> написал:
> Есть ли возможность делать предварительный
> просмотр того что я
> перевел, в локальной версии. То-есть XML это не HTML так
> просто в
> браузере его не посмотреть, хотелось бы видеть то
> что делаю.
>
> Заранее Спасибо!
>
--
Regards,
Shein Alexey