1、ETSI TR I01 778 1.1.2 (2000-02) Technical Report Methods for Testing and Specification (MTS); Technical quality of telecommunications standards; Complementary methods and technical quality manual 2 ETSI TR 1 O1 778 V1.1.2 (2000-02) Reference DTR/MTS-00039-02 Keywords methodology, quality ETSI Postal
2、 address F-O6921 Sophia Antipolis Cedex - FRANCE Office address 650 Route des Lucioles - Sophia Antipolis Valbonne - FRANCE Siret No 348 623 562 00017 - NAF 742 C Association but non lucratif enregistre la Sous-Prfecture de Grasse (06) No 7803/88 Tel.: +33 4 92 94 42 O0 Fax: +33 4 93 65 47 16 Intern
3、et secretariatetsi.fr Individual copies of this ETSI deliverable can be downloaded from h tt p :/www. e t s i. o rg If you find errors in the present document, send your comment to: editoretsi.fr Important notice This ETSI deliverable may be made available in more than one electronic version or in p
4、rint. In any case of existing or perceived difference in contents between such versions, the reference version is the Portable Document Format (PDF). In case of dispute, the reference shall be the printing on ETSI printers of the PDF version kept on a specific network drive within ETSI Secretariat.
5、Cor vriaht Notification No part may be reproduced except as authorized by written permission. The copyright and the foregoing restriction extend to reproduction in all media. O European Telecommunications Standards Institute 2000. All rights reserved. ETSI 3 ETSI TR 1 O1 778 V1.1.2 (2000-02) Content
6、s Intellectual Property Rights 5 Foreword 5 1 2 3 4 5 5.1 5.1.1 5.1.2 5.1.3 5.1.4 5.1.5 5.2 5.2.1 5.2.2 5.2.3 5.2.4 5.2.5 5.2.6 5.2.7 5.2.8 5.3 5.3.1 5.3.2 5.3.3 5.3.4 5.3.5 5.3.6 5.4 5.4.1 5.4.2 5.4.3 5.4.4 5.4.5 5.4.6 5.4.7 5.4.8 5.4.9 5.4.10 5.4.11 5.5 5.5.1 5.5.2 5.5.3 5.5.4 5.5.5 5.6 5.6.1 5.6.
7、2 5.6.3 5.6.4 5.6.5 Scope 6 References 6 Definitions and abbreviations 6 Introduction 6 The Macros 7 Scope and Language Macros 7 Shall/Should; Is/Are; May; Can; Could; May Not; Must 7 Remove Colour . 8 Section Para 8 Occurrences 8 Scope 8 Abbreviations Essential, or potentially Essential, IPRs notif
8、ied to ETSI in respect of ETSI standards“, which is available from the ETSI Secretariat. Latest updates are available on the ETSI Web server (http:/www.etsi.org/ipr). Pursuant to the ETSI IPR Policy, no investigation, including IPR searches, has been carried out by ETSI. No guarantee can be given as
9、 to the existence of other IPRs not referenced in SR O00 3 14 (or the updates on the ETSI Web server) which are, or may be, or may become, essential to the present document. Foreword This Technical Report (TR) has been produced by ETSI Technical Committee Methods for Testing and Specification (MTS).
10、 ETSI 6 ETSI TR 1 O1 778 V1.1.2 (2000-02) 1 Scope The present document is the outcome of continuing studies in TC MTS aimed at improving the technical quality of standards (and other types of deliverable) drafted in ETSI Technical Bodies. It contains a description of a set of macros operating under
11、the ETSI-approved word processor Microsoft Word 7TM contained in Office 95TM. These macros are designed to: - combine advice with a tool that automated routine tasks for rapporteurs and so made their work easier and more interesting; - provide automated tools that help to improve the consistency of
12、documents and provide a different perspective that enables errors to be noticed more easily; - provide a solution that is used on screen in association with the draft deliverable rather than advice that is in separate reports and so remains unread. Tutorial advice conforms to the ETSI Drafting Rules
13、 i. The whole output of the STF is contained in this template. The present document is adds no additional information to that contained in the template. 2 Ref e ren ces The following documents contain provisions which, through reference in this text, constitute provisions of the present document. Re
14、ferences 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. A non-specific reference to an ETS shall also be taken to ref
15、er to later versions published as an EN with the same number. TR 101 262: “ETSI drafting rules“. 121 EG 201 014: “Methods for Testing and Specification (MTS); ETSI Standards-making; Technical quality criteria for telecommunications standards“. 3 Definitions and abbreviations None. 4 Introduction The
16、 technical accuracy and correctness of a standard is more important than on the finer details of presentation. Yet, it is hard to communicate with editors/rapporteurs as they are usually short of time and disinclined to read reports or guides that they do not consider to be essential. The approach h
17、as therefore been taken of - combining advice with a tool that automated routine tasks for rapporteurs and so made their work easier and more interesting; providing automated tools that help to improve the consistency of documents and provide a different perspective that enables errors to be noticed
18、 more easily; - ETSI 7 ETSI TR 1 O1 778 V1.1.2 (2000-02) - providing solutions that are used on screen in association with the draft deliverable rather than advice that is in separate reports and so remains unread. Accordingly a suite of macros containing tutorial advice was developed for use alongs
19、ide the ETSI template. Tutorial advice conforms to the ETSI Drafting Rules 11. The whole output of the STF is contained in this template. The present document is adds no additional information to that contained in the template. 5 The Macros The macros work only in Microsoft Word 7 as in Office 95. T
20、hey do NOT work in Office 97. A version for Office 97 may be produced later. The macros are written for English versions of Word. Some macros may work in other language versions but some will not. The macros are contained in a template that should be loaded alongside the draft deliverable by using t
21、he FileTemplates command and clicking Add. Select the template and add it. The name of the template should remain stored in the dialog box so long as you do not Remove it. You can activate it by checking the box next to its name. Ensure that the templates toolbars are showing by using ViewToolbars a
22、nd checking the toolbar: MTS: Rapporteurs Assistant this toolbar contains several buttons for toggling other toolbars with the individual controls. Each toolbar has a “?“ button that displays a HELP document for you to read and store or print. There are the following toolbars: - Scope + Language; -
23、Abbrs + Defs; - Figs + Tables; - References; - Characters; - Styles. A table on the macros is given in annex A listing the macro names and relating the toolbar buttons to the macro names. The following subclauses repeat the instructions for using the macros. 5.1 Scope and Language Macros 5.1 .I Shal
24、l/Should; Is/Are; May; Can; Could; May Not; Must These macros colour and double underline each occurrence of the word in your document. They then return the cursor to where you started in your document. Blue: - denotes a word that can be used in normative text. Magenta: - used only for SHOULD whose
25、status should be clarified. Green: - denotes a word that is either informative or used in logic conditions. Red: - denotes a word that should not be used at all or should be used only with great care. If bad or dangerous words are used, a new file is created with the page numbers where the words occ
26、ur. This helps you to check potential problems in long documents. You can print, copy and paste or delete this new file after reading it. ETSI 8 ETSI TR 1 O1 778 V1.1.2 (2000-02) If you are using revision marking, the colour chosen for your revisions takes precedence over the colour for the marked w
27、ords. Think very carefully about your use of language as this will help you to make the requirements as clear as possible. 5.1.2 Remove Colour Removes the colouring and any double underlining. 5.1.3 Section Para Colours and double underlines all occurrences of SECTION, PARAGRAPH and PARA in red and
28、gives a list of page numbers where they occur. These terms should not be used for referring to parts of an ETSI document. 5.1.4 Occurrences Colours and double underlines all occurrences of a word that you specify, and allows you to choose the colour. You can use this in long documents to check where
29、 you have covered particular topics 5.1.5 Scope Finds the SCOPE clause and inserts a check list of important issues to be included. Check that you have covered them and then delete the checklist. 5.2 Abbreviations i Definitions 5.2.1 Abbreviations: Colour Runs through Abbreviations clause and checks
30、 use of each one. Colours used abbreviations green and unused ones red. Colours blue each occurrence of each abbreviation after the Abbreviations section so you can see which abbreviations are uncoloured and need to be added to the list. Identifies the Abbreviations clause by finding the word ABBREV
31、IATION in style Heading 1 or Heading 2, followed by style EW for each abbreviations. Will not work if these styles are not present. 5.2.2 Abbreviations: Add Select an abbreviation in the main body of the document and then run this macro. The macro checks whether the abbreviation is used and if not p
32、rompts you to add the meaning (expansion). The abbreviation and meaning are then added to the end of the Abbreviations clause and the cursor is returned to where you started. If the abbreviation is added then the addition to the Abbreviations clause is coloured light green and each occurrence is col
33、oured blue. Identifies the Abbreviations clause by finding the word ABBREVIATION in style Heading 1 or Heading 2, followed by style EW for each abbreviations. Will not work if these styles are not present. In addition, the macro searches for a file called abbs.doc in the same directory as the MTS te
34、mplate that contains the macros. If it finds this file, it offers to add the abbreviation to this master file as well as to the Abbreviation Clause. If the “+“abbreviation is already in the master clause, the macro offers the existing abbreviation for inclusion in the document. Matching uses a form
35、of “fuzzy logic“. 5.2.3 Abbreviations: Go To Goes to the start of the list with style EW in the Abbreviations clause. Identifies the Abbreviations clause by finding the word ABBREVIATION in style Heading 1 or Heading 2, followed by style EW for each abbreviation. ETSI 9 ETSI TR 1 O1 778 V1.1.2 (2000
36、-02) 5.2.4 Generate Master List: Abbreviations Creates a files called abbs.doc in the same directory as the MTS template that contains the macros, if such a file is not already present. This file is then used by Abbreviations: ADD for collecting a master list of the abbreviations used in your docume
37、nt 5.2.5 Generate Master List: Definitions Creates a files called defs.doc in the same directory as the MTS template that contains the macros, if such a file is not already present. This file is then used by Definitions: ADD for collecting a master list of the definitions used in your document. 5.2.
38、6 Add Definition Select in the main body of the document a word or words that need to be defined and then run this macro. The macro checks whether the word(s) are already defined and if not prompts you to add the definition. The definition is then added to the Definitions clause and the cursor is re
39、turned to where you started. If the definition is added then the addition to the Definitions clause is coloured light green and each occurrence is coloured blue. Identifies the Definitions clause by finding the word DEFINITION in style Heading 1 or Heading 2. Will not work if these styles are not pr
40、esent. In addition, the macro searches for a file called defs.doc in the same directory as the MTS template that contains the macros. If it finds this file, it offers to add the definition to this master file as well as to the Definitions Clause. If the definition is already in the master clause, th
41、e macro offers the existing definition for inclusion in the document. Matching uses a form of “fuzzy logic“. 5.2.7 Sort List Select a list of at least 2 lines and macro sorts list alphabetically. Do not use it within Tables 5.2.8 Remove Colour Removes the colouring and any double underlining. 5.3 Fi
42、gures i Tables 5.3.1 How to Use Displays some instructions on use. 5.3.2 Annexes Displays some instructions about how to reset the number sequences in annexes. 5.3.3 Table Type in the caption in the correct place and click the Table button. The macro will add the correct Style, the word TABLE and th
43、e field code for the sequence number. 5.3.4 Figure Type in the caption in the correct place and click the Figure button. The macro will add the correct Style, the word FIGURE and the field code for the sequence number. ETSI 10 ETSI TR 1 O1 778 V1.1.2 (2000-02) 5.3.5 Toggle Codes Toggles the display
44、of field codes so you can examine and problems. 5.3.6 Update Updates field codes starting from the Scope so that it avoids the Table of Contents to improve speed of operation. Displays the results of fields rather than the codes. To see the codes click TOGGLE CODES. 5.4 References 5.4.1 Collect Sear
45、ches for references of the following type: - EN nnnn(nn); - ETS nnn nnn(-nn-nn); - ES nnn nnn(-nn); - EGnnnnnn; - TS nnn nnn(-nn); - TR nnn nnn(-nn); - ETR nnn(-nn); - IS0 nnnn(n)(-nn); - IEC nnnn(n)(-nn); - ISO/IEC nnnn(n)(-nn); - ECMAnnn(n) - x.n(nnnn)(.nn) - ITU-T/CCITT Recommendations; - RFC nnn
46、(n)(-nn), and copies the text found into a new file, which you can save or print. Duplicates are excluded. The page numbers of the occurrences are given. Ail occurrences within the standard are coloured blue to help identification of references that have been missed. This macro does not check to see
47、 if the reference is already in the Reference section. 5.4.2 Add Select the standard number of a new reference in the body of the standard and run the macro. Macro checks if the standard is already in the reference section. If it is not, it adds the and number (using SEQ and bookmark) at the end of
48、the reference section, then returns to the original position and adds a copy of the with bookmark just after the reference. This macro does NOT do any colouring. After running it you need to run UPDATE and manually add details about the reference to the Reference clause, eg the title of the referenc
49、e. This macro will work with any type of reference and is not limited to the list of types stored in the RapHelp template. 5.4.3 Check Use Checks though the reference list and colours all used and colours the unused references red. Uses the stored list of reference types for finding references. ETSI 11 ETSI TR 1 O1 778 V1.1.2 (2000-02) This macro will work only with any types of reference stored in the RapHelp template. 5.4.4 Colour Non Seqs Within reference section, colours the n RED where n is a simple digit string. These references then need to be converted us
