×
Namespaces

Variants
Actions
Revision as of 08:33, 20 June 2013 by hamishwillee (Talk | contribs)

Help:Categories

From Nokia Developer Wiki
Jump to: navigation, search

This article explains how to apply categories to your articles, and possibly more important, which categories you should apply.

Contents

What categories should I apply?

The default Category Selector screen (shown below) presents the most important categories. Typically you will select one or more relevant categories from each column. In addition you will typically add one or more Version Categories using the Add Categories search box.

Note:

  • Add categories for all relevant Software platforms - like Windows Phone and Series 40
    • If a particular Software platform category is not present users will assume that the article is probably not relevant for that article
    • If no Software platform categories are present the user can assume that either platform is not relevant, or that the article is as yet uncategorised.
  • English articles do not need to add a natural language category.
  • Code Examples category should be applied to articles that include a code example, a downloadable project usually in a zip file.
  • Code Snippets category should be applied to articles that include code "inline". This is not needed if an article is a "Code Example"
  • Specific categories should be applied where possible (i.e. Subcategories rather than parent categories). So for example a Bluetooth article would not need Connectivity
  • Draft should be removed from articles when they are ready to be made visible.

How do I apply categories

The default wiki category selector screen is displayed when you edit an article (shown below). Users can select the most commonly used categories from the lists provided. Once selected, the article categories are displayed together in the "Categories" list at the top of the selector.

If you know the category you need exists but it isn't in the lists you can enter a search string into the "Add Categories" search box to find the best match. If you're not sure what categories are available you can launch the "Category Chooser" (shown below) to see all Recommended categories (in the approved Nokia Developer Ontology) and all categories in the wiki.

Category Chooser


FAQ

How do I specify the article is in English?

English articles do not need to be given a category, as this is the default.

Articles written in any other natural languages should have a language category (e.g. "Lang-Portuguese" for Portuguese. You can create a new language code if necessary using the prefix "Lang-" and an IETF language code. Note that this wiki does not support dialects so please do not create specific variants of language codes if another already exists.

When should I apply a platform category?

Articles should include categories for all relevant associated platforms (e.g. Symbian, Maemo, MeeGo, Series 40). For example, a cross platform code example will run on both MeeGo and Symbian, and should have both categories.

Note that if a platform category is not present this does not necessarily imply that the article won't work with that platform. However the presence of a category means that it will. The absence of any platform category should mean that platform is not relevant to the article - but it may mean that the article simply hasn't been categorised yet.

How do I specify platform versions?

Platform versions should be applied for any version where the code is known to work.

  • Versions: Series 40 2nd Edition, Series 40 3rd Edition, Series 60 3rd Edition, Symbian^3 etc.

How do I find topics related to specific tags

Developers are usually interested in finding the topics at the intersection of the development framework and technology tags - for example "Symbian C++" and "Bluetooth". We have created pages for these intersections, which you can usually locate by navigating from the Development Framework category page. For example, see Category:Symbian C++#All Symbian C++ Articles Organized Based on the Topics

Should I apply more than one development framework tag?

No. If an article applies to most frameworks then apply the "General" tag.

Should I apply Qt category to my Qt Quick topic?

No. If its obvious from a subcategory what the parent category is, you should not apply both categories.

How do I create a new category

You can create new categories by entering their name into the "Add Categories" box. Note that you should first confirm that your new category does not exist under a similar name or with a slightly different spelling.

What are Version Categories and how should I apply them?

As Nokia platforms evolve and grow, new functionality is added and new SDKs are released. Typically a platform will go through a number of major releases and minor "Feature Packs". We highly recommend that you apply the category versions tags for the versions for which you know the article to be true (if a version tag is not present, this does not necessarily mean that the article is not valid for the context.)

The most recent versions for each of the platforms are (at time of writing) :


You can also apply the {{VersionHint}} template to a page - in preview this displays a full list of version categories from which you can selectively copy-paste into your article.