Help:Standard article: Difference between revisions

From Hydrogenaudio Knowledgebase
(Standard article template to be used in the articles of this wiki)
 
No edit summary
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<!-- This is a standard article template. Please use it for creating articles in this wiki.-->
__NOTOC__
__NOEDITSECTION__
<!-- This is a standard article guideline. Please use it for creating
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>


<<include a brief summary of the article main topic here (this is mandatory)>>
==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):


<pre>
Introduction


==Lead section==
==Lead section #1==
This is the lead section of the article (mandatory).
This is the lead section of the article.


===Subsection #1===
===Subsection #1.1===
This is a subsection of the article (optional).
This is a subsection of the article.


====Subsection #2====
====Subsection #1.2====
This is a sub-subsection of the article (optional).
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.
</pre>
==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'''''
|-
|style="border: 1px solid #777777; font-family:courier new; width:450px;"|
<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.
|style="border: 1px solid #777777; width:450px;"|
'''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:'''
{|
|'''''wikicode'''''||'''''page rendered'''''
|-
|style="border: 1px solid #777777; font-family:courier new; width:450px;"|
<nowiki>==History==</nowiki>
LAME development began around mid-1998. Mike Cheng started it as a patch against the 8hz-MP3 encoder sources. After some quality concerns raised by others, he decided to start from scratch based on the dist10 sources. That branch (a patch against the reference sources) became LAME 2.0, and only on LAME 3.81 they got rid of all dist10 code, making LAME a completely new program-not a mere patch of an existing encoder.
The project quickly became a team effort. Mike Cheng eventually left leadership and started working on tooLAME, an MP2 encoder. Mark Taylor became leader and released version 3.0 featuring gpsycho, a new psychoacoustic model developed by him.
Nowadays LAME is considered the best MP3 encoder at mid-high bitrates and features the best VBR model among MP3 implementations, mostly thanks to the dedicated work of talented developers like Takehiro Tominaga, Naoki Shibata, Darin Morrison, Gabriel Bouvigne, Robert Hegemann, etc. And development is still going on...
|style="border: 1px solid #777777; width:450px;"|
==History==
LAME development began around mid-1998. Mike Cheng started it as a patch against the 8hz-MP3 encoder sources. After some quality concerns raised by others, he decided to start from scratch based on the dist10 sources. That branch (a patch against the reference sources) became LAME 2.0, and only on LAME 3.81 they got rid of all dist10 code, making LAME a completely new program-not a mere patch of an existing encoder.
The project quickly became a team effort. Mike Cheng eventually left leadership and started working on tooLAME, an MP2 encoder. Mark Taylor became leader and released version 3.0 featuring gpsycho, a new psychoacoustic model developed by him.
Nowadays LAME is considered the best MP3 encoder at mid-high bitrates and features the best VBR model among MP3 implementations, mostly thanks to the dedicated work of talented developers like Takehiro Tominaga, Naoki Shibata, Darin Morrison, Gabriel Bouvigne, Robert Hegemann, etc. And development is still going on...
|}
===Subsections===
Use subsections whenever necessary to make information easily readable.
'''Example:'''
{|
|'''''wikicode'''''||'''''page rendered'''''
|-
|style="border: 1px solid #777777; font-family:courier new; width:450px;"|
<nowiki>==Recommended encoder settings==</nowiki>
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.
(...)
<nowiki>===VBR (variable bitrate) settings===</nowiki>
<nowiki>'''[[VBR]]:''' ''variable bitrate mode. Use variable bitrate modes when the goal is to achieve a fixed level of quality using the lowest possible bitrate.''</nowiki>
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.
|style="border: 1px solid #777777; width:450px;"|
==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. It must be a bulleted list.
'''Example:'''
{|
|'''''wikicode'''''||'''''page rendered'''''
|-
|style="border: 1px solid #777777; font-family:courier new; width:450px;"|
<nowiki>==See also==</nowiki>
<nowiki>* [[ABR]]</nowiki>
<nowiki>* [[VBR]]</nowiki>
<nowiki>* [[CBR]]</nowiki>
|style="border: 1px solid #777777; width:450px;"|
==See also==
==See also==
Standard see also section.


* [[ABR]]
* [[VBR]]
* [[CBR]]
|}
===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'''''
|-
|style="border: 1px solid #777777; font-family:courier new; width:450px;"|
<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>
<nowiki>===Credits===</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>
|style="border: 1px solid #777777; width:450px;"|
==Notes and references==
==Notes and references==
Standard notes and references section.
# ''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==
===External links===
Standard reading and bibliography section.
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'''''
|-
|style="border: 1px solid #777777; font-family:courier new; width:450px;"|
<nowiki>==External links==</nowiki>
<nowiki>* [http://www.hydrogenaudio.org/forums/index.php Hydrogenaudio]</nowiki>
<nowiki>* [http://en.wikipedia.org/wiki/ASCII ASCII]</nowiki>
|style="border: 1px solid #777777; width:450px;"|
==External links==
==External links==
Standard external links section.
* [http://www.hydrogenaudio.org/forums/index.php Hydrogenaudio]
* [http://en.wikipedia.org/wiki/ASCII ASCII]
|}
 
[[Category:Help]]
[[Category:Guideline]]

Latest revision as of 13:55, 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.

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

wikicode page rendered

==History==

LAME development began around mid-1998. Mike Cheng started it as a patch against the 8hz-MP3 encoder sources. After some quality concerns raised by others, he decided to start from scratch based on the dist10 sources. That branch (a patch against the reference sources) became LAME 2.0, and only on LAME 3.81 they got rid of all dist10 code, making LAME a completely new program-not a mere patch of an existing encoder.

The project quickly became a team effort. Mike Cheng eventually left leadership and started working on tooLAME, an MP2 encoder. Mark Taylor became leader and released version 3.0 featuring gpsycho, a new psychoacoustic model developed by him.

Nowadays LAME is considered the best MP3 encoder at mid-high bitrates and features the best VBR model among MP3 implementations, mostly thanks to the dedicated work of talented developers like Takehiro Tominaga, Naoki Shibata, Darin Morrison, Gabriel Bouvigne, Robert Hegemann, etc. And development is still going on...

History

LAME development began around mid-1998. Mike Cheng started it as a patch against the 8hz-MP3 encoder sources. After some quality concerns raised by others, he decided to start from scratch based on the dist10 sources. That branch (a patch against the reference sources) became LAME 2.0, and only on LAME 3.81 they got rid of all dist10 code, making LAME a completely new program-not a mere patch of an existing encoder.

The project quickly became a team effort. Mike Cheng eventually left leadership and started working on tooLAME, an MP2 encoder. Mark Taylor became leader and released version 3.0 featuring gpsycho, a new psychoacoustic model developed by him.

Nowadays LAME is considered the best MP3 encoder at mid-high bitrates and features the best VBR model among MP3 implementations, mostly thanks to the dedicated work of talented developers like Takehiro Tominaga, Naoki Shibata, Darin Morrison, Gabriel Bouvigne, Robert Hegemann, etc. And development is still going on...

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

  1. MCSE Exam 70-215, Microsoft Windows 2000 Server. Chapter 1, Introduction to Microsoft Windows 2000, pg 7-18.
  2. Inside NT's Object Manager. Introduction.

Credits

Text © 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