---

Introduction to Documentation Set Guide

Contents:

Organization of This Document
See Also

Xcode, Apple’s Mac OS X development environment, includes an integrated documentation window that allows users to easily browse and search developer documentation.Third-party developers can integrate their own documentation with the Xcode IDE and get the same full-featured documentation viewer that Xcode provides for Apple’s own developer documentation.

This document explains how to package and build a documentation set for use with Xcode. If you have a developer-targeted software product, this document shows you how to integrate documentation for that product with the Xcode documentation window. This document assumes that you have existing HTML or PDF documentation files; it does not describe how to write or generate these documentation files.

In this document the term documentation producer (or producer for short) identifies a person involved in creating documentation sets. The term documentation user (or user for short) refers to Xcode users who access documentation sets installed on their file systems using the Xcode Documentation window.

Organization of This Document

This document contains the following chapters:

• “Overview of Documentation Sets” introduces the documentation set bundle and describes how they appear in the Xcode documentation window. It also provides an overview of how to create a documentation set.

• “Creating Documentation Sets” describes how to create and name the folder hierarchy for your documentation set bundle, as well as how to choose where to install that bundle.

• “Configuring Documentation Sets” introduces the Info.plist and Nodes.xml files, which are required for any documentation set. This chapter shows how to use these files to describe the documentation set and its contents.

• “Supporting API Lookup in Documentation Sets” shows how to create a tokens file to support API search in your documentation set.

• “Indexing Documentation Sets” describes the docsetutil indexing tool and shows how to use it to index your documentation set, so that Xcode can access and display its contents.

• “Internationalizing Documentation Sets” shows how to support multiple languages by localizing all or some of the contents of the documentation set bundle.

• “Acquiring Documentation Sets Through Web Feeds” describes how to support automatic detection and downloading of documentation set updates, using an RSS or Atom feed.

• “Documentation-Set Nodes Schema Reference” lists all of the elements supported in the nodes file format.

• “Documentation-Set Tokens Schema Reference” lists all of the elements supported in the tokens file format.

• “Documentation-Set Property List Key Reference” describes the info plist keys that Xcode recognizes.

See Also

In addition to the material in this document, you may find the following resources helpful:

• Xcode User Guide describes Xcode and the Xcode Documentation window.

• The AtomEnabled website provides information about the Atom format.

---