Help:New editors

All members of the forum at simplemachines.org can edit this wiki, as long as you have made at least ten posts. Do not worry about making mistakes as it is easy to reverse changes if necessary - everything is logged in the history of each page.

We recommend discussing your ideas with others in the Doc Helpers board on the SMF forum.

Wiki Basics

• When editing the wiki, please follow the Documentation Guidelines.
• Instead of having a topic and replies, the wiki has articles and versions.
• When you use Edit, you are creating a new version. The older versions never get changed.
• You can always see the older versions using the History button. You can even compare versions.
• Don't worry about editing "at the same time" as somebody else. The wiki will warn you if someone else has edited the same article while you were working, and give you a chance to merge your changes.
• If a wiki page has translated versions (you will see a list of languages at the top of the page), please discuss any substantial changes in the Doc Helpers board. This is because we try to keep these pages as stable as possible to make life easier for the translators. On the other hand, if you just want to make small corrections to the grammar and spelling, then you do not have to discuss this because it will not affect the translations.
• Please do not create new pages with ? or & in the title -- they confuse the webserver.

Searching for an Article, or for help writing Articles

Just type something into the search box, and hit the search button. If you start at one of the SMF manual content pages, like the Main Page, the results will usually be limited to the content pages. So if you are looking for something in another "namespace" -- like help, or the "how-to" pages for people working on the online manual, you can use one of the links you'll see when you land on the search page. "Everything" will make sure you don't leave anything out.

Editing an existing article

If you can see the Edit button above an article, you have permission to edit it. During editing, you will find the following features:

• Wiki editing buttons (Bold, Italic, Underline, External Link, Level 2 Heading, Picture, File, Math, <nowiki>, signature, and horizontal line) above the editing box.
• The editing box, where you type the article.
• The Summary box, where you briefly explain your changes.
• The Editing help link below the editing box for more information on wiki formatting.
• 'Show changes to compare your new version to the previous one.
• Show preview to see how your version is progressing.
• Save page to save your new version.

Starting a new article

• Type the new article title into the wiki search box, and hit the Go button. If an article with that title does not already exist, the wiki will offer up a red link to create that article. Follow that red link and get started on the new article.
• While working on another article, create a wikilink to the new wiki article. The next time you preview or save, you will see a red link to that new article. Follow that red link and get started on the new article.

Wikilinks and wiki formatting

BBCode can not be used for formatting the wiki articles. You will need to familiarize yourself with wiki code. One really nice wiki formatting feature is the automatic table of contents -- every time you use a == to make a heading, it gets added to the table of contents. You'll find more about links and formatting when you follow the Editing help link at the bottom of every editing page.

Some things that work anywhere on the page:

• A wikilink -- a link within the wiki: [[Name of article]] also see Links
• An external link -- a link to some place else [http://simplemachines.org]
• ''italic'', '''bold''', and '''''bold italic''''' text
• Pictures [[File:Yes_check.png|thumb]], but only if they are already on the wiki.
• Upload pictures to the wiki

Some things that only work at the start of a line:

• Section headings -- == Level 2 ==, ===Level 3===, etc. Please do not use Level 1 headings.
• Lists. Just start the line with a '*' to create a bullet, '#' to create a number, and double them up '**' to create indented lists.

Images on the wiki

If you've read above how to put picture in your document, you've noticed that all images used in the wiki must be found on the wiki. Also see Images

A new picture

Here's how to upload a new picture to the wiki:

• On the left side of the wiki page, under Toolbox, find the upload file link. Follow the directions.

Updating an existing picture

• While viewing the picture in a document, click on it.
• On the image page, find the Upload a new version of this file link.
• Follow the instructions to upload a new file from your desktop. The new file must have the same file extension as the old one.