Difference between revisions of "Help:Standard article"

From Hydrogenaudio Knowledgebase
Jump to: navigation, search
Line 1: Line 1:
 +
__NOTOC__
 
<!-- This is a standard article guideline. Please use it for creating
 
<!-- This is a standard article guideline. Please use it for creating
 
articles in this wiki.-->
 
articles in this wiki.-->
 
<font style="color:red; font-weight:bold;">This is a guideline. Please use it for creating articles in this wiki.</font>
 
<font style="color:red; font-weight:bold;">This is a guideline. Please use it for creating articles in this wiki.</font>
  
 +
==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):
 
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):
  
Line 39: Line 41:
 
</pre>
 
</pre>
  
 +
==Style guideline==
 
'''Introduction'''<br />
 
'''Introduction'''<br />
 
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.
 
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:''
 
''Example:''
−
{|style="padding: 3px;"|
+
{|
 
|-
 
|-
−
|style="border: 1px solid #DDDDDD; font-family:courier new;"|
+
|style="border: 1px solid #777777; font-family:courier new;"|
 
<nowiki>'''Joint stereo'''</nowiki> coding methods try to increase the coding efficiency when encoding stereo signals by exploiting commonalties between the left and right channel signal.
 
<nowiki>'''Joint stereo'''</nowiki> coding methods try to increase the coding efficiency when encoding stereo signals by exploiting commonalties between the left and right channel signal.
 
|}
 
|}
Line 53: Line 56:
  
 
''Example:''
 
''Example:''
−
{|style="padding: 3px;"|
+
{|
 
|-
 
|-
−
|style="border: 1px solid #DDDDDD; font-family:courier new;"|
+
|style="border: 1px solid #777777; font-family:courier new;"|
 
<nowiki>==Additional information==</nowiki>
 
<nowiki>==Additional information==</nowiki>
  
Line 73: Line 76:
  
 
''Example:''
 
''Example:''
−
{|style="padding: 3px;"|
+
{|
 
|-
 
|-
−
|style="border: 1px solid #DDDDDD; font-family:courier new;"|
+
|style="border: 1px solid #777777; font-family:courier new;"|
 
<nowiki>==Recommended encoder settings==</nowiki>
 
<nowiki>==Recommended encoder settings==</nowiki>
  
Line 91: Line 94:
  
 
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.
 
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'''<br />
 +
This section contains links to other wiki articles related to the article being written.
 +
 +
''Example:''
 +
{|
 +
|-
 +
|style="border: 1px solid #777777; font-family:courier new;"|
 +
<nowiki>==See also==</nowiki>
 +
 +
<nowiki>* [[ABR]]</nowiki>
 +
 +
<nowiki>* [[VBR]]</nowiki>
 +
 +
<nowiki>* [[CBR]]</nowiki>
 +
|}
 +
 +
'''Notes and references'''<br />
 +
Include here any notes or references related 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:''
 +
{|
 +
|-
 +
|style="border: 1px solid #777777; font-family:courier new;"|
 +
<nowiki>==Notes and references==</nowiki>
 +
 +
<nowiki># ''MCSE Exam 70-215, Microsoft Windows 2000 Server''. Chapter 1, Introduction to Microsoft Windows 2000, pg 7-18.</nowiki>
 +
 +
<nowiki># ''Inside NT's Object Manager''. Introduction.</nowiki>
 +
 +
===Credits===
 +
Text © Menno Bakker - <nowiki>[http://www.audiocoding.com/ Audiocoding]</nowiki>
 +
 +
written by user - <nowiki>[http://www.High-Quality.ch.vu/ High Quality Audio guides]</nowiki>
 +
|}
 +
 +
'''Further reading and bibliography'''<br />
 +
Include here references to books, academic articles, webpages or other resources that are related to the article being written.
 +
 +
''Example:''
 +
{|
 +
|-
 +
|style="border: 1px solid #777777; font-family:courier new;"|
 +
<nowiki>==Further reading and bibliography==</nowiki>
 +
 +
Text © Menno Bakker - <nowiki>[http://www.audiocoding.com/ Audiocoding]</nowiki>
 +
 +
written by user - <nowiki>[http://www.High-Quality.ch.vu/ High Quality Audio guides]</nowiki>
 
|}
 
|}

Revision as of 13:01, 20 September 2006

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.

==Further reading and bibliography==
Reading and bibliography 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:

'''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:

==Additional information==

Some more details, history and examples about joint stereo & mid/side coding:

mid/side can be lossless like obviously in Lossless formats Flac, Wavpack, Monkey's Audio (ape) etc., but in lossy encoders the encoder tries to do the best to minimize all losses in perception. And here the encoder has not only to deal with stereo modes, but also with mids, highs etc. etc. So, regarding lossy formats like MP3 (Lame, Fraunhofer, Xing), Musepack (MPC), Vorbis etc., the mid/side coding might be even mathematical lossless, might be perceptual lossless (=transparent), or not so lossless at all at low bitrates. So, it depends in the lossy formats about the quality of mid/side (js) coding. From obvious bad sounding bugs like in some old Fraunhofer mp3 ("Radium hack"), not so optimized perfomance like in mp3-Xing, up to the optimized js-modes in mp3-Lame, which offer frame-dependent stereo or mid/side coding to achieve maximum qualities. And advanced formats like mp3-lame, Musepack-MPC or Vorbis-ogg offer increasing js(mid/side//stereo)qualities in increasing general quality (q) levels, examples: Mp3-Lame inside the presets eg. -V quality levels, with different -msfix values up to the "nssafejoint" mode in 320 kbit cbr. Musepack-MPC inside the various q-levels/presets and the --ms x switch. Vorbis in its presets, 1 example above q6 the "lossless stereo coupling".

Subsections
Use subsections whenever necessary to make information easily readable.

Example:

==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.

See also
This section contains links to other wiki articles related to the article being written.

Example:

==See also==

* [[ABR]]

* [[VBR]]

* [[CBR]]

Notes and references
Include here any notes or references related 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:

==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]

Further reading and bibliography
Include here references to books, academic articles, webpages or other resources that are related to the article being written.

Example:

==Further reading and bibliography==

Text © Menno Bakker - [http://www.audiocoding.com/ Audiocoding]

written by user - [http://www.High-Quality.ch.vu/ High Quality Audio guides]

Retrieved from "https://wiki.hydrogenaud.io/index.php?title=Help:Standard_article&oldid=13979"