Managing Course References and Attachments

Course references provide supplementary materials and resources supporting course content through file attachments, instructional notes, code snippets, and external resource links. Reference management enables administrators to organize supporting documentation, provide learner access to additional materials, attach prerequisite resources, and maintain comprehensive content libraries that enhance course value beyond primary lesson content.

Administrators manage course references through References tab interface supporting multiple reference types including uploaded files, rich text notes, formatted code snippets, and external website bookmarks. Reference organization provides learners with centralized access to supplementary materials while maintaining clear separation from primary course content, supporting flexible resource delivery without disrupting core lesson structure.

Requirements

To manage course references and attachments, users must be assigned a security role with one of the following permissions:

• Administrator System Role
• Access Level: Training Manager, Manage Courses

Course References Overview

Course references serve multiple purposes supporting comprehensive training delivery and learner resource access.

Supplementary Material Repository

References provide centralized location for materials supporting but not replacing primary course content.

Material Types:

• Reference documents and study guides
• Prerequisite reading materials
• Job aids and quick reference cards
• Forms and templates for practical application
• Additional resources for advanced learners
• External research papers or articles
• Software documentation or technical specifications

Flexible Content Delivery

References support varied content formats accommodating different resource types and learner needs.

Content Flexibility:

• File attachments for downloadable resources
• Text notes for informal instructions or clarifications
• Code snippets for technical reference and examples
• External bookmarks for web-based resources
• Mixed content types within single course reference library
• Drag-and-drop file upload for efficient attachment management

Resource Organization

References maintain clear separation from lesson content enabling optional resource access without disrupting required course materials.

Organizational Benefits:

• Supplementary materials available without cluttering lessons
• Optional resources for learners seeking additional information
• Prerequisite materials accessible before course commencement
• Post-course resources for continued learning and application
• Centralized reference location simplifying resource discovery

Accessing Course References

1. Navigate to the Training module from your portal navigation menu
2. Click the Courses tab in primary navigation
3. Click the course name requiring reference management
4. Click the References tab in course navigation
5. The References page displays with file attachment list and reference creation options

Reference Types

The Training Module supports four reference types enabling varied content delivery and resource organization.

File Attachments

Uploaded files providing downloadable resources for learner access.

Purpose: Deliver documents, spreadsheets, presentations, media files, or any digital content supporting course learning objectives.

Use Cases:

• PDF reference guides and study materials
• Excel templates for practice exercises
• PowerPoint presentations for additional context
• Word documents with detailed instructions
• Media files including audio or video content
• Compressed archives containing multiple resources
• Software installation files or configuration scripts

File Support: Any file type can be attached with reasonable size limitations supporting diverse content delivery.

Notes

Rich text content providing formatted text information without requiring file creation.

Purpose: Deliver informal instructions, clarifications, announcements, or textual resources through inline rich text editor.

Use Cases:

• Course announcements or updates
• Clarification of complex concepts
• Supplementary explanations beyond lesson content
• Informal study tips or learning strategies
• Prerequisites or recommended preparation
• Copyright or attribution information
• Links to multiple external resources with descriptions

Content Features: Rich text formatting supporting bold, italic, lists, headings, links, and basic text organization.

Snippets

Formatted code or text snippets providing technical reference or reusable content examples.

Purpose: Deliver code samples, configuration examples, command-line instructions, or other formatted technical content.

Use Cases:

• Code examples for programming courses
• Configuration file templates
• Command-line syntax reference
• SQL query examples
• API request samples
• Regular expressions or patterns
• Script templates for automation

Format Support: Extension selection enabling appropriate syntax formatting or plain text display.

Bookmarks

External website links providing access to online resources without file uploading.

Purpose: Direct learners to external websites, documentation, tools, or online resources supporting course objectives.

Use Cases:

• Official documentation websites
• Online tools or applications
• Research articles or whitepapers
• Industry resources or standards bodies
• Video tutorials or demonstrations
• Community forums or discussion boards
• Vendor websites or product information

Link Management: Simple URL storage with descriptive names supporting intuitive resource access.

Attaching Files

File attachment provides downloadable resources through direct upload to course reference library.

File Attachment Workflow

1. Ensure References tab is selected in course navigation
2. Click Attach File button in References interface
3. Browser file selection dialog opens for file selection
4. Navigate to file on your computer requiring attachment
5. Select file for upload meeting size and format requirements
6. Click Open to initiate file upload
7. System uploads file and displays in reference list
8. File is accessible immediately to learners with course access

