Conventions used

this page has been migrated to our new wiki site

This page is to explain the layout and conventions we us in the GIMP tutorials so that we have consistancy across all tutorials.

Sections of the tutorial

On the first line please write what version of GIMP you tested this tutorial on. This allows people reading it to know if it can be used on their version. It also allows us to test the tutorial on future versions of GIMP and note and or update the tutorial for any differences.

This tutorial was last tested for the Gimp 2.2.13

The next is a first level heading called "Overview". Here is where you give a general description of the tutorial and what the effect / technique achieves. It is a good idea to also have a before and after iamge as well.

+ Overview

The third part is the "Prerequisites" section. If GIMP has everything it needs to follow the tutorials by default then just put "None". If the user needs to have a plugin or script installed then list that here. Do not write up how to install the plugin/script in your tutorial. If there is not one already, create a seperate page for the install and link to it from this section.

+ Prerequisites

The next section is the nuts and guts of the tutorial called "Steps". This is where you detail the exact steps that the user has to take. A good idea is to include both the menu selections and a screenshot of the shortcut icon.

+ Steps

The section after the Steps is "Tips". This is where you can put various bits of information that are not a main step. They can be variations on the main tutorial that are not different enough to warrant their own tutorial.

+ Tips

Add a link back to the main GIMP resources page.

+++++ Back to the [[[GIMP resources]]] page

The last section is the comments module.

[[module Comments]]

Guidlines for mark up

Steps

Make sure you use the automatic numbering system of the wiki. This makes it much easier to add or remove steps at a later date. If one of the steps require further substeps then use the numbering system, if it just requires some explaination points then using bulleting.

# Step one
# Step two
 # Step 2.1, notice the space in front of the hash
# Step three
 * Bullet 3.1, make sure the bullets have a space in front as well, this stops the numbering system from restarting.
 * Bullet 3.2
# Step four

Menu selections

When specifying the menu selections the convention is to use the window they use to select it (<Image> or <Toolbox>) then a forward slash (/) then the next menu selection then another forward slash etc. When marking up the text please bold the menu selection (eg <Image> / Layer / Transform / Arbitrary Rotation

**<Image> / Layer / Transform / Arbitrary Rotation**

Screenshot insertion

If you insert a screenshot during one of the steps it will restart the numbering system, that is not acceptable. To avoid the number restart all you need to do is put a space and then an underscore at the end of the previous line.

.....in the angle. _
[[image http://static.flickr.com/130/322026863_6990ac703e_o_d.jpg]]
# Go to....

I have created a Tutorial Template page so you can see what the code looks like.

Back to the GIMP resources page
Add a New Comment
Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-Share Alike 2.5 License.