Help:Editing
From HvWiki
In order to edit any page, all you have to do is click the "edit" tab at the top of any page. You don't need to know anything about HTML, as this wiki has its own markup language that is very easy to understand. (See Help:Markup) If you're not feeling very confident, or you just want to try something out, use the Sandbox; that's why it's there.
Contents |
Edit Summary
Please fill this out. It lets everyone know why a page was edited, which is extremely helpful when looking at the Recent changes page. A short description is all that's needed, such as "fixed typo" or "added links."
Creating New Pages
To create a page you enter the title in the search box on the left of the screen and click "Go" or press enter. If a page exists with that name it will be displayed and you can continue to work on it if needed. If no page with that name exist you will get a page that says "No page with this exact title exists...". Click on "this exact title" to edit your new page.
Before creating a page, please use the search tool or browse the categories to make sure there aren't any very similar pages.
Every single page on the site should be categorized. When editing a new article, please make sure you put it in the proper category. This is accomplished simply by putting a link at the bottom of the article such as [[Category:Glossary]] or [[Category:Computers]].
If you are creating an empty placeholder or the article is not completed please add the text {{stub}} to the page so it is listed as a stub.
Recommended styles
These are recommendations, that means that you don't have to follow them but it is wise to do so unless you have a reason not to.
Content
The practical side should be emphasized so that people does not only gain knowledge but also learn how to apply it. They should both learn what a Tesla coil is and how to build one. Create a ladder from basic information suitable for beginners all they way up to the most advanced levels so people can grow and develop to the next stage. Original research is strongly encouraged.
Titles
Avoid using an acronym like SCR as the title of an article. Spell out the complete name Silicon controlled rectifier as the title of the article and add a Glossary page (or redirect) named SCR that points to the main article. Browsing a list of acronyms is very tiresome and pointless if you don't know their meaning. It also makes browsers able to show a tooltip with the definition when the mouse pointer is held over the acronym.
Numbers
Do not format numbers with a comma like this: 100,100. Use a space instead like this: 100 100. Some countries use comma as a decimal point so a comma in numbers can confuse both humans and usability programs. Some fonts also have a comma and decimal point that are almost indistinguishable.
Units
If at all possible use the International System of Units to make sure the article is readable by everyone. Also see Units. When using the <math> tag, units should not be displayed in italics. Use the \mbox{} function to display units upright.
The unspoken rules of writing a wiki article
Make it readable to persons that don't already know the answer
- If people start reading an article they probably don't know everything about the subject so the article should be written in a way that makes it possible to understand it with far less knowledge than it took to write it. For example if you jump straight into some complicated looking math without explaining it in plain English then the people that have most use of the information might not be able to understand it.
Do the important things first
- Add useful information, tinker with the looks later.
- Complete what you started before starting something new.
Never do the unimportant things
- Never link to things like dates, colours or numbers.
- Never add information that is useless in the context of an article.
It is written once but read a thousand times
- Even if it is easy for anyone to edit and improve something you should try to make the article as good as you can from the start.