Drag-and-Drop Upload

Alternative upload method supporting efficient file attachment without button interaction.

1. Open file browser window on your computer
2. Navigate to file requiring attachment to course
3. Drag file from computer file browser to References page
4. Drop file onto References interface area
5. System uploads file automatically and displays in reference list

File Upload Considerations

File Size Limitations:

Reasonable file size limits ensure efficient upload and download performance. Extremely large files may require compression or alternative delivery methods.

File Format Support:

Any file type can be attached supporting comprehensive resource delivery including:

• Documents (.doc, .docx, .pdf, .txt, .rtf)
• Spreadsheets (.xls, .xlsx, .csv)
• Presentations (.ppt, .pptx)
• Images (.jpg, .png, .gif, .bmp)
• Media (.mp3, .mp4, .avi, .mov)
• Compressed archives (.zip, .rar, .tar)
• Code files (.html, .css, .js, .py, .java, etc.)

Upload Verification:

After upload completes, verify file appears in reference list with correct filename and is downloadable by test download.

Creating Notes

Notes provide rich text content through inline editor without requiring external file creation or upload.

Note Creation Workflow

1. Ensure References tab is selected in course navigation
2. Click New dropdown button in References interface
3. Select New Note from dropdown menu
4. New Note dialog opens for note configuration
5. Enter Name in Name field providing descriptive note title
6. Click Save to create note with specified name
7. Note appears in reference list with rich text editor
8. Enter note content in rich text editor using formatting tools
9. Click X or close editor to save note content

Rich Text Editor Features

Note content editor supports comprehensive text formatting enabling professional content presentation.

Formatting Options:

• Bold, italic, underline text emphasis
• Headings (H1-H6) for content organization
• Bulleted and numbered lists
• Text alignment (left, center, right, justified)
• Hyperlinks to external websites or resources
• Font colors and highlighting
• Block quotes for emphasized content
• Horizontal rules for content separation

Note Best Practices

Use notes for:

• Quick reference information not warranting separate file
• Course announcements or important updates
• Clarifications or additional context for lessons
• Study tips or learning strategies
• Prerequisites or recommended preparation
• Multiple related links with explanatory text
• Copyright notices or attribution information

Avoid notes for:

• Extensive content better served by lesson or document
• Content requiring specific formatting preservation
• Material requiring download for offline access
• Content needing version control or formal documentation
• Information requiring wide distribution beyond course

Creating Snippets

Snippets provide formatted code or text content with syntax support for technical reference materials.

Snippet Creation Workflow

1. Ensure References tab is selected in course navigation
2. Click New dropdown button in References interface
3. Select New Snippet from dropdown menu
4. New Snippet dialog opens for snippet configuration
5. Enter Subject in Subject field (required) providing descriptive snippet title
6. Select Extension from Extension dropdown choosing appropriate format type
7. Click Save to create snippet with specified configuration
8. Snippet appears in reference list with editor interface
9. Enter snippet content in editor using appropriate syntax
10. Click X or close editor to save snippet content

Extension Selection

Extension dropdown controls snippet formatting and syntax highlighting supporting appropriate content display.

Available Extensions:

• Plain Text (default) - No special formatting or syntax highlighting
• Additional extensions based on system configuration supporting various programming languages and formats

Extension Selection Guidance:

Select Plain Text when:

• Content is unformatted text without syntax requirements
• Code language is not available in extension options
• Generic text content does not require special formatting

Select specific extension when:

• Code content benefits from syntax highlighting
• Language-specific formatting improves readability
• Technical content matches available extension type

Snippet Best Practices

Use snippets for:

• Code examples demonstrating programming concepts
• Configuration file templates or samples
• Command-line syntax reference
• SQL query examples or patterns
• API request and response examples
• Regular expressions or validation patterns
• Script templates for automation or customization

Format snippets with:

• Clear comments explaining code functionality
• Consistent indentation for readability
• Realistic examples applicable to learner scenarios
• Error-free syntax preventing learner confusion
• Complete examples demonstrating full implementation

Creating Bookmarks

Bookmarks provide external website links directing learners to online resources without file hosting requirements.

Bookmark Creation Workflow

1. Ensure References tab is selected in course navigation
2. Click New dropdown button in References interface
3. Select New Bookmark from dropdown menu (alternative name may be "Bookmark")
4. New Bookmark dialog opens for bookmark configuration
5. Enter descriptive name for link in Name field
6. Enter complete URL including https:// protocol in URL field
7. Click Save to create bookmark with specified information
8. Bookmark appears in reference list as clickable link

