DYK/doc

Revision as of 01:20, 7 March 2021

This module is responsible for some of the functionality of the currently in-progress "Did you know" feature.

Functions:

The "random" function can generate up to 5 random numbers per day. Its arguments are "length", which sets the highest random number it can select (default is 30), and "seed", which can select between the 5 daily numbers. Seed accepts numbers from 1 to 5.
Example: {{#invoke:DYK|random|length=33|seed=3}} generates: 2 (this number changes daily)
The "facts" function, which returns up to 5 facts per day, selected from Dogcraft_Wiki:Did_you_know. Its arguments are "text", which expects "Template:Dogctaft Wiki:Did you know" as the value, and "count", which determines how many facts to return.
Example: {{#invoke:DYK|facts|text={{Dogctaft_Wiki:Did_you_know}}|count=2}} generates: Lua error in Module:DYK at line 41: attempt to compare number with nil. (this changes daily)

@@ Line 1: / Line 1: @@
 This module is responsible for some of the functionality of the currently in-progress "Did you know" feature.
-It currently contains:
+Functions:
-* The "random" function generating a single random number per day. <br> ''Example: ''<code><nowiki>{{#invoke:DYK|random|33}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|random|33}}</code>'' (this number changes daily)''
+* The "random" function can generate up to 5 random numbers per day. Its arguments are "length", which sets the highest random number it can select (default is 30), and "seed", which can select between the 5 daily numbers. Seed accepts numbers from 1 to 5. <br> ''Example: ''<code><nowiki>{{#invoke:DYK|random|length=33|seed=3}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|random|length=33|seed=3}}</code>'' (this number changes daily)''
+* The "facts" function, which returns up to 5 facts per day, selected from [[Dogcraft_Wiki:Did_you_know]]. Its arguments are "text", which expects "{{Dogctaft_Wiki:Did_you_know}}" as the value, and "count", which determines how many facts to return. <br> ''Example: ''<code><nowiki>{{#invoke:DYK|facts|text={{Dogctaft_Wiki:Did_you_know}}|count=2}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|facts|text={{Dogcraft_Wiki:Sandbox/DYK}}|count=4}}</code>'' (this changes daily)''