From 800e7a1864ec03f2d7372582c16f3d0d9951bdd9 Mon Sep 17 00:00:00 2001
From: James Willis <36906682+james-s-willis@users.noreply.github.com>
Date: Fri, 20 Dec 2024 12:00:44 -0500
Subject: [PATCH] Document the display option of an attribute. (#1037)

add interactive/advanced.rst

Add a page for advanced interactive application options to
highlight some things that could be buried in the documentation.

And highligh the display attribute for readers who've missed it.

---------

Co-authored-by: Jeff Ohrstrom <johrstrom@osc.edu>
---
 .../modify-form-attributes.rst                |  2 ++
 .../how-tos/app-development/interactive.rst   |  1 +
 .../app-development/interactive/advanced.rst  | 25 +++++++++++++++++++
 .../app-development/interactive/form.rst      |  2 ++
 4 files changed, 30 insertions(+)
 create mode 100644 source/how-tos/app-development/interactive/advanced.rst

diff --git a/source/enable-desktops/modify-form-attributes.rst b/source/enable-desktops/modify-form-attributes.rst
index c878a40b1..23152480c 100644
--- a/source/enable-desktops/modify-form-attributes.rst
+++ b/source/enable-desktops/modify-form-attributes.rst
@@ -310,3 +310,5 @@ really have any meaning in the LinuxHost Adapter.
 
 .. _ruby string: https://ruby-doc.org/core-2.2.0/String.html
 .. _markdown: https://en.wikipedia.org/wiki/Markdown
+   
+
diff --git a/source/how-tos/app-development/interactive.rst b/source/how-tos/app-development/interactive.rst
index c1133e197..ce575b263 100644
--- a/source/how-tos/app-development/interactive.rst
+++ b/source/how-tos/app-development/interactive.rst
@@ -47,3 +47,4 @@ Each of these files/directories are described below in their respective stage.
    interactive/conn-params
    interactive/additional-info
    interactive/saved-settings
+   interactive/advanced
diff --git a/source/how-tos/app-development/interactive/advanced.rst b/source/how-tos/app-development/interactive/advanced.rst
new file mode 100644
index 000000000..26e7dd0e9
--- /dev/null
+++ b/source/how-tos/app-development/interactive/advanced.rst
@@ -0,0 +1,25 @@
+.. _app-development-interactive-advanced:
+
+Advanced Interactive Application Configurations
+===============================================
+
+Now that you have an application up and running,
+here are some advanced features you can use.
+
+Displaying choices made in Session Card
+---------------------------------------
+
+If you want to show a form attribute in the session card, you can set the
+:ref:`display <display_option>` option to ``true``. For example, to show the 
+version of R selected edit ``form.yml`` with:
+
+.. code-block:: yaml
+  :emphasize-lines: 3
+
+  attributes:
+    r_version:
+      display: true # Displays the choice in the card
+      widget: "select"
+      options:
+        - "4.2"
+        - "4.1"
diff --git a/source/how-tos/app-development/interactive/form.rst b/source/how-tos/app-development/interactive/form.rst
index 1fed24955..84ef8b92d 100644
--- a/source/how-tos/app-development/interactive/form.rst
+++ b/source/how-tos/app-development/interactive/form.rst
@@ -592,6 +592,8 @@ are:
 
           cacheable: false
 
+.. _display_option:
+
 .. describe:: display (Boolean, false)
 
      whether the form item should be displayed in the session card after it was created.