Old MT Dev - User contributions [en]

Minetest.place schematic on vmanip

2023-08-05T22:49:44Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
<source>local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
</source>

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

MediaWiki:Monobook.css

2023-08-05T22:49:13Z

Poetry:

/* All CSS here will be loaded for users of the MonoBook skin */

.mw-wiki-logo {
background-size: contain;
}

.mw-content-text, .mw-body-content {
font-size: 1.1em;
text-align: justify;
}

.code, .source {
display:block;
background: rgb(90%, 90%, 90%);
-webkit-overflow-scrolling: touch;
overflow-x: scroll;
border-radius: .5em;
border: 2px solid darkgray;
color: black;
white-space: pre;
max-width: 100%;
min-width: 50em;
padding: 1em;
}

Minetest.place schematic on vmanip

2023-08-05T22:04:15Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
<code>local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
</code>

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

MediaWiki:Monobook.css

2023-08-05T22:02:15Z

Poetry:

/* All CSS here will be loaded for users of the MonoBook skin */

.mw-wiki-logo {
background-size: contain;
}

.mw-content-text, .mw-body-content {
font-size: 1.1em;
text-align: justify;
}

.code {
display:block;
background: rgb(90%, 90%, 90%);
-webkit-overflow-scrolling: touch;
overflow-x: scroll;
border-radius: .5em;
border: 2px solid darkgray;
color: black;
white-space: pre;
max-width: 100%;
min-width: 50em;
padding: 1em;
}

Minetest.place schematic on vmanip

2023-08-05T22:01:57Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
<code>
local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
</code>

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

Template:Code

2023-08-05T22:01:24Z

Poetry: Blanked the page

Minetest.place schematic on vmanip

2023-08-05T22:00:40Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
The below snippet places the acacia tree from default at some terrain position with a random rotation when the data written at the voxelmanip index is dirt with dry grass. It

{{code
local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
end
end
end
end
}}

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

MediaWiki:Monobook.css

2023-08-05T21:59:18Z

Poetry:

/* All CSS here will be loaded for users of the MonoBook skin */

.mw-wiki-logo {
background-size: contain;
}

.mw-content-text, .mw-body-content {
font-size: 1.1em;
text-align: justify;
}

code {
display:block;
background: rgb(90%, 90%, 90%);
-webkit-overflow-scrolling: touch;
overflow-x: scroll;
border-radius: .5em;
border: 2px solid darkgray;
color: black;
white-space: pre;
max-width: 100%;
min-width: 50em;
padding: 1em;
}

Minetest.place schematic on vmanip

2023-08-05T21:55:07Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
The below snippet places the acacia tree from default at some terrain position with a random rotation when the data written at the voxelmanip index is dirt with dry grass. It

<code>
local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
end
end
end
end
</code>

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

Module:Arguments

2023-08-05T21:43:55Z

Poetry: Created page with "local p = {} function p.getArgs(frame, options) options = options or {} local metatable = {} function metatable:__index(key) local arg = frame.args[key] if arg == nil and options.inherited then local parent = frame:getParent() arg = parent and parent.args[key] or nil end return arg end return setmetatable({}, metatable) end function p.makeInvokeFunc(func, options) return function(frame)..."

local p = {}

function p.getArgs(frame, options)
options = options or {}
local metatable = {}
function metatable:__index(key)
local arg = frame.args[key]
if arg == nil and options.inherited then
local parent = frame:getParent()
arg = parent and parent.args[key] or nil
end
return arg
end
return setmetatable({}, metatable)
end

function p.makeInvokeFunc(func, options)
return function(frame)
local args = p.getArgs(frame, options)
if (options.passFrameParam) then
return func(frame, args)
end
return func(args)
end
end

return p

Template:Codenowiki&action=edit

2023-08-05T21:42:52Z

Poetry: Created page with "<onlyinclude><code>{{{{{|safesubst:}}}nowiki|{{{1}}}}}</code></onlyinclude> {{Documentation}}"

