ClamShell

Tidy Documentation Viewer

What is it?

ClamShell is a fast and flexible documentation viewer. It can be used as a standalone window or as a popover above other running applications.

Usage

• Download a Documentation Set on a topic that interests you.

• Open ClamShell.app or run open clamshell://searchText=text to launch ClamShell as a standalone window.

• Select a Documentation Set to be used as the search index from the menu using File > Select Documentation Set....

• Use the search bar to find useful documentation or launch ClamShell as a popover as detailed below:

Integration Usage

To launch ClamShell as a popover, call open clamshell://searchText=text and append &x=500&y=600 where x and y are the origin coordinates for the popover arrow, relative to the bottom left corner of the screen.

Example usage for ClamShell, integrated into Redcar Editor.

Building ClamShell

ClamShell uses CocoaPods for dependency management. To configure:

• Install CocoaPods using gem install cocoapods and pod setup
• Install the required pods from the command line using pod install

Open the xcworkspace for ClamShell and run the ClamShell scheme default target to start ClamShell.

Testing

ClamShell is tested using Kiwi. Run tests using the ClamShell default scheme and selecting Menu > Product > Test.