3GPP TR 21.801 V11.1.

0 (2012-06)
Technical Report

3rd Generation Partnership Project; Technical Specification Group Services and System Aspects; Specification drafting rules (Release 11)

The present document has been developed within the 3rd Generation Partnership Project (3GPP TM) and may be further elaborated for the purposes of 3GPP. The present document has not been subject to any approval process by the 3GPP Organizational Partners and shall not be implemented. This Specification is provided for future development work within 3GPP only. The Organizational Partners accept no liability for any use of this Specification. Specifications and reports for implementation of the 3GPP TM system should be obtained via the 3GPP Organizational Partners' Publications Offices.

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

Keywords
GSM, UMTS, LTE, methodology

3GPP Postal address

3GPP support office address

650 Route des Lucioles - Sophia Antipolis Valbonne - FRANCE Tel.: +33 4 92 94 42 00 Fax: +33 4 93 65 47 16

Internet
http://www.3gpp.org

Copyright Notification No part may be reproduced except as authorized by written permission. The copyright and the foregoing restriction extend to reproduction in all media.
2012, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TTA, TTC). All rights reserved. UMTS is a Trade Mark of ETSI registered for the benefit of its members 3GPP is a Trade Mark of ETSI registered for the benefit of its Members and of the 3GPP Organizational Partners LTE is a Trade Mark of ETSI currently being registered for the benefit of its Members and of the 3GPP Organizational Partners GSM and the GSM logo are registered and owned by the GSM Association

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

Contents
Foreword............................................................................................................................................................. 6 1 2 3
3.1 3.2

Scope ........................................................................................................................................................ 7 References ................................................................................................................................................ 7 Definitions and abbreviations................................................................................................................... 7

Definitions ......................................................................................................................................................... 7 Abbreviations ..................................................................................................................................................... 8

4
4.1 4.2 4.3 4.4 4.5 4.6 4.7

General principles .................................................................................................................................... 8

Objective ............................................................................................................................................................ 8 Homogeneity...................................................................................................................................................... 8 Consistency of 3GPP TSs and 3GPP TRs ......................................................................................................... 8 Equivalence of official language versions ......................................................................................................... 9 Fitness for implementation as a national, regional or international standard ..................................................... 9 Planning ............................................................................................................................................................. 9 (void) ................................................................................................................................................................. 9

5
5.1 5.1.1 5.1.2 5.1.3 5.2 5.2.1 5.2.1A 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.2.7 5.2.8 5.2.9 5.3

Structure ................................................................................................................................................... 9
Subdivision of the subject matter ....................................................................................................................... 9 General ......................................................................................................................................................... 9 Subdivision of the subject matter within a series of parts .......................................................................... 10 Subdivision of the subject matter within an individual 3GPP TS or 3GPP TR.......................................... 11 Description and numbering of divisions and subdivisions............................................................................... 11 Parts and sub-parts ..................................................................................................................................... 11 General numbering issues .......................................................................................................................... 11 Clause ......................................................................................................................................................... 12 Subclause ................................................................................................................................................... 12 Paragraph ................................................................................................................................................... 12 Lists ............................................................................................................................................................ 13 Annex ......................................................................................................................................................... 13 Bibliography............................................................................................................................................... 14 Index........................................................................................................................................................... 14 Change history ........................................................................................................................................... 14 Consistency amongst Releases ........................................................................................................................ 14

6
6.1 6.1.1 6.1.2 6.1.2A 6.1.3 6.1.3A 6.1.4 6.2 6.2.1 6.2.2 6.3 6.3.1 6.3.2 6.3.3 6.3.4 6.3.5 6.3.6 6.3.7 6.3.8 6.4 6.4.1

Drafting .................................................................................................................................................. 15
Preliminary informative elements .................................................................................................................... 15 Title page.................................................................................................................................................... 15 Table of contents ........................................................................................................................................ 16 (void) .......................................................................................................................................................... 16 Foreword .................................................................................................................................................... 16 (void) .......................................................................................................................................................... 17 Introduction ................................................................................................................................................ 17 General normative elements ............................................................................................................................ 17 Scope .......................................................................................................................................................... 17 References .................................................................................................................................................. 17 Technical normative elements ......................................................................................................................... 18 Definitions .................................................................................................................................................. 18 Symbols and abbreviations......................................................................................................................... 19 Requirements.............................................................................................................................................. 19 Sampling .................................................................................................................................................... 20 Test methods .............................................................................................................................................. 20 Classification and designation .................................................................................................................... 20 Marking, labelling and packaging .............................................................................................................. 20 Normative annexes ..................................................................................................................................... 20 Supplementary informative elements............................................................................................................... 21 Informative annexes ................................................................................................................................... 21

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

6.4.2 Bibliography............................................................................................................................................... 21 6.4.3 Index........................................................................................................................................................... 21 6.4.4 Change history ........................................................................................................................................... 21 6.5 Other informative elements.............................................................................................................................. 21 6.5.1 Notes and examples integrated in the text .................................................................................................. 21 6.5.2 Footnotes to the text ................................................................................................................................... 22 6.6 Common rules and elements ............................................................................................................................ 22 6.6.1 Verbal forms for the expression of provisions ........................................................................................... 22 6.6.2 Spelling and abbreviation of names of organizations, and style................................................................. 22 6.6.2A Use of capital letters ................................................................................................................................... 22 6.6.2B Pagination ................................................................................................................................................... 22 6.6.3 Use of trade names ..................................................................................................................................... 23 6.6.4 Figures ........................................................................................................................................................ 23 6.6.4.1 Usage .................................................................................................................................................... 23 6.6.4.2 Format .................................................................................................................................................. 23 6.6.4.3 Numbering ............................................................................................................................................ 23 6.6.4.4 Layout of title ....................................................................................................................................... 24 6.6.4.5 Choice of letter symbols, style of lettering, and labelling .................................................................... 24 6.6.4.6 Technical drawings ............................................................................................................................... 24 6.6.4.7 Diagrams .............................................................................................................................................. 24 6.6.4.8 Notes to figures..................................................................................................................................... 24 6.6.4.9 Footnotes to figures .............................................................................................................................. 24 6.6.5 Tables ......................................................................................................................................................... 24 6.6.5.1 Usage .................................................................................................................................................... 24 6.6.5.2 Numbering ............................................................................................................................................ 25 6.6.5.3 Layout of title ....................................................................................................................................... 25 6.6.5.4 Headings ............................................................................................................................................... 25 6.6.5.5 Continuation of tables ........................................................................................................................... 26 6.6.5.6 Notes to tables ...................................................................................................................................... 26 6.6.5.7 Footnotes to tables ................................................................................................................................ 26 6.6.6 References .................................................................................................................................................. 26 6.6.6.1 General ................................................................................................................................................. 26 6.6.6.2 References to the 3GPP TS or 3GPP TR as a whole in its own text..................................................... 26 6.6.6.3 References to elements of text .............................................................................................................. 26 6.6.6.4 References to tables and figures ........................................................................................................... 27 6.6.6.5 References to other documents ............................................................................................................. 27 6.6.6.5.1 General ............................................................................................................................................ 27 6.6.6.5.2 Specific references .......................................................................................................................... 27 6.6.6.5.3 Non-specific references .................................................................................................................. 27 6.6.6.6 Numbering ............................................................................................................................................ 28 6.6.7 Representation of numbers and numerical values ...................................................................................... 28 6.6.8 Quantities, units, symbols and signs .......................................................................................................... 28 6.6.9 Mathematical formulae .............................................................................................................................. 29 6.6.9.1 Types of equations ................................................................................................................................ 29 6.6.9.2 Presentation .......................................................................................................................................... 29 6.6.9.3 Numbering ............................................................................................................................................ 30 6.6.10 Indication of dimensions and tolerances .................................................................................................... 30

Presentation of computer language and other code ................................................................................ 30 (void) ............................................................................................................... 31 (void) ............................................................................................................... 32 Drafting and presentation of terms and definitions.................................... 33

Annex A (informative): Annex B (informative): Annex C (normative): C.1

C.1.1 C.1.2 C.1.3 C.1.4 C.1.5

General principles .................................................................................................................................. 33

Rules for development ..................................................................................................................................... 33 Types of standard ............................................................................................................................................. 33 Choice of concepts to be defined ..................................................................................................................... 33 Avoidance of duplications and contradictions ................................................................................................. 33 Drafting of definitions ..................................................................................................................................... 33

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

C.2
C.2.1 C.2.2

Independent terminology deliverables ................................................................................................... 34

Arrangement .................................................................................................................................................... 34 Languages other than official languages .......................................................................................................... 34

C.3
C.3.1 C.3.2 C.3.3 C.3.4 C.3.5 C.3.6 C.3.7 C.3.8 C.3.9

Presentation ............................................................................................................................................ 34
Rules ................................................................................................................................................................ 34 Layout .............................................................................................................................................................. 34 Synonyms ........................................................................................................................................................ 34 Grammatical form of terms .............................................................................................................................. 35 Symbol for missing terms ................................................................................................................................ 35 Multiple meanings ........................................................................................................................................... 35 Codes for countries and for languages ............................................................................................................. 35 Parentheses and brackets ................................................................................................................................. 35 Examples and notes ......................................................................................................................................... 35

Annex D (normative): D.1

D.1.1 D.1.2 D.1.3

Drafting of the title of a 3GPP TS or 3GPP TR .......................................... 36

Elements of the title................................................................................................................................ 36

The introductory element ................................................................................................................................. 36 The main element ............................................................................................................................................ 36 The complementary element ............................................................................................................................ 36

D.2 D.3

Avoidance of unintentional limitation of the scope ............................................................................... 36 Wording.................................................................................................................................................. 36 Verbal forms for the expression of provisions ............................................ 37 Checklist concerning quantities and units to be used in 3GPP TSs or 3GPP TRs ....................................................................................................... 40 Example layout of a typescript ..................................................................... 40 3GPP styles and various information........................................................... 41

Annex E (normative): Annex F (informative): Annex G (informative): Annex H (informative): H.1 H.2 H.3 H.4 H.5 H.6

The 3GPP styles ..................................................................................................................................... 41 Page numbering, page headers and footers ............................................................................................ 41 Configuration of the Windows environment .......................................................................................... 42 Sequence numbering .............................................................................................................................. 42 Supported file formats ............................................................................................................................ 43 Quick tips to working with your document ............................................................................................ 43 Text containing SDL, program code, ICS and TTCN ................................ 45

Annex I (normative): I.1 I.2 I.3 I.4

SDL diagrams......................................................................................................................................... 45 Program code ......................................................................................................................................... 45 Implementation Conformance Statement (ICS) proforma tables ........................................................... 45 Tree and Tabular Combined Notation (TTCN) ...................................................................................... 45 Endorsement of documents from other standards organizations ............. 46

Annex J (normative): J.1 J.2 J.3 J.4

General ................................................................................................................................................... 46 Title ........................................................................................................................................................ 46 Requirements.......................................................................................................................................... 47 Annex ..................................................................................................................................................... 47 Change history ............................................................................................... 48

