Как создать документацию, готовую для медиа-вики, из комментариев и комментариев xml - PullRequest
4 голосов
/ 22 июня 2011

Может ли кто-нибудь предложить хороший рабочий процесс,

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

может позволить мне включить мою проектную документацию (отражение + комментарии xml) в синтаксис mediawiki, который я затем использовал бы для включения в мою викию команды разработчиков?

Ответы [ 3 ]

3 голосов
/ 20 июля 2011

Будет задействован некоторый ручной труд, но это должно быть выполнимо, используя ресурсы, описанные ниже.

Моей первой мыслью было просто заняться поиском, и я наткнулся на http://www.mediawiki.org/wiki/Alternative_parsers. Кажется, что все эти парсеры берут данные и преобразуют их в XML, а не из XML, также ни один из них не основан на .NET что не может быть супер важным в долгосрочной перспективе, если не было задействовано никакого кодирования. Кто знает, что здесь может быть что-то, на что стоит обратить внимание.

Затем я нашел http://www.mediawiki.org/wiki/Manual:Importing_XML_dumps. Я полагаю, что если вы можете импортировать данные в формате XML, тогда все, что вам действительно нужно знать, - это схема, чтобы вы могли соответствующим образом переформатировать свои данные. Самое лучшее, что есть , - это то, что на этой странице есть ссылка на http://www.mediawiki.org/wiki/Manual:XML_Import_file_manipulation_in_CSharp, пример C # работы с файлами импорта Media Wiki XML Import. Учитывая пример, кажется, что это всего лишь небольшой шаг для создания классов, необходимых для создания необходимого XML с нуля и выгрузки ваших данных. Вот ссылка на официальную документацию схемы: http://www.mediawiki.org/xml/export-0.3.xsd.

В зависимости от того, хотите ли вы написать PHP или нет, появляется другая опция. Вы можете написать расширение XMLTransform, о котором говорилось здесь: http://www.ehartwell.com/TechNotes/MediaWikiXmlExtension.htm. Этот сайт, кажется, говорит, что вы можете сохранить свой XML в его собственном формате и написать собственный лист XSL для отображения содержимого в нужном формате.

Удачи!

1 голос
/ 16 июля 2011

Вы можете использовать sandcastle для создания веб-страницы из вашего исходного кода http://documentation.sandcastle.codeplex.com

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

0 голосов
/ 14 июля 2011

Я бы посмотрел на использование doxygen , чтобы сгенерировать XML , а затем обработать полученный XML (XSLT или инструмент (ы) по вашему выбору) в нечто подходящее для ваших нужд.

Если вы установили graphviz , doxygen может использовать инструмент dot для генерации различных диаграмм .Вот пример (из документов KDE) диаграммы иерархии классов, сгенерированной doxygen: http://api.kde.org/playground-api/graphics-apidocs/cirkuit/src/lib/html/inherits.html

Другая, немного менее яркая (от IBM): http://www.icu -project.org / apiref/icu4c/classUMemory.html

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...