Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explore automatic generation of videos with graphical/mouse interactions #289

Open
melissawm opened this issue Dec 4, 2023 · 4 comments
Labels

Comments

@melissawm
Copy link
Member

🧰 Task

In order to keep the documentation up to date, the videos (webm) we have on our docs pages should be automated whenever possible. This doesn't mean they would be rebuilt at every docs build, but maybe once every release or when we have important gui changes.

The initial proposal is to have a script that is associated with each video and describes the sequence of actions that needs to be executed to capture that output. For example: for this video on the points layer guide, a script would be:

- Click add points icon
- Add three new points
- Click select points icon
- Select two points individually
- Drag mouse to select group of points
- Change face color 
- Change edge color
- Select group of points with different colors
- Use slider to increase point size
- Select another group of points
- Use slider to decrease point size
- With no point selected, click symbol dropdown and select cross
- Use slider to decrease opacity
- Use slider to increase opacity
- Select group of points and click the "delete selected symbol" icon
- Click the add points icon
- Use the face color dropdown to select a different color
- Use the slider to increase point size and add new points

In the future, we can maybe explore tools such as https://pyautogui.readthedocs.io/en/latest/

@melissawm melissawm added the task label Dec 4, 2023
@psobolewskiPhD
Copy link
Member

Oh wow, that's a great idea!

@melissawm
Copy link
Member Author

Another thought: can we add a "review videos and images for outdated content" to the release guide?

The release manager doesn't need to be responsible for this but maybe they can ping the documentation leads. This would make it a soft regular requirement.

@kephale
Copy link
Contributor

kephale commented Feb 29, 2024

I just want to cross reference this issue with this open napari issue about video recording from @GenevieveBuckley: napari/napari-animation#225

@psobolewskiPhD
Copy link
Member

I will add to the cross reference:
docs issue: #289
We may want to consider napari-animation in this context too https://github.com/napari/napari-animation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Prioritized
Development

No branches or pull requests

3 participants