Annex K (informative):

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

Foreword
This Technical Report has been produced by the 3rd Generation Partnership Project (3GPP) Secretariat on behalf of the 3GPP Technical Specification Groups (TSGs). The contents of the present document are subject to continuing work within the TSG and may change following formal TSG approval. Should the TSG modify the contents of the present document, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: Version x.y.z where: x the first digit: 1 presented to TSG for information; 2 presented to TSG for approval; 3 or greater indicates TSG approved document under change control. y the second digit is incremented for all changes of substance, i.e. technical enhancements, corrections, updates, etc. z the third digit is incremented when editorial only changes have been incorporated in the document. The present document is based ISO/IEC Directives. Most clauses of the ISO/IEC document have been retained, while some clauses have been modified or deleted. Additional material has been inserted. Items concerning word-processor specific layout and formatting matters when using the Microsoft Word for Windows based skeleton documents and templates are shown with shaded background. Boiler plate text (i.e. text which shall be directly used in 3GPP specifications) is represented by italic characters.

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

Scope

The present document specifies rules for the structure and drafting of documents intended to become a 3GPP Technical Specification or Technical Report. These rules are intended to ensure that such documents are drafted in as uniform a manner as is practicable, irrespective of the technical content. The present document is based on the ISO/IEC Directives, Part 3, but is a self-contained document that will be maintained as such. These drafting rules complement the 3GPP Working Procedures.

References
References are either specific (identified by date of publication, edition number, version number, etc.) or non-specific. For a specific reference, subsequent revisions do not apply. For a non-specific reference, the latest version applies. In the case of a reference to a 3GPP document (including a GSM document), a non-specific reference implicitly refers to the latest version of that document in the same Release as the present document. [1] [2] [3] ISO/IEC Directives - Part 3 (1997): "Rules for the structure and drafting of International Standards". ISO/IEC Guide 2:1996: "Standardization and related activities - General vocabulary". 3GPP TR 21.905: "Vocabulary for 3GPP Specifications".

The following documents contain provisions which, through reference in this text, constitute provisions of the present document.

3
3.1

Definitions and abbreviations

Definitions

For the purposes of the present document, the terms and definitions given in 3G TR 21.905 [3] and the following apply: informative elements: those elements that provide additional information intended to assist the understanding or use of the 3GPP TS or 3GPP TR instruction: provision that conveys an action to be performed [ISO/IEC Guide 2:1996, definition 7.3] normative element: an element setting out provisions to which it is necessary to conform in order to be able to claim compliance with the Technical Specification provision: expression in the content of a normative document, that takes the form of a statement, an instruction, a recommendation or a requirement [ISO/IEC Guide 2:1996, definition 7.1] NOTE: These types of provision are distinguished by the form of wording they employ; e.g. instructions are expressed in the imperative mood, recommendations by the use of the auxiliary "should" and requirements by the use of the auxiliary "shall" (see annex E).

recommendation: provision that conveys advice or guidance [ISO/IEC Guide 2:1996, definition 7.4] requirement: provision that conveys criteria to be fulfilled [ISO/IEC Guide 2:1996, definition 7.5] statement: provision that conveys information [ISO/IEC Guide 2:1996, definition 7.2]

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

3.2
ICS PDF SDL TR TS TTCN

Abbreviations
Implementation Conformance Statement Portable Document Format Specification and Description Language Technical Report Technical Specification Tree and Tabular Combined Notation

For the purposes of the present document, the abbreviations given in 3GPP TR 21.905 [3] and the following apply:

4
4.1

General principles
Objective

The objective of a 3GPP Technical Specification or Technical Report is to define clear and unambiguous provisions in order to facilitate international trade and communication. To achieve this objective, the 3GPP TS or TR shall: be as complete as necessary within the limits specified by its scope; be consistent, clear and accurate; provide a framework for future technological development; and be comprehensible to qualified persons who have not participated in its preparation.

4.2

Homogeneity

Uniformity of structure, of style and of terminology shall be maintained not only within each 3GPP TS or 3GPP TR, but also within a series of associated 3GPP TSs or 3GPP TRs. The structure of associated 3GPP TSs or 3GPP TRs and the numbering of their clauses shall, as far as possible, be identical. Analogous wording shall be used to express analogous provisions; identical wording shall be used to express identical provisions. The same term shall be used throughout each 3GPP TS or 3GPP TR or series of 3GPP TSs or 3GPP TRs to designate a given concept. The use of an alternative term (synonym) for a concept already defined shall be avoided. As far as possible, only one meaning shall be attributed to each term chosen. These requirements are particularly important not only to ensure comprehension of the 3GPP TS or 3GPP TR but also to derive the maximum benefit available through automated text processing techniques. See also clause 5.3.

4.3

Consistency of 3GPP TSs and 3GPP TRs

In order to achieve the aim of consistency within the complete body of 3GPP TSs and 3GPP TRs, the text of every 3GPP TS and 3GPP TR shall be in accordance with the relevant provisions of existing basic 3GPP TSs and 3GPP TRs. This relates particularly to: standardized terminology; principles and methods of terminology; quantities, units and their symbols; abbreviations; bibliographic references; and graphical symbols.

3GPP

Release 11

3GPP TR 21.801 V11.1.0 (2012-06)

In addition, for specific technical aspects, the relevant provisions of general 3GPP TSs or 3GPP TRs dealing with the following subjects shall be respected: limits; tolerancing of dimensions and uncertainty of measurement; preferred numbers; statistical methods; environmental conditions and associated tests.

4.4

Equivalence of official language versions

3GPP TSs or 3GPP TRs shall be in the English language only.

4.5

Fitness for implementation as a national, regional or international standard

The content of a 3GPP TS or 3GPP TR shall be drawn up in such a way as to facilitate its direct application and its adoption without change as a national, regional or international standard.

4.6

Planning

In order to ensure the timely publication of a 3GPP TS or 3GPP TR or of a series of associated 3GPP TSs or 3GPP TRs, the intended structure and any interrelationships shall be established before detailed drafting begins. In particular, consideration shall be given to the subdivision of the subject matter (see subclause 5.1). In the case of a multi-part 3GPP TS or 3GPP TR, a list of the intended parts together with their titles shall be drawn up. The rules given in the present document shall be applied from the very beginning of the work and throughout all subsequent stages to avoid delay at any stage.

4.7

(void)

5
5.1
5.1.1

Structure
Subdivision of the subject matter
General

3GPP TSs or 3GPP TRs are so diverse that no universally acceptable rules can be established for the subdivision of the subject matter. However, as a general rule, an individual 3GPP TS or 3GPP TR shall be prepared for each subject to be standardized, and published as a complete entity. In specific cases and for practical reasons, for example: the 3GPP TS or 3GPP TR is likely to become too voluminous; subsequent portions of the content are interlinked; portions of the 3GPP TS or 3GPP TR could be referred to in regulations; or portions of the 3GPP TS or 3GPP TR are intended to serve for certification purposes,

the 3GPP TS or 3GPP TR may be split into separate parts under the same number. This has the advantage that each part can be changed separately when the need arises.

3GPP

Release 11

10

3GPP TR 21.801 V11.1.0 (2012-06)

In particular, the aspects of a product which will be of separate interest to different parties (e.g. manufacturers, operators, certification bodies, legislative bodies) shall be clearly distinguished, preferably as parts of a 3GPP TS or 3GPP TR or as separate 3GPP TSs or 3GPP TRs. Such individual aspects are, for example: performance requirements; maintenance and service requirements; and quality assessment.

The terms that shall be used to designate the divisions and subdivisions that a 3GPP TS or 3GPP TR may have are shown in table 1. Table 1: Names of divisions and subdivisions
Term part clause subclause subclause annex clause subclause Example of numbering 3GPP TS 21.299-1 1 1.1 1.1.1 A A.1 A.1.1

5.1.2

Subdivision of the subject matter within a series of parts

There are two systems in use for subdividing into parts: a) Each part deals with a specific aspect of the subject and can stand alone. b) There are both common and specific aspects to the subject. The common aspects shall be given in part 1. Specific aspects (which may modify or supplement the common aspects and therefore cannot stand alone) shall be given in individual parts. Where the system described in b) is used, care shall be taken that the references from one part to another are always to the latest version. There are two ways to achieve this: If reference is made to a particular element, the reference shall be specific (see subclause 6.6.6.5.2). Since the complete series of parts is normally under the control of the same TSG, the use of non-specific references (see subclause 6.6.6.5.3) is permitted, provided that corresponding changes are implemented simultaneously in all parts.

The use of non-specific references requires a high degree of discipline by the TSG responsible for the 3GPP TS or 3GPP TR. Their use is not permitted between 3GPP TSs or 3GPP TRs of different Technical Bodies except where the reference is intentionally non-specific, i.e. it is accepted that it will be possible to use all future changes of the text referred to for the purposes of the referring 3GPP TS or 3GPP TR. Each part of a multi-part 3GPP TS or 3GPP TR shall be drafted in accordance with the rules for an individual 3GPP TS or 3GPP TR as specified in the present document.

3GPP

Release 11

11

3GPP TR 21.801 V11.1.0 (2012-06)

5.1.3

Subdivision of the subject matter within an individual 3GPP TS or 3GPP TR

Table 2: Example of a typical arrangement of elements in a 3GPP TS or 3GPP TR
Type of element Arrangement of elements in 3GPP TS or 3GPP TR (note 1) Title page Table of contents Permitted content of element(s) in 3GPP TS or 3GPP TR (note 1) Title (generated content, see subclause 6.1.2) Text Figure(s) Table(s) Note(s) Text (no requirements) Figure(s) Table(s) Note(s) Reference(s) Text Figure(s) Table(s) Note(s)

Informative preliminary Introduction

Scope Normative general Reference(s) Definition(s) Symbols and abbreviations Requirements : Normative annex Informative annex, (note 2)

Normative technical

Text Figure(s) Table(s Note(s) Bibliography Informative reference(s) Index (generated content) Informative supplementary Change history (note 3) Table NOTE 1: Bold type = required element; upright type = normative element; italic type = informative element. NOTE 2: Informative annexes shall not contain normative elements. NOTE 3: Provided by the 3GPP Support Team. NOTE 4: Partly provided by the 3GPP Support Team. Informative supplementary

A 3GPP TS or 3GPP TR need not contain all the normative technical elements shown in table 2 and it may contain normative technical elements other than those shown. Both the nature of the normative technical elements and their sequence are determined by the nature of the 3GPP TS or 3GPP TR in question. For an example of numbering of divisions and subdivisions see annex B. A 3GPP TS or 3GPP TR may also contain notes to figures and tables (see subclauses 6.6.4.8, 6.6.4.9, 6.6.5.6 and 6.6.5.7).

5.2
5.2.1

Description and numbering of divisions and subdivisions

Parts and sub-parts

The number of a part shall be indicated by arabic numerals, beginning with 1, following the 3GPP TS or 3GPP TR number and preceded by a hyphen, for example: 3GPP TR 21.999-1, 3GPP TR 21.999-2.

5.2.1A

General numbering issues

Every attempt shall be made to use continuous numbering as described in the remainder of 5.2. However, if continuous numbering cannot be maintained, a new element may 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. clause, subclause, annex, figure, table, note, list).

