Hochschule Offenburg

offenburg.university

ivESK

Institut fr verlssliche
Embedded Systems und
Kommunikationselektronik

Offenburg University of Applied Sciences

Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

ADD DOCUMENT TITLE HERE

ADD DOCUMENT SUBTITLE HERE

Projec
t:

ADD PROJECT NAME HERE

Versio
n:

0.1

Date:

01.12.2015

ADD DOCUMENT TITLE HERE [0.1]

Authors
Manuel Schappacher [manuel.schappacher@hs-offenburg.de]
Another Author [another.author@hs-offenburg.de]

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

History
Versio
n

Author(s)

Date

Summary of changes

0.1

M. Schappacher

05.12.2015 Initial template creation

0.2

M. Schappacher

05.12.2015 Slight layout changes in header and footer

0.3

M. Schappacher

05.12.2015 Changed layout of List of **

0.4

M. Schappacher

05.12.2015 Fixed Numberings

0.5

M. Schappacher

08.12.2015 Removed Logos from footer

0.6

M. Schappacher

13.12.2015 Added dynamic footer including University

and Institute name

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

Abbreviations
Abbreviatio
n

Description

CSMA-CA

Carrier Sense Multiple Access Collision Avoidance

ivESK

Insitut fr verlssliche Embedded Systems und

Kommunikationselektronik

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

Table of Contents
AUTHORS............................................................................................................ 1
HISTORY.............................................................................................................. 1
ABBREVIATIONS...................................................................................................2
TABLE OF CONTENTS............................................................................................ 3
LIST OF FIGURES.................................................................................................4
LIST OF TABLES...................................................................................................5
LIST OF LISTINGS.................................................................................................6
1

EXECUTIVE SUMMARY....................................................................................7

COMMON ELEMENTS......................................................................................8
2.1
NUMBERING AND ENUMERATIONS.........................................................................................8
2.2
TABLES.......................................................................................................................... 8
2.3
FIGURES......................................................................................................................... 8
2.4
FORMULAS...................................................................................................................... 9
2.5
CODE LISTINGS................................................................................................................ 9
2.6
REFERENCES................................................................................................................. 10
2.7
CAPTIONS & REFERENCES................................................................................................ 10
2.7.1 Subchapters........................................................................................................... 10

SPECIFIC ELEMENTS.....................................................................................11
3.1

INFO, TIP WARNING FIELDS.............................................................................................. 11

REFERENCES................................................................................................ 12

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

List of Figures
FIG. 1: SAMPLE

FIGURE DESCRIPTION................................................................................................ 9

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

List of Tables
TAB. 1: SAMPLE
TAB. 2: SAMPLE

TABLE DESCRIPTION................................................................................................8
TABLE DESCRIPTION.............................................................................................. 10

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

List of Listings
LIST. 1: SAMPLE

LISTING DESCRIPTION............................................................................................ 10

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

1 Executive Summary
This section should contain an executive summary of the overall document. E.g. here
you can describe the main topic of the document as well as how the document is
organized.
This document provides a template of how create documents/specifications/reports
for the ivESK. The following chapters will show the common elements of such
documents and how to use them. Its important to stick to the given rules to provide
a common look and feel of the documents.

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

2 Common Elements
Before new chapters a page break should always be used. Furthermore there shall be
no headings or sub-headings without a following text. The next chapters define the
common layout of ivESK documents.

2.1 Numbering and enumerations

For numberings and enumerations the default layout shall be used. This section gives
some examples of how to use enumerations. Maximum number of levels should be 3
as shown in the example

Enumeration 1st level

Another 1st level

o Second level enumeration
3rd level enumeration

Another one on level 3

Another second

2.2 Tables
For tables the following format as shown in tab. 1 shall be used. Captions shall be
below tables and numbering of tables shall be continuous e.g. 1 100. Tables as well
as the caption shall be left aligned.
For creating references for tables textmarks shall be used as described in chapter
Error: Reference source not found.
ID

Description

Just a sample description

Another description

Tab. 1:

Sample table description

Once it comes to tables some layout options shall be applied to avoid bad positioning
of the tables. Therefore the option

Tabelleneigenschafen -> Zeile -> Zeilenwechsel auf Seite zulassen shall be

disabled

Absatz -> Zeilen und Seitenumbruch -> Nicht von nchsten Absatz trennen
shall be enabled

2.3 Figures
For figures the following format as shown in fig. 1 shall be used. Captions shall be
below figures and numbering of tables shall be continuous e.g. 1 100. Figures as
well as the caption shall be center aligned. Please try to always use high resolution or
scalable (e.g. emf) graphics to guarantee good quality for PDF exports.

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page
15

of

