Skip to content

Commit

Permalink
Improvements to documentation:
Browse files Browse the repository at this point in the history
- Remove Gap and Remove All Gaps
- Max limits on scale x/y and shear x/y
- Updated Blender min version to 4.1 and updated doc references
- Added Fuse library requirement for AppImage and AppImage launcher instructions
- Mentioned High DPI monitor support, and troubleshooting steps and link to our wiki
- Described 3 included themes
  • Loading branch information
jonoomph committed May 30, 2024
1 parent 9b75d14 commit d96a914
Show file tree
Hide file tree
Showing 9 changed files with 114 additions and 15 deletions.
22 changes: 20 additions & 2 deletions doc/clips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,22 @@ Here is a list of all methods for cutting and/or trimming clips in OpenShot:

Keep in mind that the above cutting methods also have :ref:`keyboard_shortcut_ref`, to save even more time.

Remove Gap
""""""""""
The :guilabel:`Remove Gap` context menu option deletes the gap between two clips on the timeline, shifting all subsequent clips to close the gap.
Right click on a gap between clips to find this option. The option is only available when a gap is detected.

- **Usage Example:** Use this option when you want to quickly eliminate a specific gap between clips caused by trimming or the razor tool.
- **Tip:** If you have many gaps on a single track, you can also right click on the track name, and select :guilabel:`Remove All Gaps`.

Remove All Gaps
"""""""""""""""
The :guilabel:`Remove All Gaps` context menu option removes all gaps between clips on the timeline, shifting all clips to ensure there are no empty spaces.
Right click on a track name to find this option. The option is only available when gaps are detected.

- **Usage Example:** Ideal for tracks that contain back-to-back clips, such as a photo slideshow, where no gaps are desired.
- **Tip:** Review the entire track after using this option to ensure that no clips are unintentionally moved.

.. _clip_presets_ref:

Context Menu
Expand Down Expand Up @@ -513,7 +529,8 @@ of the screen, without adding any black bars on the edges. The scale methods are
Scale X and Scale Y
"""""""""""""""""""
The :guilabel:`Scale X` and :guilabel:`Scale Y` properties are key-frame curves that represent horizontal and vertical scaling in percentages,
respectively. The range for these curves is 0 to 1. See :ref:`clip_transform_ref`.
respectively. The range for these curves is 0 to 1. See :ref:`clip_transform_ref`. OpenShot limits the max scale values based
on the file type and the project size, to prevent crashes and performance issues.

