Difference between revisions of "Template:Infobox tsg/doc"

From TSG Doc
Jump to navigation Jump to search
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Infobox resources
+
{{documentation subpage}}
| bodyclass = vevent
+
 
| name          = Hardware
+
== Usage ==
 +
<pre style="overflow:auto;">
 +
{{Infobox tsg
 +
| child          =
 +
| name          =
 +
| title          =
 +
| image          =
 +
| image size    =
 +
| image alt      =
 +
| caption        = <!-- Image name is enough -->
 +
| header1        =
 +
| label1        =
 +
| data1          =
 +
| downloads      = <!-- List of links -->
 +
| manuals        = <!-- List of links -->
 +
}}
 +
</pre>
 +
{{Clear}}
 +
 
 +
== Example ==
 +
{{Infobox tsg
 +
| name          = Physical Place Holder
 
| image          = placeholder.png
 
| image          = placeholder.png
| caption        = A piece of hardware
+
| caption        = The device in action
 
| downloads      = {{bulleted list
 
| downloads      = {{bulleted list
       | [http://www.ru.nl Some Download link]
+
       | [[Main Page|Installer]]
       | [http://www.ru.nl Some other Download link]
+
       | [[Main Page|Drivers]]
 
   }}
 
   }}
 +
| manuals        = {{bulleted list
 +
      | [[Main Page|Quick Start Guide]]
 +
      | [[Main Page|Reference Guide]]
 +
  }}
 +
}}
 +
<pre style="overflow:auto;">
 +
{{Infobox tsg
 +
| name          = Physical Place Holder
 +
| image          = placeholder.png
 +
| caption        = The device in action
 +
| downloads      = {{bulleted list
 +
      | [[Main Page|Installer]]
 +
      | [[Main Page|Drivers]]
 +
  }}
 +
| manuals        = {{bulleted list
 +
      | [[Main Page|Quick Start Guide]]
 +
      | [[Main Page|Reference Guide]]
 +
  }}
 +
}}
 +
</pre>
 +
=== Embedded ===
 +
{{Infobox
 +
| title = Embedded Example
 +
| label1 = label1
 +
|  data1 = data1
 +
| label2 = label2
 +
|  data2 = data2
 +
|  data3 =
 +
{{Infobox tsg
 +
  | child = yes
 +
  | downloads = *[[Main Page|Link]]
 +
}}
 +
}}
 +
<pre style="overflow:auto;">
 +
{{Infobox
 +
| title = Embedded Example
 +
| label1 = label1
 +
|  data1 = data1
 +
| label2 = label2
 +
|  data2 = data2
 +
|  data3 =
 +
{{Infobox tsg
 +
  | child = yes
 +
  | downloads = *[[Main Page|Link]]
 +
}}
 
}}
 
}}
 +
</p
 +
</pre>
 +
 +
== Parameters ==
 +
All parameters are optional.
 +
 +
; child
 +
: Whether the infobox is placed embedded in an other infobox. The infobox will be styled accordingly. If embedded, the name/title will not be displayed. For technical reasons, anything for this parameter has the same effect, be it "yes", "no" or anything else. To nullify the effect of this parameter, you need to omit it.
 +
; name
 +
: Name of the infobox. Can affect the title of the infobox but its primary use is to help retrieve release data from outside the article. In such cases, if you want to edit the title at the top of the infobox, use the {{para|title}} parameter instead.
 +
::'''Attention:''' Please do not include a wikilink, hyperlink or image in this parameter. This parameter should be composed of pure text.
 +
; title
 +
: Name of the software product as displayed above the infobox. When not specified, contents of {{para|name}} parameter will be displayed instead.
 +
:'''Important note:''' Please do not include an image in this field.
 +
; bodystyle
 +
: CSS styling for the infobox as a whole. Don't touch unless you know what you're doing.
 +
; image
 +
