Details

Reviewers

Kitt Zwovic (gandalf3)
Campbell Barton (campbellbarton)
GiantCowFIlms

Maniphest Tasks

T46543: Outdated descriptions in some composite node docs

Summary

This revision is part of a larger improvement to all node documentation that @Kitt Zwovic (gandalf3) and I have been discussing (see task: T46543). It makes the page more in-keep with the direction we will take the other node pages in.

Diff Detail

Repository: rBM Blender Manual

Event Timeline

GiantCowFIlms updated this revision to Diff 5247.Oct 20 2015, 5:17 PM

GiantCowFIlms retitled this revision from to Update node controls page.

GiantCowFIlms updated this object.

GiantCowFIlms added a reviewer: Kitt Zwovic (gandalf3).

GiantCowFIlms set the repository for this revision to rBM Blender Manual.

GiantCowFIlms added a project: Documentation.

GiantCowFIlms added a subscriber: Kitt Zwovic (gandalf3).

GiantCowFIlms updated this object.Oct 20 2015, 6:17 PM

Aaron Carlisle (Blendify) updated this object.Oct 20 2015, 6:34 PM

You for got to include this in an index. Also CTRL+H for hiding unused sockets should be discussed here

Looks good after a few things are fixed:

manual/editors/node_editor/node_parts.rst
8	Image seems to big. You can crop it and scale it down, instead if setting width.
21	Watch spacing
60	Same here however this image is not as bad

Campbell Barton (campbellbarton) requested changes to this revision.Oct 20 2015, 7:01 PM

Campbell Barton (campbellbarton) added a reviewer: Campbell Barton (campbellbarton).

Campbell Barton (campbellbarton) added a subscriber: Campbell Barton (campbellbarton).

Campbell Barton (campbellbarton) added inline comments.

manual/editors/node_editor/node_parts.rst
27	Prefer not to make title apart of the sentence , just include the word twice. Same goes for next section.
39–50	Suggest include useful info as follows. Color (Yellow) .... Numeric (Grey) .... Vector (Blue) .... Shader (Green) .... You can see more easily. at a glance whats what.

This revision now requires changes to proceed.Oct 20 2015, 7:01 PM

GiantCowFIlms updated this revision to Diff 5248.Oct 20 2015, 7:20 PM

GiantCowFIlms edited edge metadata.

GiantCowFIlms removed rBM Blender Manual as the repository for this revision.

Kitt Zwovic (gandalf3) added a task: T46543: Outdated descriptions in some composite node docs.Oct 20 2015, 7:21 PM

GiantCowFIlms updated this revision to Diff 5249.Oct 20 2015, 7:26 PM

GiantCowFIlms edited edge metadata.

GiantCowFIlms marked 3 inline comments as done.

Still needs to be included in the index

Kitt Zwovic (gandalf3) added inline comments.Oct 20 2015, 7:36 PM

manual/editors/node_editor/node_parts.rst
9	That brings up the question, should we have a standard for screenshots of nodes? e.g. always view the node at the same zoom level (not sure how to set this, python probably needed), leave it at it's default dimensions, and allow 100px between the edge of the node and the edge of the image.
14	One = typo? If it's not already mentioned elsewhere, perhaps you could mention H here (the keyboard shortcut)

Aaron Carlisle (Blendify) added inline comments.Oct 20 2015, 7:39 PM

manual/editors/node_editor/node_parts.rst
9	I was using 150px however anything in the 150-200px range seems good for nodes

In D1568#33997, @Aaron Carlisle (Blendify) wrote:

Still needs to be included in the index

Not quite clear on what you mean by that....?

manual/editors/node_editor/node_parts.rst
27	I recently remember reading that it was supposed to be a part of the sentence, has this changed?
39–50	This was copied form the previous page, but I will fix it.

GiantCowFIlms updated this revision to Diff 5251.Oct 20 2015, 8:19 PM

Not quite clear on what you mean by that....?

The webpage must be included in the containing index like in the index below

.. _editors-node-index:

##############
  Node Editor
##############

.. toctree::
   :maxdepth: 2

   introduction.rst
   editor.rst
   node_controls.rst
   usage.rst
   node_groups.rst
   node_parts.rst

@Aaron Carlisle (Blendify) I added new images, and have picked a size standard:

Reset View

Zoom in (Numpad +) x 3

Screenshot.

Should work well enough.

manual/editors/node_editor/node_parts.rst
14	I will mention it

Kitt Zwovic (gandalf3) added inline comments.Oct 20 2015, 8:33 PM

manual/editors/node_editor/node_parts.rst
10	I wrote up a proposal here: T46543#342614

Removed node_controls.rst

Kitt Zwovic (gandalf3) added inline comments.Oct 20 2015, 9:00 PM

manual/editors/node_editor/node_parts.rst
6	Mentions material twice. I'd suggest just skipping the list of types here entirely. If really needed, link to http://blender.org/manual/editors/node_editor/introduction.html#node-tree-types instead to minimize the number of pages which will need updating when more node types are added.
69	What are the "controls"? What is this section referring to?