Use the wiki

The wiki is a versatile tool for interacting with your team and others who view your work. Wikis can be used to explain the main points of your project and can contain information like lab notes, contact information, or more in-depth details about your project.

The wiki supports collaborative editing, meaning your entire team can work on it at the same time. You can also make wikis publicly editable to allow visitors to your project to contribute. All versions of a wiki page are saved, so you can always go back to previous versions and compare current wikis with previous iterations.

Go to the wiki

Go to your project or component. Then click either the Wiki tab in the navigation bar or the icon in the top right of the "Wiki" section.

You will be taken to your wiki.

Edit the wiki

Click the Edit button in the top right of the page. The "Edit" pane will appear in which you can enter and edit content.

Type your notes in the "Edit" pane on the right. The middle pane, called "View,"  previews the wiki content as you type and can be toggled off by clicking the View button (next to the "Edit" button).

The wiki supports Markdown and MathJax syntax for formatting, which is explained below. Learn more about how to use Markdown and MathJax by clicking these links.

Format text, bullets, headings, and more

Formatting text, bullets, headings, and more

The toolbar above the Edit pane contains several buttons to help you format your wiki, even if you don't know Markdown syntax. In order from left to right, they are as follows:

Format text in bold

Format text in italics

Insert a hyperlink

Insert a blockquote

Insert a code sample

Insert an image

Insert a numbered list

Insert a bulleted list

Insert a heading

Insert a horizontal line

The next two buttons, though not formatting buttons,  allow you to undo or redo typing in the wiki. Finally, autocomplete can be turned on by checking the box and the wiki will try to anticipate what you are typing and complete the word for you.

Embed images

To embed images in a wiki, click the embed image icon in the toolbar.

Insert the URL for the image into the modal that appears and click Add. You can also add an image description if you choose.

If the image you want to embed in the wiki is one of your own, you will need to upload it to your project first. See the Uploading Files article to learn how to upload and view files.

Click on the name of the file to open its "File Detail" page. Then, right click on the image and select "Copy image address" to copy the URL for the image (Note: the URL will have the form: https://mfr.osf.io/export?url=https://osf.io/vfq7g/?action=download%26direct%26mode=render&initialWidth=628&childId=mfrIframe&format=1200x1200.jpeg -- NOT the short URL points to the File Detail page).

To insert a hyperlink into the wiki, click the Insert link button in the toolbar. Type the URL of the website you'd like to link to in the modal (e.g., https://osf.io), then type your text inside the brackets that appear (e.g., The Open Science Framework)

Inserting links

Insert anchors

First, add a table of contents using the following syntax:

@[toc](optional_label)

Without the optional label, the text will say "Table of Contents."

Then, insert your anchor(s) anywhere in the wiki using the following syntax:

## linked text ##

## linked text ##

Embed Youtube or Vimeo videos

You can embed Youtube, Vimeo, Vine, and Prezi in a wiki using a simple bit of Markdown syntax.

For a Youtube video:

@[youtube](https://www.youtube.com/watch?v=NqC2uagJZpw)

For a Vimeo video:

@[vimeo](https://vimeo.com/127891298)

For a Vine video:

@[vine](https://vine.co/v/hApxwH3Uax2/embed)

For a Prezi:

@[prezi](https://prezi.com/9jcaq4arxj22/communicating-science-to-the-public/#)

Replace the URL with the address of the video or presentation you wish to embed.

Add a table

You can insert tables in a wiki by using markdown syntax: each row on a separate line, with vertical pipes to separate cells. See the example below:

 

| Characteristics | Types |

| ------ | ----------- |

| Altered Wing Structures   | Short, long, none |

| Altered Body Color | brown, gold, green |

| Altered Eye Color    | brown, red, hazel |

Add and delete wiki pages

You can add or delete wiki pages by using the buttons on the left side of the Wiki page. To add a wiki page, click the +New button and type a name into the modal that appears.

To delete a wiki page, select it from the list of wiki pages and click the Delete button in the toolbar. Please note that you cannot delete the "Home" wiki page.

Rename wiki pages

To rename a wiki page, click on its name in the top left of the screen. A text edit box will open, allowing you to change the name.

Click the green check mark to accept changes or the X to cancel your changes. Please note you cannot rename the "Home" wiki page.

View and compare previous versions

Every time a user clicks Save on a wiki page, a new version of the wiki is saved to the OSF.

You can click the Compare button in the top right of the page to access and compare previous versions of the wiki. Then, use the drop-down menu in the middle and right pans to select the versions of the wiki that you want to compare.

Make your wiki publicly editable

You can make your wiki editable to any other OSF user by modifying its settings. For a wiki to be publicly editable, the project must be public.

You might use this feature to crowdsource a scientific project or use it to collect questions or feedback from others.

Click the Settings tab in the gray navigation bar, and the project's "Settings" page will appear.

Click Wiki from the left sidebar, and then choose who can edit your wiki from the drop-down list:

  1. only contributors with write access to the project
  2. or, any OSF user.

Note: By default, wiki commenting is set to contributors with write access to the project.