×
Namespaces

Variants
Actions
(Difference between revisions)

Template:ArticleMetaData

From Nokia Developer Wiki
Jump to: navigation, search
hamishwillee (Talk | contribs)
m (Hamishwillee -)
hamishwillee (Talk | contribs)
m (Hamishwillee -)
Line 3: Line 3:
 
== Usage ==
 
== Usage ==
 
The template is automatically included in new articles. To add to an existing article, copy-paste the text below and replace the html comments with your own values. Note that empty values (and HTML comments) are not displayed, so there is no need to delete unused values.
 
The template is automatically included in new articles. To add to an existing article, copy-paste the text below and replace the html comments with your own values. Note that empty values (and HTML comments) are not displayed, so there is no need to delete unused values.
<code text>{{ArticleMetaData
+
<code text>{{ArticleMetaData <!-- v1.2 -->
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
 
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) -->
+
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.wgt]]) -->
|devices= <!-- Devices tested against - e.g. ''devices=Nokia 6131 NFC, Nokia C7-00'') -->
+
|devices= <!-- Devices tested against - e.g. Nokia Lumia 928, Nokia Asha 501) -->
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
+
|sdk= <!-- SDK(s) built and tested against (e.g. Windows Phone 8.0 SDK) -->
|platform= <!-- Compatible platforms - e.g. Symbian^1 and later, Qt 4.6 and later -->
+
|platform= <!-- Compatible platforms - e.g. Nokia Asha Platform 1.0 and later -->
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
 
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->  
 
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->  
|signing=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
+
|signing=<!-- Special Signing requirements -->
|capabilities=<!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
+
|capabilities= <!-- Required capabilities for code (e.g. ID_CAP_LOCATION, ID_CAP_NETWORKING) -->
|keywords= <!-- APIs, classes and methods (e.g. QSystemScreenSaver, QList, CBase -->
+
|keywords= <!-- APIs, classes and methods (e.g. IsolatedStorageSettings, Geoposition, etc -->
|language=<!-- Language category code for non-English topics - e.g. Lang-Chinese -->
+
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
 +
|translated-by= <!-- [[User:XXXX]] -->
 +
|translated-from-title= <!-- Title only - not link -->
 +
|translated-from-id= <!-- Id of translated revision -->
 
|review-by=<!-- After re-review: [[User:username]] -->
 
|review-by=<!-- After re-review: [[User:username]] -->
|review-timestamp=<!-- After re-review: YYYYMMDD -->
+
|review-timestamp= <!-- After re-review: YYYYMMDD -->
|update-by=<!-- After significant update: [[User:username]]-->
+
|update-by= <!-- After significant update: [[User:username]]-->
|update-timestamp=<!-- After significant update: YYYYMMDD -->
+
|update-timestamp= <!-- After significant update: YYYYMMDD -->
 
|creationdate= <!-- Format YYYYMMDD -->
 
|creationdate= <!-- Format YYYYMMDD -->
|author= <!-- Display as link [[User:username]] -->
+
|author= <!-- Enter link [[User:username]] -->
 
}}
 
}}
 
</code>
 
</code>
Line 72: Line 75:
 
These option parameters allow you to specify the device and platform compatibility. This includes the actual devices and platforms you tested against (and know it to work for) and the ones you expect it to work against. To make it easier for users, also provide link to the SDK you used to build this against.
 
These option parameters allow you to specify the device and platform compatibility. This includes the actual devices and platforms you tested against (and know it to work for) and the ones you expect it to work against. To make it easier for users, also provide link to the SDK you used to build this against.
  
* ''devices'': Devices actually tested against. For example Nokia C7-00. We prefer the full name of the device, but shorthand is "better than nothing".
+
* ''devices'': Devices actually tested against. For example Nokia Lumia 920. We prefer the full name of the device, but shorthand is "better than nothing".
* ''sdk'': Actual SDK(s) built and tested against as a URL link
+
* ''sdk'': Actual SDK(s) built and tested against, most recent first
* ''platform'': Compatible platforms - e.g. Symbian^1 and later, Qt 4.6 and later, Flash Lite 1.0
+
* ''platform'': Compatible platforms - e.g. Windows Phone 8 and later, Nokia Asha Plaform 1.0 and later
 
* ''devicecompatability'': Compatible devices e.g.: All* (must have internal GPS).
 
* ''devicecompatability'': Compatible devices e.g.: All* (must have internal GPS).
 
* ''dependencies'': Any other compatibility/dependency information not captured by above. For example dependency on an external API like Google Maps or a particular non-Nokia framework library.
 
* ''dependencies'': Any other compatibility/dependency information not captured by above. For example dependency on an external API like Google Maps or a particular non-Nokia framework library.

Revision as of 03:23, 15 May 2013

This template provides users with information that helps them determine whether an article is likely to still be accurate and relevant. It should be applied to all articles.

Contents

Usage

The template is automatically included in new articles. To add to an existing article, copy-paste the text below and replace the html comments with your own values. Note that empty values (and HTML comments) are not displayed, so there is no need to delete unused values.

