Introduction
Introduced in Tiki10, the workspace UI provides site administrators with a streamlined way to create simple workspaces, which allow a group of collaborators to work in their own "protected" area.
Using the workspace UI site admins can:
- Define templates for creating workspaces of different types
- Instantiate workspaces using a given template
Note that the Workspace UI does not give you the full flexibility of Tiki workspaces. If your needs are a bit "out of the ordinary", you may need to set up your workspaces using a more manual approach, or playing with the advanced interface and yaml code (see below).
1.2. Tutorial: Creating a workspace
Let's say you are managing a project called OurFabulousProject, and you want to create a Tiki workspace where all the people on that project can share information.
In this tutorial, we will show you how to do this.
1.2.1. Activate the Workspace UI
If the Workspace UI feature is not already activated, you need to do so.
* Admin home
* Check the Advanced and Experimental boxes, then Set as my defaults (Workspace UI involves some advanced and experimental components)
- Admin > Workspaces
* Check the following checkboxes: Workspaces UI, Namespace, Perspectives, Category and Wiki.
- Hit the "Apply" button
1.2.2. Create a template for the workspace
In order to create a workspace template, you need to follow these steps:
- Admin > Workspaces
- Hit the Worspace templates button
- Create Workspace template, a new popup window will appear
- In Name, enter the template's name (let's call it Project)
Now that you have your brand new template, you need to set some permissions to decide what people who belong to the workspace can do there.
- Click on the Permissions button besides the Edit button, on the Project workspace template line.
Check the permissions you want to apply to the workspace. The only permission is to allow to users, from different categories, being able to create workspaces for this given template. In our case, we won't set that. Let's keep the admin being the only one to create workspace for this template.
1.2.3. Create a new workspace using the template
Now that we have a template for creating workspaces for projects, let's use it to create one.
- Admin > Workspaces
- Hit the Worspace templates button
- Hit the Create workspace button
- For Template, pick the Project template we just created.
- For Name, enter the name of the project OurFabulousProject,.
- OK
1.2.4. Go to the workspace's home page
That's it. You now have a workspace called OurFabulousProject. You can go to the workspace's home page: tiki-index.php?page=Project:_:OurFabulousProject. This workspace's home page is empty (no content). As it's a wiki-like page, let's add some description to be more explanatory for the members we will add further in this tutorial.
1.2.5. Assign users to the workspace
The final step is to make sure that members of the project team have access to the workspace.
All you have to do is to assign those users to the group. For example, if you want user kishiko to have access to the workspace, you do:
- Admin > Users
- Hit the Assign user to groups button
- Click the Assign button on the Project:_:OurFabulousProject line. You will be asked to confirm this action.
As a result, kishiko is our first member of the workspace. He is able now to see the worspace's home page in the list of wiki pages.
Do so for all the users you want to make as members.
1.2.6. Final tip
You can, besides setting permissions to a workspace template, setting also permissions to the workspace itself. The process is similar for all the wiki-like pages.
1.3. Internals of a workspace
Basic building blocks
As you may have surmised from the above tutorial, a workspace is made up of a bunch of lower level building blocks which are packaged together to provide a "workspace user experience".
The building blocks are:
- A category in which all content of the workspace will be put
- A group to which all collaborators of the workspace will belong
- A perspective to improve the experience when working inside a workspace
Note that in the above tutorial, we only used a wiki in the workspace. But a workspace template can include a lot more features, such as: blogs or forums. More features are being added in the interface. However, if something not supported is required, an advanced mode is available, but requires writing a Data Channel through the special interface.
Currently supported through the interface:
- Groups: Allows to create additional groups within the workspace, modify the default group and manage the default permissions.
- Allows to specify which groups are automatically joined by the workspace creator
- Allows to specify which group is the managing group. Members of this group can manage the members of the other groups
- Default permissions applied on the category for the groups within the workspace can be selected
- Wiki pages: Allows to define pages created within the workspace and define their initial content.
- Original content can be defined directly from the interface or be taken from an existing page as a template
- All pages are created within the default namespace
Workspace organization
All workspaces are created under the same root category (called Workspaces), which is created the first time a workspace is created. As a next level, the template name is used as a category, and finally the selected workspace name is used. If the workspace name contains namespace separators, a hierarchy of categories will be created.
Assuming the template is called Project, and the selected workspace name is Infrastructure::Improvements 2012, the category tree would be the following:
- Workspaces
- Project
- Infrastructure
- Improvements 2012
- Infrastructure
- Project
1.4. Edit a Workspace Template in advanced mode (yaml)
Once you have created a workspace template, you have the option to edit it through either the simple interface, of the advanced interface. To edit a workspace tempalte in advanced mode (yaml), you need to be on the template page and hitting the Advanced mode text link in the alert info:
While using the simple interface (image above), you have an easy way to add new default groups or wiki pages in the workspace template, so that they are created as objects (groups and pages) when a new workspace of this type is created.
Then you have the workspace template in advanced mode. In which you can edit in yaml code:
When you switch the interface to Advanced mode (image above), you have full control on the contents of the workspace template, and you are eventually able to define new objects (of other types: blogs, file galleries, forums, ... as far as a profile handler is created for them) to be linked with that workspace template.
For more information on this advanced feature, ask in the Developers list
1.5. Other information
Demo profile (work in progress)
http://profiles.tiki.org/Workspace_UI
1.6. Related
Related features:
- Workspaces & Namespaces, which are re-used by the Workspaces UI
- Roles and Templated Groups which are being developed in Tiki 21, and might get merged with the Workspaces UI in the future (but not yet, as of August 2019).
Alias names for this page:
WorkspacesUI | Workspaces UI | WorkspacesGUI | Workspaces GUI Workspaces-UI