Difference between revisions of "VsWiki:Manual of Style"

From VsWiki
Jump to: navigation, search
(added page description)
(added some more stuff, especially the Fixme description)
Line 5: Line 5:
 
See the [[Talk:VsWiki:Manual_of_Style|talk]] section for discussions on this guide.
 
See the [[Talk:VsWiki:Manual_of_Style|talk]] section for discussions on this guide.
  
= Vegastrike name =
+
= Genaral =
 +
== Vegastrike name ==
 
This is about the mentioning of the name ''Vegastrike'' or ''Vega Strike'' etc...
 
This is about the mentioning of the name ''Vegastrike'' or ''Vega Strike'' etc...
  
 
* Please see the discussion here: [[Talk:Vegastrike#Vegastrike_.28name.29_discussion]]
 
* Please see the discussion here: [[Talk:Vegastrike#Vegastrike_.28name.29_discussion]]
  
= Header and title style =
+
== Header and title style ==
 
If you add headers to a page or make a new page (title), please try to avoid extremly long sentences.
 
If you add headers to a page or make a new page (title), please try to avoid extremly long sentences.
  
Up to ~four words should be able to sum up the page.
+
Up to ~4 words ''should'' be able to sum up the page. If it's longer you may have to split the content anyway ;)
  
If it is longer you may have to split the content anyway ;)
+
The name header/title should be formed like a correct sentence. (e.g capital letters = First one of sentence + 1st of names + alot of abbreviations)
  
The name header/title should be formed like a correct sentence. (e.g capital letters = First one of sentence + 1st of names)
+
== Templates ==
 
 
= Templates =
 
 
See  [[VsWiki:Templates]] for availabe templates and how to use them.
 
See  [[VsWiki:Templates]] for availabe templates and how to use them.
  
= Categories =
+
= Content =
 +
== Classify the content in categories ==
 
See [[Special:Categories]] for all available (and used :? ) categories, use them wisely.
 
See [[Special:Categories]] for all available (and used :? ) categories, use them wisely.
  
See the [[Manual|manual]] pages for examples or browse the categories to figure out what categories are used for what content.
+
See the [[Manual|manual]] and [[Database|database]] pages for examples or browse the categories to figure out what categories are used for what content.
  
= Images =
+
== Images ==
 +
=== General images ===
 
Most of the images currently used in the Wiki (especially in the [[Manual]]) are located in the [http://vegastrike.sourceforge.net/gallery/wiki_manual wiki-manual gallery].
 
Most of the images currently used in the Wiki (especially in the [[Manual]]) are located in the [http://vegastrike.sourceforge.net/gallery/wiki_manual wiki-manual gallery].
== Keyboard Images ==
+
=== Keyboard images ===
 
Please see [[Manual:Keyboard layout]] for more info on how top easily include keys in you text (via Templates).
 
Please see [[Manual:Keyboard layout]] for more info on how top easily include keys in you text (via Templates).
 +
 +
== Unfinished stuff ==
 +
If you are writing content fo rthe manual (or general the wiki) and you do not know anything about some part of it, just put the <code><nowiki>{{Fixme}}</nowiki></code> tags in your text.
 +
 +
You page will then be listed in the [[:Category:Fixme]] where every editor should look into from time to time ;)
 +
 +
See also [[:Category:Pages_needing_attention]]

Revision as of 21:07, 20 March 2005

This page should proof as a guide for anyone editing the wiki.

There are no fixed rules though, especially, if something can be done better/easier/more efficient.

See the [[Talk:VsWiki:Manual_of_Style|talk]] section for discussions on this guide.

Genaral

Vegastrike name

This is about the mentioning of the name Vegastrike or Vega Strike etc...

Header and title style

If you add headers to a page or make a new page (title), please try to avoid extremly long sentences.

Up to ~4 words should be able to sum up the page. If it's longer you may have to split the content anyway ;)

The name header/title should be formed like a correct sentence. (e.g capital letters = First one of sentence + 1st of names + alot of abbreviations)

Templates

See VsWiki:Templates for availabe templates and how to use them.

Content

Classify the content in categories

See Special:Categories for all available (and used :? ) categories, use them wisely.

See the manual and database pages for examples or browse the categories to figure out what categories are used for what content.

Images

General images

Most of the images currently used in the Wiki (especially in the Manual) are located in the wiki-manual gallery.

Keyboard images

Please see Manual:Keyboard layout for more info on how top easily include keys in you text (via Templates).

Unfinished stuff

If you are writing content fo rthe manual (or general the wiki) and you do not know anything about some part of it, just put the {{Fixme}} tags in your text.

You page will then be listed in the Category:Fixme where every editor should look into from time to time ;)

See also Category:Pages_needing_attention