From 9116fcd802ef02aebfa2d94a96aebdb21febde1a Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Mon, 5 Nov 2018 18:17:53 +0100 Subject: [PATCH] [TASK] Migrate existing ViewHelper docs to valid rst * In order to allow proper rendering at docs.typo3.org * Only migrated HTML to rst, and streamlined structure. Resolves: #86855 Releases: master, 9.5 Change-Id: Ia617d24b0e70182b8702b23a340ad1f2b536910e Reviewed-on: https://review.typo3.org/c/58844 Tested-by: Christian Kuhn Tested-by: TYPO3com Tested-by: Susanne Moog Tested-by: Anja Leichsenring Reviewed-by: Christian Kuhn Reviewed-by: Susanne Moog Reviewed-by: Anja Leichsenring --- .../ViewHelpers/Link/EditRecordViewHelper.php | 20 ++-- .../ViewHelpers/Link/NewRecordViewHelper.php | 60 ++++++------ .../Button/LinkButtonViewHelper.php | 13 ++- .../Button/ShortcutButtonViewHelper.php | 13 ++- .../ModuleLayout/MenuItemViewHelper.php | 13 ++- .../ModuleLayout/MenuViewHelper.php | 13 ++- .../ViewHelpers/ModuleLayoutViewHelper.php | 20 ++-- .../ViewHelpers/Uri/EditRecordViewHelper.php | 14 +-- .../ViewHelpers/Uri/NewRecordViewHelper.php | 36 ++++--- .../Classes/ViewHelpers/BaseViewHelper.php | 17 ++-- .../ViewHelpers/Be/Buttons/CshViewHelper.php | 34 +++---- .../Be/Buttons/ShortcutViewHelper.php | 27 +++--- .../ViewHelpers/Be/ContainerViewHelper.php | 25 +++-- .../ViewHelpers/Be/InfoboxViewHelper.php | 35 ++++--- .../ViewHelpers/Be/Labels/CshViewHelper.php | 21 ++-- .../Classes/ViewHelpers/Be/LinkViewHelper.php | 16 +-- .../Menus/ActionMenuItemGroupViewHelper.php | 27 +++--- .../Be/Menus/ActionMenuItemViewHelper.php | 35 ++++--- .../Be/Menus/ActionMenuViewHelper.php | 35 ++++--- .../ViewHelpers/Be/PageInfoViewHelper.php | 12 +-- .../ViewHelpers/Be/PagePathViewHelper.php | 14 +-- .../ViewHelpers/Be/PageRendererViewHelper.php | 15 ++- .../Be/Security/IfAuthenticatedViewHelper.php | 44 ++++----- .../Be/Security/IfHasRoleViewHelper.php | 52 +++++----- .../ViewHelpers/Be/TableListViewHelper.php | 21 ++-- .../Classes/ViewHelpers/Be/UriViewHelper.php | 27 +++--- .../Be/Widget/PaginateViewHelper.php | 31 +++--- .../Classes/ViewHelpers/CObjectViewHelper.php | 30 +++--- .../ViewHelpers/Debug/RenderViewHelper.php | 6 +- .../Classes/ViewHelpers/DebugViewHelper.php | 21 ++-- .../ViewHelpers/FlashMessagesViewHelper.php | 97 ++++++++++--------- .../ViewHelpers/Form/ButtonViewHelper.php | 29 +++--- .../ViewHelpers/Form/CheckboxViewHelper.php | 48 +++++---- .../ViewHelpers/Form/HiddenViewHelper.php | 16 +-- .../ViewHelpers/Form/PasswordViewHelper.php | 16 +-- .../ViewHelpers/Form/RadioViewHelper.php | 54 ++++++----- .../Form/Select/OptgroupViewHelper.php | 4 +- .../Form/Select/OptionViewHelper.php | 2 +- .../ViewHelpers/Form/SelectViewHelper.php | 53 +++++----- .../ViewHelpers/Form/SubmitViewHelper.php | 29 +++--- .../ViewHelpers/Form/TextareaViewHelper.php | 16 +-- .../ViewHelpers/Form/TextfieldViewHelper.php | 16 +-- .../ViewHelpers/Form/UploadViewHelper.php | 16 +-- .../Form/ValidationResultsViewHelper.php | 81 ++++++++-------- .../Classes/ViewHelpers/FormViewHelper.php | 34 ++++--- .../ViewHelpers/Format/BytesViewHelper.php | 42 ++++---- .../ViewHelpers/Format/CaseViewHelper.php | 21 ++-- .../ViewHelpers/Format/CropViewHelper.php | 48 +++++---- .../ViewHelpers/Format/CurrencyViewHelper.php | 55 +++++------ .../ViewHelpers/Format/DateViewHelper.php | 80 +++++++-------- .../ViewHelpers/Format/HtmlViewHelper.php | 47 +++++---- .../Format/HtmlentitiesDecodeViewHelper.php | 25 +++-- .../Format/HtmlentitiesViewHelper.php | 25 +++-- .../ViewHelpers/Format/JsonViewHelper.php | 36 ++++--- .../ViewHelpers/Format/Nl2brViewHelper.php | 25 +++-- .../ViewHelpers/Format/NumberViewHelper.php | 25 +++-- .../ViewHelpers/Format/PaddingViewHelper.php | 36 ++++--- .../Format/StripTagsViewHelper.php | 47 +++++---- .../Format/UrlencodeViewHelper.php | 23 +++-- .../Classes/ViewHelpers/ImageViewHelper.php | 75 +++++++------- .../ViewHelpers/Link/ActionViewHelper.php | 17 ++-- .../ViewHelpers/Link/EmailViewHelper.php | 30 +++--- .../ViewHelpers/Link/ExternalViewHelper.php | 29 +++--- .../ViewHelpers/Link/PageViewHelper.php | 45 +++++---- .../ViewHelpers/Link/TypolinkViewHelper.php | 45 +++++---- .../Classes/ViewHelpers/MediaViewHelper.php | 48 ++++----- .../Security/IfAuthenticatedViewHelper.php | 45 +++++---- .../Security/IfHasRoleViewHelper.php | 56 ++++++----- .../ViewHelpers/TranslateViewHelper.php | 57 +++++------ .../ViewHelpers/Uri/ActionViewHelper.php | 14 +-- .../ViewHelpers/Uri/EmailViewHelper.php | 17 ++-- .../ViewHelpers/Uri/ExternalViewHelper.php | 25 +++-- .../ViewHelpers/Uri/ImageViewHelper.php | 49 +++++----- .../ViewHelpers/Uri/PageViewHelper.php | 36 ++++--- .../ViewHelpers/Uri/ResourceViewHelper.php | 17 ++-- .../ViewHelpers/Uri/TypolinkViewHelper.php | 27 +++--- .../Widget/AutocompleteViewHelper.php | 23 +++-- .../ViewHelpers/Widget/LinkViewHelper.php | 17 ++-- .../ViewHelpers/Widget/PaginateViewHelper.php | 30 +++--- .../ViewHelpers/Widget/UriViewHelper.php | 14 +-- .../Classes/ViewHelpers/RenderViewHelper.php | 8 +- 81 files changed, 1298 insertions(+), 1219 deletions(-) diff --git a/typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php index b9068cef8080..648421dc7f4a 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php @@ -14,16 +14,18 @@ * The uid must be given as a positive integer. * For new records, use the newRecordViewHelper * - * = Examples = + * Examples + * -------- * - * - * - * - * - * - * Edit record - * - * + * Link to the record-edit action passed to FormEngine:: + * + * + * + * Output:: + * + * + * Edit record + * */ class EditRecordViewHelper extends AbstractTagBasedViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php index 16b2d4c3b1f0..47c0a2056014 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php @@ -26,34 +26,38 @@ * * To edit records, use the editRecordViewHelper * - * = Examples = - * - * - * - * - * - * - * Edit record - * - * - * - * - * - * - * - * - * Edit record - * - * - * - * - * - * - * - * - * Edit record - * - * + * Examples + * -------- + * + * Link to create a new record of a_table after record 17 on the same pid:: + * + * + * + * Output:: + * + * + * Edit record + * + * + * Link to create a new record of a_table on root page:: + * + * + * + * Output:: + * + * + * Edit record + * + * + * Link to create a new record of a_table on page 17:: + * + * + * + * Output:: + * + * + * Edit record + * */ class NewRecordViewHelper extends AbstractTagBasedViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/LinkButtonViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/LinkButtonViewHelper.php index ee7ff6ddb655..10097564d5b8 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/LinkButtonViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/LinkButtonViewHelper.php @@ -22,16 +22,19 @@ /** * A view helper for adding a link button to the doc header area. * It must be a child of - * = Examples = - * - * + * + * Examples + * -------- + * + * Default:: + * + * * - * - * + * */ class LinkButtonViewHelper extends AbstractButtonViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/ShortcutButtonViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/ShortcutButtonViewHelper.php index d8253bb0ecc5..351e9e0c157b 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/ShortcutButtonViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/ShortcutButtonViewHelper.php @@ -25,12 +25,15 @@ /** * A view helper for adding a shortcut button to the doc header area. * It must be a child of - * = Examples = - * - * + * + * Examples + * -------- + * + * Default:: + * + * * - * - * + * */ class ShortcutButtonViewHelper extends AbstractButtonViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuItemViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuItemViewHelper.php index 0bbcc0aa2996..99dce5bcf2dd 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuItemViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuItemViewHelper.php @@ -27,14 +27,17 @@ /** * A view helper for adding a menu item to a doc header menu. * It must be a child of - * = Examples = - * - * + * + * Examples + * -------- + * + * Default:: + * + * * * * - * - * + * */ class MenuItemViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuViewHelper.php index 0cdc6b672967..962bb0300bc0 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuViewHelper.php @@ -28,14 +28,17 @@ * A view helper for adding a menu to the doc header area. * It must be a child of and accepts * only view helpers as children. - * = Examples = - * - * + * + * Examples + * -------- + * + * Default:: + * + * * * * - * - * + * */ class MenuViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayoutViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayoutViewHelper.php index dbac1a7da1e0..d5d0347083e5 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayoutViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/ModuleLayoutViewHelper.php @@ -28,15 +28,19 @@ * It will render the required HTML for the doc header. * All module specific output and further configuration of the doc header * must be rendered as children of this view helper. - * = Examples = - * - * + * + * Examples + * ======== + * + * Default:: + * + * * - * - * - * - * - * + * + * + * Output:: + * + * */ class ModuleLayoutViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php index 68e9dba855a8..dcb292c1c2dc 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php @@ -16,14 +16,14 @@ * The uid must be given as a positive integer. * For new records, use the newRecordViewHelper * - * = Examples = + * Examples + * ======== * - * - * - * - * - * /typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar - * + * URI to the record-edit action passed to FormEngine:: + * + * + * + * ``/typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar`` */ class EditRecordViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php b/typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php index 231ce17a8b5f..6c2ccc597edd 100644 --- a/typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php +++ b/typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php @@ -28,28 +28,26 @@ * * To edit records, use the editRecordViewHelper * - * = Examples = + * Examples + * ======== * - * - * - * - * - * /typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar - * + * Uri to create a new record of a_table after record 17 on the same pid:: * - * - * - * - * - * /typo3/index.php?route=/record/edit&edit[a_table][]=new&returnUrl=foo/bar - * + * * - * - * - * - * - * /typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar - * + * ``/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar`` + * + * Uri to create a new record of a_table on root page:: + * + * + * + * ``/typo3/index.php?route=/record/edit&edit[a_table][]=new&returnUrl=foo/bar`` + * + * Uri to create a new record of a_table on page 17:: + * + * + * + * ``/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar`` */ class NewRecordViewHelper extends AbstractTagBasedViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php index 4ce37312b0ef..ef05cffc3dcd 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php @@ -23,15 +23,18 @@ * current request. * In TYPO3 Flow, you should always include this ViewHelper to make the links work. * - * = Examples = + * Examples + * -------- + * + * Example:: + * + * + * + * Output:: + * + * * - * - * - * - * - * * (depending on your domain) - * */ class BaseViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php index 1b6fba5479af..4a11a32931c3 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php @@ -24,30 +24,28 @@ * set to something else than "Display no help information" in the Users settings * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- + * + * Default:: + * + * * - * - * - * - * * CSH button as known from the TYPO3 backend. - * * - * - * - * - * + * Full configuration:: + * + * + * * CSH button as known from the TYPO3 backend with some custom settings. - * * - * - * - * some text to link - * - * - * + * Full configuration with content:: + * + * + * some text to link + * + * * A link with text "some text to link" to link the help - * */ class CshViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/ShortcutViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/ShortcutViewHelper.php index 12ba44799249..86dc2a2390f6 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/ShortcutViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/ShortcutViewHelper.php @@ -23,25 +23,26 @@ * View helper which returns shortcut button with icon * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- + * + * Default:: + * + * * - * - * - * - * * Shortcut button as known from the TYPO3 backend. * By default the current page id, module name and all module arguments will be stored - * * - * - * - * - * + * Explicitly set parameters to be stored in the shortcut:: + * + * + * * Shortcut button as known from the TYPO3 backend. * This time only the specified GET parameters and SET[]-settings will be stored. - * Note: - * Normally you won't need to set getVars & setVars parameters in Extbase modules - * + * + * .. note: + * + * Normally you won't need to set getVars & setVars parameters in Extbase modules */ class ShortcutViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.php index a9cc8eda0bd5..4acd6278ee92 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.php @@ -20,25 +20,24 @@ /** * View helper which allows you to create extbase based modules in the style of TYPO3 default modules. * - * = Examples = + * Examples + * -------- + * + * Simple:: + * + * your module content * - * - * your module content - * - * * "your module content" wrapped with proper head & body tags. * Default backend CSS styles and JavaScript will be included - * * - * - * your module content - * - * + * All options:: + * + * your module content + * * "your module content" wrapped with proper head & body tags. - * Custom CSS file EXT:your_extension/Resources/Public/Css/styles.css and - * JavaScript files EXT:your_extension/Resources/Public/JavaScript/Library1.js and EXT:your_extension/Resources/Public/JavaScript/Library2.js + * Custom CSS file ``EXT:your_extension/Resources/Public/Css/styles.css`` and + * JavaScript files ``EXT:your_extension/Resources/Public/JavaScript/Library1.js`` and ``EXT:your_extension/Resources/Public/JavaScript/Library2.js`` * will be loaded, plus some inline labels for usage in JS code. - * */ class ContainerViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php index 5c5c95fcaadb..f6ef27196861 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php @@ -22,30 +22,37 @@ /** * View helper for rendering a styled content infobox markup. * - * = States = + * States + * ------ * * The Infobox provides different context sensitive states that * can be used to provide an additional visual feedback to the * to the user to underline the meaning of the information. * - * Possible values are in range from -2 to 2. Please choose a + * Possible values are in range from ``-2`` to ``2``. Please choose a * meaningful value from the following list. * - * -2: Notices (Default) - * -1: Information - * 0: Positive feedback - * 1: Warnings - * 2: Error + * ``-2`` + * Notices (Default) + * ``-1`` + * Information + * ``0`` + * Positive feedback + * ``1`` + * Warnings + * ``2`` + * Error * - * = Examples = + * Examples + * -------- * - * - * your box content - * + * Simple:: * - * - * - * + * your box content + * + * All options:: + * + * */ class InfoboxViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php index 4ccab629ac4e..1576b6f7b481 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php @@ -25,21 +25,20 @@ * set to something else than "Display no help information" in the Users settings * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- + * + * Default:: + * + * * - * - * - * - * * CSH label as known from the TYPO3 backend. - * * - * - * - * - * + * Full configuration:: + * + * + * * CSH label as known from the TYPO3 backend with some custom settings. - * */ class CshViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php index 3d983e54bf9c..7e54c10f4add 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php @@ -20,13 +20,15 @@ /** * A view helper for creating URIs to modules. - * = Examples = - * - * Go to web_ts - * - * - * Go to web_ts - * + * + * Examples + * -------- + * + * URI to the web_ts module on page 92:: + * + * Go to web_ts + * + * ``Go to web_ts`` */ class LinkViewHelper extends AbstractTagBasedViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php index 902dd1792ff9..f305ffb1c65a 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php @@ -19,20 +19,23 @@ /** * View helper which groups options of an option tag. * - * = Example = + * Example + * ------- * - * - * - * + * :: * - * - * - * - * - * - * - * - * + * + * + * + * + * + * + * + * + * + * + * + * */ class ActionMenuItemGroupViewHelper extends ActionMenuViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php index 6e0bf2c7105e..791e99ff495c 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php @@ -21,28 +21,27 @@ * This view helper only works in conjunction with \TYPO3\CMS\Fluid\ViewHelpers\Be\Menus\ActionMenuViewHelper * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- + * + * Simple:: + * + * + * + * + * + * * - * - * - * - * - * - * - * - * * Selectbox with the options "Overview", "Create new Blog" and "List Posts" - * * - * - * - * - * - * - * - * + * Localized:: + * + * + * + * + * + * * localized selectbox - * */ class ActionMenuItemViewHelper extends AbstractTagBasedViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php index 1d0d80b28845..d0d9db36ff40 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php @@ -23,28 +23,27 @@ * multiple actions and controllers and looks similar to TYPO3s funcMenu. * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- + * + * Simple:: + * + * + * + * + * + * * - * - * - * - * - * - * - * - * * Selectbox with the options "Overview", "Create new Blog" and "List Posts" - * * - * - * - * - * - * - * - * + * Localized:: + * + * + * + * + * + * * localized selectbox - * */ class ActionMenuViewHelper extends AbstractTagBasedViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php index 7c9d906f2925..1769a19a5f17 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php @@ -25,14 +25,14 @@ * View helper which return page info icon as known from TYPO3 backend modules * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- + * + * Default:: + * + * * - * - * - * - * * Page info icon with context menu - * */ class PageInfoViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php index 02a3a0469f96..1c87c2280c17 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php @@ -24,14 +24,14 @@ * View helper which returns the current page path as known from TYPO3 backend modules * Note: This view helper is experimental! * - * = Examples = + * Examples + * -------- * - * - * - * - * - * Current page path, prefixed with "Path:" and wrapped in a span with the class "typo3-docheader-pagePath" - * + * Default:: + * + * + * + * Current page path, prefixed with "Path:" and wrapped in a span with the class ``typo3-docheader-pagePath``. */ class PagePathViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php index d9500de3eb19..c6afd37c1980 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php @@ -24,17 +24,16 @@ /** * View helper which allows you to create extbase based modules in the style of TYPO3 default modules. * - * = Examples = + * Examples + * -------- * - * - * - * - * + * All options:: * - * Custom CSS file EXT:your_extension/Resources/Public/Css/styles.css and - * JavaScript files EXT:your_extension/Resources/Public/JavaScript/Library1.js and EXT:your_extension/Resources/Public/JavaScript/Library2.js + * + * + * Custom CSS file ``EXT:your_extension/Resources/Public/Css/styles.css`` and + * JavaScript files ``EXT:your_extension/Resources/Public/JavaScript/Library1.js`` and ``EXT:your_extension/Resources/Public/JavaScript/Library2.js`` * will be loaded, plus some inline labels for usage in JS code. - * */ class PageRendererViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php index 49e5bbb26b2e..e46fd84ee61c 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php @@ -19,31 +19,29 @@ /** * This view helper implements an ifAuthenticated/else condition for BE users/groups. * - * = Examples = - * - * - * - * This is being shown whenever a BE user is logged in - * - * - * + * Examples + * -------- + * + * Basic usage:: + * + * + * This is being shown whenever a BE user is logged in + * + * * Everything inside the tag is being displayed if you are authenticated with any BE user account. - * - * - * - * - * - * This is being shown in case you have access. - * - * - * This is being displayed in case you do not have access. - * - * - * - * + * + * IfAuthenticated / then / else:: + * + * + * + * This is being shown in case you have access. + * + * + * This is being displayed in case you do not have access. + * + * + * * Everything inside the "then" tag is displayed if you have access. - * Otherwise, everything inside the "else"-tag is displayed. - * */ class IfAuthenticatedViewHelper extends AbstractConditionViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php index 715fd0c65936..d1e0d81b667c 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php @@ -19,40 +19,38 @@ /** * This view helper implements an ifHasRole/else condition for BE users/groups. * - * = Examples = + * Examples + * -------- + * + * Basic usage:: + * + * + * This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive) + * * - * - * - * This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive) - * - * - * * Everything inside the tag is being displayed if the logged in BE user belongs to the specified role. - * * - * - * - * This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1" - * - * - * + * Using the usergroup uid as role identifier:: + * + * + * This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1" + * + * * Everything inside the tag is being displayed if the logged in BE user belongs to the specified role. - * * - * - * - * - * This is being shown in case you have the role. - * - * - * This is being displayed in case you do not have the role. - * - * - * - * + * IfRole / then / else:: + * + * + * + * This is being shown in case you have the role. + * + * + * This is being displayed in case you do not have the role. + * + * + * * Everything inside the "then" tag is displayed if the logged in BE user belongs to the specified role. * Otherwise, everything inside the "else"-tag is displayed. - * */ class IfHasRoleViewHelper extends AbstractConditionViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php index 5cc47e221244..9116a3737d56 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php @@ -22,25 +22,24 @@ * View helper which renders a record list as known from the TYPO3 list module * Note: This feature is experimental! * - * = Examples = + * Examples + * -------- + * + * Minimal:: + * + * * - * - * - * - * * List of all "Website user" records stored in the configured storage PID. * Records will be editable, if the current BE user has got edit rights for the table "fe_users". * Only the title column (username) will be shown. * Context menu is active. - * * - * - * - * - * + * Full:: + * + * + * * List of "Website user" records with a text property of "foo" stored on PID 1 and two levels down. * Clicking on a username will open the TYPO3 info popup for the respective record - * */ class TableListViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php index 16f2363a2cec..365c2230faf9 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php @@ -19,20 +19,21 @@ /** * A view helper for creating URIs to modules. - * = Examples = - * - * - * - * - * /typo3/index.php?M=web_ts&moduleToken=b6e9c9f?id=92 - * * - * - * {f:be.uri(route: 'web_ts', parameters: '{id: 92}')} - * - * - * /typo3/index.php?route=%2module%2web_ts%2&moduleToken=b6e9c9f?id=92 - * + * Examples + * -------- + * + * URI to the web_ts module on page 92:: + * + * + * + * ``/typo3/index.php?M=web_ts&moduleToken=b6e9c9f?id=92`` + * + * Inline notation:: + * + * {f:be.uri(route: 'web_ts', parameters: '{id: 92}')} + * + * ``/typo3/index.php?route=%2module%2web_ts%2&moduleToken=b6e9c9f?id=92`` */ class UriViewHelper extends AbstractBackendViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/PaginateViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/PaginateViewHelper.php index f80b07a51547..81bf2202f205 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/PaginateViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/PaginateViewHelper.php @@ -18,24 +18,27 @@ /** * This ViewHelper renders a Pagination of objects for the TYPO3 Backend. * - * = Examples = + * Examples + * -------- * - * - * - * use {paginatedBlogs} as you used {blogs} before, most certainly inside - * a loop. - * - * + * required arguments:: + * + * + * use {paginatedBlogs} as you used {blogs} before, most certainly inside + * a loop. + * + * + * full configuration:: + * + * + * use {paginatedBlogs} as you used {blogs} before, most certainly inside + * a loop. + * * - * - * - * use {paginatedBlogs} as you used {blogs} before, most certainly inside - * a loop. - * * The recordsLabel can be used to replace the text in "Records 1 - 99" with a label of your own choice - * * - * = Performance characteristics = + * Performance characteristics + * --------------------------- * * In the above examples, it looks like {blogs} contains all Blog objects, thus * you might wonder if all objects were fetched from the database. diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php index bf2fb49b1251..48490da25422 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php @@ -27,28 +27,26 @@ * This ViewHelper renders CObjects from the global TypoScript configuration. * NOTE: You have to ensure proper escaping (htmlspecialchars/intval/etc.) on your own! * - * = Examples = + * Examples + * -------- + * + * Render lib object:: + * + * * - * - * - * - * * rendered lib.someLibObject - * * - * - * - * - * + * Specify cObject data & current value:: + * + * + * * rendered lib.customHeader. data and current value will be available in TypoScript - * * - * - * {article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')} - * - * + * inline notation:: + * + * {article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')} + * * rendered lib.customHeader. data will be available in TypoScript - * */ class CObjectViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php index 1f964ad9462c..d85db44b0ebf 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php @@ -23,10 +23,10 @@ * rendering operation but wraps the output with HTML * that can be inspected with the admin panel in FE. * - * Replaces `f:render` when the admin panel decides + * Replaces ``f:render`` when the admin panel decides * (see ViewHelperResolver class). Also possible to use - * explicitly by using `f:debug.render` instead of the - * normal `f:render` statement. + * explicitly by using ``f:debug.render`` instead of the + * normal ``f:render`` statement. */ class RenderViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php index 3713d7aaf826..a0f0af0f9126 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php @@ -22,21 +22,20 @@ /** * This ViewHelper generates a HTML dump of the tagged variable. * - * = Examples = + * Examples + * -------- + * + * Simple:: + * + * {testVariables.array} * - * - * {testVariables.array} - * - * * foobarbazfoo - * * - * - * {blogs} - * - * + * All Features:: + * + * {blogs} + * * [A HTML view of the var_dump] - * */ class DebugViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php index bb106a99b061..e59dd55ebfe8 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php @@ -26,56 +26,59 @@ * In case you need custom Flash Message HTML output, please write your own ViewHelper for the moment. * * - * = Examples = + * Examples + * -------- + * + * Simple:: + * + * * - * - * - * - * * A list of flash messages. - * - * - * - * - * - * - *
- *
- *
- *
- * - * - * - * - *
- *
- *

