Using Nickel: Markup

Nickel uses a custom markup language which is similar to code you might use when posting on a bulletin board. Administrators have access to a special "file" tag which intelligently embeds its URL. The remaining tags are open to all user for articles and comments. The markup bar has a link (a question mark) back to this page if you or your users ever need help.

B

Make text bold. Example:
This is [b]bold[/b] text

I

Italicize text. Example:
This is [i]italic[/i] text

U

Underline text. Example:
This is [u]underlined[/u] text

List

Creates an unordered list. Separate items with line breaks. Example:
[list]Item 1
Item 2
Item 3[/list]

Code

Creates a code block. Example:
[code]try {

     throw new Exception("bar");

} catch (Exception Foo) {

     Response.Write(Foo.Message);

}[/code]

Link

Link to URL. Example:
Click [link url="http://www.bantherewind.com/"]here[/link] for awesomeness.

File

Embeds a wide variety of media. Details below. Example:
[file url="http://www.vimeo.com/15543409"]Manipulating Bob on Vimeo![/file]

Embedding Media

"File" is a flexible tag that analyzes the URL to determine what and how to embed the media. It only works on articles written by administrators to keep rogue posters from embedding things they shouldn't. Here is what is supported and how it is embedded.

Images

PNG, JPG, and GIF files appear as inline images. Nickel tries to keep the layout interesting by toggling image alignment as it goes down the article. It starts on the right. If you embed a second image, it will appear on the left, and so on. The first embedded image will appear as the preview image in an article list. Allowed image types may be changed in "Settings.cs".

Flash

Linking a "file" tag to a SWF will embed it in a centered 480 x 360 instance of Flash Player. Any text inside the tag will appear centered below the SWF. Check "Settings.cs" for allowed media types. Update if needed.

Video

Linking a "file" tag to a video file will embed it in a centered 480 x 360 instance of a HTML 5 video player. Any text inside the tag will appear centered below the video. Check "Settings.cs" for allowed media types. Update if needed.

Audio

Linking a "file" tag to an audio file will embed it in a centered 480 pixel wide HTML 5 audio player. Any text inside the tag will appear centered below the player. Check "Settings.cs" for allowed media types. Update if needed.

Downloads

Linking to downloadable files will create an "attachment" element that links to the file URL. Any text inside the tag will appear as a link next to a paper clip icon. Check "Settings.cs" for allowed types.

Vimeo

Linking to a URL on Vimeo which contains a valid video ID will embed the video in a HTML 5 player. Any text inside the tag will appear centered below the player. Example:
[file url="http://www.vimeo.com/15543409"]Manipulating Bob on Vimeo![/file]

YouTube

Linking to a URL on YouTube which contains a valid video ID will embed the video in a HTML 5 player. Any text inside the tag will appear centered below the player. Examples:
[file url="http://www.youtube.com/watch?v=XB-WxZBzfz4"]Multi-touch GPU awesomeness[/file]
[file url="http://youtube.com/v/XB-WxZBzfz4"]Multi-touch GPU awesomeness, direct file link[/file]

Last edited Nov 11, 2010 at 8:03 PM by BanTheRewind, version 8

Comments

No comments yet.