| [mdt-papyrus.dev] documentation management |
Dear all, Context Since the demand of Christian regarding the integration of mediawiki/markdown doc generation ine the build (https://bugs.eclipse.org/bugs/show_bug.cgi?id=460946 ), I would like to propose you the review of the following gerrit change (https://git.eclipse.org/r/#/c/43024/). Proposed solution As you can notice, I have created a module dedicated to maintain the documentation: plugins/doc with its own pom.xml but not .project file. Each documentation plugin has its own pom with the call of the org.eclipse.mylyn.wikitext.core.maven maven plugin to generate from the mediawiki files the corresponding html and toc files. This maven plugin plugin is the reference plugin for mediawiki processing, by using it we ensure a full compatibility with Eclipse/mylyn processor, as it is the same one. Configuration Just add the following code snipped in your pom.xml file. You have to describe where are located the mediawiki files (sourceFolder) and where to generate the given html/tocs files (outputFolder). You have to add specific dependencies when you want to process mediawiki, or markdown files. Agreement I have already migrate all documentation plugins. Could you please have a look to yours to assert I didn’t miss anything? à https://git.eclipse.org/r/#/c/43024/ Have a good day. Francois, from papyrus team. References More documentation could be found here http://help.eclipse.org/luna/index.jsp?topic=%2Forg.eclipse.mylyn.wikitext.help.ui%2Fhelp%2FMarkup-Generation.html Code <plugin> <groupId>org.eclipse.mylyn.docs</groupId> <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> <configuration> <sourceFolder>resource</sourceFolder> <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> <multipleOutputFiles>false</multipleOutputFiles> <navigationImages>true</navigationImages> <formatOutput>true</formatOutput> <htmlFilenameFormat>$1.html</htmlFilenameFormat> <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> <helpPrefix>target/generated-eclipse-help</helpPrefix> <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> </configuration> <executions> <execution> <goals> <goal>eclipse-help</goal> </goals> </execution> </executions> <dependencies> <dependency> <groupId>org.eclipse.mylyn.docs</groupId> <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> <version>${mylyn.wikitext.version}</version> </dependency> </dependencies> </plugin> François Le Fèvre Institut CARNOT CEA LIST – Nano INNOV CEA Tech/DILS/Laboratoire d’Ingénierie dirigée par les modèles pour les Systèmes Embarqués (LISE), Point Courrier n°174 91191 Gif sur Yvette CEDEX T :0169084986 @ :francois.le-fevre@xxxxxx - LISE: http://www-list.cea.fr/fr/ingenierie-logiciel-et-systeme Papyrus: https://www.eclipse.org/papyrus/ Blog: http://biocamp.blogspot.fr/ |
Attachment:
smime.p7s
Description: S/MIME cryptographic signature