Module

DYK/doc

From Dogcraft Wiki

No edit summary
m (sidebar!)
ย 
(11 intermediate revisions by 2 users not shown)
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.


===Functions:===
===Functions:===
====random====
====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> ''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 "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====
====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}}</nowiki>" 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: <blockquote>{{#invoke:DYK|facts|text={{Dogcraft_Wiki:Sandbox/DYK}}|count=4}}</blockquote>''(this 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 "<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)''

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: 3 (this number changes daily)
  • {{#invoke:DYK|random|length=33|seed=2}} generates: 11 (this number changes daily)
  • {{#invoke:DYK|random|length=33|seed=3}} generates: 18 (this number changes daily)
  • {{#invoke:DYK|random|length=33|seed=4}} generates: 25 (this number changes daily)
  • {{#invoke:DYK|random|length=33|seed=5}} generates: 33 (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: 18 (this number changes weekly)
  • {{#invoke:DYK|randomW|length=33|seed=2}} generates: 25 (this number changes weekly)
  • {{#invoke:DYK|randomW|length=33|seed=3}} generates: 32 (this number changes weekly)
  • {{#invoke:DYK|randomW|length=33|seed=4}} generates: 7 (this number changes weekly)
  • {{#invoke:DYK|randomW|length=33|seed=5}} generates: 14 (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 for a time it was possible to purchase Mall plots via a menu on the Dogcraft.net website?

(this changes daily)