About the Chronicle Plugin for Xcode
Chronicle is a code archiving tool, implemented as a plugin for the Xcode IDE distributed with Mac OSX. It allows you to easily organize and access frequently used text... such as subroutines, methods, or comments... in one simple interface. Chronicle's integration with Xcode makes adding the contents of your files to the active Xcode document quick and easy. And, Chronicle's ability to capture text from the frontmost Xcode text document makes adding text to your Chronicle Library painless and fast.
The Chronicle plugin is developed for OSX 10.4 and later. Installations for earlier versions of OSX are not directly supported, as some of the features require cocoa support not available in previous versions of OSX. The Xcode plugin architecture is primarily Applescript-based, so much of the plugin is developed using Applescript. Some features and interface customizations make use of objective-C methods and custom subclasses to enhance the features of the plugin. The Initial release of the plugin requires the 'Finder' application to be present and running, so users who use alternative file system managers will not be able to use the Chronicle plugin at this time.
Key Features:
Xcode Integration - Quickly access Chronicle features from the Xcode application menu.
"Send" text to Xcode - Easily insert text into open Xcode text documents.
"Capture" Xcode documents - Grab a selection or entire text from Xcode into Chronicle.
File Management Interface - Chronicle 'Library' provides a clean list of all files and folders.
Built-in Editor - Basic text editor provides for creation and editing of Chronicle files.
Xcode Integration...
The Chronicle plugin is a bundle-type plugin that is loaded by Xcode at launch time. Xcode treats the plugin as if it were actually part of the application, so the plugin functions seamlessly with your normal Xcode workflow. When Xcode builds it's main application menu (at the top of the screen) the plugin adds it's own menu item... a small 'book' icon. From this menu you can display the Chronicle Library, edit plugin preferences, get plugin help, and access any other plugin options that may be added in the future.
"Send" text to Xcode...
The key feature of Chronicle, is it's ability to transfer the content of your Chronicle files to your Xcode text documents. You can send text in two different ways, either directly from the Files list, or while viewing the file in the Editor. When sending text from the FIles list, the entire contents of the selected file is read and inserted into the active text document. This is a quick and effective way to add content to your project, especially if you are familiar with the plugin and your file contents. To send text from the Editor, you can either select a portion of the text or send the whole document, offering a bit more flexibility in what portion of the file is inserted into your Xcode document.
See also:
Sending Text to Xcode
"Capture" Xcode documents...
Another useful feature of the Chronicle plugin, is it's ability to 'Capture' code and text from Xcode documents. Text can be captured either by selection or the entire active Xcode text document. The target for the capture can be an existing Chronicle file, a new file, or to the clipboard. Options in the plugin Preferences, available in the Chronicle menu, determine how captured text is handled by Chronicle.
See also:
Capturing Text from Xcode
File Management Interface...
Chronicle's Files list, the main view in the plugin, shows all of the files and folders contained in your 'User Data' directory. All of Chronicle's files are saved in one folder, which is by default named 'User Data' and stored in the Chronicle directory in your Application Support folder. The location of this folder is set when the plugin is first configured, and is entirely configurable by the user. Files and folders can be created, edited, and deleted via the FIles list and FIle/Folder Editors in the plugin window. All features required to manage all of the files and folders are built right into the plugin interface.
See also:
Using the Files list
Built-in Editor...
Chronicle has a built-in text editor for creating and editing your Chronicle file content. Although the Editor is quite simple, is supports the basic features found in all text views. Text is saved in plain text format, and is not evaluated by Chronicle in terms of the type of data the file contains. For this reason, files such as images, pdf's, rtf files, etc. can be imported, but are viewed as PLAIN TEXT, not as data or styled text. Although Chronicle makes no attempt to format text, it can handle any type of text... making it flexible enough to handle any type of data, from applescript to obj-c to raw image data... leaving Chronicle's true abilities up to you to discover.
See also:
Using the Editor
Chronicle Plugin - Copyright 2005 - Jed Green
www.geocities.com/jobu10000/Chronicle/