<onlyinclude><code>{{{{{|safesubst:}}}nowiki|{{{1}}}}}</code></onlyinclude>
{{Documentation}}

Minetest.place schematic on vmanip

2023-08-05T21:39:46Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
The below snippet places the acacia tree from default at some terrain position with a random rotation when the data written at the voxelmanip index is dirt with dry grass. It

<source>
local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
end
end
end
end
</source>

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

MediaWiki:Monobook.css

2023-08-05T21:38:44Z

Poetry:

/* All CSS here will be loaded for users of the MonoBook skin */

.mw-wiki-logo {
background-size: contain;
}

.mw-content-text, .mw-body-content {
font-size: 1.1em;
text-align: justify;
}

source {
display: block;
background: none;
white-space: pre;
-webkit-overflow-scrolling: touch;
overflow-x: scroll;
max-width: 100%;
min-width: 100px;
padding: 0;
}

Module:Lua banner

2023-08-05T21:36:27Z

Poetry: Created page with "-- This module implements the {{lua}} template. local yesno = require('Module:Yesno') local mList = require('Module:List') local mTableTools = require('Module:TableTools') local mMessageBox = require('Module:Message box') local TNT = require('Module:TNT') local p = {} local function format(msg) return TNT.format('I18n/Lua banner', msg) end local function getConfig() return mw.loadData('Module:Lua banner/config') end function p.main(frame) local origArgs = frame:g..."

-- This module implements the {{lua}} template.

local yesno = require('Module:Yesno')
local mList = require('Module:List')
local mTableTools = require('Module:TableTools')
local mMessageBox = require('Module:Message box')
local TNT = require('Module:TNT')

local p = {}

local function format(msg)
return TNT.format('I18n/Lua banner', msg)
end

local function getConfig()
return mw.loadData('Module:Lua banner/config')
end

function p.main(frame)
local origArgs = frame:getParent().args
local args = {}
for k, v in pairs(origArgs) do
v = v:match('^%s*(.-)%s*$')
if v ~= '' then
args[k] = v
end
end
return p._main(args)
end

function p._main(args, cfg)
local modules = mTableTools.compressSparseArray(args)
local box = p.renderBox(modules, cfg, args)
local trackingCategories = p.renderTrackingCategories(args, modules, nil, cfg)
return box .. trackingCategories
end

function p.renderBox(modules, cfg, args)
local boxArgs = {}
if #modules < 1 then
cfg = cfg or getConfig()
if cfg['allow_wishes'] or yesno(args and args.wish) then
boxArgs.text = format('wishtext')
else
boxArgs.text = string.format('%s', format('error_emptylist'))
end
else
local moduleLinks = {}
for i, module in ipairs(modules) do
moduleLinks[i] = string.format('[[:%s]]', module)
end
local moduleList = mList.makeList('bulleted', moduleLinks)
boxArgs.text = format('header') .. '\n' .. moduleList
end
boxArgs.type = 'notice'
boxArgs.small = true
boxArgs.image = string.format(
'[[File:Lua-logo-nolabel.svg|30px|alt=%s|link=%s]]',
format('logo_alt'),
format('logo_link')
)
return mMessageBox.main('mbox', boxArgs)
end

function p.renderTrackingCategories(args, modules, titleObj, cfg)
if yesno(args.nocat) then
return ''
end

cfg = cfg or getConfig()

local cats = {}

