UCL WIKI

UCL Logo
Child pages
  • How do I edit a Wiki page?
Skip to end of metadata
Go to start of metadata

This page outlines how to edit a wiki page, add comments and insert media (such as YouTube videos).

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 about the page, 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 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 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 - see below).
  • Navigate to the space or page where you want the new page.

EITHER:

    • Click the New Page link top right. The default page's name is by default New Page. You will want to change this. Do not use punctuation or special characters when you name a page as this produces nasty URLs with lots of numbers in them!
    • Add some content and click Save.
      The new page opens.

OR

Note:

    • Each page in a wiki needs to have a unique name.
    • Page titles cannot contain the following characters::, @, /, %, \, &, !, |, #, $, *, ;, ~, [, ], (, ), {, } , <, >, . |
    • 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.

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. If it's only a small change you don't want to notify anyone watching the page about, click Minor change at the bottom before you save.

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, select the Wiki Markup tab after selecting the Edit tab. There is a summary of the markup system available from the full guide link in the right column. (This only appears when you're editing.) Common codes include:

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

text of panel (which sticks out from the rest of the text)

title of note

text of note




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

text of panel (which sticks out from the rest of the text)

title of note

text of note



Note that it is also possible to edit wiki pages in Word..

How do I view a site map of all the pages in a wiki space?

Click on Tools and then View in Hierarchy for a useful list of all the pages in your wiki space. You can re-order your pages by dragging and dropping them in this view as well.

How do I restrict access to a page?

If you want to apply restrictions in addition to the default ones on who can view or edit the page, select the EDIT link next to Restrictions at the bottom of the page whilst you are editing the page. Type the user's name or username (UCL user id) and click Search. Tick the relevant box and click Select User(s).

See the section on Creating a personal space for information about giving permissions to groups. For more information, please see our tutorial on Page Restrictions and Managing Groups.

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. Put the name of the link in the Alias field. Click the link that appears after your search 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).

To get your link to open in a new browser window, use the following syntax:

To link to an e-mail address, click on the External Link tab and enter *\* (mailto:*) followed immediately by the address. E.g. your.address@ucl.ac.uk

To link to an anchor (a location within the same web page), link to pagename#anchorname E.g. AboutWiki:Guide to the UCL Wiki#access

To insert the anchor in the page, use this syntax:

Anchor names should be short and contain no capital letters or spaces.

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 link to a YouTube video?

YouTube videos have addresses in the form: https://www.youtube.com/watch?v=-dnL00TdmLY

It's that bit after ?v= that you need in the URL (example above). Click on the markup tag and add e.g. :

Insert > Other macros  and search for "YouTube"

Insert your code into the first field: -dnL00TdmLY and click Insert. Your video will appear in your page as a code and will display properly when you Save the page.

where you want the video to appear on your page. Wow!

Can I import Word documents?

To import a Word document, click the Doc Import tab at the top of the page and select a Word document to be imported. If you just click Import, the converted document will completely replace the existing page, apart from the title, so you should use it on an empty page. Click the Advanced button for more options: the most useful of these is to split large documents into several wiki pages according to the headers in the original document - the pages will become children of the current page.

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) before you upload a file.

  • Navigate to the page to which you want to attach the file.
  • Before going into the editor, select the Attachments tab.
  • Type a brief description of the file in the Comments field and select 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 embed a Word document or Excel spreadsheet?

See Using the Office Connector.

How do I rename or move a page?

  • To rename a page, just select the Edit tab and change the page's name in the Space field. By so doing, you will break any links to your page, but you get a warning message.
  • You can also move the page to another part of the wiki by clicking the Edit tab and using the magnifying glass icon next to the Parent Page field. If the magnifying glass isn't visible, click EDIT next to the Location field at the top of the page.

