Difference between revisions of "Editing rules"

From FAIWiki
Jump to navigation Jump to search
(added hint on spelling)
 
Line 2: Line 2:
  
 
== some editing rules/hints ==
 
== some editing rules/hints ==
* please enter a summary of your edit before you save
+
* Please enter a summary of your edit before you save.
* check the preview before you save
+
* Check the preview before you save.
* please make sure that you put your content in the right context, browse through the wiki and use the search function to check that
+
* Please make sure that you put your content in the right context, browse through the wiki and use the search function to check that.
* if you created a opage that you know is not completed, add a horizontal rule (with ---- at the beginning of a line) at the end, and put TODO: <TASK TO DO> lines below that
+
* If you have created a page that you know is not completed, add a horizontal rule (with ---- at the beginning of a line) at the end, and put TODO: <TASK TO DO> lines below that. A Category <code>TODO</code>  can bring all the <code>TODO</code>-pages together.
* maybe it's a good idea if people can contact the author of a page they want contribute to - which is possible if everybody has contact data on their [[Special:Listusers| user page]] (no it's not arule that you should, but often it might help make the result better
+
* Maybe it's a good idea if people can contact the author of a page they want contribute to - which is possible if everybody has contact data on their [[Special:Listusers| user page]] (no it's not arule that you should, but often it might help make the result better.
* You can make Your text more readable by using the &lt;code&gt; &lt;/code&gt; tag for, say, filenames or shellcommands. The result will look something like  this <code>/path/to/my/file/here</code> or this: <code> # apt-get remove --purge login</code>
+
* You can make Your text more readable by using the &lt;code&gt; &lt;/code&gt; tag for, say, filenames or shellcommands. The result will look something like  this <code>/path/to/my/file/here</code> or this:  
 
+
<code> # apt-get remove --purge login</code>
 +
* Check the spelling in Your submissions. Correct orthography helps readability.
  
 
----
 
----
 
* TODO: maybe we should have a naming scheme for some special page types, like pages describeing user-contributed classes, success stories, and stuff
 
* TODO: maybe we should have a naming scheme for some special page types, like pages describeing user-contributed classes, success stories, and stuff

Latest revision as of 16:07, 23 January 2006

What would we be without rules?

some editing rules/hints

  • Please enter a summary of your edit before you save.
  • Check the preview before you save.
  • Please make sure that you put your content in the right context, browse through the wiki and use the search function to check that.
  • If you have created a page that you know is not completed, add a horizontal rule (with ---- at the beginning of a line) at the end, and put TODO: <TASK TO DO> lines below that. A Category TODO can bring all the TODO-pages together.
  • Maybe it's a good idea if people can contact the author of a page they want contribute to - which is possible if everybody has contact data on their user page (no it's not arule that you should, but often it might help make the result better.
  • You can make Your text more readable by using the <code> </code> tag for, say, filenames or shellcommands. The result will look something like this /path/to/my/file/here or this:

# apt-get remove --purge login

  • Check the spelling in Your submissions. Correct orthography helps readability.

  • TODO: maybe we should have a naming scheme for some special page types, like pages describeing user-contributed classes, success stories, and stuff