Home

Contribute

Source code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

eTrice documentation + help
=======


**Prerequistes**:

- Featurizer (Download from Bitbucket and install)
- Stagen (Download .jar from Bitbucket and put it to folder */xternalLibs*, **Java 8 **)

## Project Structure

![commented screenshot](project_structure.svg)

## Artifacts

Feature model, including

- Keyword hover
- Eclipse context help
- Feature Reference documentation part (feature-reference.md)

Online Help Site

Eclipse Help


## HowTo Edit

To update/publish everything run *make.xml*. Logs can be found in folder */tmp*.
Prerequisite: Make at least a dummy change in featuremodel/etrice.featurizer to force code generation to folder */feature-gen*.

### FeatureModel

All artifacts are automatically generated to folder */feature-gen* on change. *make.xml* copies them to the final location:

- *feature-reference.md* to folder */online-doc/content*
- else to folder */targets*

### Online Help Site

The documentation content resides in folder */content* (exception *feature-reference.md* is copied there). The output folder for the complete generated site is */online-doc/target*. Run Ant script *run_online-doc.xml* to start Stagen.

#### Stagen

A static site generator, readme can be found in the repository. A modified version is used, that supports

- xtext syntax highlighting
- toc generation
- markdown within tables (every table cell is generated isolated)

### Eclipse Help

Basically derived from Online Help Site by the means of copying and generating, but with different layout.