Template:Project infrastructure: Difference between revisions

Revision as of 20:18, 27 February 2016

The following template description is not displayed when the template is inserted in an article.

Goal

To be a universal template for referencing the current open source infrastructure used by the FlightGear project. Should the project ever need to be moved again, this template will help isolate required changes. The creation of this template was motivated by the workload caused by the shutdown of gitorious (to become gitlab) and subsequent migration of all repositories to sourceforge^[1]. The wiki admins back then realized that the workload due to having to update dozens, if not even hundreds, of articles could be greatly reduced if a common set of templates were to be used for "encapsulating" (hiding) such details. In particular, the creation of the repo link (respectively git/svn link) templates (started by Red Leader and Johan G) will greatly help reduce the amount of work needed to maintain our wiki articles up to date.

Usage

{{project infrastucture
| mode
| urn  =
| link =
| text =
}}

mode: The type of infrastructure. This defaults to name, but can be one of:

name: The name of the hosting infrastructure.
abbrev: An abbreviation for the hosting infrastructure, mainly for use in other templates (no link, and current returns sf).
buildserver: The FlightGear build server
forum: The FlightGear forum.
website: The FlightGear website.
wiki: The FlightGear wiki.
mailing lists: The FlightGear mailing lists.

urn: The optional uniform resource name, the part of the URL after the domain name.

link: If set to yes, then a MediaWiki link will be created, when appropriate. The value of no will cause plain text to be returned. This defaults to yes.

text: The optional custom text to use for the link.

Examples

Name

{{project infrastructure|name}}

SourceForge

{{project infrastructure|name|link=no}}

SourceForge

Abbreviation

{{project infrastructure|abbrev}}

sf

Build Server

{{project infrastructure|buildserver}}

Template:Project Infrastructure Option

Forum

{{project infrastructure|forum}}

FlightGear Forum

{{project infrastructure|forum|link=no}}

http://forum.flightgear.org/

Website

{{project infrastructure|website}}

FlightGear website

{{project infrastructure|website|link=no}}

http://flightgear.org/

Wiki

{{project infrastructure|wiki}}

FlightGear wiki

{{project infrastructure|wiki|link=no}}

http://wiki.flightgear.org/

↑ http://wiki.flightgear.org/FlightGear_Newsletter_April_2015#FlightGear_now_lives_at_SourceForge

[1] ttp://wiki.flightgear.org/FlightGear_Newsletter_April_2015#FlightGear_now_lives_at_SourceForge

[1]

@@ Line 37: / Line 37: @@
 ; mode: The type of infrastructure.  This defaults to '''name''', but can be one of:
-::* name: The name of the hosting infrastructure.
+:; name:  The name of the hosting infrastructure.
-::* abbrev:  An abbreviation for the hosting infrastructure, mainly for use in other templates (no link, and current returns '''sf''').
+:; abbrev:  An abbreviation for the hosting infrastructure, mainly for use in other templates (no link, and current returns '''sf''').
-::* buildserver the FlightGear build server
+:; buildserver:  The FlightGear build server
-::* forum: The FlightGear forum.
+:; forum:  The FlightGear forum.
-::* website:  The FlightGear website.
+:; website:  The FlightGear website.
-::* wiki:  The FlightGear wiki.
+:; wiki:  The FlightGear wiki.
-::* mailing lists:  The FlightGear mailing lists.
+:; mailing lists:  The FlightGear mailing lists.
 ; urn: The optional [https://en.wikipedia.org/wiki/Uniform_Resource_Name uniform resource name], the part of the [https://en.wikipedia.org/wiki/Uniform_Resource_Locator URL] after the domain name.
-; link: If set to '''yes''', then a Mediawiki link will be created, when appropriate.  The value of '''no''' will cause plain text to be returned.  This defaults to '''yes'''.
+; link: If set to '''yes''', then a MediaWiki link will be created, when appropriate.  The value of '''no''' will cause plain text to be returned.  This defaults to '''yes'''.
 ; text: The optional custom text to use for the link.