Please note that as of October 24, 2014, the Nokia Developer Wiki will no longer be accepting user contributions, including new entries, edits and comments, as we begin transitioning to our new home, in the Windows Phone Development Wiki. We plan to move over the majority of the existing entries. Thanks for all your past and future contributions.

Code example instructions

From Wiki
Jump to: navigation, search
Article Metadata
Created: seppo_fn (05 Mar 2008)
Last edited: BuildNokia (16 Apr 2014)

This article provides instructions and recommendations on how to create code example articles. A Code Example is an article that is accompanied with a downloadable and buildable example project, or which contains all of the code required to easily create one.


Create a page

Create a new article following the instructions in FNWiki:New Page.

Instructions on using features related to code examples are detailed in the following sections.

Apply a template (optional)

Nokia Developer automatically applies a very simple template to your article. You can instead use the Code snippet template for developers which has predefined subheadings - this is not mandatory, but it may help you formulate the article. You can also change the headings to suit your example.

Tip.pngTip: To use Code snippet template for developers you must edit it, and copy its source text into your new page.

Add correct categories

Add Code Examples category in order to get your example counted. Additionally add relevant technology and application area categories.

Use advanced code syntax display (optional)

You can use code syntax highlighting of your article as described in Help:Code Syntax Highlighting. The highlighting plugin provides markup for all the main development frameworks supported on Nokia Developer wiki (and many more)

Add a link to the source code in Github (highly recommended)

You should provide the example application or any related file as a link to the source repository in Github. This is typically referenced in the sourcecode and/or installationfile fields in the ArticleMetaData.