User Guide

This page provides technical information on how to create and edit pages on Toxipedia. For tips on how to develop content, please read our writers guidelines. For general information about the site, please read About Toxipedia.

Overview


Toxipedia uses the Confluence Content Management System and the the Rich Text editing system. This system uses icons to direct the text and allows anyone familiar with creating a word document to also create a Toxipedia page. This page provides our users with an overview of the icons and commands needed to contribute to the site. The first step to contributing to the site is registering. If you have any questions as you proceed, feel free to email Project Manager Nick Thorp at njthorp@toxipedia.org.

Confluence and Microsoft Word


Confluence is not compatible with Microsoft Word and directly copying text from Word into this site will result in additional incompatible code within your page. If you wish to copy content into this site, you must copy from a plain text application such as Notepad (Windows), edit (DOS), ed, vi, vim or Gedit (Unix, Linux), SimpleText (Mac OS), or TextEdit (Mac OS X).


Creating a Page Overview


This is a step-by-step guide to creating a page:

  1. You must first register for the site and sign in. After you are signed into Toxipedia, a box will appear in the upper left hand area of the page that looks like this: 
  2. Click on the 'Add Page' link. This will bring up a new screen.
  3. Enter a 'Title' for your page.
  4. Click 'Edit beside 'Location' to change the location of the page.
    From the drop-down menu displayed, select the 'Space' where you want your page to be located.
  5. In the 'Parent Page' input field, specify a parent, if needed.
    1. If you want to move the page to the root directory of a space, leave this field blank. If you clicked on 'Add page' from another page, Confluence will default the new page as a child of the first. To choose a different parent, click on the Choose a Page icon. A pop-up screen allows you select a parent page from one of the tabs displayed or to locate pages anywhere within the site using the search facility.
  6. Enter content for your page using Confluence Notation, or the Rich Text editor. See "Working with Text Effects," below.
  7. 'Preview' if desired. Click 'Add'.


Editing Overview


In order to edit a page follow the steps below. 

  1. Click on the Edit icon on the left hand side of the page. This will bring up the text of the page to edit.
  2. Edit the page. Editing is nearly as simple as making changes in a Microsoft Word document. The tool bar above the text provides familiar commands to shape the text.
  3. Save your work by clicking the "Save" button .


Toolbar Icon Overview



Each icon performs a specific function. Below are details on how to use each icon to build or modify your Toxipedia page.


Working With Text Effects


Applying Headers:


All these headings are available to the Toxipedia user, with "Heading 1" being-the largest and "Heading 6" the smallest. Toxipedia uses "Heading 1" for its paragraph headers. To select a header, highlight the word or words, select the drop-down menu, and choose the desired header.

Here are examples of the other "Non-Heading" options the drop-down menu provides:

Paragraph:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 

Quote:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Preformatted:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. 

Panel:

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Code:

Text Icons:


To Do This

Click This

Shortcut Key

 Bold

Ctrl+ b (On Windows), Apple + b (on Mac)

 Italics

Ctrl + i (On Windows), Apple + i (on Mac)

 Underline


Ctrl-u (On Windows), Applu + u (on Mac)

 Strike

None


Text Colors:

1. Click on the Text Color Icon ( ). A small color menu will appear.

2. Pick a color from the menu that appears: 

 

Table Commands


To create a table:

  1. Click on the Rich Text Editor toolbar. This will pop up a window.
  2. Enter the number of columns and rows for your table.
  3. Check the box if you want a heading style applied to the first row of the table.
  4. Click 'Insert'.

To do this

Click This

Add  row (before)

Add  row (after)

Delete row

Add column (before)

Add column (after)

Delete  column


Lists


To get this list

Click this 

Bulleted List

Numbered List

Outdent

Indent



1. Click the 'Insert Link' icon in the tool bar. The 'Link Properties' screen will appear. 

