Top Banner
JMM 1 Editing a 3GPP spec - tips for experts Move to next slide G LO BAL SYSTEM FO R M O BILE CO M M UNICATIONS R
35

JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

Mar 31, 2015

Download

Documents

Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 1

Editing a 3GPP spec - tips for experts Move to next slide

GLOBAL SYSTEM FOR MOBILE COMMUNICATIONS

R

Page 2: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 2

Question:Why am I editing this specification?

Answer:To incorporate the modifications presented in one or more Change Requests which have been agreed by the relevant plenary* meeting.

* Note:The responsibility for further development of all GSM specifications (except the 13.-series) has been transferred from the original SMG working group to the analogous working group in the appropriate 3GPP TSG. This change of responsibility also extends to maintenance of previous releases of the GSM specs.

Move to next slide

Page 3: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 3

Open the document. (The examples shown in this and the following slides have been chosen more or less at random.)

3GPP

Move to next slide

Page 4: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 4

Before editing a 3GPP spec, ensure you have the correct template file* for Word installed in Word’s ‘user templates’ directory**...

* 3gpp_70.dot** e.g. C:\Program Files\Microsoft Office\Templates\

Move to next slide

Page 5: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 5

Ensure you have the 3GPP template file in Word’s ‘user templates’ directory...

Move to next slide

Page 6: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 6

… and that you attach it to the document!

Move to next slide

Page 7: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 7

If you have any doubt about the previous use of the permitted styles, DO NOT check this box! This will ensure that the previous ‘wrong’ formatting is preserved.

Move to next slide

Page 8: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 8

Ensure the top line reads

3GPP TS

Or

3GPP TRand not simply 3G TS or 3GTR – the new designation was decided on at TSG#9.

3GPP

Move to next slide

Page 9: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 9

Update the version number.The new version number can be determined from the ‘status list’ which is in turn based on the proposals in the CR database.

Note: The version number should appear only once, on the top line. The “release” line at the end of the title should contain only the release identity, as shown here.

3GPP

Move to next slide

Page 10: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 10

Date: year and month of plenary meeting which approved the CR(s) included in this new version.

3GPP

Move to next slide

Page 11: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 11

If necessary, update the release number.

Permissible values are:Release 1999Release 4Release 5

and in addition for GSM specs only,Phase 1 *Phase 2 *Release 1996Release 1997Release 1998

*Phase 1 and 2 are closed and only very exceptional changes are anticipated.

3GPP

Move to next slide

Page 12: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 12

WARNING!!The first line (spec id) and the Release line at the end of the title are in special font styles enabling the text to be reproduced in the headers of subsequent pages. Take care not to corrupt these styles.

3GPP

Move to next slide

Page 13: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 13

Insert the GSM logo for specifications which are pure GSM (i.e. not UMTS / 3rd generation), if this is missing.

3GPP TS 44.900

GLOBAL SYSTEM FOR MOBILE COMMUNICATIONS

R

Move to next slide

Page 14: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 14

Ensure the 3GPP logo bears the “trade-mark” symbol. (If not, replace the graphic with that from the TS/TR boilerplate document.)

3GPP TS 44.900

GLOBAL SYSTEM FOR MOBILE COMMUNICATIONS

R

Move to next slide

Page 15: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 15

Check that the title is correct.

Move to next slide

In this case, the second line is wrong.

Technical Specification Group Services and System Aspects;

And there is an unnecessary capital letter in the main element of the title.

Working methods

Page 16: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 16

Move to next slide

The last line should not bear the spec number (even correctly rendered!).

(Release 1999)

Page 17: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 17

Change to “page layout” view.

Move to next slide

Check that the frames on the first page have not been displaced (e.g. by an exceptionally long title).

Page 18: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 18

Ensure that no ETSI work item reference appears on the second page.Early 3GPP documents showed this. If it appears, delete the two offending lines.

Move to next slide

Page 19: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 19

Change the copyright year if necessary.

Move to next slide

Page 20: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 20

Ensure the correct names are shown for the Organizational Partners.

Move to next slide

(ARIB, ATIS, CCSA, ETSI, TTA, TTC)

Page 21: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 21

Enter details of the change into the change history annex.The title of this part of the document varies from spec to spec. However, it is always the last annex of the document. Ensure that the date and version are mentioned, together with details of the change and the CR number which caused it.

Unfortunately, the layout of this annex varies from spec to spec. Unless you are prepared to update the entire annex, just follow the layout you find already in place.

Move to next slide

Page 22: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 22

For TSs only, ensure that this annex is shown as ‘informative’.TRs are entirely informative, so do not require this indication. Annexes in TSs are either informative or normative.

See TR 21.801 for further details.

Move to next slide

Page 23: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 23

Delete any history box and ISBN text which may appear on the last page.Early versions of the template included this box and the ISBN text. These pertain to the ETSI publication only, and should not appear on the ‘raw’ 3GPP spec.

Move to next slide

Page 24: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 24

Delete any other extraneous text which may appear on the last page.By decision of SA#9, rapporteur names and coordinates are not to appear in the specification itself. (Rapporteurs are identified in the specifications database / status list.)

Move to next slide

Page 25: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 25

Edit the document as necessary.Use exactly the text given in the approved CRs. If these are mutually contradictory, you may need to contact the rapporteur and the WG chairman for advice.

Be guided also by the 3GPP drafting rules (TR 21.801) and the ETSI guide to the use of English.

These will help you number inserted figures, guide you as to choice of paragraph style, etc. - information which is not normally contained in CRs.

Move to next slide

Page 26: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 26

Accept all changes - do not leave revision marks in the finished document.Readers can consult the CRs to determine what the changes from the previous version are.

Move to next slide

Page 27: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 27

Eliminate all annotations, “editor’s notes” etc.Unless there is a very good reason to leave them in place!

Move to next slide

Page 28: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 28

In page layout view, scroll through the document to verify that there are no superfluous page breaks, that the headers are correct, etc.

Move to next slide

Page 29: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 29

Refresh the Table of Contents (F9) and check that the actual pagination matches that claimed by the ToC.

Move to next slide

Page 30: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 30

You should normally use the special MCC ToC button to accomplish the refresh, since this ensures correct layout as well as page numbering.

Move to next slide

Page 31: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 31

IMPORTANT!

Before closing, run the MCC Evil Eye. This runs a comprehensive error check on the file.

Move to next slide

Page 32: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 32

When you are satisfied that all is well, save and close the file.

Move to next slide

Page 33: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 33

Finally, ensure the file is correctly named:

21900-330.doc

Corresponds to specification 21.90 version 3.3.0.

Note the hyphen in the middle (not underscore).

Move to next slide

Page 34: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 34

Then zip it to save space.

Retain the same file name as the doc file (but with extension .zip).

And deliver it by e-mail to the Specifications Manager.

Move to next slide

Page 35: JMM1 Editing a 3GPP spec - tips for experts Move to next slide.

JMM 35

F I NMove to

next spec!