This userscript displays a warning dialog to students when they access a virtual machine (VM) website. It reminds them that their data is not saved after the session and prompts them to use OneDrive for file storage. After acknowledging the warning, the script attempts to activate full-screen mode for the VM.
## Getting started
## Features
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
-[ ] [Set up project integrations](https://gitlab.cci.drexel.edu/icommonsCRC/vclwarningscripttampermonkey/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
- Displays a warning dialog when the VM page loads
- Reminds students to use OneDrive for file storage
- Attempts to activate full-screen mode after the warning is acknowledged
- Works with Tampermonkey browser extension
# Editing this README
## Installation
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
1. Install the Tampermonkey browser extension for your preferred browser.
2. Click on the Tampermonkey icon and select "Create a new script."
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
3. Copy and paste the entire script into the editor.
## Name
4. Replace `https://your-vm-site-url.com/*` in the `@match` line with the actual URL of your VM website.
Choose a self-explaining name for your project.
## Description
5. Save the script by pressing Ctrl+S or clicking File > Save.
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
## Usage
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Once installed, the script will automatically run when students visit the specified VM website. They will see a warning dialog reminding them to save their work to OneDrive. After clicking "OK," the script will attempt to activate full-screen mode.
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
## Customization
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
You may need to customize the script based on your specific VM website:
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
1.**Warning Message**: Modify the text inside the `dialog.innerHTML` if you need to change the warning message.
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
2.**Fullscreen Button**: If the fullscreen button on your VM website has a different structure, update the selector in the `clickFullscreenButton` function.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
## Troubleshooting
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
If the script doesn't work as expected:
## Authors and acknowledgment
1. Check the browser's console for debug messages (press F12 to open developer tools).
Show your appreciation to those who have contributed to the project.
2. Ensure the `@match` URL in the script matches your VM website URL.
3. Verify that the fullscreen button selector in `clickFullscreenButton` function matches your website's HTML structure.
## License
## Maintenance
For open source projects, say how it is licensed.
## Project status
Periodically check and update the script, especially after any changes to the VM website's interface. The fullscreen button's HTML structure might change, requiring updates to the `clickFullscreenButton` function.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.