TG1 Editors IEEE P802.15 Instruction Manual

EEE P802.15 Wireless Personal Area Networks

Project| IEEE P802.15 Working Group for Wireless Personal Area Networks (WPANs)
---|---
Title| Instructions for TG1 Editors
Date Submitted| 22 May 2000
Source| [Tom Siep]                       Voice: 972-480-6786
[Texas Instruments]         Fax: 972-480-6552
8505 Forest Lane             E-mail: siep@ti.com
Dallas, TX 75243
Re| Updated version of instructions to editors who will be modifying the text that was originally the Bluetooth Specification.
Abstract| The Bluetooth Specification 1.0a was recast into IEEE 802 format using a simple cut and paste method. That first rough-cut must be further smoothed and modified to yield a readable document that also conforms to IEEE’s formalisms.
Purpose| Document the process of changing the Bluetooth Specification into IEEE 802.15.1
Notice| This document has been prepared to assist the IEEE P802.15. It is offered as a basis for discussion and is not binding on the contributing individual(s) or organization(s). The material in this document is subject to change in form and content after further study. The contributor(s) reserve(s) the right to add, amend or withdraw material contained herein. Release
Release| The contributor acknowledges and accepts that this contribution becomes the property of IEEE and may be made publicly available by P802.15.

Introduction

This document is a set of instructions to the editors who will be modifying the text that was originally the Bluetooth Specification. The Bluetooth Specification 1.0a was recast into IEEE 802 format using a simple cut and paste method and some minor modifications. That first rough-cut must be further smoothed and modified to yield a readable document that also conforms to IEEE’s formalisms

Guidelines for Modifications to the text

The text as delivered to the editors is largely unmodified. Further changes to the text shall be done only for the following reasons:

1. Changes to enhance the clarity and readability of text
2. Changes required to adopt the IEEE 802 nomenclature

The technical content of the document is not to be changed. In the case where there is a question about the technical content of the text, the editors shall place a [comment in square brackets] in the flow of the text. Such comments are appropriate when/if inconsistencies, opaqueness, or errors in fact are found.

All changes to the text issued to the editors shall use the “change indication” feature of FrameMaker. The chief editor will remove those indicators only after review by the appropriate Bluetooth reviewers.

Changes to enhance clarity

Subclause Autonomy

Existing groups of paragraphs gathered under a numbered subheading shall be maintained as an autonomous unit. Distribution of such paragraphs to multiple subclauses shall be done only with the advice and consent of the chief technical editor.

Subheading Text

The headings used for subclauses in the original text should be preserved whenever possible. If nomenclature changes dictate that subheading text is required to be changed, the original text of the heading shall be enclosed in parentheses. This convention shall be preserved during the initial Draft review process as an aid to the reviewers who are familiar with the original document

EXAMPLE:
8.12 Bluetooth Audio
Would become:
8.12 Audio (Bluetooth Audio)

Style Changes

Portions of the Bluetooth Specification use a “conversational tone”. We, as Editors, will not make changes based on style unless the technical clarity of the passage is compromised by it. Any such changes should be reviewed and approved by the entire editorial staff.

Mechanical Issues

IEEE Formats
The Bluetooth document as delivered to the editors has been converted to use the IEEE FrameMaker formats. We are required to use those formats for the document. Example changes include:

numbers (eg Figure 10.3 becomes Figure 75)
Table titles| Table Title| Table Title| Yes, it is different. The IEEE format numbers without using dot numbers (eg Table 10.3 becomes Table 75)
Bullet lists| Bulleted| DL, Dashed List| Some have been done
Text in tables| CellBody| Table Text| Not done
Numbered lists| Numbered1| LI1, NumberList2| Used on first in sequence
Numbered lists| Numbered| LI, NumberList2| Used on rest in sequence

Additional Paragraph Formats
The IEEE publishing staff will consider additional, special formats if we can justify them. Their normal inclination will be to reject such requests unless there is a compelling reason for them. If you would like to propose an additional paragraph format, please contact the chief editor.

Cross References
During the process of converting the Bluetooth Specification to the initial IEEE format, all cross-references were resolved. Do not remove the XREF delimiters from the text you are working on. (They look like graphical “T” and upside-down graphical “T”)

IEEE 802 nomenclature

There are many references in the Bluetooth document to non-IEEE constructs and entities. The substitution of Bluetooth for IEEE terms is not an exact process. Changes shall be done on a case-by-case basis. In a few cases editors may want to use a combination of terms, for example “WPAN Bluetooth™ Assigned Numbers”. When in doubt, use Bluetooth™.
In general use the term “frames” in place of “packets” throughout the text.
The following Nomenclature Conventions are to be adopted. Where there are several choices, they are listed in bullet form.

· WPAN link management function
Bluetooth LMP| WPAN LMP
Bluetooth logical link control and adaptation protocol| WPAN Logical Link Control And Adaptation Protocol (note case change)
Bluetooth piconet| WPAN piconet
Bluetooth profile| WPAN profile
Bluetooth protocol stack| WPAN protocol stack
Bluetooth protocol architecture| WPAN protocol architecture
Bluetooth Radio| · PHY
· PHY Layer· Radio
Bluetooth radio and link controller| WPAN radio and link controller
Bluetooth Receiver| WPAN Receiver
Bluetooth Security| WPAN Security
Bluetooth System| WPAN System
Bluetooth Technology| WPAN Technology
Bluetooth Test Mode| WPAN Test Mode
Bluetooth Transceiver| WPAN Transceiver
Bluetooth Unit| WPAN Unit
Section| Clause (Clauses are the highest-level breakdown in an IEEE document. Example: Clause 7 covers the Physical Layer (PHY). Subclauses
| are lower level breakdowns in an IEEE document. Example: Subclause 7.2 covers the Frequency Band and Channel Arrangement.)

Updates to Illustrations

Some changes may need to be made to the text of illustrations. Editors shall not make changes to illustrations. A graphic artist, who will ensure a consistent look to the illustrations, will do that. Required changes that the editors discover should be communicated to the chief editor in a separate document when the Clause(s) are turned in.
A note in the text describing the change to be made as well as the page number in the currently posted PDF.

New content

Introductions

Introductory and transitional material may need to be added to the text supplied to the editors. These additional text entries should be relatively short in length and provide the reasons why the following text exists as well as relating it to other portions of the Standard.

Illustrations

Ideas for new illustrations should be communicated to the chief editor as soon as their need is realized. Sketches and or artwork will aid the graphic artist in rendering the final illustration.

SDL

Graphics and text from Telelogic’s SDT 3.6 editor will be used for Annex B. We will use the FrameMaker export facility of the Telelogic tool.

TG1 Editors IEEE P802.15 Instruction Manual – Download [optimized]
TG1 Editors IEEE P802.15 Instruction Manual – Download

Read User Manual Online (PDF format)

Read User Manual Online (PDF format)  >>

Download This Manual (PDF format)

Download this manual  >>