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 <[email protected]>
OSC · Dec 20, 2024 · 800e7a1 · 800e7a1
1 parent 0ef6582
commit 800e7a1
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -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