[Bf-docboard-svn] bf-manual: [7439] trunk/blender_docs/manual: Rendering: Restructure Output Docs

Aaron Carlisle noreply at blender.org
Sat Nov 28 07:40:16 CET 2020 

Revision: 7439
          https://developer.blender.org/rBM7439
Author:   Blendify
Date:     2020-11-28 07:40:15 +0100 (Sat, 28 Nov 2020)
Log Message:
-----------
Rendering: Restructure Output Docs

This makes the documentation better match the UI:

- Rename Settings to Properties
- Each Panel has there own page
- Group each panel in a new properties directory

Modified Paths:
--------------
    trunk/blender_docs/manual/compositing/types/converter/switch_view.rst
    trunk/blender_docs/manual/compositing/types/input/image.rst
    trunk/blender_docs/manual/editors/image/image_settings.rst
    trunk/blender_docs/manual/editors/image/navigating.rst
    trunk/blender_docs/manual/editors/image/overlays.rst
    trunk/blender_docs/manual/editors/uv/overlays.rst
    trunk/blender_docs/manual/files/media/image_formats.rst
    trunk/blender_docs/manual/render/output/animation.rst
    trunk/blender_docs/manual/render/output/index.rst
    trunk/blender_docs/manual/render/output/introduction.rst
    trunk/blender_docs/manual/video_editing/sequencer/strips/sound.rst

Added Paths:
-----------
    trunk/blender_docs/manual/render/output/properties/
    trunk/blender_docs/manual/render/output/properties/dimensions.rst
    trunk/blender_docs/manual/render/output/properties/index.rst
    trunk/blender_docs/manual/render/output/properties/metadata.rst
    trunk/blender_docs/manual/render/output/properties/output.rst
    trunk/blender_docs/manual/render/output/properties/post_processing.rst
    trunk/blender_docs/manual/render/output/properties/stereoscopy/
    trunk/blender_docs/manual/render/output/properties/stereoscopy/index.rst
    trunk/blender_docs/manual/render/output/properties/stereoscopy/introduction.rst
    trunk/blender_docs/manual/render/output/properties/stereoscopy/usage.rst

Removed Paths:
-------------
    trunk/blender_docs/manual/render/output/file_formats.rst
    trunk/blender_docs/manual/render/output/metadata.rst
    trunk/blender_docs/manual/render/output/settings.rst
    trunk/blender_docs/manual/render/output/stereoscopy/

Modified: trunk/blender_docs/manual/compositing/types/converter/switch_view.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/converter/switch_view.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/compositing/types/converter/switch_view.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -18,7 +18,7 @@
 
 .. seealso::
 
-   :doc:`The multi-view workflow </render/output/stereoscopy/index>`.
+   :doc:`The multi-view workflow </render/output/properties/stereoscopy/index>`.
 
 
 Inputs

Modified: trunk/blender_docs/manual/compositing/types/input/image.rst
===================================================================
--- trunk/blender_docs/manual/compositing/types/input/image.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/compositing/types/input/image.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -9,7 +9,7 @@
 
    Image Node.
 
-The *Image* node injects any image :doc:`format that is supported by Blender </render/output/settings>`.
+The *Image* node injects any image :doc:`format that is supported by Blender </files/media/image_formats>`.
 
 
 Inputs

Modified: trunk/blender_docs/manual/editors/image/image_settings.rst
===================================================================
--- trunk/blender_docs/manual/editors/image/image_settings.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/editors/image/image_settings.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -149,7 +149,7 @@
 View as Render
    Applies :doc:`color transform </render/color_management>` when displaying this image on the screen.
 Use Multi-View
-   See :doc:`Multi-View </render/output/stereoscopy/index>`.
+   See :doc:`Multi-View </render/output/properties/stereoscopy/index>`.
 Alpha
    Representation of alpha in the image file, to convert to and from when saving and loading the image.
    See :term:`Alpha Channel`.