- **Usage Example:** Creating a zoom-in effect by animating the Scale X and Scale Y curves simultaneously.
- **Tip:** Scale the image larger than the screen, only revealing a portion of the video. This is a simple way to crop a portion of the video.
Expand All @@ -523,7 +540,8 @@ respectively. The range for these curves is 0 to 1. See :ref:`clip_transform_ref
Shear X and Shear Y
"""""""""""""""""""
The :guilabel:`Shear X` and :guilabel:`Shear Y` properties are key-frame curves that represent X and Y shear
angles in degrees, respectively. See :ref:`clip_transform_ref`.
angles in degrees, respectively. See :ref:`clip_transform_ref`. OpenShot limits the max shear values based
on the file type and the project size, to prevent crashes and performance issues.

- **Usage Example:** Adding a dynamic tilt effect to a clip by animating the shear angles.
- **Tip:** Use shear properties for creating slanted or skewed animations.
Expand Down
Binary file added doc/images/themes.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/timeline.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 32 additions & 7 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,24 +90,49 @@ and creating a launcher for it, see our

.. image:: images/linux-appimage-permissions.jpg

Unable to Launch AppImage?
~~~~~~~~~~~~~~~~~~~~~~~~~~
Please verify that the ``libfuse2`` library is installed, which is required to mount and read an AppImage.
On newer versions of Ubuntu (i.e. 22.04+), ``libfuse2`` is not installed by default. You can install it with
the following command:

.. code-block:: console
sudo apt install libfuse2
Install AppImage Launcher
~~~~~~~~~~~~~~~~~~~~~~~~~
If you plan on using OpenShot often, you will probably want an integrated launcher for our AppImage.
We recommend using AppImageLauncher, which is the officially supported way to launch (and manage) AppImage files on
your Linux desktop. If you are on a Debian-based distro (Ubuntu, Mint, etc...), there is an official
AppImageLauncher PPA:

.. code-block:: console
sudo add-apt-repository ppa:appimagelauncher-team/stable
sudo apt update
sudo apt install appimagelauncher
Linux (PPA)
^^^^^^^^^^^

For Debian-based Linux distributions (Ubuntu, Mint, etc...), we also have a PPA
(Personal Package Archive), which adds our official OpenShot software repository to your package
manager, making it possible to install our latest version, without relying on our AppImages.

.. code-block:: console
Stable PPA (Contains only official releases)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:caption: Stable PPA (Contains only official releases)
.. code-block:: console
sudo add-apt-repository ppa:openshot.developers/ppa
sudo apt update
sudo apt install openshot-qt python3-openshot
.. code-block:: console
Daily PPA (Highly experimental and unstable, for testers)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

:caption: Daily PPA (Highly experimental and unstable, for testers)
.. code-block:: console
sudo add-apt-repository ppa:openshot.developers/libopenshot-daily
sudo apt update
Expand Down Expand Up @@ -136,21 +161,21 @@ projects first (\*.osp files). Please see :ref:`preferences_reset_ref` for instr
the previous ``openshot.settings`` file (for a clean install with **default preferences**).

Windows
-------
~~~~~~~

#. Open **Control Panel** from the Start menu
#. Click on **Programs and Features**
#. Select OpenShot Video Editor, then click **Uninstall**

Mac
---
~~~

#. Open **Finder** and go to **Applications**
#. Drag the OpenShot Video Editor icon to the **Trash** in the Dock
#. Right-click **Trash** and choose **Empty Trash**

Ubuntu (Linux)
--------------
~~~~~~~~~~~~~~

#. Open up **Files**
#. Locate the ``*.AppImage`` and delete the file
Expand Down
1 change: 1 addition & 0 deletions doc/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Features
- **JSON project format** (`OpenShot Cloud API <https://www.openshot.org/cloud-api/>`_ compatible)
- **Customizable shortcuts**
- **Translations** (100+ languages)
- **High DPI** monitor support
- **Community support** (`Visit our forum <https://openshot.org/forum/>`_)

Screenshot
Expand Down
47 changes: 46 additions & 1 deletion doc/main_window.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,8 @@ For example, imagine a 3 track video project
Timeline Toolbar
----------------

.. image:: images/timeline.jpg

.. table::
:widths: 20 73

Expand Down Expand Up @@ -124,7 +126,7 @@ Shortcut Action
:kbd:`Ctrl+B` Animated Title
:kbd:`Ctrl+Up` Center on Playhead
:kbd:`Ctrl+P` Choose Profile
:kbd:`Ctrl+Shift+ESC` Clear All Cache
:kbd:`Ctrl+Shift+ESC` Clear All Cache (regenerate video preview)
:kbd:`Ctrl+C` Copy
:kbd:`Delete` Delete Item
:kbd:`Backspace` Delete Item (Alternate 1)
Expand Down Expand Up @@ -279,3 +281,46 @@ exit the program. Re-launching OpenShot will restore your custom dock layout aut
If you have accidentally closed or moved a dock and can no longer find it, there are a couple easy solutions.
First, you can use the :guilabel:`View->Views->Simple View` menu option at the top of the screen, to restore the view back to its
default. Or you can use the :guilabel:`View->Views->Docks->...` menu to show or hide specific dock widgets on the main window.

High DPI / 4K Monitors
----------------------

OpenShot Video Editor provides robust support for High DPI (Dots Per Inch) monitors, ensuring that the interface looks
sharp and is easily readable on displays with various DPI settings. This support is particularly beneficial for users
with 4K monitors or other high-resolution displays.

Per Monitor DPI Awareness
^^^^^^^^^^^^^^^^^^^^^^^^^

OpenShot is DPI aware on a per-monitor basis, meaning it can adjust its scaling dynamically depending on the DPI
settings of each connected monitor. This ensures a consistent and high-quality user experience across different displays.

DPI Scaling on Windows
^^^^^^^^^^^^^^^^^^^^^^

On Windows, OpenShot rounds the scaling factor to the nearest whole value to maintain visual integrity. This rounding
helps avoid visual artifacts in the UI rendering and ensures that the interface elements remain crisp and well-aligned.
Due to this rounding, scaling options can sometimes lead to increased font-sizes and a feeling that the UI elements
are a bit too large.

- **125% scaling** rounds to **100%**
- **150% scaling** rounds to **200%**

