Skip to content

Commit

Permalink
Adding "Choose Profile" context menu, Profile Editor (Duplicate/Edit/…
Browse files Browse the repository at this point in the history
…Delete) options - to the user guide documentation.
  • Loading branch information
jonoomph committed Oct 10, 2024
1 parent afefac5 commit 2845489
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 4 deletions.
1 change: 1 addition & 0 deletions doc/files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Split File Split a file into many smaller files. The new trimmed file
Edit Title Edit an existing title SVG file
Duplicate Title Make a copy, and then edit the copied title SVG file
Add to Timeline Add many files to the timeline in one step, including transitions or alternating tracks.
Choose Profile Change the current project profile to match the selected file. If the file's profile does not match a known profile, it will give you the option to create a custom profile.
File Properties View the properties of a file, such as frame rate, size, etc...
Remove from Project Remove a file from the project
==================== ============
Expand Down
Binary file added doc/images/profiles-editor.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 34 additions & 2 deletions doc/profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,37 @@ Choose Profile Dialog
2 Selected Profile Click on the desired profile, and then the :guilabel:`OK` button. You can also double click a profile to select it.
3 Filtered Count Count of filtered profiles
4 Accept Profile Click the :guilabel:`OK` button to switch to the selected profile.
5 Context Menu Right click on any row to :guilabel:`Duplicate`, :guilabel:`Edit`, or :guilabel:`Delete` profiles. Note: Only custom, duplicated profiles can be edited or deleted.
== ================== ============

.. _profiles_editor_ref:

Edit/Duplicate Profile
----------------------
Right-click on any profile in OpenShot and choose :guilabel:`Duplicate` or :guilabel:`Edit` to open up the **Profile Editor**.
This screen allows you to duplicate existing built-in profiles or edit any custom profiles. You can edit the description,
resolution, frame rate, aspect ratio, and pixel ratio.

The custom profiles are saved in the ``~/.openshot_qt/profiles/`` or ``C:\Users\USERNAME\.openshot_qt\profiles`` folder.

.. image:: images/profiles-editor.jpg

.. table::
:widths: 5 28 80

== =================== ===================================================================
# Name Description
== =================== ===================================================================
1 **File Path** The location on your system where the custom profile is saved.
2 **Description** A text description for your custom profile, which is displayed in OpenShot.
3 **Width** The horizontal resolution (in pixels) of the video.
4 **Height** The vertical resolution (in pixels) of the video.
5 **Frame Rate** The frame rate of the video (frames per second).
6 **Aspect Ratio** The display aspect ratio of the video (automatically calculated from width/height and pixel ratio.
7 **Pixel Ratio** The aspect ratio of each pixel in the video. A ratio of 1:1 means square pixels (default).
8 **Interlaced** Whether the video is interlaced (Yes) or progressive (No).
== =================== ===================================================================

Converting Profiles
-------------------
When switching profiles (or exporting to a different profile), OpenShot will do it's best to convert all clip,
Expand Down Expand Up @@ -92,8 +121,11 @@ Custom Profile
--------------
Although OpenShot has more than 400 profiles (:ref:`profile_list_ref`) included by default, you can also create
your own custom profiles. Create a new text file in the ``~/.openshot_qt/profiles/`` or
``C:\Users\USERNAME\.openshot_qt\profiles`` folder. Use the following text as your template (i.e. copy and
paste this into the new file):
``C:\Users\USERNAME\.openshot_qt\profiles`` folder.

NOTE: See :ref:`profiles_editor_ref` for an alternative method of duplicating an existing profile.

Use the following text as your template (*i.e. copy and paste this into the new file*):

.. code-block:: python
Expand Down
4 changes: 2 additions & 2 deletions src/windows/profile_edit.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ def initialize(self):

# Update windows title
if self.duplicate:
self.setWindowTitle(_('Duplicate Profile'))
else:
self.setWindowTitle(_('Create Profile'))
else:
self.setWindowTitle(_('Edit Profile'))

# Add options to cboInterlaced dropdown
self.cboInterlaced.addItem(_('Yes'))
Expand Down

0 comments on commit 2845489

Please sign in to comment.