This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
extensions:creating_an_extension [2011/03/12 17:38] – [Creating a Wiki Page] daniel | extensions:creating_an_extension [2013/06/02 13:24] (current) – daniel | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Creating an Extension for Sparrow ====== | ||
+ | |||
+ | First of all: **Thanks for creating an extension for Sparrow!** | ||
+ | |||
+ | As you might know, one of Sparrow' | ||
+ | |||
+ | To integrate well with the rest of Sparrow (and with other extensions), | ||
+ | |||
+ | ===== Best practices ===== | ||
+ | |||
+ | ==== Custom class prefix ==== | ||
+ | |||
+ | Don't use the **'' | ||
+ | |||
+ | ==== Don't change the Sparrow source code ==== | ||
+ | |||
+ | An extension should not make it necessary to change the source code of Sparrow. If you need to modify a Sparrow class, please try using Objective-C' | ||
+ | |||
+ | ==== Source code repository ==== | ||
+ | |||
+ | If your extension consists of only a few files, we recommend using GitHub' | ||
+ | |||
+ | //Gist is a simple way to share snippets and pastes with others. All gists are git repositories, | ||
+ | |||
+ | This is extremely convenient. Even if you don't care about VCS-Systems at all and haven' | ||
+ | |||
+ | To create a gist, create one on the [[https:// | ||
+ | |||
+ | Of course, if your extension is too extensive, you can create a full-fledged Git repository or provide the links to any other hosting service or private homepage. | ||
+ | |||
+ | ===== Creating a Wiki Page ===== | ||
+ | |||
+ | When your extension is ready, please take the time to create a Wiki-page with all the links, a description and usage guidelines. | ||
+ | |||
+ | To create a new wiki-page, you have to register at the Sparrow Wiki. Create a user by clicking on " | ||
+ | |||
+ | Thankfully, this is very easy to do. Just paste the following address into your browser' | ||
+ | |||
+ | http:// | ||
+ | |||
+ | On the page that pops up, click on " | ||
+ | |||