Page MenuHome

Sculpting & Painting: High level changes and new Sculpting Introduction page
ClosedPublic

Authored by Julien Kaspar (JulienKaspar) on Oct 25 2022, 2:31 PM.

Details

Summary

This patch includes the some structural changes for the sculpt_paint manual.
A lot of duplicated and scattered information is avoided this way.
It will also be the base for rewriting various sections to update outdated pages and make the manual more accessible.
Here's a list of the various changes in this patch.

Sculpting & Painting:

  • Moved information about "Selection Masking" and visibility control out of "Brush", and instead into their own page called "Selection & Visibility"
  • Various wording updates to make the selection masking page more accurate
  • Small updates to the Introduction to make the information more accurate

Brush Settings:

  • Merged all "Brush Settings" pages of the painting and sculpting modes into one page. All the mode specific pages now link to the root page.
  • Removed the "Texture Mask" page and instead added necessary information to the "Texture" page. This avoids a lot of duplication.

Sculpting:

  • Added brief introductions about all the major features of sculpt mode. Various high level information from "Tool Settings", "Tools" and "Editing" was moved here, as well as a lot of new information, to give a birds eye overview and avoid scattering vital information.
  • Introduction.rst was split into various introduction pages for easier reading
  • The introduction page is more heavily linking to other UI references for specific information
  • Removed the "Adaptive" page, since its information has moved to the introduction.
  • Categorized the toolbar page for an easier overview of related features and the logic behind the order
  • Moved Topology Rake documentation from Dyntopo page to Brush Settings
  • Added and updated various visual examples
  • Various other small changes to outdated information and shortcuts

Diff Detail

Event Timeline

Julien Kaspar (JulienKaspar) requested review of this revision.Oct 25 2022, 2:31 PM
Julien Kaspar (JulienKaspar) created this revision.
Julien Kaspar (JulienKaspar) created this object with visibility "Julien Kaspar (JulienKaspar)".
Julien Kaspar (JulienKaspar) created this object with edit policy "Julien Kaspar (JulienKaspar)".
  • Fleshed out the sculpt mode introduction further
  • Moved general information from remesh and dyntopo to introduction
  • More general structural changes
  • Wrapped up first iteration of sculpt introduction
  • Merged brush settings pages to avoid duplication
Julien Kaspar (JulienKaspar) retitled this revision from WIP sculpt manual drafting to Sculpting & Painting: High level changes and new Sculpting Introduction page.Oct 31 2022, 4:42 PM
Julien Kaspar (JulienKaspar) edited the summary of this revision. (Show Details)
Julien Kaspar (JulienKaspar) edited the summary of this revision. (Show Details)

Added all missing links to the new sculpt mode introduction.

  • Removed conflicts with recently committed auto-masking additions (D16329)
  • Split introduction into multiple pages for easier reading
  • Added recommendation and summary of commonly used sculpting brushes
  • Removed outdated shortcuts from Sculpt page
  • Various other adjustments on new introduction pages
  • Added temp hidden comments of necessary images that need to be added
Julien Kaspar (JulienKaspar) planned changes to this revision.Nov 3 2022, 1:59 PM
  • Added rewrites and added information for navigation page
  • Fixed outdated/confusing info on brush settings pages
  • Started writing more information and context on the Editing pages
  • Added more temp comments of needed images

I'll remove any reviewers for now, until the main pages are done and visual material is added.

I have one comment about a page that was removed and one more about some an guide to follow the syntax style guide.

manual/sculpt_paint/brush/texture_mask.rst
1–71 ↗(On Diff #57232)

I am curious why this file was removed? It is still relevant for texture masking.

While they share a lot of similar properties with the other texturing page, there are some properties specific to this panel such as "Pressure Masking" and "Mask Mapping".

The documentation also needs to be improved on the difference between the "Texture" and "Texture Mask" panels.

manual/sculpt_paint/sculpting/toolbar.rst
179–180 ↗(On Diff #57232)

Small styling change: make the title syntax match the length of the text.

I added back some lost information from the removed Texture Mask page.
The information was also rewritten to be a bit clearer on the behavior.

@Aaron Carlisle (Blendify) I removed the Texture Mask page since it was almost completely a duplicate of the Texture page,
with the exception of "Pressure Masking", which I added back,
and minor differences between "Mapping" and "Mask Mapping", which I clarified now.

I also updated the header style to follow the syntax.

Julien Kaspar (JulienKaspar) marked an inline comment as done.Nov 7 2022, 5:50 PM
manual/sculpt_paint/brush/texture_mask.rst
1–71 ↗(On Diff #57232)

I can make the start of the page clearer on the difference between "Texture" and "Texture Mask", especially with an added image.

Since the two pages share almost all the same information it makes sense to me to merge them. The few settings that are difference, now clarify this.
In this patch I propose something very similar with the brush settings, where a few pages are merged and any mode difference is mentioned.
You think this is ok?

Aaron Carlisle (Blendify) requested changes to this revision.Nov 8 2022, 8:55 PM
Aaron Carlisle (Blendify) added inline comments.
manual/sculpt_paint/brush/texture.rst
3–5 ↗(On Diff #57327)
33–35 ↗(On Diff #57327)

This is called "Mapping" in the "Texture" panel and "Mask Mapping" in the "Texture Mask" panel; there should also be text in the description that denotes this difference.

98–100 ↗(On Diff #57327)

Add the RNA reference so that the context sensitive online manual lookup works.

manual/sculpt_paint/sculpting/controls.rst
155–161 ↗(On Diff #57327)

Looks like some complications from a merge conflict.

manual/sculpt_paint/sculpting/editing/sculpt.rst
51 ↗(On Diff #57327)

You can just use bpy.ops.sculpt.set_pivot_position as the reference.

87 ↗(On Diff #57327)

This needs to get moved with the "Rebuild BVH" heading

This revision now requires changes to proceed.Nov 8 2022, 8:55 PM

Various updates to finalise the patch

  • Addressed inline comments
  • Added and edited images for various pages
  • Fleshed out "Visibility, Masking & Face Sets" introduction page further
  • Removed leftover comments
Julien Kaspar (JulienKaspar) marked 6 inline comments as done.Dec 16 2022, 5:20 PM
Julien Kaspar (JulienKaspar) edited the summary of this revision. (Show Details)
This revision is now accepted and ready to land.Dec 21 2022, 2:08 AM