3GPP

Release 11

12

3GPP TR 21.801 V11.1.0 (2012-06)

EXAMPLE 1:

It is necessary to update a 3GPP TS. A new clause needs to be inserted between the existing clauses 8 and 9. A new clause 8A may be inserted in preference to re-numbering the existing clauses. A new figure needs to be inserted between existing figures 4 and 5. A new figure 4A may be inserted to avoid re-numbering of all subsequent figures.

EXAMPLE 2:

Similarly, an existing element may be deleted and replaced with the term "Void." to minimize disruption to the numbering scheme. However, the title of the deleted element may be retained. EXAMPLE 3: During the updating of a 3GPP TS, it is decided that annex C is no longer required. The title of annex C remains while the content simply becomes "Void.". Later annexes may therefore remain unchanged. It is decided to delete a note 3, so the text of note 3 becomes "Void." and there is no need to re-number note 4.

EXAMPLE 4:

5.2.2

Clause

The clauses in each 3GPP TS or 3GPP TR or part shall be numbered with arabic numerals, beginning with 1 for the "Scope" clause. The numbering should be continuous, see also subclause 5.2.1A. Each clause shall have a title (for formatting see subclause 5.2.3).

5.2.3

Subclause

A subclause is a numbered subdivision of a clause. A primary subclause (e.g. subclause 5.1, 5.2, etc.) may be subdivided into secondary subclauses (e.g. subclauses 5.1.1, 5.1.2, etc.) and this process of subdivision may be continued as far as the sixth heading level (e.g. subclause 6.5.4.3.2.1). Subclauses shall be numbered with arabic numerals, see also subclause 5.2.1A. A subclause should not be created unless there is at least one further subclause at the same level. For example, a piece of text in clause 10 should not be designated subclause "10.1" unless there is also a subclause "10.2". Each subclause shall be given a title, which shall be placed after its number. (Sub)clause titles shall be treated as normal text i.e. no additional capitalization; there should be no full stop at the end of a (sub)clause title.. Use the Heading style appropriate to its level. Separate the number of the heading and the text of the heading with a tab. Do not use automatic heading numbering; you may, however, use it as an initial aid when outlining the structure of your document, as long as it is eliminated before handover to the 3GPP Support Team.

5.2.4

Paragraph

"Hanging paragraphs" such as those shown in the following example should be avoided since reference to them is ambiguous. EXAMPLE: In the following example, the hanging paragraphs indicated cannot be uniquely identified as being in "clause 5" since strictly speaking the paragraphs in 5.1 and 5.2 are also in clause 5. To avoid this problem it would be necessary either to identify the unnumbered paragraphs as subclause "5.1 Xxxxxxxxxxxx" and to renumber the existing 5.1 and 5.2 accordingly (as shown), or to move the hanging paragraphs elsewhere.
Recommended 5 5.1 Designation Xxxxxxxxxxx 5 Designation xxxxxxxxxxxxx } xxxxxxx x Not recommended

3GPP

Release 11 xxxxxxx x xxxxxxx x 5.2 xxxxxxxxxxxxx xxxxxxxxxxxxxxxxx xxxxxxxxxxxxx xxxxxxxxxxxxxxxxx

13 xxxxxxx x xxxxxxx x 5.1

3GPP TR 21.801 V11.1.0 (2012-06) xxxxxxxxxxxxx } xxxxxxxxxxxxx }

hanging paragraphs

Xxxxxxxxxxx xxxxxxxxxxxxx xxxxxxxxxxxxxxxxx

Xxxxxxxxxxx xxxxxxxxxxxxx xxxxxxxxxxxxxxxxx

xxxxxxx x 5.3

xxxxxxx x 5.2

Xxxxxxxxxxx xxxxxxxxxxxxx xxxxxxxxxxxxxxxxx

Xxxxxxxxxxx xxxxxxxxxxxxx xxxxxxxxxxxxxxxxx

xxxxxxx x

xxxxxxx x

xxxxxxxxxxxx xxxxxxxxxxxxx 6 Test report

xxxxxxxxxxxx xxxxxxxxxxxxx 6 Test report

5.2.5

Lists

Lists may be introduced by a sentence, a complete grammatical proposition followed by a colon, or by the first part of a proposition (without a colon), completed by the items in the list. Each item in a list shall be preceded by a dash. EXAMPLE 1: list item 1; list item 2.

If necessary for identification, a lower-case letter followed by a parenthesis may be used. If it is necessary to subdivide an item further in this type of list, arabic numerals followed by a parenthesis shall be used (see also subclause 5.2.1A). EXAMPLE 2: a) list item a; b) list item b; 1) list item a1; 2) list item a2. Respect normal rules of punctuation: if the elements of a list are cast as phrases of a sentence which introduces the list, start each element with a lower case letter and end it with a semicolon. End the last item in the list with a full stop, unless the introductory sentence continues after the end of the list, in which case use the most appropriate punctuation (semicolon, comma, or none). If, however, each element of a list is a self-contained sentence, begin each with a capital letter and end each with a full-stop. Use "and" or "or" at the end (following the semicolon) of the penultimate element of a list to indicate unambiguously whether the elements are combinable or whether they are mutually exclusive. Use the appropriate bullet styles, i.e. styles B1 to B5. Separate the list item identifier (e.g. bullet) and the text with a tab (if not using automatic bullets and numbering). Ensure that the formatting of the lists is consistent throughout the deliverable.

5.2.6

Annex

Each annex shall start on a new page.

3GPP

Release 11

14

3GPP TR 21.801 V11.1.0 (2012-06)

Note:

This is one of the very few places in a TS or a TR where a manual page break is likely to be legitimate. The skeleton model TS and TR documents contain other page or section breaks, for example at the end of the cover page, before the Contents page, before the Foreword and before the Scope clauses, and these are intended to remain in the final document. Elsewhere in 3GPP TSs and TRs, page breaks are better controlled by the use of the "keep lines together" and "keep with next" properties of paragraphs.

For the description of normative and informative annexes, see subclauses 6.3.8 and 6.4.1. Each annex shall be designated by a heading comprising the word "Annex" followed by a capital letter designating its serial order, beginning with "A", e.g. "Annex A" (see also subclause 5.2.1A). The annex heading of a TS shall be followed by the indication "(normative):" or "(informative):", and by the title on the next line. In the case of a TR, the entire document is informative, so the text "(normative):" or "(informative):" shall be omitted. EXAMPLE: Annex A (normative): Title of annex A

Numbers given to the clauses, subclauses, tables, figures and mathematical formulae of an annex shall be preceded by the letter designating that annex followed by a full-stop (e.g. figure B.1, table C.4). The numbering shall start afresh with each annex. A single annex shall be designated "Annex A". Clauses in annex A shall be designated "A.1", "A.2", "A.3", etc. (see also subclause 5.2.1A). For endorsement of documents from other standards organizations, see annex J. Insert a manual page break before the title line of each annex. Use the Heading 8 style (for 3GPP TSs) or Heading 9 style(for 3GPP TRs) for the annex heading. Insert a line break ( "shift" + "enter") between the colon and the title. For all (sub)clause headings use the appropriate Heading styles, starting from Heading 1, e.g. for clause A.1 use Heading 1, for A.1.1 use Heading 2. Do not insert manual page breaks before each subclause of an annex.

5.2.7

Bibliography

A bibliography, if present, shall appear after the penultimate annex entitled "Bibliography".

5.2.8
-

Index

An index, if present, shall appear as the last element. The title shall be "Index". Use Heading 1 style for the title.

5.2.9
-

Change history

Shall appear as the last element (informative annex). Use Heading 1 style for the title.

5.3

Consistency amongst Releases

In line with the general provisions of clause 4.2 (homogeneity), it is essential to preserve insofar as possible the structure of a TS or TR from one Release to another. This is particularly important when voiding clauses (or figures, notes, etc) and when adding new clauses (figures, notes, etc). If a new clause is introduced, it shall be added in the logically correct place and shall be given a new clause number. It is not acceptable to re-use an existing, redundant, clause (ie one which had previously been used but has subsequently been voided). Similarly, if an identical or near identical provision is introduced into two or more Releases, the provision should use the same clause (or figure, note, etc) number in each Release instance of the TS or TR. This may mean introducing void padding clauses (or figures, notes, etc) in older Release instances in order to keep the numbering aligned.

3GPP

Release 11

15

3GPP TR 21.801 V11.1.0 (2012-06)

Example:

The structure of the Release 10 version of a TS is 5.3 Some provision 5.4 Another provision 5.5 A third provision and, due to extra functionality having been added in the Release 11 instance, the structure of the Release 11 version of the TS has become 5.3 5.4 5.5 5.6 5.7 5.8

Some provision Another provision A third provision A new provision for Rel-11 only Another new Rel-11 requirement Something else peculiar to Rel-11

It is now decided to retrospectively add some requirement at Release 10, which will be mirrored in Release 11. The new clause shall have the same number in both Releases, with void padding clauses introduced into the Release 10 instance as necessary. Thus the structure of the Release 10 TS becomes 5.3 Some provision 5.4 Another provision 5.5 A third provision 5.6 Void 5.7 Void 5.8 Void 5.9 An afterthought and that of the Release 11 TS becomes 5.3 5.4 5.5 5.6 5.7 5.8 5.9

Some provision Another provision A third provision A new provision for Rel-11 only Another new Rel-11 requirement Something else peculiar to Rel-11 An afterthought

That is, the new provision takes the clause number 5.9 in each both Releases.

6
6.1
6.1.1

Drafting
Preliminary informative elements
Title page

The title page shall contain the title of the 3GPP TS or 3GPP TR. The wording of the title shall be established by the TSG with the greatest care. While being as concise as possible, it shall indicate, without ambiguity, the subject matter of the 3GPP TS or 3GPP TR in such a way as to distinguish it from that of other 3GPP TSs or 3GPP TRs, without going into unnecessary detail. Any necessary additional particulars shall be given in the scope.

3GPP

Release 11

16

3GPP TR 21.801 V11.1.0 (2012-06)

The title shall be composed of separate elements, each as short as possible, proceeding from the general to the particular. In general, not more than the following three elements shall be used: a) an introductory element "3rd Generation Partnership Project; Technical Specification Group nn;" (where nn indicates the particular TSG concerned); b) a main element (obligatory) indicating the principal subject treated within that general field; c) a complementary element (optional) indicating the particular aspect of the principal subject or giving details that distinguish the 3GPP TS or 3GPP TR from other 3GPP TSs or 3GPP TRs, or other parts of the same 3GPP TS or 3GPP TR. d) in parentheses, "Release yyyy" where yyyy indicates the Release identifier of the Release (e.g. Release 1999, Release 4). See also annex D. NOTE: The 3GPP Secretariat is responsible for the final preparation of the title page.

