Page MenuHome

Line Art manual page
ClosedPublic

Authored by YimingWu (NicksBest) on Mar 17 2021, 7:57 AM.

Details

Summary

This is the manual page I intended to include with line art for the merged initial version :D

Necessary images are uploaded below:

Diff Detail

Repository
rBM Blender Manual

Event Timeline

There are a very large number of changes, so older changes are hidden. Show Older Changes

@YimingWu (NicksBest) All manual images should be done using the default Blender Dark theme

Sebastian Parborg (zeddb) added inline comments.
manual/grease_pencil/modifiers/generate/lineart.rst
10

I don't think we should do comparisons like this with other features in blender in the manual.

14

I really like the FAQ!

However I think that it should be in the manual and not link to a website.
This way the FAQ will always be the correct one for the blender manual version in question.

Perhaps we can have a FAQ section here instead?
But I'm not sure if we have any policy about this.

Do we have and rules about adding FAQ sections to the manual @Aaron Carlisle (Blendify) ?

63

options -> option

Also I don't thinks mentioning "industrial softwares" here is relevant.
It doesn't matter where the imported geometry is from. What matters is that the imported geometry had their edges split so two edges occupy the exact same space.

So I think this should be:

This option allows overlapping edges (e.g. from an edge split modifier or imported geometry where two edges occupy the exact same space)

93

a occlusion -> an occlusion

102

You do not mention that the occlusion bits are from the face material.
I think you should mention that here.

184

If use Bake Line Art(All), all
Should be:
Bake Line Art(All) bakes all

207

baked stroke -> baked strokes

I would also suggest that we add the following image (perhaps with some draw over scribbles to show the material mask numbers) to the occlusion transparency section:

YimingWu (NicksBest) marked 6 inline comments as done.Mar 18 2021, 1:14 AM

Cleaned up...

manual/grease_pencil/modifiers/generate/lineart.rst
14

I'll leave it as is for the moment until we have a better solution :D

@Hans Goudey (HooglyBoogly) The UI part you got the Clip checkbox wrong, should be Soft Selection, or otherwise the checkbox will have inverted logic (enabling the checkbox should allow weight to be passed through directly without being forced to 1).

Updated the manual text to reflect the changes and also new images except the vertex group one.

@Hans Goudey (HooglyBoogly) The UI part you got the Clip checkbox wrong, should be Soft Selection, or otherwise the checkbox will have inverted logic (enabling the checkbox should allow weight to be passed through directly without being forced to 1).

You're right, I got that backwards, sorry about that. However, I think the behavior should be reversed then. "Clamping" or "Clipping" is the action, and it seems like the check-box should enable turn it on rather than turn it off. The default state could be set either way to make that work. What do you think about that?

For example, the clamp check-box in some nodes:

Oh yeah... that way it's more consistent with the rest of the blender. But the operation here still isn't "clipping" though, it's treat all non-zero weights as 1 (act like a selection), so what do you think would be the best way to express this?

Updated to reflect on current changes:

  • Removal of geometry chaining threshold.
  • "Clip" changed to "Binary Weights"

Images are updated below:

Hans Goudey (HooglyBoogly) requested changes to this revision.Mar 22 2021, 7:40 PM

It would be nice to use consistent capitalization for "line art". I think I would go with not capitalizing it.

manual/grease_pencil/modifiers/generate/lineart.rst
14

Why would it be bad to have a FAQ in the manual? As long as the information is helpful and relevant and not too much of a burden to maintain, isn't that exactly what the manual is for?

I'm also not a big fan of linking to your personal wiki page here.

27–28

It's best to avoid phrasing these descriptions in second person. Maybe the tooltips have changed since you wrote this manual page, looking at the property description in RNA might be helpful.

41

This should have a list of the different edge types short descriptions.

45

Isn't it "edge angles" actually? And what is "treated as crease" supposed to mean? The important part is that edges with angles above this value are included in the result.

49–53

Let's link to the manual page for grease pencil layers and materials here.

57

typo

62–63

Either this is an incomplete sentence or it's missing a period.

64

What is "quite well" supposed to mean? Either expand on that and make it specific or remove it.

75–76

Just about precise, correct wording here: the thickness is not "used' to generate the strokes, the strokes generated by line art are given this thickness.

Same with opacity.

92

