phpDocumentor Wiki için?

3 Cevap php

Benim şirket mediawiki kullanarak son kullanıcı / geliştirici dokümanlar üzerinde çalışıyor. Ben phpdoc (özel fonksiyonlar / yöntemleri için) dışarı tükürmek API docs bir sürü almak istiyorum ve kolay transferi için wiki biçimlendirme var.

PHPDoc gelen wiki biçimlendirme veya wiki çıkışı almak için orada herhangi bir çözüm? Etrafıma baktım ve hiçbir şey bulunamadı.

3 Cevap

PHPDoc gelen Twiki çıktı üretmek için bir yol ararken sadece bu geldi. Ben de bunun için iyi bir çözüm bulamadık ve burada bir proje başladı: http://step2.co.in/content/phpdoc-twiki iş bu başlamak için. Kimse yardım isteyen olursa, lütfen temasa geçin.

PhpDocumentor web sitesi ve documentation HTML ve XML çıkışına göre mümkündür. Daha sonra XML formatı ne bakmak için ilk ihraç etmek isteyebilirsiniz ama MediaWiki yerleşik import özelliklerini kullanarak XML alabilirsiniz. Onlar da büyük miktarda veri aktarmak için XML kullanarak zaman aşımı yol ve veri eklemek SQL sorguları oluşturmak için olanak sağlayan bir alternatif olabilir söz. Ayrıca muhtemelen (SyntaxHighlight GeSHi gibi bir şey) kodunu göstermek için MediaWiki için bir uzantısı gerekir.

Tüm bu gerçekten MediaWiki (yani Wiki sözdizimi kullanarak) ile kullanılabilen bir şey içine phpDocumentor çıkışını dönüştürmek için nasıl açıklamak değildir. Büyük olasılıkla diğer bir sözdizimi dönüştürmek için komut dosyalarını kullanarak olacak. Bu phpDocumentor yoluyla kendi çıkış biçimi yaratma gibi (: DocBook çalışabilir XML olarak çıktısı olsa da) en kolay yoludur görünüyor.

(Kafamın üst kapalı) Bir seçenek MediaWiki inşa API kullanmak ve veri kendinizi göndermektir. (Komut dosyası aracılığıyla, elbette).

Diğer tek yolu PHPDoc kesmek olacaktır, ve o zaman bile, bir şekilde MediaWiki post it olurdu.