Modified: trunk/blender_docs/manual/editors/image/navigating.rst
===================================================================
--- trunk/blender_docs/manual/editors/image/navigating.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/editors/image/navigating.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -24,7 +24,7 @@
 Update Automatically
    Update the view in multiple areas.
 Show Metadata
-   Displays the metadata if they were set in the render tab's :doc:`/render/output/metadata` panel.
+   Displays the metadata if they were set in the render tab's :doc:`/render/output/properties/metadata` panel.
 Display Texture Paint UVs
    Toggles UVs in Paint Mode.
 Zoom In/Out :kbd:`Wheel`

Modified: trunk/blender_docs/manual/editors/image/overlays.rst
===================================================================
--- trunk/blender_docs/manual/editors/image/overlays.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/editors/image/overlays.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -20,4 +20,4 @@
 =====
 
 Show Metadata
-   Displays the metadata if they were set in the render tab's :doc:`/render/output/metadata` panel.
+   Displays the metadata if they were set in the render tab's :doc:`/render/output/properties/metadata` panel.

Modified: trunk/blender_docs/manual/editors/uv/overlays.rst
===================================================================
--- trunk/blender_docs/manual/editors/uv/overlays.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/editors/uv/overlays.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -49,4 +49,4 @@
 =====
 
 Show Metadata
-   Displays the metadata if they were set in the render tab's :doc:`/render/output/metadata` panel.
+   Displays the metadata if they were set in the render tab's :doc:`/render/output/properties/metadata` panel.

Modified: trunk/blender_docs/manual/files/media/image_formats.rst
===================================================================
--- trunk/blender_docs/manual/files/media/image_formats.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/files/media/image_formats.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -22,7 +22,7 @@
    * - Format
      - Channel Depth
      - Alpha
-     - :doc:`Metadata </render/output/metadata>`
+     - :doc:`Metadata </render/output/properties/metadata>`
      - DPI
      - Extensions
    * - BMP

Modified: trunk/blender_docs/manual/render/output/animation.rst
===================================================================
--- trunk/blender_docs/manual/render/output/animation.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/render/output/animation.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -115,7 +115,7 @@
    You can add other strips, like an audio strip.
 #. Scrub through the animation to check if you have included all the frames.
 #. In the Output panel, choose the container and codec you want (e.g. ``MPEG H.264``) and configure them.
-   The video codecs are described on the previous page: :doc:`Output Options </render/output/settings>`.
+   The video codecs are described in :doc:`Output Options </render/output/properties/output>`.
 #. Click the *Animation* render button and Blender will render out the Sequence editor output into a movie.
 
 

Deleted: trunk/blender_docs/manual/render/output/file_formats.rst
===================================================================
--- trunk/blender_docs/manual/render/output/file_formats.rst	2020-11-28 05:57:06 UTC (rev 7438)
+++ trunk/blender_docs/manual/render/output/file_formats.rst	2020-11-28 06:40:15 UTC (rev 7439)
@@ -1,178 +0,0 @@
-
-************
-File Formats
-************
-
-.. seealso::
-
-   :ref:`files-media-index` for technical information about supported file formats.
-
-
-Image Output
-============
-
-When rendering a single frame, the output should be a single image format and not a video.
-Several :doc:`image formats </files/media/image_formats>` are available, PNG being the default.
-
-Images can also be used for rendering animations which has a couple advantages.
-For example, when rendering animations to image file formats the render job can be canceled
-and resumed at the last rendered frame by changing the frame range.
-This is useful if the animation takes a long time to render
-and the computers resources are needed for something else.
-
-Images can then be encoded to a video by adding the rendered image sequence into
-the :doc:`Video Sequencer </video_editing/sequencer/index>` and choosing an appropriate `Video Output`_.
-
-.. tip::
-
-   Rendered image sequences can be played back in the :ref:`Animation Player <render-output-animation_player>`.
-
-
-Video Output
-============
-
-.. _render-output-video-encoding-panel:
-.. _bpy.types.FFmpegSettings:
-
-Encoding Panel
---------------
-
-.. admonition:: Reference
-   :class: refbox
-
-   :Panel:     :menuselection:`Properties --> Output --> Encoding`
-
-.. figure:: /images/render_output_file-formats_video-encoding-panel.png
-
-   Encoding panel.
-
-Here you choose which video container, codec, and compression settings you want to use.
-With all of these compression choices, there is a trade-off between file size,
-compatibility across platforms, and playback quality.
-
-.. tip::
-
-   When you view the :doc:`System Console </advanced/command_line/introduction>`,
-   you can see some of the output of the encoding process.
-   You will see even more output if you execute Blender as ``blender -d``.
-
-Presets
-   You can use the presets, which choose optimum settings for you for that type of output.
-Container
-   Video container or file type. For a list of all available options, see
-   :doc:`video formats </files/media/video_formats>`.
-Autosplit Output
-   If your video is huge and exceeds 2GiB, enable Autosplit Output.
-   This will automatically split the output into multiple files after the first file is 2GiB in size.
-
-
-Video
-^^^^^
-
-Video Codec
-   Chooses the method of compression and encoding.
-   For a list of all available options see :doc:`video formats </files/media/video_formats>`.
-
-.. note:: Standards
-
-   Some containers and codecs are not compatible with each other,
-   so if you are getting errors check that your container and codec are compatible.
-   Like containers and codecs are sometimes not compatible with each other, some codecs
-   do not work with arbitrary dimensions. So, try to stick with common dimensions
-   or research the limitations of the codec you are trying to use.
-
-Output Quality
-   These are preset `Rate`_.
-Encoding Speed
-   Presets to change between a fast encode (bigger file size) and more compression (smaller file size).
-
-Keyframe Interval
-   The number of pictures per `Group of Pictures <https://en.wikipedia.org/wiki/Group_of_pictures>`__.
-   Set to 0 for "intra_only", which disables `inter-frame <https://en.wikipedia.org/wiki/Inter-frame>`__ video.
-   A higher number generally leads to a smaller file but needs a higher-powered device to replay it.
-Max B-frames
-   Enables the use of :term:`B‑frames <Frame Types>`.
-
-   Interval
-      The maximum number of :term:`B‑frames <Frame Types>` between non-B-frames.
-
-
-Rate
-^^^^
-
-Bitrate
-   Sets the average `bit rate <https://en.wikipedia.org/wiki/Bit_rate>`__ (quality),
-   which is the count of binary digits per frame.
-   See also: `FFmpeg -b:v <https://ffmpeg.org/ffmpeg.html#Description>`__.
-Rate
-   Video files can use what is called variable bit rate (VBR).
-   This is used to give some segments of the video less compressing to frames that need more data
-   and less to frames with less data. This can be controlled by the *Minimum* and *Maximum* values.
-Buffer
-   The `decoder bitstream buffer <https://en.wikipedia.org/wiki/Video_buffering_verifier>`__ size.
-
-
-Mux
-^^^
-
-`Multiplexing <https://www.afterdawn.com/glossary/term.cfm/multiplexing>`__
-is the process of combining separate video and audio streams into a single file,
-similar to packing a video file and MP3 audio file in a zip-file.
-
-Rate
-   Maximum bit rate of the multiplexed stream.
-Packet Size
-   Reduces data fragmentation or muxer overhead depending on the source.
-
-
-.. _render-output-video-encoding-audio:
-.. _bpy.types.FFmpegSettings.audio:
-
-Audio
-^^^^^
-
-These settings change how sound is exported while rendering.
-To control how sound is played back from within Blender, see the audio settings
-in the :ref:`Preferences <prefs-system-sound>`.
-
-Audio Codec

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-docboard-svn mailing list