Docs updates from Jeremy

README.md

@@ -53,10 +53,11 @@ For QGIS versions below 3.26, see the documentation for [QGIS Animation Workbenc
 
 This software is licensed under the [GPL v2](https://github.com/timlinux/QGISAnimationWorkbench/blob/master/LICENSE) © [timlinux](https://github.com/timlinux).
 
-## :yellow_heart: Credits
+## 💛 Credits
 
 - Tim Sutton
 - Nyall Dawson
 - Mathieu Pellerin
 - Jeremy Prior
+- Thiasha Vythilingam
 

docs/contribute/contribute.md

@@ -16,49 +16,49 @@ commit messages (see [GitMoji](https://gitmoji.dev/)).
 
 | Commit type                | Emoji                                                     |
 | :------------------------- | :-------------------------------------------------------- |
-| Initial commit             | :tada: `:tada:`                                           |
-| Version tag                | :bookmark: `:bookmark:`                                   |
-| New feature                | :sparkles: `:sparkles:`                                   |
-| Bugfix                     | :bug: `:bug:`                                             |
-| Metadata                   | :card_index: `:card_index:`                               |
-| Documentation              | :books: `:books:`                                         |
-| Documenting source code    | :bulb: `:bulb:`                                           |
-| Performance                | :racehorse: `:racehorse:`                                 |
-| Cosmetic                   | :lipstick: `:lipstick:`                                   |
-| Tests                      | :rotating_light: `:rotating_light:`                       |
-| Adding a test              | :white_check_mark: `:white_check_mark:`                   |
-| Make a test pass           | :heavy_check_mark: `:heavy_check_mark:`                   |
-| General update             | :zap: `:zap:`                                             |
-| Improve format/structure   | :art: `:art:`                                             |
-| Refactor code              | :hammer: `:hammer:`                                       |
-| Removing code/files        | :fire: `:fire:`                                           |
-| Continuous Integration     | :green_heart: `:green_heart:`                             |
-| Security                   | :lock: `:lock:`                                           |
-| Upgrading dependencies     | :arrow_up: `:arrow_up:`                                   |
-| Downgrading dependencies   | :arrow_down: `:arrow_down:`                               |
-| Lint                       | :shirt: `:shirt:`                                         |
-| Translation                | :alien: `:alien:`                                         |
-| Text                       | :pencil: `:pencil:`                                       |
-| Critical hotfix            | :ambulance: `:ambulance:`                                 |
-| Deploying stuff            | :rocket: `:rocket:`                                       |
-| Fixing on MacOS            | :apple: `:apple:`                                         |
-| Fixing on Linux            | :penguin: `:penguin:`                                     |
-| Fixing on Windows          | :checkered_flag: `:checkered_flag:`                       |
-| Work in progress           | :construction:  `:construction:`                          |
-| Adding CI build system     | :construction_worker: `:construction_worker:`             |
-| Analytics or tracking code | :chart_with_upwards_trend: `:chart_with_upwards_trend:`   |
-| Removing a dependency      | :heavy_minus_sign: `:heavy_minus_sign:`                   |
-| Adding a dependency        | :heavy_plus_sign: `:heavy_plus_sign:`                     |
-| Docker                     | :whale: `:whale:`                                         |
-| Configuration files        | :wrench: `:wrench:`                                       |
-| Package.json in JS         | :package: `:package:`                                     |
-| Merging branches           | :twisted_rightwards_arrows: `:twisted_rightwards_arrows:` |
-| Bad code / need improv.    | :hankey: `:hankey:`                                       |
-| Reverting changes          | :rewind: `:rewind:`                                       |
-| Breaking changes           | :boom: `:boom:`                                           |
-| Code review changes        | :ok_hand: `:ok_hand:`                                     |
-| Accessibility              | :wheelchair: `:wheelchair:`                               |
-| Move/rename repository     | :truck: `:truck:`                                         |
+| Initial commit             | 🎉 `:tada:`                                           |
+| Version tag                | 🔖 `:bookmark:`                                   |
+| New feature                | ✨ `:sparkles:`                                   |
+| Bugfix                     | 🐛 `:bug:`                                             |
+| Metadata                   | 📇 `:card_index:`                               |
+| Documentation              | 📚 `:books:`                                         |
+| Documenting source code    | 💡 `:bulb:`                                           |
+| Performance                | 🐎 `:racehorse:`                                 |
+| Cosmetic                   | 💄 `:lipstick:`                                   |
+| Tests                      | 🚨 `:rotating_light:`                       |
+| Adding a test              | ✅ `:white_check_mark:`                   |
+| Make a test pass           | ✔️ `:heavy_check_mark:`                   |
+| General update             | ⚡️ `:zap:`                                             |
+| Improve format/structure   | 🎨 `:art:`                                             |
+| Refactor code              | 🔨 `:hammer:`                                       |
+| Removing code/files        | 🔥 `:fire:`                                           |
+| Continuous Integration     | 💚 `:green_heart:`                             |
+| Security                   | 🔒 `:lock:`                                           |
+| Upgrading dependencies     | ⬆️ `:arrow_up:`                                   |
+| Downgrading dependencies   | ⬇️ `:arrow_down:`                               |
+| Lint                       | 👕 `:shirt:`                                         |
+| Translation                | 👽 `:alien:`                                         |
+| Text                       | 📝 `:pencil:`                                       |
+| Critical hotfix            | 🚑 `:ambulance:`                                 |
+| Deploying stuff            | 🚀 `:rocket:`                                       |
+| Fixing on MacOS            | 🍎 `:apple:`                                         |
+| Fixing on Linux            | 🐧 `:penguin:`                                     |
+| Fixing on Windows          | 🏁 `:checkered_flag:`                       |
+| Work in progress           | 🚧  `:construction:`                          |
+| Adding CI build system     | 👷 `:construction_worker:`             |
+| Analytics or tracking code | 📈 `:chart_with_upwards_trend:`   |
+| Removing a dependency      | ➖ `:heavy_minus_sign:`                   |
+| Adding a dependency        | ➕ `:heavy_plus_sign:`                     |
+| Docker                     | 🐳 `:whale:`                                         |
+| Configuration files        | 🔧 `:wrench:`                                       |
+| Package.json in JS         | 📦 `:package:`                                     |
+| Merging branches           | 🔀 `:twisted_rightwards_arrows:` |
+| Bad code / need improv.    | 💩 `:hankey:`                                       |
+| Reverting changes          | ⏪ `:rewind:`                                       |
+| Breaking changes           | 💥 `:boom:`                                           |
+| Code review changes        | 👌 `:ok_hand:`                                     |
+| Accessibility              | ♿️ `:wheelchair:`                               |
+| Move/rename repository     | 🚚 `:truck:`                                         |
 | Other                      | [Be creative](http://www.emoji-cheat-sheet.com/)          |
 
 ## 💬 Contributing

docs/faq/faq.md

@@ -1 +1,9 @@
-# Frequently Asked Questions
+# Frequently Asked Questions
+
+#### Can I add any image to the intro or outro?
+
+- As long as you can provide the proper attribution for an image you can use it in your project.
+
+#### I have an older, less powerful, computer, will it handle running this workbench?
+
+- If you open the standard QGIS settings dialog and select the Animation Workbench options you can follow the advice with regards to lowering the number of threads allowed during rendering to help you computer cope. Rendering shorter movies or GIFs (i.e. fewer frames) will also help.

docs/manual/workbench_ui.md

@@ -0,0 +1,117 @@
+# The Workbench User Interface
+
+## Animation Plan
+
+- 1\. Render Modes: These determine the behaviour and type of animation
+  - `Sphere`: The coordinate reference system (CRS) will be manipulated to create a spinning globe effect.
+        Like Google Earth might do, but with your own data and cartography.
+  - `Planar`: The coordinate reference system (CRS) will not be altered, but the camera will pan and zoom
+        to each point. It lets you move from feature to feature on a flat map, pausing at each if you want to.
+  - `Fixed extent`: The frame of reference stays the same and you can animate the symbology within that scene.
+
+- 2\. Animation Layer:
+  - `Dropdown menu`: This allows you to select which map layer you want the animation to follow.
+  - `Loop from final feature back to first feature`: allows for a seamlessly looping output GIF or movie(MP4).
+
+- 3\. Zoom Range: The scale range that the animation should move through.
+  - Minimum (exclusive): The zenith (highest point) of the animation when it zooms out while travelling between
+        points, i.e. the most "zoomed out".
+  - Maximum (inclusive): The scale (zoom level) used when we arrive at each point, i.e. the most "zoomed in".
+
+- 4\. Data defined settings
+  - Scale
+    - Minimum: User-defined minimum scale
+    - Maximum: User-defined maximum scale
+
+- 5\. Animation Frames
+  - Frame rate per second (fps): When writing to video or gif, how many frames per second to use.
+  - Travel Duration: This is the number of seconds that the animation will take during animation from one feature to the next.
+  - Feature Hover duration: This is the number of seconds that the animation will hover over each feature.
+
+![Sphere and Planar](img/001_AnimationPlan_SpherePlanar_1.png)
+
+- 6\. Extent:
+  - Can be manually entered using North, East, South, and West coordinates as limits.
+  - Can be calculated from a map layer, the layout map, or a bookmark.
+  - Can be set to match the Map Canvas Extent
+  - Can be set as a rectangular extent using the `Draw on Canvas` feature.
+
+- 7\. Pan and Zoom Easings
+  - What are Easings: Easings are transitions from one state to another along a smooth curve. A user can specify the
+        shape of the curve used.
+  - Pan Easings (XY): The pan easing will determine the motion characteristics of the camera on the X and Y axis as it
+         flies across the scene (i.e. how it accelerates or decelerates between points)
+  - Zoom Easing (Z): The pan easing will determine the motion characteristics of the camera on the Z axis as it flies
+        across the scene (i.e. how the camera zooms in and out of the points)
+
+- 8\. Frame previews: A preview of what each frame of the animation will look like. A user can decide which `Frame` to view.
+
+![Fixed Extent](img/002_AnimationPlan_FixedExtent_1.png)
+
+## Intro Tab
+
+Edit the intro section of the generated movie here.
+
+- Media: List of the various images or movies selected for the intro section. You can drag and drop items in the list to change the play order.
+  - 1\. Add Media (Plus sign): Add images or movies
+  - 2\. Remove Media (Minus sign): Remove images or movies
+- 3\. Duration: For images, you can set a duration for each image (in seconds).
+- 4\. Preview Frame: This shows what the media will look like.
+- Details: Provides details about where the media is stored on your computer.
+
+![Intro Tab](img/003_IntroTab_1.png)
+
+## Outro Tab
+
+Edit the outro section of the generated movie here.
+
+- Media: List of the various images or movies selected for the outro section. You can drag and drop items in the list to change the play order.
+  - 1\. Add Media (Plus sign): Add images or movies
+  - 2\. Remove Media (Minus sign): Remove images or movies
+- 3\. Duration: For images, you can set a duration for each image (in seconds).
+- 4\. Preview Frame: This shows what the media will look like.
+- Details: Provides details about where the media is stored on your computer.
+
+![Outro Tab](img/004_OutroTab_1.png)
+
+## Soundtrack Tab
+
+- Media: List of the various sound files (.mp3 or .wav) to play during the generated movie. You can drag and drop items in the list to change the play order.
+  - 1\. Add Media (Plus sign): Add sound files (.mp3 or .wav) to play during the generated movie.
+  - 2\. Remove Media (Minus sign): Remove sound files (.mp3 or .wav)
+- 3\. Duration: The cumulative length of your soundtracks should be as long, or longer, than your movie, including the intro/outro sections. If the soundtrack is longer than the movie it will be truncated (shortened) when the movie ends.
+- Details: Provides details about where the media is stored on your computer.
+
+![Soundtrack Tab](img/005_SoundtrackTab_1.png)
+
+## Output
+
+- Output Options: Select which output format you would like. Regardless of the format chosen, a folder
+of images will be created, one image per frame.
+  - 1\. Re-use cached Images: This will not erase cached images on disk and will resume processing from the last cached image.
+  - 2\. Animated GIF: For this export to work, you need to have the ImageMagick 'convert'  application available on your system.
+  - 3\. Movie (MP4): For this option to work, you need to have the 'ffmpeg' application on your system.
+  - 4\. File selection (ellipsis): This lets a user select the location where the output will be stored.
+
+![Output Tab](img/006_OutputTab_1.png)
+
+## Progress
+
+- 1\. Frame Preview: A preview of what each frame of the animation will look like. It changes automatically as the workbench runs.
+- 2\. Progress: This provides a detailed look at what is happening while the workbench runs.
+  - Total Tasks: This number represents the total number of frames that will be generated by the workbench.
+  - Completed Tasks: The number of tasks that have completed being processed.
+  - Remaining Features: The number of features from your animation layer that still need to be processed.
+  - Active Tasks: The number of tasks (threads) currently being run by the workbench
+  - Features Complete: The number of tasks that have been processed by the workbench.
+- 3\. Logs: A detailed list of what steps the workbench is doing (a record of processing)
+- 4\. Progress Bar: A visual representation of the workbench's progression as a percentage.
+
+![Progress Tab](img/007_ProgressTab_1.png)
+
+## Other Buttons
+
+- `Run`: Starts the process of getting an output from the workbench. It is greyed out until a user provides a destination for the output file.
+- `Close`: Closes the workbench.
+- `Cancel`: Ends the workbench processing at whatever point it has reached when the button is pressed.
+- `Help`: Opens a link to the Animation Workbench documentation.

docs/start/install.md

@@ -4,6 +4,22 @@ We have not yet published the plugin in the QGIS Plugin Repository, but when we
 do you will be able to access it simply by clicking on the "QGIS Animation Workbench"
 option in the QGIS Plugin Manager.
 
+To access the QGIS Plugin Manager you simply need to select
+1\. `Plugins` -> `Manage and Install Plugins...` in the Menu Toolbar.
+
+![Plugin Repository](img/001_PluginManager_1.png)
+
+Once the QGIS Plugin Manager loads, you need to navigate to the 2\. `All` tab and
+3\. type "animation" into the search bar. Select QGIS Animation Workbench from the list
+of available plugins and then select 4\. `Install Plugin`
+
+![Search For and Install Plugin](img/002_SearchForPlugin_2.png)
+
+Once the Animation Workbench is installed, you can access it by clicking on the
+5\. `Animation Workbench` icon in the Plugin Toolbar
+
+![Launch the Workbench](img/003_AWLaunch_1.png)
+
 > Note if you are on Ubuntu, you may need to install the Qt5 multimedia libraries.
 
 ```bash