Template:Sandbox: Difference between revisions

From OLPC
Jump to navigation Jump to search
m (tweaking)
m (tweaking)
Line 20: Line 20:
|-
|-
| style="text-align:right;" | '''Status:'''
| style="text-align:right;" | '''Status:'''
| style="text-align:left;" | {{{status}}}
| style="text-align:left;" | {{{status}}} <!--
IF source --> {{ #if: {{{source|}}} | <!--

IF build --> {{ #if: {{{build|}}} |
|-
{{!}}-
| style="text-align:right;" | '''Version:'''
| style="text-align:left;" | {{{version}}}
{{!}} style="text-align:right;" {{!}} '''Build:'''
{{!}} style="text-align:left;" {{!}} {{{build}}} | <!--

ELSE build --> }} <!-- ENDIF build -->
|-
| style="text-align:right;" | '''Base:'''
| style="text-align:left;" | {{{base}}}

|-
| style="text-align:right;" | '''X-Source:'''
| style="text-align:left;" | {{{source}}}

{{ #if: {{{source|}}} | <!-- IF source -->
{{!}}-
{{!}}-
{{!}} style="text-align:right;" {{!}} '''Source:'''
{{!}} style="text-align:right;" {{!}} '''Source:'''
{{!}} style="text-align:left;" {{!}} {{{source}}}
{{!}} style="text-align:left;" {{!}} {{{source}}} <!--
{{ #if: {{{language|}}} | <!-- IF language -->
IF language --> {{ #if: {{{language|}}} |
{{!}}-
{{!}}-
{{!}} style="text-align:right;" {{!}} '''Language:'''
{{!}} style="text-align:right;" {{!}} '''Language:'''
{{!}} style="text-align:left;" {{!}} {{{language}}}
{{!}} style="text-align:left;" {{!}} {{{language}}} | <!--
| <!-- IF NO language --> }}
ELSE language --> }} <!-- ENDIF language --> <!--
{{ #if: {{{l10n|}}} | <!-- IF l10n -->
IF l10n --> {{ #if: {{{l10n|}}} |
{{!}}-
{{!}}-
{{!}} style="text-align:right;" {{!}} '''[[Localization|l10n]]:'''
{{!}} style="text-align:right;" {{!}} '''[[Localization|l10n]]:'''
{{!}} style="text-align:left;" {{!}} {{ #ifexist: {{PAGENAME}}/Localization|[[{{PAGENAME}}/Localization]]|{{{l10n|''<span class="plainlinks">[{{fullurl:{{PAGENAME}}}}/Localization add it here]</span>''}}} }}
{{!}} style="text-align:left;" {{!}} {{ #ifexist: {{PAGENAME}}/Localization|[[{{PAGENAME}}/Localization]]|{{{l10n|''<span class="plainlinks">[{{fullurl:{{PAGENAME}}}}/Localization add it here]</span>''}}} }} | <!--
| <!-- IF NO l10n --> }}
ELSE l10n --> }} <!-- ENDIF l10n --> | <!--
| <!-- IF NO source --> }}
ELSE source --> }} <!-- ENDIF source --> <!--
IF testplan --> {{ #if: {{{testplan|{{#ifexist:{{PAGENAME}}/Test plan|gotpage}}|}}} |
|-
{{!}}-
| style="text-align:right;" | '''X-[[Localization|l10n]]:'''
| style="text-align:left;" | {{ #ifexist: {{PAGENAME}}/Localization|[[{{PAGENAME}}/Localization]]|{{{l10n|''<span class="plainlinks">[{{fullurl:{{PAGENAME}}}}/Localization add it here]</span>''}}} }}
{{ #if: {{{testplan|{{#ifexist:{{PAGENAME}}/Test plan|gotpage}}}}} | {{!}}-
{{!}} style="text-align:right;" {{!}} '''[[:Category:Test Plans|Test plans]]:'''
{{!}} style="text-align:right;" {{!}} '''[[:Category:Test Plans|Test plans]]:'''
{{!}} style="text-align:left;" {{!}} {{#ifexist:{{PAGENAME}}/Test plan|[[{{PAGENAME}}/Test plan]]|{{{testplan}}}}}
{{!}} style="text-align:left;" {{!}} {{#ifexist:{{PAGENAME}}/Test plan|[[{{PAGENAME}}/Test plan]]|{{{testplan}}}}} | <!--
ELSE testplan --> }} <!-- ENDIF testplan -->
|}}
|-
|-
| colspan="2" style="text-align:center;" | '''Contributors'''
| colspan="2" style="text-align:center;" | '''Contributors'''
Line 80: Line 70:
<includeonly>[[Category:Activity]]</includeonly><noinclude>
<includeonly>[[Category:Activity]]</includeonly><noinclude>
This template automatically includes the page in the <nowiki>[[:Category:</nowiki>{{{type}}}]].
This template automatically includes the page in the <nowiki>[[:Category:</nowiki>{{{type}}}]].

Many of the 'parameters' only make sense under certain circumstances (ie: no point in mentioning l10n if there's no source code).


== Usage ==
== Usage ==


<nowiki>{{</nowiki>Status box
<nowiki>{{</nowiki>Status box
| component = &lt;!-- Name of the component --&gt;
| ''component'' = &lt;!-- OPTIONAL -- Name of the component (defaults to page title) --&gt;
| type = &lt;!-- Type of the component {activity, core, support} --&gt;
| type = &lt;!-- Type of the component {activity, core, support} --&gt;
| icon = &lt;!-- ''file name.ext'' (sans <tt><nowiki>[[Image:</nowiki>''file name.ext''<nowiki>]]</nowiki></tt> --&gt;
| ''icon'' = &lt;!-- OPTIONAL -- ''file name.ext'' (sans <tt><nowiki>[[Image:</nowiki>''file name.ext''<nowiki>]]</nowiki></tt> --&gt;
| status = &lt;!-- Status of the activity --&gt;
| status = &lt;!-- Status of the activity --&gt;
| version = &lt;!-- Current/latest version available --&gt;
| ''build'' = &lt;!-- OPTIONAL -- Build # where it first appeared --&gt;
| base = &lt;!-- Yes/No if it's included in the [[OS images]]
| ''source'' = &lt;!-- OPTIONAL -- Repository / location of the source --&gt;
/ Could be the first ''build'' number --&gt;
| source = &lt;!-- Repository / location of the source --&gt;
| ''language'' = &lt;!-- OPTIONAL -- Computer language of the ''source'' --&gt;
| ''language'' = &lt;!-- OPTIONAL -- Computer language of the ''source'' --&gt;
| l10n = &lt;!-- Repository / location of the l10n resources --&gt;
| ''l10n'' = &lt;!-- OPTIONAL -- Repository / location of the l10n resources --&gt;
| [[:Category:Test Plans|''testplan'']] = &lt;!-- OPTIONAL -- link to the [[:Category:Test Plans|test plan page]] --&gt;
| [[:Category:Test Plans|''testplan'']] = &lt;!-- OPTIONAL -- link to the [[:Category:Test Plans|test plan page]] --&gt;
| contributors = &lt;!-- People contributing to the activity --&gt;
| contributors = &lt;!-- People contributing to the activity --&gt;
| <s>version = &lt;!-- Current/latest version available --&gt;</s>''dropping it''
| <s>base = &lt;!-- Yes/No if it's included in the [[OS images]]
/ Could be the first ''build'' number --&gt;</s>''dropping it''
<nowiki>}}</nowiki>
<nowiki>}}</nowiki>

== Sample ==

=== Empty ===
Raw invocation.

<br clear="all">
{{ Sandbox }}
<nowiki>{{</nowiki> Sandbox <nowiki>}}</nowiki>
; Notes : Nothing else should show.

=== Simplest ===
Basically an idea; using the page name; and misclassified by type.

<br clear="all">
{{ Sandbox | type = Bar }}
<nowiki>{{</nowiki> Sandbox
| type = Bar
<nowiki>}}</nowiki>
; Notes : the ''type'' is not recognized, so defaults to a ''<tt>Unknown Component</tt>''. Nothing else should show.

=== Simple 1 ===
Basically an idea; using the page name; and misclassified by type.

<br clear="all">
{{ Sandbox | type = activity }}
<nowiki>{{</nowiki> Sandbox
| type = activity
<nowiki>}}</nowiki>
; Notes : the ''type'' is recognized. Nothing else should show.

=== Simple 2 ===
Basically an idea; not using the page name; and classified by type.

<br clear="all">
{{ Sandbox | component = Foo | type = activity | icon = Xo s.png }}
<nowiki>{{</nowiki> Sandbox
| component = Foo
| type = activity
| icon = Xo s.png
<nowiki>}}</nowiki>
; Notes : specifying a name for the component, the ''type'' is recognized. Apart from the icon, nothing else should show.

=== Simple 3 ===
An idea that has some code; not using the page name; and classified by type.

<br clear="all">
{{ Sandbox | component = Foo | type = activity | icon = Xo s.png | source = [[foo]] }}
<nowiki>{{</nowiki> Sandbox
| component = Foo
| type = activity
| icon = Xo s.png
| source = [[foo]]
<nowiki>}}</nowiki>
; Notes : specifying a name for the component, the ''type'' is recognized. Apart from the icon, nothing else should show.


== Sample ==
== Sample ==

Revision as of 20:21, 30 June 2007

Many times you may want to just 'test' an idea for a template, I haven't found a sensible way of fully testing templates by themselves (as they will not get included in the edited version, but rather the saved version).

The idea of this Template:Sandbox is to have that, a simple testing zone that will not interfere with others and avoid leaving a trail of botched attempts.

Please leave this comment/text for others to read.
See Also http://meta.wikimedia.org/wiki/Help:Template
Testing: Status box


Sandbox
(activity)
Status: {{{status}}}
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Unknown Component]]
    type => {{{type}}} | {{{type}}}
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => {{{type}}} | {{{type}}}
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}


This template automatically includes the page in the [[:Category:{{{type}}}]].

Many of the 'parameters' only make sense under certain circumstances (ie: no point in mentioning l10n if there's no source code).

Usage

{{Status box
 | component    = <!-- OPTIONAL -- Name of the component (defaults to page title) -->
 | type         = <!-- Type of the component {activity, core, support} -->
 | icon         = <!-- OPTIONAL -- file name.ext (sans [[Image:file name.ext]] -->
 | status       = <!-- Status of the activity -->
 | build        = <!-- OPTIONAL -- Build # where it first appeared -->
 | source       = <!-- OPTIONAL -- Repository / location of the source -->
 | language     = <!-- OPTIONAL -- Computer language of the source -->
 | l10n         = <!-- OPTIONAL -- Repository / location of the l10n resources -->
 | testplan     = <!-- OPTIONAL -- link to the test plan page -->
 | contributors = <!-- People contributing to the activity -->
 | version      = <!-- Current/latest version available -->dropping it
 | base         = <!-- Yes/No if it's included in the OS images
                       / Could be the first build number -->dropping it
 }}

Sample

Empty

Raw invocation.



Sandbox
(activity)
Status: {{{status}}}
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Unknown Component]]
    type => {{{type}}} | {{{type}}}
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => {{{type}}} | {{{type}}}
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}

{{ Sandbox }}
Notes
Nothing else should show.

Simplest

Basically an idea; using the page name; and misclassified by type.



Sandbox
(Bar)
Status: {{{status}}}
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Unknown Component]]
    type => Bar | bar
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => Bar | bar
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}

{{ Sandbox
| type = Bar
}}
Notes
the type is not recognized, so defaults to a Unknown Component. Nothing else should show.

Simple 1

Basically an idea; using the page name; and misclassified by type.



Sandbox
(activity)
Status: {{{status}}}
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Activity]]
    type => activity | activity
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => activity | activity
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}

{{ Sandbox
| type = activity
}}
Notes
the type is recognized. Nothing else should show.

Simple 2

Basically an idea; not using the page name; and classified by type.



Foo
(activity)
Xo s.png
Status: {{{status}}}
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Activity]]
    type => activity | activity
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => activity | activity
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}