For multi-part deliverables, all the individual titles in a series of parts shall contain the same introductory element (if present) and main element, while the complementary element shall be different in each case in order to distinguish the parts from one another. The complementary element shall be preceded in each case by the designation "Part :". For endorsement of documents from other standards organizations, see annex J.

6.1.2
-

Table of contents

The table of contents shall be generated automatically and shall not be set manually. The title shall be "Contents". Use the TT style for the title. Use the field {TOC \o} for the table itself. The 3GPP Support Team is responsible for the final layout of the table of contents.

NOTE:

6.1.2A 6.1.3

(void) Foreword

The foreword shall appear in each 3GPP TS or 3GPP TR. It shall not contain requirements, figures or tables. It consists of a general part giving information on: the designation and name of the TSG that prepared the 3GPP TS or 3GPP TR; information regarding the approval of the 3GPP TS or 3GPP TR;

and a specific part that shall give as many of the following as are appropriate: an indication of any other organization that has contributed to the preparation of the 3GPP TS or 3GPP TR; a statement that the 3GPP TS or 3GPP TR cancels and replaces other documents in whole or in part; a statement of significant technical changes from the previous version of the 3GPP TS or 3GPP TR; the relationship of the 3GPP TS or 3GPP TR to other 3GPP TSs or 3GPP TRs or other documents.

For multi-part deliverables, the first part shall include in its foreword an explanation of the intended structure of the series. In the foreword of each part belonging to the series, a reference shall be made to the titles of all other parts, if they are known.

3GPP

Release 11

17

3GPP TR 21.801 V11.1.0 (2012-06)

6.1.3A 6.1.4

(void) Introduction

The introduction is an optional preliminary element used, if required, to give specific information or commentary about the technical content of the 3GPP TS or 3GPP TR, and about the reasons prompting its preparation. It shall not contain requirements. The introduction shall not be numbered unless there is a need to create numbered subdivisions. In this case, it shall be numbered 0 with subclauses being numbered 0.1, 0.2, etc. Any numbered figure, table or displayed formula shall be numbered normally beginning with 1 (see also subclause 5.2.1A).

6.2
6.2.1

General normative elements

Scope

This element shall be clause 1 of each 3GPP TS or 3GPP TR and define without ambiguity the subject of the 3GPP TS or 3GPP TR and the aspect(s) covered, thereby indicating the limits of applicability of the 3GPP TS or 3GPP TR or particular parts of it. It shall not contain requirements. The scope shall be succinct so that it can be used as a summary for bibliographic purposes. This element shall be worded as a series of statements of fact. Forms of expression such as the following shall be used: "The present document specifies

the functional requirements for " a method of " the characteristics of "

establishes

a system for " general principles for "

gives guidelines for " gives terms and definitions "

Statements of applicability of the 3GPP TS or 3GPP TR shall be introduced by the following wording: "The present document is applicable to "

6.2.2

References

This is an optional element which shall be provided if references are made to other documents. References shall normally be given to Standards and Recommendations issued by recognized standardization bodies. Referencing of documents other than Standards and Recommendations are allowed under the following conditions: all referenced text shall be publicly available in the English language during the approval phases and for the expected lifetime of the 3GPP TS or 3GPP TR, via the originating body or via the 3GPP Support Team; if public availability cannot be guaranteed over a period of time as stated above, the originating body of the referenced text shall give 3GPP or its constituent Organizational Partners the right to reproduce the text; if the referenced text will not be made publicly available otherwise, agreement permitting 3GPP or its Organizational Partners to take over the copying and distribution rights will be required, in which case it shall be made available to 3GPP or its Organizational Partners in an agreed electronic format; all copyright and other IPR issues shall have been settled; the 3GPP Support Team shall establish and maintain a list of the referenced documents and the relevant external bodies, for document tracking and cross-referencing purposes, and keep the necessary liaison with the originating body.

3GPP

Release 11

18

3GPP TR 21.801 V11.1.0 (2012-06)

The list of references shall be introduced by the wording given in the approved 3GPP TS / TR template. The list shall not include the following: documents that are not publicly available; documents which are not explicitly cited in the provisions of the deliverable (such documents may be listed in a bibliography (see subclause 6.4.2)). Use the EX style, if using numbered references; enclose the numbers in square brackets and separate the numbering from the title with a tab (you may use sequence fields for automatically numbering references, see clause H.4: "Sequence numbering"). Use the Normal style, if not using numbered references.

EXAMPLE 1: [1] EXAMPLE 2: 3GPP TS 21.299 (V1.1): "Title". In documents intended to be formally issued as publications of the Standards Development Organizations which comprise the Organizational Parnters of 3GPP, references shall not be made to internal working documents of 3GPP which are not issued as such formal publications. Examples of documents which shall not be referenced are: Contributions to meetings ("TDocs"); Reports of meetings; Internal Technical Reports, in particular, those of the following series: 10.xx 30.xxx 50.xxx xx.8xx 25.7xx 3GPP TS 21.299 (V1.1): "Title".

If the use in a TS or in a TR (other than those TRs in the list above) of text from such a document is unavoidable the text shall be reproduced in the TS or TR itself (possibly in an annex). Such text may need to be corrected to make it abide by the rules contained in the present TR. The foregoing restriction does not apply to TRs not intended to be formally published by the Organizational Partners.

6.3
6.3.1

Technical normative elements

Definitions

This is an optional element giving definitions necessary for the understanding of certain terms used in the 3GPP TS or 3GPP TR. The following introductory wording, modified as appropriate, given in the 3GPP TS / TR template shall be used. Rules for the drafting and presentation of terms and definitions are given in annex C, together with special rules for terminology standards, such as vocabularies, or nomenclatures. Entries in the definition clause may be numbered. Order the terms alphabetically, unless some logical grouping dictates otherwise. 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, one space, and the definition.

3GPP

Release 11

19

3GPP TR 21.801 V11.1.0 (2012-06)

Use the Normal style.

EXAMPLE: requirement: a provision that conveys criteria to be fulfilled

6.3.2

Symbols and abbreviations

This is an optional element giving a list of the symbols and abbreviations necessary for the understanding of the 3GPP TS or 3GPP TR. Unless there is a need to list symbols in a specific order to reflect technical criteria, all symbols should be listed in alphabetical order in the following sequence: upper case Latin letter followed by lower case Latin letter (A, a, B, b, etc.); letters without indices preceding letters with indices, and with letter indices preceding numerical ones (B, b, C, Cm, C2, c, d, dext, dint, d1, etc.); Greek letters following Latin letters (Z, z, A, a, B, b, L, l, etc.); any other special symbols.

This list shall contain all technical abbreviations/acronyms and their corresponding full terms which are used within the 3GPP TS or 3GPP TR. See also subclause 6.6.2. For convenience, this element may be combined with the definitions in order to bring together terms and their definitions, symbols and abbreviations under an appropriate composite title, for example "Definitions, symbols and abbreviations". Do not number the entries in the symbols and/or abbreviations subclause. Use the EW style. Separate the abbreviation/acronym from the full term with a tab.

EXAMPLE: dB DDI decibel Direct Dialling-In

6.3.3

Requirements

This element is optional. If present, it shall contain the following: a) all characteristics relevant to the aspect(s) of the product(s), process(es) or service(s) covered by the 3GPP TS or 3GPP TR, either explicitly or by reference; b) the required limiting values of quantifiable characteristics. For test methods see subclause 6.3.5. A clear distinction shall be made between requirements, statements and recommendations. Contractual requirements concerning claims, guarantees, covering of expenses, etc. shall not be included. In some product 3GPP TSs or 3GPP TRs, it may be necessary to specify that the product shall be accompanied by warning notices or by instructions to the user or installer, and to specify their nature. On the other hand, requirements concerning use or installation as such shall be included in a separate part or a separate 3GPP TS or 3GPP TR since they are not requirements applicable to the product itself. 3GPP TSs or 3GPP TRs listing characteristics for which suppliers are required to state values that are not specified by the 3GPP TSPP or 3G TR itself shall specify how such values are to be measured and stated. For endorsement of documents from other standards organizations, see annex J.

3GPP

Release 11

20

3GPP TR 21.801 V11.1.0 (2012-06)

6.3.4

Sampling

This optional element specifies the conditions and methods of sampling, as well as the method for the preservation of the sample(s). This element may appear at the beginning of test methods.

6.3.5

Test methods

This optional element gives all the instructions concerning the procedure for determining the values of characteristics, or for checking conformity to stated requirements, and for ensuring the reproducibility of the results. If appropriate, tests shall be identified to indicate whether they are type tests, routine tests, sampling tests and so on. Instructions relating to test methods may be subdivided in the following order (where appropriate): a) principle; b) apparatus; c) preparation and preservation of test samples and test pieces; d) procedure; e) test report. Test methods may be presented as separate clauses, or be incorporated in requirements, or be presented as annexes (see subclause 6.3.8) or as separate parts (see subclause 5.2.1). A test method shall be prepared as a separate 3GPP TS if it is likely to be referred to in a number of other 3GPP TSs. The need for specification of test methods shall be evaluated on a case by case basis. A test specification enables verification that products designed to a standard conform to its requirements. When writing a 3GPP TS you should consider the need for an accompanying test specification. Every requirement of a 3GPP TS specifying a product (equipment, system or service) needs to be testable, and such requirements need to be clearly distinguishable from statements of fact or of supposition. EXAMPLE: Comparing the two sentences below: "On receiving a START CALL message, the terminal shall respond by sending an ACKNOWLEDGE message within a delay of t1." "On receiving a START CALL primitive, the CALL ACTIVATED and shall start timer t2." layer 3 protocol of the terminal shall move to state

It is clear that conformance to the first requirement can be verified by external stimulus and observation, whereas the second puts demands on a conceptual model which cannot be explicitly tested. Whilst requirements of the latter sort are useful - even essential - for describing operational details, the essential behavioural characteristics (normative provisions) are given by requirements of the type of the former, and only these are verifiable.

6.3.6
Void.

Classification and designation Marking, labelling and packaging Normative annexes

6.3.7
Void.

6.3.8

For reasons of convenience it may be decided to place some part of the normative text in an annex. Normative annexes contain provisions to which it is necessary to conform in order to be able to claim compliance with the 3GPP TS. Their status shall be indicated in the heading of the annex (see subclause 5.2.6).

3GPP

Release 11

21

3GPP TR 21.801 V11.1.0 (2012-06)

Normative annexes shall not appear in 3GPP TRs.

6.4
6.4.1

Supplementary informative elements

Informative annexes

For reasons of convenience it may be decided to place some part of the informative text in an annex. Informative annexes give additional information intended to assist the understanding or use of the 3GPP TS (or 3GPP TR) and shall not contain provisions to which it is necessary to conform in order to be able to claim compliance with the 3GPP TS. Their presence is optional and their status shall be indicated in the heading of the annex (see subclause 5.2.6). All annexes in 3GPP TRs are "informative" since 3GPP TRs cannot contain normative provisions. Therefore, the word "informative" shall not appear in the title line of annexes in 3GPP TRs.

