Note: You are currently viewing documentation for Moodle 3.8. Up-to-date documentation for the latest stable version of Moodle may be available here: URL resource settings.

URL resource settings: Difference between revisions

From MoodleDocs
m (moved URL module settings to URL resource settings: easier to understand title)
m (see also)
 
(28 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{URL}}
{{URL}}
==Adding a new URL to your course==
==Adding a URL resource to your course==


There are two ways of adding a link to a website of online file to your course page.
# Turn editing on.
#From the the "Add an activity or resource" link (or, if not present, the "Add a resource" drop down menu),choose URL. All settings may expanded by clicking the "Expand all/Collapse all" link top right.


===The quick method===
==General==
*Give your URL a name and type (or copy/paste) the URL into the External URL box. If you need to search for the correct URL, click the Choose a link button. When you find and select your link,it will be automatically pasted into the box.
*Give the URL a description if you wish, and tick the box to display that description on the course page if needed.
[[File:31URL.png|thumb|400px|center|Adding a URL]]


*This requires the administrator to check the box "Drag and drop upload of text/links" in ''Settings>Site administration>Development>Experimental''
==Appearance==
*With the editing turned on, drag a link into a section of your course (''1 below'') You will be prompted to give it a name (''2 below'') Name it and then click "Upload" (''3 below'')
For '''Display''' you have the following options. If you don't see an option, ask the administrator to enable it in ''Site administration >Plugins >Activity modules >URL.'' You can also have 'in frame' or 'New window' but these must be enabled by the administrator.


[[File:dragURL.png]]
* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
* ''Embed'' - Show the Moodle page with heading, blocks and footer. Show the title/description of the item and display the file directly in the page as well
* ''Open'' - No Moodle heading, blocks, footer or description - just show the file in the web browser (e.g. shows image, PDF, flash animation, taking up the whole browser window)
* ''In pop-up'' - Same as 'Open', but opens a new browser window to show this file (without the Moodle heading, blocks, etc) - this browser window also does not have all the menus in it. If you select this one, then you can specify the pop-up width and height.


===The longer method===
==URL variables==


*Choose[[URL]] from the "Add an activity or resource" link (or, if not present, the  "Add a resource" drop down menu) in your course.
This section allows you to pass internal information as part of the URL.
*The "Adding a new URL" screen will ask for a link name and a description (which may be required or optional according to the admin settings)
*In the "Content" box you type or paste a copied external weblink. The "Choose a link" button takes them to the file picker where they can choose URLs from online areas such as youtube, Box.net, Picasa, Merlot etc, depending on what admin has allowed.


[[File:Url.png]]
This is useful if the URL is actually an interactive web page that takes parameters, and you want to pass something like the name of the current user, for example.


==Course administration settings==
Another use is to create stable links that updates in each iteration of the course, for example:
===Display options===
 
* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
* ''Embed'' - Show the Moodle page with heading, blocks and footer. Show the title/description of the item and display the file directly in the page as well
* ''Open'' - No Moodle heading, blocks, footer or description - just show the file in the web browser (e.g. shows image, PDF, flash animation, taking up the whole browser window)
* ''In pop-up'' - Same as 'Open', but opens a new browser window to show this file (without the Moodle heading, blocks, etc) - this browser window also does not have all the menus and address bar in it.


*There are additional options  if you enable them via ''Site administration > Plugins > Activity modules > URL'':
if you want to link to the student's user report, then you add the base URL to the External URL field, and then in the URL variables section, add 'id' to the first field and select 'id' from under the site heading, and then save changes. The result is a URL that always points to the student's user report.


===Advanced Settings===
A further use includes displaying all forums in a site, by using the base URL then adding add 'id' to the first field and selecting 'id' from under the site heading. Another use makes use of mailto:email@address. URL variables could then include the subject parameter followed by the 'Site full name'. E.g. if you wanted to email a teacher who taught multiple courses, if a student clicked the URL then the email would automatically fill the subject field, which would help the teacher to identify which course the student was in.
====Parameters====


The parameters section allows you to pass internal information as part of the URL.
==Common module settings==
See [[Common module settings]]
==Restrict access/Activity completion==
(These settings are collapsed by default)


This is useful if the URL is actually an interactive web page that takes parameters, and you want to pass something like the name of the current user, for example.
These settings are visible if [[Conditional activities]] and [[Activity completion]] have been enabled in the site and the course.


===Other settings===
==Drag and Drop a URL==
Alternatively, if an administrator has enabled the experimental feature drag and drop upload of text/links in ''Settings > Site administration > Development > Experimental > [[Experimental settings]]'', a link can be dragged into a section of the course and given a name, as shown in the images below.


There are the usual [[Common module settings]] and the Restrict access settings [[Conditional activities]]. There is also an option to display the URL description on the course page below the link to the URL.
{|
| [[File:dragURL.png|thumb|Adding a URL using drag and drop]]
|}


==URL module capabilities==
==URL module capabilities==


* [[Capabilities/mod/url:view|View URL]]
* [[Capabilities/mod/url:view|View URL resource]]
* [[Capabilities/mod/url:addinstance|Add a new URL resource]]
* [[Capabilities/mod/url:addinstance|Add a new URL resource]]


==Site administration settings==
==Site administration settings==


The URL module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > URL''.
The URL module has additional settings which may be changed by an administrator in ''Administration > Site administration > Plugins > Activity modules > URL''.


