Outdated descriptions in some composite node docs #46543

Many composite node pages are overly detailed/wordy and use outdated screenshots or even outdated explanations.

For example,

[Renderlayers ]]: Overly lengthy tutorial-like explanations, outdated screenshots, should link to [ http:*blender.org/manual/render/post_process/layers.html | layers instead of listing all passes (since these vary between render engines).
Image : Lengthy/wordy phrasing, guides to splicing between different sequences don't fit in with the reference manual paradigm.

@GiantCowFIlms and I propose making each node page follow a template somewhat like this:

    *********Node Name*********

    brief 1-2 paragraph abstract [image of node]
    
    Inputs
    ======
           * Breakdown of each input
    
    Settings
    ========
           * Breakdown of each setting
    
    Outputs
    =======
           * Breakdown of each output

    
    Example use-case (with image)
    
    Advanced section (if necessary)
    -------------------
           explain any complex functions

For consistency, and since it would be good to ensure nodes screenshots are all a similar size when floated next to text (see #46082), I suggest taking such floated node screenshots in the following manner:

Prepare a node editor containing only the node you wish to screenshot
Zoom to the maximum zoom level (hold numpad + or Ctrl MMB or similar)
Zoom out 8 zoom levels (numpad - 8 times)
Allow ~30 pixels of space around the node (this doesn't have to be perfect)

As @GiantCowFIlms pointed out, this zoom level can also be accomplished by pressing Space > Reset view and then zooming in 3 levels.

This guideline only applies for floated images of single nodes.

The idea is to have images where:

The images are (reasonably) consistently sized
Nodes are in scale relative to each other (no gigantic mix nodes and tiny RGB curve nodes)
There isn't need for lots of blank space around small nodes

Notes. for screenshots:

use default theme, zoom level.
avoid window borders.

When making compositing node images, please use this image to do compositing on.
When doing things that need a green screen use [[ https://mango.blender.org/wp-content/uploads/2012/05/A003C014_12050700000.jpg?5f0e2d

this image ]]

Many composite node pages are overly detailed/wordy and use outdated screenshots or even outdated explanations. For example, * [Renderlayers ]]: Overly lengthy tutorial-like explanations, outdated screenshots, should link to [[ http:*blender.org/manual/render/post_process/layers.html | layers ](http:*blender.org/manual/composite_nodes/types/input/render_layers.html) instead of listing all passes (since these vary between render engines). * [Image ](http://blender.org/manual/composite_nodes/types/input/image.html): Lengthy/wordy phrasing, guides to splicing between different sequences don't fit in with the reference manual paradigm. @GiantCowFIlms and I propose making each node page follow a template somewhat like this: ``` *********Node Name********* brief 1-2 paragraph abstract [image of node] Inputs ====== * Breakdown of each input Settings ======== * Breakdown of each setting Outputs ======= * Breakdown of each output Example use-case (with image) Advanced section (if necessary) ------------------- explain any complex functions ``` ------------------------------- For consistency, and since it would be good to ensure nodes screenshots are all a similar size when floated next to text (see #46082), I suggest taking such floated node screenshots in the following manner: 1. Prepare a node editor containing only the node you wish to screenshot 2. Zoom to the maximum zoom level (hold `numpad +` or `Ctrl MMB` or similar) 3. Zoom out 8 zoom levels (`numpad -` 8 times) 4. Allow ~30 pixels of space around the node (this doesn't have to be perfect) As @GiantCowFIlms pointed out, this zoom level can also be accomplished by pressing `Space` > Reset view and then zooming in 3 levels. **This guideline only applies for floated images of single nodes.** The idea is to have images where: * The images are (reasonably) consistently sized * Nodes are in scale relative to each other (no gigantic mix nodes and tiny RGB curve nodes) * There isn't need for lots of blank space around small nodes -------- Notes. for screenshots: - use default theme, zoom level. - avoid window borders. When making compositing node images, please use [this image ](http://johnroper100.github.io/images/hires-trees-full.jpg) to do compositing on. When doing things that need a green screen use [[ https://mango.blender.org/wp-content/uploads/2012/05/A003C014_12050700000.jpg?5f0e2d | this image ]] | -- |

Changed status to: 'Open'

Added subscribers: @gandalf3, @GiantCowFIlms

#46280 was marked as duplicate of this issue

#45773 was marked as duplicate of this issue

Added subscriber: @Blendify

For consistency, and since it would be good to ensure nodes screenshots are all a similar size when floated next to text (see #46082), I suggest taking such floated node screenshots in the following manner:

Prepare a node editor containing only the node you wish to screenshot
Zoom to the maximum zoom level (hold numpad + or Ctrl MMB or similar)
Zoom out 8 zoom levels (numpad - 8 times)
Allow ~30 pixels of space around the node (this doesn't have to be perfect)

As @GiantCowFIlms pointed out, this zoom level can also be accomplished by pressing Space > Reset view and then zooming in 3 levels.

This guideline only applies for floated images of single nodes.

The idea is to have images where:

The images are (reasonably) consistently sized
Nodes are in scale relative to each other (no gigantic mix nodes and tiny RGB curve nodes)
There isn't need for lots of blank space around small nodes

Can this same principal applied be to texture nodes and material nodes? Also I think that cycles nodes should then be spit into there own file. That will keep consistency through out.

@Blendify That is the idea, I think it should work.

This issue was referenced by 856

Added subscriber: @Inwader77

Should http://blender.org/manual/composite_nodes/types/converter/combine_separate.html be split up?

This issue was referenced by 1016

This issue was referenced by 1017

This issue was referenced by 1018

I think that calling it "Options" is better than "Settings" any reason not to do that?

Should the example section have its own title e.g:

Example
=======

Added subscriber: @Tobias

All the documented nodes are fitted in the template:
Input, Properties, Output.

Should it be Input/Output be singular or plural:
Input or Inputs
Input (sockets)

Plural

Changed status from 'Open' to: 'Resolved'

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Outdated descriptions in some composite node docs #46543