Writing conventions

Summary

To ensure the community Wiki is consistent, please follow the writing conventions as stated below.

Conventions

When to use Upper case

Device names are always written with the first letter capitalized of each word, e.g. Advanced Perlin (link missing). This is also the case for Wiki, World Machine, and data types, e.g. Water Data Type (link missing).

Emphasis

Bold and cursive text can improve the legibility of your text, by laying emphasis on important words. For example, when describing a workflow in which it is adamant one device should be placed after the other, you can choose to lay emphasis on the word after. It is, however, important to not overdo it, as illustrated below.

Do not overuse bold and cursive emphasis, as this will impact legibility dramatically, and also reduce the weight of each emphasis.

So instead, write it like so:

Do not overuse bold and cursive emphasis, as this will impact legibility dramatically, and also reduce the weight of each emphasis.

Use headings (and Markdown in general)

Headings help you create hierarchy in your text. Use it to indicate when a new section begins, like the summary, or conclusion of an article. The Discourse forum supports an adapted form of the Markdown notation, you can explore this live demo.

The missing link

It is great to have a tightly intertwined Wiki, but not always is there already an article written on the topic you wish to link to. Make this clear to other users, by adding (link missing) after the word/text you wishes to link to another article.

Parameters, GUI elements, and extensions

Use an inline code block to demarcate parameters, GUI elements, and extensions, for example .tmd. This makes it stand out from the rest of the text, and is especially nice when a parameter is hidden in a long paragraph. It is now also clear you mean the Clear button, instead of having a weird sentence using the word clear twice in a strange manner.

Code blocks

Use code blocks when writing multiple lines of code. These also allow for syntax highlighting! For example:

<div id="codeBlockExample">
  This is neat.
</div>

Quoting

To quote or not to quote, that’s the question

Use quotes when either quoting another article, an external source (link!) or when writing an example that should clearly stand out from the text, and not be read as text (like above). When quoting another user, you can first select their text, and then use the Copy Quote button which will appear automatically. When pasting the quote in your text, it will now also credit the writer of that quote, and link to the original post.

Hiding details

Sometimes, it is best to collapse some text, to improve overall legibility. It is, for example, not really needed to explain how Perlin noise works, but it is cool to give a bit more detail. Consider using a [details] block for that.

Summary

This text will be hidden.

3 Likes