{{ Sandbox
| component = Foo
| type = activity
| icon = Xo s.png
}}
Notes
specifying a name for the component, the type is recognized. Apart from the icon, nothing else should show.

Simple 3

An idea that has some code; not using the page name; and classified by type.



Foo
(activity)
Xo s.png
Status: {{{status}}} |- Source: foo
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Activity]]
    type => activity | activity
[[Category:Activity {{{status}}}]]
    source => foo | has source
    type => activity | activity
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}

{{ Sandbox
| component = Foo
| type = activity
| icon = Xo s.png
| source = foo
}}
Notes
specifying a name for the component, the type is recognized. Apart from the icon, nothing else should show.

Sample



Foo
(Bar)
Xo s.png
Status: {{{status}}} |- Test plans: some page
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Unknown Component]]
    type => Bar | bar
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => Bar | bar
    status => {{{status}}} | {{{status}}}
[[Category:Pending i18n]]
    l10n => {{{l10n}}}

{{ Sandbox
| component = Foo
| type = Bar
| icon = Xo s.png
| testplan = [[some page]]
}}
Notes
the type is not recognized, so defaults to a general one, testplan shows because it has one specified, icon shows, goes into pending 18n as no l10n resource is given.



Sandbox
(Activity)
Status: beta
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Activity]]
    type => Activity | activity
[[Category:Software idea]]
    source => {{{source}}} | no source
    type => Activity | activity
    status => beta | beta
[[Category:l10n]]
    l10n => Localization

{{ Sandbox
| type = activity
| status = beta
| l10n = [[Localization]]
}}
Notes
Taking the component name from the {{PAGENAME}}, icon is undefined. Goes into the l10n category, as it can be l10n'ed.



Sandbox
(Activity)
Status: beta |- Source: foo |- l10n: Localization
Contributors
{{{contributors}}}
Testing parameterized categorizations:

[[Category:Activity]]
    type => Activity | activity
[[Category:Activity beta]]
    source => foo | has source
    type => Activity | activity
    status => beta | beta
[[Category:l10n]]
    l10n => Localization

{{ Sandbox
| type = activity
| status = beta
| source = foo
| l10n = [[Localization]]
}}
Notes
Taking the component name from the {{PAGENAME}}, icon is undefined. Goes into the l10n category, as it can be l10n'ed.