From 2d58cf35b4cacf629d0c7cab7cdf96fd0c5695bf Mon Sep 17 00:00:00 2001 From: james-s-willis Date: Tue, 10 Dec 2024 16:00:53 -0500 Subject: [PATCH 1/4] Added documentation for display option, so that form attributes show up in session card. --- .../enable-desktops/modify-form-attributes.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/source/enable-desktops/modify-form-attributes.rst b/source/enable-desktops/modify-form-attributes.rst index c878a40b1..9c9ce2134 100644 --- a/source/enable-desktops/modify-form-attributes.rst +++ b/source/enable-desktops/modify-form-attributes.rst @@ -310,3 +310,21 @@ 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 + +Show Form Attribute in Session Card +----------------------------------- + +If you want to show a form attribute in the session card, you can set the +``display`` option to ``true``. For example, to show the version of R selected +edit ``form.yml`` with: + +.. code-block:: yaml + :emphasize-lines: 5- + + attributes: + r_version: + display: true # Shows the choice in the card + widget: "select" + options: + - "4.2" + - "4.1" From c49d0a46d4b7ace1cb77562e1d138e26757da6b5 Mon Sep 17 00:00:00 2001 From: james-s-willis Date: Wed, 11 Dec 2024 14:41:10 -0500 Subject: [PATCH 2/4] Moved section to Interactive App development page. --- .../enable-desktops/modify-form-attributes.rst | 16 ---------------- .../app-development/interactive/form.rst | 2 ++ .../app-development/interactive/view.rst | 18 ++++++++++++++++++ 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/source/enable-desktops/modify-form-attributes.rst b/source/enable-desktops/modify-form-attributes.rst index 9c9ce2134..23152480c 100644 --- a/source/enable-desktops/modify-form-attributes.rst +++ b/source/enable-desktops/modify-form-attributes.rst @@ -311,20 +311,4 @@ 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 -Show Form Attribute in Session Card ------------------------------------ -If you want to show a form attribute in the session card, you can set the -``display`` option to ``true``. For example, to show the version of R selected -edit ``form.yml`` with: - -.. code-block:: yaml - :emphasize-lines: 5- - - attributes: - r_version: - display: true # Shows 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 1ddf0b11e..89e8578f8 100644 --- a/source/how-tos/app-development/interactive/form.rst +++ b/source/how-tos/app-development/interactive/form.rst @@ -552,6 +552,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. diff --git a/source/how-tos/app-development/interactive/view.rst b/source/how-tos/app-development/interactive/view.rst index 5f91bada7..554beb05b 100644 --- a/source/how-tos/app-development/interactive/view.rst +++ b/source/how-tos/app-development/interactive/view.rst @@ -57,6 +57,24 @@ Typically these attributes are used to construct links or forms within the ``view.html.erb`` file. See the various :ref:`app-development-interactive-view-examples` below. +Show Form Attribute in Session Card +----------------------------------- + +If you want to show a form attribute in the session card, you can set the +:ref:`display ` option to ``true``. For example, to show the +version of R selected edit ``form.yml`` with: + +.. code-block:: yaml + :emphasize-lines: 5- + + attributes: + r_version: + display: true # Shows the choice in the card + widget: "select" + options: + - "4.2" + - "4.1" + Reverse Proxy ------------- From 9289b120d6a9391033999a76f649e542e0d97e0d Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Fri, 20 Dec 2024 11:45:55 -0500 Subject: [PATCH 3/4] reset view.rst --- .../app-development/interactive/view.rst | 18 ------------------ 1 file changed, 18 deletions(-) diff --git a/source/how-tos/app-development/interactive/view.rst b/source/how-tos/app-development/interactive/view.rst index 554beb05b..5f91bada7 100644 --- a/source/how-tos/app-development/interactive/view.rst +++ b/source/how-tos/app-development/interactive/view.rst @@ -57,24 +57,6 @@ Typically these attributes are used to construct links or forms within the ``view.html.erb`` file. See the various :ref:`app-development-interactive-view-examples` below. -Show Form Attribute in Session Card ------------------------------------ - -If you want to show a form attribute in the session card, you can set the -:ref:`display ` option to ``true``. For example, to show the -version of R selected edit ``form.yml`` with: - -.. code-block:: yaml - :emphasize-lines: 5- - - attributes: - r_version: - display: true # Shows the choice in the card - widget: "select" - options: - - "4.2" - - "4.1" - Reverse Proxy ------------- From 4334cedc19263b53f2306c36f5caca1434b152aa Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Fri, 20 Dec 2024 11:52:21 -0500 Subject: [PATCH 4/4] add interactive/advanced.rst Add a page for advanced interactive application options to highlight some things that could be buried in the documentation. --- .../how-tos/app-development/interactive.rst | 1 + .../app-development/interactive/advanced.rst | 25 +++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 source/how-tos/app-development/interactive/advanced.rst diff --git a/source/how-tos/app-development/interactive.rst b/source/how-tos/app-development/interactive.rst index 10f09e0e0..2e88eda75 100644 --- a/source/how-tos/app-development/interactive.rst +++ b/source/how-tos/app-development/interactive.rst @@ -46,3 +46,4 @@ Each of these files/directories are described below in their respective stage. interactive/sub-apps interactive/conn-params interactive/additional-info + 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 ` 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"