Wiki Integration into Xcode

From RemObjects Wiki

This is a Wiki Help Topic
Provides help on using the RemObjects Wiki itself

If you have suggestions for this page, please send them to us: email.

The RemObjects Wiki provides integration with Apple's Xcode IDE to give developers using Data Abstract for Xcode and RemObjects SDK for Xcode easy access to context sensitive help from within the development environment. Two versions of the Help Integration are provided:

The Live Wiki integration registers the content of the wiki with the Xcode IDE, but relies on the live wiki pages hosted on this page for documentation viewing. It is lightweight and pages are always up to date – but an active internet connection is required to browse the documentation.

The Offline Wiki integration registers the same content with Xcode's help system, but includes local copies of the relevant pages, so documentation can be viewed without internet connection (for example when developing on a plane or out in the park). The offline wiki takes up more local space, and the documentation pages may not always reflect the latest wiki content (although code will regularly update the local documentation via RSS).

The Wiki can be integrated with Xcode using one of the following two links:

• Live Wiki RSS Feed
• Offline Wiki RSS Feed

How to Integrate with Xcode

To register one of the two Wiki RSS feeds with Xcode, simply open the application's Preferences window (⌘,) and go to the Documentation tab. Click on Add Publisher and paste in one of the two Wiki RSS Feed URLs from above:

The RemObjects Wiki Xcode Documentation Set will now show in the list of subscribed documentation sets. Xcode will automatically do the initial download, as well as regularly check the RSS feed for updates and apply them automatically.

Using Help in Xcode

Once the Wiki is integrated, you can ⌥-double-click on an identifier, to bring up the Quick help bubble inside the editor, along with options to jump you to the header file that defines the identifier or to open related full topics in the Documentation viewer (⌥⌘-double-click also takes you there):

The Documentation viewer also allows you to search for Wiki content using the Search field in the top right, and the Home popup includes the RemObjects Wiki start page, alongside the Apple-provided documentation:

See Also

• Help Glossary
• Is that a Wiki in your Xcode? Blog Post