6.4.2

Bibliography

The Bibliography identifies documents which are not explicitly cited in the body of the 3GPP TS or 3GPP TR. Format references as described in subclause 6.2.2.

6.4.3
-

Index

Format the index in a section having two columns separated by 0,5 cm using the field {INDEX \e "" \c "2"}.

6.4.4

Change history

A history box is provided by the 3GPP Support Team as the final element in a 3GPP TS or 3GPP TR and shows the major milestones in the life of a document. See also clause H.6. NOTE: The 3GPP Support Team is responsible for the final preparation of the history box.

6.5
6.5.1

Other informative elements

Notes and examples integrated in the text

Notes and examples integrated in the text of a 3GPP TS or 3GPP TR shall only be used for giving additional information intended to assist the understanding or use of the 3GPP TS or 3GPP TR. They shall not contain provisions to which it is necessary to conform in order to be able to claim compliance with a 3G TS. Notes and examples should preferably be placed at the end of the clause or subclause, or after the paragraph, to which they refer. A single note in a (sub)clause shall be preceded by "NOTE:", placed at the beginning of the first line of the text of the note. When several notes occur within the same element (e.g. subclause), they shall be designated "NOTE 1:", "NOTE 2:", "NOTE 3:", etc. (see also subclause 5.2.1A). The word NOTE shall appear in upper case. Use the NW or NO style. Separate NOTE: from the text of the note with a tab.

A single example in a (sub)clause shall be preceded by "EXAMPLE:", placed at the beginning of the first line of the text of the example. When several examples occur within the same element (e.g. subclause), they shall be designated "EXAMPLE 1:", "EXAMPLE 2:", "EXAMPLE 3:", etc. (see also subclause 5.2.1A).

3GPP

Release 11

22

3GPP TR 21.801 V11.1.0 (2012-06)

When there is a danger that it might 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". The word EXAMPLE shall appear in upper case. Use the EX style. Separate EXAMPLE: from the text of the example with a tab.

EXAMPLE 1: NOTE 1: Note text formatted with the NW style will be formatted without a space after the paragraph. NOTE 2: Note text formatted with the NO style will be formatted with a space after the paragraph. END of EXAMPLE 1

6.5.2

Footnotes to the text

Footnotes shall not be used in 3GPP TSs or 3GPP TRs.

6.6
6.6.1

Common rules and elements

Verbal forms for the expression of provisions

A 3GPP TS does not in itself impose any obligation upon anyone to follow it. However, such an obligation may be imposed, for example, by legislation or by a contract. In order to be able to claim compliance with a 3GPP TS, the user needs to be able to identify the requirements that are obligatory. The user also needs to be able to distinguish these requirements from other provisions where there is a certain freedom of choice. Clear rules for the use of verbal forms (including modal auxiliaries) are therefore essential. Annex E gives, in the first column of each table, the verbal form that shall be used to express each kind of provision. The equivalent expressions given in the second column shall be used only in exceptional cases when the form given in the first column cannot be used for linguistic reasons.

6.6.2

Spelling and abbreviation of names of organizations, and style

The spelling of the names of organizations, and their abbreviations, shall be as used by those organizations. To facilitate understanding by all readers, the style shall be as simple and concise as possible. This is particularly important for those readers whose first language is not English. The "Shorter Oxford English Dictionary" and the "Concise Oxford Dictionary" are suggested. Abbreviations shall be used with care, and their use shall be limited to those cases where it is not likely to cause confusion. An abbreviation shall be defined only if used subsequently in the 3GPP TS or 3GPP TR. The general rule is that abbreviations consisting of the initial letters of words be printed in lower-case letters (for example, "a.c." for "alternating current") and a full-stop be placed after each letter. Where, however, an abbreviation comprises capital letters, no full-stops are required.

6.6.2A

Use of capital letters

"user" is preferred to "User".

Unnecessary use of capital letters should be avoided. EXAMPLE:

6.6.2B

Pagination

Unnecessary pagination, (i.e. use of hard page breaks) should be avoided.

3GPP

Release 11

23

3GPP TR 21.801 V11.1.0 (2012-06)

Use Format | Paragraph | Text Flow | Keep Lines Together and Keep with Next attributes instead of "hard" page breaks.

6.6.3

Use of trade names

A correct designation or description of a product shall be given rather than a trade name (brand name). Proprietary trade names (i.e. trade marks) for a particular product should as far as possible be avoided, even if they are in common use. If, exceptionally, trade names cannot be avoided, their nature shall be indicated, e.g. by the symbol for a registered trade mark (see example 1). EXAMPLE 1: Instead of "Teflon", write "polytetrafluoroethylene (PTFE)".

If it is known that only one product is currently available that is suitable for the successful application of the standard, the trade name of the product may be given in the text of the standard but shall be associated with a note as shown in example 2. EXAMPLE 2: NOTE: " [trade name of product] is the trade name of a product supplied by [supplier] . This information is given for the convenience of users of the present document and does not constitute an endorsement by 3GPP of the product named. Equivalent products may be used if they can be shown to lead to the same results."

If it is considered to be essential to give an example (or examples) of commercially available products suitable for successful application of the standard because the product characteristics are difficult to describe in detail, trade names may be given in a note as shown in example 3. EXAMPLE 3: NOTE: " [trade name(s) of product(s)] is (are) an example(s) of a suitable product(s) available commercially. This information is given for the convenience of users of the present document and does not constitute an endorsement by 3GPP of this (these) product(s)."

6.6.4
6.6.4.1

Figures
Usage

Figures should be used wherever appropriate to present information in an easily comprehensible form.

6.6.4.2
-

Format

Use the TH style on the paragraph which contains the figure itself. Maximum size for figures is 17 cm by 22 cm.

Where SDL, Program Code, ICS, or TTCN is included in figures it shall be prepared in accordance with annex I.

6.6.4.3

Numbering

Figures may be numbered sequentially throughout the document without regard to the clause numbering, e.g. first figure is figure 1 and the twentieth figure (in, say clause 7) is figure 20. Figures may also be numbered taking account of clause or subclause numbering. EXAMPLE 1: EXAMPLE 2: First figure in clause 7 is figure 7.1, fifth figure in clause 7 is figure 7.5. First figure in subclause 7.3.2 is figure 7.3.2.1, fifth figure in subclause 7.3.2 is figure 7.3.2.5.

One level of subdivision only is permitted (e.g. figure 1 may be subdivided as 1 a), 1 b), 1 c), etc.). See also subclause 5.2.1A. For the numbering of figures in annexes, see subclause 5.2.6.

3GPP

Release 11

24

3GPP TR 21.801 V11.1.0 (2012-06)

You may use sequence fields for automatically numbering figures. See clause H.4: "Sequence numbering".

6.6.4.4

Layout of title

The figure title shall be below the figure. An explicit figure name is optional. See the following examples: EXAMPLE 1: Figure 1: Details of apparatus EXAMPLE 2: Figure 1 Use the TF style. If applicable, the figure number is followed by a colon, a space and the figure name

6.6.4.5
-

Choice of letter symbols, style of lettering, and labelling

Use Arial font. Use a font size of at least 8 points (final size), to ensure legibility.

6.6.4.6
Void.

Technical drawings

6.6.4.7
Void.

Diagrams

6.6.4.8

Notes to figures

Notes to figures shall be treated independently from notes integrated in the text (see subclause 6.5.1). They shall be located above the title of the relevant figure. A single note in a figure shall be preceded by "NOTE:". When several notes occur in the same figure, they shall be designated "NOTE 1:", "NOTE 2:", "NOTE 3:", etc. (see also subclause 5.2.1A). A separate numbering sequence shall be used for each figure. Notes to figures may contain requirements. Write notes to a figure using the word processor rather than embedding them in the figure itself. Use the NF style. Separate NOTE: from the text of the note with a tab.

6.6.4.9

Footnotes to figures

Footnotes shall not be used in 3GPP TSs or 3GPP TRs.

6.6.5
6.6.5.1

Tables
Usage

Tables should be used wherever appropriate to present information in an easily comprehensible form. A table within a table is not permitted. Subdivision of a table into subsidiary tables is not permitted. Centre tables horizontally.

3GPP

Release 11

25

3GPP TR 21.801 V11.1.0 (2012-06)

The "space between columns" is 0,1 cm. Maximum width for tables in portrait orientation: 17 cm and for landscape orientation: 22 cm. Set table columns widths in centimetres (not inches). Use borders to separate the rows and columns of tables, as appropriate; the precise format will depend on the structure of each table, but be consistent throughout a deliverable (or series of related deliverables). Borders should be pt single line. Each table shall be followed by an empty "Normal" style paragraph ("Enter" key).

6.6.5.2

Numbering

Tables may be numbered sequentially throughout the document without regard to the clause numbering, e.g. first table is table 1 and the twentieth table (in, say clause 7) is table 20. Tables may also be numbered taking account of clause or subclause numbering. EXAMPLE 1: EXAMPLE 2: First table in clause 7 is table 7.1, fifth table in clause 7 is table 7.5. First table in subclause 7.3.2 is table 7.3.2.1, fifth table in subclause 7.3.2 is table 7.3.2.5.

See also subclause 5.2.1A. For the numbering of tables in annexes, see subclause 5.2.6. You may use sequence fields for automatically numbering tables. See clause H.4: "Sequence numbering".

6.6.5.3

Layout of title

The title shall be above the table. An explicit table name is optional. See the following examples: EXAMPLE 1: Table 1: Electrical properties EXAMPLE 2: Table 1 Use the TH style. If applicable, the table number is followed by a colon, a space and the table name

6.6.5.4

Headings

The first word in the heading of each column shall begin with a capital letter. The units used in a given column shall generally be indicated under the column heading. EXAMPLE:
Type Linear density (kg/m) Inside diameter (mm) Outside diameter (mm)

Use of the table headings tool (Table, Heading row repeat) is encouraged for tables that require more than one page. Use the following styles: Table Headings Text Left justified Text Centred TAH TAL TAC

3GPP

Release 11

26

3GPP TR 21.801 V11.1.0 (2012-06)

Text Right justified

TAR

6.6.5.5

Continuation of tables

The column headings shall be repeated on all pages after the first (see subclause 6.6.5.4).

6.6.5.6

Notes to tables

Notes to tables shall be treated independently from notes integrated in the text (see subclause 6.5.1). They shall be located within the frame of the relevant table. A single note in a table shall be preceded by "NOTE:". When several notes occur in the same table, they shall be designated "NOTE 1:", "NOTE 2:", "NOTE 3:", etc. (see also subclause 5.2.1A). A separate numbering sequence shall be used for each table. Notes to tables may contain requirements. Use the TAN style. Include notes to a table within its borders in one cell, at the bottom. Merge all cells to one, as in the following example:

EXAMPLE:
Column 1 cell Column 2 cell NOTE: This cell is a merged cell. Column 3 cell Column 4 cell

