Tech-invite3GPPspecsSIPRFCs
Overview21222324252627282931323334353637384‑5x

Content for  TR 21.801  Word version:  16.2.0

Top   Top   Up   Prev   Next
1…   4…   5…   6…   6.3…   6.6…   7…   D…   E…   H…   I…   J…

 

6  DraftingWord‑p. 17

6.1  Preliminary informative elements

6.1.1  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.
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:
  1. an introductory element "3rd Generation Partnership Project; Technical Specification Group nn;" (where nn is the full name of theTSG which produced the TS/TR);
  2. a main element (obligatory) indicating the principal subject treated within that general field;
  3. 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.
  4. in parentheses, "Release yyyy" where yyyy indicates the Release identifier of the Release (e.g. Release 1999, Release 4).
When modifying the Release text, editors shall take care not to modify the style of that text from the style preset in the skeleton document. The style is used to replicate the Release in the header of subsequent pages of the TS/TR.
See also Annex D.
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.
Up

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.

6.1.2AVoid

6.1.3  ForewordWord‑p. 18
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.
Up

6.1.3AVoid

6.1.4  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 clause 5.2.1A).
Up

6.1.5  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 …"
Up

6.1.6  ReferencesWord‑p. 19
References should 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 3GPP Support Team will endeavour to secure the rights from the copyright holder (normally the originating body of the referenced text) to reproduce the text; in this case:
    • agreement permitting 3GPP or its Organizational Partners to take over the copying and distribution rights shall have been obtained, 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;
    • if agreement with the copyright holder along the above lines cannot be achieved, the TSG /WG responsible shall make appropriate changes to the document and remove the reference from the 3GPP TS or TR.
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 body of the deliverable (such documents may be listed in a bibliography (see clause 6.4.2)).
  • Use the EX style; 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").
EXAMPLE 1:
[1] 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 Partners 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
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.
For further instructions on references, see clause 6.6.6.
Up

6.1.7  TermsWord‑p. 20
This is a mandatory element giving formal definitions of terms used in the 3GPP TS or 3GPP TR. The introductory wording 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.
  • 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.
  • Use the Normal style.
EXAMPLE:
requirement: a provision that conveys criteria to be fulfilled
Up

6.1.8  Symbols

This is a mandatory element listing the symbols used in the 3GPP TS or 3GPP TR.
Unless there is a need to list symbols in a specific order to reflect technical criteria, 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, Α, α, Β, β, … Λ, λ, etc.);
  • any other special symbols.
See also clause 6.6.2.
Do not number the entries in the symbols and/or abbreviations clause.
  • Use the EW style.
EXAMPLE:
fl lower reference frequency
Up

6.1.9  Abbreviations

This is a mandatory element listing the abbreviations used in the 3GPP TS or 3GPP TR.
Unless there is a need to list symbols in a specific order to reflect technical criteria, all abbreviations 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, Α, α, Β, β, … Λ, λ, 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 clause 6.6.2.
  • Use the EW style.
  • Separate the abbreviation/acronym from the full term with a tab.
EXAMPLE:
dB decibel
Up

6.2Void


Up   Top   ToC