Skip to content

Commit 8c3d90c

Browse files
authored
Merge pull request #3550 from spaetz/develop
Improve Documentation (issue 2989)
2 parents e27625e + 241a7c5 commit 8c3d90c

7 files changed

+138
-83
lines changed

doc/clips.rst

+19-11
Original file line numberDiff line numberDiff line change
@@ -43,25 +43,33 @@ Overview
4343
3 Clip 2 An image clip
4444
== ================== ============
4545

46+
.. _clips_cutting_slicing_ref:
47+
4648
Cutting & Slicing
4749
-----------------
4850
OpenShot has many easy ways to adjust the start and end positions of a clip (otherwise known as cutting). The most common
4951
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:
5052

53+
.. |razortool_icon| image:: ../images/Humanity/actions/16/edit-cut.svg
54+
5155
.. table::
5256
:widths: 30
5357

54-
================== ============
55-
Name Description
56-
================== ============
57-
Slice When the play-head (i.e. red playback line) is overlapping a clip, right click on the clip, and choose Slice
58-
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)
59-
Resizing Edge Mouse over the edge of a clip, and resize the edge
60-
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.
61-
Razor Tool The razor tool cuts a clip wherever you click, so be careful. Easy and dangerous.
62-
================== ============
63-
64-
Keep in mind that all of the above cutting methods also have :ref:`keyboard_shortcut_ref`, to save even more time.
58+
====================== ============
59+
Name Description
60+
====================== ============
61+
**Slice** When the play-head (i.e. vertical red playback line) is overlapping a clip, right click on the clip,
62+
and choose :guilabel:`Slice`.
63+
**Slice All** When the play-head is overlapping many clips, right click on the play-head, and choose
64+
:guilabel:`Slice All` (it will cut all intersecting clips on all tracks).
65+
**Resizing Edge** Mouse over the edge of a clip, and resize the edge.
66+
**Split Dialog** Right click on a file, and choose :guilabel:`Split Clip`. A dialog will appear which allows
67+
for creating lots of small cuts in a single video file.
68+
**Razor Tool** The razor tool |razortool_icon| from the **Edit Toolbar** cuts a clip wherever you click on it.
69+
So be careful, it is easy and dangerous!
70+
====================== ============
71+
72+
Keep in mind that the above cutting methods also have :ref:`keyboard_shortcut_ref`, to save even more time.
6573

6674
.. _clip_presets_ref:
6775

doc/files.rst

+35-11
Original file line numberDiff line numberDiff line change
@@ -20,27 +20,42 @@
2020
Files
2121
=====
2222

23-
Before we can begin making a video, we need to import files into OpenShot. Most media file types are
24-
recognized, such as videos, images, and audio files. Files can be viewed and managed in the **Project Files** panel.
23+
To create a video, we need to make media files available to our project by importing files
24+
into OpenShot. Most media file types are recognized, such as videos, images, and audio files.
25+
Files can be viewed and managed in the **Project Files** panel.
26+
27+
Note that imported files are not copied anywhere, they remain in the physical location they
28+
were before and are simply being made available to your video project. So, they must not be
29+
deleted or moved after adding them to your project. The "Show All", "Video", "Audio",
30+
"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.
31+
32+
33+
.. _import_files_ref:
2534

2635
Import Files
2736
------------
28-
There are many ways to import media files into OpenShot.
37+
These are all possible methods to import media files into OpenShot:
38+
39+
.. |importfiles_icon| image:: ../images/Humanity/actions/16/list-add.svg
2940

3041
.. table::
3142
:widths: 25
3243

