[Rt-commit] rt branch, 5.0/custom-field-docs, created. rt-5.0.0alpha1-31-g5bf7534708

Craig Kaiser craig at bestpractical.com
Wed Mar 25 09:07:33 EDT 2020


The branch, 5.0/custom-field-docs has been created
        at  5bf7534708489de82d39dd8e3fd261bf5a8c22c1 (commit)

- Log -----------------------------------------------------------------
commit 5bf7534708489de82d39dd8e3fd261bf5a8c22c1
Author: Craig Kaiser <craig at bestpractical.com>
Date:   Wed Mar 25 07:58:05 2020 -0400

    Create user-level docs for custom fields categories feature

diff --git a/docs/custom_field.pod b/docs/custom_field.pod
new file mode 100644
index 0000000000..70a69b6f62
--- /dev/null
+++ b/docs/custom_field.pod
@@ -0,0 +1,53 @@
+=head1 NAME
+
+    RT::CustomField
+
+=head1 Categories
+
+Categories allows for RT Custom Fields to be based on one another. Such
+that by choosing values for a parent field a child fields options can be
+restricted. To create these linked fields first create a parent Custom Field.
+Choose a Custom Field L<Type|/"SUPPORTED TYPES"> that supports C<Categories>
+then save the new custom field. From there the child can choose a parent Custom
+Field under the C<Categories Based On> drop down menu. Then when addding values to
+the child class there is a C<Categories> coloumn that links the new value to the
+parent custom field value.
+
+=head2 SUPPORTED TYPES
+
+=over
+
+=item Types:
+
+  Combobox: Select or enter one value
+  Select one value
+  Select multiple values
+
+=back
+
+=head2 Walkthrough
+
+First we make our parent Custom Field. This field C<States> will dictate
+the values available for the C<Cities> Custom Field. We enter our values
+into the custom field.
+
+=for html <img alt="Custom Fields parent class" src="images/cf-categories-states.png" width="75%" style="border: #00008B 1px solid;">
+
+Then we create the child custom field C<Cities> and choose it to have
+C<Category> based on C<States>. Now when we enter value options for the
+C<Cities> custom field where we relate each value to a value from the
+C<States> custom field in the C<Categories> column.
+
+=for html <img alt="Custom Fields child class" src="images/cf-categories-cities.png" width="75%" style="border: #00008B 1px solid;">
+
+We can then see on the ticket create page that until we select a value for
+C<States> the C<Cities> custom field is greyed out.
+
+=for html <img alt="Create ticket with CustomFields" src="images/cf-categories-no-select.png" width="75%" style="border: #00008B 1px solid;">
+
+After choosing a value for C<States> custom field our options for the C<Cities>
+custom field are reduced to only the applicable values.
+
+=for html <img alt="Parent CustomField value chosen" src="images/cf-categories-limited-cities.png" width="75%" style="border: #00008B 1px solid;">
+
+=cut
diff --git a/docs/images/cf-categories-cities.png b/docs/images/cf-categories-cities.png
new file mode 100644
index 0000000000..0ed0249be2
Binary files /dev/null and b/docs/images/cf-categories-cities.png differ
diff --git a/docs/images/cf-categories-limited-cities.png b/docs/images/cf-categories-limited-cities.png
new file mode 100644
index 0000000000..e2d3157978
Binary files /dev/null and b/docs/images/cf-categories-limited-cities.png differ
diff --git a/docs/images/cf-categories-no-select.png b/docs/images/cf-categories-no-select.png
new file mode 100644
index 0000000000..29da6f3843
Binary files /dev/null and b/docs/images/cf-categories-no-select.png differ
diff --git a/docs/images/cf-categories-states.png b/docs/images/cf-categories-states.png
new file mode 100644
index 0000000000..2b1735efbb
Binary files /dev/null and b/docs/images/cf-categories-states.png differ

-----------------------------------------------------------------------


More information about the rt-commit mailing list