6.6.5.7

Footnotes to tables

Footnotes shall not be used in 3GPP TSs or 3GPP TRs.

6.6.6
6.6.6.1

References
General

As a general rule, references to particular pieces of text shall be used instead of repetition of the original source material, since such repetition involves the risk of error or inconsistency and increases the length of the document. However, if it is considered necessary to repeat such material, its source shall be identified precisely. References shall be made in the forms indicated in subclauses 6.6.6.2 to 6.6.6.5 and shall not be made to page numbers.

6.6.6.2

References to the 3GPP TS or 3GPP TR as a whole in its own text

The form "the present document " shall be used.

6.6.6.3

References to elements of text

Use, for example, the following forms: "in accordance with clause 3"; "according to subclause 3.1"; "as specified in subclause 3.1 b)"; "details as given in subclause 3.1.1"; "see annex B"; "the requirements given in clause B.2"; "see the note in table 2";

3GPP

Release 11

27

3GPP TR 21.801 V11.1.0 (2012-06)

''see example 2 in subclause 6.6.3"; "see note 3 in subclause 6.6.1".

It is required to use the terms clause and annex where applicable. It is unnecessary to use the term "subclause". If there is a need to refer to an unnumbered list item in another standard, the following formulation shall be used: "as specified in 3.1, second list item". Lower case letters are recommended (e.g. clause 1, annex A), however capital letters are also acceptable (e.g. Clause 1, Annex A). Usage should be consistent throughout the document.

6.6.6.4

References to tables and figures

Every table and figure included in the 3GPP TS or 3GPP TR shall be referred to in the text. Use, for example, the following forms: "given in table 2"; "(see table B.2)"; "shown in figure A.6"; "(see figure 3)".

Lower case letters are recommended (e.g. table 1, figure 2), however capital letters are also acceptable (e.g. Table 1, Figure 2). Usage should be consistent throughout the document.

6.6.6.5
6.6.6.5.1

References to other documents

General

References to other documents may be specific or non-specific. All references, specific and non-specific, shall be given in the "References" clause (see subclause 6.2.2).

6.6.6.5.2

Specific references

Except as provided for in 6.6.6.5.3, references shall be specific (identified by date of publication, edition number, version number, etc.). In the body of the text, use the following form: " in accordance with TS 21.299 [n] ".

For specific references, it is permissible to refer to a specific clause, figure or table of the referenced document. However, great care needs to be taken, especially when referencing documents still under development, and such referencing of specific clauses, figures or tables is to be avoided if possible.

6.6.6.5.3

Non-specific references

Non-specific references may be made only if it is accepted that it will be possible to use future changes of the document referred to for the purposes of the referring 3GPP TS or 3GPP TR. In the case of referrences to 3GPP TSs and TRs, unless otherwise indicated, a non-specific reference refers to the TS or TR in the same Release as that of the referring TS or TR. It is implicitly to the latest version of the referenced TS or TR in the Release inquestion. For non-specific references, it is not permissible to cite particular clauses, figures or tables, since it cannot be guaranteed that the numbering will be unchanged in later versions of the referenced document. Use the forms as in 6.6.6.5.2.

3GPP

Release 11

28

3GPP TR 21.801 V11.1.0 (2012-06)

6.6.6.6

Numbering

References in clause 2 shall be numbered sequentially. If a reference is removed when a specification is under change control, the entry in clause 2 shall be replaced by a [void] entry, using the same principle as for deletion of clauses and subclauses. You may use sequence fields for automatically numbering references. See clause H.4: "Sequence numbering".

6.6.7
NOTE:

Representation of numbers and numerical values

In the text below, represents the non-breaking space character.

The decimal sign shall be a comma. The thousand separator shall be a space.

If a value less than 1 is written in decimal form, the decimal sign shall be preceded by a zero. EXAMPLE 1: 0,001 (not ,001)

Each group of three digits reading to the left or to the right of a decimal sign shall be separated by a space from preceding digits or following digits respectively, except for four-digit numbers designating years. EXAMPLE 2: 23456 / 2345 / 2,345 / 2,3456 / 2,34567 but the year 1997

For clarity, the symbol or a lower case x (rather than a point or any other symbol) shall be used to indicate multiplication of numbers and numerical values. EXAMPLE 3: write 1,810-3 (not 1,8 * 10-3 or 1,8 10-3 or 1,8 . 10-3)

To express numbers of items (as opposed to numerical values of physical quantities), the numerals one to nine shall be spelt out in full. EXAMPLE 4: EXAMPLE 5: "Carry out the test on five tubes, each 5 m long." "Select a further 15 tubes for the pressure test."

Preserve document identities as in the original titles. EXAMPLE 6: EXAMPLE 7: ISO/IEC10531-1 (not ISO/IEC 10531-1). 3GPPTR21.801.

Put a non-breaking space between a number and its unit - including the percent sign (%) - even if the unit is not abbreviated: EXAMPLE 8: 2pages 4seconds 15%

Write a number preceded by an unary operator (sign) without an intervening space: EXAMPLE 9: a level of -3dB

Put a non-breaking space both before and after binary operators (+, -, , etc.): EXAMPLE 10: a+b=c Use non-breaking spaces (Ctrl + Shift + space) for the thousand separator, before and after binary operators and preceding units. Use a non-breaking hyphen (Ctrl + Shift + -) for the minus sign.

6.6.8

Quantities, units, symbols and signs

The units in which any values are expressed shall be indicated.

3GPP

Release 11

29

3GPP TR 21.801 V11.1.0 (2012-06)

6.6.9
6.6.9.1

Mathematical formulae
Types of equations

Equations between quantities are preferred to equations between numerical values. Equations shall be expressed in mathematically correct form, the variables being represented by letter symbols the meanings of which are explained in connection with the equations, unless they appear in a "Symbols and abbreviations" clause (see subclause 6.3.2). Descriptive terms, acronyms or names of quantities shall not be arranged in the form of an equation. EXAMPLE:

t=

1 (6n 2 ( N - 3n + 1))

N - 3n +1 n + j -1 j =1 i= j

( (x

i +2n

- 2 x i +n + x i )) 2

where:

xj are samples of time errors data; N is the total number of samples; t is the time error sampling interval; n is the number of sampling intervals, with n = 1,2,...,integer part (N/3).

6.6.9.2
-

Presentation

Use the EQ style. Insert one tab before the equation to center it.

The equation editor sizes and styles should be respected as shown in the following examples:

3GPP

Release 11

30

3GPP TR 21.801 V11.1.0 (2012-06)

6.6.9.3

Numbering

If it is necessary to number some or all of the formulae in a 3GPP TS or 3GPP TR in order to facilitate cross-reference, arabic numbers in parentheses shall be used, beginning with 1: x2 + y2 < z2 (1)

Equations may be numbered sequentially throughout the document without regard to the clause numbering, e.g. first equation is equation 1 and the twentieth equation (in, say clause 7) is equation 20. Equations may also be numbered taking account of clause or subclause numbering. EXAMPLE 1: EXAMPLE 2: First equation in clause 7 is equation 7.1, fifth equation in clause 7 is equation 7.5. First equation in subclause 7.3.2 is equation 7.3.2.1, fifth equation in subclause 7.3.2 is equation 7.3.2.5.

See also subclause 5.2.1A. For the numbering of equations in annexes see subclause 5.2.6. You may use sequence fields for automatically numbering tables. See clause H.4: "Sequence numbering". Insert a tab between the equation and the number to right-align the number.

6.6.10

Indication of dimensions and tolerances

80 mm25 mm50 mm (not 80 25 50 mm) 80 F2 F or (80 2) F 16 kbit/s to 64 kbit/s (not 16 to 64 kbit/s) 0 C to 10 C (not 0 to 10 C)

Dimensions and tolerances shall be indicated in an unambiguous manner. EXAMPLE 1: EXAMPLE 2: EXAMPLE 3: EXAMPLE 4:

In order to avoid misunderstanding, tolerances on percentages shall be expressed in a mathematically correct form. EXAMPLE 5: EXAMPLE 6: Write "from 63% to 67%" to express a range. Write "(652)%" to express a centre value with tolerance.

The form "652%" shall not be used.

7
-

Presentation of computer language and other code

Use the PL style.

Portions of code (e.g. ASN.1, GDMO, C, C++, etc.) can be included in a 3GPP TS or 3GPP TR but should be clearly marked as such.

3GPP

Release 11

31

3GPP TR 21.801 V11.1.0 (2012-06)

Annex A (informative): (void)

3GPP

Release 11

32

3GPP TR 21.801 V11.1.0 (2012-06)

Annex B (informative): (void)

3GPP

Release 11

33

3GPP TR 21.801 V11.1.0 (2012-06)

Annex C (normative): Drafting and presentation of terms and definitions C.1

C.1.1
Void.

General principles
Rules for development

C.1.2

Types of standard

Terminology may take the form of an independent 3GPP terminology deliverable (a vocabulary or a nomenclature) or be included in a "Definitions" clause in a 3GPP TS or 3GPP TR that also deals with other aspects.

C.1.3

Choice of concepts to be defined

Any term which is not self-explanatory or commonly known and which can be differently interpreted in different contexts shall be clarified by defining the relevant concept. Common dictionary or current technical terms shall be included only if they are used with a specific meaning in the relevant context. Trade names (brand names) and archaic and colloquial terms shall be avoided. Deprecated terms may be included after the preferred term but their nature shall be indicated (by adding the word deprecated, see subclause C.3.3). In an independent terminology deliverable, the concepts defined shall be restricted to the field corresponding to the scope of 3GPP. In other 3GPP TSs or 3GPP TRs, only such concepts shall be defined as are used in those 3GPP TSs or 3GPP TRs, apart from any additional concepts and their terms that may be deemed necessary for the understanding of these definitions.

C.1.4

Avoidance of duplications and contradictions

Before a term and a definition are established for a concept, it should be ascertained that no other term and definition for that concept exist in another 3GPP TS or 3GPP TR. If the concept is used in several 3GPP TSs or 3GPP TRs, it should be defined in the most general of those standards, or in an independent terminology deliverable. The other 3GPP TSs or 3GPP TRs should then refer to this deliverable, without repeating the definition of the concept. When the repetition of a definition is necessary, an informative reference shall be made to the document (3GPP TS or 3GPP TR or other) from which it is reproduced (see subclause 6.6.6.5). If a term and a definition for a concept are established in one 3GPP TS or 3GPP TR, the introduction in another 3GPP TS or 3GPP TR of a different term (synonym) for the defined concept is strongly deprecated.

C.1.5
-

Drafting of definitions

A definition shall not take the form of, or contain, a requirement. The form of a definition shall be such that it can replace the term in context. Additional information shall be given only in the form of examples or notes (see subclause C.3.9).

3GPP

Release 11

34

3GPP TR 21.801 V11.1.0 (2012-06)

A definition given without an indication of its applicability may be taken as representing the general meaning of the term. Special meanings in particular contexts shall be indicated by designating the subject field (see Subclause C.3.6).

