diff options
author | Francois Le Fevre - CEA | 2015-03-26 14:30:10 +0000 |
---|---|---|
committer | vincent lorenzo | 2015-03-30 12:17:23 +0000 |
commit | 5c0fa4980f7c74b1d3179f1089376a21aec647a0 (patch) | |
tree | a758130748d58b8a5e67218b47b16f9dd7aed1d0 /plugins/doc | |
parent | ed2b36fe5347eaaf13fadeab0bbccb8fb29acc16 (diff) | |
download | org.eclipse.papyrus-5c0fa4980f7c74b1d3179f1089376a21aec647a0.tar.gz org.eclipse.papyrus-5c0fa4980f7c74b1d3179f1089376a21aec647a0.tar.xz org.eclipse.papyrus-5c0fa4980f7c74b1d3179f1089376a21aec647a0.zip |
Bug 463073: [doc]: create a default template for video, add it to the
documentation and update the children poms to add name and link to the parent pom for centralizing the site elements
Change-Id: I6a408b92523a1ec2401f47a5c3caadf42cabf3bf
Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=463073
Signed-off-by: Francois Le Fevre - CEA <francois.le-fevre@cea.fr>
Diffstat (limited to 'plugins/doc')
38 files changed, 631 insertions, 60 deletions
diff --git a/plugins/doc/.gitattributes b/plugins/doc/.gitattributes new file mode 100644 index 00000000000..9b44f1a6dc1 --- /dev/null +++ b/plugins/doc/.gitattributes @@ -0,0 +1 @@ +*.approj binary diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml index 809bf593963..8edf53b488e 100644 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.cdo.ui.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Cdo UI doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml index 65769807685..64b3f153857 100644 --- a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.copypaste.ui.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -43,6 +43,27 @@ </dependency> </dependencies> </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-publish-plugin</artifactId> + <version>1.1</version> + <configuration> + <!-- checkoutDirectory>${scmPubCheckoutDirectory}</checkoutDirectory --> + <content>${siteMainDirectory}</content> <!-- tryUpdate>true</tryUpdate --> + <scmBranch>gh-pages</scmBranch> + <pubScmUrl>scm:git:git@github.com:flefevre/testpapy.git</pubScmUrl> + </configuration> + <executions> + <execution> + <id>scm-publish</id> + <phase>site-deploy</phase> + <goals> + <goal>publish-scm</goal> + </goals> + </execution> + </executions> + </plugin> </plugins> </build> + <name>Papyrus Copypaste UI doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml index 46c77f656ba..e9351b0e86a 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.dsml.validation.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus DSML Validation doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml index 6d4e31ab6d7..cbb78861046 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml @@ -2,13 +2,14 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.infra.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <name>Papyrus Infra doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml index bd5e05a17b9..00a3f96b4df 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.infra.gmfdiag.common.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Infra GmfDiag Common doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml index 8aca04cfb0c..c2761bfeab4 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.infra.gmfdiag.css.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -46,4 +46,5 @@ </plugin> </plugins> </build> + <name>Papyrus Infra GmfDiag Css doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/build.properties index a886e4fd4a0..898c9bf89ef 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/build.properties @@ -1,7 +1,7 @@ bin.includes = META-INF/,\
about.html,\
- site/mediawiki/,\
+ src/site/mediawiki/,\
plugin.xml,\
- target/generated-eclipse-help/**
+ target/site/generated-eclipse-help/**
src.includes = about.html,\
- site/mediawiki/
+ src/site/mediawiki/
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml index 7797b391971..fc5becd8e94 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml @@ -4,11 +4,11 @@ <extension point="org.eclipse.help.toc"> <toc - file="target/generated-eclipse-help/nattable-main-toc.xml" + file="target/site/generated-eclipse-help/nattable-main-toc.xml" primary="false"> </toc> <toc - file="target/generated-eclipse-help/tablemetamodeldocumentation-toc.xml" + file="target/site/generated-eclipse-help/tablemetamodeldocumentation-toc.xml" primary="false"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml index 31aee60199a..9b7f1dd9700 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.infra.nattable.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -18,8 +18,8 @@ <groupId>org.eclipse.mylyn.docs</groupId> <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> <configuration> - <sourceFolder>site/mediawiki</sourceFolder> - <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <sourceFolder>src/site/mediawiki</sourceFolder> + <outputFolder>${project.build.directory}/site/generated-eclipse-help</outputFolder> <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title--> <multipleOutputFiles>false</multipleOutputFiles> @@ -27,7 +27,7 @@ <formatOutput>true</formatOutput> <htmlFilenameFormat>$1.html</htmlFilenameFormat> <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> - <helpPrefix>target/generated-eclipse-help</helpPrefix> + <helpPrefix>target/site/generated-eclipse-help</helpPrefix> <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls--> @@ -49,4 +49,5 @@ </plugin> </plugins> </build> + <name>Papyrus Infra Nattable doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/nattable-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/nattable-main-toc.xml deleted file mode 100644 index fd52ecd2d1e..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/nattable-main-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Nattable" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="target/generated-eclipse-help/tablemetamodeldocumentation.html" label="Nattable"> - <link toc="target/generated-eclipse-help/tablemetamodeldocumentation-toc.xml"/> - <anchor id="nattable"/> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/nattable-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/nattable-main-toc.xml new file mode 100644 index 00000000000..3ddb87d0940 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/nattable-main-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="Nattable" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic href="target/site/generated-eclipse-help/tablemetamodeldocumentation.html" label="Nattable"> + <link toc="target/site/generated-eclipse-help/tablemetamodeldocumentation-toc.xml"/> + <anchor id="nattable"/> + </topic> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/tablemetamodeldocumentation.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tablemetamodeldocumentation.mediawiki index 385eddec6a4..385eddec6a4 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/tablemetamodeldocumentation.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tablemetamodeldocumentation.mediawiki diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/site.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/site.xml new file mode 100644 index 00000000000..17d21c02ace --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/site.xml @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="Reflow Maven Skin" + xmlns="http://maven.apache.org/DECORATION/1.3.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd"> + + <bannerLeft> + <name><![CDATA[ + Eclipse <span class="color-highlight">Papyrus</span> project + ]]> + </name> + <href>https://www.eclipse.org/papyrus</href> + </bannerLeft> + + <publishDate position="bottom" format="yyyy-MM-dd" /> + <version position="bottom" /> + + <skin> + <groupId>lt.velykis.maven.skins</groupId> + <artifactId>reflow-maven-skin</artifactId> + <version>1.1.1</version> + </skin> + <custom> + <reflowSkin> + <!-- Make this to 'false' for local development, i.e. file:// URLs --> + <protocolRelativeURLs>false</protocolRelativeURLs> + <smoothScroll>true</smoothScroll> + <theme>bootswatch-cosmo</theme> + <highlightJs>true</highlightJs> + <highlightJsTheme>github</highlightJsTheme> + <!-- absoluteResourceURL>http://flefevre.github.io/testpapy/</absoluteResourceURL--> + <brand> + <!-- Brand text in top-left part of the site --> + <name> + <![CDATA[ + Eclipse <span class="color-highlight">Papyrus</span> Project + ]]> + </name> + <href>https://www.eclipse.org/papyrus/</href> + </brand> + <slogan>an integrated and user-consumable environment for editing any kind of EMF model (UML, SysML, MARTE...)</slogan> + <titleTemplate>%2$s | %1$s</titleTemplate> + <!-- Use Table of Contents at the top of the page (max 6 elements) --> + <toc>top</toc> + <tocTopMax>6</tocTopMax> + <!-- Include the documentation and tools in the top navigation (in addition to links) --> + <topNav>Main|reports|modules|parent</topNav> + <!-- Split menus in the bottom navigation --> + <bottomNav maxSpan="9" > + <column>Main</column> + <column>Download</column> + <column>reports|modules|parent</column> + </bottomNav> + <bottomDescription> + <![CDATA[ + Eclipse <span class="color-highlight">Papyrus</span> project is aiming at providing an ntegrated and user-consumable environment for editing any kind of EMF model and particularly supporting UML and related modeling languages such as SysML and MARTE. + ]]> + </bottomDescription> + <pages> + <index project="doc"> + <!-- Override the title --> + <titleTemplate>Papyrus</titleTemplate> + <!-- no breadcrumbs on the main index page --> + <breadcrumbs>false</breadcrumbs> + <!-- no ToC on the main index page --> + <toc>false</toc> + <markPageHeader>false</markPageHeader> + <sections> + <!-- carousel /--> + <columns>2</columns> + <body /> + <sidebar /> + </sections> + </index> + <contribute> + <breadcrumbs>false</breadcrumbs> + </contribute> + <!-- Disable source highlighting for Maven reports --> + <source-repository> + <highlightJs>false</highlightJs> + </source-repository> + <issue-tracking> + <highlightJs>false</highlightJs> + <toc>false</toc> + </issue-tracking> + <license> + <highlightJs>false</highlightJs> + <toc>false</toc> + </license> + <!-- Disable ToC for some Maven reports --> + <project-info> + <toc>false</toc> + </project-info> + <!-- github-report> + <toc>false</toc> + </github-report--> + <dependencies> + <tocTopMax>4</tocTopMax> + </dependencies> + </pages> + </reflowSkin> + </custom> + + <body> + + <links> + <item name="Online" href="http://www.eclipse.org/papyrus" /> + <item name="Nexus repository" href="https://repo.eclipse.org/index.html#welcome" /> + <item name="Pdf" href="org.eclipse.papyrus.infra.nattable.doc.pdf" /> + </links> + + <breadcrumbs> + <item name="doc" href="/" /> + </breadcrumbs> + + <menu name="Main" inherit="top"> + <item name="Index" href="index.html" /> + <item name="Table" href="generated-eclipse-help/tablemetamodeldocumentation.html" /> + </menu> + <menu name="Maven documentation" ref="reports" inherit="bottom"/> + <menu ref="modules" inherit="top" /> + <menu ref="parent" inherit="top" /> + </body> +</project> diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/xdoc/index.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/xdoc/index.xml new file mode 100644 index 00000000000..5dd66fbc945 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/xdoc/index.xml @@ -0,0 +1,18 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> + + <properties> + <title>nattable</title> + </properties> + + <body> + <section name="Nattable for developers"> + <p>section dedicated for developers</p> + <subsection name="Context"> + <p><a href="generated-eclipse-help/tablemetamodeldocumentation.html">table metamodel</a> documentation</p> + <iframe frameborder="0" scrolling="auto" src="generated-eclipse-help/tablemetamodeldocumentation.html" height="300" width="100%"></iframe> + </subsection> + </section> + </body> +</document>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml index 9a5eeb4818f..3f4d4690c8a 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.infra.newchild.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Infra Newchild doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml index a168bf5308d..de7a5e141aa 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml @@ -2,10 +2,10 @@ <project>
<modelVersion>4.0.0</modelVersion>
<parent>
- <artifactId>org.eclipse.papyrus</artifactId>
+ <artifactId>org.eclipse.papyrus.plugins.doc</artifactId>
<groupId>org.eclipse.papyrus</groupId>
<version>1.1.0-SNAPSHOT</version>
- <relativePath>../../../releng/top-pom-main.xml</relativePath>
+ <relativePath>../pom.xml</relativePath>
</parent>
<artifactId>org.eclipse.papyrus.infra.services.controlmode.doc</artifactId>
<groupId>org.eclipse.papyrus</groupId>
@@ -44,4 +44,5 @@ </plugin>
</plugins>
</build>
-</project>
\ No newline at end of file + <name>Papyrus Infra Services ControlMode doc</name>
+</project> diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml index afbe390a86e..52160013af1 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.infra.viewpoints.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Infra Viewpoints doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml index 8e8b904d569..16fd3891479 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.layers.documentation</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Layers doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml index 529edaa8f25..5627afac1bc 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.moka.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Moka doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath index c93a9d1e930..14129a12bff 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath @@ -1,7 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <classpath> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.7"/> <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> - <classpathentry kind="src" path="src"/> - <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/> <classpathentry kind="output" path="target/classes"/> </classpath> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml index d342d418c81..2a1674a0c54 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.req.reqif.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Req Reqif doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml index 9d39cd3b8e1..ddfa72dca07 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.decoratormodel.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Uml DecoratorModel doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml index f341b4b07e9..afbe90e465e 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.diagram.common.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Uml Diagram Common doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml index c4bcaf3199b..e287f0914b4 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.diagram.profile.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Uml Diagram profile doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml index cce56e6c28b..0d636ebd4cd 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Uml doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml index 8149aa705a7..2fa5230cdbb 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.modelrepair.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus ModelRepair doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml index c55f70be75e..22aa0fa8a51 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.profile.assistants.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Uml Profile Assistants doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml index a855dedce90..89360598289 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.uml.search.ui.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Uml Search UI doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml index da9b0400e6e..f85be6be046 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml @@ -2,10 +2,10 @@ <project> <modelVersion>4.0.0</modelVersion> <parent> - <artifactId>org.eclipse.papyrus</artifactId> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> - <relativePath>../../../releng/top-pom-main.xml</relativePath> + <relativePath>../pom.xml</relativePath> </parent> <artifactId>org.eclipse.papyrus.views.properties.doc</artifactId> <groupId>org.eclipse.papyrus</groupId> @@ -45,4 +45,5 @@ </plugin> </plugins> </build> + <name>Papyrus Views Properties doc</name> </project>
\ No newline at end of file diff --git a/plugins/doc/pom.xml b/plugins/doc/pom.xml index ce1cdda668b..816446d9057 100644 --- a/plugins/doc/pom.xml +++ b/plugins/doc/pom.xml @@ -33,4 +33,175 @@ <module>org.eclipse.papyrus.views.properties.doc</module> </modules> + <description>Maven plugin dedicated to generate developer documentation through a dedicated website and pdf files.</description> + + <!-- mvn clean site site:stage-deploy scm-publish:publish-scm --> + <properties> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <siteMainDirectory>${user.home}/staging</siteMainDirectory> + </properties> + + <issueManagement> + <url>https://bugs.eclipse.org/bugs</url> + <system>Eclipse Bugzilla Issues</system> + </issueManagement> + + <distributionManagement> + <repository> + <id>repo.eclipse.org</id> + <name>Papyrus + Repository - Releases + </name> + <url>https://repo.eclipse.org/content/repositories/papyrus-releases/ + </url> + </repository> + <snapshotRepository> + <id>repo.eclipse.org</id> + <name>Papyrus + Repository - Snapshots + </name> + <url>https://repo.eclipse.org/content/repositories/papyrus-snapshots/ + </url> + <uniqueVersion>true</uniqueVersion> + </snapshotRepository> + <site> + <id>my.git.server</id> + <url>scm:git:git@github.com/flefevre/testpapy.git</url> + </site> + </distributionManagement> + + <licenses> + <license> + <name>Eclipse Public License</name> + <url>https://www.eclipse.org/legal/epl-v10.html</url> + <distribution>repo</distribution> + </license> + </licenses> + + <scm> + <url>https://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git</url> + <connection>scm:git:git://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git</connection> + <!-- developerConnection>scm:ssh://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git</developerConnection --> + </scm> + + <build> + <plugins> + <!-- plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-scm-plugin</artifactId> + <version>1.5</version> <configuration> <connectionType>connection</connectionType> + </configuration> </plugin --> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>buildnumber-maven-plugin</artifactId> + <version>1.3</version> + <executions> + <execution> + <phase>pre-site</phase> + <goals> + <goal>create</goal> + </goals> + <configuration> + <doCheck>false</doCheck> + <doUpdate>false</doUpdate> + <format>{0,date,yyyy-MM-dd_HH-mm}</format> + <items> + <item>timestamp</item> + </items> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-site-plugin</artifactId> + <version>3.3</version> + <configuration> + <skipDeploy>false</skipDeploy> + <stagingSiteURL>file://${siteMainDirectory}</stagingSiteURL> + </configuration> + <!-- executions> <execution> <id>stage-for-scm-publish</id> <phase>post-site</phase> + <goals> <goal>stage</goal> </goals> </execution> </executions --> + <dependencies> + <dependency> + <groupId>lt.velykis.maven.skins</groupId> + <artifactId>reflow-velocity-tools</artifactId> + <version>1.1.1</version> + </dependency> + <dependency> + <groupId>org.apache.velocity</groupId> + <artifactId>velocity</artifactId> + <version>1.7</version> + </dependency> + </dependencies> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-scm-publish-plugin</artifactId> + <version>1.1</version> + <configuration> + <!-- checkoutDirectory>${scmPubCheckoutDirectory}</checkoutDirectory --> + <content>${siteMainDirectory}</content> <!-- tryUpdate>true</tryUpdate --> + <!-- content>target/site</content --> + <!-- content>${stagingDirectory}</content --> + <scmBranch>gh-pages</scmBranch> + <pubScmUrl>scm:git:git@github.com:flefevre/testpapy.git</pubScmUrl> + </configuration> + <executions> + <execution> + <id>scm-publish</id> + <phase>site-deploy</phase> + <goals> + <goal>publish-scm</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-pdf-plugin</artifactId> + <version>1.3</version> + <executions> + <execution> + <id>pdf</id> + <phase>site</phase> + <goals> + <goal>pdf</goal> + </goals> + <configuration> + <outputDirectory>${project.reporting.outputDirectory}</outputDirectory> + <includeReports>false</includeReports> + <docDescriptor>src/site/pdf/main.pdf.xml</docDescriptor> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.10.2</version> + <configuration> + <show>private</show> + <!-- nohelp>true</nohelp --> + </configuration> + </plugin> + </plugins> + </build> + <reporting> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>2.8</version> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-javadoc-plugin</artifactId> + <version>2.10.2</version> + <configuration> + <!-- stylesheetfile>${basedir}/src/main/javadoc/stylesheet.css</stylesheetfile --> + <!-- show>public</show --> + </configuration> + </plugin> + </plugins> + </reporting> + </project>
\ No newline at end of file diff --git a/plugins/doc/src/site/pdf/main.pdf.xml b/plugins/doc/src/site/pdf/main.pdf.xml new file mode 100644 index 00000000000..0686797c6f3 --- /dev/null +++ b/plugins/doc/src/site/pdf/main.pdf.xml @@ -0,0 +1,25 @@ +<document xmlns="http://maven.apache.org/DOCUMENT/1.0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/DOCUMENT/1.0.1 http://maven.apache.org/xsd/document-1.0.1.xsd" + outputName="org.eclipse.papyrus.developer.doc"> + + <meta> + <title>Papyrus Main Developer Documentation</title> + <author>CEA LISE</author> + </meta> + + <toc name="Table of Contents"> + <item name="Home" ref="home.html"/> + <item name="Video" ref="video.html"/> + </toc> + + <cover> + <coverTitle>${project.name}</coverTitle> + <coverSubTitle>v. ${project.version} build ${buildNumber}</coverSubTitle> + <coverType>Developer Documentation</coverType> + <projectName>${project.name}</projectName> + <projectLogo>./images/papyrus.png</projectLogo> + <companyName>Eclipse</companyName> + <companyLogo>./images/eclipse-800x188.png</companyLogo> + </cover> +</document>
\ No newline at end of file diff --git a/plugins/doc/src/site/resources/images/eclipse-800x188.png b/plugins/doc/src/site/resources/images/eclipse-800x188.png Binary files differnew file mode 100644 index 00000000000..0c469529da5 --- /dev/null +++ b/plugins/doc/src/site/resources/images/eclipse-800x188.png diff --git a/plugins/doc/src/site/resources/images/papyrus.png b/plugins/doc/src/site/resources/images/papyrus.png Binary files differnew file mode 100644 index 00000000000..edf2a1c9a32 --- /dev/null +++ b/plugins/doc/src/site/resources/images/papyrus.png diff --git a/plugins/doc/src/site/resources/template/Papyrus_Template.approj b/plugins/doc/src/site/resources/template/Papyrus_Template.approj Binary files differnew file mode 100755 index 00000000000..684b4a9c280 --- /dev/null +++ b/plugins/doc/src/site/resources/template/Papyrus_Template.approj diff --git a/plugins/doc/src/site/site.xml b/plugins/doc/src/site/site.xml new file mode 100644 index 00000000000..1d21f2f224d --- /dev/null +++ b/plugins/doc/src/site/site.xml @@ -0,0 +1,124 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project name="Reflow Maven Skin" + xmlns="http://maven.apache.org/DECORATION/1.3.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/DECORATION/1.3.0 http://maven.apache.org/xsd/decoration-1.3.0.xsd"> + + <bannerLeft> + <name><![CDATA[ + Eclipse <span class="color-highlight">Papyrus</span> project + ]]> + </name> + <href>https://www.eclipse.org/papyrus</href> + </bannerLeft> + + <publishDate position="bottom" format="yyyy-MM-dd" /> + <version position="bottom" /> + <googleAnalyticsAccountId>UA-1402675-6</googleAnalyticsAccountId> + + <skin> + <groupId>lt.velykis.maven.skins</groupId> + <artifactId>reflow-maven-skin</artifactId> + <version>1.1.1</version> + </skin> + <custom> + <reflowSkin> + <!-- Make this to 'false' for local development, i.e. file:// URLs --> + <protocolRelativeURLs>false</protocolRelativeURLs> + <smoothScroll>true</smoothScroll> + <theme>bootswatch-cosmo</theme> + <highlightJs>true</highlightJs> + <highlightJsTheme>github</highlightJsTheme> + <!-- absoluteResourceURL>http://flefevre.github.io/testpapy/</absoluteResourceURL--> + <brand> + <!-- Brand text in top-left part of the site --> + <name> + <![CDATA[ + Eclipse <span class="color-highlight">Papyrus</span> Project + ]]> + </name> + <href>https://www.eclipse.org/papyrus/</href> + </brand> + <slogan>an integrated and user-consumable environment for editing any kind of EMF model (UML, SysML, MARTE...)</slogan> + <titleTemplate>%2$s | %1$s</titleTemplate> + <!-- Use Table of Contents at the top of the page (max 6 elements) --> + <toc>top</toc> + <tocTopMax>6</tocTopMax> + <!-- Include the documentation and tools in the top navigation (in addition to links) --> + <topNav>Main|reports|modules|parent</topNav> + <!-- Split menus in the bottom navigation --> + <bottomNav maxSpan="9" > + <column>Main</column> + <column>Download</column> + <column>reports|modules|parent</column> + </bottomNav> + <bottomDescription> + <![CDATA[ + Eclipse <span class="color-highlight">Papyrus</span> project is aiming at providing an ntegrated and user-consumable environment for editing any kind of EMF model and particularly supporting UML and related modeling languages such as SysML and MARTE. + ]]> + </bottomDescription> + <pages> + <index project="doc"> + <!-- Override the title --> + <titleTemplate>Papyrus</titleTemplate> + <!-- no breadcrumbs on the main index page --> + <breadcrumbs>false</breadcrumbs> + <!-- no ToC on the main index page --> + <toc>false</toc> + <markPageHeader>false</markPageHeader> + <sections> + <!-- carousel /--> + <columns>2</columns> + <body /> + <sidebar /> + </sections> + </index> + <contribute> + <breadcrumbs>false</breadcrumbs> + </contribute> + <!-- Disable source highlighting for Maven reports --> + <source-repository> + <highlightJs>false</highlightJs> + </source-repository> + <issue-tracking> + <highlightJs>false</highlightJs> + <toc>false</toc> + </issue-tracking> + <license> + <highlightJs>false</highlightJs> + <toc>false</toc> + </license> + <!-- Disable ToC for some Maven reports --> + <project-info> + <toc>false</toc> + </project-info> + <!-- github-report> + <toc>false</toc> + </github-report--> + <dependencies> + <tocTopMax>4</tocTopMax> + </dependencies> + </pages> + </reflowSkin> + </custom> + + <body> + + <links> + <item name="Online" href="http://www.eclipse.org/papyrus" /> + <item name="Nexus repository" href="https://repo.eclipse.org/index.html#welcome" /> + </links> + + <breadcrumbs> + <item name="doc" href="/" /> + </breadcrumbs> + + <menu name="Main" inherit="top"> + <item name="Index" href="index.html" /> + <item name="Video" href="video.html" /> + </menu> + <menu name="Maven documentation" ref="reports" inherit="bottom"/> + <menu ref="modules" inherit="top" /> + <menu ref="parent" inherit="top" /> + </body> +</project> diff --git a/plugins/doc/src/site/xdoc/index.xml b/plugins/doc/src/site/xdoc/index.xml new file mode 100644 index 00000000000..a03cbf55a81 --- /dev/null +++ b/plugins/doc/src/site/xdoc/index.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> + + <properties> + <title>Papyrus Developer Documentation</title> + </properties> + + <body> + <section name="Documentation generation"> + <subsection name="Javadoc generation defined in plugin section"> + <source>mvn javadoc:javadoc</source> + </subsection> + <subsection name="Web site generation with javadoc defined in report section"> + <source>mvn site:site</source> + </subsection> + <subsection name="Pdf generation"> + <source>mvn pdf:pdf</source> + </subsection> + </section> + <section name="Documentation publication"> + <subsection name="Web site publication"> + <p>On Hudson server, you can execute a build that will execute the following command</p> + <source>mvn clean site site:stage-deploy scm-publish:publish-scm</source> + </subsection> + <subsection name="Video publication"> + <p>Have a look to this <a href="video.html">tutorial</a></p> + </subsection> + </section> + </body> +</document>
\ No newline at end of file diff --git a/plugins/doc/src/site/xdoc/video.xml b/plugins/doc/src/site/xdoc/video.xml new file mode 100644 index 00000000000..08ad0a1d236 --- /dev/null +++ b/plugins/doc/src/site/xdoc/video.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd"> + + <properties> + <title>Video Tutorial</title> + </properties> + + <body> + + <section name="Video"> + <subsection name="Purpose"> + <p>In order to enhance the communauty and the diffusion of Papyrus, + new features and enhancements should be documented through a small + video uploaded to youtube channel. + </p> + </subsection> + <subsection name="Pre-requis"> + <p>Download the free version of Active presenter: + http://atomisystems.com/activepresenter/ + </p> + <p> + Use the + <a href="template/Papyrus_Template.approj">template</a> + </p> + </subsection> + <subsection name="Processus"> + <p>Edit the project properties: Add the description and the name of the project</p> + <p>Upload the video to youtube: make it with a committer to access the password/login</p> + <p>Diffuse it: mail to the mailing list and post a tweet on the papyrus twetter account</p> + </subsection> + <subsection name="Advices"> + <p>Make it shorter than 2 minutes</p> + </subsection> + </section> + </body> +</document>
\ No newline at end of file |