Module:Vrix/doc

Module:Vrix/doc

A V'rix universal translator for the wiki!

This module implements the templates {{vencode}}, {{vdecode}}, {{vlencode}}, {{vldecode}}, {{vrencode}}, {{vrdecode}}, and {{verror}}.

Pages Using This

Through the above macros this module is used in a large number of pages across the wiki, i.e. any page where sectors, npcs, missions, or items which may be in V'rix appear.

• {{Item}}
• {{Item/AmmoRow}}
• {{Item/DropRow}}
• {{MissionDesc}}
• {{NPC infobox}}
• {{StationInfoBox}}

Usage

These functions should generally be used via the shortcut templates listed above, the examples below show the direct module calls.

Normal Encode/Decode

The normal encode and decode functions always link to Category:V'rix.

spoiler=yes, Translation is a spoiler so it should be hidden

Acts like a "spoiler" tag and does not show the translation unless you hover over it, the original message specified is what is shown. This is the default behavior if spoiler is not specified.

• {{#invoke:Vrix|encode|message=Servants of the Ancients}} produces Servants of the Ancients
• {{#invoke:Vrix|encode|message=Servants of the Ancients|spoiler=yes}} produces Servants of the Ancients
• {{#invoke:Vrix|decode|message=S2RV1NTS4FTH21NC32NTS}} produces S2RV1NTS4FTH21NC32NTS
• {{#invoke:Vrix|decode|message=S2RV1NTS4FTH21NC32NTS|spoiler=yes}} produces S2RV1NTS4FTH21NC32NTS

spoiler=no, Translation is NOT a spoiler, so show it

Translation is shown, with original text in the tooltip.

• {{#invoke:Vrix|encode|message=Servants of the Ancients|spoiler=no}} produces S2RV1NTS4FTH21NC32NTS
• {{#invoke:Vrix|decode|message=S2RV1NTS4FTH21NC32NTS|spoiler=no}} produces SERVANTSOFTHEANCIENTS

Link Encode/Decode

The link encode/decode functions always link to the V'rix text (so in the encode case, they link to the result of the encoding, and in the decode case they link to the message specified).

spoiler=yes, Translation is a spoiler so it should be hidden

Acts like a "spoiler" tag and does not show the translation unless you hover over it, the original message specified is what is shown. This is the default behavior if spoiler is not specified.

• {{#invoke:Vrix|link_encode|message=Amah's Anger}} produces Amah's Anger
• {{#invoke:Vrix|link_encode|message=Amah's Anger|spoiler=yes}} produces Amah's Anger
• {{#invoke:Vrix|link_decode|message=1M1HSW3LL}} produces 1M1HSW3LL
• {{#invoke:Vrix|link_decode|message=1M1HSW3LL|spoiler=yes}} produces 1M1HSW3LL

spoiler=no, Translation is NOT a spoiler, so show it

• {{#invoke:Vrix|link_encode|message=Amah's Anger|spoiler=no}} produces 1M1HS1NG2R
• {{#invoke:Vrix|link_decode|message=1M1HSW3LL|spoiler=no}} produces AMAHSWILL

Raw Encode/Decode

• {{#invoke:Vrix|raw_encode|message=Scan for the Vishao Codex... negative.}} produces SC1NF4RTH2V3SH14C4D2XN2G1T3V2
• {{#invoke:Vrix|raw_decode|message=SC1NF4RTH2V3SH14C4D2XN2G1T3V2}} produces SCANFORTHEVISHAOCODEXNEGATIVE

Error

• {{#invoke:Vrix|error|message=invalid sector name}} produces