Bug 515771 - [doc] add element for templates

Actions
-adding configuration for xdoc and maven generation
-pdf generation



Change-Id: I9055ef3233ed484e64c96bc6af44cad25a58ee77
Signed-off-by: Francois Le Fevre <francois.le-fevre@cea.fr>

9 files changed, 173 insertions, 11 deletions

diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/pom.xml
index 7d36dc110ec..b4a3a9127e5 100755
--- a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/pom.xml
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/pom.xml
@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 	<parent>
 		<artifactId>org.eclipse.papyrus.plugins-doc</artifactId>
@@ -9,9 +10,9 @@
 	<artifactId>org.eclipse.papyrus.doctemplate.doc</artifactId>
 	<version>0.0.1-SNAPSHOT</version>
 	<packaging>eclipse-plugin</packaging>
-	
+	<name>Papyrus Documentation template</name>
 	<properties>
-			<siteMainDirectory>${user.home}/staging</siteMainDirectory>
+		<siteMainDirectory>${user.home}/staging</siteMainDirectory>
 	</properties>
 
 	<build>
@@ -22,8 +23,7 @@
 				<configuration>
 					<sourceFolder>src/site/mediawiki</sourceFolder>
 					<outputFolder>${project.build.directory}/site/generated-eclipse-help</outputFolder>
-					<!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice>
-					<title>${help.documentTitle}</title-->
+					<!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title -->
 					<multipleOutputFiles>false</multipleOutputFiles>
 					<navigationImages>true</navigationImages>
 					<formatOutput>true</formatOutput>
@@ -31,13 +31,14 @@
 					<xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat>
 					<helpPrefix>target/site/generated-eclipse-help</helpPrefix>
 					<stylesheetUrls>
-						<!-- <param>../css/maven-base.css</param>
-						<param>../css/maven-theme.css</param>
-						<param>../css/site.css</param> -->
+						<!-- <param>../css/maven-base.css</param> <param>../css/maven-theme.css</param> 
+							<param>../css/site.css</param> -->
 					</stylesheetUrls>
 				</configuration>
 				<executions>
 					<execution>
+						<id>sitemediawiki</id>
+						<phase>integration-test</phase>
 						<goals>
 							<goal>eclipse-help</goal>
 						</goals>
@@ -51,8 +52,51 @@
 					</dependency>
 				</dependencies>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-site-plugin</artifactId>
+				<version>3.3</version>
+				<executions>
+					<execution>
+						<id>siteauto</id>
+						<phase>integration-test</phase>
+						<goals>
+							<goal>site</goal>
+						</goals>
+					</execution>
+				</executions>
+				<configuration>
+					<outputDirectory>${project.build.directory}/site/generated-eclipse-help</outputDirectory>
+				</configuration>
+				<dependencies>
+					<dependency>
+						<groupId>org.apache.maven.skins</groupId>
+						<artifactId>maven-fluido-skin</artifactId>
+						<version>1.6</version>
+					</dependency>
+				</dependencies>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-pdf-plugin</artifactId>
+				<version>1.3</version>
+				<executions>
+					<execution>
+						<id>tutos.pdf</id>
+						<phase>install</phase>
+						<goals>
+							<goal>pdf</goal>
+						</goals>
+						<configuration>
+							<outputDirectory>${project.reporting.outputDirectory}/generated-eclipse-help</outputDirectory>
+							<includeReports>false</includeReports>
+							<docDescriptor>src/site/pdf/template.pdf.xml</docDescriptor>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
+
+
 		</plugins>
 	</build>
-	
-	<name>Papyrus Documentation template</name>
 </project>
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/mediawiki/doctemplate-main-toc.xml b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/mediawiki/doctemplate-main-toc.xml
index a365d683bf7..858219e5b4a 100755
--- a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/mediawiki/doctemplate-main-toc.xml
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/mediawiki/doctemplate-main-toc.xml
@@ -3,5 +3,7 @@
    <topic label="Writing Documentation for Papyrus" >
       <link toc="target/site/generated-eclipse-help/doctemplate-toc.xml"/>
       <anchor id="docTemplate"/>
