phpDocumentor для вики? - PullRequest
5 голосов
/ 17 марта 2009

Моя компания работает над документами для конечных пользователей / разработчиков, используя mediawiki. Я хотел бы взять много документов API, которые выкладывает phpdoc (для определенных функций / методов), и иметь их в разметке вики для удобства переноса.

Есть ли какие-нибудь решения для получения разметки вики или вывода вики из phpDoc? Я посмотрел вокруг и ничего не нашел.

Ответы [ 3 ]

2 голосов
/ 04 мая 2010

Только что натолкнулся на это, когда искал способ генерировать вывод Twiki из phpDoc. Я не нашел хорошего решения для этого и начал проект здесь: http://step2.co.in/content/phpdoc-twiki, чтобы начать работу над этим. Если кто-то заинтересован в помощи, пожалуйста, свяжитесь с нами.

1 голос
/ 27 марта 2009

По данным сайта PHPDocumentor и их документации Возможен вывод HTML и XML. Затем вы можете импортировать XML, используя встроенные функции import MediaWiki, хотя сначала вы можете захотеть выполнить экспорт, чтобы посмотреть, каков формат XML. Они также упоминают, что использование XML для импорта больших объемов данных может привести к тайм-аутам и иметь альтернативу, которая позволяет создавать запросы SQL для вставки данных. Также вам, вероятно, понадобится расширение для MediaWiki для отображения кода (что-то вроде SyntaxHighlight GeSHi ).

Все это на самом деле не объясняет, как преобразовать вывод PHPDocumentor во что-то, что можно использовать с MediaWiki (то есть с использованием синтаксиса Wiki). Скорее всего, вы будете использовать скрипты для преобразования одного синтаксиса в другой. Похоже, создание собственного формата вывода с помощью PHPDocumentor - самый простой способ (хотя вывод в формате XML: DocBook может работать).

0 голосов
/ 27 марта 2009

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

Единственный другой способ - взломать phpDoc, и даже тогда вам придется как-то публиковать его в MediaWiki.

...