Jump to content

Module:NavboxGenerator/doc

From Deadlock Wiki
Revision as of 21:13, 25 October 2024 by Sur (talk | contribs) (=eeded changes: typo in section name)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:NavboxGenerator

Not finished.

Overview[edit source]

Create's a navbox from a json file for input where keys are a title div container, and value "Display" is the display text. Each title div container gets smaller and smaller the further it is in the json.

Parameters[edit source]

Within each level of the json:

  • <key> - Title to display in the div/container/box. Can wrap it in <span style="mystyle">key</span> for styling it.
  • Style - Style for the div
  • Display - Text to display below the div
  • <Any other value> - Recursively calls for the contained layer, with <Any other value> as the new <key>

Examples[edit source]

For understanding the input syntax, it is recommended to view the Simple Example first.

Simple Example[edit source]

The input can be seen at Data:ItemNavboxSample.json

{{#invoke:NavboxGenerator|createNavbox|Data:ItemNavboxSample.json}}

Outputs

Lua error: bad argument #1 to 'mw.loadJsonData' ('Data:ItemNavboxSample.json' is not a valid JSON page).

Styled Example[edit source]

The input can be seen at Data:ItemNavbox.json

{{#invoke:NavboxGenerator|createNavbox|Data:ItemNavbox.json}}

Outputs

Lua error: bad argument #1 to 'mw.loadJsonData' ('Data:ItemNavbox.json' is not a valid JSON page).


Needed changes[edit source]

1. Style/Formatting made prettier 2. A way to have the json iterated in order; for some reason mw.loadJsonData doesn't load the keys in order they appear.


This is not used on any pages currently.