| Re: [mdt-papyrus.dev] About documentation |
|
Hello About documentation, just to remind you about the new process, here the copy/paste of the documentation generation process email send at the beginning of march 2015. The wiki page : https://wiki.eclipse.org/Papyrus_Developer_Guide/Writing_Documentation Do not hesitate to send me precisely any bug related to this. Sincerely, Francois 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> ==== ==== Dear all, May I update the wiki page : https://wiki.eclipse.org/Papyrus_Developer_Guide/Writing_Documentation To reflect the future integration of the mylyn maven plugin to generate at build time the documentation. Bug https://bugs.eclipse.org/bugs/show_bug.cgi?id=460946 The idea is to · show how to integrate the plugin mylyn given the type of wiki used (mediawiki or textile) in the plugin.doc/pom.xml just by adding a code snippet · enforce the following convention on folder tree structure o myplugin.doc § site/resources/images § site/markdown § site/mediawiki Thanks for your comments and advices Francois De : mdt-papyrus.dev-bounces@xxxxxxxxxxx [mailto:mdt-papyrus.dev-bounces@xxxxxxxxxxx] De la part de LETAVERNIER Camille Hi all, The final build for Mars (RC4) is in two days. This leaves us just enough time to complete & review the documentation. There has been a major change in the documentation process some time ago, which has probably not been properly announced. The generation from Wikitext (Mediawiki) to Eclipse Help is now automated during the build. However, this change wasn’t as seamless as it should have been, and some files might have been corrupted in the process. Especially, some image or summary links are now broken. So, please carefully review existing documentation, especially on installed versions of Papyrus. Don’t trust your debug environment: it is more tolerant to errors than the actual product. So be sure to install your documentation plug-in and double-check that everything is present. Camille |
Attachment:
smime.p7s
Description: S/MIME cryptographic signature