Microsoft Manual of Style for Technical Publications Third Edition Ebook

Total Page:16

File Type:pdf, Size:1020Kb

Microsoft Manual of Style for Technical Publications Third Edition Ebook PUBLISHED BY Microsoft Press A Division of Microsoft Corporation One Microsoft Way Redmond, Washington 98052-6399 Copyright © 2004 by Microsoft Corporation All rights reserved. No part of the contents of this book may be reproduced or transmitted in any form or by any means without the written permission of the publisher. Library of Congress Cataloging-in-Publication Data Microsoft Manual of Style for Technical Publications / Microsoft Corporation Editorial Style Board.--3rd ed. p. cm. Includes index. ISBN 0-7356-1746-5 1. Technical writing--Handbooks, manuals, etc. 2. Microsoft Corporation. I. Microsoft Corporation. Editorial Style Board. T11.M467 2003 808'.066005--dc22 2003065115 Printed and bound in the United States of America. 1 2 3 4 5 6 7 8 9 QWT 8 7 6 5 4 3 Distributed in Canada by H.B. Fenn and Company Ltd. A CIP catalogue record for this book is available from the British Library. Microsoft Press books are available through booksellers and distributors worldwide. For further information about international editions, contact your local Microsoft Corporation office or contact Microsoft Press International directly at fax (425) 936-7329. Visit our Web site at www.microsoft.com/learning/. Send comments to [email protected]. Active Directory, ActiveX, DirectDraw, DirectX, Encarta, FrontPage, Home Essentials, IntelliMouse, JScript, Microsoft, Microsoft Press, MS-DOS, MSDN, MSN, Natural, Outlook, PowerPoint, Slate, Verdana, Visio, Visual Basic, Visual FoxPro, Visual Studio, Windows, Windows Media, Windows NT, Windows Server, and Xbox are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Other product and company names mentioned herein may be the trademarks of their respective owners. The example companies, organizations, products, domain names, e-mail addresses, logos, people, places, and events depicted herein are fictitious. No association with any real company, organization, product, domain name, e-mail address, logo, person, place, or event is intended or should be inferred. This book expresses the author’s views and opinions. The information contained in this book is provided without any express, statutory, or implied warranties. Neither the authors, Microsoft Corporation, nor its resellers or distributors will be held liable for any damages caused or alleged to be caused either directly or indirectly by this book. Acquisitions Editor: Alex Blanton Project Editor: Kristine Haugseth and Sandra Haynes Technical Editor: Jim Purcell Indexer: Kari Kells Body Part No. X10-08622 Contents Acknowledgments . xvii Introduction to the Third Edition . .xix How to use this manual . .xix Other reference materials . xx About the CD. .xxi Support Information . .xxi General Topics 1: Documenting the User Interface Screen Terminology . 3 Mouse Terminology. 17 Dialog Boxes and Property Sheets. 6 Messages . 20 Unnamed Buttons . 13 Key Names . 22 Menus and Commands. 13 Command Syntax . 26 Control Panel . 16 File Names and Extensions . 27 2: Content Formatting and Layout Art, Captions, and Callouts. 29 Lists . 48 Cross-References . 33 Marginal Notes . 51 Document Conventions . 36 Page Breaks . 52 Headings and Subheadings . 42 Tables . 53 Line Breaks . 45 Notes and Tips . 57 3: Global Content Global Art . 60 Foreign Words and Phrases . 67 Examples and Scenarios . 61 Time and Place . 67 Global Syntax . 61 Names and Contact Information. 68 Word Choice. 62 Fonts . 69 Technical Terms . 65 Web, Software, and HTML Issues . 70 Jargon. 66 Additional Globalization Resources . 71 4: Content for Software Developers Reference Documentation . 73 Coding Style . 78 Code Comments . 75 Logical Operators. 80 Code Formatting Conventions. 76 COM, ActiveX, and OLE Terminology . 80 iii Contents 5: Web Content Titles of Web Pages . 87 HTML Tag, Element, and Attribute Styling . 89 Descriptions of Web Pages . 88 XML Tag, Element, and Attribute Styling. 90 6: Indexing and Attributing Indexing . 93 Keywords and Online Index Entries. 101 7: Tone and Rhetoric Tone and the Reader . 105 Anthropomorphism. 111 Bias-Free Communication. 106 Humor . 112 Parallelism . 109 8: Accessible Content Accessibility Appendix . 113 Accessible Graphics and Design . 115 Accessible Web Pages . 113 Acceptable Terminology . 116 Accessible Writing . 114 Additional Resources. 116 9: Common Style Problems Procedures. 117 Time Zones . 141 Dates . 124 URLs, Addresses. 142 Capitalization . 125 Company with Product Names . 144 Measurements and Units of Measure . 128 Version Identifiers . 144 Numbers . 131 Readme Files and Release Notes . 146 Protocols . 137 Bibliographies. 150 Names of Special Characters . 137 Titles of Publications . 152 Telephone Numbers . 139 10: Grammatical Elements Verbs and Verb Forms. 157 Prepositions . 168 Person . 164 Prefixes . 169 Noun Plurals. 166 Dangling and Misplaced Modifiers . 170 Possessives . 167 11: Punctuation Formatting Punctuation . 171 Quotation Marks . 176 Periods . 172 Parentheses . 177 Commas. 173 Hyphens, Hyphenation . 177 Apostrophes . 174 Dashes . 179 Colons . 174 Ellipses. 181 Semicolons . 175 Slash Marks. 182 12: List of Acronyms and Abbreviations iv Contents Usage Dictionary A -able, -ible. 199 alphanumeric . 207 abort. 199 alt text . 207 above . 200 A.M., P.M.. 207 accelerator key . 200 among vs. between. 207 access . 200 ampersand (&). 208 accessible. 201 and/or . 208 access key . 201 and so on. 208 accessory . 201 antialiasing . 209 access privileges . 202 antivirus. 209 access rights . 202 appears, displays . 209 accounts receivable . 202 appendix, appendixes, appendices . ..
Recommended publications
  • Microsoft DNS
    1 a. Domain Name Service (DNS) encompassing Microsoft DNS From Wikipedia, the free encyclopedia Jump to: navigation, search Microsoft DNS is the name given to the implementation of domain name system services provided in Microsoft Windows operating systems. Contents [hide] 1 Overview 2 DNS lookup client o 2.1 The effects of running the DNS Client service o 2.2 Differences from other systems 3 Dynamic DNS Update client 4 DNS server o 4.1 Common issues 5 See also 6 References 7 External links [edit] Overview The Domain Name System support in Microsoft Windows NT, and thus its derivatives Windows 2000, Windows XP, and Windows Server 2003, comprises two clients and a server. Every Microsoft Windows machine has a DNS lookup client, to perform ordinary DNS lookups. Some machines have a Dynamic DNS client, to perform Dynamic DNS Update transactions, registering the machines' names and IP addresses. Some machines run a DNS server, to publish DNS data, to service DNS lookup requests from DNS lookup clients, and to service DNS update requests from DNS update clients. The server software is only supplied with the server versions of Windows. [edit] DNS lookup client Applications perform DNS lookups with the aid of a DLL. They call library functions in the DLL, which in turn handle all communications with DNS servers (over UDP or TCP) and return the final results of the lookup back to the applications. 2 Microsoft's DNS client also has optional support for local caching, in the form of a DNS Client service (also known as DNSCACHE). Before they attempt to directly communicate with DNS servers, the library routines first attempt to make a local IPC connection to the DNS Client service on the machine.
    [Show full text]
  • Visual Basic INTRODUCTION : - Visual Basic Is a Windows Programming Language That Has Developed at Microsoft Corporation
    Visual Basic INTRODUCTION : - Visual Basic is a Windows Programming Language that has developed at Microsoft Corporation. Visual Basic is a powerful programming language to develop sophisticated windows programs very quickly. VB is a one of the RAD (Rapid application development) tools as it enables the programmer to develop application very easily and very quickly. Visual Basic application is very popular as front end to many client/server database systems like SQL/Server, Oracle etc. VISUALBASIC APPLICATION DEVELOPMENT CYCLE:- Decide what you want the computer to do. Decide how you want your program to look on the screen. (The appearance of your program is called the user interface). Draw your user interface by using common component, such as windows, menus and command buttons. (The components of user interface are called objects or controls). Define the name, color, size and appearance of each user interface object. (An object’s characteristics are called properties.) Write instruction in BASIC to make each part of your program do something. (BASIC instructions are called commands). Run your program to see whether it works. Fix any errors (or bugs) in your program. User Interface is what someone sees when program is running. Every program has a user interface in one form or another. A visual Basic user interface consists of forms and objects. A form is nothings more than a window that appears on the screen. Objects are items that appear on a form, such as command button, scroll bar, option button or check box. An object enables the user to give commands to program. Any time a user press a key, moves the mouse, or clicks the mouse button, such an action is called an event.
    [Show full text]
  • Introducing Windows Server 2012 R2 Preview Release
    Introducing Windows Server 2012 R2 Preview Release Mitch Tulloch with the Windows Server Team PUBLISHED BY Microsoft Press A Division of Microsoft Corporation One Microsoft Way Redmond, Washington 98052-6399 Copyright 2013 © Microsoft Corporation All rights reserved. No part of the contents of this book may be reproduced or transmitted in any form or by any means without the written permission of the publisher. Library of Congress Control Number (PCN): 2013945003 ISBN: 978-0-7356-8293-1 Printed and bound in the United States of America. First Printing Microsoft Press books are available through booksellers and distributors worldwide. If you need support related to this book, email Microsoft Press Book Support at [email protected]. Please tell us what you think of this book at http://www.microsoft.com/learning/booksurvey. Microsoft and the trademarks listed at http://www.microsoft.com/about/legal/en/us/ IntellectualProperty/Trademarks/EN-US.aspx are trademarks of the Microsoft group of companies. All other marks are property of their respective owners. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events depicted herein are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. This book expresses the author’s views and opinions. The information contained in this book is provided without any express, statutory, or implied warranties. Neither the authors, Microsoft Corporation, nor its resellers, or distributors will be held liable for any damages caused or alleged to be caused either directly or indirectly by this book.
    [Show full text]
  • Multiview Terminal Emulator User Guide © 2008 by Futuresoft, Inc
    MultiView Terminal Emulator User Guide © 2008 by FutureSoft, Inc. All rights reserved. MultiView User Guide This manual, and the software described in it, is furnished under a license agreement. Information in this document is subject to change without notice and does not represent a commitment on the part of FutureSoft. FutureSoft assumes no responsibility or liability for any errors or inaccuracies that may appear in this manual. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or other wise, without the prior, written per- mission of FutureSoft, Inc. MultiView 2007, MultiView 2000 Server Edition, MultiView 2008 Server Edition, MultiView Catalyst, MultiView License Manager, MultiView DeskTop and Host Support Server are tradenames of FutureSoft, Inc. Edition 1 May 2008 Document #E-MVUG-MV2007-P053108 Last Updated: 102308 FutureSoft, Inc. 12012 Wickchester Lane, Suite 600 Houston, Texas 77079 USA Printed in the USA 1.800.989.8908 [email protected] http://www.futuresoft.com Table of Contents Contents Chapter 1 Introduction Introduction to MultiView 2007 ....................................................................................... 2 Minimum Requirements .................................................................................................. 2 Contacting FutureSoft Support ........................................................................................ 3 Chapter 2 Installation and Configuration Installing MultiView
    [Show full text]
  • Active Directory with Powershell
    Active Directory with PowerShell Learn to configure and manage Active Directory using PowerShell in an efficient and smart way Uma Yellapragada professional expertise distilled PUBLISHING BIRMINGHAM - MUMBAI Active Directory with PowerShell Copyright © 2015 Packt Publishing All rights reserved. No part of this book may be reproduced, stored in a retrieval system, or transmitted in any form or by any means, without the prior written permission of the publisher, except in the case of brief quotations embedded in critical articles or reviews. Every effort has been made in the preparation of this book to ensure the accuracy of the information presented. However, the information contained in this book is sold without warranty, either express or implied. Neither the author, nor Packt Publishing, and its dealers and distributors will be held liable for any damages caused or alleged to be caused directly or indirectly by this book. Packt Publishing has endeavored to provide trademark information about all of the companies and products mentioned in this book by the appropriate use of capitals. However, Packt Publishing cannot guarantee the accuracy of this information. First published: January 2015 Production reference: 1200115 Published by Packt Publishing Ltd. Livery Place 35 Livery Street Birmingham B3 2PB, UK. ISBN 978-1-78217-599-5 www.packtpub.com Credits Author Project Coordinator Uma Yellapragada Sageer Parkar Reviewers Proofreaders David Green Simran Bhogal Ross Stone Stephen Copestake Nisarg Vora Martin Diver Ameesha Green Commissioning Editor Paul Hindle Taron Pereira Indexer Acquisition Editor Hemangini Bari Sonali Vernekar Production Coordinator Content Development Editor Aparna Bhagat Prachi Bisht Cover Work Technical Editor Aparna Bhagat Saurabh Malhotra Copy Editors Heeral Bhatt Pranjali Chury Gladson Monteiro Adithi Shetty About the Author Uma Yellapragada has over 11 years of experience in the IT industry.
    [Show full text]
  • Advanced Visual Basic
    Advanced Visual Basic Course Designer and Acquisition Editor Centre for Information Technology and Engineering Manonmaniam Sundaranar University Tirunelveli Client / Server Lecture - 1 Client /Server Objectives In this lecture you will learn the following About Client About Server About Client / Server computing Client / Server Model Centre for Information Technology and Engineering, Manonmaniam Sundaranar University 1 Advanced Visual Basic Lecture Unit - 1 1.1 Snap Shot 1.2 Client 1.3 Server 1.4 Client/ Server Computing 1.5 Client/Server Model 1.6 Short Summary 1.7 Brain Storm Lab unit 1 - ( 2 Real Time Hrs ) 2 Centre for Information Technology and Engineering, Manonmaniam Sundaranar University Client / Server 1.1 Snap Shot Any time two computers are involved in the mutual performance of executing an application, with each performing a different function, you are undoubtedly looking at a client/server application. Many definitions of client/server are used. A definition of client/server application is an application that has a client interface and that accesses data on a remote server. The work is distributed between the client system and the remote server system, based on the capabilities of the client and the system and the remote server system, based on the capabilities of the client and server software applications. Client/server systems usually are efficient because network traffic is minimized and each portion of the application is optimized for a particular function. 1.2 Client A client may be either a device or a user on a network that takes advantages of the services offered by a server. Client is often used in a loose way to refer to a computer on the network.
    [Show full text]
  • Micro Focus Security Arcsight Connectors Smartconnector for Microsoft DNS Trace Log Multiple Server File
    Micro Focus Security ArcSight Connectors SmartConnector for Microsoft DNS Trace Log Multiple Server File Configuration Guide September 17, 2020 Configuration Guide SmartConnector for Microsoft DNS Trace Log Multiple Server File September 17, 2020 Copyright © 2014 – 2020 Micro Focus or one of its affiliates. Legal Notices Micro Focus The Lawn 22-30 Old Bath Road Newbury, Berkshire RG14 1QN UK https://www.microfocus.com. Confidential computer software. Valid license from Micro Focus required for possession, use or copying. The information contained herein is subject to change without notice. The only warranties for Micro Focus products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. No portion of this product's documentation may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's internal use, without the express written permission of Micro Focus. Notwithstanding anything to the contrary in your license agreement for Micro Focus ArcSight software, you may reverse engineer and modify certain open source components of the software in accordance with the license terms for those particular components. See below for the applicable terms. U.S. Governmental Rights. For purposes of your license to Micro Focus ArcSight software, “commercial computer software” is defined at FAR 2.101. If acquired by or on behalf of a civilian agency, the U.S.
    [Show full text]
  • The Microsoft Way: COM, OLE/Activex, COM+, and .NET CLR
    8557 Chapter 15 p329-380 8/10/02 12:24 pm Page 329 CHAPTER FIFTEEN The Microsoft way: COM, OLE/ActiveX, COM+, and .NET CLR In a sense, Microsoft is taking the easiest route. Instead of proposing a global standard and hoping to port its own systems to it, it continually re-engineers its existing application and platform base. Component technology is intro- duced gradually, gaining leverage from previous successes, such as the original Visual Basic controls (VBX – non-object-oriented components!), object link- ing and embedding (OLE), OLE database connectivity (ODBC), ActiveX, Microsoft Transaction Server (MTS), or active server pages (ASP). In the standards arena, Microsoft focuses mostly on internet (IETF) and web (W3C) standards. More recently, some of its .NET specifications (CLI and C#) where adopted by ECMA – a European standards body with a fast track to ISO (ECMA, 2001a, 2001b). Microsoft is not trying to align its approaches with OMG or Java standards. While Java figured prominently in Microsoft’s strategy for a while, it has been relegated to a mere continuation of support of its older Visual J++ product – in part as a result of a settlement between Sun and Microsoft. In addition, under the name Visual J# .NET, Microsoft offers a migration tool to .NET, primarily targeting users of Visual J++ 6.0. As part of the .NET initiative, Microsoft is promoting language neutrality as a major tenet of CLR and aims to establish a new language, C#. C# adopts many of the successful traits of Java, while adding several distinctive features of its own (such as value types) and not supporting key Java features (such as inner classes).
    [Show full text]
  • Download Deploying Windows 7, Essential Guidance
    FROM THE Windows® 7 Resource Kit Mitch Tulloch, Tony Northrup, Jerry Honeycutt, Ed Wilson, and the Windows 7 Team at Microsoft I Chapter 3 Deployment Platform .............................................. 85 I Chapter 4 Planning Deployment ............................................ 113 I Chapter 5 Testing Application Compatability ........................... 139 I Chapter 6 Developing Disk Images ......................................... 179 I Chapter 7 Migrating User State Data ...................................... 223 I Chapter 8 Deploying Applications .......................................... 247 I Chapter 9 Preparing Windows PE ........................................... 273 I Chapter 10 Confi guring Windows Deployment Services .............. 293 I Chapter 11 Using Volume Activation ........................................ 335 I Chapter 12 Deploying with Microsoft Deployment Toolkit ........... 355 DEPLOYING WINDOWS 7 83 Chapter 3 Deployment Platform n Tools Introduction 85 n Windows 7 Deployment Terminology 87 n Platform Components 89 n Deployment Scenarios 99 n Understanding Setup 101 n Basic Deployment Process 105 n Microsoft Deployment Toolkit Process 107 n Summary 110 n Additional Resources 111 uilding on technology that the Windows Vista operating system introduced, Windows 7 Bdeployment technology has evolved significantly since Windows XP Professional . For example, it supports file-based disk imaging to make high-volume deployments quicker, more efficient, and more cost effective . The Windows 7 operating system also provides
    [Show full text]
  • Monitoring Windows with Powershell
    Monitoring Windows Systems with PowerShell SL1 version 8.14.0 Table of Contents Introduction 4 Monitoring Windows Devices in the ScienceLogic Platform 5 What is SNMP? 5 What is PowerShell? 5 PowerPacks 6 Configuring Windows Systems for Monitoring with SNMP 7 Configuring SNMP for Windows Server 2016 and Windows Server 2012 8 Configuring Ping Responses 8 Installing the SNMP Service 9 Configuring the SNMP Service 14 Configuring the Firewall to Allow SNMP Requests 19 Configuring Device Classes for Windows Server 2016 and Windows 10 19 Manually Align the Device Class 20 Edit the Registry Key 20 Configuring SNMP for Windows Server 2008 21 Configuring Ping Responses 21 Installing the SNMP Service 22 Configuring the SNMP Service 25 Configuring the Firewall to Allow SNMP Requests 30 Configuring Windows Servers for Monitoring with PowerShell 31 Prerequisites 32 Configuring PowerShell 32 Step 1: Configuring the User Account for the ScienceLogic Platform 33 Option 1: Creating an Active Directory Account with Administrator Access 33 Option 2: Creating a Local User Account with Administrator Access 34 Option 3: Creating a Non-Administrator User Account 34 Optional: Configuring the User Account for Remote PowerShell Access to Microsoft Exchange Server 36 Optional: Configuring the User Account for Remote PowerShell Access to Hyper-V Servers 36 Creating a User Group and Adding a User in Active Directory 36 Setting the Session Configuration Parameters and Group Permissions 37 Creating a PowerShell Credential 38 Optional: Configuring the User Account for
    [Show full text]
  • Experion PKS Dictionary
    Experion PKS Release 516 Dictionary EPDOC-XX29-en-516A August 2020 DISCLAIMER This document contains Honeywell proprietary information. Information contained herein is to be used solely for the purpose submitted, and no part of this document or its contents shall be reproduced, published, or disclosed to a third party without the express permission of Honeywell International Sàrl. While this information is presented in good faith and believed to be accurate, Honeywell disclaims the implied warranties of merchantability and fitness for a purpose and makes no express warranties except as may be stated in its written agreement with and for its customer. In no event is Honeywell liable to anyone for any direct, special, or consequential damages. The information and specifications in this document are subject to change without notice. Copyright 2020 - Honeywell International Sàrl 2 Contents CONTENTS Contents 3 Chapter 1 - About this Dictionary 49 Chapter 2 - A 51 abnormal states 51 absolute origin block 51 absolute origin 51 access capability 51 access token 51 accumulator point 52 AC 52 ACE 52 ACL 52 acronym 52 action algorithm 53 active connector 53 Active Directory 53 active high 53 active low 54 active memory 54 active parameter 54 active server location 54 ActiveX component 54 ActiveX document 54 activity entity 55 activity 55 3 Contents ADFS 55 administrative privileges 55 advanced alarm management 55 AGA 56 AIC 56 AI 56 AIM 56 alarm/event journal 56 alarm line 56 alarm priority 57 alarm 57 algorithm block 58 algorithm 58 alias table
    [Show full text]
  • Application Techniques
    Application Techniques Appeon PowerBuilder® 2017 R2 FOR WINDOWS DOCUMENT ID: DC37774-01-1700-01 LAST REVISED: January 26, 2018 Copyright © 2018 by Appeon Limited. All rights reserved. This publication pertains to Appeon software and to any subsequent release until otherwise indicated in new editions or technical notes. Information in this document is subject to change without notice. The software described herein is furnished under a license agreement, and it may be used or copied only in accordance with the terms of that agreement. Upgrades are provided only at regularly scheduled software release dates. No part of this publication may be reproduced, transmitted, or translated in any form or by any means, electronic, mechanical, manual, optical, or otherwise, without the prior written permission of Appeon Limited. Appeon and other Appeon products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Appeon Limited. SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP and SAP affiliate company. Java and all Java-based marks are trademarks or registered trademarks of Oracle and/or its affiliates in the U.S. and other countries. Unicode and the Unicode Logo are registered trademarks of Unicode, Inc. All other company and product names mentioned may be trademarks of the respective companies with which they are associated. Use, duplication, or disclosure by the government is subject to the restrictions set forth in subparagraph (c)(1)(ii) of DFARS 52.227-7013 for the DOD and as set forth in FAR 52.227-19(a)-(d) for civilian agencies.
    [Show full text]