From 6b53490d767d91cfea98257cf6ab61a914552bda Mon Sep 17 00:00:00 2001 From: Bradley Sepos Date: Wed, 18 May 2016 18:59:03 -0400 Subject: [PATCH] doc: Add and update some system specific sections. --- .../get-handbrake/check-for-updates.markdown | 26 +++-- .../where-to-get-handbrake.markdown | 8 ++ .../latest/introduction/quick-start.markdown | 70 ++++++++++++++ .../latest/workflow/adjust-quality.markdown | 14 +++ .../workflow/open-video-source.markdown | 46 ++++++++- .../latest/workflow/preview-settings.markdown | 96 ++++++++++++++++++- .../en/latest/workflow/select-preset.markdown | 18 +++- .../latest/workflow/start-encoding.markdown | 42 ++++++++ 8 files changed, 307 insertions(+), 13 deletions(-) diff --git a/source/en/latest/get-handbrake/check-for-updates.markdown b/source/en/latest/get-handbrake/check-for-updates.markdown index d75b8dc6..b7a10396 100644 --- a/source/en/latest/get-handbrake/check-for-updates.markdown +++ b/source/en/latest/get-handbrake/check-for-updates.markdown @@ -20,25 +20,35 @@ HandBrake can let you know when a newer version is available, and even automatic Before updating, make sure there are no pending encodes in the `Queue` and make note of any custom presets you have created, as they may not be compatible with the newer version. -#### Mac + + +## Updating HandBrake on Linux + +The Linux version of HandBrake does not have a built-in update checking feature. Your Linux distribution's package manager will handle any updates to the official PPA. + + + + +## Updating HandBrake on Mac From the main menu, navigate to `HandBrake` and select `Check for Updates...`. ![Check for Updates menu item](../images/mac/check-for-updates-menu-item.png) -If an update is available, you will be given the opportunity to install it right away. To enable automatic updates, select the appropriate checkbox labeled `Automatically download and install updates in the future`. - ![Check for Updates dialog](../images/mac/check-for-updates.png) -#### Windows +If an update is available, you will be given the opportunity to install it right away. To enable automatic updates, select the appropriate checkbox labeled `Automatically download and install updates in the future`. + + + + +## Updating HandBrake on Windows + From the help menu, navigate to `Check for Updates...`. If an update is available, you will be given the opportunity to install it right away. -#### Linux - -On Linux, your package manager will handle any updates. The update checked is not built- - + ## Next steps diff --git a/source/en/latest/get-handbrake/where-to-get-handbrake.markdown b/source/en/latest/get-handbrake/where-to-get-handbrake.markdown index f8711920..63d437a3 100644 --- a/source/en/latest/get-handbrake/where-to-get-handbrake.markdown +++ b/source/en/latest/get-handbrake/where-to-get-handbrake.markdown @@ -20,8 +20,12 @@ Where to get HandBrake Official [HandBrake releases](https://handbrake.fr/downloads.php) and [nightly builds](https://handbrake.fr/nightly.php) are available for Linux, Mac, and Windows. + + Ubuntu Linux users should install the [official release PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases) or the [official snapshots PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-git-snapshots). The PPA may work, but is not tested, on other Debian-compatible distributions. Users of other BSD- and *nix-like distributions may compile from source. + + HandBrake source code is available at the official [HandBrake repository on GitHub](https://github.com/HandBrake/HandBrake). Other versions obtained via third parties are not supported. @@ -30,6 +34,8 @@ Other versions obtained via third parties are not supported. We encourage you to obtain HandBrake from the official website. When downloading from any other website, we highly recommend you ensure you have received an official copy of HandBrake by verifying the downloaded files match the [official release checksums](https://handbrake.fr/checksums.php) as published on the HandBrake website. Downloaded files with different checksums may contain unwanted extras or malware. + + ## Warning about broken third-party builds Certain Linux distributions and package repositories create their own versions of HandBrake. These modified versions are often crippled (features removed for political reasons) and broken (bugs due to modifications), and should be avoided. @@ -44,6 +50,8 @@ Please **do not** request support for these or any other unofficial versions. Th Linux users should install the [official release PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases), install the [official snapshots PPA](https://launchpad.net/~stebbins/+archive/ubuntu/handbrake-releases), or compile from the [official source code](https://github.com/HandBrake/HandBrake). + + ## Next steps Continue to [Downloading and installing HandBrake](download-and-install.html). diff --git a/source/en/latest/introduction/quick-start.markdown b/source/en/latest/introduction/quick-start.markdown index 91f47e9e..acb8ce21 100644 --- a/source/en/latest/introduction/quick-start.markdown +++ b/source/en/latest/introduction/quick-start.markdown @@ -34,36 +34,92 @@ HandBrake calls the video you already have the `Source`. Select the `Open Source` button on the toolbar to browse your files for a video to open. You may also drag your `Source` video onto HandBrake's main window. + + + + + + + ![Browsing for a video source to open](../images/mac/open-source-dialog.png "The Open Source dialog allows you to browse your files for a video to open.") ![Opening a video source via drag and drop](../images/mac/open-source-drag-drop.png "In addition to the Open Source dialog, you may also open a video by dragging it to HandBrake's main window.") + + + + + + + ## Select a title Some `Sources` may contain more than one video clip, or a collection of `Titles`. Use HandBrake's `Title` control to select which video clip you want to use. + + + + + + + ![Selecting a title](../images/mac/title-selection.png "Some sources may contain more than one video clip. The title control lets you select which video clip you want to use.") + + + + + + + Some `Sources` have only one `Title`. Blu-ray and DVD `Sources` often have multiple `Titles`. ## Select a preset HandBrake provides a number of settings `Presets` to make your new video work well with your playback devices and software. For instance, if you have a third generation Apple TV, you may wish to select the `AppleTV 3` preset. The default `Normal` preset is fast and relatively compatible. + + + + + + + ![Selecting a preset](../images/mac/preset-selection.png "Presets are one-click settings to save you time and help ensure compatibility with your devices.") ![Toggling the presets list](../images/mac/toggle-presets-button.png "If the presets list is not visible, select the Toggle Presets button on the toolbar.") + + + + + + + `Presets` can affect compatibility (whether your video will work with your devices and software) and encoding time. Learn more: [Selecting a preset](../workflow/select-preset.html) ## Select a destination The `Destination` is where your new video will go. You can select the `Browse...` button to choose a different location and name, or type it directly in the box. + + + + + + + ![Selecting a destination](../images/mac/destination-field.png "The destination is where your new video will go.") ![Browsing for a destination](../images/mac/destination-dialog.png "Select the browse button to choose a different location and name.") + + + + + + + Please take special care to *note your destination*. Otherwise, you won't be able to find your new video. You can move it later if you desire. ## Start the encode @@ -72,10 +128,24 @@ Select the `Start` button on the toolbar to make your new video. HandBrake will report its progress while it's working and alert you when it's finished. Then you will have a new video file at the `Destination` you specified. + + + + + + + ![Encode progress](../images/mac/encode-progress.png "HandBrake reports its progress during encoding.") ![Encoding complete alert](../images/mac/encode-complete.png "HandBrake shows an alert when finished encoding.") + + + + + + + Congratulations! You just encoded your first video using HandBrake. It's now ready to watch on your devices. ## Next steps diff --git a/source/en/latest/workflow/adjust-quality.markdown b/source/en/latest/workflow/adjust-quality.markdown index d54226d4..71d6f0a3 100644 --- a/source/en/latest/workflow/adjust-quality.markdown +++ b/source/en/latest/workflow/adjust-quality.markdown @@ -26,8 +26,22 @@ Most of HandBrake's built-in `Presets` use the x264 video encoder and a constant To increase video quality, adjust the quality control toward the right. To reduce video quality, adjust the quality control toward the left. + + + + + + + ![Quality control](../images/mac/quality-control.png) + + + + + + + Begin by making small adjustments (plus or minus 1-2 RF is usually noticeable). ## Recommended quality settings diff --git a/source/en/latest/workflow/open-video-source.markdown b/source/en/latest/workflow/open-video-source.markdown index 4e2e0747..d8ab7ba8 100644 --- a/source/en/latest/workflow/open-video-source.markdown +++ b/source/en/latest/workflow/open-video-source.markdown @@ -37,20 +37,64 @@ Learn more about [source formats](../technical/source-formats.html). By default, HandBrake presents the `Open Source` dialog on launch. It is also accessable from the `Toolbar` at the top of HandBrake's main window. + + + + + + + ![Main window toolbar](../images/mac/toolbar.png "The Toolbar provides easy access to HandBrake's most common functions.") ![Open Source button](../images/mac/open-source-button.png "The Open Source button opens the Open Source dialog.") -Select the `Open Source` button to select the video you want to open. You can also drag and drop a video `Source` onto HandBrake's main window. + + + + + + + +Select the `Open Source` button to select the video you want to open. + +You can also drag and drop a video `Source` onto HandBrake's main window. + + + + + + + ![Open Source dialog](../images/mac/open-source-dialog.png "The Open Source dialog allows you to browse your files for a video to open.") ![Opening a video source via drag and drop](../images/mac/open-source-drag-drop.png "In addition to the Open Source dialog, you may also open a video by dragging it to HandBrake's main window.") + + + + + + + HandBrake will scan your selection and after a few moments, the main window will show the file name of the `Source` you opened along with some additional information. + + + + + + + ![Successfully opened source](../images/mac/open-source-success.png "HandBrake's main window after sucessfully opening a source.") + + + + + + + Great! At this point, HandBrake knows which video you want to use. ## Next steps diff --git a/source/en/latest/workflow/preview-settings.markdown b/source/en/latest/workflow/preview-settings.markdown index b9136a20..99ef35f9 100644 --- a/source/en/latest/workflow/preview-settings.markdown +++ b/source/en/latest/workflow/preview-settings.markdown @@ -24,27 +24,94 @@ Luckily, HandBrake has a `Preview` feature that allows you to do a test run on a At the top of HandBrake's main window, you'll see a toolbar with various buttons. + + + + + + + ![Main window toolbar](../images/mac/toolbar.png "The Toolbar provides easy access to HandBrake's most common functions.") + + + + + + + Select the `Preview` button to open the `Preview` window. + + + + + + + ![Preview button](../images/mac/preview-button.png) ![Preview window](../images/mac/preview-window.png) + + + + + + + ## Adjusting Preview settings Move your mouse cursor over the `Preview` window, and some controls will appear. + + + + + + + ![Preview controls](../images/mac/preview-controls.png) + + + + + + + Set the starting position by dragging the `Position` control left or right. Choose how many seconds of video you want to encode using the `Duration` control. Longer durations will take more time to encode. + + + + + + + ![Preview position control](../images/mac/preview-controls-position.png) ![Preview duration control](../images/mac/preview-controls-duration.png) -## Starting a Preview encode + + + + + + + + + +## Starting a Preview encode on Linux + +TODO: Linux instructions. + + + + + + +## Starting a Preview encode on Mac When you're satisfied with your starting position and duration, select `Live Preview` and be patient. HandBrake will report its progress while it works. When your `Preview` is ready, it will play automatically. You can use the playback controls to pause, rewind, and replay your `Preview`. @@ -52,14 +119,39 @@ When you're satisfied with your starting position and duration, select `Live Pre ![Preview playing](../images/mac/preview-playing.png) + + + +## Starting a Preview encode on Windows + +TODO: Windows instructions. + + + + + ## Finishing up -To create a new `Preview`, select the `Still Previews` button to start over. When you're finished previewing your work, you may close the `Preview` window. + + + + + + + +To create a new `Preview`, select the `×` button to start over. When you're finished previewing your work, you may close the `Preview` window. ![Preview reset control](../images/mac/preview-controls-reset.png) ![Closing the preview window](../images/mac/preview-window-close.png) + + + + + + + ## Next steps If the `Preview` you created was lacking in quality or otherwise not as expected, you may need to [adjust quality](adjust-quality.html) or select a different [Preset](select-preset.html), after which you can create another `Preview` to see any changes. diff --git a/source/en/latest/workflow/select-preset.markdown b/source/en/latest/workflow/select-preset.markdown index afeb725a..e348611a 100644 --- a/source/en/latest/workflow/select-preset.markdown +++ b/source/en/latest/workflow/select-preset.markdown @@ -24,12 +24,26 @@ Selecting a `Preset` can go a long way toward ensuring your video works where yo HandBrake includes a number of built-in `Presets` for various devices and general use. -![Presets](../images/mac/presets.png) - Once you've opened a `Source`, select the `Preset` that most closely describes the device you want your videos to work on. For instance, if you want to play your videos on an iPad, choose the `iPad Preset`. + + + + + + + +![Presets](../images/mac/presets.png) + ![Selecting a preset](../images/mac/preset-selection.png "Presets are one-click settings to save you time and help ensure compatibility with your devices.") + + + + + + + If your device is not listed, or you wish to play your videos on a computer, choose the `Normal Preset` or `High Profile Preset`. The `Normal Preset` is fast and compatible across a wide range of softwares and devices. The `High Profile Preset` makes better quality videos that take up less space, leaving room for a second audio track in surround sound. ## Custom presets diff --git a/source/en/latest/workflow/start-encoding.markdown b/source/en/latest/workflow/start-encoding.markdown index 2e155506..be2e0512 100644 --- a/source/en/latest/workflow/start-encoding.markdown +++ b/source/en/latest/workflow/start-encoding.markdown @@ -22,24 +22,66 @@ Now that you've got all your settings just right, it's time to make your new vid `Destination` is where your new video will go. You can select the `Browse...` button to choose a new location and name, or type it directly in the box. + + + + + + + ![Selecting a destination](../images/mac/destination.png) + + + + + + + Please take special care to *note your destination*. Otherwise, you won't be able to find your new video. You can move it later if you desire. ## Starting the encode Select the `Start` button on the toolbar to make your new video. + + + + + + + ![Main window toolbar](../images/mac/toolbar.png "The Toolbar provides easy access to HandBrake's most common functions.") ![Starting an encode](../images/mac/start-button.png "The Start button begins encoding.") + + + + + + + HandBrake will report its progress while it's working and alert you when it's finished. Then you will have a new video file at the `Destination` you specified. + + + + + + + ![Encode progress](../images/mac/encode-progress.png "HandBrake reports its progress during encoding.") ![Encoding complete alert](../images/mac/encode-complete.png "HandBrake shows an alert when finished encoding.") + + + + + + + Congratulations! You just encoded your first video using HandBrake. It's now ready to watch on your devices. ## Next steps