MDAboutController Demo

Purpose

MDAboutController is a complete About UIViewController package for iOS apps. It automatically fetches info from your Info.plist, and also populates credits from Credits.plist. This repository serves to demonstrate and test the MDAboutController class. Please visit the MDAboutController repository for the actual code :)

Installation

$ git clone https://github.com/mochidev/MDAboutControllerDemo
$ git submodule init
$ git submodule update

To include it into your own projects either download the source, or run the following on your git repo:

$ cd <your_repo>
$ git submodule add git@github.com:mochidev/MDAboutController.git <local_subpath>

This will allow you to update it at anytime by running $ git submodule update.

Usage

Simply add the MDAboutController submodule to your project, and show the controller via UIViewController's presentModalViewController:animated: method.

In your interface, define the following instance variable and method:

// Defined in interface
MDAboutController *aboutController;
- (IBAction)showAbout:(id)sender;

Then, in your UIViewController subclass implementation, implement the following methods:

// Implemented in implementation of a UIViewController subclass
- (void)dealloc
{
    [aboutController release];
    [super dealloc];
}

- (void)didReceiveMemoryWarning
{
    [super didReceiveMemoryWarning];

    // Check if the about controller is being shown
    if (aboutController.parentViewController == nil) {
        // Release and set to nil, so we can recreate it if we need to
        [aboutController release];
        aboutController = nil;
    }
}

- (IBAction)showAbout:(id)sender
{
    // If the view controller doesn't already exist, create it
    if (!aboutController) {
        aboutController = [[MDAboutController alloc] init];
    }
    
    // Present to user!
    [self presentModalViewController:aboutController animated:YES];
}

Credits.plist

To get the most out of MDAboutViewController, be sure to include a Credits.plist file in your projects resources. This will allow you to add credits, links, images, and text to your about screen. The property list must be configured as an array of dictionaries, with each dictionary representing one section on the about screen.

Each dictionary should have a Type key of type string, which can be a List for a group of links or credits, Text for blocks of text or copyright strings, or Image for images.

Type == List Keys:

Items - an array of dictionaries with mandatory key Name and optional keys Role and Link, all of type string.
Title - an optional title string to include above the group.

Type == Text Keys:

Text - the text to represent.
Link - an optional URL string to link to if the text is tapped.
Size - an optional font size of type number. The default is 13pt.
Alignment - an optional string representing the text alignment. Can be either Left, Right, or the default, Center.

Type == Image Keys:

Image - the name of the image file, much like it is referenced from UIImage's imageNamed: method.

To Do

Navigation controller compatibility
Code based customizations
App portfolio for more info

Coding Style Guidelines

Please see http://webkit.org/coding/coding-style.html

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

EleMints, the EleMints Icon, Mochi Dev, and the Mochi Development logo are copyright Mochi Development, Inc.

Also, it'd be super awesome if you left in the credit line generated automatically by the code that links back to this page :)

Credits

Created by Dimitri Bouniol for Mochi Development, Inc.

rajdn/MDAboutControllerDemo