DYK/doc

Latest revision as of 18:20, 28 August 2022

This module is responsible for the functionality of the Did you know? facts that appear on the main page. It does this by randomly pulling a number of facts from the content of the Dogcraft Wiki:Did you know/Facts page.

Functions:

random

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.
Examples:

{{#invoke:DYK|random|length=33|seed=1}} generates: 2 (this number changes daily)
{{#invoke:DYK|random|length=33|seed=2}} generates: 9 (this number changes daily)
{{#invoke:DYK|random|length=33|seed=3}} generates: 17 (this number changes daily)
{{#invoke:DYK|random|length=33|seed=4}} generates: 24 (this number changes daily)
{{#invoke:DYK|random|length=33|seed=5}} generates: 31 (this number changes daily)

randomW

The "randomW" function can generate up to 5 random numbers per week. 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.
Examples:

{{#invoke:DYK|randomW|length=33|seed=1}} generates: 26 (this number changes weekly)
{{#invoke:DYK|randomW|length=33|seed=2}} generates: 1 (this number changes weekly)
{{#invoke:DYK|randomW|length=33|seed=3}} generates: 8 (this number changes weekly)
{{#invoke:DYK|randomW|length=33|seed=4}} generates: 15 (this number changes weekly)
{{#invoke:DYK|randomW|length=33|seed=5}} generates: 23 (this number changes weekly)

facts

The "facts" function, which returns up to 5 facts per day, selected from Dogcraft_Wiki:Did_you_know. Its arguments are "text", which expects "{{Dogcraft_Wiki:Did_you_know/Facts}}" or a similarly layed out page, as the value, and "start" and "end", which determine which of the 5 facts to return.
Example: {{#invoke:DYK|facts|text={{Dogcraft_Wiki:Did_you_know/Facts}}|start=1|end=2}} generates:

... that although the Dogcraft Server was launched officially in 2015, a number of unofficial servers operated as a precursor since at least 2012?

... that player-built settlements on the Dogcraft Server have had a custom of exchanging "embassies" since the first Survival Multiplayer world?

(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.
+{{Sidebar DYK}}
+This module is responsible for the functionality of the [[Dogcraft Wiki:Did you know|Did you know?]] facts that appear on the main page. It does this by randomly pulling a number of facts from the content of the [[Dogcraft Wiki:Did you know/Facts]] page.
-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)''
+====random====
+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> ''Examples:
+* ''<code><nowiki>{{#invoke:DYK|random|length=33|seed=1}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|random|length=33|seed=1}}</code>'' (this number changes daily)''
+* ''<code><nowiki>{{#invoke:DYK|random|length=33|seed=2}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|random|length=33|seed=2}}</code>'' (this number changes daily)''
+* ''<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)''
+* ''<code><nowiki>{{#invoke:DYK|random|length=33|seed=4}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|random|length=33|seed=4}}</code>'' (this number changes daily)''
+* ''<code><nowiki>{{#invoke:DYK|random|length=33|seed=5}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|random|length=33|seed=5}}</code>'' (this number changes daily)''
+====randomW====
+The "randomW" function can generate up to 5 random numbers per week. 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> ''Examples:
+* ''<code><nowiki>{{#invoke:DYK|randomW|length=33|seed=1}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|randomW|length=33|seed=1}}</code>'' (this number changes weekly)''
+* ''<code><nowiki>{{#invoke:DYK|randomW|length=33|seed=2}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|randomW|length=33|seed=2}}</code>'' (this number changes weekly)''
+* ''<code><nowiki>{{#invoke:DYK|randomW|length=33|seed=3}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|randomW|length=33|seed=3}}</code>'' (this number changes weekly)''
+* ''<code><nowiki>{{#invoke:DYK|randomW|length=33|seed=4}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|randomW|length=33|seed=4}}</code>'' (this number changes weekly)''
+* ''<code><nowiki>{{#invoke:DYK|randomW|length=33|seed=5}}</nowiki></code>'' generates: ''<code>{{#invoke:DYK|randomW|length=33|seed=5}}</code>'' (this number changes weekly)''
+====facts====
+The "facts" function, which returns up to 5 facts per day, selected from [[Dogcraft_Wiki:Did_you_know]]. Its arguments are "text", which expects "<nowiki>{{Dogcraft_Wiki:Did_you_know/Facts}}</nowiki>" or a similarly layed out page, as the value, and "start" and "end", which determine which of the 5 facts to return. <br> ''Example: ''<code><nowiki>{{#invoke:DYK|facts|text={{Dogcraft_Wiki:Did_you_know/Facts}}|start=1|end=2}}</nowiki></code>'' generates: <blockquote>{{#invoke:DYK|facts|text={{Dogcraft_Wiki:Did_you_know/Facts}}|start=1|end=2}}</blockquote>''(this changes daily)''

Module