Info - Title for Info message

- *

Message text here.

+ * + * TYPO3 core style:: + * + * + * + * Output:: + * + *
+ *
+ *
+ *
+ * + * + * + * + *
+ *
+ *

Info - Title for Info message

+ *

Message text here.

+ *
*
- *
- *
- *
- * - * - * - *
- * - *
{flashMessage.code}
- *
{flashMessage.message}
- * - *
- * - * - * - *
- *
1013
- *
Some Warning Message.
- *
- * - * - * - * - * + *
+ *
+ * + * Output flash messages as a description list:: + * + * + *
+ * + *
{flashMessage.code}
+ *
{flashMessage.message}
+ * + *
+ * + * + * Output:: + * + *
+ *
1013
+ *
Some Warning Message.
+ *
+ * + * Using a specific queue:: + * + * */ class FlashMessagesViewHelper extends AbstractViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php index 9159b1de6059..bab41376e43b 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php @@ -17,21 +17,24 @@ /** * Creates a button. * - * = Examples = + * Examples + * -------- * - * - * Send Mail - * - * - * - * + * Defaults:: * - * - * Cancel - * - * - * - * + * Send Mail + * + * Output:: + * + * + * + * Disabled cancel button with some HTML5 attributes:: + * + * Cancel + * + * Output:: + * + * */ class ButtonViewHelper extends AbstractFormFieldViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php index 2940384bc55b..a4be1b9462d2 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php @@ -17,30 +17,36 @@ /** * View Helper which creates a simple checkbox (). * - * = Examples = - * - * - * - * - * - * - * - * - * - * - * - * - * + * Examples + * -------- + * + * Example:: + * + * + * + * Output:: + * + * + * + * Preselect:: + * + * + * + * Output:: + * + * + * * (depending on $object) - * * - * - * - * - * - * + * Bind to object property:: + * + * + * + * Output:: + * + * + * * (depending on property "interests") - * */ class CheckboxViewHelper extends AbstractFormFieldViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/HiddenViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/HiddenViewHelper.php index 6a816b7ee7ef..c9f1de5775a9 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/HiddenViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/HiddenViewHelper.php @@ -17,14 +17,16 @@ /** * Renders an tag. * - * = Examples = + * Examples + * -------- * - * - * - * - * - * - * + * Example:: + * + * + * + * Output:: + * + * * * You can also use the "property" attribute if you have bound an object to the form. * See for more documentation. diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php index 9bbee5287d7e..3a38f0212b5c 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php @@ -17,14 +17,16 @@ /** * View Helper which creates a simple Password Text Box (). * - * = Examples = + * Examples + * -------- * - * - * - * - * - * - * + * Example:: + * + * + * + * Output:: + * + * */ class PasswordViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php index eeab4d0e8633..9c7202725874 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php @@ -17,32 +17,38 @@ /** * View Helper which creates a simple radio button (). * - * = Examples = - * - * - * - * - * - * - * - * - * - * - * - * - * + * Examples + * -------- + * + * Example:: + * + * + * + * Output:: + * + * + * + * Preselect:: + * + * + * + * Output:: + * + * + * * (depending on $object) - * - * - * - * yes - * no - * - * - * yes - * no + * + * Bind to object property:: + * + * yes + * no + * + * Output:: + * + * yes + * no + * * (depending on property "newsletter") - * */ class RadioViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php index 266d0d8317bd..8298d6506f47 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php @@ -15,8 +15,8 @@ */ /** - * Adds custom `` tags inside an ``, - * supports further child `` tags. + * Adds custom ```` tags inside an ````, + * supports further child ```` tags. */ class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper { diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php index 77fd067abaff..36707e70ab1a 100644 --- a/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php +++ b/typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php @@ -16,7 +16,7 @@ use TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper; /** - * Adds custom `