Help:Formatting guidelines

From Wikichords

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
{{SUBST:Main:Help & Formatting#Formatting guidelines}}
+
== General formatting ==
 +
 
 +
=== Use of <nowiki><pre></nowiki> ===
 +
 
 +
Mediawiki markup language automatically enhances the format of documents. However, these tweaks are not always suitable for ''Chords'' formatting. For this reason, the use of the ''<nowiki><pre></nowiki>'' markup is recommended (in the following example, <nowiki><pre></nowiki> tags should be written without space in them).
 +
 
 +
<pre>
 +
< pre >
 +
Here goes the lyrics and chords
 +
[...]
 +
< /pre >
 +
</pre>
 +
 
 +
=== Song name and artist ===
 +
 
 +
The song should begin with the title, immediately followed by the artist's name on the next line. This is useful if users prefers to copy/paste the content of the song in a word processor to print it.
 +
<pre>
 +
Hotel California
 +
The Eagles
 +
</pre>
 +
 
 +
=== Positioning of chords ===
 +
 
 +
Chords should be positioned above the lyrics, and as much as possible above the syllable where the chord change occurs.
 +
<pre>
 +
C        G
 +
This is a song
 +
C                  D
 +
That contains three chords
 +
</pre>
 +
 
 +
== Verse and chorus ==
 +
 
 +
In order to make the ''Chords'' as printer-friendly as possible, sheet space should be saved by using a reference for chorus repetitions. ''CHORUS'' should be written (in caps) before the first chorus and again to indicate repetitions.
 +
 
 +
<pre>
 +
C        G
 +
This is a verse
 +
C        D
 +
And it's correct
 +
 
 +
CHORUS
 +
 
 +
D            G
 +
And now the chorus
 +
F          C
 +
It's always the same
 +
 
 +
C        G
 +
This is another verse
 +
C        D
 +
And after it's the chorus
 +
 
 +
CHORUS
 +
</pre>
 +
 
 +
=== Categories ===
 +
 
 +
At the end of each song, a Category link must be added:
 +
<pre>
 +
[[Category:Metallica]]
 +
</pre>
 +
This will link the song to the appropriate artist, and will automatically add it to the [[:Category:Artists|browse by artist]] page.
 +
 
 +
If it's a new artist, a new Category page will be created. To link this new artist to the [[:Category:Artists|browse by artist]] page, the content of the Category page should be:
 +
<pre>
 +
[[Category:Artists]]
 +
</pre>
 +
Additionally, a sorting key can be used in this link. This is useful for artists or bands with names starting with an article. For example, the content of the Category page for the Artist ''The Beatles'' is:
 +
<pre>
 +
[[Category:Artists|Beatles, The]]
 +
</pre>
 +
 
 +
== Musical guidelines ==
 +
 
 +
=== Song key ===
 +
 
 +
The song should be in the ''original key'' of the song, which is usually the key in which the song was recorded. Use of ''capo'' is allowed, though not recommended, as the chords could be played by an instrument that doesn't use capos. It is however accepted if it eases the guitar interpretation (for example if the song is in C#, a capo in first position makes it easier to play). When needed, the capo information should be written under the artist's name, using roman numerals.
 +
<pre>
 +
Hotel California
 +
The Eagles
 +
 
 +
CAPO III
 +
</pre>
 +
 
 +
=== Chords persistence ===
 +
 
 +
As some players find it hard to remember by heart all the chords of a song, chords should be placed '''throughout the whole song''', not only in the first verse and chorus.
 +
 
 +
=== Chord names ===
 +
Chords should be written in the standard English notation (C D E F G A B), in upper-case, with minors, flats and other chord alterations being in lower-case. Additionally, single notes can be written (for example for a quick bass line between two chords), using lower-case letters.
 +
 
 +
<pre>
 +
C                  c b  Am
 +
Example of a quick bass line
 +
</pre>
 +
 
 +
== Detailed formatting ==
 +
Here are some tips to make ''Chords'' as printer-friendly as possible (for the ''Letter'' format):
 +
 
 +
=== Optimize space ===
 +
Remove useless lines and spaces. Try to pack as much text as possible, but keep it readable.
 +
 
 +
=== Use columns ===
 +
Songs should be written on multiple columns, to fit on a single page whenever possible. Using columns is a good way to optimize space. Two columns are usually the best. If you use three columns, the third one may not get printed (depending on the browser/printer).
 +
 
 +
Columns are set by using
 +
<pre>
 +
{||-
 +
|
 +
</pre>
 +
''before'' the <nowiki><pre></nowiki> tag. To change column, write (without spaces in the <nowiki><pre></nowiki> tag)
 +
<pre>
 +
< /pre >
 +
||
 +
< pre >
 +
</pre>
 +
Finally, finish the page with (without spaces in the <nowiki><pre></nowiki> tag)
 +
<pre>
 +
< /pre >
 +
|}
 +
</pre>
 +
 
 +
=== Multiple pages ===
 +
Sometimes a song may not fit on a single sheet, even when optimizing space. Even if it goes against the ''printer friendly'' philosphy, it is possible to span a song on two sheets. To do so, tables must be used.
 +
 
 +
Open a table using the following syntax
 +
Columns are set by using
 +
<pre>
 +
{||-
 +
|
 +
< pre >
 +
</pre>
 +
Then insert the part of the song that fits on the first page. Then use this syntax to perform the page change.
 +
<pre>
 +
< /pre >
 +
|}
 +
{||-
 +
|
 +
< pre >
 +
</pre>
 +
This will close the first table and open a new one. Then, go on with the remaining of the song, and end with
 +
<pre>
 +
< /pre >
 +
|}
 +
</pre>

Revision as of 12:25, 29 July 2010

Contents

General formatting

Use of <pre>

Mediawiki markup language automatically enhances the format of documents. However, these tweaks are not always suitable for Chords formatting. For this reason, the use of the <pre> markup is recommended (in the following example, <pre> tags should be written without space in them).

< pre >
Here goes the lyrics and chords
[...]
< /pre >

Song name and artist

The song should begin with the title, immediately followed by the artist's name on the next line. This is useful if users prefers to copy/paste the content of the song in a word processor to print it.

Hotel California
The Eagles

Positioning of chords

Chords should be positioned above the lyrics, and as much as possible above the syllable where the chord change occurs.

C         G
This is a song
C                  D
That contains three chords

Verse and chorus

In order to make the Chords as printer-friendly as possible, sheet space should be saved by using a reference for chorus repetitions. CHORUS should be written (in caps) before the first chorus and again to indicate repetitions.

C         G
This is a verse
C         D
And it's correct

CHORUS

D            G
And now the chorus
F           C
It's always the same

C         G
This is another verse
C         D
And after it's the chorus

CHORUS

Categories

At the end of each song, a Category link must be added:

[[Category:Metallica]]

This will link the song to the appropriate artist, and will automatically add it to the browse by artist page.

If it's a new artist, a new Category page will be created. To link this new artist to the browse by artist page, the content of the Category page should be:

[[Category:Artists]]

Additionally, a sorting key can be used in this link. This is useful for artists or bands with names starting with an article. For example, the content of the Category page for the Artist The Beatles is:

[[Category:Artists|Beatles, The]]

Musical guidelines

Song key

The song should be in the original key of the song, which is usually the key in which the song was recorded. Use of capo is allowed, though not recommended, as the chords could be played by an instrument that doesn't use capos. It is however accepted if it eases the guitar interpretation (for example if the song is in C#, a capo in first position makes it easier to play). When needed, the capo information should be written under the artist's name, using roman numerals.

Hotel California
The Eagles

CAPO III

Chords persistence

As some players find it hard to remember by heart all the chords of a song, chords should be placed throughout the whole song, not only in the first verse and chorus.

Chord names

Chords should be written in the standard English notation (C D E F G A B), in upper-case, with minors, flats and other chord alterations being in lower-case. Additionally, single notes can be written (for example for a quick bass line between two chords), using lower-case letters.

C                  c b  Am
Example of a quick bass line

Detailed formatting

Here are some tips to make Chords as printer-friendly as possible (for the Letter format):

Optimize space

Remove useless lines and spaces. Try to pack as much text as possible, but keep it readable.

Use columns

Songs should be written on multiple columns, to fit on a single page whenever possible. Using columns is a good way to optimize space. Two columns are usually the best. If you use three columns, the third one may not get printed (depending on the browser/printer).

Columns are set by using

{||-
|

before the <pre> tag. To change column, write (without spaces in the <pre> tag)

< /pre >
||
< pre >

Finally, finish the page with (without spaces in the <pre> tag)

< /pre >
|}

Multiple pages

Sometimes a song may not fit on a single sheet, even when optimizing space. Even if it goes against the printer friendly philosphy, it is possible to span a song on two sheets. To do so, tables must be used.

Open a table using the following syntax Columns are set by using

{||-
|
< pre >

Then insert the part of the song that fits on the first page. Then use this syntax to perform the page change.

< /pre >
|}
{||-
|
< pre >

This will close the first table and open a new one. Then, go on with the remaining of the song, and end with

< /pre >
|}
Personal tools
Advertisement