TotalcmdWiki:Style: Difference between revisions

From TotalcmdWiki
Jump to navigation Jump to search
m (changed sort key for category Wiki guidelines)
(added sub section about Main article contents)
Line 10: Line 10:
* '''Categories'''
* '''Categories'''
* '''Interwiki links'''
* '''Interwiki links'''
=== Main article contents ===
==== Small introduction ====
Start with a small introduction without putting a section header above it. This way the introduction will appear before a possible table of contents and people can start reading immediately and determine if they want to read further.
The small introduction should explain in short the subject of the article. Preferably mention the subject of the article as soon as possible and write the subject in boldface. Only the first occurrence of the article subject on the article page should be boldfaced. Example:
'''Total Commander''' is a file manager ..
==== Sections ====
After the small introduction more detailed information follows which may be divided into sections. Sections in turn may be divided into sub sections. Start with section level 2. (Section level 1 is the article itself.) Do not choose a certain section level for cosmetic reasons.
<pre><nowiki>
== Section 1 ==
=== Sub section 1 ===
== Section 2 ==
=== Sub section 1 ===
=== Sub section 2 ===
</nowiki></pre>


=== See also section ===
=== See also section ===

Revision as of 23:10, 13 August 2008

This article contains style guidelines for writing in this wiki.

Structure of an article

When writing an article use the structure below. The listed elements are to be used only when needed.

  • Main article contents
  • See also section - A section with links to relevant information in this wiki.
  • Notes - A section with footnotes.
  • External links - A section with external links to relevant information.
  • Categories
  • Interwiki links

Main article contents

Small introduction

Start with a small introduction without putting a section header above it. This way the introduction will appear before a possible table of contents and people can start reading immediately and determine if they want to read further.

The small introduction should explain in short the subject of the article. Preferably mention the subject of the article as soon as possible and write the subject in boldface. Only the first occurrence of the article subject on the article page should be boldfaced. Example:

Total Commander is a file manager ..

Sections

After the small introduction more detailed information follows which may be divided into sections. Sections in turn may be divided into sub sections. Start with section level 2. (Section level 1 is the article itself.) Do not choose a certain section level for cosmetic reasons.

== Section 1 ==
=== Sub section 1 ===
== Section 2 ==
=== Sub section 1 ===
=== Sub section 2 ===

See also section

Use the following format for the See also section.

== See also ==
* [[Christian Ghisler]]
* [[Christian Ghisler]] is the author of Total Commander.
* [[Christian Ghisler]] - The author of Total Commander.

External links section

Use the following format for the External links section.

== External links ==
* [[http://url.1.example.com Description of link 1]]
* [[http://url.2.example.com Description of link 2]]