===Frame height===
===Frame height===


Here you can specify the height of the top frame (containing the navigation) if you choose the  "in frame" display option.  Note:If your theme has a large header then the height should be increased to prevent horizontal and vertical scrollbars.
Here you can specify the height of the top frame (containing the navigation) if you choose the  "in frame" display option.  Note:If your theme has a large header then the height should be increased to prevent horizontal and vertical scrollbars.
===Require activity description===
This setting allows you to turn off the requirement for users to type something into the description box.


===Password===
===Password===
Line 65: Line 65:
===Available display options===
===Available display options===


This setting allows you to add different ways the resource may be displayed on the course page. There are a number of defaults but you can add or change them here. Other display options are;
This setting allows you to add different ways the resource may be displayed on the course page. There are a number of defaults but you can add or change them here. Other display options are:
* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizable area below  
* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizeable area below  
* ''New window'' - very much like 'in pop-up', but the new window is a full browser window, with menus and address bar, etc.
* ''New window'' - very much like 'in pop-up', but the new window is a full browser window, with menus and address bar, etc.
[[File:Display.gif]]
[[File:Display.gif]]
Line 72: Line 72:
===Default values for activity settings===
===Default values for activity settings===


Here you can set the defaults for this resource. You can also choose which setting(s) to class as "Advanced". These settings will only then appear if the user clicks "Show advanced" in the settings.
Here you can set the defaults for this resource.  
 
===See also===
Form discussions:
* [https://moodle.org/mod/forum/discuss.php?d=389552#p1570270 URL Resource - adding a URL Variable]
 
 


[[de:Link/URL konfigurieren]]
[[de:Link/URL konfigurieren]]
[[fr:Paramètres de l'URL]]
[[fr:Paramètres de l'URL]]
[[es:Configuraciones del recurso URL]]

Latest revision as of 20:05, 12 August 2019

Adding a URL resource to your course

  1. Turn editing on.
  2. From the the "Add an activity or resource" link (or, if not present, the "Add a resource" drop down menu),choose URL. All settings may expanded by clicking the "Expand all/Collapse all" link top right.

General

  • Give your URL a name and type (or copy/paste) the URL into the External URL box. If you need to search for the correct URL, click the Choose a link button. When you find and select your link,it will be automatically pasted into the box.
  • Give the URL a description if you wish, and tick the box to display that description on the course page if needed.
Adding a URL

Appearance

For Display you have the following options. If you don't see an option, ask the administrator to enable it in Site administration >Plugins >Activity modules >URL. You can also have 'in frame' or 'New window' but these must be enabled by the administrator.

  • Automatic - Make the best guess at what should happen (probably what is wanted 99% of the time).
  • Embed - Show the Moodle page with heading, blocks and footer. Show the title/description of the item and display the file directly in the page as well
  • Open - No Moodle heading, blocks, footer or description - just show the file in the web browser (e.g. shows image, PDF, flash animation, taking up the whole browser window)
  • In pop-up - Same as 'Open', but opens a new browser window to show this file (without the Moodle heading, blocks, etc) - this browser window also does not have all the menus in it. If you select this one, then you can specify the pop-up width and height.

URL variables

This section allows you to pass internal information as part of the URL.

This is useful if the URL is actually an interactive web page that takes parameters, and you want to pass something like the name of the current user, for example.

Another use is to create stable links that updates in each iteration of the course, for example:

if you want to link to the student's user report, then you add the base URL to the External URL field, and then in the URL variables section, add 'id' to the first field and select 'id' from under the site heading, and then save changes. The result is a URL that always points to the student's user report.

A further use includes displaying all forums in a site, by using the base URL then adding add 'id' to the first field and selecting 'id' from under the site heading. Another use makes use of mailto:email@address. URL variables could then include the subject parameter followed by the 'Site full name'. E.g. if you wanted to email a teacher who taught multiple courses, if a student clicked the URL then the email would automatically fill the subject field, which would help the teacher to identify which course the student was in.

Common module settings

See Common module settings

Restrict access/Activity completion

(These settings are collapsed by default)

These settings are visible if Conditional activities and Activity completion have been enabled in the site and the course.

Drag and Drop a URL

Alternatively, if an administrator has enabled the experimental feature drag and drop upload of text/links in Settings > Site administration > Development > Experimental > Experimental settings, a link can be dragged into a section of the course and given a name, as shown in the images below.

Adding a URL using drag and drop

URL module capabilities

Site administration settings

The URL module has additional settings which may be changed by an administrator in Administration > Site administration > Plugins > Activity modules > URL.

Frame height

Here you can specify the height of the top frame (containing the navigation) if you choose the "in frame" display option. Note:If your theme has a large header then the height should be increased to prevent horizontal and vertical scrollbars.

Password

Here you can add a password that will connect your users to a secure site. See this forum post for more details.

Include role names in parameters

Available display options

This setting allows you to add different ways the resource may be displayed on the course page. There are a number of defaults but you can add or change them here. Other display options are:

  • In frame - show the Moodle heading and the file description, with the file displayed in a resizeable area below
  • New window - very much like 'in pop-up', but the new window is a full browser window, with menus and address bar, etc.

Display.gif

Default values for activity settings

Here you can set the defaults for this resource.

See also

Form discussions: