Namespaces

Variants
Actions

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 over the next few weeks. Thanks for all your past and future contributions.

(Difference between revisions)

Template:Sandbox3

From Wiki
Jump to: navigation, search
hamishwillee (Talk | contribs)
m (Hamishwillee -)
hamishwillee (Talk | contribs)
m (Hamishwillee - Testing)
Line 1: Line 1:
<noinclude>{{Abstract|This template is used by [[Template:ArticleMetaData]] to provide a default (English) translation.}} It can be copied to create translations in new languages.
+
<noinclude>{{Abstract|Base template for right aligned fix-sized information boxes}}.  
  
 
{{InternalUse|visible=true}}
 
{{InternalUse|visible=true}}
 +
[[Category:FNWiki]]
  
== Usage ==
+
== Usage ==
 +
<!-- Describe how to use here -->
 +
Use '''<nowiki>{{InfoBoxRightHandSide|title=</nowiki>''your title''<nowiki>|image=</nowiki>''image file name''<nowiki>|text="text content"}}</nowiki>''' to display titled information text inside a box.
 +
* ''title'': Title of box
 +
* ''text'': Box text
 +
* ''image'': Filename of image to be displayed on left hand side (optional)
 +
* ''link'': Link url from image
  
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.
+
'''Note''': using the equals (=) and pipe (|) characters inside the template parameters prevents them working properly. These characters should be replaced with the '''&amp;#61;''' and '''&amp;#124;''' codes respectively.
<code text>{{ArticleMetaData
+
|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]]) -->
+
|devices= <!-- Devices tested against - e.g. ''devices=Nokia 6131 NFC, Nokia C7-00'') -->
+
|sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) -->
+
|platform= <!-- Compatible platforms - e.g. Symbian^1 and later, Qt 4.6 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=<!-- Signing requirements - empty or one of: Self-Signed, DevCert, Manufacturer -->
+
|capabilities=<!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. -->
+
|keywords= <!-- APIs, classes and methods (e.g. QSystemScreenSaver, QList, CBase -->
+
|id= <!-- Article Id (Knowledge base articles only) -->
+
|language=<!-- Language category code for non-English topics - e.g. Lang-Chinese -->
+
|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= <!-- Display as link [[User:username]] -->
+
}}
+
</code>
+
  
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 <nowiki>[[User:hamishwillee]]</nowiki>.
 
 
 
==== 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 <nowiki>[[User:hamishwillee]]</nowiki>
 
* ''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 <nowiki>[[User:hamishwillee]]</nowiki>
 
* ''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.  <nowiki>[[User:hamishwillee|hamishwillee]]</nowiki>
 
* ''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
 
 
<!--
 
<!--
|translated-by= [[User: XXXXX|XXXXX]]</nowiki>
+
<div class="infoboxrhstext" align="left" style="border-color: #EDEDED; border-bottom-style:solid; border-bottom-width: 1px; padding-top:10px; padding-bottom:10px;">
|translated-from-title=
+
{{{text}}}</div>
|translated-from-id=
+
{{#if: {{{title|}}}|<div class="infoboxrhstitle" style="font-size:20px; font-style:normal; font-family:'Nokia Pure Text'; border-bottom-color: #EDEDED;border-bottom-style:solid; border-bottom-width: 1px; padding-bottom:15px;padding-top:15px;">{{{title}}}</div>|}}
 
-->
 
-->
  
==== Miscellaneous ====
+
== Appearance ==  
* ''language'': Category code for the natural language (e.g. Lang-Portuguese, Lang-Chinese) to display the template in that language. Default is English.
+
<!-- The template itself is written after the noinclude end tag. -->
 
+
</noinclude><div class="rightColumn" style="background-attachment: scroll;background-clip: border-box;background-color: white;background-image: none;background-origin: padding-box;border-bottom-width: 0px;border-left-width: 0px;border-right-width: 0px;border-top-width: 0px;color: #333;display: block;font-family: Tahoma, Geneva, sans-serif;font-size: 12px;font-style: normal;font-variant: normal;font-weight: normal;line-height: 10px;width: 220px;z-index: 1;">
* ''keywords'': APIs, classes and methods of related articles
+
<div style="padding-top:2px; padding-bottom:2px;margin-bottom:5px border-top-color: #333;border-top-style: solid;border-top-width: 2px; position: static; background: #FFFFFF;z-index:1; width:215px">
* ''id'': Knowledge-base identifier. Should be applied only by Nokia knowledgebase team.
+
<div class="infoboxrhstitle toccolours mw-collapsible {{#ifeq: {{{closed|}}}|true|mw-collapsed|}}">
 
+
{{{title}}}
=== Compatibility ===
+
<div class="mw-collapsible-content infoboxrhstext">{{{text}}}</div></div>
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.
+
</div></div>
 
+
* ''devices'': Devices actually tested against. For example Nokia C7-00. 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
+
* ''platform'': Compatible platforms - e.g. Symbian^1 and later, Qt 4.6 and later, Flash Lite 1.0
+
* ''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.
+
 
+
* ''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]])
+
 
+
=== Deprecated ===
+
These parameters are deprecated, and will not be displayed even if declared
+
* ''category''
+
* ''subcategory''
+
 
+
== 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.
+
 
