Apple Publications Style Guide December 2009
Total Page：16
File Type：pdf, Size：1020Kb
Apple Publications Style Guide December 2009 style n. 1. The way in which something is said, done, expressed, or performed: a style of speech and writing. 2. The combination of distinctive features of literary or artistic expression, execution, or performance characterizing a particular person, group, school, or era. 3. Sort; type: a style of furniture. 4. A quality of imagination and individuality expressed in one’s actions and tastes: does things with style. 5a. A com- fortable and elegant mode of existence: living in style. b. A mode of living: the style of the very rich. 6a. The fashion of the moment, especially of dress; vogue. b. A par- ticular fashion: the style of the 1920s. 7. A customary manner of presenting printed material, including usage, punctuation, spelling, typography, and arrangement. 8. A form of address; a title. 9a. An implement used for etching or engraving. b. A slen- der pointed writing instrument used by the ancients on wax tablets. 10. The needle of a phonograph. 11 . The gnomon of a sundial. 12 . Botany The usually slender part of a pistil, situated between the ovary and the stigma. 13 . Zoology A slender, tubular, or bristlelike process: a cartilaginous style. 14 . Medicine A surgical probing instru- ment; a stylet. 15. Obsolete A pen. —tr. v. styled, styl•ing, styles 1. To call or name; designate: George VI styled his brother Duke of Windsor. 2. To make consistent with rules of style: style a manuscript. 3. To give style to: style hair. [Middle English, from Old French, from Latin stylus, stilus, spike, pointed instrument used for writing, style. See STYLUS.] —styl’er n. —styl’ing n. K Apple Inc. AppleCare, Apple Store, iDisk, iMix, iTunes Music Store, Copyright © 2009 Apple Inc. All rights reserved. iTunes Store, .Mac, and ProCare are service marks of Apple Inc., registered in the U.S. and other countries. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any Apple Consultants Network, App Store, and MobileMe means, mechanical, electronic, photocopying, recording, are service marks of Apple Inc. or otherwise, without prior written permission of 1-Click® is a registered trademark of Amazon.com, Inc. Apple Inc., with the following exceptions: Any person is in the U.S. and other countries. hereby authorized to store documentation on a single computer for personal use only and to print copies of Adobe and PostScript are trademarks or registered documentation for personal use provided that the trademarks of Adobe Systems Incorporated in the documentation contains the Apple copyright notice. U.S. and/or other countries. The Apple logo is a trademark of Apple Inc., registered The Bluetooth® word mark and logos are registered in the U.S. and other countries. Use of the “keyboard” trademarks owned by Bluetooth SIG, Inc. and any use Apple logo (Shift-Option-K) for commercial purposes of such marks by Apple is under license. without the prior written consent of Apple may This document mentions software developed by the constitute trademark infringement and unfair University of California, Berkeley, FreeBSD, Inc., competition in violation of federal and state laws. The NetBSD Foundation, Inc., and their respective Apple contributors. 1 Infinite Loop “Dolby,” “Pro Logic,” and the double-D symbol are Cupertino, California 95014 trademarks of Dolby Laboratories. Confidential 408-996-1010 Unpublished Works, © 1992–1997 Dolby Laboratories, www.apple.com Inc. All rights reserved. Apple, the Apple logo, AirMac, AirPort, AirPort Express, FileMaker is a trademark of FileMaker, Inc., registered AirPort Extreme, Apple Cinema Display, AppleScript, in the U.S. and other countries. AppleShare, AppleTalk, Apple TV, AppleWorks, Aqua, Back to My Mac, Bonjour, Boot Camp, Carbon, Cocoa, Intel, Intel Core, and Xeon are trademarks of Intel Corp. ColorSync, Cover Flow, Dashcode, DVD Studio Pro, eMac, in the U.S. and other countries. Exposé, FileVault, Final Cut, Final Cut Pro, Final Cut Java™ and all Java-based trademarks and logos are Studio, FireWire, GarageBand, iBook, iCal, iChat, iDVD, trademarks or registered trademarks of Sun iLife, iMac, iMovie, Inkwell, iPhone, iPhoto, iPod, iPod Microsystems, Inc. in the U.S. and other countries. classic, iPod Hi-Fi, iPod nano, iPod shuffle, iPod touch, Mighty Mouse™ & © 2008 CBS Operations Inc. All rights iSight, iTunes, iWork, Jam Pack, Keychain, Keynote, reserved. Leopard, LiveType, Logic, Logic Studio, Mac, MacBook, MacBook Air, Macintosh, Mac OS, MagSafe, MainStage, OpenGL is a registered trademark of Silicon Graphics, Inc. Numbers, Pages, Panther, Photo Booth, PowerBook, PowerPC™ and the PowerPC logo™ are trademarks of Power Mac, Quartz, QuickDraw, QuickTime, Rosetta, International Business Machines Corporation, used Safari, Shake, Sherlock, Snow Leopard, Soundtrack, under license therefrom. Spaces, Spotlight, SuperDrive, Tiger, Time Capsule, Time Machine, TrueType, Velocity Engine, WaveBurner, Times is a registered trademark of Heidelberger WebObjects, Xcode, Xgrid, Xsan, and Xserve are Druckmaschinen AG, available from Linotype Library trademarks of Apple Inc., registered in the U.S. and other GmbH. countries. UNIX® is a registered trademark of The Open Group. AirTunes, Aperture, Apple Remote Desktop, Apple Other company and product names mentioned herein Studio Display, Cinema Tools, Enterprise Objects, Finder, are trademarks of their respective companies. Mention iWeb, Multi-Touch, NetInfo, OpenCL, Photocasting, of third-party products is for informational purposes QuickTime Broadcaster, Shuffle, SnapBack, and Techno only and constitutes neither an endorsement nor a are trademarks of Apple Inc. recommendation. Apple assumes no responsibility with regard to the performance or use of these products. 1 Contents Preface 5 About This Guide 5 What’s in This Guide 6 Standard Editorial Resources 6 Conventions Used in This Guide Chapter 1 7 Style and Usage Chapter 2 191 Units of Measure 192 Prefixes for Units of Measure 193 Names and Unit Symbols for Units of Measure Chapter 3 199 Apple Products 200 Desktop Computers 200 Portable Computers 201 iPhone and iPod Products 201 Servers 201 Displays 202 Keyboards and Mouse Devices 202 Storage Devices 202 Wireless Networking Products 203 Accessories 204 Software and Technologies 208 Programs and Services Chapter 4 209 Technical Notation 209 General Considerations 209 Code 209 Syntax Descriptions 210 Code Font in Text 210 Metasymbols in Text 3 Chapter 5 211 How to Write a Glossary 211 Audience Considerations 212 Content Guidelines 213 Matters of Form 215 Assembling the Glossary Chapter 6 217 How to Develop an Index 217 Choosing the Number of Levels 217 Main Entries 217 Subentries 218 Wording 218 Commands 218 Cross-References 219 Order of Entries 220 Style of Entries Chapter 7 221 International Style 221 Basic Rules 221 Currency 222 Dates and Times 222 Decimals 223 Languages 224 Telephone Numbers 224 Units of Measure 4 Contents About This Guide Preface The Apple Publications Style Guide provides editorial guidelines for text in Apple instructional publications, technical documentation, reference information, training programs, and the software user interface. Writers, editors, and developers can use this document as a guide to writing style, usage, and Apple product terminology. Writers and editors should thoroughly review the guide so that they become familiar with the range of issues involved in creating high-quality, readable, and consistent documentation. Apple developers and third-party developers should follow this guide when labeling user interface elements and writing any text that users see, as well as when writing documentation for their users. For more detail about the user interface, consult the Apple Human Interface Guidelines. For details about terms used frequently in Apple marketing materials (such as the names of specific products, services, and sales programs), refer to the Apple Marketing Communications Style Guide. Note that some terms are treated differently in this guide and the Apple Marketing Communications Style Guide. What’s in This Guide This 2009 edition of the style guide is a minor revision for Mac OS X version 10.6, with a small number of new or updated entries.  Chapter 1, “Style and Usage,” on page 7, shows how certain terms are used in Apple publications and gives preferred style (capitalization, spelling, and hyphenation) for those terms. It also gives general rules of style and usage for Apple publications. Names of Apple products and services are in this chapter only if there is more information than the correct spelling and capitalization; otherwise, those names are in Chapter 3 only.  Chapter 2, “Units of Measure,” on page 191, provides preferred style for spelled-out and abbreviated forms of units of measurement likely to occur in Apple publications.  Chapter 3, “Apple Products,” on page 199, lists the official names of many Apple hardware and software products. 5  Chapter 4, “Technical Notation,” on page 209, provides special style and usage rules that apply largely or exclusively to developer documentation. (Some of these rules are also included by topic in “Style and Usage.”)  Chapter 5, “How to Write a Glossary,” on page 211, provides guidelines for preparing a glossary.  Chapter 6, “How to Develop an Index,” on page 217, provides guidelines for creating an index.  Chapter 7, “International Style,” on page 221, provides guidelines for creating material for localization. Standard Editorial Resources In general, follow the style and usage rules in:  The American Heritage Dictionary  The Chicago Manual of Style  Words into Type Exceptions to certain guidelines in these resources are noted in this guide. In cases where reference sources conflict with each other, follow:  The Chicago Manual of Style for questions of style and usage  The American Heritage Dictionary for questions of spelling Also refer to any department-specific materials provided by your editor. Conventions Used in This Guide Modifiers consisting of two or more words are often hyphenated when they precede a noun, but not when they follow the verb as a compound predicate adjective.