C.2
C.2.1

Independent terminology deliverables

Arrangement

An independent terminology deliverable containing terms and definitions should be preferably classified according to the hierarchy of the concepts. The terms and definitions of general concepts shall precede those of less general concepts. If a mixed system of concepts is used in which several groupings (according to different criteria) appear, each grouping shall be kept separate and the relevant criteria shall be indicated. The grouping of terms shall be evident from their numbering.

C.2.2
Void.

Languages other than official languages

C.3
C.3.1
Void.

Presentation
Rules

C.3.2

Layout

The preferred term (set in bold type) shall be placed on a new line, (after its reference number, if used), starting with a lower-case letter except for any capital letters required by the normal written form in running text. The definition shall follow, after a colon and a space. EXAMPLE: delamination: separation of two adjacent plies resulting from a lack of adhesion

C.3.3

Synonyms

Admitted terms (set in normal type in the printed publication) shall each be placed on a new line, after the preferred term. EXAMPLE 1: serializer; parallel-serial converter dynamicizer: functional unit that converts a set of simultaneous signals into a corresponding time sequence of signals

Symbols shall be given following any admitted term(s). Information regarding the units applicable to a quantity shall be given in a note.

3GPP

Release 11

35

3GPP TR 21.801 V11.1.0 (2012-06)

EXAMPLE 2: resistance; R: electric difference divided by current when there is no electromotive force in the conductor NOTE: Resistance is expressed in ohms.

Deprecated, obsolete and superseded terms (in normal type) shall each be placed after the recommended term, after any symbols, and shall be followed by an indication of their status, in parentheses. EXAMPLE 3: radix; base (deprecated): positive integer by which the weight of any digit place is multiplied to obtain the weight of the digit place with the next higher weight

C.3.4

Grammatical form of terms

Terms shall in general be presented in their basic grammatical form, i.e. nouns in the singular, verbs in the infinitive.

C.3.5
Void.

Symbol for missing terms Multiple meanings

C.3.6

If a term is used to represent several concepts, the subject field to which each concept belongs shall be indicated between angle brackets, before the definition. EXAMPLE: die, noun: [extrusion] metal block with a shaped orifice through which plastic material is extruded die, noun: [moulding] assembly of parts enclosing the cavity from which the moulding takes its form die, noun: [punching] tool to punch sheet or film material

C.3.7
Void.

Codes for countries and for languages Parentheses and brackets

C.3.8

Parentheses and square brackets shall be used only if they constitute part of the normal written form of the term. They shall not be used to show alternative terms. EXAMPLE: bis(dimethylthiocarbamyl) disulfide

C.3.9

Examples and notes

Examples of term usage, and notes concerning entries, shall be presented as shown below. radix; base (deprecated): [radix numeration system] positive integer by which the weight of any digital place is multiplied to obtain the weight of the digit place with the next higher weight EXAMPLE: NOTE: In the decimal numeration system the radix of each digit place is 10.

The term "base" is deprecated in this sense because of its mathematical use.

3GPP

Release 11

36

3GPP TR 21.801 V11.1.0 (2012-06)

Annex D (normative): Drafting of the title of a 3GPP TS or 3GPP TR D.1

D.1.1

Elements of the title

The introductory element

See subclause 6.1.1.

D.1.2

The main element

The main element shall always be included.

D.1.3

The complementary element

The complementary element is necessary if the 3GPP TS or 3GPP TR covers only one or a few aspects of the subject indicated in the main element. Experience has shown that the titles of most deliverables benefit from the precision supplied in the complementary element. In the case of a 3GPP TS or 3GPP TR published as a series of parts, the complementary element shall serve to distinguish and identify the parts (the introductory element and the main element remaining the same for each part). The complementary element shall be omitted if the 3GPP TS or 3GPP TR both: covers all essential aspects of the subject indicated in the main element; and is (and is intended to remain) the only 3GPP TS or 3GPP TR relating to this subject.

D.2

Avoidance of unintentional limitation of the scope

The title shall not contain details that might imply a limitation of the scope of the 3GPP TS or 3GPP TR. However, if the 3GPP TS or 3GPP TR pertains to a specific type of product, this fact shall be reflected in the title.

D.3
Void.

Wording

3GPP

Release 11

37

3GPP TR 21.801 V11.1.0 (2012-06)

Annex E (normative): Verbal forms for the expression of provisions

NOTE: Only singular forms are shown. The verbal forms shown in table E.1 shall be used to indicate requirements strictly to be followed in order to conform to the standard and from which no deviation is permitted. Table E.1: Requirement
Verbal form shall Equivalent expressions for use in exceptional cases (see subclause 6.6.1)

is to is required to it is required that has to only ... is permitted it is necessary shall not is not allowed [permitted] [acceptable] [permissible] is required to be not is required that ... be not is not to be Do not use "must" as an alternative for "shall". (This will avoid any confusion between the requirements of a standard and external statutory obligations). Do not use "may not" instead "shall not" to express a prohibition. To express a direct instruction, for example referring to steps to be taken in a test method, use the imperative mood (e.g. "switch on the recorder").

The verbal forms shown in table E.2 shall be used to indicate that among several possibilities one is recommended as particularly suitable, without mentioning or excluding others, or that a certain course of action is preferred but not necessarily required, or that (in the negative form) a certain possibility or course of action is deprecated but not prohibited. Table E.2: Recommendation
Verbal form should should not Equivalent expressions for use in exceptional cases (see subclause 6.6.1) it is recommended that ought to it is not recommended that ought not to

The verbal forms shown in table E.3 are used to indicate a course of action permissible within the limits of the 3GPP TS or 3GPP TR.

3GPP

Release 11

38

3GPP TR 21.801 V11.1.0 (2012-06)

Table E.3: Permission

Equivalent expressions for use in exceptional cases (see subclause 6.6.1) may is permitted is allowed is permissible need not it is not required that no ... is required Do not use "possible" or "impossible" in this context. Do not use "can" instead of "may" in this context. Do not use "may" or "may not" to indicate a possibility or lack of possibility see Table E.4 below. NOTE: "May" signifies permission expressed by the standard, whereas "can" refers to the ability of a user of the standard or to a possibility open to him. Verbal form

The verbal forms shown in table E.4 are used for statements of possibility and capability, whether material, physical or causal. Table E.4: Possibility and capability
Equivalent expressions for use in exceptional cases (see subclause 6.6.1) can be able to there is a possibility of it is possible to cannot be unable to there is no possibility of it is not possible to Do not use "may" instead of "can" in this context. Do not use "may not" in this context. NOTE: "May" signifies permission expressed by the standard, whereas "can" refers to the ability of a user of the standard or to a possibility open to him. If there is uncertainty about whether an event will or will not happen, in particular where the normally expected behaviour will sometimes be impossible, a formulation such as cannot always should be used. Verbal form

The verbal forms shown in table E.5 shall be used to indicate behaviour of equipment or sub-systems outside the scope of the document in which they appear. For example, in a standard specifying the requirements of terminal equipment, these forms shall be used to describe the expected behaviour of the network or network simulator to which the terminal is connected. Table E.5: Inevitability
Verbal form Equivalent expressions will will not Distinguish from "shall" / "shall not". Use to express behaviour of equipment or systems outside the scope of the document being drafted, where description of such behaviour is essential to the correct understanding of the requirements pertaining to equipment within the scope of the current document.

EXAMPLE:

Extract from standard specifying behaviour of terminal equipment: " On expiry of timer T3, the terminal shall send a TIMEOUT message to the network and start timer T4. The network will respond with a TIMOUT-ACKNOWLEDGE message. On receipt of a TIMEOUTACKNOWLEDGE message, the terminal shall stop timer T4 "; thus is distinguished the strong future ("the terminal shall") used for requirements and the normal future ("the network will") used to indicate expected events.

The verbal forms shown in table E.6 shall be used to indicate statements of fact.

3GPP

Release 11

39

3GPP TR 21.801 V11.1.0 (2012-06)

Table E.6: Fact

Verbal form Equivalent expressions is Any verb in the indicative mood, present tense. is not Distinguish from "shall" / "shall not". Do not use present indicative of verbs for expressing requirements.

3GPP

Release 11

40

3GPP TR 21.801 V11.1.0 (2012-06)

Annex F (informative): Checklist concerning quantities and units to be used in 3GPP TSs or 3GPP TRs
Void.

Annex G (informative): Example layout of a typescript

Void.

3GPP

Release 11

41

3GPP TR 21.801 V11.1.0 (2012-06)

Annex H (informative): 3GPP styles and various information H.1 The 3GPP styles
Table H.1
For this type of element Clause ( if numbered) Subclause level n In exceptional cases, for level 6 or beyond, use Heading 5 if required in contents list or H6 if not to appear. Annex title for TS Heading 8 Annex title for TR Heading 9 Standard paragraph, Definition Normal Reference, Example EX Symbol, Abbreviation, Example continuation in text EW List element level n Bn Free paragraph (left justified) FP Note integrated in the text NO Note continuation in text NW Note in figure NF Note in table TAN Table title, Figures TH Heading within table TAH Centred text within table TAC Left justified text within table TAL Right justified text within table TAR Figure title TF Contents list title TT Programming language PL Equation EQ Header (portrait and landscape pages) Header use "tab" between "item/number" and "text". EXAMPLE: The "tab" is preceding this example text. Use this style

Use table H.1 when determining which style to use for various elements of the deliverable.

Heading 1 Heading n

Other styles exist in the template, but are for use by the Support Team only.

H.2
-

Page numbering, page headers and footers

Use the HEADER style on all page headers (sections) except for the title page (section)

The skeleton document supplies fields for automatic page numbering and the identification of the deliverable in the page header. Do not add anything to or delete anything from the headers.

3GPP

Release 11

42

3GPP TR 21.801 V11.1.0 (2012-06)

H.3
-

Configuration of the Windows environment

Use centimetres as the preferred unit of measurement. Do not select "Change 'Straight Quotes' to 'Smart Quotes'" in the AutoCorrect options. Set Default Tab Stops to 0,5 cm. The remaining configurable elements of Windows and of Word are at your discretion.

Set your Windows environment to use the English (International) conventions (via Control Panel, International).

H.4

Sequence numbering

You may use sequence numbering (Insert Field Seq) for tables, figures, equations, references, etc. Use the sequence identifiers shown in the following table. Table H.2: Sequence numberings
Sequence Bookmark name Description seq bib bib_xx for bibliography entries seq equ equ_xx for equations (note 1) seq fig fig_xx for figures (note 1) seq ref ref_xx for references seq tab tab_xx for tables (note 1) NOTE 1: Reset the sequence numbering to one for the first item of each annex of a 3GPP TS or 3GPP TR by using the switch \r1 (e.g. { seq fig \r1 }). NOTE 2: "xx" represents the identifier for the particular object concerned, e.g. fig_ProcessControl. Do not use bookmarks of the form "fig_fig1". You can use underscores as separators in sequence identifiers if necessary.