2. In the 'Link' text box, enter the URL (location) of the link.
(info) Use the tabs to help you find the URL: 

  • Search - Search the spaces in your Confluence site for a particular term or phrase, then select your link location from the search results.
  • History - Select your link location from recently-visited pages.
  • Recently Modified - Select your link location from pages recently modified by you or other Confluence users.
  • External Link - Enter the URL of an external location.
  • Attachments - Select one of the attachments to the current page. You can also browse for a file and attach it to the page, then select it to create the link.

3. If you want your link to display specific words on the page, rather than the actual URL, enter the desired text in the 'Alias' text box.

4. If you want your link to display a short popup help tip, enter the desired text in the 'Tooltip' text box.

5. Click the 'OK' button to add the link.


Displaying an Image


 Main Article: Working with Images
1. Click on the 'Image' ( ) icon in the toolbar:
2. This will open up the 'Image Properties' window. All attached images are displayed. You can either:

  • Click on an image to select it, then click 'OK' to insert the image;
    OR:
  • To attach a new image, 'Browse' to select your file; then click 'Attach'; then select it and click 'OK'.

3. If you want to display an image attached to the page, click one of the attached images. The image name will appear in the 'Filename' text box.

4. If you want to display a remote image, enter the URL in the 'File Name' text box.

5. If you want the Confluence page to display a smaller version of your image rather than the full-size image, click the 'Thumbnail' checkbox. This will also hyperlink the image - if the user clicks the image, a new window will open displaying the full-size image.

6. If you want to control the placement of the image on the page, select a value from the 'Alignment' drop-down list. Available values are 'None' (i.e. default), 'Left,' 'Centre,' and 'Right'.

7. Click 'OK' to insert the image on the Confluence page.


Additional Commands


To do this

Click This

Undo an action

Redo an action

Insert horizontal line after paragraph title

Insert an emoticon

Insert custom character

Toggle fullscreen mode


Additional Page Controls


Toxipedia allows the user significant freedom to navigate and improve not only specific pages, but the entire site as well. As always, you must be registered and singed in to edit the page or access the controls. After you are registered, use the links in the "Control Box" to navigate the site. In order to access the "Control Box," the user must follow these steps:

  1. Click on the "Open Controls" button:
  2. View the options in the Control Box:


Control Box Options:

Below are overviews of the "Control Box" Options users can employ to improve their page and navigate the site.

Attachments:

Main Article: Working with Attachments

Use Toxipedia's Attachments function to display the list of attachments that belong to a page.

Info:

The info function provides the user with a detailed page history of the page they are currently viewing. By opening up the "Info" for the page, the user can view the incoming links to the page, outgoing links from the page, past versions of the page, edits that were made, and other pertinent information about the page.

Dashboard:

The Dashboard is the front page of a Confluence site. It provides an overview of the site, access to all spaces to which you have 'view' permission, and displays a list of recently updated content.

You can go to the Dashboard from any page on your site by clicking on the logo beside the page title or via the Breadcrumbs (the "You are here" path) located at the top of every page.

The dashboard is divided into five sections:

  1. The Welcome Message for the site, which is configured from the Administration Console.
  2. A list of the spaces within the site to which you have access, presented via convenient tabs: 'My', 'Team', 'New' or 'All' spaces. See Customizing the Dashboard.
  3. A list of the most Recently Updated documents on the site from the spaces listed. For example, if you click on the tab 'Team,' the recently updated content from your team spaces will be listed here.
  4. A list of your Favorite Pages. See Working with Favourites.

The Dashboard is the only place in Confluence from where you can:

  • access all existing spaces on the site.
  • add a new space to the site.

By default, the Dashboard is also the site homepage. However, you can set any other page in Confluence as the homepage through the Space Admin tab or your User Profile settings.

Browse Space:

Main Article: Browsing a Space

The 'Browse Space' view is your window to space-wide summary information as well as to a host of tools relating to the management of your space. 

  • No labels