+      <topic href="target/site/generated-eclipse-help/video.html" label="Video">
+      </topic>
    </topic>
-</toc>
\ No newline at end of file
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/pdf/template.pdf.xml b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/pdf/template.pdf.xml
new file mode 100644
index 00000000000..2f6c4823e14
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/pdf/template.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="video.xml">
+
+  <meta>
+    <title>Papyrus Template</title>
+    <author>CEA LISE</author>
+  </meta>
+
+  <toc name="Table of Contents">
+  	<item name="Introduction" ref="index.html"/>
+    <item name="Video" ref="video.html"/>
+  </toc>
+
+  <cover>
+    <coverTitle>Papyrus</coverTitle>
+    <coverSubTitle>v. ${project.version} build ${buildNumber}</coverSubTitle>
+    <coverType>Developer Documentation</coverType>
+    <projectName>Papyrus tutorials</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/org.eclipse.papyrus.doctemplate.doc/src/site/resources/images/eclipse-800x188.png b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/images/eclipse-800x188.png
new file mode 100644
index 00000000000..0c469529da5
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/images/eclipse-800x188.png
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/images/papyrus.png b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/images/papyrus.png
new file mode 100644
index 00000000000..edf2a1c9a32
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/images/papyrus.png
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/template/Papyrus_Template.approj b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/template/Papyrus_Template.approj
new file mode 100755
index 00000000000..684b4a9c280
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/resources/template/Papyrus_Template.approj
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/site.xml b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/site.xml
new file mode 100644
index 00000000000..649e03b115c
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/site.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0"?>
+<project name="${project.name}">
+  <publishDate position="none" />
+  <version position="none"/>
+
+  <skin>
+    <groupId>org.apache.maven.skins</groupId>
+    <artifactId>maven-fluido-skin</artifactId>
+    <version>1.5</version>
+  </skin>
+  <custom>
+    <fluidoSkin>
+      <topBarEnabled>false</topBarEnabled>
+      <sideBarEnabled>false</sideBarEnabled>
+      <skipGenerationDate>true</skipGenerationDate>
+    </fluidoSkin>
+  </custom>
+  <poweredBy>
+    <logo name="" href="" img="" position="none"/>
+  </poweredBy>
+
+
+
+  <body>
+  </body>
+</project>
\ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/xdoc/index.xml b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/xdoc/index.xml
new file mode 100644
index 00000000000..36a1aae46c5
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/xdoc/index.xml
@@ -0,0 +1,28 @@
+<?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">
+			<subsection name="Contexte">
+				<p>Papyrus provides several documentation: the official wiki, the embeded one in Eclipse. Here the following documentation is included in the official git repository within the code. It is mainlyt baed upon the Maven site generator.</p> 
+			</subsection>
+			<subsection name="Commands">
+				<p>Javadoc generation defined in plugin section"</p>
+				<source>mvn javadoc:javadoc</source>
+				<p>"Web site generation with javadoc defined in report section"</p>
+				<source>mvn site:site</source>
+				<p>Pdf generation"</p>
+				<source>mvn pdf:pdf</source>
+			</subsection>
+			<subsection name="Docs">
+				<p>Have a look to tips for video creation <a href="video.html">Video Tips</a></p>
+				<p>Download the pdf <a href="video.xml.pdf">Doc.pdf</a></p>
+			</subsection>
+		</section>
+	</body>
+</document>
\ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/xdoc/video.xml b/plugins/doc/org.eclipse.papyrus.doctemplate.doc/src/site/xdoc/video.xml
new file mode 100644
index 00000000000..da2eeae1474
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.doctemplate.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:
+					<a href="http://atomisystems.com/activepresenter/">http://atomisystems.com/activepresenter/</a>
+				</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