CollaboraActivityModule - Revision history

Jan.dagefoerde: I overestimated mediawiki, it seems :) see the new page!

2019-12-02T15:13:30Z

I overestimated mediawiki, it seems :) see the new page!

← Older revision		Revision as of 15:13, 2 December 2019
Line 1:		Line 1:
	~~{{DISPLAYTITLE:Collabora Activity Module}}~~		#REDIRECT [[Collabora Activity Module]]
	~~{{Infobox plugin~~
	~~\|type = Activity~~
	~~\|entry = https://moodle.org/plugins/view/mod_collabora~~
	~~\|tracker = https://github.com/learnweb/moodle-mod_collabora~~
	~~\|maintainer =~~ [[~~User:University of Münster\|University of Münster]]~~
	~~\|discussion = N/A~~
	~~\|float = right~~
	}}

	~~A teacher can add a~~ Collabora ~~activity in a course when editing is turned on by clicking an 'Add an activity or resource' link (or, if not present, the "Add an activity" drop down menu) and selecting Collabora.~~

	This activity creates an office document (text, spreadsheet or presentation) that can be edited by more then one student simultaneously. Your system administrator should have hooked up a Collabora server to your Moodle installation for this to work (see section [[#Server_setup\|Server setup]]). A collabora server is a server that generates the possibility to cooperate on office documents using a web based version of LibreOffice.

	==Activity ~~settings==~~
	~~To see all the settings expanded, click the link "Expand all" top right.~~

	Give your Collabora name (which students see on the course page) and a description. The name will end up the name of the document that will be created with this activity. You can set a tick box to show the description of the course page.

	~~===Format===~~
	~~This setting determines which kind of document will be created by the Collabora activity. This option can't be changed anymore after saving the activity.~~
	~~Options are:~~
	* File upload: upload a document as a start for your students to collaborate on. When this option chosen, an extra line will appear, showing the name and a download link to the original document.
	* Specified text:
	* Spreadsheet: create an empty spreadsheet
	* Word Processor document: create an empty text document
	* Presentation: create an empty presentation

	~~===Display===~~
	* Current tab: when a student enters the activity, the editor with the document are shown in the current browser tab.
	* New tab: when a student enters the activity, the editor will open in a new tab. The current tab keeps showing the course page.

	~~===Width===~~
	~~Alters the width of the editor. 0 for automatic width.~~

	~~===Height===~~
	~~Alters the height of the editor. 0 for automatic.~~

	~~By experience: 1200 gives a full A4 page editor on zoom level 100%~~

	~~===Display name===~~
	~~Set to yes displays the name of the Collabora activity above the editor when students access the activity.~~

	~~===Display description===~~
	~~Set to yes displays the description of the Collabora activity above the editor when students access the activity.~~

	~~==Server setup==~~

	~~For an initial local demo, follow the suggestions in https://github.com/learnweb/moodle-mod_collabora/blob/master/Collabora-Config.md.~~

	Afterwards, you will want to use the Collabora-Moodle integration in production. If you are connecting Moodle to an existing Collabora server (e.g., from a Collabora-Nextcloud installation), you will need to modify the Collabora configuration to allow requests from Moodle AND Nextcloud. Here's an example configuration of the relevant section:

	~~<code xml>~~
	~~<wopi allow="true" desc="Allow/deny wopi storage. Mutually exclusive with webdav.">~~
	~~<host allow="true" desc="Regex pattern of hostname to allow or deny.">127.0.0.1</host>~~
	~~<host allow="true" desc="Regex pattern of hostname to allow or deny.">localhost</host>~~
	~~<host allow="true" desc="Regex pattern of hostname to allow or deny.">nextcloud.example.be</host>~~
	~~<host allow="true" desc="Regex pattern of hostname to allow or deny.">moodle.example.be</host>~~
	~~<host allow="false" desc="Regex pattern of hostname to allow or deny.">10\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9~~]~~{1,3}</host>~~
	~~<host allow="false" desc="Regex pattern of hostname to allow or deny.">172\.1[6789]\.[0-9]{1,3}\.[0-9]{1,3}</host>~~
	~~<host allow="false" desc="Regex pattern of hostname to allow or deny.">172\.2[0-9]\.[0-9]{1,3}\.[0-9]{1,3}</host>~~
	~~<host allow="false" desc="Regex pattern of hostname to allow or deny.">172\.3[01]\.[0-9]{1,3}\.[0-9]{1,3}</host>~~
	~~<host allow="false" desc="Regex pattern of hostname to allow or deny.">192\.168\.[0-9]{1,3}\.[0-9~~]~~{1,3}</host>~~
	~~<host allow="false" desc="Regex pattern of hostname to allow or deny.">192\.168\.1\.1</host>~~
	~~<max_file_size desc="Maximum document size in bytes to load. 0 for unlimited." type="uint">0</max_file_size>~~
	~~</wopi>~~
	~~</code>~~

	~~You will notice that, in the example configuration, there are hostnames for both, Nextcloud AND Moodle. Adapt it to your hostnames and IP addresses as needed.~~

Jan.dagefoerde at 15:10, 2 December 2019

2019-12-02T15:10:39Z

← Older revision		Revision as of 15:10, 2 December 2019
Line 1:		Line 1:
			{{DISPLAYTITLE:Collabora Activity Module}}
	{{Infobox plugin		{{Infobox plugin
	\|type = Activity		\|type = Activity

Jan.dagefoerde: add infobox

2019-12-02T15:05:52Z

add infobox

← Older revision		Revision as of 15:05, 2 December 2019
Line 1:		Line 1:
			{{Infobox plugin
			\|type = Activity
			\|entry = https://moodle.org/plugins/view/mod_collabora
			\|tracker = https://github.com/learnweb/moodle-mod_collabora
			\|maintainer = [[User:University of Münster\|University of Münster]]
			\|discussion = N/A
			\|float = right
			}}

	A teacher can add a Collabora activity in a course when editing is turned on by clicking an 'Add an activity or resource' link (or, if not present, the "Add an activity" drop down menu) and selecting Collabora.		A teacher can add a Collabora activity in a course when editing is turned on by clicking an 'Add an activity or resource' link (or, if not present, the "Add an activity" drop down menu) and selecting Collabora.

Jan.dagefoerde: Migrate from https://docs.moodle.org/37/en/index.php?title=mod/collabora/mod -- thanks to User:koen roggemans for all the documentation!

2019-12-02T15:04:42Z

Migrate from https://docs.moodle.org/37/en/index.php?title=mod/collabora/mod -- thanks to Koen roggemans for all the documentation!

New page

A teacher can add a Collabora activity in a course when editing is turned on by clicking an 'Add an activity or resource' link (or, if not present, the "Add an activity" drop down menu) and selecting Collabora.

This activity creates an office document (text, spreadsheet or presentation) that can be edited by more then one student simultaneously. Your system administrator should have hooked up a Collabora server to your Moodle installation for this to work (see section [[#Server_setup|Server setup]]). A collabora server is a server that generates the possibility to cooperate on office documents using a web based version of LibreOffice.

==Activity settings==
To see all the settings expanded, click the link "Expand all" top right.

Give your Collabora name (which students see on the course page) and a description. The name will end up the name of the document that will be created with this activity. You can set a tick box to show the description of the course page.

===Format===
This setting determines which kind of document will be created by the Collabora activity. This option can't be changed anymore after saving the activity.
Options are:
* File upload: upload a document as a start for your students to collaborate on. When this option chosen, an extra line will appear, showing the name and a download link to the original document.
* Specified text:
* Spreadsheet: create an empty spreadsheet
* Word Processor document: create an empty text document
* Presentation: create an empty presentation

===Display===
* Current tab: when a student enters the activity, the editor with the document are shown in the current browser tab.
* New tab: when a student enters the activity, the editor will open in a new tab. The current tab keeps showing the course page.

===Width===
Alters the width of the editor. 0 for automatic width.

===Height===
Alters the height of the editor. 0 for automatic.

By experience: 1200 gives a full A4 page editor on zoom level 100%

===Display name===
Set to yes displays the name of the Collabora activity above the editor when students access the activity.

===Display description===
Set to yes displays the description of the Collabora activity above the editor when students access the activity.

==Server setup==

For an initial local demo, follow the suggestions in https://github.com/learnweb/moodle-mod_collabora/blob/master/Collabora-Config.md.

Afterwards, you will want to use the Collabora-Moodle integration in production. If you are connecting Moodle to an existing Collabora server (e.g., from a Collabora-Nextcloud installation), you will need to modify the Collabora configuration to allow requests from Moodle AND Nextcloud. Here's an example configuration of the relevant section:

<code xml>
<wopi allow="true" desc="Allow/deny wopi storage. Mutually exclusive with webdav.">
<host allow="true" desc="Regex pattern of hostname to allow or deny.">127.0.0.1</host>
<host allow="true" desc="Regex pattern of hostname to allow or deny.">localhost</host>
<host allow="true" desc="Regex pattern of hostname to allow or deny.">nextcloud.example.be</host>
<host allow="true" desc="Regex pattern of hostname to allow or deny.">moodle.example.be</host>
<host allow="false" desc="Regex pattern of hostname to allow or deny.">10\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}</host>
<host allow="false" desc="Regex pattern of hostname to allow or deny.">172\.1[6789]\.[0-9]{1,3}\.[0-9]{1,3}</host>
<host allow="false" desc="Regex pattern of hostname to allow or deny.">172\.2[0-9]\.[0-9]{1,3}\.[0-9]{1,3}</host>
<host allow="false" desc="Regex pattern of hostname to allow or deny.">172\.3[01]\.[0-9]{1,3}\.[0-9]{1,3}</host>
<host allow="false" desc="Regex pattern of hostname to allow or deny.">192\.168\.[0-9]{1,3}\.[0-9]{1,3}</host>
<host allow="false" desc="Regex pattern of hostname to allow or deny.">192\.168\.1\.1</host>
<max_file_size desc="Maximum document size in bytes to load. 0 for unlimited." type="uint">0</max_file_size>
</wopi>
</code>

You will notice that, in the example configuration, there are hostnames for both, Nextcloud AND Moodle. Adapt it to your hostnames and IP addresses as needed.