>Rubenwardy at 20:13, 18 June 2020

2020-06-18T20:13:40Z

New page

== Normal prose ==

Use paragraphs, represented in MediaWiki by two line breaks (i.e. hit enter twice), as opposed to single line breaks to separate text.

Don't put line breaks in the middle of a line in the source code. It might make it easier to read momentarily, but it has no real semantic meaning to the wiki, so there's no reason to do it.

== Links and article names ==

Articles' names shouldn't all be capitalized. These aren't research papers or book titles, they're just pages to let people know what's happening in the project.

== Source code ==

Indent source code with tab character.

Put spaces before and after binary operators, don't put spaces after unary operators (<source enclose="none">local b = -a + 3 * (c - a) / 2</source>)

== Syntax highlighting ==
<pre><source>
-- Some code
function minetest.string_to_privs(str, delim)
assert(type(str) == "string")
delim = delim or ','
privs = {}
for _, priv in pairs(string.split(str, delim)) do
privs[priv:trim()] = true
end
return privs
end
</source></pre>

<source>
-- Some code
function minetest.string_to_privs(str, delim)
assert(type(str) == "string")
delim = delim or ','
privs = {}
for _, priv in pairs(string.split(str, delim)) do
privs[priv:trim()] = true
end
return privs
end
</source>

<pre><source enclose="none">assert(type(str) == "string")</source></pre>

<source enclose="none">assert(type(str) == "string")</source>

== [casting] ==
<pre>add_item("listname", stack)</pre> → <source enclose="none">add_item("listname", stack)</source> (link points to [[EnvRef:add_item]])

<pre>[InvRef]add_item("listname", stack)</pre> → <source enclose="none">[InvRef]add_item("listname", stack)</source> (link is made to point to [[InvRef:add_item]])

You should use casting for those methods:
* <code>add_item</code>
* <code>get_inventory</code>
* <code>is_empty</code>
* <code>to_table</code>

== Method template ==
<pre>
{{DISPLAYTITLE:minetest.new_awesome_method}}
== Syntax ==
<source>minetest.new_awesome_method("string", {table}, variable)</source>

== Description ==
* <code>variable</code> — the most important variable in call

Do something.

== Example ==
<source>
minetest.new_awesome_method("lol", {wtf}, 42)
</source>

</pre>

Old MT Dev:Style Guide - Revision history

>Rubenwardy at 20:13, 18 June 2020