Fix glossary entries with poor/misleading definitions or which don't follow the style guide #45895

New Issue

gandalf3 · 2015-08-25T04:06:23+02:00

gandalf3 commented

2015-08-25 04:06:23 +02:00

Once a solid definition is put on what makes a well written glossary entry (#45893), there are a lot of glossary entries which will have to be edited to conform.
In addition there are some entries which have rather unclear or incomplete definitions (e.g. Layer) or poorly managed uses (e.g. Color Blend Modes).

As an example:

Several files all reference Color Blend Modes as a reference "for details on each blending mode".
Not only does the glossary not contain these details, but imo a glossary entry should define a term and shouldn't be used as a reference for explaining details about a particular feature.

Here's a list of entries which currently don't follow the style guide :

Entry	Reason
Active	No definition
Straight Alpha	Definition not first
Premultiplied Alpha	Definition not first
Ambient Light	"It's", and could use a rewrite (where did this desk come from?)
Baking	Repetition
Boolean	Avoid using numerical characters in place of words (s/2/two)
Bump Mapping	Could use some simplification
Bézier	"It's"
Caustics	Very wordy, can be condensed
Collapse	"Is"
Color Blend Modes	s/2/two
Constraint	"It's"
Crease	"It's"
Curve	"It's"
Depth Of Field	"It's"
Diffuse Light	"It's"
Directional Light	"Is"
Double Buffer	No definition (well described otherwise though)
Edge	s/2/two
Edge Ring	s/2/two
Full-Screen Anti-Aliasing	Definition not first
Gamma	Incomplete
Geometric Center	Uses term in definition
Global Illumination	"Is"
Index Of Refraction	"It's"
Inverse Kinematics	"Is"
Keyframe	"It's"
Lattice	Repetition
Motion Blur	"It's"
Ngon	"It's"
NURBS	"Is"
Overscan	Repetition
Particle system	"It's"
Pivot Point	"It's"
Pole	"It's"
Primitive	"Is"
Quad	"It's"
Radiosity	"Is"
Refraction	"It's"
Relative Vertex Keys	No clear definition
Subdividing	"It's"
Subdivision surface	"Is"
Tessellation	Incomplete
Texture	Repetition
Triangle	"It's"
UV map	Repetition
Vertex	"It's"
Vertex Group	No clear definition

List may not be complete. If you see any more, by all means add them here :)

Once a solid definition is put on what makes a well written glossary entry (#45893), there are a lot of glossary entries which will have to be edited to conform. In addition there are some entries which have rather unclear or incomplete definitions (e.g. *Layer*) or poorly managed uses (e.g. *Color Blend Modes*). As an example: Several files all reference *Color Blend Modes* as a reference "for details on each blending mode". Not only does the glossary not contain these details, but imo a glossary entry should define a term and shouldn't be used as a reference for explaining details about a particular feature. ----- Here's a list of entries which currently don't follow the [style guide ](https://www.blender.org/manual/about/writing_style_guide.html#glossary): | Entry | Reason | ----- | ----- | Active | No definition | Straight Alpha | Definition not first | Premultiplied Alpha | Definition not first | Ambient Light | "It's", and could use a rewrite (where did this *desk* come from?) | Baking | Repetition | Boolean | Avoid using numerical characters in place of words (s/2/two) | Bump Mapping | Could use some simplification | Bézier | "It's" | Caustics | Very wordy, can be condensed | Collapse | "Is" | Color Blend Modes | s/2/two | Constraint | "It's" | Crease | "It's" | Curve | "It's" | Depth Of Field | "It's" | Diffuse Light | "It's" | Directional Light | "Is" | Double Buffer | No definition (well described otherwise though) | Edge | s/2/two | Edge Ring | s/2/two | Full-Screen Anti-Aliasing | Definition not first | Gamma | Incomplete | Geometric Center | Uses term in definition | Global Illumination | "Is" | Index Of Refraction | "It's" | Inverse Kinematics | "Is" | Keyframe | "It's" | Lattice | Repetition | Motion Blur | "It's" | Ngon | "It's" | NURBS | "Is" | Overscan | Repetition | Particle system | "It's" | Pivot Point | "It's" | Pole | "It's" | Primitive | "Is" | Quad | "It's" | Radiosity | "Is" | Refraction | "It's" | Relative Vertex Keys | No clear definition | Subdividing | "It's" | Subdivision surface | "Is" | Tessellation | Incomplete | Texture | Repetition | Triangle | "It's" | UV map | Repetition | Vertex | "It's" | Vertex Group | No clear definition List may not be complete. If you see any more, by all means add them here :)

gandalf3 commented

2015-08-25 04:06:23 +02:00

Changed status to: 'Open'

gandalf3 commented

2015-08-25 04:06:23 +02:00

Added subscriber: @gandalf3

Campbell Barton commented

2015-08-31 09:27:27 +02:00

Added subscriber: @ideasman42

Campbell Barton commented

2015-08-31 09:27:27 +02:00

Could you list which entries need to be updated?

It's no good to have tickets like this open - when its unclear whats needed.

Could you list which entries need to be updated? It's no good to have tickets like this open - when its unclear whats needed.

gandalf3 commented

2015-08-31 09:34:02 +02:00

@ideasman42 I'd like to solidify the definition of a "good glossary entry" first, otherwise such a list would just be based on my opinions.
I proposed the start of a style guide here: #45893.

@ideasman42 I'd like to solidify the definition of a "good glossary entry" first, otherwise such a list would just be based on my opinions. I proposed the start of a style guide here: #45893.

gandalf3 self-assigned this 2015-09-01 22:27:39 +02:00

gandalf3 commented

2015-09-01 22:27:39 +02:00

Editing description

gandalf3 removed their assignment 2015-09-01 22:39:34 +02:00

gandalf3 commented

2015-09-01 22:39:34 +02:00

@ideasman42 I added a list problematic entries (at least, the ones I noticed). Incidentally Non-manifold and Manifold both repeat the term immediately, however maybe this is okay given that they do this in order to specify meshes specifically?

@ideasman42 I added a list problematic entries (at least, the ones I noticed). Incidentally **Non-manifold** and **Manifold** both repeat the term immediately, however maybe this is okay given that they do this in order to specify *meshes* specifically?

gandalf3 self-assigned this 2015-09-03 02:58:16 +02:00

blender-admin commented

2015-09-10 10:36:36 +02:00

This issue was referenced by 591

gandalf3 commented

2015-09-10 10:41:08 +02:00

Changed status from 'Open' to: 'Resolved'

gandalf3 closed this issue

2015-09-10 10:41:08 +02:00

Sign in to join this conversation.

No Label

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Fix glossary entries with poor/misleading definitions or which don't follow the style guide #45895