ADD DOCUMENT TITLE HERE [0.1]

Fig. 1:

Sample figure description

2.4 Formulas
In case equations will be used they shall be placed within a table with invisible
frames. The equation shall be right aligned whereas the numbering shall be left
aligned right to the equation as shown in the example from eq. 1. Numbering shall be
continuous e.g. 1 -100. This example can also be used as template for defining
further equations.
n

n
( x+ a ) = n x k ank
k=0 k

()

Eq. 1

2.5 Code Listings

For some types of documentations it might be required to include code listings e.g. in
case of user manuals or interface descriptions. In that case, the layout of the
following listing block as shown in list. 1 shall be used. To create listings several
helpers exist, e.g. Notepad++ includes a plugin NPP Export that allows to export
code to HTML that can be pasted into the word document. List. 2 has been created
this way.
/*==============================================================================
RPL Configuration
=============================================================================*/
/*! \struct rpl_configuration
\brief for dynamic RPL parameter configuration
*/
typedef struct rpl_configuration
{
/* The DIO interval (n) represents 2^n ms. default value = 8 */
uint8_t DIO_interval_min;
/* Maximum amount of timer doublings. default value = 12 */
uint8_t DIO_interval_doublings;
/* This value decides which DAG instance we should participate in by default.
default value = 0x1e (30) */
uint8_t default_instance;
Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page 10 of
15

ADD DOCUMENT TITLE HERE [0.1]

/* Initial metric attributed to a link when the ETX is unknown. default value = 2
*/
uint8_t init_link_metric;
/* Default route lifetime unit. This is the granularity of time used in RPL
lifetime values, in seconds. default value = 0xffff */
uint16_t default_route_lifetime_unit;
/* Default route lifetime as a multiple of the lifetime unit. default value = 0xff
*/
uint8_t default_route_lifetime;
}s_rpl_conf_t;
/*! RPL configuration struct, do not change */
extern s_rpl_conf_t
rpl_config;

List. 1:

Sample listing description

2.6 References
Almost every document comes with references and furthermore those references
often become reused within different documents. Therefore it is important to stick to
the rules of how references will be created. A detailed description of how to create
references is given in chapter 2.7. A sample reference would be [1].

2.7 Captions & References

For captions as well as for references self-defined fields shall be used instead of MS
Words built in add caption functionality. This mechanisms gives more flexibility as
well as it allows to copy/paste references and captions between different documents.
Fields and there references can be defined using special braces that can be inserted
using the key shortcut STRG+F9, furthermore fields can be shown/hidden using ALTF9. For a common look and feel the following naming rules as described in table 2
shall be applied.
Type

Pref
x

Sample defnition

Sample reference

Table

tab

Tab. {\seq tab }: {\set

tabexampletable ""}

{\seq tab tabexampletable

}

Figure

fig

Fig. {\seq fig }: {\set figexamplefigure {\seq fig

""}
figexamplefigure }

Equation eq

Eq. {\seq eq }: {\set

eqexampleequation ""}

{\seq eq
eqexampleequation }

Listing

List {\seq list }: {\set

listexamplelisting ""}

{\seq list
listexamplelisting }

{\seq lit }{\set litexampleliterature

""}

{\seq lit
litexampleliterature }

list

Referenc lit
e
Tab. 2:

Sample table description

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page 11 of
15

ADD DOCUMENT TITLE HERE [0.1]

1.1.1
chapters

Sub

In general it is allowed to create subchapters without any restriction. However it is

recommended not to use more than 3 levels. In case you need a deeper chapter
structure you might also consider changing the structure of your documentation.

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page 12 of
15

ADD DOCUMENT TITLE HERE [0.1]

3 Specific Elements
Besides the common documentation elements as described in chapter 2 some
documents might require further elements. This is often the case e.g. when writing
user guides. The following chapters shall give some examples and ideas of specific
documentation blocks.

3.1 Info, Tip Warning Fields

Especially when writing user guides, quite often it comes to specific sections that
need to highlight a specific text block. Here the Info, Tip, or warning fields can be
used. The following blocks give an example of how they can look like.
This is a sample of a tip box. This type of box can be used e.g. to point to some
interesting tips.

This is a sample of an information box. This type of box can be used e.g. to
point to some interesting information.

This is a sample of a warning box. This type of box can be used e.g. to show
that care has to be taken at specific points within the specification.

This is a sample of a error box. This type of box can be used e.g. to point to
some important things that the user shall absolutely take care of.

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page 13 of
15

ADD DOCUMENT TITLE HERE [0.1]

References
[1] Reference

Offenburg
University
of
Applied
Sciences
Institute of reliable Embedded Systems and Communication
Electronics (ivESK)

Page 14 of
15