Template: Infobox Function

From LibrePlanet
Jump to: navigation, search
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Infobox
 
{{Infobox
 
| title  = {{{websitename|{{{name|<includeonly>{{PAGENAME}}</includeonly> }}} }}}
 
| title  = {{{websitename|{{{name|<includeonly>{{PAGENAME}}</includeonly> }}} }}}
| above  = {{{websitelogo|{{{logo|}}} }}}
 
| image  = {{#if:{{{collapsible|}}}|{{hidden begin|title=Screenshot|titlestyle=text-align:center}}}}{{{screenshot|}}}
 
 
| caption = {{{caption|}}}{{#if:{{{collapsible|}}}|{{hidden end}}}}
 
| caption = {{{caption|}}}{{#if:{{{collapsible|}}}|{{hidden end}}}}
| label1  = [[Note]]
+
| label1  = Header
| data1  = {{{note|}}}
+
| data1  = {{{header|}}}
| label2  = [[Region]]
+
| label2  = Supported Since
| data2  = {{{region|}}}
+
| data2  = {{{since|}}}
| label3  = Area
 
| data3  = {{{area|}}}
 
| label4  = Mailing list
 
| data4  = {{{list|}}}
 
| label5  = Website
 
| data5  = {{{website}}}
 
| label6  = Available [[natural language|language]](s)
 
| data6  = {{{language|}}}
 
| label13 = Contact
 
| data13  = {{{contact}}}
 
| label17  = Members
 
| data17  = {{{members|}}}
 
| label18  = Description
 
| data18  = {{{description|}}}
 
| label19 = Current status
 
| data19  = {{{current_status|{{{current status|}}} }}}
 
 
}}
 
}}
 
[[is entity::group| ]]<noinclude>
 
[[is entity::group| ]]<noinclude>
 +
 
==Documentation==
 
==Documentation==
  
The most reliable way to learn to use this infobox is to follow the example of pages that already use it.  There's a list here:
+
This template exists for the purpose of defining properties of a function, when making a page for the GNU Developer Network, a project that aims to better document development on GNU systems.
 
 
* [[Special:WhatLinksHere/Template:Infobox_Group]]
 
 
 
('''Note:''' The author of the documentation below is not the author of the infobox.  Watch out for errors, and please fix them if you can.  If someone knowledgeable checks this documentation, please remove this note.)
 
  
 
These are the fields of this template:
 
These are the fields of this template:
  
 
* <nowiki>| title  = (automatically filled in from the page name)</nowiki>
 
* <nowiki>| title  = (automatically filled in from the page name)</nowiki>
* <nowiki>| above  = (??? website logo?)</nowiki>
+
* <nowiki>| header  = name of the header file that the function is included in</nowiki>
* <nowiki>| image   = (this doesn't seem to work)</nowiki>
+
* <nowiki>| since   = Specifies what version of the standard the function has been supported since</nowiki>
* <nowiki>| caption = (???)</nowiki>
 
* <nowiki>| note    = information about the page/group</nowiki>
 
* <nowiki>| region  = geographical region or "Worldwide"</nowiki>
 
* <nowiki>| area    = more precise than region (or also "Worldwide")</nowiki>
 
* <nowiki>| list    = link to mailing list</nowiki>
 
* <nowiki>| website = link to home page</nowiki>
 
* <nowiki>| language= language(s) used</nowiki>
 
* <nowiki>| contact = link to page with details on how to contact the organisers</nowiki>
 
* <nowiki>| members = the number of members (can be automated.  Example: {{#ask: [[member of group::Group:FSF]] | format=count}}</nowiki>
 
* <nowiki>| description = a description</nowiki>
 
* <nowiki>| current_status = activity status</nowiki>
 
  
 
</noinclude>
 
</noinclude>

Latest revision as of 14:18, 19 December 2013

Documentation

This template exists for the purpose of defining properties of a function, when making a page for the GNU Developer Network, a project that aims to better document development on GNU systems.

These are the fields of this template:

  • | title = (automatically filled in from the page name)
  • | header = name of the header file that the function is included in
  • | since = Specifies what version of the standard the function has been supported since