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
Wiki Markup
Float
right
right
2background: #F0F0F0
3border: solid navy
width300px
Table of Contents
minLevel1
outlinetrue
indent0px

By Chris Dillon 21/05/08.

...

Version

...

4.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

...

Camino

...

or

...

Firefox,

...

rather

...

than

...

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

...

Logging

...

in

...

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.

...

Adding

...

a

...

comment

...

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).

...

Editing

...

a

...

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).

...


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

...

!

...

You

...

may

...

find

...

it

...

quicker

...

to

...

create

...

pages

...

by

...

using

...

wiki

...

markup.

...

To

...

do

...

this,

...

click

...

the

...

*Wiki

...

Markup

...

*

...

tab.

...

There

...

is

...

a

...

summary

...

of

...

the

...

markup

...

system

...

in

...

the

...

right

...

column.

...

Common

...

codes

...

include:

...

Section
Column
width50%
Code Block

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}
{code} {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} Use the *full guide* link at the top of the column for a complete list of wiki markup. Note: You will find it quicker to create tables on the _Rich Text_ tab than on the _Wiki Markup_ tab\! h1. Adding 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. 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. 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 Confluence. Some Word formatting will be retained. * {color:#ff0000}Each page in a wiki needs to have a unique name.{color} h1. Attaching a file to a page in the wiki Attachments are inconvenient things; don't use them if you can get away with copying text into an ordinary wiki page. {color:#990000}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. Inserting 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. Adding 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. Restricting 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. Exporting a 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. Viewing changes and restoring 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. Removing pages Click the \*Edit\* tab to edit the page in question. Click the \*Remove Page\* hyperlink top right. h1. Creating a personal space in the wiki 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
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

Use the full guide link at the top of the column for a complete list of wiki markup.
Note: You will find it quicker to create tables on the Rich Text tab than on the Wiki Markup tab!

Adding 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.

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.

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 Confluence. Some Word formatting will be retained.
  • Each page in a wiki needs to have a unique name.

Attaching a file to a page in the wiki

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.

Inserting 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).

Adding 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.

Restricting 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.

Exporting a 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.

Viewing changes and restoring 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.

Removing pages

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

Creating a personal space in the wiki

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:

...

}
Code Block
http://wiki.ucl.ac.uk//display/~your seven digit UCL user id
{code}
Click *Create*.

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. 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.

{color:#cc0000}Note that information put in your profile is visible to anonymous users of the UCL Wiki.{color}


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.

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

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.

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://www.ucl.ac.uk/display/AboutWiki/UCL+Wiki+Permissions+Explained

...

Advanced formatting

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

For macros, click on the Wiki Markup tag.

For computer code etc. you could use an

No Format
 tag before and after e.g.

{unformat} copy *.* 

copy . s:\Training

...

No Format

Further information

Wiki Markup
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

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