From 7520cfc32f6b095944ca4b96f088c8829c5fc742 Mon Sep 17 00:00:00 2001 From: Sebastian Spaeth Date: Mon, 8 Jun 2020 09:06:28 +0200 Subject: [PATCH] Improve Documentation This is a smallish attempt to improve openshot's sparse documentation (issue #2989). The getting started page only contains an installation description, so name it so. Improve the quick tutorial somewhat (at least according to my taste) but still keep it quick. Improve the start of the "Files" pages somewhat. Make the import files table more consistent by nameing the method in the first column and actually describing them in a full senctence (interpunction) in the 2nd column. Add the actual toolbar button icon image to the table. Similar things for the slice clips table on the clips page. --- doc/clips.rst | 30 ++++++++++++++-------- doc/files.rst | 46 +++++++++++++++++++++++++-------- doc/getting_started.rst | 45 --------------------------------- doc/index.rst | 2 +- doc/installation.rst | 56 +++++++++++++++++++++++++++++++++++++++++ doc/main_window.rst | 1 + doc/quick_tutorial.rst | 43 +++++++++++++++++++------------ 7 files changed, 139 insertions(+), 84 deletions(-) delete mode 100644 doc/getting_started.rst create mode 100644 doc/installation.rst diff --git a/doc/clips.rst b/doc/clips.rst index 1d06ac520d..b3f3d687c6 100644 --- a/doc/clips.rst +++ b/doc/clips.rst @@ -43,25 +43,33 @@ Overview 3 Clip 2 An image clip == ================== ============ +.. _clips_cutting_slicing_ref: + Cutting & Slicing ----------------- OpenShot has many easy ways to adjust the start and end positions of a clip (otherwise known as cutting). The most common method is simply grabbing the left (or right) edge of the clip and dragging. Here is a list of methods for cutting clips in OpenShot: +.. |razortool_icon| image:: ../src/images/Humanity/actions/16/edit-cut.svg + .. table:: :widths: 30 - ================== ============ - Name Description - ================== ============ - Slice When the play-head (i.e. red playback line) is overlapping a clip, right click on the clip, and choose Slice - Slice All When the play-head is overlapping many clips, right click on the play-head, and choose Slice All (it will cut all intersecting clips) - Resizing Edge Mouse over the edge of a clip, and resize the edge - Split Dialog Right click on a file, and choose **Split Clip**. A dialog will appear which allows for creating lots of small cuts in a single video file. - Razor Tool The razor tool cuts a clip wherever you click, so be careful. Easy and dangerous. - ================== ============ - -Keep in mind that all of the above cutting methods also have :ref:`keyboard_shortcut_ref`, to save even more time. + ====================== ============ + Name Description + ====================== ============ + **Slice** When the play-head (i.e. vertical red playback line) is overlapping a clip, right click on the clip, + and choose :guilabel:`Slice`. + **Slice All** When the play-head is overlapping many clips, right click on the play-head, and choose + :guilabel:`Slice All` (it will cut all intersecting clips on all tracks). + **Resizing Edge** Mouse over the edge of a clip, and resize the edge. + **Split Dialog** Right click on a file, and choose :guilabel:`Split Clip`. A dialog will appear which allows + for creating lots of small cuts in a single video file. + **Razor Tool** The razor tool |razortool_icon| from the **Edit Toolbar** cuts a clip wherever you click on it. + So be careful, it is easy and dangerous! + ====================== ============ + +Keep in mind that the above cutting methods also have :ref:`keyboard_shortcut_ref`, to save even more time. .. _clip_presets_ref: diff --git a/doc/files.rst b/doc/files.rst index 387c1f9766..514cc74e72 100644 --- a/doc/files.rst +++ b/doc/files.rst @@ -20,27 +20,42 @@ Files ===== -Before we can begin making a video, we need to import files into OpenShot. Most media file types are -recognized, such as videos, images, and audio files. Files can be viewed and managed in the **Project Files** panel. +To create a video, we need to make media files available to our project by importing files +into OpenShot. Most media file types are recognized, such as videos, images, and audio files. +Files can be viewed and managed in the **Project Files** panel. + +Note that imported files are not copied anywhere, they remain in the physical location they +were before and are simply being made available to your video project. So, they must not be +deleted or moved after adding them to your project. The "Show All", "Video", "Audio", +"Image" filters above the files allows you to only see the file types you are interested in. You can also toggle the view between details and thumbnails view of your files. + + +.. _import_files_ref: Import Files ------------ -There are many ways to import media files into OpenShot. +These are all possible methods to import media files into OpenShot: + +.. |importfiles_icon| image:: ../src/images/Humanity/actions/16/list-add.svg .. table:: :widths: 25 - ==================== ============ - Name Description - ==================== ============ - Drag and Drop Drag and drop the files from your file manager (file explorer, finder, etc...) - Right Click\→Import Right click in the **Project Files** panel, choose **Import Files...** - File Menu\→Import File menu\→Import Files... - Import Files Toolbar Click the **Import Files...** toolbar button (on the top menu) - ==================== ============ + =========================== ============ + Name Description + =========================== ============ + Drag and Drop Drag and drop the files from your file manager (file explorer, finder, etc...). + Context menu (`File Menu`_) Right click anywhere in the **Project Files** panel and choose :guilabel:`Import Files`. + Main Menu In the main menu choose: :guilabel:`File\→Import Files`. + Toolbar button Click the |importfiles_icon| toolbar button in the main toolbar. + Keyboard shortcut Press :kbd:`Ctrl-F` (:kbd:`Cmd-F` on Mac). + =========================== ============ + + .. image:: images/quick-start-drop-files.jpg + File Menu --------- To view the file menu, right click on a file (in the **Project Files** panel). Here are the actions you can use from the @@ -83,6 +98,8 @@ to repeat the steps for your next clip. When you are finished, simply close the 4 Create Clip Create the clip (which resets this dialog, so you can repeat these steps for each clip) == ================== ============ +Please refer to the section :ref:`clips_cutting_slicing_ref` for more ways to cut and slice clips directly in the timeline. + Add to Timeline --------------- In certain cases, you might need to add many files to the timeline at the same time. For example, a photo slide show, @@ -123,3 +140,10 @@ This will launch the file properties dialog, which displays information about yo 2 Frame Rate For image sequences, you can also adjust the frame rate of the animation == ==================== ============ + +.. _file_remove_ref: + +Remove from Project +------------------- + +This will remove a file from the project. It will not delete the underlying physical file though, so removing a file from the project merely makes it unavailable for this video project. diff --git a/doc/getting_started.rst b/doc/getting_started.rst deleted file mode 100644 index 1324eea617..0000000000 --- a/doc/getting_started.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. Copyright (c) 2008-2016 OpenShot Studios, LLC - (http://www.openshotstudios.com). This file is part of - OpenShot Video Editor (http://www.openshot.org), an open-source project - dedicated to delivering high quality video editing and animation solutions - to the world. - -.. OpenShot Video Editor is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - -.. OpenShot Video Editor is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - -.. You should have received a copy of the GNU General Public License - along with OpenShot Library. If not, see . - -Getting Started -=============== - -OpenShot Video Editor is available on most operating systems (including Linux, Mac, and Windows). -Visit the official download page and grab the latest and greatest version: -https://www.openshot.org/download/. - -Linux ------ -Depending on which Linux distribution you use, there are likely many ways to install OpenShot. The -easiest way to ensure you have the very latest version, is to download an AppImage from the -project website (listed above). Once downloaded, right click on the AppImage file, choose -Properties, and mark the file as **Executable**. Now, go ahead and double click the -AppImage to launch it. - -Mac ---- -Download the DMG file from the project website (listed above), double click it, and then drag -the OpenShot application icon into your **Applications** shortcut. This is very similar to how most -other Mac applications are installed. Now launch OpenShot from Launchpad. - -Windows -------- -Download the Windows installer executable from the project website (listed above), double click it, -and follow the directions on screen. Once completed, OpenShot will be installed and available -in your Start menu. diff --git a/doc/index.rst b/doc/index.rst index f22393fa42..3d12629aa7 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,7 +34,7 @@ Table of Contents: :maxdepth: 2 introduction - getting_started + installation quick_tutorial main_window files diff --git a/doc/installation.rst b/doc/installation.rst new file mode 100644 index 0000000000..d3c14b6ac5 --- /dev/null +++ b/doc/installation.rst @@ -0,0 +1,56 @@ +.. Copyright (c) 2008-2016 OpenShot Studios, LLC + (http://www.openshotstudios.com). This file is part of + OpenShot Video Editor (http://www.openshot.org), an open-source project + dedicated to delivering high quality video editing and animation solutions + to the world. + +.. OpenShot Video Editor is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + +.. OpenShot Video Editor is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + +.. You should have received a copy of the GNU General Public License + along with OpenShot Library. If not, see . + + +Installation +============ + +The latest and greatest version of OpenShot Video Editor for Linux, +Mac, and Windows can be downloaded fromm the official download page at +https://www.openshot.org/download/. + +Linux +^^^^^ + +Most Linux distributions have a version of OpenShot in their software +repositories, so installation should be easy. Some might have an +outdated version though (make sure to check the version number). The +easiest way to ensure you have the very latest version, is to download +an AppImage from the `project website +`_. Once downloaded, right click on +the AppImage file, choose Properties, and mark the file as +**Executable**. Now, go ahead and double click the AppImage to launch +it. + +Mac +^^^ + +Download the DMG file from the `project website +`_, double click it, and then drag +the OpenShot application icon into your **Applications** +shortcut. This is very similar to how most other Mac applications are +installed. Now launch OpenShot from Launchpad. + +Windows +^^^^^^^ + +Download the Windows installer executable from the `project website +`_, double click it, and follow the +directions on screen. Once completed, OpenShot will be installed and +available in your Start menu. diff --git a/doc/main_window.rst b/doc/main_window.rst index 0850b586f3..28e9f97718 100644 --- a/doc/main_window.rst +++ b/doc/main_window.rst @@ -55,6 +55,7 @@ the basics. Clicking **Next** will jump to the next topic. You can always view t .. image:: images/built-in-tutorial.jpg +.. _tracks_ref: Tracks & Layers ------------------ diff --git a/doc/quick_tutorial.rst b/doc/quick_tutorial.rst index 0141b46f71..0cf1adc87b 100644 --- a/doc/quick_tutorial.rst +++ b/doc/quick_tutorial.rst @@ -26,35 +26,45 @@ Using OpenShot is very easy, and this tutorial will take you through the basics **under 5 minutes**. After this tutorial, you will be able to make a simple photo slide-show with music. -Step 1 – Import Photos & Music ------------------------------- -Before we can begin making a video, we need to import files into OpenShot. Drag and -drop a few images (\*.JPG, \*.PNG, etc...) and a music file (most formats will work) -from your Desktop to OpenShot. Be sure to drop the files where the +Step 1 – Import media files +--------------------------- + +Before we can begin making a video, we need to import media files into OpenShot. Most video, +image and music file formats will work. Drag and drop a few videos or images and a music file +(most formats will work) from your Desktop to OpenShot. Be sure to drop the files where the arrow in the illustration is pointing to. .. image:: images/quick-start-drop-files.jpg -Step 2 – Arrange Photos on Timeline ------------------------------------- -Next, drag each photo onto the timeline (as seen in the illustration). The timeline represents -your final video, so arrange your photos in whatever sequence you want them to appear in your -video. If you overlap two clips, OpenShot will automatically create a smooth fade between them, -displayed by blue rounded rectangles between the clips. Remember, you can rearrange the clips -as many times as needed by simply dragging and dropping them. +Alternative methods to add files to your projects are described in the section +:ref:`import_files_ref`. +The "Show All", "Video", "Audio", "Image" filters above the added files +allows you to only see the file types you are interested in. + +Step 2 – Arrange Videos and Photos on Timeline +---------------------------------------------- + +Next, drag each video or photo onto a track in the timeline (as seen in the illustration). +The timeline represents your final video, so arrange your photos in whatever sequence you want +them to appear in your video. If you overlap two clips, OpenShot will automatically create a +smooth fade between them, displayed by blue rounded rectangles between the clips. Remember, +you can rearrange the clips as many times as needed by simply dragging and dropping them. .. image:: images/quick-start-timeline-drop.jpg Step 3 – Add Music to Timeline ------------------------------ -To make our photo slide-show more interesting, we need to add some music. You should have -imported a music file in step 1. Click on the music file, and drag it onto the timeline. If -the song is too long, grab the right edge of your music clip, and resize it smaller. + +To make our creation more interesting, we need to add some music. Click on the music +file that you imported in step 1, and drag it onto the timeline. If the song is too long, grab +the right edge of your music clip, and resize it smaller (that will make it end earlier). You +could also insert the same file multiple times, if your music is too short. .. image:: images/quick-start-music.jpg Step 4 – Preview your Project ------------------------------ + To preview what our video looks & sounds like, click the Play button under the preview window. You can also pause, rewind, and fast-forward your video project by clicking the corresponding buttons. @@ -63,7 +73,8 @@ buttons. Step 5 – Export your Video --------------------------- -Once you are happy with your photo slide-show video, the next step is to export your video. + +Once you are happy with your video, the next step is to export your video. This will convert your OpenShot project into a single video file, which will work on most media players (such as VLC) or websites (such as YouTube, Vimeo, etc...).