User Manual

Editing a Wiki Page

You can use the Wiki for providing an overview of a project. You can also post lab notes, contacts, or project details on the wiki. The Wiki supports Markdown and MathJax syntax.
The Wiki allows all contributors of a team to edit collaboratively. You can also share the Wiki with contributors to allow them editing. All versions of the edited Wiki page are saved, so you can always go back to the previous version and compare it with the current content.

Opening the Wiki Editing Screen

Click 'Wiki' in the navigation bar on a project's main screen and move to the Wiki editing screen.
If the 'Edit' button on the toolbar at the top right of the screen is not turned on, click it to turn it on to display the 'Edit' pane. *(This will be displayed separately.) Enter the content in the 'Edit' panel.

Opening the Wiki Editing Screen

When you turn on the 'View' button on the toolbar, the 'View' pane will appear in the centre. The content you have entered will be displayed as a preview.

Opening the Wiki Editing Screen

Formatting the Text

Even if you don't know the Markdown syntax, you can format the Wiki from the toolbar on the 'Edit' pane. The formats that can be set are as follows in order from the left.

  • Bold formatting
  • Italic formatting
  • Inserting a hyperlink
  • Inserting a blockquote
  • Inserting a code sample
  • Inserting an image
  • Inserting a numbered list
  • Inserting a bulleted list
  • Inserting a heading
  • Inserting a horizontal rule

The next two buttons are not formatting buttons, but allow you to 'undo' and 'redo' the input.
If you check the autocomplete checkbox, autocomplete will be enabled. It will predict Wiki syntax from the characters you type.

Formatting the Text

Embedding a File

Embedding files from NII storage

To browse the files uploaded to NII storage from the Wiki page, open the file you wish to embed and copy the Globally Unique Identifier (GUID) from the file's URL.
When you open the uploaded file, the URL will have the following format.

https://rdm.nii.ac.jp/ptsg4/

In this example, the GUID is the 5 characters 'ptsg4' after https://rdm.nii.ac.jp/.

Embedding files from NII storage

In the Wiki editor, paste the following syntax GUID and embed it using the following syntax.

@[osf](GUID)

If the GUID is ptsg4, it will be as written below.

@[osf](ptsg4)

When you click the green ‘Save’ button below the ‘Edit’ pane, the changes will be reflected and the specified file will be embedded in the Wiki.

Embedding files from NII storage

Uploading an image file in a local folder

You can drag and drop image file(s) from your local folder into the 'Edit' pane.
Click the green 'Save' button below the 'Edit' pane to save your changes.

Uploading an image file in a local folder

Embedding an image

To embed the image uploaded to a project in the Wiki, copy the URL of the image.
For information on how to upload an image to a project, please refer to 'Registering a File' in the manual.
When you click the 'Insert an Image' icon on the Wiki editor toolbar, a modal window will appear.

Embedding an image

Paste the URL of the copied image address and click 'Add' to embed the image in the Wiki page.
Click the green 'Save' button below the 'Edit' pane to save your changes.

Embedding an image

Adjusting the image size

When you embed an image in a Wiki, a footnote will be included in the Markdown syntax.

Adjusting the image size

To change the image size, first delete this footnote and the footnote number immediately after the image description. Then, add the image URL enclosed in half-width brackets immediately after the image description.

![enter image description here](https://mfr.rdm.nii.ac.jp/...)

Adjusting the image size

To specify the size of the image in pixels, add the following syntax after the image URL (m, n can be any number of pixels):

![enter image description here](https://mfr.rdm.nii.ac.jp/... =mxn)

Adjusting the image size

To match the size of the image to the page width, add the following syntax after the URL (set as: image URL + space + = + % specified + x).

![enter image description here](https://mfr.rdm.nii.ac.jp/... =100%x)

Adjusting the image size

To change the image size to a relative size, use percentages (n can be any percentage number).

![enter image description here](https://mfr.rdm.nii.ac.jp/... =n%x)

Adjusting the image size

Inserting a Link

To insert a link into the Wiki, click the 'Insert a Hyperlink' button on the toolbar.
In the modal window displayed, enter the URL of the linked site.

Inserting a Link

Inserting a Link

How to Link to Other Wiki Pages

How to Link to Other Wiki Pages

For Wiki links, please use Markdown notation. When linking to the Wiki page of a project, specify it with a relative address such as '../Implementation'.

Adding a Table of Contents

You can add a table of contents to the Wiki. Add the following syntax to the table of contents.

@[toc](optional_label)

The ‘optional_label’ part is the heading of the table of contents. If you left it blank, the heading for the table of contents will be displayed as ‘Table of Contents’. When you insert an item name to be added to the table of contents anywhere in the Wiki according to the following syntax, it will be added automatically to the table of contents. If you click the item name in the table of contents, you will be taken to that location.

## linked text ##

## linked text ##

Adding a Table of Contents

Embedding Videos on External Sites such as Youtube

You can embed videos on Youtube, Vimeo, Vine and Prezi into the Wiki using simple Markdown syntax.

For Youtube videos:

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

For Vimeo videos:

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

For Vine videos:

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

For Prezi videos:

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

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

Inserting a Table

You can insert a table into a Wiki page using Markdown syntax. Line breaks are indicated by staring a new line, and cells are separated by vertical pipes. Please refer to the examples below.

| header cell 1 | header cell 2 |
| ----------- - | ------------ |
| row 1 cell 1 | row 1 cell 2 |
| row 2 cell 1 | row 2 cell 2 |
| ------------- | ------------ |
| row 3 cell 1 | row 3 cell 2 |
| row 4 cell 1 | row 4 cell 2 |
| ------------- | ------------ |
| row 5 cell 1 | row 5 cell 2 |

Inserting a Table