Edit Note Syntax: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
mNo edit summary
(Simplified page into one table.)
Line 1: Line 1:
This page describes special syntax that is available in [[Edit Note|edit note]]s, it's loosely inspired by Wiki (and especially [[Moin Moin|MoinMoin]]) syntax.
This page describes special syntax that is available in [[Edit Note|edit note]]s, it's loosely inspired by wiki syntax.


{| border="1" width="800px"
==Formatting==
! Description !! '''You type''' !! '''You get'''

{| border="1"
|-
|-
| ''' Name/Sample''' || ''' Markup ''' || ''' Notes '''
| Italic text || <nowiki>''italic''</nowiki> || ''italic''
|-
| Bold text || <nowiki>'''bold'''</nowiki> || '''bold'''
|-
|-
| Linking to an edit || edit #123456<br /> edit:123456<br /> edit 123456 || [[Edit:123456|edit #123456]]
| ''italic'' || <code><nowiki>''italic''</nowiki></code> || Double single quotes.
|-
|-
| Linking to a WikiDoc page || doc:Edit_Note_Syntax<br /> [Edit_Note_Syntax] || [http://musicbrainz.org/doc/Edit_Note_Syntax Edit_Note_Syntax]
| '''bold''' || <code><nowiki>'''bold'''</nowiki></code> || Triple single quotes.
|-
| Linking to artist/release group/release/track/label || colspan="2" align="center"| '''''Not available yet, see [[Ticket:1609|ticket #1609]].'''''
|}
|}


==Linking to edits==
== Notes ==

'''Syntax:''' <pre>edit #editid
OR
edit:editid
OR (simplest)
edit editid
</pre>

Where ''editid'' is the edit number.

'''Example:''' <code><nowiki>edit #123456</nowiki></code> or <code><nowiki>edit:123456</nowiki></code> would result in: <code>[[Edit:123456|edit #123456]]</code>.

==Linking to WikiDocs pages==

'''Syntax:''' <pre>doc:WikiDocs_Page
OR
[WikiDocs_Page]
</pre>

Where ''WikiDocs_Page'' is the name of the [[WikiDocs Page]].

'''Example:''' <code><nowiki>doc:Disc_Number_Style</nowiki></code> or <code><nowiki>[Disc_Number_Style]</nowiki></code> would result in: <code>[http://musicbrainz.org/doc/Disc_Number_Style Disc Number Style]</code>.


* There is no syntax to use when entering in a URL, any entered URLs will turn into links automatically.
==Linking to Artists, Releases, Labels, ...==
* URLs may break if there are special characters in the URL, but if this happens it is a simple matter to fix.
** Copy the URL (by right clicking on the link); paste this URL into a new window or tab; now copy the remaining portion of the URL that was left out of the clickable link.
* Long URLs will be shortened when displayed, don't worry the link will still work.


'''Status:''' Not yet implemented. See [[Ticket:1609|ticket #1609]].


[[Category:Editing]]
[[Category:Editing]]

Revision as of 04:13, 17 December 2009

This page describes special syntax that is available in edit notes, it's loosely inspired by wiki syntax.

Description You type You get
Italic text ''italic'' italic
Bold text '''bold''' bold
Linking to an edit edit #123456
edit:123456
edit 123456
edit #123456
Linking to a WikiDoc page doc:Edit_Note_Syntax
[Edit_Note_Syntax]
Edit_Note_Syntax
Linking to artist/release group/release/track/label Not available yet, see ticket #1609.

Notes

  • There is no syntax to use when entering in a URL, any entered URLs will turn into links automatically.
  • URLs may break if there are special characters in the URL, but if this happens it is a simple matter to fix.
    • Copy the URL (by right clicking on the link); paste this URL into a new window or tab; now copy the remaining portion of the URL that was left out of the clickable link.
  • Long URLs will be shortened when displayed, don't worry the link will still work.