How to help with enGrid's wiki

This page might still be incomplete...

Table of Contents Instructions Licenses for the wiki content Notes about transferring Mediawiki pages Mediawiki images

Instructions

You need an account at GitHub and possibly you'll need enGits' permission for editing, for which you can contact ogloth.

Formats used on the wiki can be seen here: GitHub's Gollum

In the following chapters are additional notes about writing wiki pages that are valid in GitHub's wiki system.

Licenses for the wiki content

By default, this wiki uses the same license used in the original enGrid wiki, namely: GNU Free Documentation License 1.3.

If you write a page here on the wiki that you don't want to use this particular license, you'll have to disclaim said license in one first chapters or in the header section of that particular page. Please do not use closed access licenses, or your hard written pages will simply be deleted.

Notes about transferring Mediawiki pages

The Mediawiki format supported by GitHub's Gollum (the wiki rendering engine) is not exactly identical to the one that the official Mediawiki system uses. Known issues:

• The Image:file_name.jpg and similar links only work partially. If you try to use the more complex structures, they are unlikely to work as intended. This is why a guideline has been created for enGrid's wiki: Mediawiki images.
• Mediawiki definitions have to be done like this:

; the thing to define
: The definition

• Links to anchors in a GitHub generated wiki page have to be done like this:

[[How to help with enGrid's wiki#wiki-Mediawiki_images|Mediawiki images]]

Yes, they're dumb. You have to use the full page's name and then for the anchor reference you have to use `wiki-` as a prefix, as well has have underscores for the anchor name.

Mediawiki images

Mediawiki format template for images:

<center>
{| width="600px"
|| <a id="Figure-1" href="images/image_file.extension">
[[images/image_file.extension|width=600px]]</a> 
|-
|| Figure 1: Here you can place any text.
|}
</center>

Example below can be seen here:

<center>
{|
|| <a id="Figure-5" href="images/tutorial_01_06.png">
[[images/tutorial_01_06.png|width=500px]]</a> 
|-
|| Figure 5: Create Surface Mesh - You can copy from the code below:
<pre>
damper_top = 0.05;
damper_bottom = 0.05;
damper_left = 0.05;
damper_right = 0.05;
damper_back = 0.05;
</pre>
|}
</center>

The link for this particular example of Figure 5 is this:

[[Complete Mesh for a damper in a duct (starting from an STL geometry)#wiki-Figure-5|Figure 5]]