Skip to Content

Wiki source code of 4 - Project Subwiki Setup

Last modified by publicadmin on 2025/12/16 13:04
Show last authors
1 = About Project Wiki Setup =
2
3 This Guide for Project Wiki Setup is intended to be used by [[Platform Administrators>>doc:Main.user_guide.Managing User Accounts.User Roles.WebHome]] of the Virtual Research Environment (VRE) to perform the initial setup steps required to allow Project Members to use the Wiki for their Project.
4
5 == Resources: ==
6
7 **XWiki User Guide:** [[https:~~/~~/www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/]]
8
9 **XWiki Users and Group Management: **[[https:~~/~~/www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/UsersAndGroupsManagement>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/Features/UsersAndGroupsManagement]]
10
11 **Permission Types: **[[https:~~/~~/www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Access%20Rights/Permission%20types/>>https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Access%20Rights/Permission%20types/]]
12
13
14 == Things to Know ==
15
16 1. The VRE XWiki is connected to the VRE through a Single Sign-On integration, User Profiles and Project Groups are created automatically in XWiki and cannot be created manually: 
17 11. A **User's Profile** is created automatically in XWiki the first time they click on the XWiki icon in one of their VRE Projects
18 11. A **Project Group** is created on XWiki the first time a Platform Administrator or any of the Project Members clicks on the XWiki icon from the Project's page in the VRE
19 11. A **Project Subwiki **is created manually by a Platform Administrator when a new Project is onboarded to the VRE
20 1. The VRE Wiki is set up as a multi-tenancy Wiki, so multiple unique subwikis exist within the Main Wiki and have their own unique pages and access rights
21 11. __Main Wiki__
22 11*. only accessible to Platform Administrators
23 11*. view access blocked to regular VRE users and Unregistered Users
24 11*. contains User Profiles, Global User Rights, and all subwikis
25 11*. access maintained by VRE Support Team
26 11. __Project-base Subwikis__
27 11*. edit access granted to all Project members
28 11*. view access blocked for other VRE users and unregistered users
29 11*. contains Project-specific pages and information
30 11*. created and administered by Platform Administrators
31 11. __Public Subwiki__
32 11*. publically available to all VRE users AND unregistered users
33 11*. contains user support materials
34 11*. created and maintained by Indoc Team
35 1. Access Rights can be granted to **Users **or **Groups**
36 1. A user or group can be granted Access Rights at **different levels**:
37 11. **Globally **to the XWiki and all of its subwikis
38 11. **Locally** to a subwiki and all of its pages
39 11. To a **Page and all of its Children**
40 11. To a **Single Page **within a subwiki
41 1. XWiki operates on an __'implicit denial'__ system - if a user or group is granted a specific type of access to a specific page, all other users or groups will be denied access by default, for example: 
42 1*. Turning on **View **rights for a //Project Group// to their //Project Subwiki// will automatically deny access to that subwiki for all other users
43 1*. Turning** View **rights on for a particular user in the //Main Wiki: Global Rights// page will deny view access to the Main Wiki for all other users by default
44 1**. Users that are not Platform Administrators are denied access to the //Main Wiki// to to keep the User Profiles of other VRE users private and to hide the list of subwikis
45 1. Turning on high-level Access Rights will grant other access rights by default
46 1*. Granting **Admin**// //access to a user or group for a specific page will by default provide the user or group with// View, Like, Comment, //and //Edit //access
47 1*. Granting **Admin **or **Program** access in the Global Administration to a user or group will grant those users //View, Like, Comment, Edit, Delete, Register, //and //Script access //by default
48 1. Unregistered users are able to access the VRE Public subwiki and view all of its contents, including: 
49 1*. VRE User Guide
50 1*. Platform Administrators Guide
51 1*. Developers Guide
52
53 (((
54 = 1 Initializing a Project Wiki =
55 )))
56
57 === 1.1: Log into the Virtual Research Environment ===
58
59 * Open a browser connected to the internet and navigate to the VRE portal: [[https:~~/~~/vre.charite.de/vre>>url:https://vre.charite.de/vre]]
60
61 [[image:VRE Guide for Project XWiki Setup Release 1.0.0 2021-01-22_html_a73a90d37f81a4e6.png||height="362" width="438"]]
62
63
64 (% class="box infomessage" %)
65 (((
66 **Note: **If you forgot your login credentials, click //Forgot password?// to receive a reset email.
67 )))
68
69 == 1.2: Access the Wiki from the Project Canvas ==
70
71 * Navigate to the Project for which you would like to setup the Wiki page and click the Wiki icon in the Left Sidebar.
72
73 (((
74 [[image:XWiki Project Setup Guide - XWiki Sidebar.png||class="img-thumbnail" height="442" width="346"]]
75 )))
76
77 * Click on the action menu in the right-hand corner and click **Log-in**
78
79 [[image:XWiki Project Setup Guide - XWiki Login.png||class="img-thumbnail" height="379" width="775"]]
80
81 * You will be automatically logged into XWiki with your VRE account through the Single Sign-On integration.
82
83 == 1.3: Create Project Subwiki ==
84
85 * Click the action menu in the right-hand corner and click **Wiki Index**
86 * Click **Create Wiki**
87 * Under //Pretty Name// enter the Project Code
88 * The Wiki Identifier should match the Project Code
89
90 {{warning}}
91 **Warning: **The Wiki Identifier must match the Project Code for Project members to be able to access their Project Subwiki from the VRE.   
92 {{/warning}}
93
94 * Under Flavor/Template switch to the **Template **tab
95 * Select the **Private Project Subwiki **template from the dropdown
96 * Click **Next Step**
97 * Select //Only global users are available in the wiki //and //Only an admin can send invitations to join this wiki//
98 * Click **Create**
99 * The subwiki will be setup automatically, this process can take several minutes
100 * Once completed click on Go To Subwiki to configure the subwiki Access Rights
101
102 = 2. Administering Project Subwiki User Rights =
103
104 (((
105 == 2.1 Initialize Project Wiki User Group ==
106 )))
107
108 * A new Project Group (named to match the //Project Code//) will be automatically created in XWiki when a Platform Administrator or Project Members clicks on the XWiki icon in the left sidebar of the Project's landing page.
109 * Project Groups on XWiki contains all Project Members from the VRE that have previously accessed XWiki
110
111 {{info}}
112 **Note: **For a user to appear in the User List they must first access XWiki from the VRE and log in via Single Sign-On, if you do not see a user in the User List, reach out to them directly to have them access XWiki for the first time. 
113 {{/info}}
114
115 == 2.2 Administer Project Subwiki for Project User Group ==
116
117 * Navigate to the Project subwiki main page
118 * Open the action menu in the top right-hand corner and click **Administer Wiki**
119 * Select **Users and Rights > Rights**
120 * Select the **Global** list from the Groups dropdown
121 * Turn on //View, Like, Comment, //and// Edit// access for the Project Group with the corresponding Project Code
122 ** Project members will now be able to access and update the content on their Project subwiki
123 ** VRE users and unregistered users who are not a member of the project will be denied access to the Project Subwiki
124
125 (((
126 {{warning}}
127 **Warning:** Turning on access to a page for a user or group results in //implicit denial// of this right to all other non-admin users. 
128 {{/warning}}
129 )))
130
131 [[image:VRE Guide for Project XWiki Setup Release 1.0.0 2021-01-22_html_7bd91c331ead9791.png||height="24" width="24"]] **Enable** permissions by checking off the checkbox.
132
133 [[image:VRE Guide for Project XWiki Setup Release 1.0.0 2021-01-22_html_1e4232142d5070a7.png||height="19" width="19"]] **Deny **permission by checking the checkbox a second time to show the Deny icon.
134
135 __Boxes left blank will follow the default settings for your Project’s XWiki Page__.
136
137 (% class="box infomessage" %)
138 (((
139 **Note: **Any additional Members added to a Project in the VRE will also be added to that Project’s Wiki User Group the next time they access XWiki from the VRE.
140 )))
141
142 (((
143 == 2.4 Grant access to VRE User Guide ==
144
145 When a new Project is created the corresponding Group on XWiki must also be granted access to the VRE User Guide
146
147 * Navigate to the VRE Public Subwiki in the navigation bar at the top of the Main Wiki
148 * Open the action menu in the top right-hand corner and click **Administer Wiki**
149 * Select **Users and Rights > Rights**
150 * Select the Global list from the Groups dropdown
151 * Turn on //View //access for the new Project Group 
152
153 = 3 Grant Platform Administrator Access =
154
155 Platform Administrators can be granted administrative access to the VRE Wiki. 
156
157 * Click on the action menu in the top right-hand corner and click **Administer Wiki**
158 * Click **Users & Rights**
159 * Click **Rights**
160 * Switch to the //Users// tab and search for the user that you would like to grant global administrative access to.
161 * Turn on **Admin** or **Program** depending on the level of access you would like the user to have.
162 )))
163
164 ----
165
166 {{box}}
167 (% style="text-align:center" %)
168 image:https://i.creativecommons.org/l/by-sa/4.0/88x31.png
169
170 (% style="text-align: center;" %)
171 Copyright © 2022, Indoc Research. This work is licensed under a [[Creative Commons Attribution-ShareAlike 4.0>>http://creativecommons.org/licenses/by-sa/4.0/ ||rel="noopener noreferrer" target="blank"]] International License.
172 {{/box}}