Skip to content

Commit

Permalink
add docs for form_header (#1027)
Browse files Browse the repository at this point in the history
  • Loading branch information
johrstrom authored Nov 25, 2024
1 parent 501c68a commit 7f028eb
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
8 changes: 8 additions & 0 deletions source/how-tos/app-development/interactive/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,14 @@ This is the full list of items with details, you may supply to this yaml file to

whether or not the application is cacheable or not. Defaults to true.

.. _bc_form_header:
.. describe:: form_header (String)

New in 4.0.

Add a text header to the form. Note this is different from the
manifest's description as it does not appear as hoverover text.

.. _bc_form_attributes:

Attributes
Expand Down
16 changes: 14 additions & 2 deletions source/release-notes/v4.0-release-notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ New Features
- `noVNC quality and compression defaults`_
- `Batch connect sessions poll delay`_
- `System Status application`_
- `User mapping now accepts UIDs`
- `Remove runtime dependency on SCL`
- `User mapping now accepts UIDs`_
- `Interactive apps can have a text header`_
- `Remove runtime dependency on SCL`_

Thanks!
-------
Expand Down Expand Up @@ -338,6 +339,17 @@ User mapping scripts can now return a UID instead of a username.
This can be helpful for centers that have multiple domains and possible
username collisions.

Interactive apps can have a text header
.......................................

The item ``form_header`` can be added to intereactive applications
to display additional text in the form. Note this is different from
the ``manifest.yml``'s ``description`` field becuase it will not be
displayed on hoverover.

See the :ref:`form documentation for form_header <bc_form_header>`
for more details.

Remove runtime dependency on SCL
................................

Expand Down

0 comments on commit 7f028eb

Please sign in to comment.