The most important question for me: "What even is an occlusion level?" Without an explanation from one of you I don't think I would have any idea.

97

Unnecessary word.

102

Unnecessary words

124

Unnecessary words

133

Grammar: being -> to be

140–141

I think this was removed or its name changed, right?

164

Should be plural

164

"that has" -> "with"

164

Should be plural

169

This changed too, right?

174

Typo

187

I think italics are preferred instead of backticks.

189

typo: deactivated

206

Be specific about "range", "frame range" is more specific.

212

"On multiple portions of frames separately" is a bit clearer I think.

This revision now requires changes to proceed.Mar 22 2021, 7:40 PM
Aaron Carlisle (Blendify) requested changes to this revision.Mar 23 2021, 3:41 AM

There are some fixes to the page titles that should be made.

manual/grease_pencil/modifiers/generate/lineart.rst
5–7
14

Adding the FAQ here is fine, and I prefer that also.

19–20
67–68
83–84
115–116
150–151
178–179
YimingWu (NicksBest) marked 31 inline comments as done.

Updated to fix those commented and for the confirmed UI. Relevant images are uploaded below:

manual/grease_pencil/modifiers/generate/lineart.rst
45

I'm not sure about the English grammar here... Can you say "edge angles"? Can a edge have an angle? How best to describe it?

Yes, you can say edge angle.

manual/grease_pencil/modifiers/generate/lineart.rst
14

FAQ is still not in the manual but linked to an other webpage...

I started working on rB3e87d8a4315d794efff659e40f0bb9e34e2aec8a in rBM7942 the line art sub panel still needs text for 2.93.

Okay yeah I'll update document for that part as well.

YimingWu (NicksBest) marked an inline comment as done.

Updated manual for:

  • Object line art panel
  • Material line art panel
  • Collection tab
  • Minor fixes

Extra images here:

Other than me new remarks, I think it looks fine.

manual/grease_pencil/modifiers/generate/lineart.rst
16

Solutions are being implemented at the moment.

I think it probably should be:
There are plans to remedy this in the future, but this is a known limitation for now.

179

This explanation for how it works when "match output" is off is quite confusing.

I would replace:

Otherwise, a single Target is required to receive the weight info, if multiple
weights are present, the higher one will be stored in Target.`

With:

If Match Output is off, then a Target vertex group has to be specified.
If there are multiple weight groups copied into Target, then the highest weight value is copied into it.

I would move this explanation into it's own Target section.

So you would have Filter Source, Match Output and Target.

manual/scene_layout/collections/properties.rst
48 ↗(On Diff #36246)

Child object can have line art :ref:lineart_object-usage value overriding collection's setting.

Should be:

Child objects of the collection can override this setting if they wish in :ref:lineart_object-usage.

YimingWu (NicksBest) marked 3 inline comments as done.

Updated for better grammer

I think this looks good to me now.

@Aaron Carlisle (Blendify) @Hans Goudey (HooglyBoogly) do you guys have anything to remark on?

manual/grease_pencil/modifiers/generate/lineart.rst
15–16

the evaluation will take much longer.

16

extra \

42–47

I think a different format for these lists is usually used, like this:

Type
   :Attribute:
      Use the values from the attribute to move each point by a different amount.
   :Float:
      Use a single value to translate every single point. This is a shortcut for assigning the same value
      for the X, Y, and Z components of the vector input, and allows adjusting the scale in a uniform way.
   :Vector:
      Use a single vector to translate every single point.
64

Only one empty line is necessary between properties.

67

threashold -> threshold

76

particles and other instanced objects Particles are not a type of instanced object, I'd change it to "particle instances", though I'm not even sure talking about particles is necessary.

109

has -> have

122

I still think you shouldn't refer to these as "bits" in the UI or the manual. Now I don't think they're called bits in the UI, seems like the manual should reflect that.
In the UI they are called "Masks" plural, I think that would work here.

126

Extra "all"

174

will get -> will be

207

extra -> manually

I think that's clearer in this case.

manual/scene_layout/collections/properties.rst
47 ↗(On Diff #36312)

I don't think we need do be documenting defaults.

YimingWu (NicksBest) marked 14 inline comments as done.

Fixed stuff pointed out in the comments

This revision is now accepted and ready to land.Apr 22 2021, 8:49 PM

This has been committed to the 2.93 branch