Submitting A Profile App¶
Profile App Metadata¶
<Module xmlns:ning="http://developer.ning.com/opensocial/"> <ModulePrefs title="My Profile App" description="The description" author_email="firstname.lastname@example.org" thumbnail="http://example.com/thumb.png" screenshot="http://example.com/screenshot.png"> </ModulePrefs> <Content> ... </Content> </Module>
The <ModulePrefs> tag of your XML file must have the following attributes filled out for an OpenSocial Application to be considered for the Directory:
The title of your OpenSocial Application. The title is used in many places, including the Profile App Directory, the module title area as well as the default text for the navigation tab. All titles should have a maximum length of 24 characters.
- The description the Profile App. This description appears in about view for the application in the Profile App Directory.
- An email address that Network Creators can contact you for support. It is displayed publicly in the Profile App Directory.
- URL for the Application thumbnail. This should be a logo for you Profile App or for your company. The image must be a 120px by 60px image. The preferred image type is PNG, however GIF and JPG are also acceptable.
- URL for screenshot of your Profile App. The recommended width is 280px, with a maximum width of 502px . The height of the screenshot should be the natural height of the gadget when it’s in use, with a maximum height of 1000px.
We have made a PhotoShop PSD that you may use as a screenshot template.
Because of our commitment to Ning’s Network Creators, we have a thorough list of qualifications for a Ning Network to be included into the Profile App Directory. Here are a list of best practices that we recommend:
What you must do¶
- Your application must add value to Ning Networks
- Your application must work as described
- Ensure that all Profile App resources are not blocked by robots.txt or similar
- Make sure the <ModulePrefs> attributes of your Application are properly filled out and images are the proper sizes.
- The title must accurately describe your application
- The thumbnail must accurately represent the application or your company
- The description should accurately describe the application, make sense, and be free of spelling and grammatical errors.
- The author_email attribute must point at a valid email address
- If using Ning specific features include the Ning XML namespace: <Module xmlns:ning="http://developer.ning.com/opensocial/">
- Make sure screenshots represent your application and are the proper sizes.
- Fail gracefully when member data is not available
- Provide a good experience for signed out users of your application when the user ID is _anonymous
- If your Application allows users to download, view, listen to or otherwise access or distribute third party content dealing with copyright, follow the instructions of Section 6 of the Application Developer Terms of Service.
What you should do¶
- Make sure your application is free of spelling and grammatical errors
- Test your Profile App in IE6, IE7, the latest versions of FireFox, Safari, IE, and Chrome. We recommend Yahoo’s A-Grade browser support.
- Be aware that every Ning Network is unique and has different needs. Some Ning Networks are sensitive towards harsh language or suggestive images.
- Be aware that not every viewer of your application will be the Network Creator
- Optimize your Profile App so it runs as fast as possible. Many optimization tips used in general web development will also apply to developing your Profile App. Read the OpenSocial Latency Combat Field Manual.
- Beware of caching. All Profile Apps have caching enabled, meaning the code severed to the Ning Network may be slightly out of date
- Give users of your Profile App a fun and meaningful social experience. Read Social Design Best Practices
- Be aware that Ning Networks have different themes. Inhert as much style as possible using gadgets.skins
What not to do¶
- If your Profile App shares user generated content between Ning Networks, profile thumbnail images can not be displayed
- Don’t require your users to download an browser/platform-specific external application. We want to be sure that all people, regardless of the browser they use, have a great experience when using a Profile App. For this reason, any Profile Apps that have severe limitations on particular platforms or require users to download external files to install on operating systems will not be admitted into the Ning Profile Apps Directory.
- Don’t violate our Terms of Service. The Terms of Service we currently use for Ning Networks carry over to Profile Apps, and violators will be handled appropriately
- Don’t do anything that will overly annoy the people using your Profile App. If you have an Profile App that runs slow scripts, requires an external download, immediately navigates away from the page or blocks the execution of the Profile Page, you’ll upset the people using your Application which will make your Profile App less popular.
Submitting your Profile App¶
To submit your Profile App to the Profile App Directory, log in to the Ning Developer Network and click on Create an Application on the main page, or choose Submissions from the navigation menu. From there, enter the URL for your Profile App.
Once you have added the URL, your Profile App will be in one of the following states:
- A Profile App receives this state once you successfully add the URL of your XML File. Select a Category that best matches your Profile App, and click ‘Submit for Review’. Upon successful submission, your Profile App will be in a “Pending” state.
- Once the Profile App is submitted and all required fields have been completed, the Profile App is in a “Pending” state awaiting approval from a member of the Ning Team. From there, the Profile App will be either “Active” or “Rejected,” and an e-mail will be sent to the email address you used to log in to the Ning Developer Network.
- Indicates that the Profile App is currently live in the Profile App Directory. Once in this state, Profile App Developers have the ability to delete or take their Applications offline.
- Indicates that the Profile App was rejected from the Profile App Directory. Any additional notes will also be included with the status message.
- Indicates that that Profile App that was previously in the Profile App Directory has been removed. Any additional notes will also be included with the status message.