Difference between revisions of "CcTeamspace"

From Creative Commons
Jump to: navigation, search
(Presentation)
(Updated git repository link.)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The internal task and project tracking system used at Creative Commons is powered by [http://semantic-mediawiki.org/ Semantic Media Wiki].
+
{{Infobox|
 +
Teamspace was the internal task and project tracking system used at Creative Commons. It is powered by [http://semantic-mediawiki.org/ Semantic Media Wiki].
 +
 
 +
Teamspace is offered as an experiment in building applications with Semantic MediaWiki; CC no longer uses the software and there is no support and no active development at this time.
 +
}}
  
 
=Presentation=
 
=Presentation=
CcTeamspace can be considered as a web-based collaborative project management software. It is in fact only a wiki data structure to be used on a MediaWiki platform. CcTeamspace is currently used internaly at Creative Commons.
+
CcTeamspace can be considered as a web-based collaborative project management software. It is in fact only a wiki data structure to be used on a MediaWiki platform.
  
 
The main features are :
 
The main features are :
 +
* Project and task management system with calendar and mail notifications.
 +
* Staff, companies and groups management
 
* Traditional wiki features (pages, links, images...)
 
* Traditional wiki features (pages, links, images...)
 
* Semantic web features (words have a meaning for the machine)
 
* Semantic web features (words have a meaning for the machine)
* Project and task management system.
 
 
   
 
   
 
<gallery widths="150px" perrow="3">
 
<gallery widths="150px" perrow="3">
Line 30: Line 35:
 
On this MediaWiki installation, we will add some semantic features. [http://semantic-mediawiki.org/wiki/Help:Download Download] Semantic MediaWiki and follow the [http://semantic-mediawiki.org/wiki/Help:Installation#Installation four installation steps].
 
On this MediaWiki installation, we will add some semantic features. [http://semantic-mediawiki.org/wiki/Help:Download Download] Semantic MediaWiki and follow the [http://semantic-mediawiki.org/wiki/Help:Installation#Installation four installation steps].
  
'''(3) Import the ccTeamspace structure:'''
+
'''(3) Add  Semantic Extensions:'''
* Download the [ccTeamspace structure xml file].
 
* Log in with your [http://meta.wikimedia.org/wiki/Help:Administration#Making_sysops Sysops] account and go to the <nowiki>Special:Import</nowiki> page to import the xml file.
 
 
 
'''(4) Refresh the semantic data with a script:'''
 
Move the php file ''./extensions/SemanticMediaWiki/maintenance/SMW_refreshData.php'' to the ''./maintenance/'' directory of your MediaWiki installation. Then execute the SMW_refreshData.php script to create the semantic data in your database.
 
  php maintenance/SMW_refreshData.php
 
 
 
 
 
'''(5) Add  Semantic Extensions:'''
 
 
All of the following extensions are needed:
 
All of the following extensions are needed:
 
* [http://www.mediawiki.org/wiki/Extension:Semantic_Drilldown Semantic Drilldown]
 
* [http://www.mediawiki.org/wiki/Extension:Semantic_Drilldown Semantic Drilldown]
 
* [http://meta.wikimedia.org/wiki/ParserFunctions ParserFunctions]
 
* [http://meta.wikimedia.org/wiki/ParserFunctions ParserFunctions]
 +
* [http://www.mediawiki.org/wiki/Extension:StringFunctions StringFunctions]
 
* [http://www.mediawiki.org/wiki/Extension:Header_Tabs Header Tabs]
 
* [http://www.mediawiki.org/wiki/Extension:Header_Tabs Header Tabs]
 
* [http://www.mediawiki.org/wiki/Extension:Semantic_Forms Semantic Forms]: edit your pages with forms
 
* [http://www.mediawiki.org/wiki/Extension:Semantic_Forms Semantic Forms]: edit your pages with forms
 
* [http://www.mediawiki.org/wiki/Extension:Semantic_Calendar Semantic Calendar]: use a monthly calendar to display your tasks (Don't forget to consider [http://www.mediawiki.org/wiki/Extension:Semantic_Calendar#The_caching_issue this point] during installation)
 
* [http://www.mediawiki.org/wiki/Extension:Semantic_Calendar Semantic Calendar]: use a monthly calendar to display your tasks (Don't forget to consider [http://www.mediawiki.org/wiki/Extension:Semantic_Calendar#The_caching_issue this point] during installation)
* [http://www.mediawiki.org/wiki/Extension:SemanticTasks Semantic Tasks]: email notifications and reminders.
+
* [http://www.mediawiki.org/wiki/Extension:SemanticTasks SemanticTasks]: email notifications and reminders.
 +
* [http://www.mediawiki.org/wiki/Extension:Semantic_Result_Formats Semantic Result Formats]: more formats like sum needed for expanding options.
 +
 
 +
'''(4) Import the ccTeamspace structure:'''
 +
* Use the [https://github.com/cc-archive/Teamspace CcTeamspace git repository] to download the last Teamspace data structure :
 +
    $git clone https://github.com/cc-archive/Teamspace
 +
* Log in with your [http://meta.wikimedia.org/wiki/Help:Administration#Making_sysops Sysops] account and go to the ''<nowiki>Special:Import</nowiki>'' page to import the Teamspace-data.xml file.
 +
 
 +
'''(5) Refresh the semantic data with a script:'''
 +
Move the php file ''./extensions/SemanticMediaWiki/maintenance/SMW_refreshData.php'' to the ''./maintenance/'' directory of your MediaWiki installation. Then execute the SMW_refreshData.php script to create the semantic data in your database.
 +
  $php maintenance/SMW_refreshData.php
 +
''If this produce an error due to Semantic Calendar, just comment the Semantic Calendar include line in your file LocalSettings.php, restart the script and then uncomment the previous line.''
  
 
=Usage and FAQ=
 
=Usage and FAQ=
'''When a new user is created, add the following code to enable the task calendar template:'''
+
 
 +
Basicaly, a ''task'' can be part of a ''project'' and a ''project'' can be part of a ''project category''.
 +
 
 +
A ''Group'' is an organization or a company you are working with. You can create groups and fill-in many informations.
 +
 
 +
'''When a new user is created, if this user is part of the staff, add the following code to enable the staff and task templates:'''
 
     <nowiki>{{Staff}}</nowiki>
 
     <nowiki>{{Staff}}</nowiki>
 
     <nowiki>{{User Tasks}}</nowiki>
 
     <nowiki>{{User Tasks}}</nowiki>
  
'''How do I add a task?'''
+
==How to==
On an user page, click on ''Add task'' or go to the page <nowiki>Category:Task</nowiki>   
+
 
 +
'''Add a task:'''
 +
On an user page, click on ''Add task'' or go to the page ''<nowiki>Special:AddPage/Task</nowiki>''  
 
      
 
      
'''How to I add a project?''' Go to the page <nowiki>Category:Project</nowiki>
+
'''Add a project:''' Go to the page ''<nowiki>Special:AddPage/Project</nowiki>''
 +
 
 +
'''Add a project category:''' Go to the page ''<nowiki>Special:AddPage/Project_Category</nowiki>''
 +
 
 +
'''Add a group:''' Go to the page ''<nowiki>Special:AddPage/Group</nowiki>''
 +
 
 +
'''Have an overview of the projects:'''
 +
* To have a overview on all projects, go to the page ''<nowiki>Category:Project</nowiki>''
 +
* If you know the ''project category'' they belong to, go directly to the project category page (by tipping its name in the url tab). This page displays a control panel of the current projects.
 +
 
 +
'''Have an overview of the tasks of one project:''' Simply go to the project page (by tipping its name in the url tab). This page displays a control panel of the different tasks.
 +
 
 +
'''Get the list of the groups:''' Go to the page ''<nowiki>Category:Group</nowiki>''.
 +
 
 +
'''Get the list of the staff:''' Go to the page ''<nowiki>Category:Staff</nowiki>''
 +
 
 +
'''Get the list of all the users of CcTeamSpace:''' Go to the page ''<nowiki>Special:Listusers</nowiki>''.
 +
 
 +
=Developers=
 +
If you want to contribute to the ccTeamspace data structure, please [[CcTeamspace developers|read this page]].
  
'''How to I add a project category?''' Go to the page <nowiki>Category:Project_Category</nowiki>
+
=Authors=
 +
* Nathan R. Yergler, CTO (mailto:nathan@creativecommons.org)
 +
* Asheesh Laroia, Software Engineer  (mailto:asheesh@creativecommons.org)
 +
* Steren Giannini, Technology Intern (mailto:steren.giannini@gmail.com)

Latest revision as of 15:53, 16 April 2019

Teamspace was the internal task and project tracking system used at Creative Commons. It is powered by Semantic Media Wiki.

Teamspace is offered as an experiment in building applications with Semantic MediaWiki; CC no longer uses the software and there is no support and no active development at this time.

Presentation

CcTeamspace can be considered as a web-based collaborative project management software. It is in fact only a wiki data structure to be used on a MediaWiki platform.

The main features are :

  • Project and task management system with calendar and mail notifications.
  • Staff, companies and groups management
  • Traditional wiki features (pages, links, images...)
  • Semantic web features (words have a meaning for the machine)

Installation

Requirements:

  • Web Server such as Apache or IIS
  • PHP version 5.0 or later (5.1.x recommended)
  • Database Server MySQL 4.0 or later

Follow these five steps to install ccTeamspace on your server :

(1) MediaWiki : MediaWiki is a free software wiki package used for Wikipedia and many other wikis. It's the basis of the ccTeamspace software. Follow the MediaWiki installation guide to complete the installation of your wiki.

(2)Semantic MediaWiki: On this MediaWiki installation, we will add some semantic features. Download Semantic MediaWiki and follow the four installation steps.

(3) Add Semantic Extensions: All of the following extensions are needed:

(4) Import the ccTeamspace structure:

   $git clone https://github.com/cc-archive/Teamspace
  • Log in with your Sysops account and go to the Special:Import page to import the Teamspace-data.xml file.

(5) Refresh the semantic data with a script: Move the php file ./extensions/SemanticMediaWiki/maintenance/SMW_refreshData.php to the ./maintenance/ directory of your MediaWiki installation. Then execute the SMW_refreshData.php script to create the semantic data in your database.

  $php maintenance/SMW_refreshData.php

If this produce an error due to Semantic Calendar, just comment the Semantic Calendar include line in your file LocalSettings.php, restart the script and then uncomment the previous line.

Usage and FAQ

Basicaly, a task can be part of a project and a project can be part of a project category.

A Group is an organization or a company you are working with. You can create groups and fill-in many informations.

When a new user is created, if this user is part of the staff, add the following code to enable the staff and task templates:

   {{Staff}}
   {{User Tasks}}

How to

Add a task: On an user page, click on Add task or go to the page Special:AddPage/Task

Add a project: Go to the page Special:AddPage/Project

Add a project category: Go to the page Special:AddPage/Project_Category

Add a group: Go to the page Special:AddPage/Group

Have an overview of the projects:

  • To have a overview on all projects, go to the page Category:Project
  • If you know the project category they belong to, go directly to the project category page (by tipping its name in the url tab). This page displays a control panel of the current projects.

Have an overview of the tasks of one project: Simply go to the project page (by tipping its name in the url tab). This page displays a control panel of the different tasks.

Get the list of the groups: Go to the page Category:Group.

Get the list of the staff: Go to the page Category:Staff

Get the list of all the users of CcTeamSpace: Go to the page Special:Listusers.

Developers

If you want to contribute to the ccTeamspace data structure, please read this page.

Authors