Merge branch 'master' of git.freeside.biz:/home/git/freeside

[freeside.git] / rt / docs / extending / external_custom_fields.pod

diff --git a/rt/docs/extending/external_custom_fields.pod b/rt/docs/extending/external_custom_fields.pod
index c6730ae..5e70d3e 100644 (file)
--- a/rt/docs/extending/external_custom_fields.pod
+++ b/rt/docs/extending/external_custom_fields.pod
@@ -13,7 +13,7 @@ For each type of data source that you want, you'll need to put a file in
 F</opt/rt4/local/lib/RT/CustomFieldValues/> (or equivalent if you
 installed RT into someplace other than F</opt/rt4>). To get a sense of
 the code that you'll need to write, take a look at the code in
-L</opt/rt4/lib/RT/CustomFieldValues/Groups.pm> for a simple example
+F</opt/rt4/lib/RT/CustomFieldValues/Groups.pm> for a simple example
 which just uses RT's API to pull in a list of RT's groups.
 
 Running C<perldoc /opt/rt4/lib/RT/CustomFieldValues/External.pm> will
@@ -57,6 +57,10 @@ web interface. See L</Configuration>.
 This method should return an array reference of hash references.  The
 hash references should contain keys for C<name>, C<description>, and
 C<sortorder>. C<name> is most important one; the others are optional.
+You can also optionally provide a key for C<category> and use the
+"Categories are based on" option on the custom field configuration
+page to make the values displayed for this custom field vary based
+on the value selected in the "based on" custom field.
 
 =back
 
@@ -77,9 +81,9 @@ Here's a simple static example:
       # return reference to array ([])
       return [
           # each element of the array is a reference to hash that describe a value
-          # possible keys are name, description and sortorder
-          { name => 'value1', description => 'external value', sortorder => 1 },
-          { name => 'value2', description => 'another external value', sortorder => 2 },
+          # possible keys are name, description, sortorder, and category
+          { name => 'value1', description => 'external value', sortorder => 1, category => 'Other CF' },
+          { name => 'value2', description => 'another external value', sortorder => 2, category => 'Other CF' },
           # values without description are also valid, the default description is empty string
           { name => 'value3', sortorder => 3 },
           # you can skip sortorder too, but note that the default sortorder is 0 (zero)