Template:Module: Difference between revisions

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

@@ Line 1: / Line 1: @@
 <noinclude>
-This is a template for displaying the details of a Module. Use it as follows:
+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>
@@ Line 6: / Line 9: @@
   |description=A paragraph of textual description.
   |owner=Some Name
- |contentowner=Some Other Name (used for some websites where content owner is different from technical owner)
   |peers=<nowiki>[mailto:markup@isaccepted.com Mark Up]</nowiki>, Other Guy
-  |advisors=<nowiki>[mailto:markup@isaccepted.com Smart Girl]</nowiki>, Smart Guy
+  |ownersemeritus=Ex Owner (1998-2003), Past Person (2003-2012)
-  |content=<nowiki>[mailto:markup@isaccepted.com Other Smart Girl]</nowiki>, Other Smart Guy
+ |peersemeritus=Eric Meritus, Peter Eer
-  |group=discussion-group-name-without-leading-'mozilla.'
+  |design=<nowiki>[mailto:markup@isaccepted.com UX Master]</nowiki>, Design Master
-  |forum=<nowiki>[http://example.com/link/to/forum Our Discussion Forum]</nowiki> (for modules without a newsgroup)
+  |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>
+  |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
   }}
@@ Line 23: / Line 27: @@
   |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
   }}
@@ Line 36: / Line 42: @@
   |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
   }}
@@ Line 58: / Line 66: @@
 <tr>
-   <th style="text-align: right; vertical-align: top; width: 150px">{{#if:{{{contentowner|}}}|Technical }}Owner:</th>
+   <th style="text-align: right; vertical-align: top; width: 150px">Owner:</th>
    <td>{{{owner|''none''}}}</td>
 </tr>
-{{#if:{{{contentowner|}}}
+{{#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">Content Owner:</th>
+   <th style="text-align: right; vertical-align: top; width: 150px"><abbr title="Past owners of this module">Owner(s) Emeritus</abbr>:</th>
-   <td>{{{contentowner}}}</td>
+   <td><i>{{{ownersemeritus}}}</i></td>
 </tr>
 }}
-{{#if:{{{peers|}}}
+{{#if:{{{peersemeritus|}}}
 |
 <tr>
-   <th style="text-align: right; vertical-align: top; width: 150px">Peer(s):</th>
+   <th style="text-align: right; vertical-align: top; width: 150px"><abbr title="Past peers of this module">Peer(s) Emeritus</abbr>:</th>
-   <td>{{{peers}}}</td>
+   <td><i>{{{peersemeritus}}}</i></td>
 </tr>
 }}
@@ Line 86: / Line 110: @@
 }}
-{{#if:{{{content|}}}
+{{#if:{{{design|}}}
 |
 <tr>
-   <th style="text-align: right; vertical-align: top; width: 150px">Content Owner(s):</th>
+   <th style="text-align: right; vertical-align: top; width: 150px">UX and Design Owner(s):</th>
-   <td>{{{content}}}</td>
+   <td>{{{design}}}</td>
 </tr>
 }}
@@ Line 113: / Line 137: @@
 |
 <tr>
-   <th style="text-align: right; vertical-align: top; width: 150px">URL:</th>
+   <th style="text-align: right; vertical-align: top; width: 150px">URL(s):</th>
    <td>{{{url|}}}</td>
 </tr>
@@ Line 131: / Line 155: @@
    <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>

Template:Module: Difference between revisions

Latest revision as of 15:14, 28 January 2020

Navigation menu

Search