Wikis are available in Synapse both on the
Project level and on
Files/Folders to provide a space to build narrative content to describe the research.
Every project has a Wiki tab where you can build pages and a hierarchy of subpages as you would with any website. These pages can be reordered through the Edit Order button below the Wiki pages.
Wikis can also be added to
Files allowing additional content documentation.
Wikis, whether they are under the Wiki tab or on a folder, are built in the same way and enables incorporation of highly customized content including, but not limited to: images, tables, code blocks, LaTeX formatted equations, and scholarly references. In addition, Synapse-specific widgets lets you embed dynamic content based on other resources stored in Synapse.
After creating a new project select the Wiki tab. Start a
Wiki through the Tools menu by selecting the ‘Edit Project Wiki’ function. Content in this first
Wiki becomes your
Project’s home page. Go to the Tools menu to add subpages to your
Wiki. These will appear as links on the left side of your home page. Adding a
Wiki to a
File is done in a similar manner by selecting ‘Edit Folder/File Wiki’. Content added to a
Wiki can be Previewed before Saving. Each version of a saved
Wiki is visible under Wiki History where older versions can be restored. To delete a
Wiki select ‘Delete Wiki Page’ under Tools.
Wiki pages do not have
Conditions for Use as a feature. Therefore, do not put any protected human data (
Controlled Data) in Synapse
Wikis. See the Synapse Data Use Procedure document for details.
The layout and text of a
Wiki can be customized using Wiki markdown language. A Formatting Guide is available within the Wiki editing window. For additional markdown functions see Markdown in Synapse. Useful markdown shortcuts are available as separate tools, including: heading, bold, italic, strike-through, code block, sub and superscript.
To create a table you separate the columns by the pipe character (|). A Header can be added by separating the first row by dashes (-). A header allows the table to be sorted by each column. A simple table would be created by the following markdown.
```` Header 1 | Header 2 | Header 3 | --- | --- | --- | a | b | c | ````
For more table settings see the formatting guide at the top of the wiki editor.
Files, images and videos can be attached to a
Wiki. This may be content on from the web, your desktop, or
Files already uploaded to Synapse. Links can be added to content available from any source with a url or to a Synapse users profile through the Tag someone widget, or by typing @ - just enter the Synapse username in the dialog that appears.
On the project Wiki page, go to ‘Tools’ and click on ‘Edit Project Wiki’
See the ‘Insert’ list for the following widgets to customize your Wiki design.
|Widget||Hover over the image to see what the widget will look like when embedded in your project|
Create a reference list by linking to papers using the References widget
Embeds a preview window for csv, txt and image files
Embeds the provenance graph created for a file
|Table of Contents
Creates a content list that links to sections of the wiki based on headers and subheaders
A list of Synapse
|Table: Paste tabular data
A table can be created of any data by pasting tab delimited content into this widget window.
|Table: Query on a Synapse
Provides a Query for any Synapse
Provides a Query based an annotations (need link) added to
Insert a button that links to content within Synapse or elsewhere. Tip: buttons can be colored purple by adding
|Join Team Button
Provide a button for people to join Synapse Teams
Creates a link to the
You can add a Biodalliance genome browser using tracks from files uploaded to Synapse or from external sources. Choose between Human or Mouse and adjust your tracks for height and color. See the Biodalliance Setup page for more information
Video, Vimeo Video, and YouTube Video insert a video from various sources.
Try posting a question to our Forum.
Let us know what was unclear or what has not been covered. Reader feedback is key to making the documentation better, so please let us know or open an issue in our Github repository (Sage-Bionetworks/synapseDocs).