From 7909fe8a60e46b06f66df279a252b4c9617cce19 Mon Sep 17 00:00:00 2001 From: Luka Stocker Date: Mon, 21 Oct 2024 17:04:04 +0200 Subject: [PATCH] UI: Testsuite for UI components - adding missing descriptions and expected output to examples. --- src/UI/examples/Breadcrumbs/breadcrumbs.php | 19 ++++ src/UI/examples/Button/Bulky/base.php | 27 ++++- src/UI/examples/Button/Bulky/engaged.php | 22 +++- .../Button/Bulky/unavailable_action.php | 18 ++- src/UI/examples/Button/Bulky/with_tooltip.php | 22 +++- src/UI/examples/Button/Close/base.php | 23 +++- src/UI/examples/Button/Close/modal.php | 19 +++- src/UI/examples/Button/Minimize/base.php | 16 +++ src/UI/examples/Button/Month/base.php | 27 ++++- src/UI/examples/Button/Primary/base.php | 25 ++++- src/UI/examples/Button/Primary/engaged.php | 21 +++- .../Button/Primary/unavailable_action.php | 19 +++- .../Button/Primary/with_load_anim.php | 23 +++- .../examples/Button/Primary/with_tooltip.php | 22 +++- src/UI/examples/Button/Shy/base.php | 25 ++++- src/UI/examples/Button/Shy/engaged.php | 21 +++- .../Button/Shy/unavailable_action.php | 19 +++- src/UI/examples/Button/Shy/with_tooltip.php | 22 +++- src/UI/examples/Button/Standard/base.php | 25 ++++- src/UI/examples/Button/Standard/engaged.php | 22 +++- .../Button/Standard/unavailable_action.php | 19 +++- .../Button/Standard/with_js_binding.php | 21 +++- .../Button/Standard/with_load_anim.php | 20 +++- .../examples/Button/Standard/with_tooltip.php | 22 +++- src/UI/examples/Button/Tag/base.php | 30 ++++- src/UI/examples/Button/Tag/engaged.php | 21 +++- src/UI/examples/Button/Tag/with_tooltip.php | 21 +++- src/UI/examples/Button/Toggle/base.php | 28 ++++- .../Button/Toggle/unavailable_action.php | 18 ++- .../examples/Button/Toggle/with_tooltip.php | 22 +++- .../examples/Card/RepositoryObject/base.php | 26 ++++- .../RepositoryObject/with_object_icon.php | 23 +++- .../with_object_icon_and_actions.php | 25 ++++- .../with_object_icon_and_certificate.php | 23 +++- ...ith_object_icon_and_progressmeter_mini.php | 23 +++- src/UI/examples/Card/Standard/base.php | 25 ++++- .../Chart/ProgressMeter/FixedSize/base.php | 26 ++++- .../FixedSize/maximum_configuration.php | 22 +++- .../FixedSize/only_comparison_value.php | 22 +++- .../FixedSize/user_reached_required.php | 21 +++- .../Chart/ProgressMeter/Mini/base.php | 23 +++- .../Chart/ProgressMeter/Mini/headline.php | 19 +++- .../Mini/maximum_configuration.php | 19 +++- .../Chart/ProgressMeter/Mini/no_score_yet.php | 18 ++- .../Mini/reached_100_percent.php | 18 ++- .../Chart/ProgressMeter/Standard/base.php | 26 ++++- .../Standard/maximum_configuration.php | 22 +++- .../Standard/only_comparison_value.php | 22 +++- .../Standard/user_reached_required.php | 21 +++- src/UI/examples/Chart/ScaleBar/base.php | 25 ++++- src/UI/examples/Chart/ScaleBar/ten_items.php | 22 +++- src/UI/examples/Counter/Novelty/base.php | 24 +++- src/UI/examples/Counter/Status/base.php | 24 +++- .../Counter/Status/multiple_glyphs.php | 22 +++- src/UI/examples/Counter/Status/with_js.php | 25 ++++- .../examples/Counter/Status/with_novelty.php | 21 +++- src/UI/examples/Deck/base.php | 25 ++++- src/UI/examples/Deck/repository.php | 22 +++- src/UI/examples/Deck/user.php | 23 +++- src/UI/examples/Deck/xl_card.php | 22 +++- src/UI/examples/Divider/Horizontal/base.php | 24 +++- .../Divider/Horizontal/with_label.php | 21 +++- src/UI/examples/Divider/Vertical/base.php | 24 +++- src/UI/examples/Dropdown/Standard/base.php | 26 ++++- .../Dropdown/Standard/with_aria_label.php | 23 +++- .../Standard/with_buttons_and_links.php | 24 +++- .../Dropdown/Standard/with_divider.php | 23 +++- .../Standard/with_divider_with_label.php | 24 +++- .../examples/Dropzone/File/Standard/base.php | 29 ++++- .../File/Standard/with_additional_input.php | 28 ++++- .../examples/Dropzone/File/Wrapper/base.php | 26 ++++- .../File/Wrapper/with_additional_input.php | 24 +++- .../File/Wrapper/with_clear_button.php | 23 +++- src/UI/examples/Image/Responsive/base.php | 24 +++- src/UI/examples/Image/Standard/base.php | 24 +++- src/UI/examples/Image/Standard/decorative.php | 19 +++- .../Input/Container/Filter/Standard/base.php | 26 ++++- .../Input/Container/Form/Standard/base.php | 26 ++++- .../Form/Standard/data_processing.php | 24 +++- .../Form/Standard/with_dedicated_name.php | 23 +++- .../Container/Form/Standard/with_keys.php | 25 ++++- src/UI/examples/Input/Field/Checkbox/base.php | 24 +++- .../Input/Field/Checkbox/disabled.php | 18 ++- src/UI/examples/Input/Field/DateTime/base.php | 48 +++++++- src/UI/examples/Input/Field/Duration/base.php | 38 ++++++- src/UI/examples/Input/Field/File/base.php | 22 +++- src/UI/examples/Input/Field/File/in_form.php | 27 ++++- src/UI/examples/Input/Field/Group/base.php | 29 ++++- .../examples/Input/Field/Group/disabled.php | 25 ++++- src/UI/examples/Input/Field/Hidden/base.php | 21 +++- src/UI/examples/Input/Field/Link/base.php | 28 ++++- .../examples/Input/Field/MultiSelect/base.php | 35 +++++- .../Input/Field/MultiSelect/empty_options.php | 23 +++- .../Input/Field/Numeric/numeric_inputs.php | 35 +++++- .../Input/Field/OptionalGroup/base.php | 39 ++++++- .../with_required_sub_inputs.php | 25 ++++- src/UI/examples/Input/Field/Password/base.php | 22 +++- .../examples/Input/Field/Password/in_form.php | 28 ++++- .../Input/Field/Password/with_contraints.php | 34 +++++- src/UI/examples/Input/Field/Radio/base.php | 31 ++++- .../examples/Input/Field/Radio/disabled.php | 23 +++- src/UI/examples/Input/Field/Section/base.php | 24 +++- .../examples/Input/Field/Section/disabled.php | 19 +++- src/UI/examples/Input/Field/Select/base.php | 31 ++++- .../examples/Input/Field/Select/disabled.php | 18 ++- .../Input/Field/Select/with_required.php | 25 ++++- .../Input/Field/SwitchableGroup/base.php | 59 +++++++++- .../Field/SwitchableGroup/with_disabled.php | 21 +++- src/UI/examples/Input/Field/Tag/base.php | 24 +++- .../Input/Field/Tag/base_with_data.php | 32 +++++- .../Input/Field/Tag/base_with_value.php | 23 +++- src/UI/examples/Input/Field/Tag/disabled.php | 19 +++- src/UI/examples/Input/Field/Text/base.php | 22 +++- src/UI/examples/Input/Field/Text/disabled.php | 19 +++- .../examples/Input/Field/Text/with_error.php | 19 +++- .../examples/Input/Field/Text/with_value.php | 19 +++- src/UI/examples/Input/Field/Textarea/base.php | 27 ++++- .../Input/Field/Textarea/disabled.php | 24 +++- .../Input/Field/Textarea/with_limits.php | 25 ++++- src/UI/examples/Input/Field/Url/base.php | 21 +++- src/UI/examples/Input/Field/Url/disabled.php | 19 +++- .../examples/Input/Field/Url/with_error.php | 19 +++- .../examples/Input/Field/Url/with_value.php | 20 +++- src/UI/examples/Item/Group/base.php | 25 ++++- src/UI/examples/Item/Group/with_actions.php | 22 +++- src/UI/examples/Item/Notification/base.php | 25 ++++- .../examples/Item/Notification/closable.php | 23 +++- .../Item/Notification/include_aggregates.php | 24 +++- src/UI/examples/Item/Shy/base.php | 24 +++- src/UI/examples/Item/Shy/with_close.php | 23 +++- src/UI/examples/Item/Shy/with_description.php | 22 +++- src/UI/examples/Item/Shy/with_lead_icon.php | 22 +++- .../Item/Shy/with_long_description.php | 22 +++- src/UI/examples/Item/Shy/with_properties.php | 22 +++- src/UI/examples/Item/Standard/base.php | 26 ++++- .../Item/Standard/with_audio_player.php | 24 +++- .../Item/Standard/with_image_and_progress.php | 23 +++- .../Item/Standard/with_lead_avatar.php | 24 +++- .../examples/Item/Standard/with_lead_icon.php | 24 +++- .../Item/Standard/with_lead_image.php | 24 +++- .../examples/Item/Standard/with_lead_text.php | 24 +++- .../Item/Standard/with_link_title.php | 23 +++- .../Item/Standard/with_main_action.php | 24 +++- .../Item/Standard/with_main_link_action.php | 23 +++- .../examples/Item/Standard/with_progress.php | 22 +++- .../Item/Standard/with_shy_properties.php | 23 +++- .../examples/Item/Standard/with_shy_title.php | 23 +++- src/UI/examples/Layout/Page/Standard/ui.php | 106 +++++++++++++++++- .../Layout/Page/Standard/ui_mainbar.php | 87 +++++++++++++- src/UI/examples/Legacy/base.php | 25 ++++- src/UI/examples/Legacy/inside_panel.php | 21 +++- src/UI/examples/Link/Bulky/base.php | 24 +++- src/UI/examples/Link/Bulky/with_tooltip.php | 22 +++- src/UI/examples/Link/Standard/base.php | 25 ++++- .../with_content_and_referenced_language.php | 23 +++- .../Link/Standard/with_relationships.php | 22 +++- .../examples/Link/Standard/with_tooltip.php | 23 +++- .../Listing/CharacteristicValue/Text/base.php | 26 ++++- src/UI/examples/Listing/Descriptive/base.php | 31 ++++- src/UI/examples/Listing/Ordered/base.php | 28 ++++- src/UI/examples/Listing/Unordered/base.php | 28 ++++- .../examples/Listing/Workflow/Linear/base.php | 25 ++++- .../examples/Listing/Workflow/Step/base.php | 38 ++++++- .../Listing/Workflow/Step/with_actions.php | 22 +++- src/UI/examples/Menu/Drilldown/drilldown.php | 23 +++- src/UI/examples/Menu/Sub/sub.php | 19 ++++ .../MessageBox/Confirmation/confirmation.php | 25 ++++- .../examples/MessageBox/Failure/failure.php | 24 +++- src/UI/examples/MessageBox/Info/info.php | 26 ++++- .../examples/MessageBox/Success/success.php | 25 ++++- src/UI/examples/Modal/Interruptive/base.php | 24 +++- .../show_modal_on_button_click.php | 26 ++++- ...w_modal_on_button_click_async_rendered.php | 27 ++++- .../Modal/Interruptive/with_custom_labels.php | 24 +++- .../Modal/InterruptiveItem/KeyValue/base.php | 30 ++++- .../Modal/InterruptiveItem/Standard/base.php | 30 ++++- .../Lightbox/show_different_page_types.php | 32 +++++- .../LightboxImagePage/show_a_single_image.php | 28 ++++- .../show_multiple_images.php | 28 ++++- .../LightboxTextPage/show_a_single_text.php | 28 ++++- .../LightboxTextPage/show_multiple_texts.php | 28 ++++- .../Modal/RoundTrip/show_form_in_modal.php | 25 ++++- .../Modal/RoundTrip/show_multi_step_modal.php | 23 +++- ..._the_same_modal_with_different_buttons.php | 23 +++- .../Modal/RoundTrip/with_custom_labels.php | 20 +++- .../examples/Panel/Listing/Standard/base.php | 26 ++++- .../Standard/with_all_view_controls.php | 23 +++- .../Listing/Standard/with_lead_image.php | 23 +++- .../Panel/Listing/Standard/with_lead_text.php | 23 +++- src/UI/examples/Panel/Report/base.php | 27 ++++- .../examples/Panel/Secondary/Legacy/base.php | 24 +++- .../Legacy/with_all_view_controls.php | 27 ++++- .../Panel/Secondary/Legacy/with_footer.php | 22 +++- .../examples/Panel/Secondary/Listing/base.php | 27 ++++- .../Listing/with_all_view_controls.php | 31 ++++- .../Panel/Standard/base_text_block.php | 24 +++- .../examples/Panel/Standard/with_actions.php | 22 +++- .../Panel/Standard/with_all_view_controls.php | 28 ++++- .../examples/Panel/Standard/with_listings.php | 28 ++++- src/UI/examples/Panel/Sub/base.php | 25 ++++- src/UI/examples/Panel/Sub/with_actions.php | 23 +++- src/UI/examples/Panel/Sub/with_card.php | 24 +++- src/UI/examples/Player/Audio/base.php | 27 ++++- src/UI/examples/Player/Video/video_mp4.php | 32 +++++- .../Player/Video/video_mp4_poster.php | 28 ++++- src/UI/examples/Player/Video/video_vimeo.php | 32 +++++- .../examples/Player/Video/video_youtube.php | 33 +++++- src/UI/examples/Popover/Listing/base.php | 29 ++++- .../Popover/Standard/show_card_in_popover.php | 30 ++++- ...show_popover_with_async_loaded_content.php | 26 ++++- .../show_popover_with_different_positions.php | 28 ++++- ..._popover_with_dynamic_changing_content.php | 26 ++++- .../show_popover_with_vertical_scrollbars.php | 23 +++- src/UI/examples/Symbol/Avatar/Letter/base.php | 24 +++- .../examples/Symbol/Avatar/Picture/base.php | 24 +++- src/UI/examples/Symbol/Glyph/Add/add.php | 33 +++++- src/UI/examples/Symbol/Glyph/Angry/angry.php | 33 +++++- src/UI/examples/Symbol/Glyph/Apply/apply.php | 33 +++++- .../Symbol/Glyph/Astounded/astounded.php | 33 +++++- .../Symbol/Glyph/Attachment/attachment.php | 33 +++++- src/UI/examples/Symbol/Glyph/Back/back.php | 33 +++++- .../Symbol/Glyph/Briefcase/briefcase.php | 33 +++++- .../Symbol/Glyph/Bulletlist/bulletlist.php | 33 +++++- .../Symbol/Glyph/Calendar/calendar.php | 33 +++++- src/UI/examples/Symbol/Glyph/Close/close.php | 33 +++++- .../Symbol/Glyph/Collapse/collapse.php | 35 +++++- .../CollapseHorizontal/collapsehorizontal.php | 26 ++++- .../examples/Symbol/Glyph/Comment/comment.php | 33 +++++- .../Symbol/Glyph/Disclosure/disclosure.php | 33 +++++- .../examples/Symbol/Glyph/Dislike/dislike.php | 33 +++++- src/UI/examples/Symbol/Glyph/Down/down.php | 33 +++++- .../examples/Symbol/Glyph/Expand/expand.php | 33 +++++- .../Symbol/Glyph/Eyeclosed/eyeclosed.php | 33 +++++- .../examples/Symbol/Glyph/Eyeopen/eyeopen.php | 33 +++++- .../examples/Symbol/Glyph/Filter/filter.php | 33 +++++- src/UI/examples/Symbol/Glyph/Help/help.php | 33 +++++- .../Symbol/Glyph/Language/language.php | 33 +++++- src/UI/examples/Symbol/Glyph/Laugh/laugh.php | 33 +++++- src/UI/examples/Symbol/Glyph/Like/like.php | 33 +++++- .../Symbol/Glyph/Listindent/listindent.php | 33 +++++- .../Symbol/Glyph/Listoutdent/listoutdent.php | 33 +++++- src/UI/examples/Symbol/Glyph/Login/login.php | 33 +++++- .../examples/Symbol/Glyph/Logout/logout.php | 33 +++++- src/UI/examples/Symbol/Glyph/Love/love.php | 33 +++++- .../Symbol/Glyph/Mail/mail_example.php | 33 +++++- src/UI/examples/Symbol/Glyph/More/more.php | 33 +++++- .../examples/Symbol/Glyph/Next/next_glyph.php | 33 +++++- src/UI/examples/Symbol/Glyph/Note/note.php | 33 +++++- .../Glyph/Notification/notification.php | 33 +++++- .../Glyph/Numberedlist/numberedlist.php | 33 +++++- .../examples/Symbol/Glyph/Remove/remove.php | 33 +++++- .../Symbol/Glyph/Reset/glyph_reset.php | 33 +++++- src/UI/examples/Symbol/Glyph/Sad/sad.php | 33 +++++- .../examples/Symbol/Glyph/Search/search.php | 33 +++++- .../Symbol/Glyph/Settings/settings.php | 33 +++++- .../Glyph/SortAscending/sort_ascending.php | 33 +++++- .../Glyph/SortDescending/sort_descending.php | 33 +++++- .../examples/Symbol/Glyph/Tag/tag_example.php | 33 +++++- .../examples/Symbol/Glyph/Time/time_glyph.php | 33 +++++- src/UI/examples/Symbol/Glyph/Up/up.php | 33 +++++- src/UI/examples/Symbol/Glyph/User/user.php | 33 +++++- .../Symbol/Glyph/User/with_js_binding.php | 23 +++- .../Symbol/Icon/Custom/custom_icon.php | 25 ++++- .../Symbol/Icon/Standard/default_icon.php | 24 +++- .../Symbol/Icon/Standard/disabled_icon.php | 21 +++- .../Symbol/Icon/Standard/std_course_icon.php | 21 +++- .../Symbol/Icon/Standard/std_icons.php | 22 +++- src/UI/examples/Table/Presentation/base.php | 25 ++++- src/UI/examples/Table/Presentation/base1.php | 28 ++++- src/UI/examples/Toast/Container/base.php | 24 +++- .../Toast/Container/with_multiple_toasts.php | 22 +++- .../examples/Toast/Container/with_toast.php | 19 +++- src/UI/examples/Toast/Standard/base.php | 25 ++++- .../examples/Toast/Standard/with_action.php | 22 +++- .../Toast/Standard/with_additional_links.php | 22 +++- .../Toast/Standard/with_description.php | 22 +++- .../Toast/Standard/with_link_title.php | 22 +++- .../Toast/Standard/with_long_description.php | 22 +++- .../examples/Tree/Expandable/expandable.php | 25 ++++- .../examples/Tree/Expandable/expandable2.php | 22 +++- .../Tree/Expandable/expandable_async_repo.php | 21 +++- src/UI/examples/Tree/Node/Bylined/bylined.php | 29 ++++- .../examples/Tree/Node/KeyValue/key_value.php | 26 ++++- src/UI/examples/Tree/Node/Simple/simple.php | 25 ++++- .../Tree/Node/Simple/simpleWithLink.php | 22 +++- src/UI/examples/ViewControl/Mode/base.php | 7 +- .../examples/ViewControl/Pagination/base.php | 11 +- .../ViewControl/Pagination/many_pages.php | 9 +- .../Pagination/many_pages_dropdown.php | 9 +- .../ViewControl/Pagination/no_pages.php | 3 + .../ViewControl/Pagination/with_signal.php | 6 +- src/UI/examples/ViewControl/Section/base.php | 12 +- .../examples/ViewControl/Sortation/_Base.php | 9 +- .../examples/ViewControl/Sortation/async.php | 4 +- .../examples/ViewControl/Sortation/small.php | 4 +- 295 files changed, 7244 insertions(+), 318 deletions(-) diff --git a/src/UI/examples/Breadcrumbs/breadcrumbs.php b/src/UI/examples/Breadcrumbs/breadcrumbs.php index 22536ee45eac..f3685f017773 100644 --- a/src/UI/examples/Breadcrumbs/breadcrumbs.php +++ b/src/UI/examples/Breadcrumbs/breadcrumbs.php @@ -1,5 +1,21 @@ * ILIAS shows two rows of clickable links separated by simple arrows (>). * The second row has one more entry than the first one. + * + * Validating Breadcrumbs: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function breadcrumbs() diff --git a/src/UI/examples/Button/Bulky/base.php b/src/UI/examples/Button/Bulky/base.php index 2e605b5d9a27..4a9136352b1e 100644 --- a/src/UI/examples/Button/Bulky/base.php +++ b/src/UI/examples/Button/Bulky/base.php @@ -1,16 +1,41 @@ + * Example for rendering a bulky button. + * * note: > * The exact look of the Bulky Buttons is mostly defined by the surrounding container. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button with an icon and titled "Icon". The button's size is almost as wide as the width of the box + * in the background. Clicking the button won't activate any actions. + * Additionally ILIAS shows a button with a glyph and the title "Glyph". The button's size is also almost as wide as + * the widht of the box in the background. Clicking the button won't activate any actions. + * + * Validating Bulky Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Bulky/engaged.php b/src/UI/examples/Button/Bulky/engaged.php index 7974aa83d524..c4a90b31120d 100755 --- a/src/UI/examples/Button/Bulky/engaged.php +++ b/src/UI/examples/Button/Bulky/engaged.php @@ -1,13 +1,33 @@ + * Example for rendering an engaged bulky button + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button with a glyph and the title "Engaged". The button looks different than the base bulky button. + * Clicking the button won't activate any actions. * --- */ function engaged() diff --git a/src/UI/examples/Button/Bulky/unavailable_action.php b/src/UI/examples/Button/Bulky/unavailable_action.php index 033d631b9e32..f57b090c9370 100644 --- a/src/UI/examples/Button/Bulky/unavailable_action.php +++ b/src/UI/examples/Button/Bulky/unavailable_action.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a button with a glyph and the title "Unavailable". Clicking the button won't activate any actions. * * note: > * The disabled attribute is set in the DOM. diff --git a/src/UI/examples/Button/Bulky/with_tooltip.php b/src/UI/examples/Button/Bulky/with_tooltip.php index b3e883d63dbf..211b1cfabc46 100644 --- a/src/UI/examples/Button/Bulky/with_tooltip.php +++ b/src/UI/examples/Button/Bulky/with_tooltip.php @@ -1,13 +1,33 @@ + * Example for rendering a bulky button with tooltips + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows an icon titled "Goto ILIAS". Hovering over the text will show you following tooltips: "tooltip: ilias" + * and "tooltip: learning management system". * --- */ function with_tooltip() diff --git a/src/UI/examples/Button/Close/base.php b/src/UI/examples/Button/Close/base.php index 1f256a63224d..fb5d1dd0f4d9 100755 --- a/src/UI/examples/Button/Close/base.php +++ b/src/UI/examples/Button/Close/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a grey box with an dark grey "X" in the right corner. Clicking the "X" won't activate any action. + * + * Validating Close Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * * note: > * In some cases, additional CSS will be needed for placing the button diff --git a/src/UI/examples/Button/Close/modal.php b/src/UI/examples/Button/Close/modal.php index 11a643eec5ba..cadfa6753b0c 100755 --- a/src/UI/examples/Button/Close/modal.php +++ b/src/UI/examples/Button/Close/modal.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a button titled "Show Close Button Demo". Clicking the button will open a modal with text and a Close-Button. + * A click onto the button will close the modal. * --- */ function modal() diff --git a/src/UI/examples/Button/Minimize/base.php b/src/UI/examples/Button/Minimize/base.php index da2f88260e01..a379da8ec7c7 100755 --- a/src/UI/examples/Button/Minimize/base.php +++ b/src/UI/examples/Button/Minimize/base.php @@ -1,5 +1,21 @@ + * Example for rendering a dropdown button showing the default month/year while not opened and a selection of months while + * opened. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button including a month and year. Clicking the button will open a selection of other months and years + * which can be selected. Another click onto a month opens a dialog which confirms the click. In this dialog you can see + * a long kombination of numbers/letters and additionally the selected month (e.g. 03-2020). + * + * Validating Month Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Primary/base.php b/src/UI/examples/Button/Primary/base.php index c05dda8e12e8..990b49a03e1f 100755 --- a/src/UI/examples/Button/Primary/base.php +++ b/src/UI/examples/Button/Primary/base.php @@ -1,13 +1,36 @@ + * Example for rendering a primary button. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows an active, very colorful button titled "Goto ILIAS". Clicking the button will open the website + * www.ilias.de in the same browser window. + * + * Validating Primary Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Primary/engaged.php b/src/UI/examples/Button/Primary/engaged.php index 5daf9431bf7b..34b283d88c44 100755 --- a/src/UI/examples/Button/Primary/engaged.php +++ b/src/UI/examples/Button/Primary/engaged.php @@ -1,13 +1,32 @@ + * Example for rendering an engaged primary button + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a white button titled "Engaged Button". A click onto the button won't activate any actions. * --- */ function engaged() diff --git a/src/UI/examples/Button/Primary/unavailable_action.php b/src/UI/examples/Button/Primary/unavailable_action.php index 2e1d6fb1a3f5..abb7330643cb 100644 --- a/src/UI/examples/Button/Primary/unavailable_action.php +++ b/src/UI/examples/Button/Primary/unavailable_action.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an inactive button titled "Unavailable". The button looks more ordinary as compared to the base + * primary button. Clicking the button won't activate any actions. * --- */ function unavailable_action() diff --git a/src/UI/examples/Button/Primary/with_load_anim.php b/src/UI/examples/Button/Primary/with_load_anim.php index b7cc29d39821..9ebc440cbc30 100644 --- a/src/UI/examples/Button/Primary/with_load_anim.php +++ b/src/UI/examples/Button/Primary/with_load_anim.php @@ -1,13 +1,34 @@ + * Example for rendering a primary button with a loading animation + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows an active, very colorful button titled "Goto ILIAS". After clicking the button the text will change to + * "Working..." and the button's color will change to grey. During that process you can not click the button. After a + * while the button will change to it's origin color and the text will be "Done". * --- */ function with_load_anim() diff --git a/src/UI/examples/Button/Primary/with_tooltip.php b/src/UI/examples/Button/Primary/with_tooltip.php index f99bd299582f..0cfc3fac3aec 100644 --- a/src/UI/examples/Button/Primary/with_tooltip.php +++ b/src/UI/examples/Button/Primary/with_tooltip.php @@ -1,13 +1,33 @@ + * Example for rendering a primary button with tooltips + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows an active button titled "Goto ILIAS". Hovering over the button will show you a tooltip with following + * content: "tooltip: ilias" and "tooltip: learning management system". * --- */ function with_tooltip() diff --git a/src/UI/examples/Button/Shy/base.php b/src/UI/examples/Button/Shy/base.php index a50c6d619c45..959f4cba4374 100644 --- a/src/UI/examples/Button/Shy/base.php +++ b/src/UI/examples/Button/Shy/base.php @@ -1,13 +1,36 @@ + * Example for rendering a shy button. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a small button titled "ILIAS". The button lacks a background, but shows a text. Clicking the button will + * open the website www.ilias.de in the same browser window. + * + * Validating Shy Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Shy/engaged.php b/src/UI/examples/Button/Shy/engaged.php index f312138483fe..01a9e7416da4 100755 --- a/src/UI/examples/Button/Shy/engaged.php +++ b/src/UI/examples/Button/Shy/engaged.php @@ -1,13 +1,32 @@ + * Example for rendering an engaged shy button + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a small button titled "Engaged Button". Clicking the button won't activate any actions. * --- */ function engaged() diff --git a/src/UI/examples/Button/Shy/unavailable_action.php b/src/UI/examples/Button/Shy/unavailable_action.php index 08a6c21a5b20..e37008b0dd6d 100644 --- a/src/UI/examples/Button/Shy/unavailable_action.php +++ b/src/UI/examples/Button/Shy/unavailable_action.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a small button titled "Unavailable". The button's background is colored dark grey. Clicking the button + * won't activate any actions. * --- */ function unavailable_action() diff --git a/src/UI/examples/Button/Shy/with_tooltip.php b/src/UI/examples/Button/Shy/with_tooltip.php index 4a049c24c599..d2a5b27b4694 100644 --- a/src/UI/examples/Button/Shy/with_tooltip.php +++ b/src/UI/examples/Button/Shy/with_tooltip.php @@ -1,13 +1,33 @@ + * Example for rendering a shy button with tooltips + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a small button titled "Goto ILIAS". Hovering over the button will show a tooltip with following contents: + * "tooltip: ilias" and "tooltip: learning managemend system". * --- */ function with_tooltip() diff --git a/src/UI/examples/Button/Standard/base.php b/src/UI/examples/Button/Standard/base.php index b2e8cc927181..7115e12c9e10 100755 --- a/src/UI/examples/Button/Standard/base.php +++ b/src/UI/examples/Button/Standard/base.php @@ -1,13 +1,36 @@ + * Example for rendering a standard button. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a colored, active button titled "Goto ILIAS". Clicking the button opens the website www.ilias.de + * in the same browser window. + * + * Validating Standard Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Standard/engaged.php b/src/UI/examples/Button/Standard/engaged.php index f7704e42d936..1aa7f4ce56b4 100755 --- a/src/UI/examples/Button/Standard/engaged.php +++ b/src/UI/examples/Button/Standard/engaged.php @@ -1,13 +1,33 @@ + * Example for rendering an engaged standard button + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a grey, active button titled "Engaged". The button looks different to the base standard button. + * Clicking the button won't activate any actions. * --- */ function engaged() diff --git a/src/UI/examples/Button/Standard/unavailable_action.php b/src/UI/examples/Button/Standard/unavailable_action.php index fb9173e8ae90..af58265182e8 100644 --- a/src/UI/examples/Button/Standard/unavailable_action.php +++ b/src/UI/examples/Button/Standard/unavailable_action.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a inactive button titled "Unavailable". The button is more prominent as compared to the base standard button. + * Clicking the button won't activate any actions. * --- */ function unavailable_action() diff --git a/src/UI/examples/Button/Standard/with_js_binding.php b/src/UI/examples/Button/Standard/with_js_binding.php index 1bff690dffb4..ef5dc0a8ff70 100755 --- a/src/UI/examples/Button/Standard/with_js_binding.php +++ b/src/UI/examples/Button/Standard/with_js_binding.php @@ -1,13 +1,32 @@ + * Example for rendering a standard button with JS binding + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows an active button titled "Goto ILIAS". Clicking the button opens a dialog with a click-ID. * --- */ function with_js_binding() diff --git a/src/UI/examples/Button/Standard/with_load_anim.php b/src/UI/examples/Button/Standard/with_load_anim.php index c18161ac75bb..4d24ec6a9ba5 100644 --- a/src/UI/examples/Button/Standard/with_load_anim.php +++ b/src/UI/examples/Button/Standard/with_load_anim.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an active button titled "Do Something". The color of the button will change after clicking the button + * and the word "Working" will appear, which is referencing to the loading status. After a while the button's content + * will change to "Done". * --- */ function with_load_anim() diff --git a/src/UI/examples/Button/Standard/with_tooltip.php b/src/UI/examples/Button/Standard/with_tooltip.php index fbcc1614f0e7..124594eccc59 100755 --- a/src/UI/examples/Button/Standard/with_tooltip.php +++ b/src/UI/examples/Button/Standard/with_tooltip.php @@ -1,13 +1,33 @@ + * Example for rendering a standard button with tooltips + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows an active button titled "Goto ILIAS". Hovering over the button will show you a tooltip with following + * lines: "tooltip: ilias" and "tooltip: learning management system". * --- */ function with_tooltip() diff --git a/src/UI/examples/Button/Tag/base.php b/src/UI/examples/Button/Tag/base.php index cac105653aaf..342706893c9c 100644 --- a/src/UI/examples/Button/Tag/base.php +++ b/src/UI/examples/Button/Tag/base.php @@ -1,13 +1,41 @@ + * Example for rendering a Tag Button. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows four different buttons titled "simple tag" in following order: + * 1. Five buttons in shaded colors. The cursor will change while hovering above the button which confirms that the + * buttons are clickable. + * 2. with unavailable action: five grey buttons which are not clickable. A click won't activate any actions. + * 3. with additional class(es): a very broad button with a loading animation at the right side. + * 4. with fix colors: three buttons with different background colors and different text colors. Hovering over the + * buttons will change the cursor which confirms that the buttons are clickable. + * + * Validating Tag Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Tag/engaged.php b/src/UI/examples/Button/Tag/engaged.php index 756d8004a62b..91fbeffe99a1 100755 --- a/src/UI/examples/Button/Tag/engaged.php +++ b/src/UI/examples/Button/Tag/engaged.php @@ -1,13 +1,32 @@ + * Example for rendering an engaged Tag Button + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows five buttons titled "simple tag". Those buttons look different to the base Tag Buttons. * --- */ function engaged() diff --git a/src/UI/examples/Button/Tag/with_tooltip.php b/src/UI/examples/Button/Tag/with_tooltip.php index 7d0219ad70d3..adbc6f4fdaf1 100644 --- a/src/UI/examples/Button/Tag/with_tooltip.php +++ b/src/UI/examples/Button/Tag/with_tooltip.php @@ -1,13 +1,32 @@ + * Example for rendering Tag Buttons with tooltips. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows two buttons titled "simple tag." Hovering over those buttons will show a tooltip. * --- */ function with_tooltip() diff --git a/src/UI/examples/Button/Toggle/base.php b/src/UI/examples/Button/Toggle/base.php index 2e616e4567b1..e324e789a4cb 100644 --- a/src/UI/examples/Button/Toggle/base.php +++ b/src/UI/examples/Button/Toggle/base.php @@ -1,13 +1,39 @@ + * Example for rendering a Toggle Button. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a switch. Clicking onto the switch will result to the switch moving to the right side and opening a + * dialog: "Toggle Button has been turned on". + * Closing the dialog via "delete" will move back the switch. The switch will stay on the right side if the dialog + * is closed via "close". + * Another click onto the switch will move the switch to the left side. ILIAS notifies: "Toggle Button has been turned off". + * + * Validating Toggle Button: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Button/Toggle/unavailable_action.php b/src/UI/examples/Button/Toggle/unavailable_action.php index 523bb6824479..a3d655371946 100644 --- a/src/UI/examples/Button/Toggle/unavailable_action.php +++ b/src/UI/examples/Button/Toggle/unavailable_action.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a greyed out switch which indicates it's status. Clicking onto the switch won't activate any actions. * --- */ function unavailable_action() diff --git a/src/UI/examples/Button/Toggle/with_tooltip.php b/src/UI/examples/Button/Toggle/with_tooltip.php index a9b44a466eda..2ed830ed6c26 100644 --- a/src/UI/examples/Button/Toggle/with_tooltip.php +++ b/src/UI/examples/Button/Toggle/with_tooltip.php @@ -1,13 +1,33 @@ + * Example for rendering a Toggle Button with tooltips + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a switch looking like a base toggle button. The functions are the same as the base toggle button functions. + * Hovering over the switch shows following tooltips: "tooltip: ilias" and "tooltip: learning management system". * --- */ function with_tooltip() diff --git a/src/UI/examples/Card/RepositoryObject/base.php b/src/UI/examples/Card/RepositoryObject/base.php index 63cc14ab9c2f..374e49f2b73a 100644 --- a/src/UI/examples/Card/RepositoryObject/base.php +++ b/src/UI/examples/Card/RepositoryObject/base.php @@ -1,13 +1,37 @@ + * Example for rendering a repository card. Note that those cards are used if more visual information about the + * repository object type is needed. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a ILIAS-Logo. The logo's size will change accordingly to the size of the browser/desktop. A title + * "RepositoryObject Card Title" is displayed below the logo. + * + * Validating RepositoryObject Card: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Card/RepositoryObject/with_object_icon.php b/src/UI/examples/Card/RepositoryObject/with_object_icon.php index f542559d1092..13ce5d993bf5 100644 --- a/src/UI/examples/Card/RepositoryObject/with_object_icon.php +++ b/src/UI/examples/Card/RepositoryObject/with_object_icon.php @@ -1,13 +1,34 @@ + * Example for rendering a repository card with an object icon + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a ILIAS-Logo. The logo's size changes accordingly to the size of the browser window/desktop. A title and + * some entries (Entry 1, Some text etc.) are displayed below the logo. In the left top corner you can see the outlined + * icon "Course". * --- */ function with_object_icon() diff --git a/src/UI/examples/Card/RepositoryObject/with_object_icon_and_actions.php b/src/UI/examples/Card/RepositoryObject/with_object_icon_and_actions.php index 4f934fef1639..6656556ff46f 100644 --- a/src/UI/examples/Card/RepositoryObject/with_object_icon_and_actions.php +++ b/src/UI/examples/Card/RepositoryObject/with_object_icon_and_actions.php @@ -1,13 +1,36 @@ + * Example for rendering a repository card with an object icon title action. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a ILIAS-Logo. The logo's size changes accordingly to the size of the browser window/desktop. A title and + * some entries (Entry 1, Some text etc.) are displayed below the logo. The upper part of the Icons are darkened. In the + * left top corner you can see the outlined icon "Course". + * Additionally a dropdown menu is displayed in the right top corner. The menu can be opened by a click and displays links + * titled "Go to Course", "Go to Portfolio" and "ilias.de". Only the last link functions. * --- */ function with_object_icon_and_actions() diff --git a/src/UI/examples/Card/RepositoryObject/with_object_icon_and_certificate.php b/src/UI/examples/Card/RepositoryObject/with_object_icon_and_certificate.php index d2efe26f96e0..ccf57f57f8a2 100644 --- a/src/UI/examples/Card/RepositoryObject/with_object_icon_and_certificate.php +++ b/src/UI/examples/Card/RepositoryObject/with_object_icon_and_certificate.php @@ -1,13 +1,34 @@ + * Example for rendering a repository card with an icon and certificate + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a ILIAS-Logo. The logo's size changes accordingly to the size of the browser window/desktop. A title and + * some entries (Entry 1, Some text etc.) are displayed below the logo. In the left top corner an outlined icon "Course" + * is displayed. Additionally you can see the outlined icon "Certificate" next to the course icon. * --- */ function with_object_icon_and_certificate() diff --git a/src/UI/examples/Card/RepositoryObject/with_object_icon_and_progressmeter_mini.php b/src/UI/examples/Card/RepositoryObject/with_object_icon_and_progressmeter_mini.php index 08f1750f4831..3ff1590c8054 100644 --- a/src/UI/examples/Card/RepositoryObject/with_object_icon_and_progressmeter_mini.php +++ b/src/UI/examples/Card/RepositoryObject/with_object_icon_and_progressmeter_mini.php @@ -1,13 +1,34 @@ + * Example for rendering a repository card with an object icon and small progressmeter + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a ILIAS-Logo. The logo's size changes accordingly to the size of the browser window/desktop. A title and + * some entries (Entry 1, Some text etc.) are displayed below the logo. In the left top corner an outlined icon "Course" + * is displayed. Additionally you can see a small progress meter next to the course icon. * --- */ function with_object_icon_and_progressmeter_mini() diff --git a/src/UI/examples/Card/Standard/base.php b/src/UI/examples/Card/Standard/base.php index 9e23142f37c0..de118c198c19 100644 --- a/src/UI/examples/Card/Standard/base.php +++ b/src/UI/examples/Card/Standard/base.php @@ -1,13 +1,36 @@ + * Example for rendering a base card. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a ILIAS-Logo. The size of the logo depends on the browser/desktop size and will change accordingly. + * A title will be displayed below the logo. + * + * Validating Standard Card: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Chart/ProgressMeter/FixedSize/base.php b/src/UI/examples/Chart/ProgressMeter/FixedSize/base.php index 93c69e09184d..d2bb5352e20e 100644 --- a/src/UI/examples/Chart/ProgressMeter/FixedSize/base.php +++ b/src/UI/examples/Chart/ProgressMeter/FixedSize/base.php @@ -1,5 +1,21 @@ - * Example for rendering a fixed size Progress Meter with minimum configuration + * Example for rendering a fixed size Progress Meter with minimum configuration. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a red bar. The bar takes up three quarter of the progress meter. + * You can see the information "75%" within the progress meter. + * + * Changing the browser window's size will not change the size of the progress meter: the display stays the same! + * + * Validating Fixed Size ProgressMeter: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Chart/ProgressMeter/FixedSize/maximum_configuration.php b/src/UI/examples/Chart/ProgressMeter/FixedSize/maximum_configuration.php index 4719648fa8f3..512a6df12f32 100644 --- a/src/UI/examples/Chart/ProgressMeter/FixedSize/maximum_configuration.php +++ b/src/UI/examples/Chart/ProgressMeter/FixedSize/maximum_configuration.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with two bars. The outer bar is colored red and takes up three quarter of the + * display. The inner bar is colored grey and takes up the half of the display. A triangle marks the needed value at + * 80%. The informations "Your Score 75%" and "80% Required Score" are positioned within the progress meter. + * + * Changing the browser window's size will not change the size of the progress meter: the display stays the same! * --- */ function maximum_configuration() diff --git a/src/UI/examples/Chart/ProgressMeter/FixedSize/only_comparison_value.php b/src/UI/examples/Chart/ProgressMeter/FixedSize/only_comparison_value.php index 205b4f4d8b6f..770f68547ae7 100644 --- a/src/UI/examples/Chart/ProgressMeter/FixedSize/only_comparison_value.php +++ b/src/UI/examples/Chart/ProgressMeter/FixedSize/only_comparison_value.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with two bars. The outer bar is colored red and is displayed as a dot (equals 0%). + * The inner bar is colored grey and takes up half of the display. A triangle marks the needed value at 75%. The + * informations "0%" and "75%" are displayed within the progress meter. + * + * Changing the browser window's size will not change the size of the progress meter: the display stays the same! * --- */ function only_comparison_value() diff --git a/src/UI/examples/Chart/ProgressMeter/FixedSize/user_reached_required.php b/src/UI/examples/Chart/ProgressMeter/FixedSize/user_reached_required.php index e3b87a9398f5..63a71362cfc4 100644 --- a/src/UI/examples/Chart/ProgressMeter/FixedSize/user_reached_required.php +++ b/src/UI/examples/Chart/ProgressMeter/FixedSize/user_reached_required.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a green colored bar. The bar takes up 80% of the display. A triangle + * marks the needed value at 75%. The informations "80%" and "75%" are positioned within the progress meter. + * + * Changing the browser window's size will not change the size of the progress meter: the display stays the same! * --- */ function user_reached_required() diff --git a/src/UI/examples/Chart/ProgressMeter/Mini/base.php b/src/UI/examples/Chart/ProgressMeter/Mini/base.php index b9fe17376373..2870a74af211 100644 --- a/src/UI/examples/Chart/ProgressMeter/Mini/base.php +++ b/src/UI/examples/Chart/ProgressMeter/Mini/base.php @@ -1,5 +1,21 @@ - * Example for rendering a mini Progress Meter with minimum configuration + * Example for rendering a mini Progress Meter with minimum configuration. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a red colored bar. The bar takes up three quarter of the display. + * + * Validating Mini ProgressMeter: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Chart/ProgressMeter/Mini/headline.php b/src/UI/examples/Chart/ProgressMeter/Mini/headline.php index 733eff7ea5ad..4d48bd61ab1b 100644 --- a/src/UI/examples/Chart/ProgressMeter/Mini/headline.php +++ b/src/UI/examples/Chart/ProgressMeter/Mini/headline.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a red colored bar and the headline "Your Progress". The bar takes up + * three quarter of the display. * --- */ function headline() diff --git a/src/UI/examples/Chart/ProgressMeter/Mini/maximum_configuration.php b/src/UI/examples/Chart/ProgressMeter/Mini/maximum_configuration.php index 02253766565f..f49c07fe4fbc 100644 --- a/src/UI/examples/Chart/ProgressMeter/Mini/maximum_configuration.php +++ b/src/UI/examples/Chart/ProgressMeter/Mini/maximum_configuration.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a red colored bar. The bar takes up half of the display. A grey bar marks + * the needed value. * --- */ function maximum_configuration() diff --git a/src/UI/examples/Chart/ProgressMeter/Mini/no_score_yet.php b/src/UI/examples/Chart/ProgressMeter/Mini/no_score_yet.php index f19afde8ab49..ca1fbac68f97 100644 --- a/src/UI/examples/Chart/ProgressMeter/Mini/no_score_yet.php +++ b/src/UI/examples/Chart/ProgressMeter/Mini/no_score_yet.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a red dot. The dot displays that no progress was reached until now. * --- */ function no_score_yet() diff --git a/src/UI/examples/Chart/ProgressMeter/Mini/reached_100_percent.php b/src/UI/examples/Chart/ProgressMeter/Mini/reached_100_percent.php index c17d40d4ec91..5af60043fc97 100644 --- a/src/UI/examples/Chart/ProgressMeter/Mini/reached_100_percent.php +++ b/src/UI/examples/Chart/ProgressMeter/Mini/reached_100_percent.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a green colored bar. The bar takes up the whole display. * --- */ function reached_100_percent() diff --git a/src/UI/examples/Chart/ProgressMeter/Standard/base.php b/src/UI/examples/Chart/ProgressMeter/Standard/base.php index 906f1a4cc909..98f08fb6ef57 100644 --- a/src/UI/examples/Chart/ProgressMeter/Standard/base.php +++ b/src/UI/examples/Chart/ProgressMeter/Standard/base.php @@ -1,5 +1,21 @@ - * Example for rendering a standard Progress Meter with minimum configuration + * Example for rendering a standard Progress Meter with minimum configuration. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a red bar. The bar takes up three quarter of the progress meter. The + * information "75%" is positioned within the progress meter. + * + * Changing the size of the browser window will change the size of the progress meter: it gets smaller or bigger. + * + * Validating Standard ProgressMeter: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Chart/ProgressMeter/Standard/maximum_configuration.php b/src/UI/examples/Chart/ProgressMeter/Standard/maximum_configuration.php index 665113657e32..a9089a959761 100644 --- a/src/UI/examples/Chart/ProgressMeter/Standard/maximum_configuration.php +++ b/src/UI/examples/Chart/ProgressMeter/Standard/maximum_configuration.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with two bars. The outer bar is colored red and takes up three quarter of the + * progress meter. The inner bar is colored grey and takes up half of the progress meter. A triangle marks the needed value + * at "80%". The informations "Your Score 75%" and "80% Required Score" are positioned within the progress meter. + * + * Changing the size of the browser window will change the size of the progress meter: it gets smaller or bigger. * --- */ function maximum_configuration() diff --git a/src/UI/examples/Chart/ProgressMeter/Standard/only_comparison_value.php b/src/UI/examples/Chart/ProgressMeter/Standard/only_comparison_value.php index e076ba1a2d35..1b78d956d69d 100644 --- a/src/UI/examples/Chart/ProgressMeter/Standard/only_comparison_value.php +++ b/src/UI/examples/Chart/ProgressMeter/Standard/only_comparison_value.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with two bars. The outer bar is colored red and is displayed as a dot (equals 0%). + * The inner bar is colored yellow and takes up half of the progress meter. A triangle within the progress meter marks + * the needed value at 75%. The informations "0%" and "75%" are also positioned within the progress meter. + * + * Changing the size of the browser window will change the size of the progress meter: it gets smaller or bigger. * --- */ function only_comparison_value() diff --git a/src/UI/examples/Chart/ProgressMeter/Standard/user_reached_required.php b/src/UI/examples/Chart/ProgressMeter/Standard/user_reached_required.php index cd48c62a3823..49e14243094a 100644 --- a/src/UI/examples/Chart/ProgressMeter/Standard/user_reached_required.php +++ b/src/UI/examples/Chart/ProgressMeter/Standard/user_reached_required.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rounded progress meter with a green colored bar. The bar takes up 80% of the progress meter. A triangle + * marks the needed value at 75%. The Informations "80%" and "75%" are positioned within the progress meter. + * + * Changing the size of the browser window will change the size of the progress meter: it gets smaller or bigger. * --- */ function user_reached_required() diff --git a/src/UI/examples/Chart/ScaleBar/base.php b/src/UI/examples/Chart/ScaleBar/base.php index 491186f8d7e1..a63a5b2d1e92 100644 --- a/src/UI/examples/Chart/ScaleBar/base.php +++ b/src/UI/examples/Chart/ScaleBar/base.php @@ -1,13 +1,36 @@ + * Example of rendering a base scale bar. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows four equal stripes with a label each: None, Low, Medium, High. + * The "Medium" stripe is particularly highlighted. No stripe is clickable. + * + * Validating ScaleBar: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Chart/ScaleBar/ten_items.php b/src/UI/examples/Chart/ScaleBar/ten_items.php index 653819bde743..1615f0eddcec 100644 --- a/src/UI/examples/Chart/ScaleBar/ten_items.php +++ b/src/UI/examples/Chart/ScaleBar/ten_items.php @@ -1,13 +1,33 @@ + * Example for rendering a scale bar with ten items + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows ten equal stripes with a number between 0-9 each. + * Stripe "6" is particularly highlighted. No stripe is clickable. * --- */ function ten_items() diff --git a/src/UI/examples/Counter/Novelty/base.php b/src/UI/examples/Counter/Novelty/base.php index 687f70f04015..0735b41b35be 100755 --- a/src/UI/examples/Counter/Novelty/base.php +++ b/src/UI/examples/Counter/Novelty/base.php @@ -1,13 +1,35 @@ + * Base example for rendering a novelty counter. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a glyph with a counter. The counter consists of a white colored number within a red/orange circle. + * + * Validating Novelty Counter: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Counter/Status/base.php b/src/UI/examples/Counter/Status/base.php index 0535e1012e50..8702601d74f1 100755 --- a/src/UI/examples/Counter/Status/base.php +++ b/src/UI/examples/Counter/Status/base.php @@ -1,13 +1,35 @@ + * Base example for rendering a status counter. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a rendered glyph with a counter. The counter consists of a white colored number within a grey circle. + * + * Validating Status Counter: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Counter/Status/multiple_glyphs.php b/src/UI/examples/Counter/Status/multiple_glyphs.php index 47c03c52f4e6..dd4d6d8cc601 100755 --- a/src/UI/examples/Counter/Status/multiple_glyphs.php +++ b/src/UI/examples/Counter/Status/multiple_glyphs.php @@ -1,13 +1,33 @@ + * Example for rendering multiple glyphs with status counters + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows three rendered glyphs with two counters each in a row. + * The counters consist of a white number each and are highlighted red resp. grey * --- */ function multiple_glyphs() diff --git a/src/UI/examples/Counter/Status/with_js.php b/src/UI/examples/Counter/Status/with_js.php index 59bd6a416c00..f46e4f2fd708 100644 --- a/src/UI/examples/Counter/Status/with_js.php +++ b/src/UI/examples/Counter/Status/with_js.php @@ -1,11 +1,30 @@ + * Base example for rendering a JS status counter + * * note: > * Counters also offer an interface for manipulations through JS. * Checkout src/UI/templates/js/Counter/counter.js for a complete spec. @@ -17,7 +36,11 @@ * novelty_count = counter.setNoveltyToStatus().getNoveltyCount(); //novelty count should be 0, status count 3 * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows differennt JS-exmaples which can get altered directly: + * - Click once to raise the status counter to 10. + * - Click once to raise the novelty counter to 1. + * - Click once to change the novelty counter to a status counter. + * - Click once to change the status counter 3 to a novelty counter 7. * --- */ function with_js() diff --git a/src/UI/examples/Counter/Status/with_novelty.php b/src/UI/examples/Counter/Status/with_novelty.php index f1fe57f631e9..04cbc8ed9c64 100755 --- a/src/UI/examples/Counter/Status/with_novelty.php +++ b/src/UI/examples/Counter/Status/with_novelty.php @@ -1,13 +1,32 @@ + * Base example for rendering a status counter with novelty + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a glyph with two counters. The counter's numbers are white and highlighted red resp. grey. * --- */ function with_novelty() diff --git a/src/UI/examples/Deck/base.php b/src/UI/examples/Deck/base.php index ba38231c2970..a47504dc00e8 100755 --- a/src/UI/examples/Deck/base.php +++ b/src/UI/examples/Deck/base.php @@ -1,13 +1,36 @@ + * Example for rendering a base deck. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows nine "Cards" with a title and text each. According to the browser window/desktop size the a different + * number of cards will be displayed per line. + * + * Validating Deck: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Deck/repository.php b/src/UI/examples/Deck/repository.php index ed82b0dbb66d..420f70b491bb 100644 --- a/src/UI/examples/Deck/repository.php +++ b/src/UI/examples/Deck/repository.php @@ -1,13 +1,33 @@ + * Example for rendering a repository card + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows nine cards with a title and text each. Additionally every single card include outlined icons, certificate + * glyphs and action menus. You can open the menus via click. * --- */ function repository() diff --git a/src/UI/examples/Deck/user.php b/src/UI/examples/Deck/user.php index 5bd9216ea419..67e065458ba7 100755 --- a/src/UI/examples/Deck/user.php +++ b/src/UI/examples/Deck/user.php @@ -1,13 +1,34 @@ + * Example for rendering a user card + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows seven "Cards" with a title ("Timon Amstutz") and Text (Adress and E-Mail Adress) each. A button "Request + * Contact" is displayed below each card. Clicking the button won't activate any actions. According to the size of the + * browser window/desktop the number of cards displayed in each line will change. * --- */ function user() diff --git a/src/UI/examples/Deck/xl_card.php b/src/UI/examples/Deck/xl_card.php index 5e65c22f629c..dde55921c3a0 100755 --- a/src/UI/examples/Deck/xl_card.php +++ b/src/UI/examples/Deck/xl_card.php @@ -1,13 +1,33 @@ + * Example for rendering a XL card + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows three "Cards" with a title and text each. The number of cards displayed in each line will change according + * to the size of the browser window/desktop. * --- */ function xl_card() diff --git a/src/UI/examples/Divider/Horizontal/base.php b/src/UI/examples/Divider/Horizontal/base.php index afd6601e6669..49497f2457e4 100644 --- a/src/UI/examples/Divider/Horizontal/base.php +++ b/src/UI/examples/Divider/Horizontal/base.php @@ -1,13 +1,35 @@ + * Example for rendering a horizontal divider. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a fine dark grey dividing line within a light grey box. + * + * Validating Horizontal Divider: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Divider/Horizontal/with_label.php b/src/UI/examples/Divider/Horizontal/with_label.php index ed38decebec4..e63e18da72a6 100644 --- a/src/UI/examples/Divider/Horizontal/with_label.php +++ b/src/UI/examples/Divider/Horizontal/with_label.php @@ -1,13 +1,32 @@ + * Example for rendering a horizontal dividing line with a label + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a bulky white dividing line within a light grey box. The text "Label" is positioned within the line. * --- */ function with_label() diff --git a/src/UI/examples/Divider/Vertical/base.php b/src/UI/examples/Divider/Vertical/base.php index 5a383f957756..af775332bf58 100644 --- a/src/UI/examples/Divider/Vertical/base.php +++ b/src/UI/examples/Divider/Vertical/base.php @@ -1,13 +1,35 @@ + * Example for rendering a vertical dividing line. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a dot centered between two text sections. + * + * Validating Vertical Divider: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Dropdown/Standard/base.php b/src/UI/examples/Dropdown/Standard/base.php index d1bdfa181ce4..c07620de45a0 100755 --- a/src/UI/examples/Dropdown/Standard/base.php +++ b/src/UI/examples/Dropdown/Standard/base.php @@ -1,13 +1,37 @@ + * Example for rendering a dropdown. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button titled "Actions" and a triangle pointing to the bottom. Clicking the button will open a + * dropdown menu with the entries "ILIAS" and "GitHub" rendered as shy buttons. Clicking the entries will open + * the appropriate website in the same browser window. + * + * Validating Dropdown: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Dropdown/Standard/with_aria_label.php b/src/UI/examples/Dropdown/Standard/with_aria_label.php index fe0c8f80f4fb..2b3bb09bf483 100644 --- a/src/UI/examples/Dropdown/Standard/with_aria_label.php +++ b/src/UI/examples/Dropdown/Standard/with_aria_label.php @@ -1,13 +1,34 @@ + * Example for rendering a dropdown with aria labels + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button with a triangle pointing to the bottom without a title. Clicking the button will open a + * dropdown menu with the entries "ILIAS" and "GitHub" rendered as shy buttons. Clicking the entries will open the + * appropriate website in the same browser window. * --- */ function with_aria_label() diff --git a/src/UI/examples/Dropdown/Standard/with_buttons_and_links.php b/src/UI/examples/Dropdown/Standard/with_buttons_and_links.php index 541bf0b9e49d..d5035e6a098e 100644 --- a/src/UI/examples/Dropdown/Standard/with_buttons_and_links.php +++ b/src/UI/examples/Dropdown/Standard/with_buttons_and_links.php @@ -1,13 +1,35 @@ + * Example for rendering a dropdown with buttons and links + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button titled "Actions" and a triangle pointing to the bottom. Clicking the button will open a + * dropdown menu with the entries "ILIAS" rendered as a link and "GitHub" rendered as a shy button. Clicking the + * shy button will open the appropriate website in the same browser window while clicking the link will open the + * appropriate website in a new browser tab., * --- */ function with_buttons_and_links() diff --git a/src/UI/examples/Dropdown/Standard/with_divider.php b/src/UI/examples/Dropdown/Standard/with_divider.php index 8a7f43bdd31b..54949aa21da8 100644 --- a/src/UI/examples/Dropdown/Standard/with_divider.php +++ b/src/UI/examples/Dropdown/Standard/with_divider.php @@ -1,13 +1,34 @@ + * Example for rendering a dropdown with dividers + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button titled "Actions" and a triangle pointing to the bottom. Clicking the button will open a + * dropdown menu with the entries "ILIAS" and "GitHub" rendered as shy buttons. The entries are divided by a fine line. + * Clicking the entries will open the appropriate website in the same browser window. * --- */ function with_divider() diff --git a/src/UI/examples/Dropdown/Standard/with_divider_with_label.php b/src/UI/examples/Dropdown/Standard/with_divider_with_label.php index 3e1fcb613eb6..c4e76264f175 100644 --- a/src/UI/examples/Dropdown/Standard/with_divider_with_label.php +++ b/src/UI/examples/Dropdown/Standard/with_divider_with_label.php @@ -1,13 +1,35 @@ + * Example for rendering a dropdown with a divider including a label + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button titled "Actions" and a triangle pointing to the bottom. Clicking the button will open a + * dropdown menu with the entries "GitHub", "Docu", "Features" and "Bugs" rendered as shy buttons. The last three + * entries are positioned under the not clickable caption "ILIAS". Clicking the entries will open the appropriate + * website in the same browser window. * --- */ function with_divider_with_label() diff --git a/src/UI/examples/Dropzone/File/Standard/base.php b/src/UI/examples/Dropzone/File/Standard/base.php index 9afed36f067f..4a3cf8f1fd80 100644 --- a/src/UI/examples/Dropzone/File/Standard/base.php +++ b/src/UI/examples/Dropzone/File/Standard/base.php @@ -1,13 +1,40 @@ + * Example for rendering a file dropzone. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a white box with a dashed border. You can see a text "Upload files" (displayed as a link) on the left + * side and on the right side the text "Drag files in here to upload them". Clicking onto the link or dragging a file + * into the box opens a small window with the buttons "Save" and "Cancel". If you dragged a file into the box you can + * see the file in said small window too. You can upload any amount of files. The window will be closed if you click + * onto the "Save" button. An upload doesn't happen in this example. If a file got listed after saving your selection + * you can remove the file by clicking the "X" on the right side. + * + * Validating Standard Dropzone File: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Dropzone/File/Standard/with_additional_input.php b/src/UI/examples/Dropzone/File/Standard/with_additional_input.php index eee7fbe7f68b..5e13694da2a5 100644 --- a/src/UI/examples/Dropzone/File/Standard/with_additional_input.php +++ b/src/UI/examples/Dropzone/File/Standard/with_additional_input.php @@ -1,13 +1,39 @@ + * Example for rendering a standard file dropzone with additional input. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a white box with a dashed border. You can see a text "Upload files" (displayed as a link) on the left + * side and on the right side the text "Drag files in here to upload them". Clicking onto the link or dragging a file + * into the box opens a small window with the buttons "Save" and "Cancel". If you dragged a file into the box you can + * see the file in said small window too including a text input under the file. The text input is labeled "Additional + * Input". Below said input "Additional input which affects all files of this upload" is written. You can upload any + * amount of files. The window will be closed if you click onto the "Save" button. An upload doesn't happen in this + * example. If a file got listed after saving your selection you can remove the file by clicking the "X" on the right + * side. * --- */ function with_additional_input() diff --git a/src/UI/examples/Dropzone/File/Wrapper/base.php b/src/UI/examples/Dropzone/File/Wrapper/base.php index 26c5a8c6d20a..f4fc1f95731d 100644 --- a/src/UI/examples/Dropzone/File/Wrapper/base.php +++ b/src/UI/examples/Dropzone/File/Wrapper/base.php @@ -1,13 +1,37 @@ + * Example for rendering a file dropzone wrapper. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a blue box titled "Drag and drop files onto me!". If you drag a file into the box a small window opens + * including two buttons named "Save" and "Close". The file will be shown too. You can remove a uploaded file by clicking + * onto the "X" on the right side. + * + * Validating File Dropzone Wrapper: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Dropzone/File/Wrapper/with_additional_input.php b/src/UI/examples/Dropzone/File/Wrapper/with_additional_input.php index 7176a4488665..2c4652dd7dd0 100644 --- a/src/UI/examples/Dropzone/File/Wrapper/with_additional_input.php +++ b/src/UI/examples/Dropzone/File/Wrapper/with_additional_input.php @@ -1,13 +1,35 @@ + * Example for rendering a file dropzone wrapper with additional input. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a blue box titled "Drag and drop files onto me!". If you drag a file into the box a small window opens + * including two buttons named "Save" and "Close". The file will be shown too. Additionally a text input titled "Additional + * Input" is rendered below the file entry. Below the input "Additional input which affects all files of this upload" is + * written. You can remove a uploaded file by clicking onto the "X" on the right side. * --- */ function with_additional_input() diff --git a/src/UI/examples/Dropzone/File/Wrapper/with_clear_button.php b/src/UI/examples/Dropzone/File/Wrapper/with_clear_button.php index 07fd7817b68d..a4f88d3b6924 100644 --- a/src/UI/examples/Dropzone/File/Wrapper/with_clear_button.php +++ b/src/UI/examples/Dropzone/File/Wrapper/with_clear_button.php @@ -1,13 +1,34 @@ + * Example for rendering a file dropzone wrapper with clear buttons. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a blue box titled "Drag and drop files onto me!". If you drag a file into the box a small window opens + * including three buttons named "Save","Close" and "Clear files!". Clicking the clear button will remove the file. + * The file will be shown too. You can remove a uploaded file by clicking onto the "X" on the right side. * --- */ function with_clear_button() diff --git a/src/UI/examples/Image/Responsive/base.php b/src/UI/examples/Image/Responsive/base.php index f47012ca53ca..3312c6176c31 100755 --- a/src/UI/examples/Image/Responsive/base.php +++ b/src/UI/examples/Image/Responsive/base.php @@ -1,5 +1,21 @@ - * Base example for rendering a responsive Image + * Base example for rendering a responsive Image. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a rendered image. While changing the sitze of the browser window the image will + * decrease in size bit by bit. If the element gets analyzed a text entry for "alt" is shown withing the HTML. + * + * Validating Respsonsive Image: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Image/Standard/base.php b/src/UI/examples/Image/Standard/base.php index 4a9111dbbd29..14e978ec861d 100755 --- a/src/UI/examples/Image/Standard/base.php +++ b/src/UI/examples/Image/Standard/base.php @@ -1,5 +1,21 @@ - * Base example for rendering an Image + * Base example for rendering an Image. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a rendered image with a grey background. While changing the size of the browser window the + * image won't decrease in size. If the element gets analyzed a text entry for "alt" is shown within the HTML. + * + * Validating Standard Image: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Image/Standard/decorative.php b/src/UI/examples/Image/Standard/decorative.php index 714c066b1a77..bb1a9c2f02e8 100755 --- a/src/UI/examples/Image/Standard/decorative.php +++ b/src/UI/examples/Image/Standard/decorative.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a rendered image with a grey background. While changing the size of the browser window the + * image won't decrease in size. If the element gets analyzed no text entry for "alt" is shown within the HTML. * --- */ function decorative() diff --git a/src/UI/examples/Input/Container/Filter/Standard/base.php b/src/UI/examples/Input/Container/Filter/Standard/base.php index e85c5156115a..3674c9b49111 100644 --- a/src/UI/examples/Input/Container/Filter/Standard/base.php +++ b/src/UI/examples/Input/Container/Filter/Standard/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * If the filter with the toggle button on the right top is disabled "Filter Data" is empty. + * If the filter with the toggle button on the right top is enabled "Filter Data" includes the data entered into the filter. + * If the filter is minimized all inputs will be hidden and the values will be displayed minimized. + * If the filter inputs will be applied by clicking the button "Apply" the filter will be employed automatically. The data + * will be displayed accordingly. + * Clicking "Reset" will reset all filter. + * + * Validating Filter: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Container/Form/Standard/base.php b/src/UI/examples/Input/Container/Form/Standard/base.php index 7122c8ec4851..ba286d66eee8 100755 --- a/src/UI/examples/Input/Container/Form/Standard/base.php +++ b/src/UI/examples/Input/Container/Form/Standard/base.php @@ -1,5 +1,21 @@ - * ILIAS zeigt einen Abschnitt mit dem Titel "Section 1" an. - * Dieser enthält ein Eingabefeld mit dem Titel "Basic Input". - * Sie können Zahlen und Buchstaben eingeben. - * Ein Klick auf die Schaltfläche Speichern lädt die Seite neu. + * ILIAS shows a section titled "Section 1" including an input field titled "Basic Input". + * You can enter numbers and letters. + * Clicking "Save" relaods the page. + * + * Validating Standard Form: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Container/Form/Standard/data_processing.php b/src/UI/examples/Input/Container/Form/Standard/data_processing.php index 35e800ff2922..53401e1ac49f 100755 --- a/src/UI/examples/Input/Container/Form/Standard/data_processing.php +++ b/src/UI/examples/Input/Container/Form/Standard/data_processing.php @@ -1,5 +1,21 @@ - * ILIAS zeigt einen Abschnitt mit zwei Eingabefeldern mit den Titeln "Left" und "Right" an. - * Geben Sie jeweils eine ausgeschriebene Zahl auf Englisch zwischen 1 und 10 ein (z.B. "two" und "four"), - * addiert ILIAS diese nach dem Speichern und zeigt das Ergebnis in folgendem Format an: + * ILIAS shows a section with two input fields titled "Left" and "Right". + * Please enter an advertised number in english between 1 and 10 (e.g. "two" and "four"). + * ILIAS will add those numbers after the input was saved. The output will be displayed in following format: * 2 + 4 = 6 - * Machen Sie andere Angaben, reagiert ILIAS mit einer Fehlermeldung unterhalb der Eingabefelder. + * Entering unvalid inputs will result to an error message below the input fields. * --- */ function data_processing() diff --git a/src/UI/examples/Input/Container/Form/Standard/with_dedicated_name.php b/src/UI/examples/Input/Container/Form/Standard/with_dedicated_name.php index f560d4b8b67e..70ba48b839e1 100644 --- a/src/UI/examples/Input/Container/Form/Standard/with_dedicated_name.php +++ b/src/UI/examples/Input/Container/Form/Standard/with_dedicated_name.php @@ -1,5 +1,21 @@ - * Ilias zeigt ein Input Feld mit einem Beschreibungstext "Just Another Input" an. - * Unter dem Feld steht der Text "I'm just another input". - * Drücken sie auf Speichern. - * Es sollte einfach das Feld wieder erscheinen. + * ILIAS shows an input field titled "Just Another Input". + * A text "I'm just another input" is displayed below the field. + * After clicking "Save" the input field should get reloaded. * --- */ function with_dedicated_name() diff --git a/src/UI/examples/Input/Container/Form/Standard/with_keys.php b/src/UI/examples/Input/Container/Form/Standard/with_keys.php index 525ddf162d1a..d48e8f03761a 100755 --- a/src/UI/examples/Input/Container/Form/Standard/with_keys.php +++ b/src/UI/examples/Input/Container/Form/Standard/with_keys.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a section with two input fields titled "Input 1" and "Input 2". You can enter anything you want. + * Your input will be displayed in following format after being saved: + * + * Array + * ( + * [Input1] => Some input 1 + * [Innput2] => Some input 2 + * ) * --- */ function with_keys() diff --git a/src/UI/examples/Input/Field/Checkbox/base.php b/src/UI/examples/Input/Field/Checkbox/base.php index 78bcabcb4673..90c67e6146ee 100644 --- a/src/UI/examples/Input/Field/Checkbox/base.php +++ b/src/UI/examples/Input/Field/Checkbox/base.php @@ -1,5 +1,21 @@ - * Base example showing how to plug a checkbox into a form + * Base example showing how to plug a checkbox into a form. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a section with an active checkbox. The checkbox can get deactivated. After saving the status of the + * checkbox it will be displayed above (activ = 1). + * + * Validating Checkbox: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Checkbox/disabled.php b/src/UI/examples/Input/Field/Checkbox/disabled.php index 63f41b5a769a..30d238f51ab5 100644 --- a/src/UI/examples/Input/Field/Checkbox/disabled.php +++ b/src/UI/examples/Input/Field/Checkbox/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a section with an checkbox. The checkbox can not get changed. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/DateTime/base.php b/src/UI/examples/Input/Field/DateTime/base.php index 2f244166d4ed..a6c4b13ed719 100644 --- a/src/UI/examples/Input/Field/DateTime/base.php +++ b/src/UI/examples/Input/Field/DateTime/base.php @@ -1,5 +1,21 @@ - * Base example showing how to plug date-inputs into a form + * Base example showing how to plug date-inputs into a form. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a group of date and time fields in following format: + * + * - YYYY-MM-DD + * - DD.MM.YYYY + * - HH:mm + * - YYYY-MM-DD HH:mm + * - YYYY-MM-DD HH:mm + * - YYYY-MM-DD HH:mm (pre-filled: current date and time at the current location) + * - YYYY-MM-DD HH:mm (pre-filled: current date and time in Tokyo) + * - YYYY-MM-DD (pre-filled: current date at the current location) + * + * A calendar glyph is displayed next to each field, except for the thrid line: there you can see a clock glyph. + * Clicking the glyphs will display following options: + * + * - Line 1: Selection of any date in the future + * - Line 2: Selection of a date in the future + * - Line 3: Selection of any time + * - Line 4: Selection of any date and any time + * - Line 5: Selection of any date and any time + * - Line 6: Selection of any date and any time + * - Line 7: Selection of any date and any time + * - Line 8: This field is disabled. No selection possible. + * + * Now click "Save". + * ILIAS reloads the page and displays the selection in an array. The outputs have to be the same as your selection. + * Regarding pure date or time fields: the output might display the current date and time 00:00. + * + * Validating DateTime: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Duration/base.php b/src/UI/examples/Input/Field/Duration/base.php index a6c79be26a04..7b2c487a4b20 100644 --- a/src/UI/examples/Input/Field/Duration/base.php +++ b/src/UI/examples/Input/Field/Duration/base.php @@ -1,5 +1,21 @@ - * Base example showing how to plug date-inputs into a form + * Base example showing how to plug date-inputs into a form. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a group with eight date and time fields. Each are connected are mark the beginning and end of a period of time: + * + * - Selection of a date (beginning) + * - Selection of a date (ending) + * - Selection of a time (beginning) + * - Selection of a time (ending) + * - Selection of a date including time (beginning) + * - Selection of a date including time (ending) + * - No selection possible (beginning) + * - No selection possible (ending) + * + * A calendar glyph is displayer next to each field, except for line 3 and 4, which display a clock glyph. + * You can choose a date/time in line 1-6 through clicking the glyphs. + * Please save the selection. + * ILIAS reloads the page and displays your selection in a array overview. The selection has to be the same as the output. + * Regarding pure date or time fields: the output might display the current date and time 00:00. + * + * Validating Duration: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/File/base.php b/src/UI/examples/Input/Field/File/base.php index 882fcca7810a..9a523e85c8bc 100755 --- a/src/UI/examples/Input/Field/File/base.php +++ b/src/UI/examples/Input/Field/File/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a field titled "Upload File" next to a box surrounded by dashed lines. You can choose a file by dragging + * the file to the box or by clicking "Select files". If you save your selection ILIAS will reset the field. + * + * Validating File: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/File/in_form.php b/src/UI/examples/Input/Field/File/in_form.php index 1ef870cb4804..587efc141fde 100755 --- a/src/UI/examples/Input/Field/File/in_form.php +++ b/src/UI/examples/Input/Field/File/in_form.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a field titled "Upload File" next to a box surrounded by dashed lines. Choose a file by clicking "Select + * files" or dragging a file to the box. Save your selection. ILIAS will confirm your action in following format: + * + * Array + * ( + * [file] => Array + * ( + * [0] => 06f7d8e94a28d102cf35483e346c121c + * ) + * ) * --- */ function in_form() diff --git a/src/UI/examples/Input/Field/Group/base.php b/src/UI/examples/Input/Field/Group/base.php index 00361a16d0b7..da8d7fe8f943 100755 --- a/src/UI/examples/Input/Field/Group/base.php +++ b/src/UI/examples/Input/Field/Group/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a group of two input fields titled "Left" and "Right". You can insert numbers. Clicking "Save" reloads + * the page. If the addition of both the inserted numbers equals 10 ILIAS will display following: + * + * Array + * ( + * [custom_group] => 10 + * ) + * + * Else the error message "The sum must equal ten." will be displayed. + * + * Validating Group: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Group/disabled.php b/src/UI/examples/Input/Field/Group/disabled.php index 0130fc90558a..66d65bbe413b 100644 --- a/src/UI/examples/Input/Field/Group/disabled.php +++ b/src/UI/examples/Input/Field/Group/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a group of two input fields titled "Left" and "Right". The number "5" is already displayed in both fields + * and can not get changed, because the fields are deactivated. Clicking "Save" will reload the page and ILIAS displays + * following above the box: + * + * Array + * ( + * [custom_group] => 10 + * ) * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Hidden/base.php b/src/UI/examples/Input/Field/Hidden/base.php index c7442dc1e987..53f2d9833848 100755 --- a/src/UI/examples/Input/Field/Hidden/base.php +++ b/src/UI/examples/Input/Field/Hidden/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an empty white field. Clicking "Save" relaods the page. + * + * Validating Hidden: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Link/base.php b/src/UI/examples/Input/Field/Link/base.php index 632140e85f3f..7380f300c1a2 100644 --- a/src/UI/examples/Input/Field/Link/base.php +++ b/src/UI/examples/Input/Field/Link/base.php @@ -1,13 +1,39 @@ + * Example of rendering a link. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows two input fields titled "Label" and "URL". You can enter letters and number into the label field. You + * can enter a valid URL into the URL field. Please insert a valid label and URL and save your input. This should not + * throw any errors. + * Now enter a text into the label field and an unvalid URL into the URL field and save your input. An error message + * should be displayed. + * + * Validating Link: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/MultiSelect/base.php b/src/UI/examples/Input/Field/MultiSelect/base.php index e6d73148ed21..2631c1073964 100644 --- a/src/UI/examples/Input/Field/MultiSelect/base.php +++ b/src/UI/examples/Input/Field/MultiSelect/base.php @@ -1,5 +1,21 @@ - * Base example showing how to plug a Multi-Select into a form + * Base example showing how to plug a Multi-Select into a form. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a groupd titled "Take your picks" with checkboxes. You can activate one or more checkboxes. After saving + * your selection ILIAS will display your selection in following format: + * + * Array + * ( + * [multi] => Array + * ( + * [0] => 2 + * [1] => 3 + * ) + * ) + * + * If you click "Save" without selecting a checkbox ILIAS will display a error message below the group. + * + * Validating MultiSelect: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/MultiSelect/empty_options.php b/src/UI/examples/Input/Field/MultiSelect/empty_options.php index 050d8c8b3b94..3f90fd38f568 100644 --- a/src/UI/examples/Input/Field/MultiSelect/empty_options.php +++ b/src/UI/examples/Input/Field/MultiSelect/empty_options.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an empty field with following text: "No options". Clicking "Save" will result into following output: + * + * Array + * ( + * [empty] => + * ) * --- */ function empty_options() diff --git a/src/UI/examples/Input/Field/Numeric/numeric_inputs.php b/src/UI/examples/Input/Field/Numeric/numeric_inputs.php index 98e3ffa29573..55c4094df907 100755 --- a/src/UI/examples/Input/Field/Numeric/numeric_inputs.php +++ b/src/UI/examples/Input/Field/Numeric/numeric_inputs.php @@ -1,5 +1,21 @@ - * Base example showing how to plug a numeric input into a form + * Base example showing how to plug a numeric input into a form. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows two input fields titled "Some Number". One input field already displays a number. The other input field + * is required (*). You can enter numbers into the fields or choose a number through useing the arrows at the end of the fields. + * Clicking "Save" reloads the page. + * Afterwards ILIAS will show the inserted number in the following format: + * + * Array + * ( + * [n1] => 56 + * [n2] => 77 + * ) + * + * If you insert one or more non-numeric numbers into the field the input field will get highlighted in red. Saving + * those inputs results to displaying a error message right above the required field. + * + * Validating Numeric: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function numeric_inputs() diff --git a/src/UI/examples/Input/Field/OptionalGroup/base.php b/src/UI/examples/Input/Field/OptionalGroup/base.php index b263c6bb7451..16450bdb2c42 100644 --- a/src/UI/examples/Input/Field/OptionalGroup/base.php +++ b/src/UI/examples/Input/Field/OptionalGroup/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * Next to the title "Optional Group" ILIAS displays a checkbox with a byline. If the checkbox is activated two input + * fields "Item 1" and "Item 2" are displayed including a byline each. If the ckeckbox is deactivated those two input + * fields are not visible. + * If you activate the checkbox, fill out the text field and the date field and click "Save" the following output will + * be displayed above the box: + * + * Array + * ( + * [0] => Array + * ( + * [dependant_text] => MEINE EINGABE + * [dependant_date] => DateTimeImmutable Object + * ( + * [date] => EINGEGEBENES-DATUM-ALS-YYYY-MM-DD 00:00:00.000000 + * [timezone_type] => 3 + * [timezone] => Europe/Berlin + * ) + * ) + * ) + * + * Validating OptionalGroup: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/OptionalGroup/with_required_sub_inputs.php b/src/UI/examples/Input/Field/OptionalGroup/with_required_sub_inputs.php index 33924d769040..893c545feed7 100644 --- a/src/UI/examples/Input/Field/OptionalGroup/with_required_sub_inputs.php +++ b/src/UI/examples/Input/Field/OptionalGroup/with_required_sub_inputs.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a optional group titled "this input is not required" and a checkbox with a byline. + * + * Save the checkbox and click "Save": + * 1. Did you leave the text field empty a red error message is displayed accordingly to the system language. + * 2. Did you fill out the text field the output looks like the base optional group example. + * + * Deactivate the checkbox and click "Save": + * 1. No error message is displayed. * --- */ function with_required_sub_inputs() diff --git a/src/UI/examples/Input/Field/Password/base.php b/src/UI/examples/Input/Field/Password/base.php index 86453c61a896..740980d057fe 100755 --- a/src/UI/examples/Input/Field/Password/base.php +++ b/src/UI/examples/Input/Field/Password/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a input field titled "Password". An inserted text won't be displayed but exchanged with dots. Clicking + * "Save" will reload the page. + * + * Validating Password: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Password/in_form.php b/src/UI/examples/Input/Field/Password/in_form.php index 10d1088b9b8d..aa05519617ca 100755 --- a/src/UI/examples/Input/Field/Password/in_form.php +++ b/src/UI/examples/Input/Field/Password/in_form.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Password". An inserted text won't be displayed but exchanged with dots. Clicking + * the Eyeopen-Glyph will display your input. Clicking that gyph again will hide your input. Clicking "Save" will + * reload the page and display your input in the following format in the box above: + * + * Array + * ( + * [password] => ILIAS\Data\Password Object + * ( + * [pass:ILIAS\Data\Password:private] => Passwort Test + * ) + * ) * --- */ function in_form() diff --git a/src/UI/examples/Input/Field/Password/with_contraints.php b/src/UI/examples/Input/Field/Password/with_contraints.php index 10bd9ec579d5..cc6980249a64 100644 --- a/src/UI/examples/Input/Field/Password/with_contraints.php +++ b/src/UI/examples/Input/Field/Password/with_contraints.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Password". An inserted text won't be displayed but exchanged with dots. + * ILIAS will apply your password if following requirements are fullfilled: + * - At least eight letters + * - At least one number + * - At least one capital letter + * - At least one lowercase letter + * - At least one special character + * Else ILIAS will display an error message above the input field. + * Clicking "Save" will reload the page and show your input in following format in the box above: + * + * Array + * ( + * [pwd] => ILIAS\Data\Password Object + * ( + * [pass:ILIAS\Data\Password:private] => Passwort-1 + * ) + * ) * --- */ function with_contraints() diff --git a/src/UI/examples/Input/Field/Radio/base.php b/src/UI/examples/Input/Field/Radio/base.php index c9809ce83e85..7b16b3fef7f7 100644 --- a/src/UI/examples/Input/Field/Radio/base.php +++ b/src/UI/examples/Input/Field/Radio/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a group titled "Radio" with three radio buttons: + * - label1 + * - label2 + * - label3 + * + * You can only activate one radio button at a time. Save your selection. ILIAS will display your selection in following format: + * + * Array + * ( + * [radio] => value3 + * ) + * + * Validating Radio: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Radio/disabled.php b/src/UI/examples/Input/Field/Radio/disabled.php index ef3a2f8d1f75..ac21ebcc16c8 100644 --- a/src/UI/examples/Input/Field/Radio/disabled.php +++ b/src/UI/examples/Input/Field/Radio/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a group titled "Radio" with three radio buttons: + * - label1 + * - label2 + * - label3 + * + * You can not select any options as the radio buttons are disabled. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Section/base.php b/src/UI/examples/Input/Field/Section/base.php index 6ef0f07edc0b..e82413ece84b 100755 --- a/src/UI/examples/Input/Field/Section/base.php +++ b/src/UI/examples/Input/Field/Section/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a section with two input fields and a byline. The section is titled "Equals 10", the input fields are + * labeled "Left" and "Right". You can insert numbers. Clicking "Save" will reload the page. If the addition of the + * inserted numbers is 10 ILIAS will output a display accordingly. Else an error message "The sum must equal ten" will + * be displayed under the fields. + * + * Validating Section: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Section/disabled.php b/src/UI/examples/Input/Field/Section/disabled.php index beeef67fc3ea..58b983781361 100644 --- a/src/UI/examples/Input/Field/Section/disabled.php +++ b/src/UI/examples/Input/Field/Section/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a section with two input fields and a byline. The section is titled "Equals 10", the input fields are + * labeled "Left" and "Right". The number 5 is already displayed in both input fields and can not be changed. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Select/base.php b/src/UI/examples/Input/Field/Select/base.php index cef5f9dd9741..59efd9d439f4 100644 --- a/src/UI/examples/Input/Field/Select/base.php +++ b/src/UI/examples/Input/Field/Select/base.php @@ -1,5 +1,21 @@ - * Base example showing how to plug a Select into a form + * Base example showing how to plug a Select into a form. * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a button titled "Choose an Option". No option is selected. If you choose an option and save your selection + * ILIAS will show you your selection in following format: + * + * Array + * ( + * [0] => 2 + * ) + * + * You can use the save function without selecting any options. + * + * Validating Select: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Select/disabled.php b/src/UI/examples/Input/Field/Select/disabled.php index f83366fdb2f2..7b9b451437ea 100644 --- a/src/UI/examples/Input/Field/Select/disabled.php +++ b/src/UI/examples/Input/Field/Select/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a selection button but it's disabled. You can not select any option. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Select/with_required.php b/src/UI/examples/Input/Field/Select/with_required.php index c0d31842c152..c77a33a06b6b 100644 --- a/src/UI/examples/Input/Field/Select/with_required.php +++ b/src/UI/examples/Input/Field/Select/with_required.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a selection button titled "Choose an Option" including a red asterisk. No option is selected. If you + * choose an option and click save ILIAS will display your selection in following format: + * + * Array ( + * [0] => 1 + * ) + * + * Do not choose an option (saving without having choosen an option): ILIAS will display an error message. * --- */ function with_required() diff --git a/src/UI/examples/Input/Field/SwitchableGroup/base.php b/src/UI/examples/Input/Field/SwitchableGroup/base.php index d56f02c3815f..f07f5c17492d 100644 --- a/src/UI/examples/Input/Field/SwitchableGroup/base.php +++ b/src/UI/examples/Input/Field/SwitchableGroup/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows three radio button groups titled "Pick One", "Pick One*" and "Again, Pick One" with a byline each. + * According to your selection of the radio button three input fields, one input field with a standard text or no + * input field will be displayed. The second option in the third group is already activated. + * Please select some radio buttons ("Pick One*" is required), fill out the input fields and click "Save". Afterwards + * ILIAS will display following content in the box above: + * + * Array + * ( + * [switchable_group] => Array + * ( + * [0] => 1 + * [1] => Array + * ( + * [field_1_1] => Text 1 + * [field_1_2] => Text 2 + * [field_1_3] => DateTimeImmutable Object + * ( + * [date] => 2022-08-01 00:00:00.000000 + * [timezone_type] => 3 + * [timezone] => Europe/Berlin + * ) + * ) + * ) + * [switchable_group_required] => Array + * ( + * [0] => g2 + * [1] => Array + * ( + * [field_2_1] => Verpflichtender Text + * ) + * ) + * [switchable_group_preset] => Array + * ( + * [0] => g3 + * [1] => Array + * ( + * ) + * ) + * ) + * + * Validating SwitchableGroup: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/SwitchableGroup/with_disabled.php b/src/UI/examples/Input/Field/SwitchableGroup/with_disabled.php index ba6e44306d27..9f436e53f6c1 100644 --- a/src/UI/examples/Input/Field/SwitchableGroup/with_disabled.php +++ b/src/UI/examples/Input/Field/SwitchableGroup/with_disabled.php @@ -1,13 +1,32 @@ + * Example showing how a dependant group (aka sub form) might be attached to a radio while being disabled. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a group of two radio buttons titled "Disabled Switchable Group". Selecting a radio button is not possible. * --- */ function with_disabled() diff --git a/src/UI/examples/Input/Field/Tag/base.php b/src/UI/examples/Input/Field/Tag/base.php index b8843b5c39b6..dd856ecaa81b 100644 --- a/src/UI/examples/Input/Field/Tag/base.php +++ b/src/UI/examples/Input/Field/Tag/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic Tag". If typing an A, B, I or R into the field ILIAS will display a + * completion of the possible Tags. It is also possible to insert Tags of your own and confirm those through hitting the + * Enter button on your keyboard. Tags which are inserted and confirmed will be highlighted with a color. A "X" is positioned + * directly next to each tag. You can remove the Tag through clicking the "X". + * + * Validating Tag: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Tag/base_with_data.php b/src/UI/examples/Input/Field/Tag/base_with_data.php index 8aa38b9a08f9..57ea77cfe1ce 100644 --- a/src/UI/examples/Input/Field/Tag/base_with_data.php +++ b/src/UI/examples/Input/Field/Tag/base_with_data.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic TagInput". ILIAS will display a completion of the tags if an A, B, I or R + * is typed in. It is also possible to insert tags of your own and confirm those through hitting the Enter button on your + * keyboard. Afterwards the tags get highlighted with color. An "X" is positioned directly next to each tag. Removing + * a tag is possible through clicking the "X". + * Clicking "Save" reloads the page and displays your input in the following format above teh input field: + * + * Array + * ( + * [0] => Array + * ( + * [0] => Interesting + * [1] => Animating + * [2] => Whatever + * ) + * ) * --- */ function base_with_data() diff --git a/src/UI/examples/Input/Field/Tag/base_with_value.php b/src/UI/examples/Input/Field/Tag/base_with_value.php index ebf1ffc525a4..165fec879616 100644 --- a/src/UI/examples/Input/Field/Tag/base_with_value.php +++ b/src/UI/examples/Input/Field/Tag/base_with_value.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic TagInput". The Tag "Interesting" is already displayed and can get removed + * through clicking the "X". A completion of the tags will be displayed by ILIAS if an A, B, I or R is typed into the field. + * It is also possible to insert tags of your own and confirm those through hitting the Enter button on your keyboard. + * Afterwards the tags will be highlighted with color. An "X" is displayed directly next to each tag. Clicking the "X" + * will remove the tag. + * Clicking "Save" will reload the page and will set the Tag in the input field back to "Interesting". * --- */ function base_with_value() diff --git a/src/UI/examples/Input/Field/Tag/disabled.php b/src/UI/examples/Input/Field/Tag/disabled.php index 4b90e289d585..ec7772ff347f 100644 --- a/src/UI/examples/Input/Field/Tag/disabled.php +++ b/src/UI/examples/Input/Field/Tag/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic TagInput". The Tags "Boring" and "Animating" are already displayed. Changing + * the input is not possible. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Text/base.php b/src/UI/examples/Input/Field/Text/base.php index b967ee3b1f0e..a7a786015a62 100755 --- a/src/UI/examples/Input/Field/Text/base.php +++ b/src/UI/examples/Input/Field/Text/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a text field titled "Basic Input". You can enter numbers and letters into the field. Clicking "Save" + * reloads the page. + * + * Validating Text: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Text/disabled.php b/src/UI/examples/Input/Field/Text/disabled.php index 4b70dc604f96..101366f81890 100644 --- a/src/UI/examples/Input/Field/Text/disabled.php +++ b/src/UI/examples/Input/Field/Text/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a text field titled "Disabled Input". You can not activate and type anything into the field. + * Clicking "Save" will reload the page. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Text/with_error.php b/src/UI/examples/Input/Field/Text/with_error.php index 0195ecb3e310..e083e71b41af 100755 --- a/src/UI/examples/Input/Field/Text/with_error.php +++ b/src/UI/examples/Input/Field/Text/with_error.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a text field titled "Basic Input". You can enter numbers and letters into the field. Above the field + * a color-coded error message "Some error" is displayed. Clicking "Save" will reload the page. * --- */ function with_error() diff --git a/src/UI/examples/Input/Field/Text/with_value.php b/src/UI/examples/Input/Field/Text/with_value.php index 302b6b00991f..f284a7ce73a1 100755 --- a/src/UI/examples/Input/Field/Text/with_value.php +++ b/src/UI/examples/Input/Field/Text/with_value.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows a text field titled "Basic Input". The field is already filled with the text "Default Value". You can + * enter numbers and letter into the field. Clicking "Save" will relaod the page. * --- */ function with_value() diff --git a/src/UI/examples/Input/Field/Textarea/base.php b/src/UI/examples/Input/Field/Textarea/base.php index 416e30a2e756..7af61995f575 100644 --- a/src/UI/examples/Input/Field/Textarea/base.php +++ b/src/UI/examples/Input/Field/Textarea/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Textarea Input". You can enter a text as long or short as ones likes. After saving + * the text ILIAS will display the input in following format: + * + * Array + * ( + * [0] => My Text + * ) + * + * Validating Textarea: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Textarea/disabled.php b/src/UI/examples/Input/Field/Textarea/disabled.php index 55814b88e9ad..49f469a874a8 100644 --- a/src/UI/examples/Input/Field/Textarea/disabled.php +++ b/src/UI/examples/Input/Field/Textarea/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Disabled Textarea Input". You can not enter a text. ILIAS will show you an oupput + * in following format after clicking "Save": + * + * Array + * ( + * [0] => + * ) * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Textarea/with_limits.php b/src/UI/examples/Input/Field/Textarea/with_limits.php index c8850c8f3a08..9ce290f68cf9 100644 --- a/src/UI/examples/Input/Field/Textarea/with_limits.php +++ b/src/UI/examples/Input/Field/Textarea/with_limits.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Textarea Input". You can enter a text with 20 letters max. Try entering the following + * text: "Test text with more than 20 letters". You can not enter more letters/words after "Test text with more" and + * the counter "Characters remaining" is set to 0. After saving the input ILIAS will display your text in following format: + * + * Array + * ( + * [0] => Test text with more + * ) * --- */ function with_limits() diff --git a/src/UI/examples/Input/Field/Url/base.php b/src/UI/examples/Input/Field/Url/base.php index 6267f2347b84..f4a4e20184ce 100644 --- a/src/UI/examples/Input/Field/Url/base.php +++ b/src/UI/examples/Input/Field/Url/base.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic Input". You can enter letters and numbers. Clicking "Save" will reload the page. + * + * Validating Url: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Input/Field/Url/disabled.php b/src/UI/examples/Input/Field/Url/disabled.php index 83d97bc837c0..990454994cae 100644 --- a/src/UI/examples/Input/Field/Url/disabled.php +++ b/src/UI/examples/Input/Field/Url/disabled.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Disabled Input". You can not activate the field and therefore you can also not + * enter any text. Clicking "Save" will relaod the page. * --- */ function disabled() diff --git a/src/UI/examples/Input/Field/Url/with_error.php b/src/UI/examples/Input/Field/Url/with_error.php index b954f6907806..be63ae41b178 100644 --- a/src/UI/examples/Input/Field/Url/with_error.php +++ b/src/UI/examples/Input/Field/Url/with_error.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic Input". You can enter numbers and letters. The colored error message "Some + * error" is displayed above the field. Clicking "Save" will relaod the page. * --- */ function with_error() diff --git a/src/UI/examples/Input/Field/Url/with_value.php b/src/UI/examples/Input/Field/Url/with_value.php index 96f3243d2297..0d9c5f2a5345 100644 --- a/src/UI/examples/Input/Field/Url/with_value.php +++ b/src/UI/examples/Input/Field/Url/with_value.php @@ -1,5 +1,21 @@ - * ILIAS shows the rendered Component. + * ILIAS shows an input field titled "Basic Input". The field is pre-filled with the text "https://www.iliasd.de/". + * If you enter a URL and click "Save" your input should be displayed in the field. If you enter a random text (no URL) + * and save your input an error message should be displayed (There is some error in this part.). * --- */ function with_value() diff --git a/src/UI/examples/Item/Group/base.php b/src/UI/examples/Item/Group/base.php index 65b57ca63bdd..7d6fd4fdd430 100644 --- a/src/UI/examples/Item/Group/base.php +++ b/src/UI/examples/Item/Group/base.php @@ -1,13 +1,36 @@ + * Example for rendering a group item. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a group with two items: "Item Title" and "Item Title 2". The group's heading is "Subtitle 1". Both items + * have got an action menu. + * + * Validating Item Group: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Item/Group/with_actions.php b/src/UI/examples/Item/Group/with_actions.php index 85e3fa09126a..76113173149e 100644 --- a/src/UI/examples/Item/Group/with_actions.php +++ b/src/UI/examples/Item/Group/with_actions.php @@ -1,13 +1,33 @@ + * Example for rendering a group item with actions. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a group with two items: "Item Title" and "Item Title 2". The group's heading is "Subtitle 1". Both items + * have got an action menu. Additionally the group itself has got an action menu too. * --- */ function with_actions() diff --git a/src/UI/examples/Item/Notification/base.php b/src/UI/examples/Item/Notification/base.php index d4bd1df90fdf..c8e806c66311 100644 --- a/src/UI/examples/Item/Notification/base.php +++ b/src/UI/examples/Item/Notification/base.php @@ -1,13 +1,36 @@ + * Example for rendering a notification item. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box titled "Inbox" on a white background and including following text: "You have 23 unread mails in + * your inbox". A dashed line and a time indication (Time 3 days ago) are displayed below. + * + * Validating Notification Item: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Item/Notification/closable.php b/src/UI/examples/Item/Notification/closable.php index b0a03cf524d6..fb13ef6dc5de 100644 --- a/src/UI/examples/Item/Notification/closable.php +++ b/src/UI/examples/Item/Notification/closable.php @@ -1,13 +1,34 @@ + * Example for rendering a closable notification item. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box titled "Inbox" on a white background and including following text: "You have 23 unread mails in + * your inbox". A dashed line and a time indication (Time 3 days ago) are displayed below. Additionally a "X" is rendered + * on the right side of the box. Clicking the "X" will close the box. * --- */ function closable() diff --git a/src/UI/examples/Item/Notification/include_aggregates.php b/src/UI/examples/Item/Notification/include_aggregates.php index 5c31bfaaf5c3..72fe1dde12b7 100644 --- a/src/UI/examples/Item/Notification/include_aggregates.php +++ b/src/UI/examples/Item/Notification/include_aggregates.php @@ -1,13 +1,35 @@ + * Example for rendering a notificication item including aggregates. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box titled "Item" on a white background and following text: "Notification Item with Aggregates". + * Clicking the item's heading will collapse another field with the same content. On the right side an "X" for closing the + * boxes is displayed. Additionally you can see two dropdown fields on the right side including two entries each. + * On the top the heading " + * Example for rendering a shy item. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box highlighted white and including the text "Test shy Item". + * + * Validating Shy Item: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Item/Shy/with_close.php b/src/UI/examples/Item/Shy/with_close.php index c04b4a171bfd..c2a9cda8248d 100644 --- a/src/UI/examples/Item/Shy/with_close.php +++ b/src/UI/examples/Item/Shy/with_close.php @@ -1,13 +1,34 @@ + * Example for rendering a shy item with a close function. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a "X" for closing the item + * is displayed on the right side. If you click onto the "X" nothing will happen. This example only serves to show you + * the rendering of that close button. * --- */ function with_close() diff --git a/src/UI/examples/Item/Shy/with_description.php b/src/UI/examples/Item/Shy/with_description.php index b19ced8eb80e..e62d08f44347 100644 --- a/src/UI/examples/Item/Shy/with_description.php +++ b/src/UI/examples/Item/Shy/with_description.php @@ -1,13 +1,33 @@ + * Example for rendering a shy item with a description. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a short description is displayed + * below the text. * --- */ function with_description() diff --git a/src/UI/examples/Item/Shy/with_lead_icon.php b/src/UI/examples/Item/Shy/with_lead_icon.php index 59a2bf4e8a87..cf25ac7e33f8 100644 --- a/src/UI/examples/Item/Shy/with_lead_icon.php +++ b/src/UI/examples/Item/Shy/with_lead_icon.php @@ -1,5 +1,21 @@ + * Example for rendering a shy item with an lead icon. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a small icon is displayed + * to the left of the text. * --- */ function with_lead_icon() diff --git a/src/UI/examples/Item/Shy/with_long_description.php b/src/UI/examples/Item/Shy/with_long_description.php index 2451e8a67256..f0496f22ec90 100644 --- a/src/UI/examples/Item/Shy/with_long_description.php +++ b/src/UI/examples/Item/Shy/with_long_description.php @@ -1,13 +1,33 @@ + * Example for rendering a shy item with a long description. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a multi-lined description + * is displayed below the text. * --- */ function with_long_description() diff --git a/src/UI/examples/Item/Shy/with_properties.php b/src/UI/examples/Item/Shy/with_properties.php index 007217f37873..4481ecbd465e 100644 --- a/src/UI/examples/Item/Shy/with_properties.php +++ b/src/UI/examples/Item/Shy/with_properties.php @@ -1,13 +1,33 @@ + * Example for rendering a shy item with properties. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box highlighted white and including the text "Test shy Item". Additionally a fine dashed line is displayed + * below the text. Right below the line you can see the information "Property: Value". * --- */ function with_properties() diff --git a/src/UI/examples/Item/Standard/base.php b/src/UI/examples/Item/Standard/base.php index 7405c9dbb597..7faa781fb3a4 100644 --- a/src/UI/examples/Item/Standard/base.php +++ b/src/UI/examples/Item/Standard/base.php @@ -1,13 +1,37 @@ + * Example for rendering a standard item. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading "Item Title" with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" + * and "Location". Additionally a action menu is displayed in the box on the right top. + * + * Validating Standard Item: + * You do not get an error message. You can ignore warnings, but have in mind that you do not should receive errors. * --- */ function base() diff --git a/src/UI/examples/Item/Standard/with_audio_player.php b/src/UI/examples/Item/Standard/with_audio_player.php index 32b8002051e0..aed929482ec8 100644 --- a/src/UI/examples/Item/Standard/with_audio_player.php +++ b/src/UI/examples/Item/Standard/with_audio_player.php @@ -1,13 +1,35 @@ + * Example for rendering a standard item with an audio player. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box with following informations: The ILIAS-Logo, "ILIAS Audio" as heading and a dummy text in small + * writings ("Lorem ipsum...") below. Beneath those you can see a player to play an audio file. Below that player a fine + * line and more informations about the lengths of the file are displayed. Additionally the box includes an action menu + * on the right top. * --- */ function with_audio_player(): string diff --git a/src/UI/examples/Item/Standard/with_image_and_progress.php b/src/UI/examples/Item/Standard/with_image_and_progress.php index 8e6c7c2d49ec..929da815f6ba 100644 --- a/src/UI/examples/Item/Standard/with_image_and_progress.php +++ b/src/UI/examples/Item/Standard/with_image_and_progress.php @@ -1,13 +1,34 @@ + * Example for rendering a standard item with an image and displaying the progress. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading "Item Title" with a dummy text in small writings + * ("Lorem ipsum...") below. On the left side a ILIAS icon is displayed, on the right side you can see a pictorial representation + * and also a text (75%) about the progress. * --- */ function with_image_and_progress() diff --git a/src/UI/examples/Item/Standard/with_lead_avatar.php b/src/UI/examples/Item/Standard/with_lead_avatar.php index c2362ce043ec..6737942dc21f 100644 --- a/src/UI/examples/Item/Standard/with_lead_avatar.php +++ b/src/UI/examples/Item/Standard/with_lead_avatar.php @@ -1,13 +1,35 @@ + * Example for rendering a standard item with an lead avatar. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows two very similiar boxes including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Last Update" + * and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a avatar is + * displayed. * --- */ function with_lead_avatar() diff --git a/src/UI/examples/Item/Standard/with_lead_icon.php b/src/UI/examples/Item/Standard/with_lead_icon.php index 55404826850f..4dbae7eeeed9 100644 --- a/src/UI/examples/Item/Standard/with_lead_icon.php +++ b/src/UI/examples/Item/Standard/with_lead_icon.php @@ -1,13 +1,35 @@ + * Example for rendering a standard item with an lead icon. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" + * and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a "Course" icon + * is displayed. * --- */ function with_lead_icon() diff --git a/src/UI/examples/Item/Standard/with_lead_image.php b/src/UI/examples/Item/Standard/with_lead_image.php index f1aa6d4be273..5dc8a919541c 100644 --- a/src/UI/examples/Item/Standard/with_lead_image.php +++ b/src/UI/examples/Item/Standard/with_lead_image.php @@ -1,13 +1,35 @@ + * Example for rendering a standard item with an lead image. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" + * and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a ILIAS-Logo + * is displayed. On small screens the logo is rendered above the title. * --- */ function with_lead_image() diff --git a/src/UI/examples/Item/Standard/with_lead_text.php b/src/UI/examples/Item/Standard/with_lead_text.php index 61419580d6bb..14e69acdacb0 100644 --- a/src/UI/examples/Item/Standard/with_lead_text.php +++ b/src/UI/examples/Item/Standard/with_lead_text.php @@ -1,13 +1,35 @@ + * Example for rendering a standard item with an lead text. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" + * and "Location". Additionally a action menu is displayed in the box on the right top. On the left side a period of time + * (11:20-12:40) is displayed. On small screens the period of time will be rendered above the title. * --- */ function with_lead_text() diff --git a/src/UI/examples/Item/Standard/with_link_title.php b/src/UI/examples/Item/Standard/with_link_title.php index de144eadf81b..85206919970f 100644 --- a/src/UI/examples/Item/Standard/with_link_title.php +++ b/src/UI/examples/Item/Standard/with_link_title.php @@ -1,13 +1,34 @@ + * Example for rendering a standard item with a link title. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A title with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Code Repo" and + * "Location". The title is rendered as a link and redirects to ilias.de. * --- */ function with_link_title() diff --git a/src/UI/examples/Item/Standard/with_main_action.php b/src/UI/examples/Item/Standard/with_main_action.php index 55bd38341f50..2ac78762bdef 100644 --- a/src/UI/examples/Item/Standard/with_main_action.php +++ b/src/UI/examples/Item/Standard/with_main_action.php @@ -1,13 +1,35 @@ + * Example for rendering a standard item with main actions. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" + * and "Location". Additionally a action menu is displayed in the box on the right top. On the left next to the action + * menu a "Edit" button ist rendered. * --- */ function with_main_action() diff --git a/src/UI/examples/Item/Standard/with_main_link_action.php b/src/UI/examples/Item/Standard/with_main_link_action.php index 8415885d6269..3f02c870416e 100644 --- a/src/UI/examples/Item/Standard/with_main_link_action.php +++ b/src/UI/examples/Item/Standard/with_main_link_action.php @@ -1,13 +1,34 @@ + * Example for rendering a standard item with a main action displayed as a link. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Origin", "Last Update" + * and "Location". Additionally a link titled "Open ILIAS" is rendered on the right top side of the box. * --- */ function with_main_link_action() diff --git a/src/UI/examples/Item/Standard/with_progress.php b/src/UI/examples/Item/Standard/with_progress.php index 7b4beb69e7aa..39c0e4798fdc 100644 --- a/src/UI/examples/Item/Standard/with_progress.php +++ b/src/UI/examples/Item/Standard/with_progress.php @@ -1,13 +1,33 @@ + * Example for rendering a standard item with a progress meter. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Additionally a progress meter (75%) is rendered on the right top side of the box. * --- */ function with_progress() diff --git a/src/UI/examples/Item/Standard/with_shy_properties.php b/src/UI/examples/Item/Standard/with_shy_properties.php index 57f1113975fa..4f20bba8730b 100644 --- a/src/UI/examples/Item/Standard/with_shy_properties.php +++ b/src/UI/examples/Item/Standard/with_shy_properties.php @@ -1,13 +1,34 @@ + * Example for rendering a standard item with shy properties. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "LMS", "Code Repo" + * and "Location". "Code Repo" ("ILIAS") and "LMS" ("GitHub") are rendered as shy buttons and are functioning as links. * --- */ function with_shy_properties() diff --git a/src/UI/examples/Item/Standard/with_shy_title.php b/src/UI/examples/Item/Standard/with_shy_title.php index 625c92f3d958..36df0b8ed617 100644 --- a/src/UI/examples/Item/Standard/with_shy_title.php +++ b/src/UI/examples/Item/Standard/with_shy_title.php @@ -1,13 +1,34 @@ + * Example for rendering a standard item with shy titles. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box including the following informations: A heading with a dummy text in small writings + * ("Lorem ipsum...") below. Beneath those you can see a fine line and more informations about "Code Repo" + * and "Location". "Code Repo" ("ILIAS") is rendered as shy link. * --- */ function with_shy_title() diff --git a/src/UI/examples/Layout/Page/Standard/ui.php b/src/UI/examples/Layout/Page/Standard/ui.php index 4d1707a1221a..f3dfad4381f3 100644 --- a/src/UI/examples/Layout/Page/Standard/ui.php +++ b/src/UI/examples/Layout/Page/Standard/ui.php @@ -1,5 +1,21 @@ + * Example for rendering a UI. + * * expected output: > - * ILIAS shows the rendered Component. + * ILIAS shows a box with a link "See UI in fullscreen-mode". Clicking the link will redirect to a ILIAS standard + * page. Clicking onto "Tools" in the navigation tree on the left side will open a slate with dummy buttons. + * + * Identify the main aria roles: + * Use "search element" or F12 - a function from the developer tools. + * 1. Check the HTML element which shows the Page Header including the logo, title and metabar: + * The Header is characterized by
. Therefore he ARIA landmark role "banner" is available. + * 2. Check the HTML element which shows the Page Content: + * The Content is characterized by
. Therefore the ARIA landmark role "main" available. + * 3. Check the HTML element which shows the Page Footer: + * The Footer is characterized by