Purpose

The purpose of this tutorial is to teach you how to use the Wiki. By the end of the tutorial, you should be able to create new collabs, create new pages in a collab, delete pages and collabs, and understand how the navigation menu is constructed.

Creating a new collab

To create a new collab, you must first select the "Collabs" option from the top navigation menu. This will bring you to the "Collab search" page; however, at the top right of the page, you have a "Create a collab" option. Note that you must be logged in to see this option.

After you click on "Create a collab," you will be brought to the collab-creation form which looks like this: 

Collab title - The title is what users see at the top of the left hand navigation pane.
Collab name (also called slug) - This identifies your collab and is automatically filled from the title. The collab name is what will appear in the URL of your collab.
Description - The description of your collab, this will appear in listing and search results.
Visibility - This is whether your collab is private  or public. Private can only be viewed by people you specify in the collab's Team, while public can be viewed by anybody.

Once you have filled out all of the above fields and selected your visibility, you click "Create Collab." After a short delay, your collab will be constructed, and you will be automatically brought to the main page of your new collab.

Adding members to your collab

To add members to your collab, you need to visit the "Team" navigation element on the left-hand side of the page, as shown in the figure below.

Once there, you can add a user by clicking on the "add user" button. A pop-up will appear to search for the user you want to add.

When you click on this user, they will be added to your Team. If you click “add user” in the "Admins" tab, they will be added as an admin. The same applies if you are in the "Editors" or "Viewers" tab.

You can also add entire Units or Groups to your collab's Team from this page. This is the preferred method whenever possible: users have a role from the Unit or Group they are in and permissions to access a collab are granted by that role rather than individually. When users change role in the future, their permissions are adapted accordingly and automatically.

Creating a new page in your collab

To create a new page, you need to have admin or editor rights for the collab. Select the page under which the new page should be added; this can be that collab's home page or any wiki sub-page. The Wiki navigation pane shows the selected collab's home page and wiki sub-pages alongside other navigation elements.

With this in mind, you can create a page by visiting any of your wiki pages and clicking on the "Create" button in the top right corner of that page.

Whatever page you click "Create" on will be the parent of the new page. For example, if you click "Create" in the above image, the new page will be a sub-page of "Pauls test." You can see in the image above the "Top level page" was created by going to "Pauls test" and clicking create.

If you visit "Top level page" and click "Create", the new page will be a sub-page of "Top level page." This is exactly what will be done for the next demonstration.

After you click "Create", you will have the option to choose what you want to create. The following image is what you will see.

The title is the name of the new page. The location is the full path it will take in the wiki page hierarchy, as mentioned above. By clicking on "Top level page" and then clicking on "Create," this will be a sub-page of "Top level page." The following page types are currently supported:

Blank page - A standard blank wiki page.
Article - A page with an auto-generated table of content which will be displayed in the right margin. It comes with sample content which can be useful to get started quickly.
Community App - To embed a community app in the Wiki page. Community apps are web services designed to be displayed in the Collaboratory Wiki context. You can choose one from a list of apps. More details can be found in our community app documentation.
Integrate external page with an iFrame - This allows you to insert any web page from any web server as an iFrame inside this new page. It can be used e.g. to give direct access to Jupyter Notebooks from your collab's navigation. Note: some web servers disable the feature of embedding their pages in an iFrame.

For now, we can click on “Article” and click "Create." This will bring you to the final stage of creating a new page. When you select "Article," it will bring you to a page with pre-existing content that you can modify. Once you press "Save & View" or "Save", the page will be created and can be visited. After doing all of the above, here is the new structure: 

NOTE: You cannot change the type after you have created a page.

Deleting a collab page

To delete a collab page, you must first go to the page you want to delete. You need to have editor or admin rights to delete a page. Once on the page, click on the kebab icon (3 vertical dots) beside the "Create" button to bring up a menu. From here, you can click on the "Delete" option as shown in the following screenshot.

Once you click this button, you will get a confirmation screen. After you confirm, your page will be deleted. 

NOTE: Currently the only way to restore a deleted page is via support, so be careful performing this action.

Deleting a collab

To delete an entire collab, you need to repeat the steps for deleting a collab page, except this time, you need to do it from the collab's main page. If you visit "Pauls test" page and click delete, you will be given one more option which is to "Affect children" as well. If you click this, the entire collab will be deleted.

Conclusion

At this stage, you should be able to construct a collab in the way you want and remove anything from the collab you want to remove. You should also have an understanding of how to add users to your collab.