diff options
Diffstat (limited to 'plugins/doc')
| -rw-r--r-- | plugins/doc/pom.xml | 155 | ||||
| -rw-r--r-- | plugins/doc/src/site/pdf/main.pdf.xml | 25 | ||||
| -rw-r--r-- | plugins/doc/src/site/resources/images/eclipse-800x188.png | bin | 13315 -> 0 bytes | |||
| -rw-r--r-- | plugins/doc/src/site/resources/images/papyrus.png | bin | 14108 -> 0 bytes | |||
| -rwxr-xr-x | plugins/doc/src/site/resources/template/Papyrus_Template.approj | bin | 43422720 -> 0 bytes | |||
| -rw-r--r-- | plugins/doc/src/site/site.xml | 124 | ||||
| -rw-r--r-- | plugins/doc/src/site/xdoc/index.xml | 31 | ||||
| -rw-r--r-- | plugins/doc/src/site/xdoc/video.xml | 37 |
8 files changed, 1 insertions, 371 deletions
diff --git a/plugins/doc/pom.xml b/plugins/doc/pom.xml index b46984bc804..cff5ef0f0f5 100644 --- a/plugins/doc/pom.xml +++ b/plugins/doc/pom.xml @@ -8,8 +8,6 @@ </parent> <artifactId>org.eclipse.papyrus.plugins-doc</artifactId> <packaging>pom</packaging> - <name>The Papyrus end-user and developer documentation bundles</name> - <description>Maven plugin dedicated to generate developer documentation through a dedicated website and pdf files.</description> <modules> <module>org.eclipse.papyrus.cdo.ui.doc</module> @@ -33,156 +31,5 @@ <module>org.eclipse.papyrus.uml.search.ui.doc</module> <module>org.eclipse.papyrus.views.properties.doc</module> </modules> - - <!-- 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> - </plugins> - </build> - <reporting> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-project-info-reports-plugin</artifactId> - <version>2.8</version> - </plugin> - </plugins> - </reporting> - + </project> diff --git a/plugins/doc/src/site/pdf/main.pdf.xml b/plugins/doc/src/site/pdf/main.pdf.xml deleted file mode 100644 index 1c702d5e0d7..00000000000 --- a/plugins/doc/src/site/pdf/main.pdf.xml +++ /dev/null @@ -1,25 +0,0 @@ -<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="index.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 differdeleted file mode 100644 index 0c469529da5..00000000000 --- a/plugins/doc/src/site/resources/images/eclipse-800x188.png +++ /dev/null diff --git a/plugins/doc/src/site/resources/images/papyrus.png b/plugins/doc/src/site/resources/images/papyrus.png Binary files differdeleted file mode 100644 index edf2a1c9a32..00000000000 --- a/plugins/doc/src/site/resources/images/papyrus.png +++ /dev/null diff --git a/plugins/doc/src/site/resources/template/Papyrus_Template.approj b/plugins/doc/src/site/resources/template/Papyrus_Template.approj Binary files differdeleted file mode 100755 index 684b4a9c280..00000000000 --- a/plugins/doc/src/site/resources/template/Papyrus_Template.approj +++ /dev/null diff --git a/plugins/doc/src/site/site.xml b/plugins/doc/src/site/site.xml deleted file mode 100644 index 1d21f2f224d..00000000000 --- a/plugins/doc/src/site/site.xml +++ /dev/null @@ -1,124 +0,0 @@ -<?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 deleted file mode 100644 index a03cbf55a81..00000000000 --- a/plugins/doc/src/site/xdoc/index.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?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 deleted file mode 100644 index 08ad0a1d236..00000000000 --- a/plugins/doc/src/site/xdoc/video.xml +++ /dev/null @@ -1,37 +0,0 @@ -<?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 |
