Template:Mdnbox/doc: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
(.)
Line 5: Line 5:


==Parameters==
==Parameters==
There are 4 named parameters (see the table below), none of which is required for the template to work, but one of which has to be used together with one or more of the other parameters.
There are 3 named parameters (see the table below), none of which is required for the template to work.


{| class="wikitable"
{| class="wikitable"
|-
|-
! Parameter !! Description
! Parameter !! Description
|-
| <code>lang</code> || Language code
|-
|-
| <code>zone</code> || MDN zone
| <code>zone</code> || MDN zone
Line 21: Line 19:


;<big>Copy-paste template</big>
;<big>Copy-paste template</big>
* <code><nowiki>{{mdnbox|lang= |zone= |wpla= |tool= }}</nowiki></code>
* <code><nowiki>{{mdnbox|zone= |wpla= |tool= }}</nowiki></code>
 
===Language===
''Conditional''
;<big>lang</big>
It is possible to specify a MDN locale code for the link (e.g. <tt>de</tt> for German or <tt>sv-SE</tt> for Swedish). If this parameter is left out, the link will be redirected at MDN to either the locale of the user's Firefox browser, or (if there is no translation of that webpage for the user's locale) to the English default locale (<tt>en-US</tt>). An up-to-date list of Mozilla's web locale codes can be found at the [https://l10n.mozilla-community.org/webdashboard/ Mozilla Web Localization Dashboard].
 
;Limitation
* Cannot be used on its own, it will only have an effect if used together with one or more of the other three parameters.
 
;Usage:
* <code><nowiki>{{mdnbox|</nowiki>lang=''locale code''<nowiki>}}</nowiki></code>


===MDN zone===
===MDN zone===
Line 140: Line 127:
;<big>tool</big>
;<big>tool</big>
<code><nowiki>{{mdnbox|tool=jsdeb}}</nowiki></code> gives
<code><nowiki>{{mdnbox|tool=jsdeb}}</nowiki></code> gives
<br><br><br><br>
{{mdnbox|lang=de}}
;<big>lang</big> (only)
<code><nowiki>{{mdnbox|lang=de}}</nowiki></code> gives
<br><br><br><br>
{{mdnbox|lang=de}}
;<big>lang</big> (with another parameter)
<code><nowiki>{{mdnbox|lang=de|zone=ff}}</nowiki></code> gives
<br><br><br><br>
<br><br><br><br>
{{mdnbox|zone=ff|wpla=html5|tool=jsdeb}}
{{mdnbox|zone=ff|wpla=html5|tool=jsdeb}}

Revision as of 21:36, 27 November 2014

Edit-copy green.svg
This is a documentation subpage for Template:Mdnbox.
It contains usage information, categories and other content that is not part of the original template page.

Usage

{{mdnbox}} produces a right-hand adjusted, floating message box, telling the reader there are documents on a certain subject on Mozilla Developer Network (MDN).

Parameters

There are 3 named parameters (see the table below), none of which is required for the template to work.

Parameter Description
zone MDN zone
wpla MDN web platform
tool MDN developer tool
Copy-paste template
  • {{mdnbox|zone= |wpla= |tool= }}

MDN zone

zone

MDN sort the major Mozilla application projects into "zones". You can choose to link to a certain zone, or to the overview page for Mozilla projects, by entering the parameter zone and set it to one of the values in the table Zone codes below. In addition to the zones specified at MDN, I have added a few common applications.

Usage
  • {{mdnbox|zone=zone code}}

Zone codes

Value MDN zone Comment
add Add-ons
app Apps
cal Calendar/Lightning
ff Firefox
ffa Firefox for Android
fos Firefox OS
fxa Firefox Accounts
mp Marketplace
per Persona
tb Thunderbird
moz Mozilla for all other Mozilla projects

Web Platform

wpla

MDN have documentation for all of the web platform used by Mozilla and Mozilla products. You can choose to link to a certain platform, or to the overview page for the web technologies you may find in the Mozilla projects you work with, by entering the parameter wpla and set it to one of the values in the table Platform codes below.

Usage
  • {{mdnbox|wpla=platform code}}

Platform codes

Value Web platform Comment
api APIs and DOM
css CSS
css3 CSS3
graph Graphics
html HTML
html5 HTML5
js JavaScript
mml MathML
all Web technology for developers for all other web platforms

Developer Tools

tool

In addition to documentation on applications designed to run as stand-alone programs, MDN have documentation for Mozilla's web tools and in-application developer tools. You can choose to link to a certain tool, or to the overview page for the developer tools in Firefox, by entering the parameter tool and set it to one of the values in the table Tool codes below.

Usage
  • {{mdnbox|tool=tool code}}

Tool codes

Value Developer tool Comment
appm App Manager
jsdeb JavaScript Debugger
pagin Page Inspector
wcon Web Console
all Firefox Developer Tools for all other developer tools

Examples

(By parameter)

MDN logotype Find documentation about developing for the web on  MDN text banner
No parameters

{{mdnbox}} gives



MDN logotype Find documentation about Firefox on  MDN text banner
zone

{{mdnbox|zone=ff}} gives



MDN logotype Find documentation about HTML5 on  MDN text banner
wpla

{{mdnbox|wpla=html5}} gives



MDN logotype Find documentation about JavaScript Debugger on  MDN text banner
tool

{{mdnbox|tool=jsdeb}} gives



MDN logotype Find documentation about Firefox and HTML5  and JavaScript Debugger on  MDN text banner
Combo

{{mdnbox|zone=ff|wpla=html5|tool=jsdeb}} gives

See also


Retrieved from "https://wiki.mozilla.org/index.php?title=Template:Mdnbox/doc&oldid=1037553"