Advanced formatting with the Wikinut editor.

Sam Wormleighton By Sam Wormleighton, 22nd Dec 2009 | Follow this author | RSS Feed | Short URL http://nut.bz/193xv2hv/
Posted in Wikinut>Guides>Using Wikinut>Using The Editor

If you're already skilled with the Wikinut editor you might be ready to try some of the advanced options - Lists, Fixed format blocks, and Embedded youtube videos.

First - learn the basic editor functions

Before trying some of these more advanced options you should be confident about using the standard editor tools. If you have published pages which use links and text formatting and also have embedded images and a preview image then you are ready to try these options. If you haven't already used all the basic tools then you should go back and try those first.

Understanding Wikinut formatting codes

When you format text in the Wikinut editor it places special codes into your text. You can see these code in your editor.

For example: When you make some text Bold, codes like this are inserted:

[b]Bold[/b]

The letters contained in the square brackets (in this case b and /b) are the commands which Wikinut uses to format the text. The standard commands are:

  1. b - Bold
  2. i - Italics
  3. link - create a link

The link command is a special case. We recommend that you always use the Link button in the editor toolbar to create your links.

Formatting a list

Lists are common components in well researched pages. Including a list in your Wikinut page is simple, once you understand the Wikinut command codes used.

A list is made up of two elements. The first element is the list itself, which can either be a numbered list or a list without numbers. The second element is the items that make up the list.

To format a list you use two command codes: [list] and [*].

The [list] command is used to mark the start of your list, the matching command [/list] marks the end.

Each item in the list is written on a single line starting with the [*] (a star or asterisk) command.

Example:

[list]
[*]Item 1
[*]Item 2
[*]Item 3
[/list]

This will generate a list like this:

  • Item 1
  • Item 2
  • Item 3

It is important to understand that only simple lists are supported. Do no try to include carriage returns in your list items. Do not overlap lists or include one list within another.

If you want a numbered list, use [numberedlist] instead of [list].

Example:

[numberedlist]
[*]Item 1
[*]Item 2
[*]Item 3
[/numberedlist]

Will generate a list which looks like this:

  1. Item 1
  2. Item 2
  3. Item 3

Inserting a pre-formatted/fixed width text block

Sometimes you'll find the need to insert a block of text where you want whitespace characters to be used for formatting purposes. This frequently occurs when you want to include some programming code in a page, the layout of the code relies upon the leading spaces on each line being displayed properly.

So, for example, the following code is not formatted correctly:

<?php
function helloworld() {
return "Hello, World!";
}
?>

Whereas the following code has the whitespace preserved, and formats correctly:

<?php
function helloworld() {
return "Hello, World!";
}
?>

In order to format text in this way you just have to use the wikinut command code "c", which stands for code. It isn't just for code though, it works well for any text you want to display in a fixed-width font.

The above sample was produced using this text in the editor:

[c]
<?php
function helloworld() {
return "Hello, World!";
}
?>
[/c]

Note that if you use [ or ] characters within a code block they are not treated as Wikinut commands. This is because many programming languages already use the square bracket characters. You therefore cannot have formatted text (bold etc) within a code block.

If you wish to insert [ or ] characters elsewhere in your documents you can access them by using a double character.

[[ will display as [
]] will display as ]

Including a youtube video

If you want to include a youtube video in your page you can use the special command code [yt]. You need to know the identifier for the youtube video, this identifier can found within your youtube account page or within the URL of the video you want to embed.

In the case of the following video the identifier is txqiwrbYGrs:

http://www.youtube.com/watch?v=txqiwrbYGrs

Using the command code:

[yt]txqiwrbYGrs[/yt]

Give the following result:

Currently youtube is the only video hosting service supported for embedding.

Tags

Editor, Formatting, Guide, Help, List, Numbered, Preformatted, Wikinut, Youtube

Meet the author

author avatar Sam Wormleighton
I am Wikinut's top technical author and advisor, which makes me a pretty big nut when you think about it!

Share this page

moderator Chief Nut moderated this page.
If you have any complaints about this content, please let us know

Comments

Username
Can't login?
Password