Difference between revisions of "Template:Package"

From WikEmacs
Jump to: navigation, search
(What the template looks like)
(Add source code and in_emacs links)
Line 9: Line 9:
 
| label2  = Maintainer
 
| label2  = Maintainer
 
| data2  = {{{maintainer|name of maintainer}}}
 
| data2  = {{{maintainer|name of maintainer}}}
 +
| label3  = Source Code
 +
| data3  = {{{source|'''no link provided'''}}}
 +
| {{#if: {{{in_emacs|}}}||NULL}}label4  = Part of Emacs since
 +
| {{#if: {{{in_emacs|}}}||NULL}}data4  = {{#if: {{{in_emacs|}}}|{{in_emacs}}}}}
 
}}
 
}}
 
<!-- Add to a set of categories, only if included in a page -->
 
<!-- Add to a set of categories, only if included in a page -->
Line 24: Line 28:
 
* description - One line description
 
* description - One line description
 
* maintainer - The maintainer
 
* maintainer - The maintainer
* (optional) in_emacs - When the package was included in emacs
 
 
* source - Where the source code lives
 
* source - Where the source code lives
 +
* (optional) in_emacs - When the package was included in emacs
  
For example: ! Not an Emacs extension, a browser extension !
+
For example:
  
 
<pre>
 
<pre>
 
{{Package
 
{{Package
|name=Edit with Emacs
+
|name=edit-server.el
|description=Edit text areas via Chrom(ium) browsers
+
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée  
+
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome
+
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
 
}}
 
}}
 
</pre>
 
</pre>

Revision as of 04:01, 29 March 2012

What the template looks like

Description simple one line description
Maintainer name of maintainer
Source Code no link provided


Usage

This template is used for adding a Emacs Packages to the wiki and formating a nice bit of boiler plate and auto-categorisation. Parameters include:

  • name - Name of package
  • description - One line description
  • maintainer - The maintainer
  • source - Where the source code lives
  • (optional) in_emacs - When the package was included in emacs

For example:

{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|maintainer=Alex Bennée
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}