File resource settings: Difference between revisions

Latest revision as of 12:26, 12 January 2024

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

Adding files to your course

There are two ways to add files to your course:

Dragging and dropping. You will know if drag and drop is available to you because you will (briefly) see a message at the top of your screen when the editing is turned on.

To drag and drop a folder, you must first compress/zip it using whichever program your computer has. See the documentation Folder for more information.

From the Activity chooser > File. (See File resource.

General

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

Upload your file by clicking the 'Add' button in the Select files box. Clicking on this button takes you to the File picker which is the name given to the file storage and access area within Moodle.
If you see a box with an arrow, you can drag and drop a file straight from your desktop into Moodle.

Settings for uploading a file

Appearance

Display

Automatic - let Moodle decide the best option for you.
Embed - show the file as part of the Moodle page (images, PDFs, videos)
Force download - force the user to save the file or open it in a program on their computer.
Open - show the file in the browser, but without the Moodle page decorations (images, PDFs, videos)
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.

Other options are visible if the admin has enabled them in the site settings:

In frame - show the Moodle heading and the file description, with the file displayed in a resizable 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.

Show size or type: This might be useful for learners with poor bandwidth who need to download your content.
Show upload/modified date: This might be useful if you are regularly updating content.; Display resource description; If enabled, this setting will display any content from the description box above the file.
Use filters on file content: If you wish included media such as images and mp3 to appear embedded in the files then select "all files" or "HTML files only", according to your file types.

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

Viewing and editing uploaded files

Once uploaded, files appear as thumbnails in the file manager for easy recognition.
Files view can be easily toggled between icons view or a table view with sizes and dates, or a hierarchical list view. See the documentation on the File picker for more information.
Clicking on the name of an uploaded file opens up a pop up dialogue box which allows file details quickly to be altered.

File info popup dialogue

Creating an alias/shortcut

When an uploaded file - or a file from the Private files, Dropbox, File system or EQUELLA repositories - is re-used elsewhere on Moodle, the teacher has the option to make a copy (a new, unconnected version) or to create a shortcut or alias.
If an alias is created, then when the original file is updated, it will change in all instances of the alias. So a teacher might add course notes to their private files for example, and then add them into a number of courses. When the teacher makes an alteration in the file in their private files, this alteration will be reflected in all instances of the course notes.
An alias can be recognised by its thumbnail. See the difference in the screenshot below between the original file (left) and the alias (right):
To update a file, go to its original location (for example Private files) and upload your new version with the same name . You will be prompted to override or rename the file. Choose "override" and this file will replace your original file and the alisas/shortcuts will remain and all be updated to your latest version.

Creating an alias

Note: Aliases cannot be made in the following areas:

an assignment submission
a forum post attachment
a workshop submission
a quiz essay
a database activity file field

This is to prevent cases such as a student uploading an item for assessment and then subsequently changing the original in their private files. When a student uses a file from their private files in one of these instances, they do not see the options to "copy" or "create an alias".

Extracting or unzipping a zipped archive file

If you uploaded a zip file into a File or Folder Resource, you can uncompress and expand it into its various files. To do this, go into Edit settings for the resource, right click on the file icon in the Select files area, and then click on the Unzip file button.

Displaying a website index page

The file module may be used if you have a folder with linked files such as a website with an index.html file or a flash activity with xml/swf and index file.

Setting the main file

Website index page set as main file

Click the 'Turn editing on' button at the top right of the course page
Drag and drop the zipped folder onto the course section where you'd like it to appear, answer 'Create file resource' to the popup dialogue, then click the upload button
Clicking the editing icon (hand with a pen) then click on the zip file and unzip it
Click on the index.html file or the file you want to start displaying your linked files from then in the popup dialogue click the button 'Set main file'. This ensures this file is the one that appears on the course page for students to click on. The main file is then indicated with a title in bold.
Click the button 'Save and display' at the bottom of the page

Site settings

The File resource has additional settings which may be changed by an administrator in Site administration > Plugins > Activity modules > File.

Frame height allows you to 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.
Available display options: By default Moodle doesn't enable "New window" or "In frame", so you need to set them available here if required, and you can also disable other options if not applicable.

The following capabilities relate to the file resource:

@@ Line 1: / Line 1: @@
 {{File}}
-==Adding a file==
+This page explores in more detail the settings for the File resource once you have added it to your course and also covers the Site administration settings.
+==Adding files to your course==
-To add a file to your course
+There are two ways to add files to your course:
-[[File:dragandrop.png|thumb|Quick method of adding a file]]
+* Dragging and dropping. You will know if drag and drop is available to you because you will (briefly) see a message at the top of your screen when the editing is turned on.
-{{New features}}Quick method:
-# Click the 'Turn editing on' button at the top right of the course page
-# Drag and drop the file onto the course section where you'd like it to appear
-# If necessary, edit the title of the file by clicking the pencil icon, or edit other options (see below) by clicking the editing icon
-Longer method:
+[[File:dragdropmessage.png]]
-# Click the 'Turn editing on' button at the top right of the course page
-# Click 'Add an activity or resource' link, then in the activity chooser, select file then click the Add button (or select file from the "Add a resource" dropdown menu)
-# Enter a link name and a description (which may be required or optional according to the admin settings)
-# Either drag and drop a file into the box with an arrow or click the Add button to open the [[File picker]] menu in order to choose a file from your computer or a repository
-# Select display and other options as required (see below)
-# Click the button 'Save and display' at the bottom of the page
-==Course administration settings==
+To drag and drop a folder, you must first compress/zip it using whichever program your computer has. See the documentation [[Folder]] for more information.
-===Display options===
+* From the Activity chooser > File. (See [[File resource]].
-* ''Automatic'' - Make the best guess at what should happen (probably what is wanted 99% of the time).
+==General==
-* ''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 (good for images, flash animations, videos?, PDFs).
+Give the file a name and a description if required, checking the box if you want the description to display on the course page.
-* ''Force download'' - user clicks on the file, then the web browser pops up with the 'where do you want to save this file' box.
+*Upload your file by clicking the 'Add' button in the Select files box. Clicking on this button takes you to the [[File picker]] which is the name given to the file storage and access area within Moodle.
-* ''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)
+*If you see a box with  an arrow, you can drag and drop a file straight from your desktop into Moodle.
+[[File:31File.png|thumb|center|400px|Settings for uploading a file]]
+==Appearance==
+;Display:
+* ''Automatic'' - let Moodle decide the best option for you.
+* ''Embed'' - show the file as part of the Moodle page (images, PDFs, videos)
+* ''Force download''  - force the user to save the file or open it in a program on their computer.
+* ''Open'' - show the file in the browser, but without the Moodle page decorations (images, PDFs, videos)
 * ''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.
-*The following additional options are only there if you enable them via ''Site administration > Plugins > Activity modules > File'':
+Other options are visible if the admin has enabled them in the site settings:
-* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizable area below (images, PDF, flash, etc. supported).
+* ''In frame'' - show the Moodle heading and the file description, with the file displayed in a resizable 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.
+;Show size or type
+:This might be useful for learners with poor bandwidth who need to download your content.
+;Show upload/modified date
+:This might be useful if you are regularly updating content.
+:Display resource description
+:If enabled, this setting will display any content from the description box above the file.
+;Use filters on file content
+:If you wish  included media such as images and mp3 to appear embedded in the files then select "all files" or "HTML files only", according to your file types.
-All of the above is true of items that can be displayed inside the browser directly (e.g. images, text files, PDFs (with plugin)). If the file cannot be displayed within the browser (e.g. word documents, without a suitable plugin, or other files that need to be loaded by an external program), then the pop-ups or frames, etc. will be created, but then the browser will take over and ask if you want to save the file.
+==Other settings==
+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 summarise:
+==Viewing and editing uploaded files==
-* Do you want Moodle to sort it all out for you? - Automatic
+* Once uploaded, files appear as thumbnails in the file manager for easy recognition.
-* Do you want to force the user to save the file (or open it in a program on their desktop)? - Force download
+* Files view can be easily toggled between icons view or a table view with sizes and dates, or a hierarchical list view. See the documentation on the [[File picker]] for more information.
-* Do you want to show the file as part of the Moodle page (images, PDFs, videos)? - Embed
+*Clicking on the  name of an uploaded file opens up a pop up dialogue box which allows file details quickly to be altered.
-* Do you want to show the file in the browser, but without the Moodle page decorations (images, PDFs, videos)? - Open
-* Do you want that, but in a new window? - In Pop-up (or possibly 'New window')
-* Do you want to use a horrible bit of non-strict HTML that should never be allowed in polite company? - In frame
-===Additional options===
-{{New features}}To show the file size and/or type on the course page and also on the resource page, simply tick the appropriate checkboxes.
+[[File:popupdialogue.png|thumb|400px|center|File info popup dialogue]]
-[[File:files showing size and type.png]]
+==Creating an alias/shortcut==
-There is also an option to display the file description on the course page below the link to the file.
+*When an uploaded file - or a file from the Private files, Dropbox, File system or EQUELLA repositories - is re-used elsewhere on Moodle, the teacher has the option to make a copy (a new, unconnected version) or to create a shortcut or ''alias''.
+*If an alias is created, then when the original file is updated, it will change in all instances of the alias. So a teacher might add course notes to their private files for example, and then add them into a number of courses. When the teacher makes an alteration in the file in their private files, this alteration will be reflected in all instances of the course notes.
+*An alias can be recognised by its thumbnail. See the difference in the screenshot below between the original file (left) and the alias (right):
+*To update a file, go to its original location (for example Private files) and upload your new version ''with the same name'' . You will be prompted to override or rename the file. Choose "override" and this file will replace your original file and the alisas/shortcuts will remain and all be updated to your latest version.
+{|
+| [[File:alias.png|thumb|Creating an alias]]
+| [[File:shortcut1.png|frame]]
+|}
-There are the usual [[Common module settings]] and  - if admin has enabled them - the Restrict access settings [[Conditional activities]].
+'''''Note:''' Aliases cannot be made in the following areas:
+''
+* an assignment submission
+* a forum post attachment
+* a workshop submission
+* a quiz essay
+* a database activity file field
+This is to prevent cases such as a student uploading an item for assessment and then subsequently changing the original in their private files. When a student uses a file from their private files in one of these instances, they do not see the options to "copy" or "create an alias".
+==Extracting or unzipping a zipped archive file ==
+If you uploaded a zip file into a File or Folder Resource, you can uncompress and expand it into its various files. To do this, go into Edit settings for the resource, right click on the file icon in the Select files area, and then click on the Unzip file button.
+[[File:file_resource_unzip.png|Unzip button]]
 ==Displaying a website index page==
-[[File:Setmainfile.png|thumb|Setting the main file]]
 The file module may be used if you have a folder with linked files such as a website with an index.html file or a flash activity with xml/swf and index file.
-[[File:file resource.png|thumb|Website index page set as main file]]
+{|
+| [[File:Setmainfile.png|thumb|Setting the main file]]
+| [[File:file resource.png|thumb|Website index page set as main file]]
+|}
 # Click the 'Turn editing on' button at the top right of the course page
 # Drag and drop the zipped folder onto the course section where you'd like it to appear, answer 'Create file resource' to the popup dialogue, then click the upload button
@@ Line 62: / Line 90: @@
 # Click the button 'Save and display' at the bottom of the page
-==File module capabilities==
+==Site settings==
+The File resource has additional settings which may be changed by an administrator in ''Site administration > Plugins > Activity modules > File''.
+*Frame height allows you to 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.
+*Available display options:  By default Moodle doesn't enable "New window" or "In frame", so you need to set them available here if required, and you can also disable other options if not applicable.
+The following capabilities relate to the file resource:
 * [[Capabilities/mod/resource:view|View file resource]]
 * [[Capabilities/mod/resource:addinstance|Add a new file resource]]
-==Site administration settings==
+[[de:Datei konfigurieren]]
+[[es:Configuraciones del recurso archivo]]
-The file module has additional settings which may be changed by an administrator in ''Settings > Site administration > Plugins > Activity modules > File''.
-===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.
-===Require activity description===
-This setting allows you to turn off the requirement for users to type something into the description box.
-===Available display options===
-This setting allows you to add different ways the resource may be displayed on the course page.
-===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.

Documentation