Commit 5aa5c9db authored by Kristof Szabados's avatar Kristof Szabados
Browse files

indentation fix


Signed-off-by: Kristof Szabados's avatarKristof Szabados <Kristof.Szabados@ericsson.com>
parent c7a58a33
== Introduction
= Introduction
:toc:
:figure-number: 0
=== Overview
== Overview
This document describes the general workflow and use of the TITAN Designer for the Eclipse IDE plug-in.
......@@ -18,11 +18,11 @@ The TITAN Designer plug-in provides support for:
* remote build.
=== Target Groups
== Target Groups
This document is intended for system administrators and users who intend to use the TITAN Designer plug-in for the Eclipse IDE.
=== Typographical Conventions
== Typographical Conventions
This document uses the following typographical conventions:
......@@ -34,11 +34,11 @@ This document uses the following typographical conventions:
* `*Bold monospaced font*` is used for commands that must be entered at the Command Line Interface (CLI), For example, `*mctr_gui*`
=== Installation
== Installation
For details on installing the TITAN Designer for the Eclipse IDE plug-in, see the Installation Guide for TITAN Designer and TITAN Executor for the Eclipse IDE.
=== Reporting Errors
== Reporting Errors
The following information should be included into trouble reports:
......
== Contents of the Outline View
= Contents of the Outline View
:toc:
:figure-number: 121
......@@ -8,7 +8,7 @@ It is often useful to get a higher level view of the actual TTCN-3/ASN.1 module,
The Outline view consists of two main parts. The toolbar and the actual tree view.
=== The Tree
== The Tree
The Outline view contains a tree, representing the structure of the current TTCN-3/ASN.1 module. Each element is represented in the Outline view by an icon that makes the type of the item easily recognizable and by a text that shows the name and the type of the element or in case of structures with formal parameters their calling convention.
......@@ -16,11 +16,11 @@ image::images/10_F107.png[title="Outline view"]
The root of the tree always represents the current TTCN-3/ASN.1 module and optionally the list of module importations if there were any. The structure of the underlying levels shows data structure hierarchies, type definition groupings etc.
=== The Toolbar
== The Toolbar
With the functionality available through the toolbar buttons, the elements of the Outline view can be ordered, restructured or the visibility of specific elements can be changed. In the following subsections these toolbar actions will be described.
==== Sorting Elements
=== Sorting Elements
By default the elements in the Outline view are in the order of their position in the TTCN-3/ASN.1 module.
......@@ -30,7 +30,7 @@ The elements can be sorted alphabetically with toggling the image:images/sortalp
image::images/10_F109.png[title="Sorted alphabetically"]
==== Categorizing Elements
=== Categorizing Elements
It is possible to order the outline view t categorizes the elements to be displayed before sorting them. This function is useful if one is only interested records, or functions as this way functions, types, module parameters will be found together in the outline view.
......@@ -38,13 +38,13 @@ Categorizing of the outline elements is possible with toggling the image:images/
image::images/10_F110.png[title="Categorized and sorted alphabetically"]
==== Grouping
=== Grouping
By default the Outline view does not show the group hierarchies in the module, as the groups do not have any effect on scoping. However they can be used to group semantically similar functions, type definitions etc. To make group hierarchies visible in the Outline view the image:images/outlinegroup.png[outline_group] button can be used.
image::images/10_F111.png[title="Grouping"]
==== Filtering Elements
=== Filtering Elements
If there are lots of elements in the Outline view it can be hard to find the appropriate one, so it is possible to filter the elements based on their types, using the filtering buttons in the toolbar. Filtering is additive, more filters can be active at the same time.
......@@ -56,7 +56,7 @@ Hide templates (image:images/icon_02.png[filter_02])
Hide types (image:images/icon_03.png[filter_03])
=== Outline View Icons
== Outline View Icons
image::images/10_F112.png[title="Outline view icons for TTCN-3 and ASN.1"]
Pitfalls
......
== Extensions to the Project Explorer
= Extensions to the Project Explorer
:toc:
:figure-number: 128
[[filtering-resources-from-the-view]]
=== Filtering Resources from the View
== Filtering Resources from the View
It is possible to hide excluded resources from the Project explorer view.
......
== References
= References
[[_1]]
* [1] link:https://github.com/eclipse/titan.core/blob/master/usrguide/installationguide.adoc[Installation guide for TITAN TTCN-3 Test Executor]
......
== Abbreviations
= Abbreviations
ASN.1:: Abstract Syntax Notation One
......
== Contents of the Problems View
= Contents of the Problems View
:toc:
:figure-number: 109
......@@ -8,7 +8,7 @@ Whenever a problem is found in a project related resource, a marker is placed on
In general, when any part of the TITAN Designer plugin checks a given file for problems, it first removes the markers from the resource then does the checking; and if any problems were found new markers are placed on the resource. The only exception to this is that the on-the-fly parser cannot remove markers generated by the compiler; but instead it turns them grey, this was designed so because the checks of the compiler are much more precise than the checks of the on-the-fly parser. The compiler overwrites also the markers of the on-the-fly parser, of course.
=== Types of Markers
== Types of Markers
There are three error marker types indicating:
......@@ -21,7 +21,7 @@ There are three error marker types indicating:
Issues are reported as warnings (minuscule issues) or errors (severe issues that must be repaired as soon as possible).
[[eclipse-provided-features]]
=== Eclipse Provided Features
== Eclipse Provided Features
Every time a marker is created the TITAN plugin tries to provide as much information about the issue as possible to fully profit from the Eclipse features.
......@@ -48,7 +48,7 @@ These markers can be grouped in several, semantically different ways. This will
Every editor provided by the TITAN plug-in is able to show the error texts of markers placed on a line. The mouse pointer must be placed over a marker to activate this functionality. If several errors were found in the same line, each of their texts is displayed on a new line.
[[grouping-of-problems]]
=== Grouping of Problems
== Grouping of Problems
Grouping of markers can be activated by selecting *Triangle / Group By*.
......@@ -58,13 +58,13 @@ Other elements of Eclipse can also report problems; these issues will be called
Groupings supported by TITAN plugin are described in the following sections.
==== Group by Severity
=== Group by Severity
Here the markers are grouped by their severity, that is, whether they are representing errors or warnings. This grouping is preferable when treating errors first. Other problems are mixed into the problems reported by TITAN plugin.
image::images/8_F103.png[title="Grouping by severity"]
==== Group by Type
=== Group by Type
Here the problems are grouped by the reporting entity. The following groups are composed by the TITAN plugin:
......@@ -74,7 +74,7 @@ Here the problems are grouped by the reporting entity. The following groups are
image::images/8_F104.png[title="Grouping by type"]
==== Group by TITAN Problems
=== Group by TITAN Problems
Here every problem reported by the TITAN plugin is placed into the same group labeled TITAN Problems. Other problems are placed into a group labeled Other Problems.
......
== Contents of the Tasks View
= Contents of the Tasks View
:toc:
:figure-number: 114
......@@ -6,7 +6,7 @@ This section presents how TITAN Designer plugin is integrated in the Tasks view.
There are many cases when a developer would like to mark parts of the code; not necessarily because of errors. For example, the programmer may be working on a huge project consisting of many small parts easy to overlook. In this case it is invaluable for the programmer if he can mark parts of the code as not finished. It happens several times in real life development that the design of smaller program parts is shifted so many times and so much in time that people actually forget about it.
=== Types of Markers
== Types of Markers
There are two task marker types:
......
== Introduction
= Introduction
=== Overview
== Overview
This document describes the general workflow and use of the TITAN Executor for the Eclipse IDE plug-in.
......@@ -8,11 +8,11 @@ TITAN Executor is a tool to launch testcases with different configuration types,
It is advised to have a basic knowledge and understanding of the Eclipse IDE and its workflows. For information, open *Help > Workbench User Guide* in the Eclipse GUI.
=== Target Groups
== Target Groups
This document is intended for system administrators and users who intend to use the TITAN Executor plug-in for the Eclipse IDE.
=== Typographical Conventions
== Typographical Conventions
This document uses the following typographical conventions:
......@@ -24,11 +24,11 @@ The '>' character is used to denote a menu and sub-menu sequence. For example, *
`*Bold monospaced*` font is used for commands that must be entered at the Command Line Interface (CLI), For example, `*mctr_gui*`
=== Installation
== Installation
For details on installing the TITAN Executor for the Eclipse IDE plug-in, see the Installation Guide for TITAN Designer and TITAN Executor for the Eclipse IDE <<7-references.adoc#_2, [2]>>.
=== Reporting Errors
== Reporting Errors
The following information should be included into trouble reports:
......
== Executing and Controlling the Execution of Test Suites
= Executing and Controlling the Execution of Test Suites
:figure-number: 25
The three different launch modes that are supported by the Executor plug-in, also imply three different execution mechanisms (executions and executors).
As the general user interaction interfaces, are about the same, we will discuss them one by one, detailing the differences between the execution modes when they apply.
=== Execution Control
== Execution Control
Execution can be started on several ways:
......@@ -21,7 +21,7 @@ Please note that redrawing the supported views might cost some performance, for
As soon as an execution is started it will be displayed in the Executor monitor view.
=== TITAN Execution Controller View
== TITAN Execution Controller View
[[Figure-26]]
image::images/5_F26.png[title="TITAN Execution Controller view"]
......@@ -196,7 +196,7 @@ Please note that in this case the notification messages (originally also conside
+
Selecting this action you can update the detailed information, which the main controller provides (an example can be seen on <<Figure-29,Figure 29>>).
==== Execute Dialog
=== Execute Dialog
[[Figure-31]]
image::images/5_F31.png[title="Execute dialog enabled"]
......@@ -223,7 +223,7 @@ image::images/5_F32.png[title="Execute dialog with disabled execution times part
Please note that if an element type is not present then the corresponding branch cannot be expanded. For example if no configuration file was set on the Basic Main Controller options page, then the configuration file branch does not have leafs.
=== TITAN Notifications View
== TITAN Notifications View
image::images/5_F33.png[title="TITAN Notifications view"]
......@@ -251,7 +251,7 @@ If this action is checked and new records are inserted into the lists of notific
Please note that these actions can be selected from the toolbar and menu bar of the view.
=== TITAN Test Results View
== TITAN Test Results View
image::images/5_F34.png[title="The Executed tests view"]
......@@ -279,7 +279,7 @@ Please note that these actions can be selected from the toolbar and menu bar of
Please note, that if verdict extraction is not enabled on the Performance page of the launch configuration, this view will be empty. For more information please refer to section 4.2.5.
=== Console Views
== Console Views
There are a few things to remember about console views:
......@@ -293,7 +293,7 @@ There are a few things to remember about console views:
* When an executing launch is selected in the Executor monitor view, the Console view changes to the console of the main controller belonging to the execution.
==== Creating a New Console View
=== Creating a New Console View
By default the Executor perspective has only a single Console view open this can be changed by selecting the Open Console menu (Figure 36) and clicking on the New Console View option (Figure 37). By doing so a new Console view will be created in the actual perspective
......@@ -303,7 +303,7 @@ image::images/5_F37.png[title="The New Console View menu entry"]
Using this feature of the Console views it is possible to create a separate Console view for each Host Controller or Main Controller of interest, and with their output at the same time.
==== Selecting and Pining to a New Console Output
=== Selecting and Pining to a New Console Output
The default behavior of the Console View provided by its plug-in is that it always tries to show the data printed to a console. For this reason when any Host controller or the Main Controller displays any information on its standard output, the Console View will automatically switch to the Console displaying that information.
......@@ -318,7 +318,7 @@ To force a Console View to always display the contents of a given console, one h
image::images/5_F40.png[title="The Pin Console menu item"]
=== Limitations
== Limitations
* In Parallel mode the actions that are displayed to be available and the ones truly available might differ in special time periods. The reason for this limitation is that it is almost impossible to tell the exact state of the Main Controller at a given time. For example, if the system buffers the output of the Main Controller, or the input of the watching process, than a short status change indicating message might not appear until the buffer is not filled up (with still to come messages). On the performance page of the mctr_cli launch configuration it can be set how often the states should be synchronized.
......
== Other Available Functions
= Other Available Functions
:figure-number: 40
=== Formatting Log Files
== Formatting Log Files
To format a log file (one having log as extension) *right click* the fileand select *Titan Log > Format log*.
......@@ -11,7 +11,7 @@ This will produce a formatted log file in the very same directory, with the same
Please note that for the duration while the formatted log is being created progress indication is provided in the *Progress view*.
=== Merging Log Files
== Merging Log Files
To merge several log files (ones having log as extension) select them, and after right clicking on one select *Titan Log > Format log.*
......
== References
= References
[[_1]]
* [1] link:https://github.com/eclipse/titan.core/blob/master/usrguide/installationguide.adoc[Installation guide for TITAN TTCN-3 Test Executor]
......
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