-

Note: You are currently viewing documentation for Moodle 3.10. 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
(added info)
(→‎URL variables: Revised definition of "base URL")
 
(43 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{URL}}
{{URL}}
==Adding a new URL to your course==
This page explores in more detail the settings for the URL resource once you have added it to your course and also covers the Site administration settings.


*You can add link to a website or online file  by choosing [[URL]] from the "Add a resource" drop down menu in your course.
==General==
*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)
Give the URL a name and a description if required, checking the box if you want the description to display on the course page.
*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]]
In External tool, type the full web address of your URL or click the Choose a link button for more options.
 
==Course administration settings==
===Display options===


==Appearance==
;Display
* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
* ''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
* ''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)
* ''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.
* ''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.
 
You can also have 'in frame' or 'New window' but these must be enabled by the administrator. If you don't see an option, ask the administrator to enable it in ''Site administration >Plugins >Activity modules >URL.''
==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.
 
The "base URL" is the fixed part of the URL that the variables will be appended to. For example https://moodle.example.com/report/outline/user.php or https://moodle.example.com/report/outline/user.php?mode=complete could both have a user ID and course ID appended (for example course=4&id=36).


*There are additional options  if you enable them via ''Site administration > Plugins > Activity modules > URL'':
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.


===Advanced Settings===
==Other settings==
====Parameters====
Depending on what is enabled for your site and course, you may also need to explore [[Common module settings]], [[Restrict access| Restrict access]],  [[Activity completion]], [[Tags]] and [[Competencies]]
(to be continued)
===Other settings===
There are the usual [[Common module settings]] and the Restrict access settings [[Conditional activities]].


{{Moodle 2.2}}In Moodle 2.2 onwards, there is an option to display the URL description on the course page below the link to the URL. See the screencast [http://www.screencast.com/t/ieLFs7To0e Moodle 2.2 - Show descriptions] for a demonstration by developer Sam Marshall.
==Drag and Drop a URL==
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.


Moodle 2.2
{|
| [[File:dragURL.png|thumb|Adding a URL using drag and drop]]
|}


In Moodle 2.2 onwards, there is an option to display the file description on the course page below the link to the file. See the screencast Moodle 2.2 - Show descriptions for a demonstration by developer Sam Marshall.
==URL module capabilities==
 
* [[Capabilities/mod/url:view|View 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 resource 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 ''resource_framesize'' variable 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===
===Password===
 
This setting allows you to turn off the requirement for users to type something into the description box.


===Password===
Here you can add a password that will connect your users to a secure site. [http://moodle.org/mod/forum/discuss.php?d=189842#p826416 See this forum post] for more details.


===Include role names in parameters===
===Include role names in parameters===
Line 48: Line 60:
===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 55: Line 67:
===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]]
[[fr:Paramètres de l'URL]]
[[es:Configuraciones del recurso URL]]

Latest revision as of 10:08, 21 April 2021

This page explores in more detail the settings for the URL resource once you have added it to your course and also covers the Site administration settings.

General

Give the URL a name and a description if required, checking the box if you want the description to display on the course page.

In External tool, type the full web address of your URL or click the Choose a link button for more options.

Appearance

Display
  • 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.

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

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.

The "base URL" is the fixed part of the URL that the variables will be appended to. For example https://moodle.example.com/report/outline/user.php or https://moodle.example.com/report/outline/user.php?mode=complete could both have a user ID and course ID appended (for example course=4&id=36).

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.

Other settings

Depending on what is enabled for your site and course, you may also need to explore Common module settings, Restrict access, Activity completion, Tags and Competencies

Drag and Drop a URL

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 resource 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: