Template:Infobox subsystem: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Doc style; making it possible to use lists in a few of the fields)
mNo edit summary
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<includeonly>{{Infobox
<includeonly>{{Infobox
|title   = {{{name|}}}
|title   = {{{name|}}}
|image   = {{#if:{{{image|}}}|[[Image:{{{image|}}}{{!}}270px{{!}}{{{alt{{!}}}}]]}}
|type = {{{type|tool}}}
|caption = {{{alt|}}}
|image   = {{#if: {{{image|}}} | [[File:{{{image|}}}|270px|{{{alt|}}}]] }}
|label1   = Started in
|caption = {{{alt|}}}
|data1   = {{{started|}}}
|label1 = Started in
|label2   = Description
|data1   = {{{started|}}}
|data2   = {{{description|}}}
|label2 = Description
|label3   = Maintainer(s)
|data2   = {{{description|}}}
|data3   =
|label3 = Maintainer(s)
|data3   =
{{{maintainers|}}}
{{{maintainers|}}}
|label4   = Developer(s)
 
|data4   =
|label4 = Contributor(s)
|data4 =
{{{developers|}}}
{{{developers|}}}
|label5  = Status
|data5    = {{{status|}}}


|label6   = Folders
|label5 = Merge Request(s)
|data6    =
|data5  = {{{merge-requests|}}}
 
|label6 = Status
|data6  = {{{status|}}}
 
|label7 = Folders
|data7  =
{{{folders|}}}
{{{folders|}}}


|= Topic branches:
|label8 = Changelog
|label7  = $SG_SRC
|data8 =  
|data7  = {{{topic-sg|}}}
{{{changelog|}}}
|label8   = $FG_SRC
|data8   = {{{topic-fg|}}}
|label9  = $FG_ROOT


|header9 = {{#if: {{{topic-sg|}}}{{{topic-fg|}}}{{{topic-fgdata|}}} | Topic branches: }}
|label9  = [[$SG_SRC]]
|data9  = {{{topic-sg|}}}
|label10 = [[$FG_SRC]]
|data10  = {{{topic-fg|}}}
|label11 = [[fgdata]]
<!--
<!--
Todo: use git link template here with default params using fgdata
Todo: use git link template
{{Git link|gitorious|fg/galvedros-fgdata|dev-failure-manager|pre=galvedros-fgdata/}}
-->
-->
|data9    = {{{topic-fgdata|}}}
|data11 = {{{topic-fgdata|}}}
 
|label12 = Website
|data12  = {{{website|}}}
|label13 = Subforum
|data13  = {{{subforum|}}}


|label10  = Website
|data10    = {{{website|}}}
|label11  = Subforum
|data11    = {{{subforum|}}}
}}</includeonly><noinclude>
}}</includeonly><noinclude>
{{Informative template|1=
{{Informative template|1=
Line 44: Line 53:


== Usage ==
== Usage ==
Add this to the top of the article describing the subsystem.
Add this to the top of the article describing the tool/subsystem.
  <nowiki>{{</nowiki>'''infobox subsystem'''
  <nowiki>{{</nowiki>'''infobox subsystem'''
  <nowiki>|</nowiki> ''name''         =  
  <nowiki>|</nowiki> ''name''           =
  <nowiki>|</nowiki> ''image''       =  
<nowiki>|</nowiki> ''type''          =  
  <nowiki>|</nowiki> ''alt''         =  
  <nowiki>|</nowiki> ''image''         =  
  <nowiki>|</nowiki> ''started''     =  
  <nowiki>|</nowiki> ''alt''           =  
  <nowiki>|</nowiki> ''description'' =  
  <nowiki>|</nowiki> ''started''       =  
  <nowiki>|</nowiki> ''maintainers''  =  
  <nowiki>|</nowiki> ''description''   =  
  <nowiki>|</nowiki> ''developers''   =  
  <nowiki>|</nowiki> ''maintainers''   =
  <nowiki>|</nowiki> ''status''       =  
  <nowiki>|</nowiki> ''developers''    =  
  <nowiki>|</nowiki> ''folders''      =  
  <nowiki>|</nowiki> ''merge-requests'' =  
  <nowiki>|</nowiki> ''topic-sg''     =  
  <nowiki>|</nowiki> ''status''         =  
  <nowiki>|</nowiki> ''topic-fg''     =  
  <nowiki>|</nowiki> ''folders''        =
  <nowiki>|</nowiki> ''topic-fgdata'' =  
<nowiki>|</nowiki> ''changelog''      =  
  <nowiki>|</nowiki> ''website''     =  
  <nowiki>|</nowiki> ''topic-sg''       =  
  <nowiki>|</nowiki> ''subforum''     =  
  <nowiki>|</nowiki> ''topic-fg''       =  
  <nowiki>|</nowiki> ''topic-fgdata''   =
<nowiki>|</nowiki> ''git-repo''  =  
  <nowiki>|</nowiki> ''website''       =  
  <nowiki>|</nowiki> ''subforum''       =  
  <nowiki>}}</nowiki>
  <nowiki>}}</nowiki>


Line 65: Line 78:


; name:  Name of the subsystem
; name:  Name of the subsystem
; type:  Type of the tool/utility (e.g. addon)


; image:  Image related to the subsystem, for example a screenshot
; image:  Image related to the subsystem, for example a screenshot
Line 77: Line 92:


; developers:  List of developers
; developers:  List of developers
; merge-requests:  List of merge requests


; status:  Current development status
; status:  Current development status
Line 82: Line 99:
; folders:  Pointers for most relevant folders, for example $SG_SRC/canvas or $FG_SRC/Scripting
; folders:  Pointers for most relevant folders, for example $SG_SRC/canvas or $FG_SRC/Scripting


; topic-sg:  Simgear repository and topic branch URL
; changelog:  Can be a link to the changes to a file or files.  Multiple entries can be put in a list.  It is recommended to use {{tl|Git File History}}.
 
; topic-sg:  [[SimGear]] repository and topic branch URL


; topic-fg:  FlightGear repository and topic branch URL
; topic-fg:  FlightGear repository and topic branch URL


; topic-fgdata:  fgdata repository and topic branch URL
; topic-fgdata:  fgdata repository and topic branch URL
; git-repo: repository for standalone tools (e.g. addons)


; website:  Link to project website
; website:  Link to project website


; subforum:  Link to FlightGear subforum
; subforum:  Link to related FlightGear subforum or topic
 
== Related templates ==
* {{tl|merge-request}} — ''For links to merge requests''


[[Category:Infobox templates|Subsystem]]
[[Category:Infobox templates|Subsystem]]
}}
}}
</noinclude>
</noinclude>

Revision as of 10:16, 24 March 2020


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

Goal

This template is intended to be used in the top of pages describing subsystems.

Usage

Add this to the top of the article describing the tool/subsystem. 

{{infobox subsystem
| name           = 
| type           = 
| image          = 
| alt            = 
| started        = 
| description    = 
| maintainers    = 
| developers     = 
| merge-requests = 
| status         = 
| folders        = 
| changelog      = 
| topic-sg       = 
| topic-fg       = 
| topic-fgdata   =
| git-repo   = 
| website        = 
| subforum       = 
}}

All parameters are optional.

name
Name of the subsystem
type
Type of the tool/utility (e.g. addon)
image
Image related to the subsystem, for example a screenshot
alt
Caption for the image
started
Month of development started, for example 04/2024
description
Short description of the subsystem/feature
maintainers
List of current maintainers
developers
List of developers
merge-requests
List of merge requests
status
Current development status
folders
Pointers for most relevant folders, for example $SG_SRC/canvas or $FG_SRC/Scripting
changelog
Can be a link to the changes to a file or files. Multiple entries can be put in a list. It is recommended to use {{Git File History}}.
topic-sg
SimGear repository and topic branch URL
topic-fg
FlightGear repository and topic branch URL
topic-fgdata
fgdata repository and topic branch URL
git-repo
repository for standalone tools (e.g. addons)
website
Link to project website
subforum
Link to related FlightGear subforum or topic

Related templates


Retrieved from "https://wiki.flightgear.org/w/index.php?title=Template:Infobox_subsystem&oldid=122485"