Thus the title of a table will read: Table { seq tab }: Table title where the italic part represents the sequence field code. Bookmark each entry in a sequence (select it and use Edit Bookmark Add), using a bookmark name of the form shown in table H2. You can then refer to the table, figure, reference, etc. from the text by inserting a sequence field citing the same sequence identifier and the particular bookmark required. For example, table 1 has been bookmarked "tab_Seq_Num". Thus a reference to this table from the text reads: see table { seq tab tab_Seq_Num } where the italic part represents the sequence field code. You can force Word to recalculate and refresh the display of sequence numbers and their references by selecting the text and pressing F9. Do not use Word's cross-referencing tool (Insert, Cross-reference), since it implies the use of automatic heading or caption numbering. When drafting is complete and the TS or TR is placed under change control, the Support Team shall hard code all automatic number sequences (Ctrl-Shift-F9). Thereafter, manual numbering shall be used. This will avoid invalidating references from extermal documents to particular clauses / tables / etc. in the document under consideration. Do not use automatic clause numbering.

3GPP

Release 11

43

3GPP TR 21.801 V11.1.0 (2012-06)

H.5

Supported file formats

Table H.3: Permitted software tools

Software tools to be used for document development within 3GPP are detailed in table H.3

Type Text

Graphics

Tool(s) Microsoft Word 2003 or earlier. Note: File compatibility with Word 2003 or earlier shall be retained. Micrografx Designer version 3.x or 6.0 or 7.0 (preferred)

Comments

MS Visio (file compatibility with version Professional 2003 shall be maintained)

Microsoft Word built-in drawing tools.

SDL, MSC

IBM Telelogic Tau

TTCN v2

IBM Telelogic ITEX

TTCN v3

IBM Rational Systems tester

Now part of Coral Designer, but older versions can be found for download. For general graphics; the rapporteur shall supply the source file. Not to be used for formal SDL diagrams. Final diagrams shall be visible in "normal" view (Word 2003 and earlier) or "draft" view (Word 2007 and later). SDL diagrams and Message Sequence Charts can be copy-andpasted into Word. Rapporteurs shall supply the source files. Note 1: Rapporteurs should contact their Support Team officer for access to this tool. Note 2: For SDLs which do not need to be compiled, Microsoft Visio (see above) may be used. Note: Rapporteurs should contact their Support Team officer for access to this tool. Note: Rapporteurs should contact their Support Team officer for access to this tool.

Databases

General Tools

Microsoft Access 2003 or earlier. Note: File compatibility with Access 2003 or earlier shall be maintained. Microsoft Office 2003 or earlier software suite (Excel, Powerpoint, etc.) Note: File compatibility with Office version 2003 or earlier shall be maintained.

Rapporteurs shall retain the source files of graphics where these exist, and they shall be retained for future maintenance of the document.

H.6

Quick tips to working with your document

When working with your 3GPP TS or 3GPP TR remember ... ... you may do this... use bold to emphasize text; use italic for citations, linguistic expressions or when a word/text/expression is extracted from a specific context;

3GPP

Release 11

44

3GPP TR 21.801 V11.1.0 (2012-06)

use non-breaking spaces () or hyphens () in order to avoid unexpected wrap around between two words and/or numbers (e.g. 50cm, 1000, clause6, annexA, table1, figure1, TR218011, etc.). These characters appear as normal spaces ( ) or hyphens (-) when printed out; use the default tab stops 0,5 cm; use "straight" quotation marks (". . .") not "curly" or "smart" (. . .) ones. If a second set of quotations is needed (e.g. GDMO, ASN.1, etc.), single quotes ('. . .') may be used.

but please don't do this alter existing styles or formats pre-set in the 3GPP template; add new styles to the 3GPP template; delete 3GPP styles; use a font other than the one pre-set in the 3GPP styles; use the underline attribute, as this causes confusion when revision marks are used; put more than one space after a full stop; precede comma (,), semicolon (;), colon (:), full stop (.), question mark (?) or exclamation mark (!) by spaces; use spaces in place of tabs when indentation/alignment is required; this can cause text to be misaligned; use footnotes or end-notes; unnecessarily use capital letters.

3GPP

Release 11

45

3GPP TR 21.801 V11.1.0 (2012-06)

Annex I (normative): Text containing SDL, program code, ICS and TTCN I.1 SDL diagrams

Provide SDL diagrams in SDT binary files or, exceptionally, as CIF files when not using SDT. When using SDT use the .ini file supplied on the 3GPP server. Take into account the following when inserting SDL diagrams in Word documents Do not include SDL headers or footers.

I.2

Program code

Large volumes of program code, source code or formal description language shall be placed in a separate file.

I.3

Implementation Conformance Statement (ICS) proforma tables

(For further study.)

I.4

Tree and Tabular Combined Notation (TTCN)

Provide TTCN as a separate file. Provide both Graphical Rendition (GR) and Machine Processable (MP) files. The following text should be used for ATSs using TTCN. The subdivision is recommended. This ATS has been produced using the Tree and Tabular Combined Notation (TTCN) according to ISO/IEC 9646-3 [<x>]. The ATS was developed on a separate TTCN software tool and therefore the TTCN tables are not completely referenced in the table of contents. The ATS itself contains a test suite overview part which provides additional information and references. <x1> The TTCN Graphical form (TTCN.GR) The TTCN.GR representation of this ATS is contained in a Portable Document Format file (<filename>.PDF contained in archive <filename>.ZIP) which accompanies the present document. <x2> The TTCN Machine Processable form (TTCN.MP) The TTCN.MP representation corresponding to this ATS is contained in an ASCII file (<filename>.MP contained in archive <filename>.ZIP) which accompanies the present document. NOTE: According to ISO/IEC 9646-3 [<x>], in case of a conflict in interpretation of the operational semantics of TTCN.GR and TTCN.MP, the operational semantics of the TTCN.GR representation takes precedence."

3GPP

Release 11

46

3GPP TR 21.801 V11.1.0 (2012-06)

Annex J (normative): Endorsement of documents from other standards organizations J.1 General

In the case that a 3GPP TS or 3GPP TR would become almost identical to a document from another standards organization, the TSG may decide to prepare a 3GPP TS or 3GPP TR defining only the differences, if any, between that document (commonly called "endorsed document") and the 3GPP TS or 3GPP TR. Such a 3GPP TS or 3GPP TR, commonly called "endorsement", shall be drafted in accordance with the present document, with the exceptions defined below.

J.2

Title

If the endorsed document is referred to without modifications, the title of the 3GPP TS or 3GPP TR should be as close as possible to the title of the endorsed document, but comply with the provisions of annex D. EXAMPLE 1: Endorsement of ITU-T Recommendation Q.1215 (1993): "Physical plane for intelligent network CS-1", gives the 3GPP TS the title: Intelligent Network (IN); Physical plane for intelligent network Capability Set 1 (CS1) [ITU-T Recommendation Q.1215 (1993)] If the endorsed document is referred to with textual (technical and/or editorial) modifications, the title of the 3GPP TS or 3GPP TR shall indicate that. EXAMPLE 2: Endorsement of ITU-T Recommendation G.957 (1993): "Optical interfaces for equipments and systems relating to the synchronous digital hierarchy", gives the 3GPP TS the title: Transmission and Multiplexing (TM); Optical interfaces for equipments and systems relating to the Synchronous Digital Hierarchy (SDH) [ITU-T Recommendation G.957 (1993), modified]

3GPP

Release 11

47

3GPP TR 21.801 V11.1.0 (2012-06)

J.3

Requirements

This element is mandatory and shall be entitled "Endorsement notice". If the endorsed document is referred to without modifications, the following text should be used: "All elements of . apply." If the endorsed document is referred to with modifications, the following text should be used: "The elements of . apply , with the following modifications:" The modifications shall be presented in an order following the sequence of clauses of the endorsed document. General modifications shall precede specific modifications. The use of revision marks for the presentation of the modifications is recommended.

J.4

Annex

Designation of the serial order of an annex shall be with two letters, the first letter always being Z (i.e. ZA, ZB, ZC, etc.), in order to avoid confusion with any annexes of the endorsed document.

3GPP

Release 11

48

3GPP TR 21.801 V11.1.0 (2012-06)

Annex K (informative): Change history

Change history <Phase> New Subject/Comment Version 0.0.0 First draft, internal to MCC. 1.0.0 Editorial clean up 1.0.1 Presentation to SA#8 Rel-4 4.0.0 Approved (Rel-4) Rel-4 4.1.0 Automatic numbering of references Rel-4 4.1.0 Clarification on use of automatically numbered figures, tables, etc. Rel-4 4.2.0 Corrections of invalid clause reference Rel-4 4.3.0 Correction of invalid table number, annex H. Rel-5 5.0.0 Upgrade to Rel-5. Rel-5 5.0.1 2002-07-19: Correct cover page. Rel-5 5.0.2 2003-05-15: Correct cover page. Rel-6 6.0.0 Upgrade without change to Release 6 Rel-7 7.0.0 The use of 'void' Rel-7 Introduction of MS Visio Specification of versions of permitted software 7.1.0 packages Rel-7 7.2.0 Inclusion of version identity for Visio Rel-7 Alignment of section 6.6.4.2 and annex I in 7.3.0 respect of figure format. Rel-8 Upgrade to Rel-8, allowing for more recent 8.0.0 versions of application file formats Rel-8 Correction of illegal text 8.1.0 Elimination of IPR provisions 9.0.0 Upgrade to Rel-9, no technical change Rel-10 References to Figures and Tables Clarification on usage of "may, may not, 10.0.0 can and cannot Rel-10 Supported file formats Rules on referencing unpublished documents 10.1.0 Clarification on the use of References Rel-10 Editorial correction to previous meeting's entry 10.1.1 in this history table. Rel-10 10.1.2 Editorial correction to table H.3 Rel-11 11.0.0 Clarification on treatment of void clauses Rel-11 11.1.0 Page breaks before annexes

TSG SA TDoc Version # 05-2000 06-2000 0.0.0 SP-08 SP-000278 1.0.0 SP-08 1.0.1 SP-11 SP-010193 4.0.0 SP-11 SP-010213 4.0.0 SP-13 SP-15 SP-16 SP-010482 4.1.0 SP-020105 4.2.0 4.3.0 5.0.0 5.0.1 5.0.2 SP-050401 6.0.0 SP-050535 7.0.0

CR 001 002r1 003 004

SP-23 SP-28 SP-29

009 013 014r1 015 017 018 020 021 024r4 026r1 028r3 029r3 030

SP-30 SP-34 SP-37 SP-39 SP-46 SP-48

SP-050689 7.1.0 SP-060914 7.2.0 SP-070527 7.3.0 SP-080078 8.0.0 8.1.0 SP-100365 9.0.0 SP-100422 SP100655 SP-100629 10.1.0 10.1.1 SP-120112 10.1.2 SP-120317 11.0.0 10.0.0

SP-49

SP-55 SP-56

031r1 033

3GPP