Template:ShipArticle/doc: Difference between revisions

Line 1:

{{cleanup|Standardize [[Template:Documentation/preload|documentation]]. Explain auto image fetching from [https://images.evetech.net/ CCP Servers]. [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 11:33, 27 July 2022 (UTC)}}

{{Work in progress|Both the actual template and the doc page are being overhauled. The doc in situ and the template in [[User:Evon R'al/Sandbox template]]|date= 12:25, 4 January 2023 (UTC) }}

{{Work in progress|Both the actual template and the doc page are being overhauled. The doc in situ and the template in [[User:Evon R'al/Sandbox template]]|date= 18:07, 6 January 2023 (UTC) }}

; Description

Line 140:

::; shipid {{Co|palegreen|[Preferred]}} : EVE Online database ID for the ship. See [[How to get ID]] for how to find it. Used for: * External links to zKillboard, EVE workbench, evepraisal and EVE Ref: * Ship image from CCP image server when no local image available.

:;; shipimg {{Co|palegreen|[Preferred]}} {{Co|yellow|[bl, tt]}} : Name of the local image file with extension. Used to show the image. Overrules the use of the CCP image server (see '''shipid''')

:;; shipname {{Co|palegreen|[Required]}} {{Co|yellow|[bl, tt]}} : The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for: * ~~Breadcrumbs~~; * Show ship name when hovering over the image; * Naming of external links, (see '''shipid''').

:;; shipname {{Co|palegreen|[Required]}} {{Co|yellow|[bl, tt]}} : The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for: * Show ship name; * Show ship name when hovering over the image; * Breadcrumbs; * Naming of external links, (see '''shipid''').

:;; caption : {{Co|red|Not used}} in {{Tl|ShipArticle}} (Need to check for <s>{{Tl|ShipBoxLarge}}</s> and <s>{{Tl|ShipBoxTooltip}}</s>

::; class {{Co|palegreen|[Required]}} {{Co|yellow|[bl]}} : Class the ship belongs to. This info is not directly available in-game (see table ''Ship classes'') Used for: * Excluding (special edition) shuttles from the external EVE Workbench link; * Determine the (default) number of rigs (in combination with '''tech'''); * Determine the (default) rig size; * Determine (default) number of calibration points (in combination with '''grouping'''); * Determine presence of Frigate Escape Bay

::; class {{Co|palegreen|[Required]}} {{Co|yellow|[bl]}} : Class the ship belongs to. This info is not directly available in-game (see table ''Ship classes'') Used for: * Excluding (special edition) shuttles from the external EVE Workbench link; * Determine the (default) number of rigs (in combination with '''tech'''); * Determine the (default) rig size; * Determine (default) number of calibration points (in combination with '''grouping'''); * Determine presence of Frigate Escape Bay; * Part of the header text, {{Co|yellow|[bl]}} only

{{Note box|

2022-12-28 - Be aware: the tables give the "old" values. this part of the template is being worked on.

Line 247:

| 400

|}

::; grouping {{Co|palegreen|[Required]}} {{Co|yellow|[tt]}} : Name of the market group the ship belongs to. Used for: * Ship category in breadcrumbs; * Ship category under ship image; * Determine (default) number of calibration points (in combination with '''class''')

::; grouping {{Co|palegreen|[Required]}} {{Co|yellow|[tt]}} : Name of the market group the ship belongs to. Used for: * Ship category in breadcrumbs; * Ship category under ship image; * Determine (default) number of calibration points (in combination with '''class'''); * Part of the header, {{Co|yellow|[tt]}}

::; hulltype {{Co|yellow|[tt]}} : Ships basic hulltype. The Tech1 shipname when there are variations i.e. The [[Vexor]], [[Guardian-Vexor]], [[Ishtar]] and [[Vexor Navy Issue]] all have Vexor for their hulltype. Otherwise use the shipname. Used for: <''Hull type''> Class under ship image. The word Class must be included.

::; faction {{Co|palegreen|[Required]}} {{Co|yellow|[bl]}} : Name of the faction the ship belongs to. Used for: * Faction name under ship image; * Faction logo under ship image; * Show faction name when hovering over the logo.

@@ Line 1: / Line 1: @@
 {{cleanup|Standardize [[Template:Documentation/preload|documentation]]. Explain auto image fetching from [https://images.evetech.net/ CCP Servers]. [[User:Arin Mara|Arin Mara]] ([[User talk:Arin Mara|talk]]) 11:33, 27 July 2022 (UTC)}}
-{{Work in progress|Both the actual template and the doc page are being overhauled. The doc in situ and the template in [[User:Evon R'al/Sandbox template]]|date= 12:25, 4 January 2023 (UTC) }}
+{{Work in progress|Both the actual template and the doc page are being overhauled. The doc in situ and the template in [[User:Evon R'al/Sandbox template]]|date= 18:07, 6 January 2023 (UTC) }}
 ; Description
@@ Line 140: / Line 140: @@
 ::; shipid {{Co|palegreen|[Preferred]}} : EVE Online database ID for the ship. See [[How to get ID]] for how to find it. Used for: <br>* External links to zKillboard, EVE workbench, evepraisal and EVE Ref: <br>* Ship image from CCP image server when no local image available.
 :;; shipimg {{Co|palegreen|[Preferred]}} {{Co|yellow|[bl, tt]}} : Name of the local image file with extension. Used to show the image. Overrules the use of the CCP image server (see '''shipid''')
-:;; shipname {{Co|palegreen|[Required]}} {{Co|yellow|[bl, tt]}} : The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for: <br>* Breadcrumbs; <br>* Show ship name when hovering over the image; <br>* Naming of external links, (see '''shipid''').
+:;; shipname {{Co|palegreen|[Required]}} {{Co|yellow|[bl, tt]}} : The name of the ship. Exactly as written in-game. Must be identical to the article name. Used for: <br>* Show ship name; <br>* Show ship name when hovering over the image; <br>* Breadcrumbs; <br>* Naming of external links, (see '''shipid''').
 :;; caption : {{Co|red|Not used}} in {{Tl|ShipArticle}} (Need to check for <s>{{Tl|ShipBoxLarge}}</s> and <s>{{Tl|ShipBoxTooltip}}</s>
-::; class {{Co|palegreen|[Required]}} {{Co|yellow|[bl]}} : Class the ship belongs to. This info is not directly available in-game (see table ''Ship classes'') Used for: <br>* Excluding (special edition) shuttles from the external EVE Workbench link; <br>* Determine the (default) number of rigs (in combination with '''tech'''); <br>* Determine the (default) rig size; <br>* Determine (default) number of calibration points (in combination with '''grouping'''); <br>* Determine presence of Frigate Escape Bay
+::; class {{Co|palegreen|[Required]}} {{Co|yellow|[bl]}} : Class the ship belongs to. This info is not directly available in-game (see table ''Ship classes'') Used for: <br>* Excluding (special edition) shuttles from the external EVE Workbench link; <br>* Determine the (default) number of rigs (in combination with '''tech'''); <br>* Determine the (default) rig size; <br>* Determine (default) number of calibration points (in combination with '''grouping'''); <br>* Determine presence of Frigate Escape Bay; <br>* Part of the header text, {{Co|yellow|[bl]}} only
 {{Note box|
 -12-28 - Be aware: the tables give the "old" values. this part of the template is being worked on.
@@ Line 247: / Line 247: @@
 | 400
 |}
-::; grouping {{Co|palegreen|[Required]}} {{Co|yellow|[tt]}} : Name of the market group the ship belongs to. Used for: <br>* Ship category in breadcrumbs; <br>* Ship category under ship image; <br>* Determine (default) number of calibration points (in combination with '''class''')
+::; grouping {{Co|palegreen|[Required]}} {{Co|yellow|[tt]}} : Name of the market group the ship belongs to. Used for: <br>* Ship category in breadcrumbs; <br>* Ship category under ship image; <br>* Determine (default) number of calibration points (in combination with '''class'''); <br>* Part of the header, {{Co|yellow|[tt]}}
 ::; hulltype {{Co|yellow|[tt]}} : Ships basic hulltype. The Tech1 shipname when there are variations i.e. The [[Vexor]], [[Guardian-Vexor]], [[Ishtar]] and [[Vexor Navy Issue]] all have Vexor for their hulltype. Otherwise use the shipname. <br>Used for: <''Hull type''> Class under ship image. The word Class must be included.
 ::; faction {{Co|palegreen|[Required]}} {{Co|yellow|[bl]}} : Name of the faction the ship belongs to. Used for: <br>* Faction name under ship image; <br>* Faction logo under ship image; <br>* Show faction name when hovering over the logo.