-- Error category
if #modules < 1 and not (cfg['allow_wishes'] or yesno(args.wish)) and cfg['error_category'] then
cats[#cats + 1] = cfg['error_category']
end

-- Lua templates category
titleObj = titleObj or mw.title.getCurrentTitle()
if titleObj.namespace == 10
and not cfg['subpage_blacklist'][titleObj.subpageText]
then
local category = args.category
if not category then
local pagename = modules[1] and mw.title.new(modules[1])
category = pagename and cfg['module_categories'][pagename.text]
if not category then
if (cfg['allow_wishes'] or yesno(args.wish)) and #modules < 1 then
category = cfg['wish_category']
else
category = cfg['default_category']
end
end
end
if category then
cats[#cats + 1] = category
end
end

for i, cat in ipairs(cats) do
cats[i] = string.format('[[Category:%s]]', cat)
end
return table.concat(cats)
end

return p

Module:Documentation

2023-08-05T21:34:45Z

Poetry: Created page with "-- This module implements {{documentation}}. -- Get required modules. local getArgs = require('Module:Arguments').getArgs local messageBox = require('Module:Message box') -- Get the config table. local cfg = mw.loadData('Module:Documentation/config') local i18n = mw.loadData('Module:Documentation/i18n') local p = {} -- Often-used functions. local ugsub = mw.ustring.gsub ---------------------------------------------------------------------------- -- Helper functions -..."

-- This module implements {{documentation}}.

-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local messageBox = require('Module:Message box')

-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
local i18n = mw.loadData('Module:Documentation/i18n')
local p = {}

-- Often-used functions.
local ugsub = mw.ustring.gsub

----------------------------------------------------------------------------
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------

local function message(cfgKey, valArray, expectType)
--[[
-- Gets a message from the cfg table and formats it if appropriate.
-- The function raises an error if the value from the cfg table is not
-- of the type expectType. The default type for expectType is 'string'.
-- If the table valArray is present, strings such as $1, $2 etc. in the
-- message are substituted with values from the table keys [1], [2] etc.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-type', cfgKey, expectType, type(msg)), 2)
end
if not valArray then
return msg
end

local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-empty', '$' .. match, cfgKey), 4)
end

local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end

p.message = message

local function makeWikilink(page, display)
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
end

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
end

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)
local ret = {}
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
return '(' .. table.concat(ret, ' | ') .. ')'
end

p.makeToolbar = makeToolbar

----------------------------------------------------------------------------
-- Argument processing
----------------------------------------------------------------------------

local function makeInvokeFunc(funcName)
return function (frame)
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == 'heading' or value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
return p[funcName](args)
end
end

----------------------------------------------------------------------------
-- Load TemplateStyles
----------------------------------------------------------------------------

p.main = function(frame)
local parent = frame.getParent(frame)
local output = p._main(parent.args)
return frame:extensionTag{ name='templatestyles', args = { src= message('templatestyles-scr') } } .. output
end

----------------------------------------------------------------------------
-- Main function
----------------------------------------------------------------------------

function p._main(args)
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--
-- Messages:
-- 'main-div-id' --> 'template-documentation'
-- 'main-div-classes' --> 'template-documentation iezoomfix'
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
:wikitext(p._getModuleWikitext(args, env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
:tag('div')
:attr('id', message('main-div-id'))
:addClass(message('main-div-class'))
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:done()
:wikitext(p._endBox(args, env))
:wikitext(p.addTrackingCategories(env))
return tostring(root)
end

----------------------------------------------------------------------------
-- Environment settings
----------------------------------------------------------------------------

function p.getEnvironment(args)
--[[
-- Returns a table with information about the environment, including title objects and other namespace- or
-- path-related data.
-- @args - table of arguments passed by the user
--
-- Title objects include:
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
-- env.printTitle - the print version of the template, located at the /Print subpage.
--
-- Data includes:
-- env.protectionLevels - the protection levels table of the title object.
-- env.subjectSpace - the number of the title's subject namespace.
-- env.docSpace - the number of the namespace the title puts its documentation in.
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]

local env, envFuncs = {}, {}

-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- more than once. (Nils won't be memoized.)
setmetatable(env, {
__index = function (t, key)
local envFunc = envFuncs[key]
if envFunc then
local success, val = pcall(envFunc)
if success then
env[key] = val -- Memoise the value.
return val
end
end
return nil
end
})

function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end

function envFuncs.templateTitle()
--[[
-- The template (or module, etc.) title object.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end

function envFuncs.docTitle()
--[[
-- Title object of the /doc subpage.
-- Messages:
-- 'doc-subpage' --> 'doc'
--]]
local title = env.title
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
end
return mw.title.new(docpage)
end

function envFuncs.sandboxTitle()
--[[
-- Title object for the /sandbox subpage.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end

function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end

function envFuncs.printTitle()
--[[
-- Title object for the /Print subpage.
-- Messages:
-- 'print-subpage' --> 'Print'
--]]
return env.templateTitle:subPageTitle(message('print-subpage'))
end

function envFuncs.protectionLevels()
-- The protection levels table of the title object.
return env.title.protectionLevels
end

function envFuncs.subjectSpace()
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
end

function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the same as the
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
return subjectSpace + 1
else
return subjectSpace
end
end

function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- For some namespaces this is the talk page, rather than the template page.
local templateTitle = env.templateTitle
local docSpace = env.docSpace
local docSpaceText = mw.site.namespaces[docSpace].name
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
return docSpaceText .. ':' .. templateTitle.text
end

function envFuncs.compareUrl()
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
if templateTitle.exists and sandboxTitle.exists then
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
else
return nil
end
end

return env
end

----------------------------------------------------------------------------
-- Auxiliary templates
----------------------------------------------------------------------------

p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')

function p._getModuleWikitext(args, env)
local currentTitle = mw.title.getCurrentTitle()
if currentTitle.contentModel ~= 'Scribunto' then return end
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care
local moduleWikitext = package.loaded["Module:Module wikitext"]
if moduleWikitext then
return moduleWikitext.main()
end
end

function p.sandboxNotice(args, env)
--[=[
-- Generates a sandbox notice for display above sandbox pages.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
-- 'sandbox-notice-pagetype-template' --> '[[w:Wikipedia:Template test cases|template sandbox]] page'
-- 'sandbox-notice-pagetype-module' --> '[[w:Wikipedia:Template test cases|module sandbox]] page'
-- 'sandbox-notice-pagetype-other' --> 'sandbox page'
-- 'sandbox-notice-compare-link-display' --> 'diff'
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'
-- 'sandbox-notice-testcases-link-display' --> 'test cases'
-- 'sandbox-category' --> 'Template sandboxes'
--]=]
local title = env.title
local sandboxTitle = env.sandboxTitle
local templateTitle = env.templateTitle
local subjectSpace = env.subjectSpace
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
return nil
end
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
local omargs = {}
omargs.image = message('sandbox-notice-image')
-- Get the text. We start with the opening blurb, which is something like
-- "This is the template sandbox for [[Template:Foo]] (diff)."
local text = ''
local frame = mw.getCurrentFrame()
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
local pagetype
if subjectSpace == 10 then
pagetype = message('sandbox-notice-pagetype-template')
elseif subjectSpace == 828 then
pagetype = message('sandbox-notice-pagetype-module')
else
pagetype = message('sandbox-notice-pagetype-other')
end
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
if isPreviewing or not compareUrl then
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
else
local compareDisplay = message('sandbox-notice-compare-link-display')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
end
-- Get the test cases page blurb if the page exists. This is something like
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
else
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. ' ' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
end
end
-- Add the sandbox to the sandbox category.
text = text .. makeCategoryLink(message('sandbox-category'))
omargs.text = text
omargs.class = message('sandbox-class')
local ret = '<div style="clear: both;"></div>'
ret = ret .. messageBox.main('ombox', omargs)
return ret
end

function p.protectionTemplate(env)
-- Generates the padlock icon in the top right.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
local title = env.title
local protectionLevels
local protectionTemplate = message('protection-template')
local namespace = title.namespace
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then
-- Don't display the protection template if we are not in the template or module namespaces.
return nil
end
protectionLevels = env.protectionLevels
if not protectionLevels then
return nil
end
local editLevels = protectionLevels.edit
local moveLevels = protectionLevels.move
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then
-- The page is full-move protected, or full, template, or semi-protected.
local frame = mw.getCurrentFrame()
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
else
return nil
end
end

----------------------------------------------------------------------------
-- Start box
----------------------------------------------------------------------------

p.startBox = makeInvokeFunc('_startBox')

function p._startBox(args, env)
--[[
-- This function generates the start box.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
-- which generate the box HTML.
--]]
env = env or p.getEnvironment(args)
local links
local content = args.content
if not content then
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
if linksData then
links = p.renderStartBoxLinks(linksData)
end
end
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
-- User specified no heading.
return nil
end
end

function p.makeStartBoxLinksData(args, env)
--[[
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'view-link-display' --> 'view'
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'purge-link-display' --> 'purge'
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'create-link-display' --> 'create'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local docTitle = env.docTitle
if not title or not docTitle then
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end

local data = {}
data.title = title
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = i18n['view-link-display']
data.editLinkDisplay = i18n['edit-link-display']
data.historyLinkDisplay = i18n['history-link-display']
data.purgeLinkDisplay = i18n['purge-link-display']
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 6 then -- File namespace
preload = message('file-docpage-preload')
elseif subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end
data.preload = preload
data.createLinkDisplay = i18n['create-link-display']
return data
end

function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create] links from the data table.
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]

local function escapeBrackets(s)
-- Escapes square brackets with HTML entities.
s = s:gsub('%[', '[') -- Replace square brackets with HTML entities.
s = s:gsub('%]', ']')
return s
end

local ret
local docTitle = data.docTitle
local title = data.title
if docTitle.exists then
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
else
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
ret = '[%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, createLink)
end
return ret
end

function p.makeStartBoxData(args, env, links)
--[=[
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
--
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
--]=]
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
local data = {}

-- Heading
local heading = args.heading -- Blank values are not removed.
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
if heading then
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = i18n['template-namespace-heading']
elseif subjectSpace == 828 then -- Module namespace
data.heading = i18n['module-namespace-heading']
elseif subjectSpace == 6 then -- File namespace
data.heading = i18n['file-namespace-heading']
else
data.heading = i18n['other-namespaces-heading']
end

-- Data for the [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message('start-box-linkclasses')
data.linksId = message('start-box-link-id')
data.links = links
end

return data
end

function p.renderStartBox(data)
-- Renders the start box html.
-- @data - a table of data generated by p.makeStartBoxData.
local sbox = mw.html.create('div')
sbox
:addClass(message('header-div-class'))
:tag('div')
:addClass(message('heading-div-class'))
:wikitext(data.heading)
local links = data.links
if links then
sbox
:tag('div')
:addClass(data.linksClass)
:attr('id', data.linksId)
:wikitext(links)
end
return tostring(sbox)
end

----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------

p.content = makeInvokeFunc('_content')

function p._content(args, env)
-- Displays the documentation contents
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
local content = args.content
if not content and docTitle and docTitle.exists then
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle}
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
local cbox = mw.html.create('div')
cbox
:addClass(message('content-div-class'))
:wikitext('\n' .. (content or '') .. '\n')
return tostring(cbox)
end

p.contentTitle = makeInvokeFunc('_contentTitle')

function p._contentTitle(args, env)
env = env or p.getEnvironment(args)
local docTitle = env.docTitle
if not args.content and docTitle and docTitle.exists then
return docTitle.prefixedText
else
return ''
end
end

----------------------------------------------------------------------------
-- End box
----------------------------------------------------------------------------

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)
--[=[
-- This function generates the end box (also known as the link box).
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--]=]

-- Get environment data.
env = env or p.getEnvironment(args)
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
end

-- Check whether we should output the end box at all. Add the end
-- box by default if the documentation exists or if we are in the
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
end

-- Assemble the footer text field.
local text = ''
if linkBox then
text = text .. linkBox
else
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
-- We are in the user, template or module namespaces.
-- Add sandbox and testcases links.
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. (p.makeExperimentBlurb(args, env) or '')
text = text .. ' '
if not args.content and not args[1] then
-- "Please add categories to the /doc subpage."
-- Don't show this message with inline docs or with an explicitly specified doc page,
-- as then it is unclear where to add the categories.
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
if printBlurb then
text = text .. ' ' .. printBlurb
end
end
end

local ebox = mw.html.create('div')
ebox
:addClass(message('footer-div-class'))
:wikitext(text)
return tostring(ebox)
end

function p.makeDocPageBlurb(args, env)
--[=[
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[w:Wikipedia:Template documentation|documentation]]
-- is [[w:Wikipedia:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[w:Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle or args.content then
return nil
end
local ret
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = i18n['edit-link-display']
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = i18n['history-link-display']
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. ' '
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = i18n['create-link-display']
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. ' '
end
return ret
end

function p.makeExperimentBlurb(args, env)
--[[
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'sandbox-link-display' --> 'sandbox'
-- 'sandbox-edit-link-display' --> 'edit'
-- 'compare-link-display' --> 'diff'
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'sandbox-create-link-display' --> 'create'
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
-- 'mirror-link-display' --> 'mirror'
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
-- 'sandbox-link-display' --> 'sandbox'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display'--> 'edit'
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-link-display' --> 'testcases'
-- 'testcases-edit-link-display' --> 'edit'
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('module-sandbox-preload')
else
sandboxPreload = message('template-sandbox-preload')
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
else
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
if subjectSpace == 828 then
messageName = 'experiment-blurb-module'
else
messageName = 'experiment-blurb-template'
end
return message(messageName, {sandboxLinks, testcasesLinks})
end

function p.makeCategoriesBlurb(args, env)
--[[
-- Generates the text "Please add categories to the /doc subpage."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end

function p.makeSubpagesBlurb(args, env)
--[[
-- Generates the "Subpages of this template" link.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'template-pagetype' --> 'template'
-- 'module-pagetype' --> 'module'
-- 'default-pagetype' --> 'page'
-- 'subpages-link-display' --> 'Subpages of this $1'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
pagetype = message('default-pagetype')
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end

function p.makePrintBlurb(args, env)
--[=[
-- Generates the blurb displayed when there is a print version of the template available.
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
-- Messages:
-- 'print-link-display' --> '/Print'
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]'
-- .. ' of this template exists at $1.'
-- .. ' If you make a change to this template, please update the print version as well.'
-- 'display-print-category' --> true
-- 'print-category' --> 'Templates with print versions'
--]=]
local printTitle = env.printTitle
if not printTitle then
return nil
end
local ret
if printTitle.exists then
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display'))
ret = message('print-blurb', {printLink})
local displayPrintCategory = message('display-print-category', nil, 'boolean')
if displayPrintCategory then
ret = ret .. makeCategoryLink(message('print-category'))
end
end
return ret
end

----------------------------------------------------------------------------
-- Tracking categories
----------------------------------------------------------------------------

function p.addTrackingCategories(env)
--[[
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment

-- Messages:
-- 'display-strange-usage-category' --> true
-- 'doc-subpage' --> 'doc'
-- 'testcases-subpage' --> 'testcases'
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
--
-- /testcases pages in the module namespace are not categorised, as they may have
-- {{documentation}} transcluded automatically.
--]]
local title = env.title
local subjectSpace = env.subjectSpace
if not title or not subjectSpace then
return nil
end
local subpage = title.subpageText
local ret = ''
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
ret = ret .. makeCategoryLink(message('strange-usage-category'))
end
return ret
end

return p

Module:Lua

2023-08-05T21:31:25Z

Template:Lua

2023-08-05T21:29:00Z

Poetry: Created page with "<onlyinclude><includeonly>{{#invoke:Lua banner|main}}</includeonly></onlyinclude> {{Lua|Module:Lua banner}} {{Documentation}} "

<onlyinclude><includeonly>{{#invoke:Lua banner|main}}</includeonly></onlyinclude>
{{Lua|Module:Lua banner}}
{{Documentation}}

Template:Documentation

2023-08-05T21:28:17Z

Poetry: Created page with "<noinclude> <languages/> </noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude> {{documentation|content= {{Lua|Module:Documentation}} <translate> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate> <translate> It is intended for pages which are <tvar name=..."

<noinclude>
<languages/>
</noinclude><includeonly>{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}</includeonly><noinclude>
{{documentation|content=

{{Lua|Module:Documentation}}
<translate> This template automatically displays a documentation box like the one you are seeing now, of which the content is sometimes transcluded from another page.</translate>
<translate> It is intended for pages which are [[<tvar name=1>Special:MyLanguage/Help:Transclusion</tvar>|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.</translate>

<translate>
==Usage== 

===Customizing display=== 


Overrides exist to customize the output in special cases:
</translate>
* <nowiki>{{</nowiki>documentation{{!}}'''heading'''=<nowiki>}}</nowiki> - <translate> change the text of the "documentation" heading.</translate> <translate> If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.</translate>

Minetest.place schematic on vmanip

2023-08-05T21:26:56Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
The below snippet places the acacia tree from default at some terrain position with a random rotation when the data written at the voxelmanip index is dirt with dry grass. It

{{code
local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
end
end
end
end
}}

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

Minetest.place schematic on vmanip

2023-08-05T21:26:13Z

Poetry:

{{UnofficialLua}}
{{DISPLAYTITLE:minetest.place_schematic_on_vmanip}}
== Syntax ==
<source>minetest.place_schematic_on_vmanip(vm, pos, schematic, rotation, replacements, force_placement)</source>

== Description ==
This method works in a similar fashion to minetest.place_schematic, but can be used with a [[VoxelManip]] for better performance when manipulating large amounts of nodes.

* Uses VoxelManip object vm, which is the voxel manipulator you are using to e.g. generate terrain
* Places the schematic specified by schematic (see: Schematic specifier) at pos.
* Rotation can be "0", "90", "180", "270", or "random".
* If the rotation parameter is omitted, the schematic is not rotated.
* replacements = {["old_name"] = "convert_to", ...}
* force_placement is a boolean indicating whether nodes other than air and ignore are replaced by the schematic
 
{{Template:Note|Schematics are volumes and the position where you place the schematic is the corner of the schematic. If for example you have a 5 by 5 by 5 schematic of a tree whose trunk is in the middle, you will need to offset the x and z position by -2. If you don't, you risk misplacing the tree causing them to float in the air or be generated inside blocks on e.g. steep slopes.}}

== Example ==
The below snippet places the acacia tree from default at some terrain position with a random rotation when the data written at the voxelmanip index is dirt with dry grass. It
{{code
local data = {}
local vm, emin, emax = minetest.get_mapgen_object("voxelmanip")
local area = VoxelArea:new({MinEdge = emin, MaxEdge = emax})
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
for y = minp.y-1, maxp.y+1 do
-- E.g. terrain generation code here
end
end
end
-- Decoration
for z = minp.z, maxp.z do
for x = minp.x, maxp.x do
local ivm = area:index(x, minp.y-1, z)
for y = minp.y-1, maxp.y+1 do
if data[ivm] == minetest.get_content_id("default:dirt_with_dry_grass") and math.random(0, 500) then
-- We place the tree if there is grass with dirt, but we could also have retrieved the y from the
-- terrain heightmap in which case we would not necessarily have to loop from minp.y to maxp.y again
minetest.place_schematic_on_vmanip(vm, { x = x - 4, y = y, z = z - 4},
minetest.get_modpath("default").."/schematics/acacia_tree.mts",
"random", nil, false)
end
end
end
end
}}

 
{{Template:Note|If you place schematics while performing the vmanip of e.g. the terrain from negative y to positive y, you may need to separate your terrain generation loop from the schematic placement loop or risk the schematics to be overwritten}}

[[Category:Methods|p]]

Template:Code

2023-08-05T21:24:48Z

Poetry: Created page with "{{#if:{{{inline|}}}|<code {{#if:{{{class|}}}|class="{{{class}}}"}} {{#if:{{{id|}}}|id="{{{id}}}"}} {{#if:{{{style|}}}|style="{{{style}}}"}}>{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|lang="{{{lang|{{{2|text}}}}}}"|inline=true}}</code>|{{#if:{{{header|}}}|{{{header}}}}}{{#tag:syntaxhighlight |{{{code|{{{1}}}}}} |lang={{{lang|{{{2|bash}}}}}} }}}}<noinclude> {{documentation}} </noinclude>"

{{#if:{{{inline|}}}|<code {{#if:{{{class|}}}|class="{{{class}}}"}} {{#if:{{{id|}}}|id="{{{id}}}"}} {{#if:{{{style|}}}|style="{{{style}}}"}}>{{#tag:syntaxhighlight|{{{code|{{{1}}}}}}|lang="{{{lang|{{{2|text}}}}}}"|inline=true}}</code>|{{#if:{{{header|}}}|{{{header}}}}}{{#tag:syntaxhighlight
|{{{code|{{{1}}}}}}
|lang={{{lang|{{{2|bash}}}}}}
}}}}<noinclude>
{{documentation}}
</noinclude>

MediaWiki:Sidebar

2023-08-05T05:34:01Z

Poetry:

* keepthisline
* navigation
** mainpage|mainpage-description
** recentchanges-url|recentchanges
** randompage-url|randompage
* API
** Modding_Intro|Modding Intro
* Engine
** Engine|Engine Intro
** Changelog|Changelog
** All_rules_regarding_to_development|All dev rules
* links
** https://minetest.org/|Final Minetest
** https://minetest.io/|Minetest.IO
** https://git.minetest.io/|9,000 git repos
** https://edgy1.net/|EdgyNet
** https://irc.minetest.org:9000/#/connect|CoderNet chat
** https://minetest.org/bucketsrc/|Bucket Source
** https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents|MediaWiki help
* SEARCH
* TOOLBOX
* LANGUAGES

MediaWiki:Monobook.css

2023-08-05T05:26:05Z

Poetry: Created page with "/* All CSS here will be loaded for users of the MonoBook skin */ .mw-wiki-logo { background-size: contain; } .mw-content-text, .mw-body-content { font-size: 1.1em; text-align: justify; }"

/* All CSS here will be loaded for users of the MonoBook skin */

.mw-wiki-logo {
background-size: contain;
}

.mw-content-text, .mw-body-content {
font-size: 1.1em;
text-align: justify;
}

Main Page

2023-08-05T05:15:57Z

Poetry:

Welcome to the '''Minetest Developer Wiki''', here you learn how Minetest and games and mods for Minetest are developed.

'''Minetest''' is a [https://en.wikipedia.org/wiki/Game_engine game engine] inspired by Minecraft, Infiniminer and others. It's licensed under the GNU LGPL 2.1, with artwork generally covered by CC BY-SA 3.0. There are two major parts to the system, the first being a [[Engine structure|core engine]] written in C++, the second being a modding API that exposes useful functions to a Lua environment.

The Minetest Wiki for players is located at [https://wiki.minetest.net/ wiki.minetest.net].

{{Contributor Call to Action}}

{{Main Content Links}}

[[Category:Root-Category]]

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]

Main Page

2023-08-05T05:12:28Z

Poetry:

{{Languages}}

Welcome to the '''Minetest Developer Wiki''', here you learn how Minetest and games and mods for Minetest are developed.

'''Minetest''' is a [https://en.wikipedia.org/wiki/Game_engine game engine] inspired by Minecraft, Infiniminer and others. It's licensed under the GNU LGPL 2.1, with artwork generally covered by CC BY-SA 3.0. There are two major parts to the system, the first being a [[Engine structure|core engine]] written in C++, the second being a modding API that exposes useful functions to a Lua environment.

The Minetest Wiki for players is located at [https://wiki.minetest.net/ wiki.minetest.net].

{{Contributor Call to Action}}

{{Main Content Links}}

[[Category:Root-Category]]

== Getting started ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]