Template:Infobox subsystem: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
m (I think I don't understand how {{tickets}} is supposed to work ??)
(fix: Fixed "ticket-label" parameter issue, that per default made the template add a link to a search for for tickets labeled "Compositor"; +doc: Added documentation for said parameter)
Line 46: Line 46:
|data13  = {{{subforum|}}}
|data13  = {{{subforum|}}}
|label14 = Open Tickets  
|label14 = Open Tickets  
|data14 = {{Tickets|Compositor|labels:"{{{ticket-label|Compositor}}}"}}
|data14 = {{#if: {{{ticket-label|}}} | {{Tickets||labels:"{{{ticket-label|}}}"}} }}
}}</includeonly><noinclude>
}}</includeonly><noinclude>
{{Informative template|1=
{{Informative template|1=
Line 55: Line 55:
== Usage ==
== Usage ==
Add this to the top of the article describing the tool/subsystem.
Add this to the top of the article describing the tool/subsystem.
  <nowiki>{{</nowiki>'''infobox subsystem'''
  {{obr}}'''infobox subsystem'''
  <nowiki>|</nowiki> ''name''          =  
  {{!}} ''name''          =  
  <nowiki>|</nowiki> ''type''          =  
  {{!}} ''type''          =  
  <nowiki>|</nowiki> ''image''          =  
  {{!}} ''image''          =  
  <nowiki>|</nowiki> ''alt''            =  
  {{!}} ''alt''            =  
  <nowiki>|</nowiki> ''started''        =  
  {{!}} ''started''        =  
  <nowiki>|</nowiki> ''description''    =  
  {{!}} ''description''    =  
  <nowiki>|</nowiki> ''maintainers''    =  
  {{!}} ''maintainers''    =  
  <nowiki>|</nowiki> ''developers''    =  
  {{!}} ''developers''    =  
  <nowiki>|</nowiki> ''merge-requests'' =  
  {{!}} ''merge-requests'' =  
  <nowiki>|</nowiki> ''status''        =  
  {{!}} ''status''        =  
  <nowiki>|</nowiki> ''folders''        =  
  {{!}} ''folders''        =  
  <nowiki>|</nowiki> ''changelog''      =  
  {{!}} ''changelog''      =  
  <nowiki>|</nowiki> ''topic-sg''      =  
  {{!}} ''topic-sg''      =  
  <nowiki>|</nowiki> ''topic-fg''      =  
  {{!}} ''topic-fg''      =  
  <nowiki>|</nowiki> ''topic-fgdata''  =
  {{!}} ''topic-fgdata''  =
  <nowiki>|</nowiki> ''git-repo''   =  
  {{!}} ''git-repo''       =  
  <nowiki>|</nowiki> ''website''        =  
  {{!}} ''website''        =  
  <nowiki>|</nowiki> ''subforum''      =  
  {{!}} ''subforum''      =  
  <nowiki>}}</nowiki>
  {{!}} ''ticket-label''  =
{{cbr}}


All parameters are optional.
All parameters are optional.
Line 113: Line 114:


; subforum:  Link to related FlightGear subforum or topic
; subforum:  Link to related FlightGear subforum or topic
; ticket-label:  Label to search for in the {{tickets|issue tracker tickets}} of FlightGear.


== Related templates ==
== Related templates ==

Revision as of 17:09, 10 September 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       = 
| ticket-label   = 
}}

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
ticket-label
Label to search for in the issue tracker tickets of FlightGear.

Related templates