From 4f6c984f48358fdf8dfefcb05c8d8c77b56f57e7 Mon Sep 17 00:00:00 2001
From: Brendan Hagan <bhaganksu@gmail.com>
Date: Fri, 1 Jul 2022 20:44:00 -0400
Subject: [PATCH] misc: extra_data doc entry

---
 doc/function/extra_data.txt | 27 +++++++++++++++++++++++++++
 doc/function/index.txt      |  3 ++-
 2 files changed, 29 insertions(+), 1 deletion(-)
 create mode 100644 doc/function/extra_data.txt

diff --git a/doc/function/extra_data.txt b/doc/function/extra_data.txt
new file mode 100644
index 00000000..1f5b754e
--- /dev/null
+++ b/doc/function/extra_data.txt
@@ -0,0 +1,27 @@
+Function: extra_data
+
+DOC_MSE_VERSION: since 2.2.0
+
+--Usage--
+> extra_data("field_name")
+
+Access the value of extra card fields.
+
+Due to lazy initialization of stylesheet specific Extra Card Fields they are not exposed directly from the card using `card.field_name` syntax.
+As a workaround this function returns the Value of the specified field name for the active card using an access pattern that supports late resolution of the value for the active stylesheet.
+
+--Parameters--
+! Parameter	Type	Description
+| @input@	[[type:string]]	Field name, with or without underscores.
+
+--Examples--
+
+>extra card field:
+>	...
+>	name: my first extra field
+>
+>extra card field:
+>	...
+>	name: my second extra field
+>	script:
+>>		space_to_comma(extra_data("my first extra field")) + "!"
diff --git a/doc/function/index.txt b/doc/function/index.txt
index 700fdf7d..254fd71d 100644
--- a/doc/function/index.txt
+++ b/doc/function/index.txt
@@ -65,7 +65,8 @@ These functions are built into the program, other [[type:function]]s can be defi
 | [[fun:english_plural|english_singular]]		Find the singular of a word, @"cards" -> "card"@.
 | [[fun:process_english_hints]]				Process the hints left by english_ functions in a keyword's reminder text.
 	
-! Fields and values			<<<
+! Fields and values			<<<
+| [[fun:extra_data]]	Access the value of extra card fields.
 | [[fun:combined_editor|forward_editor]]	Use one field to edit another.
 | [[fun:combined_editor]]		Use one field to edit multiple others.
 | [[fun:primary_choice]]		Return the top level choice chosen from a choice field.