Template:DeviceInfoBox: Difference between revisions

From Night Vision Wiki
No edit summary
No edit summary
Line 2: Line 2:
<templatedata>
<templatedata>
{
{
  "description": "Info box for a device",
"description": "Info box for a device",
  "params": {
"params": {
      "name": {
"name": {
        "label": "Name",
"label": "Name",
        "description": "Name of the device",
"description": "Name of the device",
        "required": true,
"required": true,
        "suggested": true,
"suggested": true,
        "example": "AN/PVS-14",
"example": "AN/PVS-14",
        "type": "string"
"type": "string"
      },
},
      "manufacturer": {
"manufacturer": {
        "label": "Manufacturer #1",
"label": "Manufacturer #1",
        "description": "Page of the manufacturer of the device",
"description": "Page of the manufacturer of the device",
        "required": true,
"required": true,
        "suggested": true,
"suggested": true,
        "example": "L3Harris",
"example": "L3Harris",
        "type": "wiki-page-name"
"type": "wiki-page-name"
      },
},
      "manufacturer-name": {
"manufacturer-name": {
        "label": "Manufacturer #1 Device Name",
"label": "Manufacturer #1 Device Name",
        "description": "Name of the device as used by the manufacturer",
"description": "Name of the device as used by the manufacturer",
        "required": false,
"required": false,
        "suggested": true,
"suggested": true,
        "example": "M914A",
"example": "M914A",
        "type": "string"
"type": "string"
      },
},
      "manufacturer-2": {
"manufacturer-2": {
        "label": "Manufacturer #2",
"label": "Manufacturer #2",
        "inherits": "manufacturer"
"inherits": "manufacturer"
      },
},
      "manufacturer-name-2": {
"manufacturer-name-2": {
        "label": "Manufacturer #2 Device Name",
"label": "Manufacturer #2 Device Name",
        "inherits": "manufacturer-name"
"inherits": "manufacturer-name"
      },
},
      "manufacturer-3": {
"manufacturer-3": {
        "label": "Manufacturer #3",
"label": "Manufacturer #3",
        "inherits": "manufacturer"
"inherits": "manufacturer"
      },
},
      "manufacturer-name-3": {
"manufacturer-name-3": {
        "label": "Manufacturer #3 Device Name",
"label": "Manufacturer #3 Device Name",
        "inherits": "manufacturer-name"
"inherits": "manufacturer-name"
      },
},
      "page": {
"page": {
        "label": "Product page",
"label": "Product page",
        "description": "The main product page of the device",
"description": "The main product page of the device",
        "required": false,
"required": false,
        "suggested": true,
"suggested": true,
        "example": "https://www.abnightvision.com/pages/rnvg-ruggedized-night-vision-goggle",
"example": "https://www.abnightvision.com/pages/rnvg-ruggedized-night-vision-goggle",
        "type": "url"
"type": "url"
      }
},
  },
"image": {
  "paramOrder": [
"label": "Image",
      "name",
"description": "Image of the device",
      "manufacturer",
"example": "File:RNVG.jpg",
      "manufacturer-name",
"type": "wiki-file-name",
      "manufacturer-2",
"suggested": true
      "manufacturer-name-2",
},
      "manufacturer-3",
"type": {},
      "manufacturer-name-3",
"format": {},
      "page"
"fov-ver": {},
  ]
"fov-hor": {},
"mount": {},
"objectives": {},
"eyepieces": {},
"weight": {}
},
"paramOrder": [
"name",
"manufacturer",
"manufacturer-name",
"manufacturer-2",
"manufacturer-name-2",
"manufacturer-3",
"manufacturer-name-3",
"page",
"image",
"type",
"format",
"fov-ver",
"fov-hor",
"mount",
"objectives",
"eyepieces",
"weight"
]
}
}
</templatedata>
</templatedata>

Revision as of 20:29, 22 February 2023

Info box for a device

[Edit template data]

Template parameters

ParameterDescriptionTypeStatus
Namename

Name of the device

Example
AN/PVS-14
Stringrequired
Manufacturer #1manufacturer

Page of the manufacturer of the device

Example
L3Harris
Page namerequired
Manufacturer #1 Device Namemanufacturer-name

Name of the device as used by the manufacturer

Example
M914A
Stringsuggested
Manufacturer #2manufacturer-2

Page of the manufacturer of the device

Example
L3Harris
Page namerequired
Manufacturer #2 Device Namemanufacturer-name-2

Name of the device as used by the manufacturer

Example
M914A
Stringsuggested
Manufacturer #3manufacturer-3

Page of the manufacturer of the device

Example
L3Harris
Page namerequired
Manufacturer #3 Device Namemanufacturer-name-3

Name of the device as used by the manufacturer

Example
M914A
Stringsuggested
Product pagepage

The main product page of the device

Example
https://www.abnightvision.com/pages/rnvg-ruggedized-night-vision-goggle
URLsuggested
Imageimage

Image of the device

Example
File:RNVG.jpg
Filesuggested
typetype

no description

Unknownoptional
formatformat

no description

Unknownoptional
fov-verfov-ver

no description

Unknownoptional
fov-horfov-hor

no description

Unknownoptional
mountmount

no description

Unknownoptional
objectivesobjectives

no description

Unknownoptional
eyepieceseyepieces

no description

Unknownoptional
weightweight

no description

Unknownoptional

Parameters

  1. image (optional): Name of an image on the wiki (without File: prefix)
  1. name: Name of the device
  2. manufacturer: Page of the manufacturer
  3. manufacturer-name (optional): Manufacturer-specific name of the device
  4. manufacturer (optional): Page of the second manufacturer
  5. manufacturer-name (optional): Second manufacturer-specific name of the device
  6. manufacturer (optional): Page of the third manufacturer
  7. manufacturer-name (optional): Third manufacturer-specific name of the device
  8. page (optional): Product page URL
  9. type: Housing type, should be one of TODO
  10. format: Format, should be one of TODO
  11. fov-ver: Horizontal field of view (numeric)
  12. fov-hor: Vertical field of view (numeric)
  13. mount: Type of mount, should be one of TODO
  14. objectives: Type of objectives
  15. eyepieces: Type of eyepieces
  16. weight: Weight in g (numeric)