Template:Module: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
 
(Adding fallback peers field for Firefox and Toolkit)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
#REDIRECT [[Template:Code Module]]
<noinclude>
This is a template for displaying the details of a Module. You use it in wiki markup as follows.
 
* Please try and include a mailto link or other contact details for all module owners and peers, but not for emeritus owners and peers to avoid them being bothered.
* You will probably not need all the lines.
 
<nowiki>{{Module</nowiki>
|name=name_of_module
|description=A paragraph of textual description.
|owner=Some Name
|peers=<nowiki>[mailto:markup@isaccepted.com Mark Up]</nowiki>, Other Guy
|ownersemeritus=Ex Owner (1998-2003), Past Person (2003-2012)
|peersemeritus=Eric Meritus, Peter Eer
|design=<nowiki>[mailto:markup@isaccepted.com UX Master]</nowiki>, Design Master
|group=hyphen-separated-standard-discussion-forum-name-without-leading-'mozilla' (e.g "dev-platform")
|forum=<nowiki>[http://example.com/link/to/forum Our Web-based Discussion Forum]</nowiki> (for modules using other discussion systems)
|source_dirs=source/directory/from/top/of/tree, another/directory
|components=BugzillaProduct::Component Name, Another Product::Another Component
|url=<nowiki>http://www.example.com/relevant/url</nowiki>, <nowiki>http://is.gd/second-relevant-url</nowiki>
|notes=Free text content, perhaps clarifying the structured bit
}}
 
E.g.
<nowiki>{{Module</nowiki>
|name=accessibility
|description=Support for platform accessibility APIs.
|owner=Alexander Surkov
|peers=<nowiki>[mailto:marco.zehe@googlemail.com Marco Zehe]</nowiki>, Ginn Chen, David Bolter
|ownersemeritus=Aaron Leventhal (1998-2001)
|group=dev-accessibility
|source_dirs=accessible/
|components=Core::Disability Access APIs
|url=<nowiki>http://www.mozilla.org/access/</nowiki>
|notes=Also covers bugs in other components
}}
 
Which comes out like this:
 
{{Module
|name=accessibility
|description=Support for platform accessibility APIs.
|owner=Alexander Surkov
|peers=[mailto:marco.zehe@googlemail.com Marco Zehe], Ginn Chen, David Bolter
|ownersemeritus=Aaron Leventhal (1998-2001)
|group=dev-accessibility
|source_dirs=accessible/
|components=Core::Disability Access APIs
|url=http://www.mozilla.org/access/
|notes=Also covers bugs in other components
}}
 
Contact Gerv if you have questions. Ignore the below.
 
<hr>
 
</noinclude><table style="width:100%; margin-bottom: 1em" border="1" cellpadding="3" cellspacing="0" id="{{{name}}}">
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Name:</th>
  <th style="text-align:left">{{{name}}} <sup><small>([[#{{{name}}} |#]])</small></sup></th>
</tr>
 
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Description:</th>
  <td>{{{description}}}</td>
</tr>
 
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Owner:</th>
  <td>{{{owner|''none''}}}</td>
</tr>
 
{{#if:{{{peers|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Peer(s):</th>
  <td>{{{peers}}}</td>
</tr>
}}
 
{{#if:{{{fallbackpeers|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Fallback Peer(s):</th>
  <td>{{{fallbackpeers}}}</td>
</tr>
}}
 
{{#if:{{{ownersemeritus|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px"><abbr title="Past owners of this module">Owner(s) Emeritus</abbr>:</th>
  <td><i>{{{ownersemeritus}}}</i></td>
</tr>
}}
 
{{#if:{{{peersemeritus|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px"><abbr title="Past peers of this module">Peer(s) Emeritus</abbr>:</th>
  <td><i>{{{peersemeritus}}}</i></td>
</tr>
}}
 
{{#if:{{{advisors|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Advisor(s):</th>
  <td>{{{advisors}}}</td>
</tr>
}}
 
{{#if:{{{design|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">UX and Design Owner(s):</th>
  <td>{{{design}}}</td>
</tr>
}}
 
{{#if:{{{source_dirs|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Source Dir(s):</th>
  <td>{{{source_dirs|}}}</td>
</tr>
}}
 
{{#if:{{{components|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Bugzilla Component(s):</th>
  <td>{{{components|}}}</td>
</tr>
}}
 
{{#if:{{{url|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">URL(s):</th>
  <td>{{{url|}}}</td>
</tr>
}}
 
{{#if:{{{group|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Discussion&nbsp;Group:</th>
  <td>[http://www.mozilla.org/community/forums/#{{{group}}} {{{group}}}]</td>
</tr>
}}
 
{{#if:{{{forum|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Discussion Forum(s):</th>
  <td>{{{forum|}}}</td>
</tr>
}}
 
{{#if:{{{notes|}}}
|
<tr>
  <th style="text-align: right; vertical-align: top; width: 150px">Notes:</th>
  <td>{{{notes|}}}</td>
</tr>
}}
 
</table>

Latest revision as of 15:14, 28 January 2020

This is a template for displaying the details of a Module. You use it in wiki markup as follows.

  • Please try and include a mailto link or other contact details for all module owners and peers, but not for emeritus owners and peers to avoid them being bothered.
  • You will probably not need all the lines.
{{Module
|name=name_of_module
|description=A paragraph of textual description.
|owner=Some Name
|peers=[mailto:markup@isaccepted.com Mark Up], Other Guy
|ownersemeritus=Ex Owner (1998-2003), Past Person (2003-2012) 
|peersemeritus=Eric Meritus, Peter Eer
|design=[mailto:markup@isaccepted.com UX Master], Design Master
|group=hyphen-separated-standard-discussion-forum-name-without-leading-'mozilla' (e.g "dev-platform")
|forum=[http://example.com/link/to/forum Our Web-based Discussion Forum] (for modules using other discussion systems)
|source_dirs=source/directory/from/top/of/tree, another/directory
|components=BugzillaProduct::Component Name, Another Product::Another Component
|url=http://www.example.com/relevant/url, http://is.gd/second-relevant-url
|notes=Free text content, perhaps clarifying the structured bit
}}

E.g. 

{{Module
|name=accessibility
|description=Support for platform accessibility APIs.
|owner=Alexander Surkov
|peers=[mailto:marco.zehe@googlemail.com Marco Zehe], Ginn Chen, David Bolter
|ownersemeritus=Aaron Leventhal (1998-2001)
|group=dev-accessibility
|source_dirs=accessible/
|components=Core::Disability Access APIs
|url=http://www.mozilla.org/access/
|notes=Also covers bugs in other components
}}

Which comes out like this:

Name: accessibility (#)
Description: Support for platform accessibility APIs.
Owner: Alexander Surkov
Peer(s): Marco Zehe, Ginn Chen, David Bolter
Owner(s) Emeritus: Aaron Leventhal (1998-2001)
Source Dir(s): accessible/
Bugzilla Component(s): Core::Disability Access APIs
URL(s): http://www.mozilla.org/access/
Discussion Group: dev-accessibility
Notes: Also covers bugs in other components

Contact Gerv if you have questions. Ignore the below.

Name: {{{name}}} ([[#{{{name}}} |#]])
Description: {{{description}}}
Owner: none
Retrieved from "https://wiki.allizom.org/index.php?title=Template:Module&oldid=1222945"