Help:Standard article
From Hydrogenaudio Knowledgebase
This is a guideline. Please use it for creating articles in this wiki.
Introduction
The aim of this guideline is to provide ways to standardize articles in this wiki. Every article should abide to the general structure below (in wiki code):
Introduction ==Lead section #1== This is the lead section of the article. ===Subsection #1.1=== This is a subsection of the article. ====Subsection #1.2==== This is a sub-subsection of the article. ==Lead section #2== This is the lead section of the article. ===Subsection #2.1=== This is a subsection of the article. ====Subsection #2.2==== This is a sub-subsection of the article. ==See also== See also section. ==Notes and references== Notes and references section. ==External links== External links section.
Style guideline
Introduction
Every article should start with a summary of the topic detailed in the article. This is the very first thing to be written before any section.
Example:
| wikicode | page rendered |
|
'''Joint stereo''' coding methods try to increase the coding efficiency when encoding stereo signals by exploiting commonalties between the left and right channel signal. |
Joint stereo coding methods try to increase the coding efficiency when encoding stereo signals by exploiting commonalties between the left and right channel signal. |
Lead sections
An article may have any number or lead sections. Within these sections you should put any relevant information about the section topic including pictures, media files, formulas etc.
Example:
Subsections
Use subsections whenever necessary to make information easily readable.
Example:
| wikicode | page rendered |
|
==Recommended encoder settings== This section describes the Hydrogenaudio recommended settings to be used with LAME for highest quality MP3 encoding. These settings require LAME 3.94 or later. LAME 3.97beta3 is the recommended version. Avoid using alpha (a) versions of LAME. More often than not those are exclusively for testing purposes. Use them only if you want to help developers with feedback. (...) ===VBR (variable bitrate) settings=== '''[[VBR]]:''' ''variable bitrate mode. Use variable bitrate modes when the goal is to achieve a fixed level of quality using the lowest possible bitrate.'' VBR is best used to target a specific quality level, instead of a specific bitrate. The final file size of a VBR encode is less predictable than with ABR, but the quality is usually better. |
Recommended encoder settingsThis section describes the Hydrogenaudio recommended settings to be used with LAME for highest quality MP3 encoding. These settings require LAME 3.94 or later. LAME 3.97beta3 is the recommended version. Avoid using alpha (a) versions of LAME. More often than not those are exclusively for testing purposes. Use them only if you want to help developers with feedback. (...) VBR (variable bitrate) settingsVBR: variable bitrate mode. Use variable bitrate modes when the goal is to achieve a fixed level of quality using the lowest possible bitrate. VBR is best used to target a specific quality level, instead of a specific bitrate. The final file size of a VBR encode is less predictable than with ABR, but the quality is usually better. |
See also
This section contains links to other wiki articles related to the article being written. It must be a bulleted list.
Example:
| wikicode | page rendered |
|
==See also== * [[ABR]] * [[VBR]] * [[CBR]] |
See also |
Notes and references
Include here any notes or references directly or indirectly related to the article being written. Include here references to books, academic articles, webpages or other resources that are interesting to the article being written.
Any credits should be put in a subsection in this section too, however remember that this is a collaborative wiki so please do not abuse credits.
Notes and references must be numbered.
Example:
| wikicode | page rendered |
|
==Notes and references== # ''MCSE Exam 70-215, Microsoft Windows 2000 Server''. Chapter 1, Introduction to Microsoft Windows 2000, pg 7-18. # ''Inside NT's Object Manager''. Introduction. ===Credits=== Text © Menno Bakker - [http://www.audiocoding.com/ Audiocoding] written by user - [http://www.High-Quality.ch.vu/ High Quality Audio guides] |
Notes and references
CreditsText © Menno Bakker - Audiocoding written by user - High Quality Audio guides |
External links
Include here any external links that are directly or indirectly related to the article being written. It must be a bulleted list.
Example:
| wikicode | page rendered |
|
==External links== * [http://www.hydrogenaudio.org/forums/index.php Hydrogenaudio] * [http://en.wikipedia.org/wiki/ASCII ASCII] |
External links |