33-
==================== ============
34-
Name Description
35-
==================== ============
36-
Drag and Drop Drag and drop the files from your file manager (file explorer, finder, etc...)
37-
Right Click\→Import Right click in the **Project Files** panel, choose **Import Files...**
38-
File Menu\→Import File menu\→Import Files...
39-
Import Files Toolbar Click the **Import Files...** toolbar button (on the top menu)
40-
==================== ============
44+
=========================== ============
45+
Name Description
46+
=========================== ============
47+
Drag and Drop Drag and drop the files from your file manager (file explorer, finder, etc...).
48+
Context menu (`File Menu`_) Right click anywhere in the **Project Files** panel and choose :guilabel:`Import Files`.
49+
Main Menu In the main menu choose: :guilabel:`File\→Import Files`.
50+
Toolbar button Click the |importfiles_icon| toolbar button in the main toolbar.
51+
Keyboard shortcut Press :kbd:`Ctrl-F` (:kbd:`Cmd-F` on Mac).
52+
=========================== ============
53+
54+
4155

4256
.. image:: images/quick-start-drop-files.jpg
4357

58+
4459
File Menu
4560
---------
4661
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
8398
4 Create Clip Create the clip (which resets this dialog, so you can repeat these steps for each clip)
8499
== ================== ============
85100

101+
Please refer to the section :ref:`clips_cutting_slicing_ref` for more ways to cut and slice clips directly in the timeline.
102+
86103
Add to Timeline
87104
---------------
88105
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
123140
2 Frame Rate For image sequences, you can also adjust the frame rate of the animation
124141
== ==================== ============
125142

143+
144+
.. _file_remove_ref:
145+
146+
Remove from Project
147+
-------------------
148+
149+
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.

doc/getting_started.rst

-45
This file was deleted.

doc/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Table of Contents:
3434
:maxdepth: 2
3535

3636
introduction
37-
getting_started
37+
installation
3838
quick_tutorial
3939
main_window
4040
files

