Difference between revisions of "Template:Package"
Jump to navigation
Jump to search
(Add source code and in_emacs links) |
|||
| (35 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
| − | < | + | <includeonly><!--Summary Infobox --> |
| − | |||
| − | |||
| − | <!--Summary Infobox --> | ||
{{Infobox | {{Infobox | ||
| − | | | + | | title = {{{name|package name}}} |
| label1 = Description | | label1 = Description | ||
| data1 = {{{description|simple one line description}}} | | data1 = {{{description|simple one line description}}} | ||
| − | | label2 = | + | | label2 = Author |
| − | | data2 = {{{maintainer|name of maintainer}}} | + | | data2 = {{{author|name of author}}} |
| − | | | + | | label3 = Maintainer |
| − | | | + | | data3 = {{{maintainer|name of maintainer}}} |
| − | | {{#if: {{{in_emacs|}}}||NULL}} | + | | label4 = Source |
| − | | {{#if: {{{in_emacs|}}}||NULL}} | + | | data4 = {{{source|'''no link provided'''}}} |
| − | }} | + | | {{#if: {{{in_emacs|}}}||NULL}}label5 = Part of Emacs |
| − | + | | {{#if: {{{in_emacs|}}}||NULL}}data5 = {{#switch: {{{in_emacs}}} | |
| − | + | | 23 = Since Emacs 23 | |
| − | [ | + | | 24 = Since Emacs 24 |
| − | </includeonly> | + | | {{{in_emacs}}} |
| − | <noinclude> | + | }} |
| − | + | |{{#if: {{{el_get}}}||NULL}}label6 = El-Get | |
| + | |{{#if: {{{el_get}}}||NULL}}data6 = {{#ifeq: {{{el_get|}}}|||[https://github.com/dimitri/el-get/blob/master/recipes/{{{el_get}}}.rcp {{{el_get}}}]}} | ||
| + | |{{#if: {{{melpa}}}||NULL}}label7 = MELPA | ||
| + | |{{#if: {{{melpa}}}||NULL}}data7 = {{#ifeq: {{{melpa|}}}|||[https://github.com/melpa/melpa/blob/master/recipes/{{{melpa}}} {{{melpa}}}]}} | ||
| + | }}</includeonly><noinclude> | ||
| + | |||
== Usage == | == Usage == | ||
| Line 27: | Line 29: | ||
* name - Name of package | * name - Name of package | ||
* description - One line description | * description - One line description | ||
| + | * author - Author Name | ||
* maintainer - The maintainer | * maintainer - The maintainer | ||
* source - Where the source code lives | * source - Where the source code lives | ||
* (optional) in_emacs - When the package was included in emacs | * (optional) in_emacs - When the package was included in emacs | ||
| + | * (optional) el_get - El-Get package name. Generates link to recipe. | ||
| + | * (optional) melpa - MELPA package name. Generates link to recipe. | ||
| + | |||
| + | {{Package | ||
| + | |name=edit-server.el | ||
| + | |description=Provide an edit server for Chrom(ium) browser extensions | ||
| + | |author=Alex Bennée | ||
| + | |maintainer=Alex Bennée | ||
| + | |source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el | ||
| + | |in_emacs=No | ||
| + | |category= | ||
| + | }} | ||
| − | + | By using this template to declare a package you automatically include the page in the [[:Category:Emacs Package|Emacs Package category]] | |
| + | The sample box shown here is defined using: | ||
<pre> | <pre> | ||
{{Package | {{Package | ||
|name=edit-server.el | |name=edit-server.el | ||
|description=Provide an edit server for Chrom(ium) browser extensions | |description=Provide an edit server for Chrom(ium) browser extensions | ||
| + | |author=Alex Bennée | ||
|maintainer=Alex Bennée | |maintainer=Alex Bennée | ||
| + | |in_emacs=No | ||
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el | |source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el | ||
}} | }} | ||
</pre> | </pre> | ||
| + | |||
| + | <!-- Note: The sample above sets 'category' to empty just so this Template page doesn't get categorized. --> | ||
| + | <!-- The pre block shows the correct usage, where the 'category' param is unset and so the default gets used. --> | ||
| + | |||
| + | [[Category:Templates]] | ||
| + | [[Category:Package]] | ||
| + | |||
| + | </noinclude> | ||
Latest revision as of 01:04, 25 October 2016
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
- author - Author Name
- maintainer - The maintainer
- source - Where the source code lives
- (optional) in_emacs - When the package was included in emacs
- (optional) el_get - El-Get package name. Generates link to recipe.
- (optional) melpa - MELPA package name. Generates link to recipe.
| Description | Provide an edit server for Chrom(ium) browser extensions |
|---|---|
| Author | Alex Bennée |
| Maintainer | Alex Bennée |
| Source | https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el |
| Part of Emacs | No |
By using this template to declare a package you automatically include the page in the Emacs Package category
The sample box shown here is defined using:
{{Package
|name=edit-server.el
|description=Provide an edit server for Chrom(ium) browser extensions
|author=Alex Bennée
|maintainer=Alex Bennée
|in_emacs=No
|source=https://github.com/stsquad/emacs_chrome/blob/master/servers/edit-server.el
}}