+
</noinclude><div class="toccolours mw-collapsible rightColumn">
+
== Article Metadata ==
+
<div class="mw-collapsible-content">
+
<!-- Code Example -->{{#if:{{{sourcecode|}}}{{{installfile|}}}|<hr />Code Example|}}<!--
+
-->{{#if: {{{sourcecode|}}}|<div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Source file: {{{sourcecode}}}</div>|}}<!--
+
-->{{#if: {{{installfile|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Installation file: {{{installfile}}}</div>|}}<!--
+
--><!-- Testing-->{{#if: {{{sdk|}}}{{{devices|}}}|<hr />Tested with|}}<!--
+
-->{{#if: {{{sdk|}}}|<div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">SDK: {{{sdk}}}</div>|}}<!--
+
-->{{#if: {{{devices|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Devices(s): {{{devices}}}</div>|}}<!--
+
--><!-- Compatability -->{{#if: {{{platform|}}}{{{devicecompatability|}}}|<hr />Compatibility|}}<!--
+
-->{{#if: {{{platform|}}}|<div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Platform(s): {{{platform}}}</div>|}}<!--
+
-->{{#if: {{{devicecompatability|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Device(s): {{{devicecompatability}}}</div>|}}<!--
+
-->{{#if: {{{dependencies|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Dependencies: {{{dependencies}}}</div>|}}<!--
+
--><!-- PlatSec-->{{#if: {{{signing|}}}{{{capabilities|}}}|<hr />Platform Security|}}<!--
+
-->{{#if: {{{signing|}}}|<div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Signing Required: {{{signing}}}</div>|}}<!--
+
-->{{#if: {{{capabilities|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Capabilities: {{{capabilities}}}</div>|}}<!--
+
--><!-- Article Metadata --><hr />Article<!--
+
-->{{#if: {{{id|}}}|<div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Article ID: {{{id}}}</div>|}}<!--
+
-->{{#if: {{{keywords|}}}|<div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Keywords: {{{keywords}}}</div>|}}<!--
+
-->{{#if: {{{translated-by|}}}{{{translated-from-id|}}}{{{translated-from-title|}}}{{{translated-from-url|}}}|<!--
+
--><div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Translated:</div>
+
<div style="font-size:10px; padding-left:15px; padding-top:10px; padding-right:10px;">From {{#if:{{{translated-from-url|}}}|<!-- is url -->{{#if:{{{translated-from-title|}}}|[{{{translated-from-url|}}} {{{translated-from-title|}}}]|{{{translated-from-url|}}} }}<!-- /is url -->|<!--NOT url -->{{#if:{{{translated-from-id|}}}|[{{fullurl:{{{translated-from-title}}}|oldid={{{translated-from-id}}} }} {{{translated-from-title}}}]|[[{{{translated-from-title}}}]] }}<!--/NOT url -->}}</div>
+
{{#if:{{{translated-by|}}}|<div style="font-size:10px; padding-left:15px; padding-top:10px; padding-right:10px;">By {{{translated-by}}}</div>|}}|<!--
+
Not translated
+
--><div style="font-size:11px; padding-left:10px; padding-top:10px; padding-right:10px;">Created: {{#if: {{{author|}}}|{{{author}}}| {{#dpl:titlematch={{FULLPAGENAME}}%|namespace={{NAMESPACE}}|skipthispage=no|addauthor=true|format=,[[User:%USER%|%USER%]],,}}  }} ({{#if: {{{creationdate|}}}|<!-- Format date to standard -->{{#iferror:{{#time: d M Y|{{{creationdate}}} }}|{{{creationdate}}}|{{#time: d M Y|{{{creationdate}}} }} }}<!-- End Format date to standard -->|{{#dpl:titlematch={{FULLPAGENAME}}%|skipthispage=no|ordermethod=firstedit|addeditdate=true|userdateformat=d M Y|format=,%DATE%,,}} }})</div><!--
+
 
+
-->}}<!--
+
 
+
-->{{#if: {{{update-by|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Updated: {{{update-by}}} {{#if: {{{update-timestamp|}}}| ({{#time: d M Y|{{{update-timestamp}}} }})</div>|}}|}}<!--
+
 
+
-->{{#if: {{{review-by|}}}|<div style="font-size:11px; padding:10px 10px 5px 10px;">Reviewed: {{{review-by}}} {{#if: {{{review-timestamp|}}}| ({{#time: d M Y|{{{review-timestamp}}} }})</div>|}}|}}<!--
+
 
+
--><div style="font-size:11px; padding:10px 10px 5px 10px;">Last edited: [[User:{{REVISIONUSER}}]] ({{#time: d M Y | {{REVISIONTIMESTAMP}} }})</div><!--
+
 
+
--> </div></div>
+

Revision as of 01:26, 15 August 2013

Base template for right aligned fix-sized information boxes.

Internal use only.

Usage

Use {{InfoBoxRightHandSide|title=your title|image=image file name|text="text content"}} to display titled information text inside a box.

  • title: Title of box
  • text: Box text
  • image: Filename of image to be displayed on left hand side (optional)
  • link: Link url from image

Note: using the equals (=) and pipe (|) characters inside the template parameters prevents them working properly. These characters should be replaced with the &#61; and &#124; codes respectively.


Appearance

{{{title}}}

{{{text}}}
 

Was this page helpful?

Your feedback about this content is important. Let us know what you think.

 

Thank you!

We appreciate your feedback.

×