: Code for an image to be displayed at the top of the infobox. You may specify a full image syntax or just a file name, with or without namespace prefix. In other words, the following examples are all acceptable:
 +
::placeholder.png
 +
::File:placeholder.png
 +
::Image:placeholder.png
 +
::<nowiki>[[File:placeholder.png|64px]]</nowiki>
 +
::<nowiki>[[Image:placeholder.png|64px]]</nowiki>
 +
; image size
 +
: Size of the image. Defaults to 300px.
 +
; image alt
 +
: Alternative text of the image; very important.
 +
; caption
 +
: Caption of the image that appears below it.
 +
; header1
 +
: Some space left to possibly include other information before the resource links, or for a custom resource header.
 +
; label1
 +
: Some space left to possibly include other information before the resource links.
 +
; data1
 +
: Some space left to possibly include other information before the resource links.
 +
; downloads
 +
: Designed to take a list of (download) links using something like {{tl|bulleted list}}.
 +
; manuals
 +
: Designed to take a list of links (to manuals) using something like {{tl|bulleted list}}.
 +
 +
<includeonly>
 +
<!-- ADD CATEGORIES BELOW THIS LINE -->
 +
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 +
</includeonly>

Latest revision as of 12:33, 3 August 2015

Usage

{{Infobox tsg
| child          = 
| name           = 
| title          = 
| image          = 
| image size     = 
| image alt      = 
| caption        = <!-- Image name is enough -->
| header1        = 
| label1         = 
| data1          = 
| downloads      = <!-- List of links -->
| manuals        = <!-- List of links -->
}}

Example

Physical Place Holder
Placeholder.png
The device in action
Downloads
Manuals
{{Infobox tsg
| name           = Physical Place Holder
| image          = placeholder.png
| caption        = The device in action
| downloads      = {{bulleted list
      | [[Main Page|Installer]]
      | [[Main Page|Drivers]]
  }}
| manuals        = {{bulleted list
      | [[Main Page|Quick Start Guide]]
      | [[Main Page|Reference Guide]]
  }}
}}

Embedded

Embedded Example
label1data1
label2data2
Downloads
{{Infobox
| title = Embedded Example
| label1 = label1
|  data1 = data1
| label2 = label2
|  data2 = data2
|  data3 =
 {{Infobox tsg
  | child = yes
  | downloads = *[[Main Page|Link]]
 }}
}}
</p

Parameters

All parameters are optional.

child
Whether the infobox is placed embedded in an other infobox. The infobox will be styled accordingly. If embedded, the name/title will not be displayed. For technical reasons, anything for this parameter has the same effect, be it "yes", "no" or anything else. To nullify the effect of this parameter, you need to omit it.
name
Name of the infobox. Can affect the title of the infobox but its primary use is to help retrieve release data from outside the article. In such cases, if you want to edit the title at the top of the infobox, use the |title= parameter instead.
Attention: Please do not include a wikilink, hyperlink or image in this parameter. This parameter should be composed of pure text.
title
Name of the software product as displayed above the infobox. When not specified, contents of |name= parameter will be displayed instead.
Important note: Please do not include an image in this field.
bodystyle
CSS styling for the infobox as a whole. Don't touch unless you know what you're doing.
image
Code for an image to be displayed at the top of the infobox. You may specify a full image syntax or just a file name, with or without namespace prefix. In other words, the following examples are all acceptable:
placeholder.png
File:placeholder.png
Image:placeholder.png
[[File:placeholder.png|64px]]
[[Image:placeholder.png|64px]]
image size
Size of the image. Defaults to 300px.
image alt
Alternative text of the image; very important.
caption
Caption of the image that appears below it.
header1
Some space left to possibly include other information before the resource links, or for a custom resource header.
label1
Some space left to possibly include other information before the resource links.
data1
Some space left to possibly include other information before the resource links.
downloads
Designed to take a list of (download) links using something like {{bulleted list}}.
manuals
Designed to take a list of links (to manuals) using something like {{bulleted list}}.