You may prefer to use the cut and paste method in markup with Ctrl-A (to highlight the whole text), Ctrl-X (to cut it), click Remove Page and then create a new page and use Ctrl-V to paste the text in the markup there. (If you're using a Mac, use Command instead of Ctrl!)

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 link, top right.

How would I create a template in the wiki?

Templates are useful if there is content which stays the same on many pages or one wants to encourage people to lay pages out so that they look similar.

You need to be a space administrator to create a space template.

  • Click Browse > Advanced and then Templates in the left column.
  • Click Add New Space Template.
  • Give the template a name in the Name field and an optional description in the Description field.
  • The WYSIWYG editor is not available in this screen. Use Wiki markup (see above) to input the content you want in your template.
  • Click Save.

How do I create a page using a template?

  • Choose Add > Page - at the top of the page.
  • Click the Select a page template to start from link above the tabs of the WYSIWYG editor. (You only see this link if there is at least one template available.)
  • Select a template and then Next.
  • Replace the words New Page with the name of the page.
  • Add content as usual.
  • Click Save.

What's all this about labels?

Labels are keywords or tags for a page. If a page has them, you will see them at the top.

By clicking on a label, you can search for other pages with the same label in that space or across the whole of UCL Wiki. Therefore, it is possible to use this functionality to create a simple online database, searchable by lables as keywords.

How do I add labels?

  • Click on the EDIT link next to Labels at the top of your page.
    Anyone with the right to see the page can see the label.
    If you put my: at the beginning of a label, only you can see it.

How do I read news posts about a page?

  • News posts have been replaced by blogs in the latest upgrade - all previous news posts have been automatically updated to blogs. To read blogs on a particular Wiki Space, navigate to that space and click on Browse > Blog.

How do I post a new blog post?

  • To add a new blog post go to the UCL Wiki homepage and click Add Blog Post (top, right). You will be able to choose from a drop-down list of all the spaces you can add a blog post too. Every UCL user will be able to add a blog post to their personal space.

How do I watch for changes to my space?

Wiki space owners who allow UCL staff and students to edit or comment on pages, or who allow anonymous read permission to anyone on the internet should maintain an active awareness of contributions by applying the settings Watch a space or Subscribe to daily updates to that space.
You must be a space administrator (see the Browse > Space Admin link) to do this.

To watch your wiki space, go to Browse > Advanced  > Start watching this space so you may be automatically notified of activity.

Can I get information about the spaces that are visible to me?

You can subscribe to a daily report which sends you an e-mail of changes in all spaces visible to you:

  • Click your name at the top of the page.
  • Select Preferences.
  • Select the Edit Profile tab.
  • Select the Email link in the left-hand panel.
  • Check the box beside Subscribe to daily updates.
  • Click Save.

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

  • Once you are logged on, you should see your name, top right as a link 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 link.
  • Now you need to set the viewing and editing rights for your space by clicking any of the Edit Permissions links. Either type in UCL user ids (followed by comma space if there are several) or use the magnifying glass button to search for users by name.
    By default personal spaces are only viewable by the person concerned, and global spaces are only viewable by the administrators of the spaces 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 explicitly to give access to group ucl-all. ucl-staff, ucl-hon, ucl-ug and ucl-pg are other useful groups. Note the use of the role suffix (e.g. -all) after the hyphen; it would not work if you just used ucl. For detailed information about UCL access groups, see: http://www.ucl.ac.uk/upi/web-users/intranet-groups
    You can add several individuals by typing in user ids separated by comma space.
    Note that the create right is the one you use to give edit access and that you need to give the attach right to people who want to display images.
    Do not give individuals or groups rights they do not need.
    Click Create.
  • If you ever need to adjust the access rights to your space, click on Browse > Space Admin tab and then click on the Permissions link in the left column.

Note:

  • Wiki-users should not give anonymous write access to pages or comments. If such access is given, it is switched off automatically. Spaces persistently enabling such access will be removed.
  • The address of your space is:http://wiki.ucl.ac.uk//display/~your seven digit UCL user id
  • It is recommended that you place a watch on your wiki space (Browse > Advanced > Start watching this space) so you may be automatically notified of activity. 
  •  Note:You can create create your own groups for access control if it's a personal spaces (ONLY global spaces).

What's all this about global spaces?

So far the talk has been about personal spaces. The good news is that global spaces, the main part of the wiki with content from many people, not your personal bit, behave functionally very much the same as personal spaces.

You can apply for a global space on the UCL Wiki by filling in this form to request a wiki space, but first you should consider how the space fits into your own structures: committees/subcommittees, projects/subprojects and the pros and cons of sharing a space.

Changing access rights / permissions

  • To adjust who has what access to your space, click the Browse > Space Admin tab. Select Permissions in the left column.
  • 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

Can I set up my own groups of people and assign rights to those groups?

It is not possible to create your own groups for assigning access rights in the case of a personal space. The procedure for doing it for a global space is:

  • Click Browse > Manage Users/Groups tab. Here you can create your own groups and add people to them.

 Note:

  • 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.
  • You can only create your own groups for access control if it's a global space (i.e. NOT if it's a personal space).

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

How can I change the administrator of my space?

Contact Wiki Support and tell them who you want to be administrator. It needs to be a member of UCL staff.

How would I remove my space?

If you ever want to remove your space, click Browse > Space Admin tab. Click Remove Space.

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.

Displaying programming code on your wiki page

To display programming code etc. it is common practice to use a {noformat} tag before and after e.g.

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


 E.g.copy . s:\Training


Adding Actions etc.

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

Watch out for this!



Watch out for this!




Adding a completed item (with a tick)

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

This was done.



This was done.




Adding a Table of contents

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


Adding Columns

Here is the code for creating columns on your page:

Column one text goes here.

Column two text goes here.


Column one text goes here.


Column two text goes here.


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

  • No labels