Principles-for-drafting-ETSI-deliverables
Introduction
This guide provides step-by-step instructions to support ETSI rapporteurs and experts in drafting ETSI deliverables. It complements the ETSI skeletons, which are pre-built deliverables, already laid out as required and containing essential titles and text blocks. It is the essential foundation for your working document that can be used for any of the Microsoft Word® versions.
For the drafting of ETSI deliverables it is recommended to download the following documents and tools from edithelp! website:
- The appropriate ETSI skeleton.
- The most recent publication of the ETSI Drafting Rules (EDRs).
- The template and toolbar of ETSI styles.
Table of contents and List of figures and/or tables
Contents
The table of contents named "Contents" is a required element, automatically generated and already included on page 3 of ETSI skeletons.
For the title use TT style. For the table itself use the field { TOC \o \w "1-9" }.
If it is needed to unlock the table of contents:
Select the entire table of contents, click simultaneously: Ctrl + Shift + F11.
To update the table of contents:
Press on F9.
To lock the Table of Contents:
Select the table of contents and then click simultaneously: Ctrl + F11.
List of figures and/or tables
"List of figures" and/or "List of tables" are optional unnumbered informative elements. They can be automatically generated using the field indicated below (one or the other or both). If used they shall appear after the table of contents.
For the title use TT style .
For the list of figures use the field {TOC \t "TF" \c}
For the list of tables use the field {TOC \t "TH" \c}.
Intellectual Property Rights
This unnumbered clause is the first required informative element and starts on a new page. The textblock is already included in ETSI skeletons and shall not be changed.
Foreword
This second unnumbered clause appears on the same page as the IPR clause. It is a required informative element and shall not contain requirements, figures or tables, except for the [Go to transposition table in European Standards (ENs)](#transposition-table-for-ens). For ENs Harmonised Standards use the specific ETSI EN Harmonised Standard skeletons.
A pre-defined text block is provided in ETSI skeletons.
More details about the foreword can be found in ETSI Drafting Rules, clause 2.5.
Foreword in ETSI multi-part deliverables
For multi-part ETSI deliverables, one of the following options shall be added to explain the relationship between the various parts in the series.
Option a)
In the Foreword of each part belonging to the series, a list of known parts and sub-parts with their titles shall be provided. One of the textblocks below can be used (see note).
Multi-part ETSI deliverables with parts (without sub-parts)
The present document is part <i> of a multi-part deliverable covering [the] <common element of the title>, as identified below:
Part 1: "<part element of the title>";
Part <i>: "<part element of the title>";
Part <n>: "<part element of the title>".
Multi-part ETSI deliverables containing parts and sub-parts
The present document is part <i>, sub-part <j> of a multi-part deliverable covering [the] <common element of the title>, as identified below:
Part 1: "<part element of the title>";
Part <i>: "<part element of the title>";
Sub-part 1: "<sub-part element of the title>";
Sub-part <j>: "<sub-part element of the title>";
Sub-part <m>: "<sub-part element of the title>".
Part <n>: "<part element of the title>".
NOTE: the <common element of the title> is the same for all parts;
the <part element of the title> differs from part to part; and if appropriate;
the <sub-part element of the title> differs from sub-part to sub-part.
The paragraph identifying the current part (and sub-part, if appropriate) shall be set in bold.
See an example in the Foreword of ETSI TS 100 392-3-15.
Option b)
In the Foreword of a specific part (usually part 1) a detailed list of all parts and/or subparts shall be provided using one of the textblock of option a) and the other parts and/or sub-parts will refer to it using the text block below:
The present document is part <i>, sub-part <j> of a multi-part deliverable. Full details of the entire series can be found in part <N> [Bookmark reference].
See an example in the Foreword of ETSI EN 301 489-28.
Additional text
Additional paragraphs, to be included in the Foreword, may be provided by the Technical Body giving as many of the following as are appropriate:
- an indication of any other organisation that has contributed to the preparation of the ETSI deliverable;
- a statement that the ETSI deliverable cancels and replaces other documents in whole or in part;
- a statement of significant technical changes from the previous version of the ETSI deliverable;
- the relationship of the ETSI deliverable to other ETSI deliverables or other documents;
- the existence of an electronic attachment accompanying the ETSI deliverables, if this is not mentioned elsewhere.
Transposition table for ENs
Each European Standard (EN) shall contain a transposition table as the last element in the Foreword. The table is already included in the ETSI skeleton. Harmonised Standards have appropriate transposition periods, see specific ETSI EN Harmonised Standard skeletons.
ETSI Drafting Rules, clauses 2.5.1 and 8.1.
Modal verbs terminology
This unnumbered clause is a required informative element that appears after the foreword. The textblock is already included in ETSI skeletons.
ETSI Drafting Rules, clause 2.6.
Executive summary
This unnumbered clause is an optional informative element and shall not contain requirements. It appears after "Modal verbs terminology" clause and before the introduction.
The "Executive summary" is used to summarise the ETSI deliverable. It should contain enough information for the readers to become acquainted with the full document without reading it. It is usually one page or shorter.
ETSI Drafting Rules, clause 2.7.
Introduction
This unnumbered clause is an optional informative element and shall not contain requirements. The "Introduction" clause may appear after the "Executive summary" clause (if present).
The "Introduction" clause may be used to give specific information or commentary about the technical content of the ETSI deliverable, and about the reasons prompting its preparation.
ETSI Drafting Rules, clause 2.8.
Scope
The "Scope" shall start on a new page and is clause number 1 of each ETSI deliverable. It is a required informative element and shall not contain requirements. For Harmonised Standards see also specific ETSI EN Harmonised Standard skeletons.
The "Scope" defines without ambiguity the subject of the ETSI deliverable and the aspect(s) covered, thereby indicating the limits of applicability of the ETSI deliverable or particular parts of it.
Forms of expression such as the following should be used:
The present document … EXAMPLE: The present document specifies high-level security and data protection provisions for consumer.
ETSI Drafting Rules, clause 2.9.
References
"References" is clause number 2 and shall list all the documents cited anywhere in an ETSI deliverable including its annexes. It shall consist of clause 2.1 "Normative references" and clause 2.2 "Informative references".
The appropriate text blocks for clauses 2.1.and 2.2 are already included in ETSI skeletons.
More details about the references can be found in ETSI Drafting Rules, clause 2.10.
Normative references
Normative references in normative ETSI deliverables (TS, EN, ES and GS)
Clause 2.1 in normative ETSI deliverables shall contain exclusively a numbered list of all normative references of an ETSI deliverable. These references have to be publicly available and in English. Documents provided in this list shall be normatively referenced provided that they contain technical requirements. This means that informative documents shall not be normatively referenced as they do not contain any normative requirements.
Legal acts can never be used as normative references. For EN Harmonised Standards see also specific ETSI EN Harmonised Standard skeletons.
Use the EX style, enclose the number in square brackets and separate it from the title with a tab (you may use sequence fields for automatically numbering references, see ETSI Drafting Rules, clause 6.9.2).
The document number or title shall incorporate hyperlinks to the sources where the references are available.
Use the NO style, if one or more notes accompanies the reference. Separate "NOTE:" from the text of the note with a tab. The note numbering restart on each reference entry.
If there are no normative references to be listed, add the following text after the text block provided in the skeleton:
Not applicable.
Otherwise list the references as indicated below:
[1] <Standard Organisation acronym> <document number>: "<Title>". (Style EX)
NOTE 1: This is the first note of reference [1]. (Style NO)
NOTE 2: This is the second note of reference [1]. (Style NO)
[2] ETSI EN 300 163: "Television systems; NICAM 728: transmission of two-channel digital sound with terrestrial television systems B, G, H, I, K1 and L". (Style EX)
Normative references in informative ETSI deliverables (TR, EG, SR and GR)
Informative ETSI deliverables do not contain any normative requirements, for this reason no document shall be normatively referenced to throughout the document and/or listed in clause 2.1. The text to be used instead of the text block is indicated in the skeleton.
Informative references
Clause 2.2 shall provide a numbered list of all informative references of an ETSI deliverable. "Informative references" lists documents that may be useful in implementing an ETSI deliverable or add to the reader's understanding but which are not required for conformance to the ETSI deliverable. It is preferable that the informative references are publicly available. Current practice is that the Secretariat will not check the public availability of the informative references”.
Use the EX style, add the letter "i" (for informative) before the number (which shall be in square brackets) and separate this from the title with a tab (you may use sequence fields for automatically numbering references, see ETSI Drafting Rules, clause 6.9.2). Use the NO style, if one or more notes accompanies the reference. Separate "NOTE:" from the text of the note with a tab. The note numbering restart on each reference entry.
If there are no informative references to be listed, add the following text after the text block provided in the skeleton:
Not applicable.
Otherwise list the references as indicated below:
[i.1] <Standard Organisation acronym> <document number> <V#>: "<Title>". (Style EX)
NOTE 1: This is the first note of reference [i.1]. (Style NO)
NOTE 2: This is the second note of reference [i.1]. (Style NO)
[i.2] ETSI TR 102 469: "Digital Video Broadcasting (DVB); IP Datacast over DVB-H: Architecture". (Style EX)
Definition of terms, symbols and abbreviations
Clause 3 with its subclauses are required informative elements and shall not contain requirements.
ETSI Drafting Rules, clause 2.11.
All terms and abbreviations extracted from published ETSI deliverables are collected in the TErms and Definitions Interactive Database (TEDDI). The Secretariat strongly recommends consulting this database when drafting an ETSI deliverable.
Terms
The terms list shall:
- not take the form of, or contain, a requirement;
- be presented in alphabetical order;
- have a definition that can replace the terms in context. Additional information shall be given only in the form of examples or notes. If there are several notes or examples for the same term, the notes and examples shall be numbered (see examples below).
The text block is provided in ETSI skeletons.
Use the Normal style.
The term shall be in bold, and shall start with a lower case letter (unless it is always rendered with a leading capital) followed by a colon, also in bold, one space, and the definition of term starting with a lower case letter and no ending full‑stop.
Use the NO style, if one or more notes accompanies a term. Separate "NOTE:" from the text of the note with a tab.
Use EX style, for the example. Separate "EXAMPLE:" from the text of the example with a tab. The note and/or example numbering restart on each term.
If there are no terms to be listed, replace the text block provided in the skeleton, by:
Void.
Otherwise list the terms after the text block as indicated below:
communal site: location at which there is more than one fixed transmitter (Style Normal)
NOTE: This is the note to communal site. (Style NO)
fast channel: channel with low latency but higher BER in comparison to the slow channel (Style Normal)
EXAMPLE: In contrast to the slow channel, the fast channel is not interleaved. (Style EX)
NOTE 1: This is the first note of the term. (Style NO)
NOTE 2: This is the second note of the term. (Style NO)
Symbols
The symbols list shall:
- contain the symbols and their corresponding explanations;
- be presented in alphabetical order;
- have entries not numbered.
The text block is provided in the ETSI skeletons.
Use the EW style and separate this from the definition with a tab.
Use EX style for the symbol accompanied by note and/or example. Use the NO style, for the note. Separate "NOTE:" from the text of the note with a tab. Use EX style, for the example. Separate "EXAMPLE:" from the text of the example with a tab. The note and/or example numbering restart on each symbol.
Use the EX style for the last symbol.
If there are no symbols to be listed, replace the text block provided in the skeleton, by:
Void.
Otherwise list the symbols after the text block as indicated below:
dB decibel (Style EX)
NOTE 1: This is the first note of the symbol. (Style NO)
NOTE 2: This is the second note of the symbol. (Style NO)
EXAMPLE: This is the example of the symbol. (Style EX)
C Wanted signal (Style EW)
DDI Direct Dialling-In, or direct dialling-in (this is the last item of the list) Style EX)
Abbreviations
The abbreviations list shall:
- contain the abbreviations and their corresponding full form;
- be presented in alphabetical order;
- have entries not numbered.
The text block is provided in the ETSI skeletons.
Use the EW style and separate this from the definition with a tab.
Use EX style for the abbreviation accompanied by note and/or example. Use the NO style, for the note. Separate "NOTE:" from the text of the note with a tab. Use EX style, for the example. Separate "EXAMPLE:" from the text of the example with a tab. The note and/or example numbering restart on each abbreviation.
Use the EX style for the last abbreviation.
If there are no abbreviations to be listed, replace the text block provided in the skeleton, by:
Void.
Otherwise list the abbreviations after the text block as indicated below:
CCI Co-Channel Interference (Style EX)
NOTE 1: This is the firsts note of the abbreviation. (Style NO)
NOTE 2: This is the second note of the abbreviation. (Style NO)
EXAMPLE: This is the example of the abbreviation. (Style EX)
DPC Dynamic Power Control (Style EW)
BER Bit Error Ratio (this is the last item of the list) (Style EX)
Clause numbering
From clause 4, the technical content of the ETSI deliverable shall be inserted. Each clause shall have a title and be placed after its number.
A clause can have numbered subdivisions, e.g. 5.1, 5.2, 5.1.1, 5.1.2, etc. This process of subdivisions may be continued as far as the sixth heading level (e.g. 6.5.4.3.2.1). The sixth heading level and onwards will not be visible in the table of contents).
Every attempt shall be made to use continuous numbering. However, if continuous numbering cannot be kept, a new element shall be inserted in existing text using an appropriate alphanumeric designation that does not disturb the existing numbering scheme. This applies to all elements (e.g. clauses, annexes, figures, tables, notes, lists):
EXAMPLE 1: It is necessary to update an ETSI deliverable. A new clause needs to be inserted between the existing clauses 8 and 9. A new clause 8a shall be inserted in preference to avoid re-numbering the existing clauses.
Similarly, an existing element may be deleted and replaced with the term "Void" to minimise disruption to the numbering scheme.
EXAMPLE 2: During the updating of an ETSI deliverable, it is decided that annex C is no longer required. The title of annex C becomes "Void". Later annexes, therefore, remain unchanged.
Automatic numbering may be used in ETSI deliverables, if used, shall be applied anywhere in an ETSI deliverable including annexes using the appropriate ETSI styles, otherwise it may corrupt the deliverable.
For an easy application of the ETSI styles download "The ETSI styles toolbar" from editHelp! website.
Use the Heading style appropriate to its level, see #ETSI Styles.
Separate the number of the heading and the text of the heading with a tab.
Treat clause titles as normal text (i.e. no additional capitalisation), but no full stop and no reference bookmarks.
Subdivision of clauses
To be able to precisely reference every clause, clauses must have either numbered or unnumbered subdivisions (a paragraph is an unnumbered subdivision of a clause). When a clause or subclause has text below the title, there can be no further subclauses (see examples).
Alternatives 1 and 2 shall be used, alternative 3 shall not be used.
| Alternative 1
(shall be used) |
Alternative 2
(shall be used) |
Alternative 3
(shall not be used) |
|---|---|---|
| 5 Title
5.1 Title Paragraphs 5.2 Title Paragraphs 5.3 Title Paragraphs 6 Test report |
5 Title
Paragraph 1 Paragraph 2 … Paragraph n 6 Test report |
5 Title
Paragraph 1 (text that cannot be precisely referenced) Paragraph 2 (text that cannot be precisely referenced) 5.1 Title Paragraphs 5.2 Title Paragraphs 6 Test report |
ETSI Drafting Rules, clause 2.12.1.
ETSI Styles
| Use this style | For this type of element |
|---|---|
| Heading styles | For different headings |
| Heading 1 | Clause |
| Headings 2 to 5 | Subdivision level 2 to 5 |
| H6 | Subdivision level 6 (not reflected in the table of contents) |
| Heading 8 | Annex title (for ENs, HSs, TSs, ESs and GSs only) |
| Heading 9 | Annex title (for TRs, EGs, GRs and SRs only) |
| Example styles | For examples and abbreviations/symbols lists |
| EX | Reference, Example => |
| EW | Symbol, Abbreviation, Example continuation in text => |
| Note style | |
| NO | Note integrated in the text => |
| Figure styles | For formatting figures |
| TF | Figure title |
| FL | Figure layout |
| NF | Note in figure => |
| Table styles | For formatting tables |
| TH | Table title |
| TAH | Heading within table or column heading |
| TAC | Centred texts |
| TAL | Left aligned text |
| TAR | Right aligned text |
| TB1 | List in tables Level 1 |
| TB2 | List in tables Level 2 |
| TAN | Note in table => |
| List styles (indents) | |
| B1 to B5 | Indent 1 to 5 |
| B1+ | Bulleted indent 1 (round bullets) |
| B2+ | Bulleted indent 2 (dashes) |
| B3+ | Bulleted indent 3 (square bullets) |
| BN | Bulleted (numbers) indent 1 |
| BL | Bulleted (letters) indent 1 |
| General styles | For different items |
| Normal | Standard paragraph, Definition |
| TT | Contents list title |
| PL | Programming language |
| EQ | Equation |
| Header | Header (portrait and landscape pages) |
| Style which can be user-defined | For formatting defined by the user that will not be
altered by the ETSI processing macros |
| FP | Free Paragraph |
| => means that a "tab" shall be used between "item/number" and "text". | |
Notes
Notes and examples integrated in the text shall only be used for giving additional information intended to assist the understanding or use of the ETSI deliverable. Notes and examples shall not contain requirements except when they are included in table or figures.
ETSI Drafting Rules, clause 5.5.
A single note in a clause shall be preceded by "NOTE" in upper case. When several notes occur within the same element (e.g. clause, figure or table), they shall be designated "NOTE 1:", "NOTE 2:", "NOTE 3:", etc. For notes included in "References" and "Definition of terms, symbols and abbreviations" clauses, see clauses 8 and 9. For notes included in tables and figures see #Figures and Tables.
For added or removed notes further to the revision of a deliverable, see #Clause numbering.
Use the NO style. Separate "NOTE:" from the text of the note with a tab.
Format the note as indicated below:
NOTE 1: Text formatted with the NO style will be formatted with a space after the paragraph. (Style NO) NOTE 2: This is the second note contained in a clause. (Style NO)
Examples
A single example in a clause shall be preceded by "EXAMPLE:" in upper case. When several examples occur within the same element (e.g. clause, figure or table), they shall be designated "EXAMPLE 1:", "EXAMPLE 2:", "EXAMPLE 3:", etc. See #Definition of terms, symbols and abbreviations for examples included in that clause.
For added or removed examples further to the revision of a deliverable, see #Clause numbering.
When there is a danger that it may not be clear where the example ends and the normal text continues, then the end of the example may be designated by "END of EXAMPLE".
Use EX style. Separate "EXAMPLE:" from the text of the example with a tab.
Format the example as indicated below:
EXAMPLE 1: This is the first example of the clause. (Style EX)
EXAMPLE 2: This is the second example of the clause. (Style EX)
END of EXAMPLE.
Lists
Lists may be introduced by a sentence, a complete grammatical proposition or by the first part of a proposition, completed by the items in the list.
Each item in a list shall be preceded by a bullet, a dash, an Arabic numeral followed by a parenthesis, or a lower case letter followed by a parenthesis.
Use the appropriate bullet styles, i.e. styles B1 to B5 or B1+ to B3+, BN, BL (see ETSI styles in clause 12).
Separate the list item identifier (e.g. bullet) and the text with a tab (if using styles B1 to B5, the others are automatic bullet styles containing the space).
Ensure that the formatting of the lists is consistent throughout the deliverable.
Format the list as indicated below:
B1+:
- list item 1
- list item 2
- list item 3
BN:
1) List item 1.
2) List item 2.
3) List item 3.
BL:
a) List item a.
b) List item b.
c) List item c.
B2+:
- list item 1;
- list item 2;
- list item 3.
B3+:
■ list item 1;
■ list item 2;
■ list item 3.
B1+, B2+ and B3+:
- list item 1:
- list item 2:
■ list item 3
"And" or "or" shall be used at the end of the penultimate element of a list to indicate unambiguously whether all the elements apply ("and") or whether they are mutually exclusive ("or").
Figures
Layout of figures
Figures shall be prepared in accordance to ETSI Drafting Rules, clauses 5.1 and 7.2 for SDL and MSC diagrams. Details concerning "Supported file formats" are available on the editHelp! website. For an easy application of the ETSI styles, download the ETSI "Styles toolbar" from the editHelp! website and see clause 12 of the present document.
- The figure number and title shall be below the figure. An explicit figure title is optional.
- Notes to figures shall be treated independently from notes integrated in the text and may contain requirements. They shall be located before the title of the relevant figure.
- To generate a list of figures see #List of figures and/or tables.
- Use TF style for the figure number and title.
- Use FL style on the paragraph which contains the figure itself.
- Use NF style for the notes to figures. Separate "NOTE:" from the text of the note with a tab. The note numbering restart on each figure.
- If applicable, the figure number is followed by a colon, a space and the figure title.
- Maximum width for figures is 17 cm and maximum height is 22 cm.
- For automatic figure numbering see ETSI Drafting Rules, clause 6.9.2.
Format the list as indicated below:
NOTE: This is a note to figure 1. (Style NF) Figure 1: Production of deliverables (Style TF)
Figure numbering
Figures may be numbered sequentially throughout the ETSI deliverable without regard to the clause numbering, e.g. first figure is figure 1 and the twentieth figure is figure 20.
Figures may also be numbered taking account of clause numbering.
EXAMPLE 1: First figure in clause 5 is figure 5.1, second figure in clause 5.1.1 is figure 5.2, third figure in clause 5.2.3 is figure 5.3.
EXAMPLE 2: First figure in clause 7 is figure 7.1, fifth figure in clause 7 is figure 7.5.
EXAMPLE 3: First figure in clause 7.3.2 is figure 7.3.2.1, fifth figure in clause 7.3.2 is figure 7.3.2.5.
One level of subdivision may only be used (e.g. figure 1 may be subdivided as 1 a), 1 b), 1 c), etc.).
Figures of an annex shall be preceded by the letter designating that annex followed by a full-stop (e.g. figure B.1, figure C.4). The numbering shall start afresh with each annex.
For added or removed figures further to the revision of a deliverable, see also clause 10.
How to insert a figure
If there is a need to insert a figure, from another source document, in an ETSI deliverable be aware that, ETSI deprecates the reproduction of third parties material in an ETSI deliverable (see #Use and reproduction of text, signs and material legally protected).
If you are authorised by the author to reproduce the figure, the steps below should be followed to avoid figures to be corrupted or lost:
- Right-click the figure you want to copy from the source document.
- In the destination document, select "Paste" - "Paste Special", and the appropriate graphical tool (e.g. Microsoft® Office GraphicObject).
- MS Word opens the graphical software window: select "Edit" - "Paste Special" and choose the required output format.
- After closing this window, the figure appears as an object embedded into the Word document, which allows safe further edits.