doc/installation.rst

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. Copyright (c) 2008-2020 OpenShot Studios, LLC
2+
(http://www.openshotstudios.com). This file is part of
3+
OpenShot Video Editor (http://www.openshot.org), an open-source project
4+
dedicated to delivering high quality video editing and animation solutions
5+
to the world.
6+
7+
.. OpenShot Video Editor is free software: you can redistribute it and/or modify
8+
it under the terms of the GNU General Public License as published by
9+
the Free Software Foundation, either version 3 of the License, or
10+
(at your option) any later version.
11+
12+
.. OpenShot Video Editor is distributed in the hope that it will be useful,
13+
but WITHOUT ANY WARRANTY; without even the implied warranty of
14+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15+
GNU General Public License for more details.
16+
17+
.. You should have received a copy of the GNU General Public License
18+
along with OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
19+
20+
21+
Installation
22+
============
23+
24+
The latest and greatest version of OpenShot Video Editor for Linux,
25+
Mac, and Windows can be downloaded fromm the official download page at
26+
https://www.openshot.org/download/.
27+
28+
Linux
29+
^^^^^
30+
31+
Most Linux distributions have a version of OpenShot in their software
32+
repositories, so installation should be easy. Some might have an
33+
outdated version though (make sure to check the version number). The
34+
easiest way to ensure you have the very latest version, is to download
35+
an AppImage from the `project website
36+
<https://www.openshot.org/download/>`_. Once downloaded, right click on
37+
the AppImage file, choose Properties, and mark the file as
38+
**Executable**. Now, go ahead and double click the AppImage to launch
39+
it.
40+
41+
Mac
42+
^^^
43+
44+
Download the DMG file from the `project website
45+
<https://www.openshot.org/download/>`_, double click it, and then drag
46+
the OpenShot application icon into your **Applications**
47+
shortcut. This is very similar to how most other Mac applications are
48+
installed. Now launch OpenShot from Launchpad.
49+
50+
Windows
51+
^^^^^^^
52+
53+
Download the Windows installer executable from the `project website
54+
<https://www.openshot.org/download/>`_, double click it, and follow the
55+
directions on screen. Once completed, OpenShot will be installed and
56+
available in your Start menu.

doc/main_window.rst

+1
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ the basics. Clicking **Next** will jump to the next topic. You can always view t
5555

5656
.. image:: images/built-in-tutorial.jpg
5757

58+
.. _tracks_ref:
5859

5960
Tracks & Layers
6061
------------------

doc/quick_tutorial.rst

+26-15
Original file line numberDiff line numberDiff line change
@@ -26,35 +26,45 @@ Using OpenShot is very easy, and this tutorial will take you through the basics
2626
**under 5 minutes**. After this tutorial, you will be able to make a simple photo
2727
slide-show with music.
2828

29-
Step 1 – Import Photos & Music
30-
------------------------------
31-
Before we can begin making a video, we need to import files into OpenShot. Drag and
32-
drop a few images (\*.JPG, \*.PNG, etc...) and a music file (most formats will work)
29+
Step 1 – Import media files
30+
---------------------------
31+
32+
Before we can begin making a video, we need to import media files into OpenShot. Most video,
33+
image and music file formats will work. Drag and drop a few videos or images and a music file
3334
from your Desktop to OpenShot. Be sure to drop the files where the
3435
arrow in the illustration is pointing to.
3536

3637
.. image:: images/quick-start-drop-files.jpg
3738

38-
Step 2 – Arrange Photos on Timeline
39-
------------------------------------
40-
Next, drag each photo onto the timeline (as seen in the illustration). The timeline represents
41-
your final video, so arrange your photos in whatever sequence you want them to appear in your
42-
video. If you overlap two clips, OpenShot will automatically create a smooth fade between them,
43-
displayed by blue rounded rectangles between the clips. Remember, you can rearrange the clips
44-
as many times as needed by simply dragging and dropping them.
39+
Alternative methods to add files to your projects are described in the section
40+
:ref:`import_files_ref`.
41+
The "Show All", "Video", "Audio", "Image" filters above the added files
42+
allows you to only see the file types you are interested in.
43+
44+
Step 2 – Arrange Videos and Photos on Timeline
45+
----------------------------------------------
46+
47+
Next, drag each video or photo onto a track in the timeline (as seen in the illustration).
48+
The timeline represents your final video, so arrange your photos in whatever sequence you want
49+
them to appear in your video. If you overlap two clips, OpenShot will automatically create a
50+
smooth fade between them, displayed by blue rounded rectangles between the clips. Remember,
51+
you can rearrange the clips as many times as needed by simply dragging and dropping them.
4552

4653
.. image:: images/quick-start-timeline-drop.jpg
4754

4855
Step 3 – Add Music to Timeline
4956
------------------------------
50-
To make our photo slide-show more interesting, we need to add some music. You should have
51-
imported a music file in step 1. Click on the music file, and drag it onto the timeline. If
52-
the song is too long, grab the right edge of your music clip, and resize it smaller.
57+
58+
To make our creation more interesting, we need to add some music. Click on the music
59+
file that you imported in step 1, and drag it onto the timeline. If the song is too long, grab
60+
the right edge of your music clip, and resize it smaller (that will make it end earlier). You
61+
could also insert the same file multiple times, if your music is too short.
5362

5463
.. image:: images/quick-start-music.jpg
5564

5665
Step 4 – Preview your Project
5766
------------------------------
67+
5868
To preview what our video looks & sounds like, click the Play button under the preview window.
5969
You can also pause, rewind, and fast-forward your video project by clicking the corresponding
6070
buttons.
@@ -63,7 +73,8 @@ buttons.
6373

6474
Step 5 – Export your Video
6575
---------------------------
66-
Once you are happy with your photo slide-show video, the next step is to export your video.
76+
77+
Once you are happy with your project, the next step is to export your video.
6778
This will convert your OpenShot project into a single video file, which will work on most
6879
media players (such as VLC) or websites (such as YouTube, Vimeo, etc...).
6980

0 commit comments

Comments
 (0)