Wiki source code of Tutorial

Version 16.1 by chaney08 on 2021/06/08 12:27
Show last authors
1 == Purpose ==
2
3 The purpose of this tutorial is to teach users how to use the Collaboratory.Wiki. By the end of the tutorial users should be able to create new collabs, create new pages on the collabs, delete pages and collabs, and to understand how the navigation menu is constructed.
4
5 == Creating a new collab ==
6
7 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 will have a "Create a collab" option. Note that you must be logged in to see this option.
8
9 After you click on "Create a collab" you will be brought to the collab creation form which should look something like this : [[image:1623147909367-226.png]]
10
11 **Collab title** - The title users will see when the first the collab
12 **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.
13 **Description** - The description of your collab, this will appear in listing and search results.
14 **Visibility** - This is whether your collab is private  or public. Private can only be viewed by people you specify, while public can be viewed by anybody ( But only edited by people you add to the team)
15
16 Once you have filled out all of the above fields and selected your visibility, you click "Create Collab". After a small delay your collab will be constructed and you are automatically brought to the main page of your new collab.
17
18 == Adding members to your collab ==
19
20 To add members to your collab you need to visit the "Team" navigation element on the left hand side of the page
21
22 [[image:1623147787085-789.png||height="300" width="1123"]]
23
24 Once here, you can add a user by clicking on the "add user" button, this will create a small popup where you can search for the user you want to add.
25
26 [[image:1623147811388-407.png||height="400" width="527"]]
27
28 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, same applies if you are in the "Editors" or "Viewers" tab. You can also add entire units or groups from this page.
29
30 == Creating a new page in your collab ==
31
32 To create a new page you need to have admin or editor rights for the collab. The wiki works with a hierarchy, the top level pages will all be "Under" the collab itself, for example, my top level elements will be under "Pauls test"
33
34 [[image:https://wiki.ebrains.eu/bin/download/Collabs/collab-devs/Documentation%20Wiki/Tutorial/WebHome/1623080798301-211.png?rev=1.1||alt="1623080798301-211.png" height="230" width="250"]]
35
36 With this in mind, you create a page by visiting any of your wiki pages and clicking on the "Create" button in the top left of that page.
37
38 [[image:https://wiki.ebrains.eu/bin/download/Collabs/collab-devs/Documentation%20Wiki/Tutorial/WebHome/1623080879820-462.png?rev=1.1||alt="1623080879820-462.png"]]
39
40 Whatever page you click "Create" on will be the parent of the new page. For example, if I click "Create" in the above image, the new page will be a subpage of "Pauls test", you can see in the image above the "Top level page" was created by going to "Pauls test" and clicking create.
41
42 If I visit "Top level page" and click "Create", then the new page will be a sub page of "Top level page". I will do exactly that for the next demonstration.
43
44 After you click "Create", you will have an option on what you want to create. The following image is what you will see:
45
46 [[image:https://wiki.ebrains.eu/bin/download/Collabs/collab-devs/Documentation%20Wiki/Tutorial/WebHome/1623081111437-408.png?width=852&height=400&rev=1.1||alt="1623081111437-408.png" height="400" width="852"]]
47
48 The title is the name of the new page. The location is the full path it will take in the hierarchy, as mentioned above, by clicking on "Top level page" and then clicking "Create", this will be a sub page of "Top level page". Type is what you kind of page you want.
49
50 **Blank page** - A standard blank page, nothing will be prepopulated here
51 **Article **- A page with an auto generated structure and a table of content, useful to get started quickly and provides a few examples of what you can do.
52 **Community App** - Linking to a community app, more details found in our [[community app documentation>>doc:Collabs.collaboratory-community-apps.WebHome]].
53 **Integrate external page with an iFrame** - This allows you to insert any page you want as an iFrame inside this new page, very useful to put Jupyter Notebooks into your collab.
54
55 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 examples 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 my new structure
56
57 **NOTE**: You cannot change the type after you have created a page.
58
59 [[image:https://wiki.ebrains.eu/bin/download/Collabs/collab-devs/Documentation%20Wiki/Tutorial/WebHome/1623081496395-702.png?rev=1.1||alt="1623081496395-702.png"]]
60
61 == Deleting a collab page ==
62
63 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, you click on the 3 vertical dots beside the "Create" button to bring up a menu, from here you can click on the "Delete" option as show in the following screenshot:
64
65 [[image:https://wiki.ebrains.eu/bin/download/Collabs/collab-devs/Documentation%20Wiki/Tutorial/WebHome/1623142296175-320.png?rev=1.1||alt="1623142296175-320.png"]]
66
67 Once you click this button, you will get a confirmation screen, after confirming, your page will be deleted.
68
69 NOTE: Currently the only way to restore a deleted page is via support, so be careful performing this action.
70
71 == Deleting a collab ==
72
73 To delete an entire collab, you need to repeat the steps for deleting a collab page, except this time you need to do it in the main collab page. If I visit "Pauls test" page and click delete, I will be given one more option which is to "Affect children" as well, if I click this, the entire collab will be deleted.
74
75 == Conclusion ==
76
77 At this stage, the user should be able to construct a collab in the way they want, and remove anything from the collab they want to remove. They should also have an understanding of how to add users to their collab.