Template:ShipBoxTooltip/doc: Difference between revisions

(3 intermediate revisions by the same user not shown)

Line 1:

; Description

: Creates a tooltip with a subset of the ships stats.

: {{Color box

| color= var(--background-color-error-subtle)

| border= #2F8F2F

| This template is a part of the Ship Database template set and designed to be used in conjunction with the templates on that category and is not meant to be used or called directly!. If you're looking on how to use the '''Ship''' template please see [[Template:Ship|this page]] instead. DO NOT EDIT THE CONTENTS OF THIS TEMPLATE IF YOU ARE NOT SURE ON WHAT YOU ARE DOING.

}}

~~{{Color box~~

~~|color=#144f1d~~

~~|border=#2f8f2f~~

|This template is a part of Ship Database template and designed to be used in conjunction with the templates on that category and is not meant to be used or called directly!. If you're looking on how to use the '''Ship template''' please see [[Template:Ship|this page]] instead. DO NOT EDIT THE CONTENTS OF THIS TEMPLATE IF YOU ARE NOT SURE ON WHAT YOU ARE DOING.}}

~~For usage guide please see [[Template:Ship|Ship Template]]~~

~~; Description~~

~~: This template is a sub-template used to produce a link to a ship which on mouse over shows a tool-tip whit some ship info.~~

; Dependencies:

: Uses:

:; Uses:

:: {{T|Tooltip}}

:: ~~Ship information in~~ ship ~~database articles~~.

:: {{T|Imageserver}} When no local image of ship is available and <kbd>shipid</kbd> is known.

~~: Called by:~~

:: Part of the parameter set of {{Tl|ShipArticle}}

:: {{T|~~Ship~~}} ~~through [[:Category:Ship Database|ship database]] articles~~

; Syntax

: ~~Can ~~not~~~~ be used on its own.

: ShipBoxTooltip is not to be used on its own. It is to be called by using the wrapper template {{Tl|Ship}}

: {{T|~~ShipBoxTooltip~~}} ~~is called when a ship article is called with mode= tooltip. e.g. <nowiki>~~{{:~~Vexor~~|~~mode= tooltip~~}}~~</nowiki> gives~~ {{~~:Vexor~~|~~mode= tooltip~~}}

; Template set

: {{T|ShipArticle}}

: {{T|Ship}}

:: {{T|ShipBoxLarge}}

:: {{T|ShipBoxTooltip}}

; Sample

Line 31:

|There is a problem with the presentation of the result. See [[Template talk:ShipBoxTooltip]]}}

<includeonly>[[Category:~~Template~~]]</includeonly>

<includeonly>[[Category:Formatting templates]] [[Category:Data templates]]</includeonly>

<noinclude>[[Category:Template documentation]]</noinclude>

@@ Line 1: / Line 1: @@
-{{Cleanup|Documentation need some more work}}
+; Description
+: Creates a tooltip with a subset of the ships stats.
+: {{Color box
+| color= var(--background-color-error-subtle)
+| border= #2F8F2F
+| This template is a part of the Ship Database template set and designed to be used in conjunction with the templates on that category and is not meant to be used or called directly!.<br>If you're looking on how to use the '''Ship''' template please see [[Template:Ship|this page]] instead.<br><br>DO NOT EDIT THE CONTENTS OF THIS TEMPLATE IF YOU ARE NOT SURE ON WHAT YOU ARE DOING.
+}}
-{{Color box
-|color=#144f1d
-|border=#2f8f2f
-|This template is a part of Ship Database template and designed to be used in conjunction with the templates on that category and is not meant to be used or called directly!. If you're looking on how to use the '''Ship template''' please see [[Template:Ship|this page]] instead.<br><br>DO NOT EDIT THE CONTENTS OF THIS TEMPLATE IF YOU ARE NOT SURE ON WHAT YOU ARE DOING.}}
-For usage guide please see [[Template:Ship|Ship Template]]
-; Description
-: This template is a sub-template used to produce a link to a ship which on mouse over shows a tool-tip whit some ship info.
 ; Dependencies:
-: Uses:
+:; Uses:
 :: {{T|Tooltip}}
-:: Ship information in ship database articles.
+:: {{T|Imageserver}} When no local image of ship is available and <kbd>shipid</kbd> is known.
-: Called by:
+:: Part of the parameter set of {{Tl|ShipArticle}}
-:: {{T|Ship}} through [[:Category:Ship Database|ship database]] articles
 ; Syntax
-: Can <em>not</em> be used on its own.
+: ShipBoxTooltip is not to be used on its own. It is to be called by using the wrapper template {{Tl|Ship}}
-: {{T|ShipBoxTooltip}} is called when a ship article is called with mode= tooltip. e.g. <nowiki>{{:Vexor|mode= tooltip}}</nowiki> gives {{:Vexor|mode= tooltip}}
+; Template set
+: {{T|ShipArticle}}
+: {{T|Ship}}
+:: {{T|ShipBoxLarge}}
+:: {{T|ShipBoxTooltip}}
 ; Sample
@@ Line 31: / Line 31: @@
 |There is a problem with the presentation of the result. See [[Template talk:ShipBoxTooltip]]}}
-<includeonly>[[Category:Template]]<!-- Any categories for the template itself --></includeonly>
+<includeonly>[[Category:Formatting templates]] [[Category:Data templates]]<!-- Any categories for the template itself --></includeonly>
 <noinclude>[[Category:Template documentation]]</noinclude>