History: Workspace UI
Source of version: 28
Copy to clipboard
!!# 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 {BOX(title="You can still create workspaces manually")} 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 ((Workspaces|more manual approach)), or playing with the [#yaml|advanced interface and yaml code] (see [#yaml|below]). {BOX} !!# 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. !!!# 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__ {img src="display1609" link="display1609" width="full" rel="box[g]" imalign="center" desc="Activating WorkspaceUI feature | Click to expand" align="center" styleimage="border"} * Check the following checkboxes: __Workspaces UI__, __Namespace__, __Perspectives__, __Category__ and __Wiki__. * __Hit the "Apply" button__ !!!# Create a template for the workspace Let's assume that you don't already have a workspace template for projects. So your next step is to create one. * __Admin > Workspaces and Areas__ * __Create a workspace template__ * In __Name__, enter the template's name (let's call it __Project__) {img fileId="901"} Now that you have a template, you need to set some permissions to decide what people who belong to the workspace can do there. * Click on the wrench icon besides the __Project__ template, then click on __Select permissions__. {img fileId="903"} * Check the permissions you want to apply to the workspace. In our case, we will go do the __wiki__ section and enable __tiki_p_view__ and __tiki_p_edit__, so that members of the workspace can view and edit wiki pages. !!!# 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 and Areas__ * __Create a workspace__ * For __Template__, pick the __Project__ template we just created. * For __Name__, enter the name of the project __OurFabulousProject__,. * __OK__ {img fileId="904"} !!!# 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. !!!# 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 __JoeBloe__ to have access to the workspace, you do * __Admin > Users__ * Click the _+ sign__ beside the group __ Project:_:OurFabulousProject __. {img fileId="905"} !!# 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 {ANAME()}yaml{ANAME}{ANAME()}YAML{ANAME} !!# Edit a Workspace Template in advanced mode (yaml) Once you have created a workspace template, you have the option to edit it thorugh either the __simple interface__, of the __advanced interface__: {img src="display1233" link="display1233" width="400" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"} Once the workspace template is open for edition, you will see the link to open it in the advanced mode: {img src="display1234" link="display1234" width="400" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"} 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. When you switch the interface to Advanced mode, 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 [http://profiles.tiki.org/Handlers|profile handler] is created for them) to be linked with that workspace template: {img src="display1235" link="display1235" width="400" rel="box[g]" imalign="center" desc="Click to expand" align="center" styleimage="border"} For more information on this advanced feature, ask in the [https://tiki.org/Mailing+Lists|Developers list] !!# Other information Demo profile (work in progress) http://profiles.tiki.org/Workspace_UI Alias names for this page: (alias(WorkspacesUI)) | (alias(Workspaces UI)) | (alias(WorkspacesGUI)) | (alias(Workspaces GUI)) (alias(Workspaces-UI))