URL Configuration

Complete URL Format:

Enter full URL including protocol (https:// or http://) ensuring link functionality.

Examples:

• https://www.example.com/documentation
• https://docs.product.com/api-reference
• https://community.forum.com/best-practices

Avoid:

• Incomplete URLs missing protocol (www.example.com)
• Internal links not accessible to external learners
• Temporary URLs that may expire or change
• URLs requiring authentication without notification

Bookmark Best Practices

Use bookmarks for:

• Official product documentation websites
• Industry standards or best practices resources
• Online tools or applications supporting course content
• Video tutorials or demonstration websites
• Community forums or support resources
• Research papers or academic publications
• Vendor websites with product information

Select reliable bookmarks:

• Verify URLs are accessible and functional before adding
• Choose authoritative sources providing accurate information
• Prefer stable websites unlikely to change or disappear
• Test bookmark access as learner ensuring functionality
• Update or remove bookmarks when targets become unavailable

Managing Existing References

Reference management supports editing, reordering, and removing references as course evolves and content requirements change.

Editing Reference Names

Reference names can be updated to improve clarity or reflect content changes.

1. Locate reference requiring name modification in reference list
2. Click reference name or access edit option through reference actions
3. Update name in edit interface with improved description
4. Save changes to persist updated name
5. Reference displays updated name immediately in reference list

Reference Content Editing

Reference content can be modified after initial creation supporting ongoing maintenance and improvement.

For Notes and Snippets:

1. Click note or snippet in reference list to open editor
2. Modify content using rich text editor or snippet editor
3. Click X or close editor to save content changes
4. Changes persist immediately without additional save action

For Bookmarks:

1. Access bookmark edit interface through reference actions
2. Update URL or name as needed
3. Save changes to persist updated bookmark information

Removing References

References can be deleted when content is no longer relevant or appropriate for course.

1. Locate reference requiring removal in reference list
2. Access delete option through reference actions or interface
3. Confirm deletion if prompted (permanent action)
4. Reference removes from list immediately
5. Learners lose access to removed reference

Removal Considerations:

• Verify reference is no longer needed before deletion (permanent action)
• Consider editing content rather than removing when update is sufficient
• Communicate reference removal to active learners if material was previously relied upon
• Maintain reference archives outside portal if historical record is valuable

Reordering References

References display in list order which can be adjusted through interface controls when supported.

Reordering Support:

If reordering functionality is available, references can be arranged in logical order supporting learner navigation and prioritization.

Organizational Strategies:

• Place prerequisite materials before supplementary resources
• Order references by importance or usage frequency
• Group related references together
• Sequence references aligning with lesson progression
• Position most valuable resources prominently

Reference Access for Learners

Learners access course references through course interface supporting convenient resource discovery and download.

Learner Reference Access

Learners view references in course navigation or details page accessing supplementary materials alongside primary course content.

Access Location:

References typically accessible through course details interface, sidebar, or dedicated reference section depending on portal configuration.

Learner Capabilities:

• View reference list with names and types
• Click files to download or preview
• Open notes to read rich text content
• View snippets in formatted display
• Click bookmarks to open external websites in new tabs
• Search or filter references when reference list is extensive

Reference Download

Learners download file attachments accessing resources for offline review and application.

Download Process:

1. Learner navigates to course references section
2. Clicks file attachment name or download icon
3. File downloads to learner's default download location
4. Learner opens file using appropriate application

Download Considerations:

• File size impacts download time for learners with limited bandwidth
• File format requires appropriate software for opening
• Downloaded files are learner's responsibility for security and organization
• No tracking of individual file downloads in standard reporting

Best Practices and Recommendations

Reference Type Selection

Use file attachments when:

• Content requires download for offline access or application
• Material needs specific formatting preserved (documents, spreadsheets)
• Resources are formal documents requiring file-based distribution
• Content includes media files (audio, video, images)
• Learners need templates or forms for completion

Use notes when:

• Quick reference information does not warrant separate file
• Content is informal instructions or clarifications
• Multiple links require explanatory text or context
• Announcements or updates need prominent display
• Simple formatted text serves purpose without file complexity

Use snippets when:

• Code examples require syntax formatting
• Technical content benefits from monospace display
• Configuration templates need clear formatting
• Command-line instructions require precise syntax
• Programming patterns or examples support course content

Use bookmarks when:

• External websites provide authoritative resources
• Online tools or applications support course objectives
• Documentation or references are web-based
• Community resources or forums provide value
• Third-party content complements course materials

Content Organization

Organize references logically supporting intuitive learner navigation and resource discovery.

Group related references together maintaining topical or functional organization.

Name references descriptively enabling learners to identify content without opening each reference.

Order references by importance or usage sequence when ordering functionality is supported.

Limit reference quantity to essential materials preventing overwhelming learners with excessive options.

Reference Quality

Ensure references provide genuine value complementing course content rather than duplicating lesson materials.

Verify file attachments open correctly and contain expected content before learner access.

Test bookmark URLs regularly confirming external websites remain accessible and relevant.

Review notes and snippets periodically ensuring content accuracy and currency.

Remove outdated references promptly preventing learner confusion or misinformation.

File Management

Optimize file attachments for reasonable file size balancing quality and download performance.

Use appropriate file formats ensuring learner compatibility with standard software.

Name files descriptively before upload supporting meaningful reference names in list.

Consider compressing multiple related files into single archive for efficient distribution.

Maintain file versions outside portal ensuring ability to restore or replace as needed.

Learner Communication

Highlight valuable references in course descriptions or lesson content drawing learner attention.

Provide guidance on reference usage explaining when and how learners should access materials.

Communicate reference updates to active learners when significant changes occur.

Distinguish required references from optional supplementary materials setting appropriate expectations.

Solicit learner feedback on reference value identifying improvement opportunities.

Content Maintenance

Review course references regularly during course updates ensuring continued relevance and accuracy.

Update or replace outdated materials proactively preventing learner confusion or misinformation.

Add new references as course evolves or additional valuable resources become available.

Remove references that are no longer valuable or accessible reducing learner navigation burden.

Document reference rationale internally supporting future decision-making during course maintenance.

Troubleshooting Tips

Cannot Attach File

Verify you have Manage Courses permissions at appropriate scope level for reference management.

Check file size is reasonable and does not exceed system limitations for uploads.

Ensure stable internet connection during upload for successful file transfer.

Try different browser if upload consistently fails in current browser environment.

Verify file is not corrupted by attempting to open file outside portal.

File Upload Fails

Confirm file format is supported (all standard formats typically supported).

Check internet connection stability during upload operation for large files.

Reduce file size through compression or optimization if upload fails repeatedly.

Try drag-and-drop upload method if button upload fails consistently.

Contact system administrator if upload issues persist after troubleshooting.

Note or Snippet Not Saving

Verify you clicked close (X) or otherwise triggered save action for editor.

Check that content was actually entered into editor before attempting save.

Refresh browser page and verify note or snippet appears in reference list.

Try creating note or snippet again if initial attempt fails to save.

Contact administrator if saving issues persist across multiple attempts.

Bookmark Link Not Working

Verify URL includes complete protocol (https:// or http://) in bookmark configuration.

Test URL directly in browser ensuring website is accessible and functional.

Check for typos in URL entry preventing proper link functionality.

Update bookmark URL if external website has changed or moved content.

Remove bookmark if external website is permanently unavailable or inaccessible.

References Not Displaying to Learners

Verify course is Published making references accessible to assigned learners.

Check that learners have course access through appropriate assignment or enrollment.

Confirm references actually exist in References tab and were saved successfully.

Review portal configuration ensuring reference display is enabled for learner interface.

Test reference access as learner role verifying functionality in learner view.

Cannot Remove Reference

Verify you have Manage Courses permissions at appropriate scope level.

Check that course sharing settings allow your modification access based on permissions.

Refresh browser page if remove action appears unresponsive or fails.

Try different browser if removal functionality fails in current browser.

Contact system administrator if removal issues persist after verification.

Reference Order Not Changing

Verify ordering functionality is available in your portal version and configuration.

Check if drag-and-drop or alternative ordering mechanism is supported for references.

Refresh browser after reordering to confirm changes persisted correctly.

Clear browser cache if reordering appears successful but doesn't persist.

Contact administrator if ordering functionality is needed but unavailable.

Snippet Extension Not Available

Verify snippet extensions are configured in system for desired language or format.

Use Plain Text extension as fallback when specific extension unavailable.

Contact administrator to request additional snippet extension configuration if needed.

Consider using file attachment for code if snippet formatting is insufficient.

Provide code in note format with monospace font if snippet not suitable.

Jump to Training Module Checklist

<< Adding Course Pictures | Cloning and Sharing Courses >>