Help:Manual

From e107 Wiki
Jump to: navigation, search
This article is under development by the admins. If you have any suggestions, please bring them up on this article's talk page.


Contents

Introduction

Please follow these guidelines when working on this wiki.

Syntax

There are several syntax references available:

Namespaces and Categories

We have created certain namespaces and categories for use when creating e107 wiki pages, to enable the pages to be listed in the correct place and to have a convention so it's immediately obvious what these pages are for and to keep naming schemes tidy. These are as follows;

  • How To Guides - these guides should include [[Category:HOWTOs]] somewhere in the markup so they are listed in the Category page and should use the 'HOWTO' namespace - i.e. the page name should be 'HOWTO:<pagename>'.
  • Development Pages - these pages should include [[Category:Development]] somewhere in the markup so they are listed in the Category page and should use the 'Dev' namespace - i.e. the page name should be 'Dev:<pagename>'.
  • Security Pages - these pages should include [[Category:Security]] somewhere in the markup so they are listed in the Category page and should use the 'Security' namespace - i.e. the page name should be 'Security:<pagename>'.
  • Admin Pages - these pages should include [[Category:Admin]] somewhere in the markup so they are listed in the Category page and should use the 'Admin' namespace - i.e. the page name should be 'Admin:<pagename>'.
  • API Pages - these pages should include [[Category:API]] somewhere in the markup so they are listed in the Category page and should use the 'API' namespace - i.e. the page name should be 'API:<pagename>'.
  • Themeing Pages - these pages should include [[Category:Themeing]] somewhere in the markup so they are listed in the Category page and should use the 'Themeing' namespace - i.e. the page name should be 'Themeing:<pagename>'.
  • Help Pages - covers all pages concerning help regarding this wiki. These pages should include [[Category:Help]] somewhere in the markup so they are listed in the Category page and should use the 'Help' namespace - i.e. the page name should be 'Help:<pagename>'.

Article Changes

If you have something to add to an article, just do it. However, if you're not sure or would like to discuss it first, you should post the addition on the article's Talk page under the same heading as in the article itself (if there isn't a relevant heading, make one up).

Style

  • Don't post internal (directed towards other editors) comments on the articles themselves. Use the talk page for that. If you need to leave a note for other editors in the article text, use an HTML comment. For example, <!-- This is a comment that won't show up on the article page, but will be visible if the page is edited -->
  • Sign the comments you leave on the Talk pages with ~~~ or ~~~~.

Comments or Summary

Please use edit comments (summary field) as often as possible. Even if it's a small and obvious change you should still tell us what it is.

If you're deleting content from an article, always state your reason for doing so. Otherwise, it looks like vandalism and will be reverted.

Reverting

Sometimes some pages get spammed or vandalized. Usually, an admin will be around to revert the bad changes. However, if you wish, you can clean up the mess too. To revert spammer edits, click on the history link at the top of the page in question, then click on the date of the last good edit. You will be taken to the article as it was before it was spammed. Click the edit link and submit. This will make the last good version the newest one.

Do NOT simply hightlight the spam and delete it. Spammers overwrite good content. If you then delete their changes, you also delete the good content. If in doubt, just let the admins take care of it.

Announcing Reverts

Don't bother. Everyone can see what you reverted on the RC page.

Format

When reverting, you don't need to use the following format of the summary: Reverted edit of X, changed back to last version by Y. You see a lot of these comments because admins have a special "rollback" link that automatically uses that kind of a message when reverting. You just need to say that you are reverting and state the reason for doing so. You can say something like this: "reverted due to spam".