Page MenuHome

Fix glossary entries with poor/misleading definitions or which don't follow the style guide
Closed, ResolvedPublic

Description

Once a solid definition is put on what makes a well written glossary entry (T45893), 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:

EntryReason
ActiveNo definition
Straight AlphaDefinition not first
Premultiplied AlphaDefinition not first
Ambient Light"It's", and could use a rewrite (where did this desk come from?)
BakingRepetition
BooleanAvoid using numerical characters in place of words (s/2/two)
Bump MappingCould use some simplification
Bézier"It's"
CausticsVery wordy, can be condensed
Collapse"Is"
Color Blend Modess/2/two
Constraint"It's"
Crease"It's"
Curve"It's"
Depth Of Field"It's"
Diffuse Light"It's"
Directional Light"Is"
Double BufferNo definition (well described otherwise though)
Edges/2/two
Edge Rings/2/two
Full-Screen Anti-AliasingDefinition not first
GammaIncomplete
Geometric CenterUses term in definition
Global Illumination"Is"
Index Of Refraction"It's"
Inverse Kinematics"Is"
Keyframe"It's"
LatticeRepetition
Motion Blur"It's"
Ngon"It's"
NURBS"Is"
OverscanRepetition
Particle system"It's"
Pivot Point"It's"
Pole"It's"
Primitive"Is"
Quad"It's"
Radiosity"Is"
Refraction"It's"
Relative Vertex KeysNo clear definition
Subdividing"It's"
Subdivision surface"Is"
TessellationIncomplete
TextureRepetition
Triangle"It's"
UV mapRepetition
Vertex"It's"
Vertex GroupNo clear definition

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

Revisions and Commits

Event Timeline

Kitt Zwovic (gandalf3) raised the priority of this task from to 90.
Kitt Zwovic (gandalf3) updated the task description. (Show Details)
Kitt Zwovic (gandalf3) edited a custom field.
Bastien Montagne (mont29) lowered the priority of this task from 90 to Normal.Aug 25 2015, 12:03 PM

Could you list which entries need to be updated?

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

@Campbell Barton (campbellbarton) 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: T45893.

Editing description

@Campbell Barton (campbellbarton) 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?

Campbell Barton (campbellbarton) raised the priority of this task from 30 to Normal.Sep 2 2015, 5:32 AM
Campbell Barton (campbellbarton) updated the task description. (Show Details)
Kitt Zwovic (gandalf3) changed the task status from Unknown Status to Resolved by committing rBM591: Fix T45895.Sep 10 2015, 10:41 AM