Apple Publications Style Guide September 2008
Total Page:16
File Type:pdf, Size:1020Kb
Apple Publications Style Guide September 2008 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. Apple Consultants Network and MobileMe are service Copyright © 2008 Apple Inc. All rights reserved. marks of Apple Inc. No part of this publication may be reproduced, stored in 1-Click® is a registered trademark of Amazon.com, Inc. a retrieval system, or transmitted, in any form or by any in the U.S. and other countries. means, mechanical, electronic, photocopying, recording, Adobe and PostScript are trademarks or registered or otherwise, without prior written permission of trademarks of Adobe Systems Incorporated in the Apple Inc., with the following exceptions: Any person is U.S. and/or other countries. hereby authorized to store documentation on a single computer for personal use only and to print copies of The Bluetooth® word mark and logos are registered documentation for personal use provided that the trademarks owned by Bluetooth SIG, Inc. and any use documentation contains the Apple copyright notice. of such marks by Apple is under license. The Apple logo is a trademark of Apple Inc., registered This document mentions software developed by the in the U.S. and other countries. Use of the “keyboard” University of California, Berkeley, FreeBSD, Inc., Apple logo (Shift-Option-K) for commercial purposes The NetBSD Foundation, Inc., and their respective without the prior written consent of Apple may contributors. constitute trademark infringement and unfair “Dolby,” “Pro Logic,” and the double-D symbol are competition in violation of federal and state laws. trademarks of Dolby Laboratories. Confidential Apple Unpublished Works, © 1992–1997 Dolby Laboratories, 1 Infinite Loop Inc. All rights reserved. Cupertino, California 95014 USA FileMaker is a trademark of FileMaker, Inc., registered 408-996-1010 in the U.S. and other countries. www.apple.com Intel, Intel Core, and Xeon are trademarks of Intel Corp. Apple, the Apple logo, AirMac, AirPort, AirPort Express, in the U.S. and other countries. AirPort Extreme, Apple Cinema Display, AppleScript, AppleShare, Apple Studio Display, AppleTalk, Apple TV, Java™ and all Java-based trademarks and logos are AppleWorks, Aqua, Back to My Mac, Bonjour, Boot Camp, trademarks or registered trademarks of Sun Carbon, Cocoa, ColorSync, Cover Flow, Dashcode, Microsystems, Inc. in the U.S. and other countries. DVD Studio Pro, eMac, Exposé, FileVault, Final Cut, Mighty Mouse™ & © 2008 CBS Operations Inc. All rights Final Cut Pro, Final Cut Studio, FireWire, GarageBand, reserved. iBook, iCal, iChat, iDVD, iLife, iMac, iMovie, Inkwell, OpenGL is a registered trademark of Silicon Graphics, Inc. iPhoto, iPod, iPod Hi-Fi, iSight, iTunes, iWork, Jam Pack, Keychain, Keynote, Leopard, LiveType, Logic, Mac, PowerPC™ and the PowerPC logo™ are trademarks of MacBook, Macintosh, Mac OS, MagSafe, Numbers, Pages, International Business Machines Corporation, used Panther, Photo Booth, PowerBook, Power Mac, Quartz, under license therefrom. QuickDraw, QuickTime, Rosetta, Safari, Shake, Sherlock, Times is a registered trademark of Heidelberger Soundtrack, Spaces, SuperDrive, Tiger, Time Capsule, Druckmaschinen AG, available from Linotype Library TrueType, Velocity Engine, WaveBurner, WebObjects, GmbH. Xcode, Xgrid, Xsan, and Xserve are trademarks of Apple Inc., registered in the U.S. and other countries. UNIX® is a registered trademark of The Open Group. AirTunes, Aperture, Apple Remote Desktop, Other company and product names mentioned herein Cinema Tools, Enterprise Objects, Finder, iPhone, iWeb, are trademarks of their respective companies. Mention MacBook Air, MainStage, Multi-Touch, NetInfo, of third-party products is for informational purposes Photocasting, QuickTime Broadcaster, Shuffle, SnapBack, only and constitutes neither an endorsement nor a Spotlight, Techno, and Time Machine are trademarks recommendation. Apple assumes no responsibility with of Apple Inc. regard to the performance or use of these products. AppleCare, Apple Store, iTunes Music Store, iTunes Store, .Mac, and ProCare are service marks of Apple Inc., registered in the U.S. and other countries. 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 187 Units of Measure 188 Prefixes for Units of Measure 189 Names and Unit Symbols for Units of Measure Chapter 3 195 Apple Products 196 Desktop Computers 196 Portable Computers 197 iPhone and iPod Products 197 Servers 197 Displays 198 Keyboards and Mouse Devices 198 Storage Devices 198 Wireless Networking Products 198 Accessories 199 Software and Technologies 203 Programs and Services Chapter 4 205 Technical Notation 205 General Considerations 205 Code 205 Syntax Descriptions 206 Code Font in Text 206 Metasymbols in Text 3 Chapter 5 207 How to Write a Glossary 207 Audience Considerations 208 Content Guidelines 209 Matters of Form 211 Assembling the Glossary Chapter 6 213 How to Develop an Index 213 Choosing the Number of Levels 213 Main Entries 213 Subentries 214 Wording 214 Commands 214 Cross-References 215 Order of Entries 216 Style of Entries Chapter 7 217 International Style 217 Basic Rules 217 Currency 218 Dates and Times 218 Decimals 219 Languages 220 Telephone Numbers 220 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 2008 edition of the style guide adds terms used in Mac OS X version 10.5.  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 187, 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 195, lists the official names of many Apple hardware and software products. 5  Chapter 4, “Technical Notation,” on page 205, 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 207, provides guidelines for preparing a glossary.  Chapter 6, “How to Develop an Index,” on page 213, provides guidelines for creating an index.  Chapter 7, “International Style,” on page 217, 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. This guide distinguishes the differences as follows:  An entry followed by adj. in parentheses gives the form to be used when the adjective immediately precedes the noun it modifies.