From d6c03366fecd4846861abee4df7e810665137175 Mon Sep 17 00:00:00 2001 From: Bradley Sepos Date: Fri, 23 Dec 2016 04:50:53 -0500 Subject: [PATCH] docs: Housekeeping prior to HandBrake 1.0.0. --- .../latest/advanced/resizing-video.markdown | 2 - .../download-and-install.markdown | 4 +- .../docs/en/latest/table-of-contents.markdown | 102 ++++++++++-------- .../anamorphic-guide.markdown | 0 .../audio-quality.markdown | 0 .../automatic-file-naming.markdown | 0 .../containers.markdown | 0 .../dynamic-range-compression.markdown | 0 .../filters-summary.markdown | 0 .../frame-rates.markdown | 0 .../{advanced => technical}/modulus.markdown | 0 .../old-ipod-support.markdown | 0 .../latest/technical/source-formats.markdown | 2 +- .../video-angles.markdown | 0 .../video-encoding-performance.markdown | 0 15 files changed, 59 insertions(+), 51 deletions(-) rename source/docs/en/latest/{advanced => technical}/anamorphic-guide.markdown (100%) rename source/docs/en/latest/{advanced => technical}/audio-quality.markdown (100%) rename source/docs/en/latest/{advanced => technical}/automatic-file-naming.markdown (100%) rename source/docs/en/latest/{advanced => technical}/containers.markdown (100%) rename source/docs/en/latest/{advanced => technical}/dynamic-range-compression.markdown (100%) rename source/docs/en/latest/{advanced => technical}/filters-summary.markdown (100%) rename source/docs/en/latest/{advanced => technical}/frame-rates.markdown (100%) rename source/docs/en/latest/{advanced => technical}/modulus.markdown (100%) rename source/docs/en/latest/{advanced => technical}/old-ipod-support.markdown (100%) rename source/docs/en/latest/{advanced => technical}/video-angles.markdown (100%) rename source/docs/en/latest/{advanced => technical}/video-encoding-performance.markdown (100%) diff --git a/source/docs/en/latest/advanced/resizing-video.markdown b/source/docs/en/latest/advanced/resizing-video.markdown index 6767ae63..ceb13620 100644 --- a/source/docs/en/latest/advanced/resizing-video.markdown +++ b/source/docs/en/latest/advanced/resizing-video.markdown @@ -41,8 +41,6 @@ The width and height must be divisible by this number. It's best left at 2, but Typically recommended that you leave this on "loose". If your source is not anamorphic, having this set to an anamorphic option will not affect the output. Thus, it is safe to leave on. -For more information on what Anamorphic is, please read our advanced anamorphic guide [TODO LINK] - ## Upscaling The HandBrake GUI's do not allow upscaling. Most of the time this is a bad idea as it reduces (not increases) the quality of your source file along with increasing the final file size. This is less than idea. Most of the time, letting the playback device or software upscale to your screen size is much better. You don't gain anything by upscaling with HandBrake. diff --git a/source/docs/en/latest/get-handbrake/download-and-install.markdown b/source/docs/en/latest/get-handbrake/download-and-install.markdown index cce820e6..375a4be1 100644 --- a/source/docs/en/latest/get-handbrake/download-and-install.markdown +++ b/source/docs/en/latest/get-handbrake/download-and-install.markdown @@ -118,7 +118,7 @@ By selecting `More info`, you will be able to select `Run anyway` to continue th ## Launching HandBrake -You may launch HandBrake by quickly clicking twice (double-clicking) on the cocktail & pineapple icon[^about-icon]. Depending on your system settings, a single click may suffice. +You may launch HandBrake by quickly clicking twice (double-clicking) on the cocktail & pineapple icon. Depending on your system settings, a single click may suffice. ![HandBrake icon](../../images/icon-1.0.0.png)![Double-clicking HandBrake icon](../../images/icon-click-1.0.0.gif) @@ -135,5 +135,3 @@ Continue to [Checking for updates](check-for-updates.html). [^gatekeeper-disabled]: If Gatekeeper is disabled on your Mac, you may not see this message. [^gatekeeper-instructions]: These instructions are taken directly from Apple's Gatekeeper support documents. You can learn more about Gatekeeper [here](https://support.apple.com/kb/PH21769?locale=en_US) and [here](https://support.apple.com/en-us/HT202491). - -[^about-icon]: Read about the icon and more at HandBrake lore (TODO: link). diff --git a/source/docs/en/latest/table-of-contents.markdown b/source/docs/en/latest/table-of-contents.markdown index 8bb2929f..366728f5 100644 --- a/source/docs/en/latest/table-of-contents.markdown +++ b/source/docs/en/latest/table-of-contents.markdown @@ -18,8 +18,6 @@ Table of contents ## Introduction - - - [Quick start](introduction/quick-start.html) *Learn how to make your first video in minutes* - [About HandBrake](introduction/about.html) @@ -50,23 +48,24 @@ Table of contents *Start encoding your new video with one click* -## Advanced features +## Advanced workflows -- [Multiple encodes using the Queue](advanced/queue.html) -- [Custom presets](advanced/custom-presets.html) - - [Audio and Subtitled Defaults](advanced/audio-subtitle-defaults.html) -- [Resizing video](advanced/resizing-video.html) -- [Managing Audio Tracks](advanced/managing-audio.html) - - [Understanding Surround Sound](advanced/surround-sound.html) -- [Adding subtitles](advanced/subtitles.html) -- [Chapter markers](advanced/chapter-markers.html) +- [Multiple encodes using the queue](advanced/queue.html) + *Set up multiple encode jobs at once* +- [Point-to-point encoding](advanced/point-to-point.html) +- [Custom presets](advanced/custom-presets.html) +- [Audio and subtitle defaults](advanced/audio-subtitle-defaults.html) +- [Resizing video](advanced/resizing-video.html) +- [Preserving surround sound](advanced/surround-sound.html) +- [Adding subtitles](advanced/subtitles.html) +- [Adding chapter markers](advanced/chapter-markers.html) + + -## Advanced features part 2 + - - [Summary of encoders](technical/video-codecs.html) - - [Video encoding speed](advanced/video-encoding-performance.html) - - [Constant quality versus average bit rate](technical/video-cq-vs-abr.html) - - [Video angles](advanced/video-angles.html) - - [Frame rate](advanced/frame-rates.html) -- Audio - - [Dynamic Range Compression](advanced/dynamic-range-compression.html) - - [Audio quality](advanced/audio-quality.html) -- Output and Compatibility - - [Formats/containers](advanced/containers.html) - - [Web optimized](advanced/web-optimised.html) - - [iPod 5G support](advanced/old-ipod-support.html) - - [Point-to-point](advanced/point-to-point.html) - - [Automatic file naming](advanced/automatic-file-naming.html) -- Picture - - [Anamorphic Guide](advanced/anamorphic-guide.html) - - [Modulus](advanced/modulus.html) -- Filters - - [Summary](advanced/filters-summary.html) +- [Understanding source types](advanced/video-sources.html) +- [Selecting a container format and encoders](advanced/containers.html) +- [Selecting a video angle](advanced/video-angles.html) +- [Working with frame rates](advanced/frame-rates.html) +- [Adjusting audio quality](advanced/audio-quality.html) +- [Progressive download support](advanced/web-optimised.html) +- [Compatibility with legacy devices](advanced/old-ipod-support.html) +- [Automatically naming files](advanced/automatic-file-naming.html) +--> ## Getting help - [Troubleshooting common issues](help/troubleshooting-common-issues.html) *What to do if something goes wrong* - [Community support](help/community-support.html) - *Help from real people* -- [Activity Log](help/activity-log.html) + *Get help from real people* +- [Activity Log](help/activity-log.html) + *Activity Logs help you receive better support* ## HandBrake lore - [Project history](about/history.html) + ## CLI documentation -- [Command line guide](cli/cli-guide.html) -- [CLI options](cli/cli-options.html) +- [CLI guide](cli/cli-guide.html) +- [CLI options list](cli/cli-options.html) ## Technical documentation - [System requirements](technical/system-requirements.html) *Make sure your system can run HandBrake* -- [Supported Source formats](technical/source-formats.html) +- [Supported source formats](technical/source-formats.html) + *Types of video files HandBrake can read* - [Official presets](technical/official-presets.html) + *Technical summary of the official presets* - Video - - [x264 presets and tunes](technical/video-x264-presets-tunes.html) - - [x264 profile and level](technical/video-x264-profiles-levels.html) - - [Intel QuickSync Options](technical/video-qsv-options.html) + - [Video encoders](technical/video-codecs.html) + - [Video encoding speed](technical/video-encoding-performance.html) + - [Constant quality versus average bit rate](technical/video-cq-vs-abr.html) + - [x264 presets and tunes](technical/video-x264-presets-tunes.html) + - [x264 profile and level](technical/video-x264-profiles-levels.html) + - [Video angles](technical/video-angles.html) + - [Anamorphic video](technical/anamorphic-guide.html) + - [Modulus](technical/modulus.html) + - [Frame rate](technical/frame-rates.html) + - [Intel QuickSync Video (QSV) options](technical/video-qsv-options.html) +- Audio + - [Dynamic range compression](technical/dynamic-range-compression.html) + - [Audio quality](technical/audio-quality.html) +- Files and compatibility + - [Container formats](technical/containers.html) + - [Web optimized](technical/web-optimised.html) + - [iPod 5th Generation support](technical/old-ipod-support.html) + - [Automatic file naming](technical/automatic-file-naming.html) +- Filters + - [Filters summary](technical/filters-summary.html) + ## Developer documentation -- Releases - - [Linux Flatpaks](developer/flatpak-repo.html) - Building HandBrake - [Building HandBrake for Linux](developer/build-linux.html) - Installing dependencies on [CentOS](developer/install-dependencies-centos.html) / [Fedora](developer/install-dependencies-fedora.html) / [Gentoo](developer/install-dependencies-gentoo.html) / [Ubuntu](developer/install-dependencies-ubuntu.html) - [Building HandBrake for Mac](developer/build-mac.html) - [Building HandBrake for Windows](developer/build-windows.html) +- Packaging HandBrake + - [Flatpak apps for Linux](developer/flatpak-repo.html) + *Fully-contained applications compatible with multiple Linux distributions* + diff --git a/source/docs/en/latest/advanced/anamorphic-guide.markdown b/source/docs/en/latest/technical/anamorphic-guide.markdown similarity index 100% rename from source/docs/en/latest/advanced/anamorphic-guide.markdown rename to source/docs/en/latest/technical/anamorphic-guide.markdown diff --git a/source/docs/en/latest/advanced/audio-quality.markdown b/source/docs/en/latest/technical/audio-quality.markdown similarity index 100% rename from source/docs/en/latest/advanced/audio-quality.markdown rename to source/docs/en/latest/technical/audio-quality.markdown diff --git a/source/docs/en/latest/advanced/automatic-file-naming.markdown b/source/docs/en/latest/technical/automatic-file-naming.markdown similarity index 100% rename from source/docs/en/latest/advanced/automatic-file-naming.markdown rename to source/docs/en/latest/technical/automatic-file-naming.markdown diff --git a/source/docs/en/latest/advanced/containers.markdown b/source/docs/en/latest/technical/containers.markdown similarity index 100% rename from source/docs/en/latest/advanced/containers.markdown rename to source/docs/en/latest/technical/containers.markdown diff --git a/source/docs/en/latest/advanced/dynamic-range-compression.markdown b/source/docs/en/latest/technical/dynamic-range-compression.markdown similarity index 100% rename from source/docs/en/latest/advanced/dynamic-range-compression.markdown rename to source/docs/en/latest/technical/dynamic-range-compression.markdown diff --git a/source/docs/en/latest/advanced/filters-summary.markdown b/source/docs/en/latest/technical/filters-summary.markdown similarity index 100% rename from source/docs/en/latest/advanced/filters-summary.markdown rename to source/docs/en/latest/technical/filters-summary.markdown diff --git a/source/docs/en/latest/advanced/frame-rates.markdown b/source/docs/en/latest/technical/frame-rates.markdown similarity index 100% rename from source/docs/en/latest/advanced/frame-rates.markdown rename to source/docs/en/latest/technical/frame-rates.markdown diff --git a/source/docs/en/latest/advanced/modulus.markdown b/source/docs/en/latest/technical/modulus.markdown similarity index 100% rename from source/docs/en/latest/advanced/modulus.markdown rename to source/docs/en/latest/technical/modulus.markdown diff --git a/source/docs/en/latest/advanced/old-ipod-support.markdown b/source/docs/en/latest/technical/old-ipod-support.markdown similarity index 100% rename from source/docs/en/latest/advanced/old-ipod-support.markdown rename to source/docs/en/latest/technical/old-ipod-support.markdown diff --git a/source/docs/en/latest/technical/source-formats.markdown b/source/docs/en/latest/technical/source-formats.markdown index 8dd57cba..a19e20c2 100644 --- a/source/docs/en/latest/technical/source-formats.markdown +++ b/source/docs/en/latest/technical/source-formats.markdown @@ -42,7 +42,7 @@ HandBrake can open a number of production formats produced by professional video HandBrake can directly open DVD and Blu-ray discs. In most situations it is better to first copy the contents to your computer's hard drive[^uncopyable]. Common folders are VIDEO_TS and BDMV. Common video file types are VOB, EVO, and MTS or M2TS. -Certain third-party disc copy tools such as MakeMKV (TODO: link) commonly make... wait for it... MKV video files. Other tools create ISO (sometimes labeled CDR) images of DVD and Blu-ray discs. HandBrake usually can open these directly. +Certain third-party disc copy tools such as MakeMKV commonly make... wait for it... MKV video files. Other tools create ISO (sometimes labeled CDR) images of DVD and Blu-ray discs. HandBrake usually can open these directly. BIN+CUE, MDF+MDS, and Toast images must first be mounted. Open the image using your operating system or appropriate software, and then open the virtual disc with HandBrake. diff --git a/source/docs/en/latest/advanced/video-angles.markdown b/source/docs/en/latest/technical/video-angles.markdown similarity index 100% rename from source/docs/en/latest/advanced/video-angles.markdown rename to source/docs/en/latest/technical/video-angles.markdown diff --git a/source/docs/en/latest/advanced/video-encoding-performance.markdown b/source/docs/en/latest/technical/video-encoding-performance.markdown similarity index 100% rename from source/docs/en/latest/advanced/video-encoding-performance.markdown rename to source/docs/en/latest/technical/video-encoding-performance.markdown