UCL WIKI

UCL Logo

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
{float:right\|width=300px\|background: #F0F0F0\|border: solid navy} {toc:outline=true\|indent=0px\|minLevel=1} {float} _By Chris Dillon 21/05/08. Version 5.1_ Latest version at: [
Wiki Markup
Float
right
right
2background: #F0F0F0
3border: solid navy
width300px
Table of Contents
minLevel1
outlinetrue
indent0px

By Chris Dillon 21/05/08. Version 5.1
Latest version at: http://wiki.ucl.ac.uk/display/AboutWiki/About+the+UCL+Wiki

...

It

...

is

...

recommended

...

that

...

you

...

use

...

Firefox

...

or

...

Internet

...

Explorer

...

on

...

the

...

PC,

...

and

...

Firefox,

...

Camino

...

or

...

Safari,

...

on

...

the

...

Mac.

...

Why

...

would

...

you

...

want

...

to

...

use

...

a

...

wiki?

...

Wikis

...

may

...

be

...

used,

...

for

...

example,

...

for:

...

  • structures

...

  • of

...

  • articles

...

  • on

...

  • subjects

...

  • à

...

  • la

...

  • Wikipedia

...

  • collaborative

...

  • work

...

  • (e.g.

...

  • in

...

  • teaching

...

  • and

...

  • learning)

...

  • for

...

  • research

...

  • groups

...

  • for

...

  • committees

...

  • for

...

  • projects

...

  • sharing

...

  • technical

...

  • notes

...

  • in

...

  • a

...

  • small

...

  • group

...

  • managing

...

  • projects

...

For

...

more

...

information

...

on

...

why

...

one

...

would

...

want

...

to

...

use

...

a

...

wiki,

...

click

...

here

...

.

How do I login to UCL Wiki?

Go to http://wiki.ucl.ac.uk

...

and login with your normal UCL user ID and password.
The page which appears is the UCL Wiki Dashboard. It lists the spaces (i.e.

...

different

...

areas

...

in

...

the

...

wiki)

...

to

...

which

...

you

...

have

...

access

...

in

...

a

...

column

...

on

...

the

...

left.

...

You

...

may

...

be

...

able

...

to

...

see

...

some

...

spaces

...

without

...

logging

...

in,

...

but

...

you

...

won't

...

be

...

able

...

to

...

do

...

much.

...

How

...

do

...

I

...

add

...

a

...

comment

...

to

...

a

...

page?

...

As

...

you

...

navigate

...

through

...

pages

...

in

...

spaces,

...

you

...

will

...

find

...

Add

...

Comment

...

links

...

on

...

some

...

pages.

...

If

...

you

...

have

...

a

...

short

...

comment,

...

you

...

can

...

use

...

these.

...

Someone

...

else

...

may

...

reply

...

to

...

your

...

comment

...

thus

...

creating

...

a

...

threaded

...

discussion.

...

If

...

your

...

comment

...

is

...

more

...

substantial,

...

you

...

may

...

want

...

to

...

edit

...

the

...

page

...

itself,

...

if

...

you

...

have

...

been

...

given

...

the

...

right

...

to

...

do

...

so

...

(you

...

can

...

see

...

the

...

Edit

...

tab

...

at

...

the

...

top

...

of

...

the page).

How do I edit a page?

  • You must have sufficient permission to be able to edit a wiki page. You will see various tabs at the top of wiki pages. If you can see the Edit tab, you can click on it to edit the page (or the page's title).
  • After clicking the Edit tab you will see three further tabs, Rich Text, Wiki Markup and Preview.
  • If you are using one of the recommended browsers (see the top of this guide), a WYSIWYG editor (the Rich Text tab) will appear with Word-like formatting options.
  • The Format drop-down box is the recommended way to add headings and other styles. Remember to save any changes before navigating away from the page you're working on!
  • Once you're done editing, just hit the "Save" button and the updated page will replace the older version.

You may find it quicker to create content by using wiki markup. Using wiki markup is a powerful way to add design and functionality to your wiki pages. To do this, click the Wiki Markup tab. There is a summary of the markup system available from the full guide link in the right column. Common codes include:

Section
Column
width50%

No Format

h1. Biggest heading
h5. Smallest heading

*bold*
_italic_

---- for a horizontal line across the page

* for a bullet point
** for a sub-bullet
# for a numbered point

[British Library|http://www.bl.uk] for a link to a Web site

{note:title=title of note} text of note
{note}
{noformat} {column} {column:width=50%} h1. Biggest heading h5. Smallest heading *bold* _italic_ \---\- for a horizontal line across the page * for a bullet point ** for a sub-bullet # for a numbered point [British Library|http://www.bl.uk] for a link to a Web site {note:title=title of note} text of note {note} {column} {section} h1. How do I add a new page? * This presumes that the part of the wiki ("space") the page is to be added to exists, if it doesn't, see _Creating a space_ below. * You must have sufficient permission to be able to edit a wiki to add a page. If you can see the _Edit_ tab on a wiki page you can add a new page to that wiki. * The procedure is the same whatever kind of space it is (i.e. _personal_ or _global_). * Navigate to the space or page where you want the new page. * Click the *New Page* hyperlink top right. The default page's name is by default _New Page_. you will want to change this. * Add some content and click *Save*. The new page opens. h2. How do I restrict access to a page? If you want to restrict who can view or edit the page, edit the restrictions below the editor. For more information, please see our tutorial on Page Restrictions. h2. Notes * Putting a link (see below) to a non-existent page creates it. * Once the page is created, you can type text in it or use copy text from Word to UCL WIki. Some Word formatting will be retained. * {color:#ff0000}Each page in a wiki needs to have a unique name.{color} h1. How do I attach a file to a page? Attachments are inconvenient things; don't use them if you can get away with copying text into an ordinary wiki page. {color:#ff0000}It is not possible to attach files larger than 10Mb.{color} Check in Windows Explorer (PC) or Finder (Mac). Navigate to the page to which you want to attach the file. Before going into the editor, click on the *Attachments* tab. Type a brief description of the file in the _Comments_ field and click *Browse* to locate the file to be uploaded into the wiki. To remove an attachment, click on the *Attachments* tab and click the *Remove* button to the right of the file. h1. How do I insert a link? Click the *Insert/Edit Link* icon (it looks like a chain) on the toolbar. To link to a page in the UCL Wiki, search e.g. _Global Spaces_ for the page. Click the link and click OK. (Attachments are included in the search.) To link to a page on the Internet, click on the *External Link* tab and enter the address. (it may be safest to copy the address from your browser's _Address_ field). h1. How do I add an image? Click the *Insert/Edit Image* icon (it looks like mountains) on the toolbar. Click *Browse* to locate the file. In fact images displayed in Confluence pages are attached to the page and you can see them on the _Attachments_ tab. h1. How do I restrict access to a page? Click the *EDIT* link next to _Restrictions_ at the bottom of the page further to restrict who can read and edit the page. See the section on _Creating a personal space_ for information about giving permissions to groups. h1. How do I save a Wiki page as a Word file or PDF? Navigate to the page and click on the *Info* tab. Click on the *PDF* or *Word* link in the *Export As* field. Note: Some spaces may be set up so that viewers don't have permission to do this. h1. How do I view changes or restore older versions of pages? To see individual changes to a page, click on the *Info* tab of the page in question and use the *view changes* links. To compare two versions of a page, use the *Recent Changes* link, tick any two versions and click *Compare selected versions*. Green indicates additions, red deletions. Restore an old version of a page by clicking the *Recent Changes* link. h1. How do I remove pages? Click the *Edit* tab to edit the page in question. Click the *Remove Page* hyperlink top right. h1. How do I create a personal wiki space and give access to it? _Please note that only members of UCL staff can create personal spaces._ Once you are logged on, you should see your name top right as a hyperlink on the UCL Wiki homepage. Click on this link. On the page that appears, you should see a message saying *You can create a personal space to keep your own pages and news*. Click on the *create a personal space* hyperlink. Now you need to set the viewing and editing rights for your space. By default personal (and global) spaces are only viewable by the person concerned. Note: _Registered users - anyone logged into Confluence_ has no effect in the UCL implementation of the software. If you want all registered users to have access, you have to explicitly give access to group "ucl-all". ucl-staff, ucl-hon, ucl-ug and ucl-pg are other useful groups. For detailed information about UCL access groups, see: [
Column
Column
width50%

Biggest heading

Smallest heading

bold
italic
---- for a horizontal line across the page

  • for a bullet point
    • for a sub-bullet
  1. for a numbered point
    British Library for a link to a Web site
    Note
    titletitle of note

    text of note

How do I add a new page?

  • This presumes that the part of the wiki ("space") the page is to be added to exists, if it doesn't, see Creating a space below.
  • You must have sufficient permission to be able to edit a wiki to add a page. If you can see the Edit tab on a wiki page you can add a new page to that wiki.
  • The procedure is the same whatever kind of space it is (i.e. personal or global).
  • Navigate to the space or page where you want the new page.
  • Click the New Page hyperlink top right. The default page's name is by default New Page. you will want to change this.
  • Add some content and click Save.
    The new page opens.

How do I restrict access to a page?

If you want to restrict who can view or edit the page, edit the restrictions below the editor. For more information, please see our tutorial on Page Restrictions.

Notes

  • Putting a link (see below) to a non-existent page creates it.
  • Once the page is created, you can type text in it or use copy text from Word to UCL WIki. Some Word formatting will be retained.
  • Each page in a wiki needs to have a unique name.
  • Wiki Markup
    Page titles cannot contain the following characters:
    \\  {{:, @, /, %, \, &, \!, \|, #, $, \*, ;, \~, \[, \], (, ), \{, \} , <, >, .}} \|
    \\

How do I attach a file to a page?

Attachments are inconvenient things; don't use them if you can get away with copying text into an ordinary wiki page. It is not possible to attach files larger than 10Mb. Check in Windows Explorer (PC) or Finder (Mac).
Navigate to the page to which you want to attach the file. Before going into the editor, click on the Attachments tab. Type a brief description of the file in the Comments field and click Browse to locate the file to be uploaded into the wiki.
To remove an attachment, click on the Attachments tab and click the Remove button to the right of the file.

How do I insert a link?

Click the Insert/Edit Link icon (it looks like a chain) on the toolbar.
To link to a page in the UCL Wiki, search e.g. Global Spaces for the page. Click the link and click OK. (Attachments are included in the search.)
To link to a page on the Internet, click on the External Link tab and enter the address. (it may be safest to copy the address from your browser's Address field).

How do I add an image?

Click the Insert/Edit Image icon (it looks like mountains) on the toolbar. Click Browse to locate the file. In fact images displayed in Confluence pages are attached to the page and you can see them on the Attachments tab.

How do I restrict access to a page?

Click the EDIT link next to Restrictions at the bottom of the page further to restrict who can read and edit the page. See the section on Creating a personal space for information about giving permissions to groups.

How do I save a Wiki page as a Word file or PDF?

Navigate to the page and click on the Info tab.
Click on the PDF or Word link in the Export As field.
Note: Some spaces may be set up so that viewers don't have permission to do this.

How do I view changes or restore older versions of pages?

To see individual changes to a page, click on the Info tab of the page in question and use the view changes links.

To compare two versions of a page, use the Recent Changes link, tick any two versions and click Compare selected versions. Green indicates additions, red deletions.

Restore an old version of a page by clicking the Recent Changes link.

How do I remove pages?

Click the Edit tab to edit the page in question. Click the Remove Page hyperlink top right.

How do I create a personal wiki space and give access to it?

Please note that only members of UCL staff can create personal spaces.

Once you are logged on, you should see your name top right as a hyperlink on the UCL Wiki homepage. Click on this link.
On the page that appears, you should see a message saying You can create a personal space to keep your own pages and news. Click on the create a personal space hyperlink.
Now you need to set the viewing and editing rights for your space.
By default personal (and global) spaces are only viewable by the person concerned.
Note: Registered users - anyone logged into Confluence has no effect in the UCL implementation of the software.
If you want all registered users to have access, you have to explicitly give access to group "ucl-all". ucl-staff, ucl-hon, ucl-ug and ucl-pg are other useful groups. For detailed information about UCL access groups, see: http://www.ucl.ac.uk/upi/web-users/intranet-groups

...


You

...

can

...

also

...

create

...

your

...

own

...

groups

...

and

...

add

...

people

...

to

...

them

...

by

...

clicking

...

on

...

the

...

Manage

...

Users/Groups

...

tab.

...

It

...

is

...

better

...

to

...

use

...

this

...

feature,

...

rather

...

than

...

granting

...

permission

...

to

...

individuals,

...

as

...

it

...

is

...

a

...

lot

...

less

...

work

...

if

...

you

...

ever

...

need

...

to

...

change

...

the

...

permissions

...

in

...

future.

...


It

...

is

...

not

...

recommended

...

that

...

you

...

tick

...

Anonymous

...

-

...

anyone,

...

logged

...

in

...

or

...

not

...

,

...

as

...

this

...

would

...

expose

...

your

...

space

...

to

...

mischievous

...

comments

...

from

...

the

...

unscrupulous.

...


The

...

address

...

of

...

your

...

space

...

is:

...

}
No Format
http://wiki.ucl.ac.uk//display/~your seven digit UCL user id
{noformat}
Click *Create*.

It is recommended that you place a watch on your wiki space (*Browse Space \| Advanced \| Start watching this space*) so you may be automatically notified of activity. For more information, click [here|Watching a Space].

If you ever want to remove your space, click the *Browse Space* hyperlink top right and then the *Space Admin* tab. Click *Remove Space*.

h2. Access rights

To adjust who has what access to your space, click the *Browse Space* hyperlink top right and then the *Space Admin* tab. Click *Edit Permissions* under the relevant user category and tick the relevant boxes. Click *Save All*.

For more information on permissions, see: [

Click Create.

It is recommended that you place a watch on your wiki space (Browse Space | Advanced | Start watching this space) so you may be automatically notified of activity. For more information, click here.

If you ever want to remove your space, click the Browse Space hyperlink top right and then the Space Admin tab. Click Remove Space.

Access rights

To adjust who has what access to your space, click the Browse Space hyperlink top right and then the Space Admin tab. Click Edit Permissions under the relevant user category and tick the relevant boxes. Click Save All.

For more information on permissions, see: http://wiki.ucl.ac.uk/display/AboutWiki/UCL+Wiki+Permissions+Explained

...

Your profile

To edit details about yourself, add your photo etc., click on your name top right on the UCL Wiki homepage once logged in.

Click on Preferences top right and then the Edit Profile tab.

Note that information put in your profile is visible to anonymous users of the UCL Wiki.

Advanced formatting

Once you have mastered the basic functions detailed above, you may want to adopt some macros to make things look nice.

To enter macro code, click on the Wiki Markup tag.

For computer code etc. you could use a {noformat} tag before and after e.g.

Section
Column
width50%

{noformat}
copy . s:\Training
{noformat}

Column
width50%
No Format

copy *.* s:\Training
{noformat} {column} {section} {section} {column:width=50%} The \{note\} tag before and after produces an exclamation mark: {noformat}
Section
Column
width50%

The {note} tag before and after produces an exclamation mark:

No Format

{note}
Watch out for this\!
{note}
{noformat} {column} {column:width=50%} {note} Watch out for this\! {note} {column} {section} {section} {column:width=50%} A \{tip\} tag before and after produces a handsome green tick: {noformat}
Column
width50%
Note

Watch out for this!

Section
Column
width50%

A {tip} tag before and after produces a handsome green tick:

No Format

{tip} This was done.
{tip}
{noformat} {column} {column:width=50%} {tip} This was done. {tip} {column} {section} If you want to insert a table of contents at the beginning of your page, picking up headings in your text, use something like: {noformat}
Column
width50%
Tip

This was done.

If you want to insert a table of contents at the beginning of your page, picking up headings in your text, use something like:

No Format
{toc:type=list|indent=10px|minLevel=2}
{noformat}

Lastly,

...

here

...

is

...

the

...

code

...

for

...

creating

...

columns

...

on

...

your

...

page:

...

No Format
Section
Column
width50%

Column one text goes here.

Column
width50%

Column two text goes here.

Section

No Format

Further information

A good general overview may be found at: http://www.atlassian.com/software/confluence/webinar.jsp

...


UCL

...

specific

...

documentation

...

is

...

here:

...

http://wiki.ucl.ac.uk/display/AboutWiki/About+the+UCL+Wiki

...


For

...

detailed

...

documentation,

...

see:

...

http://confluence.atlassian.com/display/DOC/Confluence+Documentation+Home

...

Tips

  1. Do not save your pages too often, as this creates many versions.
  2. Do not leave pages open in Edit mode for a long time, as this puts a heavy load on the server.