Commit 44c8db47 authored by Dennis Hendriks's avatar Dennis Hendriks
Browse files

#344 Move common tool documentation to project documentation.

 - Also improved the title of an unrelated section.
parent a1730c2a
<?xml version="1.0" encoding="UTF-8"?>
<fileset-config file-format-version="1.2.0" simple-config="false" sync-formatter="false">
<local-check-config name="Eclipse ESCET Checkstyle" location="/org.eclipse.escet.releng.configuration/checkstyle.xml" type="project" description="Eclipse ESCET Checkstyle.
Copyright (c) 2010, 2022 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT">
<additional-data name="protect-config-file" value="false"/>
</local-check-config>
<fileset name="all" enabled="true" check-config-name="Eclipse ESCET Checkstyle" local="true">
<file-match-pattern match-pattern="^(src.*|asciidoc)/" include-pattern="true"/>
</fileset>
<filter name="NonSrcDirs" enabled="false"/>
</fileset-config>
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>org.eclipse.escet.common.documentation</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.pde.ManifestBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.pde.SchemaBuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>net.sf.eclipsecs.core.CheckstyleBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.pde.PluginNature</nature>
<nature>net.sf.eclipsecs.core.CheckstyleNature</nature>
</natures>
</projectDescription>
Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: ESCET Common Documentation (Incubation)
Bundle-SymbolicName: org.eclipse.escet.common.documentation;singleton:=true
Bundle-Version: 0.6.0.qualifier
Bundle-Vendor: Eclipse ESCET
Require-Bundle: org.eclipse.help
//////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2022 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available
// under the terms of the MIT License which is available at
// https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
//////////////////////////////////////////////////////////////////////////////
// Local attributes only for this folder.
// Due to property caching in Eclipse AsciiDoctor editor, use a unique name per directory.
:incdir-tools: ../../images/tools
<!--
Copyright (c) 2022 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<assembly
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">
<formats>
<format>zip</format>
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<fileSets>
<fileSet>
<directory>${project.build.directory}/website</directory>
<outputDirectory />
</fileSet>
<fileSet>
<directory>${basedir}/images</directory>
<outputDirectory />
</fileSet>
</fileSets>
</assembly>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<launchConfiguration type="org.eclipse.m2e.Maven2LaunchConfigurationType">
<booleanAttribute key="M2_DEBUG_OUTPUT" value="false"/>
<stringAttribute key="M2_GOALS" value="clean package --projects releng/org.eclipse.escet.releng.target,common/org.eclipse.escet.common.documentation --also-make"/>
<booleanAttribute key="M2_NON_RECURSIVE" value="false"/>
<booleanAttribute key="M2_OFFLINE" value="false"/>
<stringAttribute key="M2_PROFILES" value=""/>
<listAttribute key="M2_PROPERTIES">
<listEntry value="tycho.pomless.aggregator.names=releng,chi,cif,common,setext,thirdparty,tooldef,product"/>
</listAttribute>
<stringAttribute key="M2_RUNTIME" value="EMBEDDED"/>
<booleanAttribute key="M2_SKIP_TESTS" value="false"/>
<intAttribute key="M2_THREADS" value="1"/>
<booleanAttribute key="M2_UPDATE_SNAPSHOTS" value="true"/>
<stringAttribute key="M2_USER_SETTINGS" value=""/>
<booleanAttribute key="M2_WORKSPACE_RESOLUTION" value="false"/>
<stringAttribute key="org.eclipse.debug.core.ATTR_REFRESH_SCOPE" value="${workspace}"/>
<booleanAttribute key="org.eclipse.jdt.launching.ATTR_ATTR_USE_ARGFILE" value="false"/>
<booleanAttribute key="org.eclipse.jdt.launching.ATTR_USE_CLASSPATH_ONLY_JAR" value="false"/>
<stringAttribute key="org.eclipse.jdt.launching.WORKING_DIRECTORY" value="${workspace_loc:/org.eclipse.escet.root}"/>
</launchConfiguration>
###############################################################################
# Copyright (c) 2022 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the terms
# of the MIT License which is available at https://opensource.org/licenses/MIT
#
# SPDX-License-Identifier: MIT
###############################################################################
bin.includes = META-INF/,\
plugin.xml,\
images/
src.includes = asciidoc/,\
images/
<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>
<!--
Copyright (c) 2022 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<plugin>
<extension
point="org.eclipse.help.toc">
<toc
file="toc.xml"
primary="true">
</toc>
</extension>
</plugin>
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2022 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<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>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.root</artifactId>
<version>0.6.0-SNAPSHOT</version>
<relativePath>../../</relativePath>
</parent>
<artifactId>org.eclipse.escet.common.documentation</artifactId>
<packaging>eclipse-plugin</packaging>
<build>
<plugins>
<!-- Generate documentation from AsciiDoc sources. -->
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<configuration>
<sourceDirectory>asciidoc</sourceDirectory>
<sourceDocumentName>documentation.asciidoc</sourceDocumentName>
<attributes>
<imagesdir />
</attributes>
</configuration>
<executions>
<execution>
<id>generate-eclipse-help</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>
${project.build.directory}/eclipse-help-intermediate/documentation.html
</outputFile>
<backend>html5</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<logHandler>
<failIf>
<severity>DEBUG</severity>
</failIf>
</logHandler>
<attributes>
<attribute-missing>warn</attribute-missing>
<linkcss>true</linkcss>
<imgsdir>images</imgsdir>
<icons>font</icons>
<sectanchors>false</sectanchors>
<html-output>true</html-output>
<eclipse-help-output>true</eclipse-help-output>
</attributes>
</configuration>
</execution>
<execution>
<id>generate-pdf</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>
${project.build.directory}/website-intermediate/eclipse-escet-incubation-common-manual.pdf
</outputFile>
<backend>pdf</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<logHandler>
<failIf>
<severity>DEBUG</severity>
</failIf>
</logHandler>
<attributes>
<attribute-missing>warn</attribute-missing>
<imgsdir>${project.basedir}/images</imgsdir>
<doctype>book</doctype>
<icons>font</icons>
<pagenums />
<sectnums />
<toc />
<toclevels>3</toclevels>
<pdf-output>true</pdf-output>
</attributes>
</configuration>
</execution>
<execution>
<id>generate-website</id>
<phase>generate-resources</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>${project.build.directory}/website-intermediate/documentation.html</outputFile>
<backend>html5</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<logHandler>
<failIf>
<severity>DEBUG</severity>
</failIf>
</logHandler>
<attributes>
<attribute-missing>warn</attribute-missing>
<imgsdir>.</imgsdir>
<doctype>book</doctype>
<icons>font</icons>
<toc>left</toc>
<toclevels>7</toclevels>
<sectanchors>true</sectanchors>
<html-output>true</html-output>
<website-output>true</website-output>
</attributes>
</configuration>
</execution>
</executions>
</plugin>
<!-- Split single-page HTML to multi-page HTML. -->
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<mainClass>
org.eclipse.escet.common.asciidoc.html.multipage.AsciiDocMultiPageHtmlSplitter
</mainClass>
<includePluginDependencies>true</includePluginDependencies>
<includeProjectDependencies>true</includeProjectDependencies>
</configuration>
<executions>
<execution>
<id>eclipse-help-multi-html-split</id>
<phase>generate-resources</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/asciidoc</argument>
<argument>${project.build.directory}/eclipse-help-intermediate/documentation.html</argument>
<argument>${project.build.directory}/eclipse-help</argument>
<argument>--eclipse-help</argument>
</arguments>
</configuration>
</execution>
<execution>
<id>website-multi-html-split</id>
<phase>generate-resources</phase>
<goals>
<goal>java</goal>
</goals>
<configuration>
<arguments>
<argument>${project.basedir}/asciidoc</argument>
<argument>${project.build.directory}/website-intermediate/documentation.html</argument>
<argument>${project.build.directory}/website</argument>
<argument>--website</argument>
<argument>Common website</argument>
<argument>.</argument>
</arguments>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.common.asciidoc</artifactId>
<version>${project.version}</version>
<type>eclipse-plugin</type>
</dependency>
<dependency>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.common.java</artifactId>
<version>${project.version}</version>
<type>eclipse-plugin</type>
</dependency>
<dependency>
<groupId>org.eclipse.escet</groupId>
<artifactId>org.eclipse.escet.common.app.framework</artifactId>
<version>${project.version}</version>
<type>eclipse-plugin</type>
</dependency>
</dependencies>
</plugin>
<!-- Copy non-HTML files from intermediate output folders to final output folders. -->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<version>3.0.0</version>
<executions>
<execution>
<id>copy-intermediate-to-final</id>
<phase>generate-resources</phase>
<goals>
<goal>run</goal>
</goals>
<configuration>
<target>
<copy todir="${project.build.directory}/eclipse-help" verbose="true">
<fileset dir="${project.build.directory}/eclipse-help-intermediate">
<exclude name="**/*.html" />
</fileset>
</copy>
<copy todir="${project.build.directory}/website" verbose="true">
<fileset dir="${project.build.directory}/website-intermediate">
<exclude name="**/*.html" />
</fileset>
</copy>
</target>
</configuration>
</execution>
</executions>
</plugin>
<!-- Package the Eclipse help contents in the plugin. -->
<plugin>
<groupId>org.eclipse.tycho</groupId>
<artifactId>tycho-packaging-plugin</artifactId>
<configuration>
<additionalFileSets>
<fileSet>
<directory>${project.build.directory}/eclipse-help/</directory>
<includes>
<include>**/*</include>
</includes>
</fileSet>
</additionalFileSets>
</configuration>
</plugin>
<!-- Assemble website ZIP file. -->
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<id>assemble-website</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
<configuration>
<finalName>common-website-${escet.version.enduser}</finalName>
<appendAssemblyId>false</appendAssemblyId>
<descriptors>
<descriptor>${basedir}/assembly.xml</descriptor>
</descriptors>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
<!--
Copyright (c) 2022 Contributors to the Eclipse Foundation
See the NOTICE file(s) distributed with this work for additional
information regarding copyright ownership.
This program and the accompanying materials are made available under the terms
of the MIT License which is available at https://opensource.org/licenses/MIT
SPDX-License-Identifier: MIT
-->
<!--
Dummy TOC file.
A real one is generated and packaged during the build.
This one is only present to silence warnings in the development environment, for plugin.xml.
-->
<toc label="Common dummy TOC" topic="common_dummy_toc_does_not_exist.html"/>
......@@ -39,11 +39,13 @@ ifdef::website-output[]
TIP: You can link:eclipse-escet-project-incubation-manual.pdf[download this manual] as a PDF as well.
endif::website-output[]
This documentation includes general information related to the Eclipse ESCET toolkit as a whole.
This documentation includes general information related to the Eclipse ESCET toolkit as a whole, as well as its general tools.
The following information is available:
* <<use-chapter-index>>
* <<performance-chapter-index>>
* Tools
** <<tools-chapter-dsm-clustering>>
* <<release-notes-chapter-index>>
* <<legal-chapter-index>>
......@@ -94,6 +96,10 @@ include::performance/tweak-perf-settings.asciidoc[]
:leveloffset: -1
// Tools
include::tools/dsm-clustering.asciidoc[]
// Release notes
include::release-notes.asciidoc[]
......
......@@ -12,7 +12,6 @@
//////////////////////////////////////////////////////////////////////////////
include::_part_attributes.asciidoc[]
include::_local_attributes.asciidoc[]
[[tools-chapter-dsm-clustering]]
== Design Structure Matrix (DSM) clustering
......
......@@ -14,7 +14,7 @@
include::_part_attributes.asciidoc[]
[[use-chapter-index]]
== Using Eclipse ESCET IDE
== Using the Eclipse ESCET IDE
After you have downloaded and extracted the Eclipse ESCET IDE, you can start using it.
The following information is available to get you started on using the Eclipse ESCET IDE in general, and applies to the various tools in the toolkit:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment