Commit 66b92421 authored by Dennis Hendriks's avatar Dennis Hendriks
Browse files

#73 More work on splitting ESCET and dev docs.

parent 1327b23d
......@@ -37,7 +37,7 @@ All output that the application generates, is given to the output components.
Each output component can decide for itself what to do with that output.
All applications include at least a `StreamOutputComponent`, that redirects stream output to the console.
For stand-alone applications, this means redirection to stdout and stderr.
For application running within the Eclipse IDE, this means redirection to a _Console_ <<use-terminology-view,view>>.
For application running within the Eclipse IDE, this means redirection to a _Console_ view.
Applications that only need to provide error, warning, normal, and debug textual output, the default output component interface (`IOutputComponent`) suffices.
Applications that want to provide additional (typed) output, should create a derived interface that inherits from `IOutputComponent`, and extends the interface with additional callback methods.
......
......@@ -114,7 +114,7 @@ To remedy this situation, application framework applications running within Ecli
Furthermore, the application framework allows termination requests via the `AppEnv.terminate` method.
Application framework applications and threads should regularly call the `AppEnv.isTerminationRequested` method to see whether they should terminate.
See also the <<use-apps-view-termination,termination features>> of the <<use-apps-view,Applications>> <<use-terminology-view,view>>.
See also the termination features of the link:https://eclipse.org/escet/escet/use/apps-view.html[Applications] view.
indexterm:[application, exceptions]
......@@ -156,7 +156,7 @@ Changing the current working directory is also supported.
Application framework applications should use the methods in the `org.eclipse.escet.common.app.framework.Paths` class to get and set the current working directory, to resolve relative paths, etc.
These methods also allow both Windows (`\`) and Unix (`/`) separators to be used in paths, on all platforms, transparently.
Furthermore, within the Eclipse IDE, the concept of a <<use-terminology-workspace,workspace>> is introduced.
Furthermore, within the Eclipse IDE, the concept of a link:https://eclipse.org/escet/escet/use/terminology.html#eclipse-workspace[workspace] is introduced.
In order to allow importing of resources from other projects etc, it may be nice to allow end users to specify platform paths (plug-in paths or workspace paths).
Eclipse Modeling Framework (EMF) URIs, besides local file system paths, provide functionality for platform URIs as well.
EMF URIs can for instance be used to load models that are instances of an Ecore.
......
......@@ -37,4 +37,4 @@ For all contributions to the Eclipse ESCET project, check the following:
Remember that <<development-contributing-chapter-index,contributions>> are always welcome, and contributions don't have to be perfect.
The project's developers can help to improve your contribution, and ensure it adheres to these coding standards.
For any questions regarding these coding standards, please <<development-chapter-index,contact>> the project's developers.
For any questions regarding these coding standards, please <<development-dev-list-chapter-index,contact>> the project's developers.
......@@ -33,7 +33,7 @@ The following topics are discussed:
=== How to contribute to Eclipse ESCET
It is often a good idea to first discuss your contribution with the project's community and committers, before creating the actual code (e.g. patches), documentation, etc of your contribution.
Discussions can take place via an <<development-issue-tracking-chapter-index,issue>> in the issue tracker, or on the project's <<development-chapter-index,'dev' list>>.
Discussions can take place via an <<development-issue-tracking-chapter-index,issue>> in the issue tracker, or on the project's <<development-dev-list-chapter-index,'dev' list>>.
To contribute your actual contribution, e.g. code, documentation, examples, or anything else to the project, please make sure an issue already exists or create a new issue for it in the <<development-issue-tracking-chapter-index,issue tracker>>.
......@@ -123,7 +123,7 @@ Once the committers agree with the contribution, they will merge the contributio
Remember that contributions are always welcome, and contributions don't have to be perfect.
The project's developers can help to improve your contribution.
If you need any help regarding the content of your contribution, the steps above, or anything else, just ask the project's developers via the issue or the project's <<develop-dev-list,'dev' list>>.
If you need any help regarding the content of your contribution, the steps above, or anything else, just ask the project's developers via the issue or the project's <<development-dev-list-chapter-index,'dev' list>>.
See for more information our <<development-development-process-chapter-index,development process>>.
......
......@@ -100,7 +100,7 @@ After setting them, make sure to fully close the Eclipse Installer and then star
In your new development environment, consider changing the following settings:
* For the _Package Explorer_ <<use-terminology-view,view>>:
* For the _Package Explorer_ view:
** Enable the _Link with Editor_ setting, using the image:{development-imgsdir}/link-with-editor.png[] icon.
......
......@@ -21,4 +21,4 @@ You can contact the Eclipse ESCET developers via the project's 'dev' list.
For other means to interact with the Eclipse ESCET community and its developers, see:
* link:https://www.eclipse.org/escet/escet/contact.html[Eclipse ESCET contact information]
* link:https://eclipse.org/escet/escet/contact.html[Eclipse ESCET contact information]
......@@ -28,7 +28,7 @@ The Eclipse ESCET project primarily uses GitLab for its development:
=== Discussion
It is often a good idea to first discuss new ideas and features with the rest of the project developers, i.e. the project committers and the project community.
Discussions can take place on the project's <<development-chapter-index,'dev' list>>, especially for radical new ideas and new features that have not been discussed before.
Discussions can take place on the project's <<development-dev-list-chapter-index,'dev' list>>, especially for radical new ideas and new features that have not been discussed before.
indexterm:[issue]
......
......@@ -43,9 +43,9 @@ The way we work with our Git repository is explained as part of our <<developmen
In the Eclipse ESCET source code repository (Git repository), three layers are distinguished:
* The top layer contains user-oriented languages for designing controllers.
Currently there are two modeling languages in this layer, <<intro-chapter-cif,CIF>> and <<intro-chapter-chi,Chi>>.
Currently there are two modeling languages in this layer, link:https://eclipse.org/escet/cif[CIF] and link:https://eclipse.org/escet/chi[Chi].
+
The third language in the top layer is <<intro-chapter-tooldef,ToolDef>>, a cross-platform scripting language to run tests, and to automate the various tools that need to be executed while designing a controller.
The third language in the top layer is link:https://eclipse.org/escet/tooldef[ToolDef], a cross-platform scripting language to run tests, and to automate the various tools that need to be executed while designing a controller.
* The middle layer contains developer oriented support code.
It has a language of its own, named <<setext-chapter-index,SeText>>.
......@@ -64,7 +64,7 @@ Instead, different parts are stored in different sub-directories from the root.
=== Language directories
Each language has its own subdirectory in the root, `/cif` and `/chi` for the <<intro-chapter-cif,CIF>> and <<intro-chapter-chi,Chi>> modeling languages, `/tooldef` for the <<intro-chapter-tooldef,ToolDef>> language, and `/setext` for the <<setext-chapter-index,SeText>> language.
Each language has its own subdirectory in the root, `/cif` and `/chi` for the CIF and Chi modeling languages, `/tooldef` for the ToolDef language, and `/setext` for the SeText language.
Within a language directory, a directory exists for each part of the code (often equivalent to a plugin), with the same name as the plugin.
The pattern of a plugin name is `org.eclipse.escet.<language>.<plugin-name>` where the plugin-name in different directories has the same meaning.
......@@ -100,7 +100,7 @@ Often generated using modeling tools such as Sirius, but manually written classe
| `tests`
| Collection of tests to check the tools for the language.
Typically a set of input specifications, a set of expected output files, and a <<intro-chapter-tooldef,ToolDef>> script to run the tests.
Typically a set of input specifications, a set of expected output files, and a ToolDef script to run the tests.
These tests can be seen as integration tests.
| `<plugin-name>.tests`
......@@ -113,7 +113,7 @@ These tests can be seen as integration tests.
| Support libraries used by the runnable model.
| `tooldefs`
| Interface definitions to make tools of the language available for <<intro-chapter-tooldef,ToolDef>>.
| Interface definitions to make tools of the language available for ToolDef.
| `common`
| Common functionality used by many tools of the language.
......@@ -135,8 +135,7 @@ These plugins contain:
| Common <<app-framework-chapter-index,application framework>>.
| `org.eclipse.escet.common.app.framework.appsview.ui`
| The <<use-apps-view,Applications view>>.
User interface of the active applications.
| The link:https://eclipse.org/escet/escet/use/apps-view.html[Applications] view provides a user interface to manage the active applications.
| `org.eclipse.escet.common.asciidoc`
| Common functionality related to _AsciiDoc_ documentation.
......
......@@ -78,7 +78,7 @@ The following topics relate to the common libraries and development tools:
:leveloffset: +1
include::development/contact.asciidoc[]
include::development/dev-list.asciidoc[]
include::development/development-process.asciidoc[]
......
......@@ -24,8 +24,8 @@ You can interact with the Eclipse ESCET community and its developers in various
link:https://www.eclipse.org/forums/index.php/f/527/[Eclipse ESCET forum]::
If you have any questions regarding the Eclipse ESCET project, any of its tools, or how to use them, feel free to ask them on the project forum.
<<developer-issue-tracking-chapter-index,Issue tracking>>::
If you wish to browse existing issues or report new ones, then see the issue tracking section for more information.
<<issue-reporting-chapter-index,Issue reporting>>::
If you wish to browse existing issues or report new ones, then see the issue reporting section for more information.
link:https://eclipse.org/escet/development[Development information]::
If you specifically want to contact the Eclipse ESCET developers concerning development related activities, want to contribute to the Eclipse ESCET project, or want to browse the source code, then see the development information.
......@@ -54,6 +54,7 @@ The following information is available:
* <<performance-chapter-index>>
* <<release-notes-chapter-index>>
* <<contact-chapter-index>>
* <<issue-reporting-chapter-index>>
* <<legal-chapter-index>>
......@@ -131,6 +132,10 @@ include::release-notes.asciidoc[]
include::contact.asciidoc[]
// Issue reporting
include::issue-reporting.asciidoc[]
// Legal
include::legal.asciidoc[]
......
/////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2021 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
/////////////////////////////////////////////////////////////////////////////////
include::_root_attributes.asciidoc[]
indexterm:[issue, reporting]
[[issue-reporting-chapter-index]]
== Eclipse ESCET issue reporting
The Eclipse ESCET project uses GitLab to track ongoing development and issues:
* link:https://gitlab.eclipse.org/eclipse/escet/escet/-/milestones[Eclipse ESCET milestones]
* link:https://gitlab.eclipse.org/eclipse/escet/escet/-/issues[Eclipse ESCET issues]
Be sure to search for existing issues before you create another one.
Remember that contributions are always welcome!
To contribute code (e.g. patches), documentation, or anything else, see the link:https://eclipse.org/escet/development/development/contributing.html[Contributing] section.
To understand how we work with issues, see our link:https://eclipse.org/escet/development/development/development-process.html[development process].
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