Documentation
Generate Screens
The Generate Screens feature allows you to automatically create preview images (screenshots) for all pages within your project's resources. This functionality is particularly useful for providing visual previews of your content in any LMS platform interface.
Overview
Using the Generate Screens feature, you can:
- create consistent preview images for all pages in your resources,
- generate both large and small preview versions simultaneously,
- customize capture dimensions and cropping settings,
- process up to 300 resources at once.
Accessing the Feature
- Navigate to the Admin panel.
- Select "Manage projects".
- Find your project and click the "Generate screens" option.
Configuration Options
Essential Settings
Capture screen width (Required)
- Sets the initial capture width of the screenshots.
- Range: 10-2000 pixels
Small screenshot width (Required)
- Determines the width of the small preview image.
- Range: 10-2000 pixels
- Must be less than or equal to the “Capture screen width”.
Large screenshot width (Required)
- Determines the width of the large preview image.
- Range: 10-2000 pixels
- Must be less than or equal to the capture screen width.
- Must be larger than the small screenshot width.
Optional Adjustments
Screen cropping - allows precise control over the captured area by defining top and bottom margins
- Top crop: 1-2000 pixels
- Bottom crop: 1-2000 pixels
Small screenshot dimensions - controls the height constraints for small preview images
- Constant height: 10-2000 pixels
- Minimum height: 10-2000 pixels
- Minimum height must be less than constant height.
Large screenshot dimensions - controls the height constraints for large preview images
- Constant height: 10-2000 pixels
- Minimum height: 10-2000 pixels
- Minimum height must be less than constant height.
Process and Behavior
When you initiate the Generate Screens process:
- The system analyzes all resources within the selected space.
- For each resource:
- creates separate tasks for screenshot generation,
- processes all pages within the resource,
- stores generated images on the server,
- updates the resource settings with preview information.
- You receive email notifications as each resource completes processing.
Automatic Management
The system intelligently manages the screenshot generation process to ensure efficiency and avoid unnecessary operations. When a resource already has screenshots, the system checks its version and the generation parameters. If the resource version has changed or the generation parameters (such as screen dimensions or cropping settings) are different from those used previously, the system will automatically remove the old screenshots and generate new ones. However, if the version and parameters remain unchanged, the system will skip that resource to optimize processing time. This ensures that screenshots are only regenerated when necessary, either due to content updates or changes in how you want the previews to appear.
Important Notes
Resource Limits:
- Maximum 300 resources processed simultaneously.
- Spaces with over 1000 resources will not start processing.
- You'll receive an email notification if the limit is exceeded.
Performance:
- Processing time is primarily determined by page loading.
- Example: 20 lessons with 10 pages each (400 screenshots) ≈ 2 minutes.
Best Practices
Plan Ahead:
- Consider the number of resources before starting.
- Ensure all pages are properly formatted.
Optimize Settings:
- Choose appropriate dimensions based on your needs.
- Consider using constant heights for consistent presentation.
Monitor Progress:
- Check email notifications for completion status.
- Verify generated previews after processing.
Troubleshooting
If you encounter issues:
- Verify resource count is within limits.
- Check that all width/height values meet dependencies.
- Ensure resources are properly exported to your target platform.