Workarounds for Fine-Grained Adjustment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

While rounding helps maintain a clean interface, there are workarounds for users who require more precise control
over the scaling. However, these methods are **not recommended** due to potential visual artifacts:

- **QT_SCALE_FACTOR_ROUNDING_POLICY=PassThrough**

- Setting this environment variable can disable rounding and allow more precise scaling.
- **Note:** This may cause visual artifacts, particularly in the timeline, and is not recommended.

- **QT_SCALE_FACTOR=0.75** (or similar value)

- Manually setting the scale factor can provide finer adjustments to the font and UI scaling.
- **Note:** This method can also lead to visual artifacts and make OpenShot harder to use.

For more info on adjusting these environment variables, please visit
https://github.com/OpenShot/openshot-qt/wiki/OpenShot-UI-too-large.
16 changes: 13 additions & 3 deletions doc/preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,21 @@ The General tab of the Preferences window allows you to modify the settings that
Default Theme Humanity:Dark Choose your theme for OpenShot, either Light, Dark or None
Image Length (seconds) 10.00 How long the image displays on the screen when added to the timeline
Volume 75.00 The percentage of the volume of the clip when added to the timeline
Blender Command (path) *<blank>* The path to the binary for Blender (version 2.8+)
Blender Command (path) *<blank>* The path to the binary for Blender (version 4.1+)
Advanced Title Editor (path) *<blank>* The path to the binary for Inkscape
Show Export Dialog when Finished *<checked>* Displays the Export Video windows after the export is finished
================================ ============= ===========

Themes
""""""
OpenShot comes with 3 standard themes, which change the look and feel of the program.

- **Retro:** A light theme that offers a classic and clean appearance. This theme uses light gray and white tones, making it ideal for users who prefer a bright and high-contrast interface. It provides a traditional look that is easy on the eyes, especially in well-lit environments.
- **Humanity Dark:** [Default Theme] A dark theme with dark gray tones, providing a modern and sleek look. This theme is designed for users who prefer working in low-light conditions or who enjoy a more subdued and professional appearance. The dark gray background reduces glare and eye strain, making it suitable for extended editing sessions.
- **Cosmic Dusk:** A bluish theme with a more modern UI design, enhancing the visual aesthetics of the editor. This theme features shades of blue and purple, giving the interface a contemporary and dynamic feel. It combines modern aesthetics with functionality, offering a fresh and visually appealing workspace for video editing.

.. image:: images/themes.jpg

.. _preferences_preview_ref:

Preview
Expand Down Expand Up @@ -87,7 +97,7 @@ a specific number of minutes, helping to reduce the risk or impact of data loss
or user error.

Recovery
^^^^^^^^
""""""""

Before each save, a copy of the current project is created in a recovery folder, to further
reduce the risk of data loss. The recovery folder is located at ``~/.openshot_qt/recovery/`` or
Expand Down Expand Up @@ -152,7 +162,7 @@ NOTE: On systems with older graphics cards, hardware acceleration may not always
Advices is N(cores-1) or N(Threads-1) ?
Hardware Decoder max width/height Can be found where? Link to HW manufacturers?
Use Blender GPU rendering: Default = on?
(May be default in Blender 2.8? -
(May be default in Blender 4.1? -
May work backfire if system has multiple GPUs and high-end GPU recognizes Blender automatically)
Keyboard
Expand Down
2 changes: 1 addition & 1 deletion doc/titles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Installing Blender
The :guilabel:`Animated Title` feature in OpenShot requires the latest version of
Blender (https://www.blender.org/download/) be installed and the OpenShot **Preferences** updated
with the correct path to the Blender executable. See the :ref:`preferences_general_ref` tab
in Preferences. NOTE: The minimum supported version of Blender is 2.8+. Older versions of Blender are
in Preferences. NOTE: The minimum supported version of Blender is 4.1+. Older versions of Blender are
not compatible with OpenShot Video Editor.

For a detailed guide on how to install these dependencies, see
Expand Down
2 changes: 1 addition & 1 deletion src/classes/info.py
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
DESKTOP_ID = "org.openshot.OpenShot.desktop"

# Blender minimum version required (a string value)
BLENDER_MIN_VERSION = "2.80"
BLENDER_MIN_VERSION = "4.1"

# Data-model debugging enabler
MODEL_TEST = False
Expand Down

0 comments on commit d96a914

Please sign in to comment.