Guide to Creating a New Tutorial

From CryWiki

This guide will focus on the techinical aspects of creating a new tutorial.

Parts of a Tutorial

Every tutorial should have the following:

• Summary
• "About this Tutorial" Box
• Prerequisites
• Steps
• Conclusion
• See Also

Creating the Underlying Article

Note: Please capitalize all words except for conjunctions (an, it, to, a ... etc)

This will tell the Wiki to create the page with the name

Introducing the basics

Please skip this if you're already well versed in editing a Wiki.

Now, you should see a big textbox. This textbox contains the article in its editable state.You can write your tutorial in the textbox, as well as include special phrases that the wiki understands. These special phrases are called WikiText

We are now going to include some WikiText that every tutorial needs to look right and function properly.

Creating the Information Box

The information box is an area on the right side of all tutorials that gives basic information about it.

{{{1}}}

Substitute the author's name for (Authors), the editors' names for (Editors), the current date for (Update Date), and the version of Crysis you are using for (Compatibility). Crysis with no patch should be called 1.0.

Writing a Summary

The summary should describe the tutorial's purpose, what it applies to, and any information that would be helpful to the reader before he starts the tutorial.

Writing a Prerequisites

The prerequisite section includes things that should have been completed before using the tutorial. Usually, prerequisites include Sandbox2 properly installed and configured.

{{{1}}}

This creates the Prerequisites section. The 2 '==' on either side make the text "Prerequisites" a section heading. This section heading has to be on its own line, with nothing else on its line.

Now you should have

{{{1}}}

Dividing your tutorial into sections

As with the section heading in Prerequisites, a == on each side of text in a line marks the text as a section heading. Use thses to divide your tutorial into sections.

Create a section for each major idea. A section header should generally include some information right below it summarizing the section and/or provide useful background information.

Writing steps

Each tutorial is made up of many steps. A step is a distinct action that the reader must do to move on. Don't clump actions together into one step. Try to be concise and accurate. Addition information may be added after the step.

{{{1}}}

The {{Step... wikitext will format your step according to CryWiki standards.

For example, the following creates a Step numbered 9999 and with the text "My Step"

{{{1}}}

Writing a Conclusion

A conclusion should summarize what the reader has achieved and learned. You may also give further direction for the reader to take.

{{{1}}}

Setting up the category !!!VERY IMPORTANT!!!

A category allows the page to be easily indexed into the tutorial list. Without one, most likely no one will ever see or read your tutorial.

If your level is a Level Creation tutorial, please include the following at the bottom of your tutorial:

{{{1}}}

If your level is a Flowgraph tutorial, please include the following at the bottom of your tutorial:

{{{1}}}

Writing a See also

A See also leads the reader to related articles.

{{{1}}}

{{{1}}}

For example, to link to the main page, append this:

{{{1}}}

This will produce the following Main Page