{{ArticleMetaData <!-- v1.2 -->
|sourcecode= <!-- Link to example source code e.g. [[Media:The Code Example ZIP.zip]] -->
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.wgt]]) -->
|devices= <!-- Devices tested against - e.g. Nokia Lumia 928, Nokia Asha 501) -->
|sdk= <!-- SDK(s) built and tested against (e.g. Windows Phone 8.0 SDK) -->
|platform= <!-- Compatible platforms - e.g. Nokia Asha Platform 1.0 and later -->
|devicecompatability= <!-- Compatible devices e.g.: All* (must have internal GPS) -->
|dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 -->
|signing=<!-- Special Signing requirements -->
|capabilities= <!-- Required capabilities for code (e.g. ID_CAP_LOCATION, ID_CAP_NETWORKING) -->
|keywords= <!-- APIs, classes and methods (e.g. IsolatedStorageSettings, Geoposition, etc -->
|language= <!-- Language category code for non-English topics - e.g. Lang-Chinese -->
|translated-by= <!-- [[User:XXXX]] -->
|translated-from-title= <!-- Title only - not link -->
|translated-from-id= <!-- Id of translated revision -->
|review-by=<!-- After re-review: [[User:username]] -->
|review-timestamp= <!-- After re-review: YYYYMMDD -->
|update-by= <!-- After significant update: [[User:username]]-->
|update-timestamp= <!-- After significant update: YYYYMMDD -->
|creationdate= <!-- Format YYYYMMDD -->
|author= <!-- Enter link [[User:username]] -->
}}

The parameters are documented in more detail below. Note that only the Creation parameters are mandatory.

Article Information

Creation

These parameters record the original article author. They are intended to give the author credit for their work, and to make it easy for readers to find out more about the author:

  • creationdate=Article creation date, format YYYYMMDD.
  • author=Original article author, format [[User:hamishwillee]].


Review

The (optional) review parameters allow end-users to see the last date that an article was known to be accurate. With this information readers can still "trust" older articles.

The parameters can be updated by any wiki user who is technically competent in the article area.

  • review-by=Reviewer user id, in format [[User:hamishwillee]]
  • review-timestamp=Timestamp of review, in format YYYYMMDD


Update

Articles may periodically receive a significant update. These parameters allow the author of the update to be recognised for their work, and alongside the #Review parameters, help end-users determine how likely it is that the content is still relevant.

  • update-by=Update author in format [[User:hamishwillee]]
  • update-timestamp=Update timestamp, format YYYYMMDD


Translation

Translated articles should use the following additional parameters to record the translator and translation version information. Note that these create links to the actual translated version of the topic:

  • translated-by= Link to the translator user id - e.g. [[User:hamishwillee|hamishwillee]]
  • translated-from-title= Name of original article: "Article Title"
  • translated-from-id= Id of translated page. If the URL of the revision in History tab ends in &oldid=111747, the id is 111747

If (and ONLY if) article an article is translated from an off-wiki topic fill in:

  • translated-from-title= Name of original article: "Article Title"
  • translated-from-url= Url of translated article


Miscellaneous

  • language: Category code for the natural language (e.g. Lang-Portuguese, Lang-Chinese) to display the template in that language. Default is English.
  • keywords: APIs, classes and methods of related articles

Compatibility

These option parameters allow you to specify the device and platform compatibility. This includes the actual devices and platforms you tested against (and know it to work for) and the ones you expect it to work against. To make it easier for users, also provide link to the SDK you used to build this against.

  • devices: Devices actually tested against. For example Nokia Lumia 920. We prefer the full name of the device, but shorthand is "better than nothing".
  • sdk: Actual SDK(s) built and tested against, most recent first
  • platform: Compatible platforms - e.g. Windows Phone 8 and later, Nokia Asha Plaform 1.0 and later
  • devicecompatability: Compatible devices e.g.: All* (must have internal GPS).
  • dependencies: Any other compatibility/dependency information not captured by above. For example dependency on an external API like Google Maps or a particular non-Nokia framework library.

Platform Security

Applies to secure platforms only (e.g. Symbian)

  • signing: What level of signing is required. Empty means "Any". Otherwise use one of: Self-Signed, DevCert, Manufacturer.
  • capabilities: Platform security "Capabilities" required by the article/code example (e.g. Location, NetworkServices).

Downloads

These parameters provide direct links to downloads (source or installation files) associated with the article.

Deprecated

These parameters are deprecated, and will not be displayed even if declared

  • category
  • subcategory
  • id: Knowledge-base identifier. No longer used

Articles which use this template

[show details]


Translations

This template passes all the template parameters to an underlying "template". If a particular translation exists then it will be selected. Otherwise the /default page is used. Below are the current translation pages.

To translate this template:

  1. add a sub page to this template (by convention (only) the sub page should be named with the language code (ie de for German).
  2. Copy the content of the /default page into your new page and translate the visible strings.
  3. Open this page and add a new value to the switch indicating the mapping between the language category and your sub page name

Warning.pngWarning: If you modify this page, consider copying the modifications to the translated pages.

Template appearance

When added to an article, the header is displayed on the top right of the article, along with any information entered when the template was created. Note that parameters with no content are not displayed.

Article Metadata
Article
Created: ()
Last edited: hamishwillee (15 May 2013)
1089 page views in the last 30 days.
×