[Bf-docboard-svn] bf-manual: [8547] trunk/blender_docs/manual: Geometry Nodes: Complete documentation in text category

[Hans Goudey]

Revision: 8547
          https://developer.blender.org/rBM8547
Author:   HooglyBoogly
Date:     2021-10-28 00:16:43 +0200 (Thu, 28 Oct 2021)
Log Message:
-----------
Geometry Nodes: Complete documentation in text category

Add two example images, and more detail to the string to curves page.

Modified Paths:
--------------
    trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_node.png
    trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_node.png
    trunk/blender_docs/manual/modeling/geometry_nodes/text/join_strings.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/text/replace_string.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/text/special_characters.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/text/string_to_curves.rst

Added Paths:
-----------
    trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_example.png
    trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_example.png

Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_example.png
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_example.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_example.png	2021-10-27 20:17:03 UTC (rev 8546)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_example.png	2021-10-27 22:16:43 UTC (rev 8547)

Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_example.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Modified: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_replace-string_node.png
===================================================================
(Binary files differ)

Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_example.png
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_example.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_example.png	2021-10-27 20:17:03 UTC (rev 8546)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_example.png	2021-10-27 22:16:43 UTC (rev 8547)

Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_example.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Modified: trunk/blender_docs/manual/images/modeling_geometry-nodes_text_string-to-curves_node.png
===================================================================
(Binary files differ)

Modified: trunk/blender_docs/manual/modeling/geometry_nodes/text/join_strings.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/text/join_strings.rst	2021-10-27 20:17:03 UTC (rev 8546)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/text/join_strings.rst	2021-10-27 22:16:43 UTC (rev 8547)
@@ -15,10 +15,10 @@
 
 .. tip::
 
-   This node can be used to create a multiline string for
-   the :doc:`String to Curves </modeling/geometry_nodes/text/string_to_curves>` node,
+   This node can be used to create a multi-line string for
+   the :doc:`/modeling/geometry_nodes/text/string_to_curves`,
    when combined with the line break output from
-   the :doc:`Special Characters </modeling/geometry_nodes/text/special_characters>` node.
+   the :doc:`/modeling/geometry_nodes/text/special_characters`.
 
 
 Inputs

Modified: trunk/blender_docs/manual/modeling/geometry_nodes/text/replace_string.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/text/replace_string.rst	2021-10-27 20:17:03 UTC (rev 8546)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/text/replace_string.rst	2021-10-27 22:16:43 UTC (rev 8547)
@@ -6,7 +6,7 @@
 *******************
 
 .. figure:: /images/modeling_geometry-nodes_text_replace-string_node.png
-   :align: center
+   :align: right
 
    The Replace String node.
 
@@ -37,3 +37,12 @@
 
 String
    Standard string output.
+
+
+Examples
+========
+
+.. figure:: /images/modeling_geometry-nodes_text_replace-string_example.png
+   :align: center
+
+   Using the node to add the new-line character to a string.
\ No newline at end of file

Modified: trunk/blender_docs/manual/modeling/geometry_nodes/text/special_characters.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/text/special_characters.rst	2021-10-27 20:17:03 UTC (rev 8546)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/text/special_characters.rst	2021-10-27 22:16:43 UTC (rev 8547)
@@ -15,9 +15,10 @@
 
 .. tip::
 
-   This node can be used to create a multiline string for
-   the :doc:`String to Curves </modeling/geometry_nodes/text/string_to_curves>` node,
-   when combined with the :doc:`Join Strings </modeling/geometry_nodes/text/join_strings>` node.
+   This node can be used to create a multi-line string for
+   the :doc:`/modeling/geometry_nodes/text/string_to_curves`,
+   when combined with the :doc:`/modeling/geometry_nodes/text/join_strings`
+   or the :doc:`/modeling/geometry_nodes/text/replace_string`.
 
 
 Inputs

Modified: trunk/blender_docs/manual/modeling/geometry_nodes/text/string_to_curves.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/text/string_to_curves.rst	2021-10-27 20:17:03 UTC (rev 8546)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/text/string_to_curves.rst	2021-10-27 22:16:43 UTC (rev 8547)
@@ -10,9 +10,20 @@
 
    String to Curves node.
 
-The *String to Curves* converts a string to curve geometry.
+The *String to Curves* converts a string to curve instances. Each unique character used in the string
+is converted to a curve once, and further uses of that character are more instances of the same geometry.
 
+This makes processing the output geometry very efficient, because each unique character only has to
+be processed once. However, it means that the result will be the same for every instance of the
+same character. To process each character individually,
+the :doc:`/modeling/geometry_nodes/instances/realize_instances` can be used.
 
+
+.. tip::
+
+   :doc:`Socket inspection </modeling/geometry_nodes/inspection>` can be used to see the value
+   of the string input used when the node was evaluated, by holding the mouse over the socket.
+
 Inputs
 ======
 
@@ -20,21 +31,27 @@
    Standard string input.
 
 Size
-   Size of the curve.
+   The size of each character. The values of the other inputs are scaled by this value.
 
 Character Spacing
-   A factor by which space between each character (kerning) is scaled in width.
+   A factor by which the space between each character (kerning) is scaled on the X axis.
 
 Word Spacing
-   A factor by which white-space between words is scaled in width.
+   A factor by which white-space between words is scaled on the X axis.
 
 Line Spacing
-   A factor by which the vertical space between lines is scaled.
+   The distance between separate lines in the output. Scaled by the *Size* input.
 
 Max Width
-   Maximum width of the text
+   Maximum width of the text, applies when the *Overflow* mode is set to *Overflow*.
 
+Text Box Width
+   The maximum width of each line, though individual words will not be wrapped.
 
+Text Box Height
+   The maximum height for all the lines of the text.
+
+
 Properties
 ==========
 
@@ -42,9 +59,14 @@
    Font glyph used to generate the curve.
 
 Overflow
-   :Overflow: Allows the text to use more space than the specified height.
-   :Scale To Fit: Scales the text size to fit the width and height.
-   :Truncate: Only outputs curves that fit within the width and height.
+   :Overflow:
+      Allows the text to use more space than the specified height. The width of the output is
+      still constrained by the *Max Width* input though.
+   :Scale To Fit:
+      Scales the text size to fit the width and height.
+   :Truncate: 
+      Only outputs text characters that fit within the width and height, based on the *Size* input.
+      Any part of the string that did not fit is moved to the *Remainder* output.
 
 Alignment
    :Left: Aligns the text to the left.
@@ -65,4 +87,18 @@
 =======
 
 Curves
-   Generated curve.
+   Curve instances geometry.
+
+Remainder
+   The part of the text that did not fit in the box described by the *Text Box Height* and
+   *Text Box Width* inputs. Only used in the *Truncate* overflow mode.
+
+Examples
+========
+
+.. figure:: /images/modeling_geometry-nodes_text_string-to-curves_example.png
+   :align: center
+
+The node can be used to make overflowing text boxes. Here, the text that 
+does not fit into the first node's hard-coded text box is passed to a
+separate string to curves node and added with a scale to fit node.
\ No newline at end of file