[TASK] Migrate existing ViewHelper docs to valid rst 44/58844/15
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Mon, 5 Nov 2018 17:17:53 +0000 (18:17 +0100)
committerAnja Leichsenring <aleichsenring@ab-softlab.de>
Sat, 23 Feb 2019 16:41:38 +0000 (17:41 +0100)
* 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 <lolli@schwarzbu.ch>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Susanne Moog <susanne.moog@typo3.org>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Reviewed-by: Susanne Moog <susanne.moog@typo3.org>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
81 files changed:
typo3/sysext/backend/Classes/ViewHelpers/Link/EditRecordViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/Link/NewRecordViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/LinkButtonViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/Button/ShortcutButtonViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuItemViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/ModuleLayout/MenuViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/ModuleLayoutViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/BaseViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/ShortcutViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/InfoboxViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Labels/CshViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/LinkViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemGroupViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuItemViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Menus/ActionMenuViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/PageInfoViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/PagePathViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/PageRendererViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfAuthenticatedViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Security/IfHasRoleViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/TableListViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Widget/PaginateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/CObjectViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Debug/RenderViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/ButtonViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/HiddenViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/PasswordViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/RadioViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptgroupViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/Select/OptionViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/SelectViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/SubmitViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextareaViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextfieldViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/UploadViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/ValidationResultsViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/FormViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/BytesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CaseViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CropViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/CurrencyViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/DateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesDecodeViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/JsonViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/Nl2brViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/NumberViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/PaddingViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/StripTagsViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/UrlencodeViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/ImageViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/ActionViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/EmailViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/ExternalViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/PageViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Link/TypolinkViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/MediaViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Security/IfAuthenticatedViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Security/IfHasRoleViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/TranslateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ActionViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/EmailViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ExternalViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ImageViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/PageViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/ResourceViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Uri/TypolinkViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/AutocompleteViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/LinkViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/PaginateViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/UriViewHelper.php
typo3/sysext/form/Classes/ViewHelpers/RenderViewHelper.php

index b9068ce..648421d 100644 (file)
@@ -14,16 +14,18 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * The uid must be given as a positive integer.
  * For new records, use the newRecordViewHelper
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Link to the record-edit action passed to FormEngine">
- * <be:link.editRecord uid="42" table="a_table" returnUrl="foo/bar" />
- * </code>
- * <output>
- * <a href="/typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar">
- *   Edit record
- * </a>
- * </output>
+ * Link to the record-edit action passed to FormEngine::
+ *
+ *    <be:link.editRecord uid="42" table="a_table" returnUrl="foo/bar" />
+ *
+ * Output::
+ *
+ *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar">
+ *      Edit record
+ *    </a>
  */
 class EditRecordViewHelper extends AbstractTagBasedViewHelper
 {
index 16b2d4c..47c0a20 100644 (file)
@@ -26,34 +26,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  * To edit records, use the editRecordViewHelper
  *
- * = Examples =
- *
- * <code title="Link to create a new record of a_table after record 17 on the same pid">
- * <be:link.newRecord table="a_table" returnUrl="foo/bar" uid="-17"/>
- * </code>
- * <output>
- * <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
- *   Edit record
- * </a>
- * </output>
- *
- * <code title="Link to create a new record of a_table on root page">
- * <be:link.newRecord table="a_table" returnUrl="foo/bar""/>
- * </code>
- * <output>
- * <a href="/typo3/index.php?route=/record/edit&edit[a_table][]=new&returnUrl=foo/bar">
- *   Edit record
- * </a>
- * </output>
- *
- * <code title="Link to create a new record of a_table on page 17">
- * <be:link.newRecord table="a_table" returnUrl="foo/bar" pid="17"/>
- * </code>
- * <output>
- * <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
- *   Edit record
- * </a>
- * </output>
+ * Examples
+ * --------
+ *
+ * Link to create a new record of a_table after record 17 on the same pid::
+ *
+ *    <be:link.newRecord table="a_table" returnUrl="foo/bar" uid="-17"/>
+ *
+ * Output::
+ *
+ *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
+ *      Edit record
+ *    </a>
+ *
+ * Link to create a new record of a_table on root page::
+ *
+ *    <be:link.newRecord table="a_table" returnUrl="foo/bar""/>
+ *
+ * Output::
+ *
+ *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][]=new&returnUrl=foo/bar">
+ *      Edit record
+ *    </a>
+ *
+ * Link to create a new record of a_table on page 17::
+ *
+ *    <be:link.newRecord table="a_table" returnUrl="foo/bar" pid="17"/>
+ *
+ * Output::
+ *
+ *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
+ *      Edit record
+ *    </a>
  */
 class NewRecordViewHelper extends AbstractTagBasedViewHelper
 {
index ee7ff6d..1009756 100644 (file)
@@ -22,16 +22,19 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 /**
  * A view helper for adding a link button to the doc header area.
  * It must be a child of <be:moduleLayout>
- * = Examples =
- * <code>
- * <be:moduleLayout>
+ *
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <be:moduleLayout>
  *      <be:moduleLayout.button.linkButton
  *          icon="actions-add"
  *          title="Add record')}"
  *          link="{be:uri.newRecord(table: 'tx_my_table')}"
  *      />
- * </be:moduleLayout>
- * </code>
+ *    </be:moduleLayout>
  */
 class LinkButtonViewHelper extends AbstractButtonViewHelper
 {
index d8253bb..351e9e0 100644 (file)
@@ -25,12 +25,15 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 /**
  * A view helper for adding a shortcut button to the doc header area.
  * It must be a child of <be:moduleLayout>
- * = Examples =
- * <code>
- * <be:moduleLayout>
+ *
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <be:moduleLayout>
  *      <be:moduleLayout.button.shortcutButton displayName="Shortcut label" />
- * </be:moduleLayout>
- * </code>
+ *    </be:moduleLayout>
  */
 class ShortcutButtonViewHelper extends AbstractButtonViewHelper
 {
index 0bbcc0a..99dce5b 100644 (file)
@@ -27,14 +27,17 @@ use TYPO3Fluid\Fluid\View\Exception;
 /**
  * A view helper for adding a menu item to a doc header menu.
  * It must be a child of <be:moduleLayout.menu>
- * = Examples =
- * <code>
- * <be:moduleLayout>
+ *
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <be:moduleLayout>
  *     <be:moduleLayout.menu identifier="MenuIdentifier">
  *          <be:moduleLayout.menuItem label="Menu item 1" uri="{f:uri.action(action: 'index')}"/>
  *     </be:moduleLayout.menu>
- * </be:moduleLayout>
- * </code>
+ *    </be:moduleLayout>
  */
 class MenuItemViewHelper extends AbstractViewHelper
 {
index 0cdc6b6..962bb03 100644 (file)
@@ -28,14 +28,17 @@ use TYPO3Fluid\Fluid\View\Exception;
  * A view helper for adding a menu to the doc header area.
  * It must be a child of <be:moduleLayout> and accepts
  * only <be:moduleLayout.menuItem> view helpers as children.
- * = Examples =
- * <code>
- * <be:moduleLayout>
+ *
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <be:moduleLayout>
  *     <be:moduleLayout.menu identifier="MenuIdentifier">
  *          <be:moduleLayout.menuItem label="Menu item 1" uri="{f:uri.action(action: 'index')}"/>
  *     </be:moduleLayout.menu>
- * </be:moduleLayout>
- * </code>
+ *    </be:moduleLayout>
  */
 class MenuViewHelper extends AbstractViewHelper
 {
index dbac1a7..d5d0347 100644 (file)
@@ -28,15 +28,19 @@ use TYPO3Fluid\Fluid\View\Exception;
  * 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 =
- * <code>
- * <be:moduleLayout>
+ *
+ * Examples
+ * ========
+ *
+ * Default::
+ *
+ *    <be:moduleLayout>
  *     <f:render section="content" />
- * </be:moduleLayout>
- * </code>
- * <output>
- * <!-- HTML of the backend module -->
- * </output>
+ *    </be:moduleLayout>
+ *
+ * Output::
+ *
+ *    <!-- HTML of the backend module -->
  */
 class ModuleLayoutViewHelper extends AbstractViewHelper
 {
index 68e9dba..dcb292c 100644 (file)
@@ -16,14 +16,14 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * The uid must be given as a positive integer.
  * For new records, use the newRecordViewHelper
  *
- * = Examples =
+ * Examples
+ * ========
  *
- * <code title="URI to the record-edit action passed to FormEngine">
- * <be:uri.editRecord uid="42" table="a_table" returnUrl="foo/bar" />
- * </code>
- * <output>
- * /typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar
- * </output>
+ * URI to the record-edit action passed to FormEngine::
+ *
+ *    <be:uri.editRecord uid="42" table="a_table" returnUrl="foo/bar" />
+ *
+ * ``/typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar``
  */
 class EditRecordViewHelper extends AbstractViewHelper
 {
index 231ce17..6c2ccc5 100644 (file)
@@ -28,28 +28,26 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * To edit records, use the editRecordViewHelper
  *
- * = Examples =
+ * Examples
+ * ========
  *
- * <code title="Uri to create a new record of a_table after record 17 on the same pid">
- * <be:uri.newRecord table="a_table" returnUrl="foo/bar" uid="-17"/>
- * </code>
- * <output>
- *  /typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar
- * </output>
+ * Uri to create a new record of a_table after record 17 on the same pid::
  *
- * <code title="Uri to create a new record of a_table on root page">
- * <be:uri.newRecord table="a_table" returnUrl="foo/bar""/>
- * </code>
- * <output>
- *  /typo3/index.php?route=/record/edit&edit[a_table][]=new&returnUrl=foo/bar
- * </output>
+ *    <be:uri.newRecord table="a_table" returnUrl="foo/bar" uid="-17"/>
  *
- * <code title="Uri to create a new record of a_table on page 17">
- * <be:uri.newRecord table="a_table" returnUrl="foo/bar" pid="17"/>
- * </code>
- * <output>
- *  /typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar
- * </output>
+ * ``/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::
+ *
+ *    <be:uri.newRecord table="a_table" returnUrl="foo/bar""/>
+ *
+ * ``/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::
+ *
+ *    <be:uri.newRecord table="a_table" returnUrl="foo/bar" pid="17"/>
+ *
+ * ``/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar``
  */
 class NewRecordViewHelper extends AbstractTagBasedViewHelper
 {
index 4ce3731..ef05cff 100644 (file)
@@ -23,15 +23,18 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * current request.
  * In TYPO3 Flow, you should always include this ViewHelper to make the links work.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Example::
+ *
+ *    <f:base />
+ *
+ * Output::
+ *
+ *    <base href="http://yourdomain.tld/" />
  *
- * <code title="Example">
- * <f:base />
- * </code>
- * <output>
- * <base href="http://yourdomain.tld/" />
  * (depending on your domain)
- * </output>
  */
 class BaseViewHelper extends AbstractViewHelper
 {
index 1b6fba5..4a11a32 100644 (file)
@@ -24,30 +24,28 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * set to something else than "Display no help information" in the Users settings
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <f:be.buttons.csh />
  *
- * <code title="Default">
- * <f:be.buttons.csh />
- * </code>
- * <output>
  * CSH button as known from the TYPO3 backend.
- * </output>
  *
- * <code title="Full configuration">
- * <f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey" />
- * </code>
- * <output>
+ * Full configuration::
+ *
+ *    <f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey" />
+ *
  * CSH button as known from the TYPO3 backend with some custom settings.
- * </output>
  *
- * <code title="Full configuration with content">
- * <f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey">
- *   some text to link
- * </f:be.buttons.csh>
- * </code>
- * <output>
+ * Full configuration with content::
+ *
+ *    <f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey">
+ *       some text to link
+ *    </f:be.buttons.csh>
+ *
  * A link with text "some text to link" to link the help
- * </output>
  */
 class CshViewHelper extends AbstractBackendViewHelper
 {
index 12ba447..86dc2a2 100644 (file)
@@ -23,25 +23,26 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * View helper which returns shortcut button with icon
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <f:be.buttons.shortcut />
  *
- * <code title="Default">
- * <f:be.buttons.shortcut />
- * </code>
- * <output>
  * Shortcut button as known from the TYPO3 backend.
  * By default the current page id, module name and all module arguments will be stored
- * </output>
  *
- * <code title="Explicitly set parameters to be stored in the shortcut">
- * <f:be.buttons.shortcut getVars="{0: 'route', 1: 'myOwnPrefix'}" setVars="{0: 'function'}" />
- * </code>
- * <output>
+ * Explicitly set parameters to be stored in the shortcut::
+ *
+ *    <f:be.buttons.shortcut getVars="{0: 'route', 1: 'myOwnPrefix'}" setVars="{0: 'function'}" />
+ *
  * 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
- * </output>
+ *
+ * .. note:
+ *
+ *    Normally you won't need to set getVars & setVars parameters in Extbase modules
  */
 class ShortcutViewHelper extends AbstractBackendViewHelper
 {
index a9cc8ed..4acd627 100644 (file)
@@ -20,25 +20,24 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 /**
  * View helper which allows you to create extbase based modules in the style of TYPO3 default modules.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Simple::
+ *
+ *    <f:be.container>your module content</f:be.container>
  *
- * <code title="Simple">
- * <f:be.container>your module content</f:be.container>
- * </code>
- * <output>
  * "your module content" wrapped with proper head & body tags.
  * Default backend CSS styles and JavaScript will be included
- * </output>
  *
- * <code title="All options">
- * <f:be.container pageTitle="foo" includeCssFiles="{0: '{f:uri.resource(path:\'Css/Styles.css\')}'}" includeJsFiles="{0: '{f:uri.resource(path:\'JavaScript/Library1.js\')}', 1: '{f:uri.resource(path:\'JavaScript/Library2.js\')}'}" addJsInlineLabels="{0: 'label1', 1: 'label2'}">your module content</f:be.container>
- * </code>
- * <output>
+ * All options::
+ *
+ *    <f:be.container pageTitle="foo" includeCssFiles="{0: '{f:uri.resource(path:\'Css/Styles.css\')}'}" includeJsFiles="{0: '{f:uri.resource(path:\'JavaScript/Library1.js\')}', 1: '{f:uri.resource(path:\'JavaScript/Library2.js\')}'}" addJsInlineLabels="{0: 'label1', 1: 'label2'}">your module content</f:be.container>
+ *
  * "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.
- * </output>
  */
 class ContainerViewHelper extends AbstractBackendViewHelper
 {
index 5c5c95f..f6ef271 100644 (file)
@@ -22,30 +22,37 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
 /**
  * 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
+ * --------
  *
- * <code title="Simple">
- * <f:be.infobox title="Message title">your box content</f:be.infobox>
- * </code>
+ * Simple::
  *
- * <code title="All options">
- * <f:be.infobox title="Message title" message="your box content" state="-2" iconName="check" disableIcon="true" />
- * </code>
+ *    <f:be.infobox title="Message title">your box content</f:be.infobox>
+ *
+ * All options::
+ *
+ *    <f:be.infobox title="Message title" message="your box content" state="-2" iconName="check" disableIcon="true" />
  */
 class InfoboxViewHelper extends AbstractViewHelper
 {
index 4ccab62..1576b6f 100644 (file)
@@ -25,21 +25,20 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * set to something else than "Display no help information" in the Users settings
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <f:be.labels.csh />
  *
- * <code title="Default">
- * <f:be.labels.csh />
- * </code>
- * <output>
  * CSH label as known from the TYPO3 backend.
- * </output>
  *
- * <code title="Full configuration">
- * <f:be.labels.csh table="xMOD_csh_corebe" field="someCshKey" label="lang/Resources/Private/Language/locallang/header.languages" />
- * </code>
- * <output>
+ * Full configuration::
+ *
+ *    <f:be.labels.csh table="xMOD_csh_corebe" field="someCshKey" label="lang/Resources/Private/Language/locallang/header.languages" />
+ *
  * CSH label as known from the TYPO3 backend with some custom settings.
- * </output>
  */
 class CshViewHelper extends AbstractBackendViewHelper
 {
index 3d983e5..7e54c10 100644 (file)
@@ -20,13 +20,15 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
 /**
  * A view helper for creating URIs to modules.
- * = Examples =
- * <code title="URI to the web_ts module on page 92">
- * <f:be.link route="web_ts" parameters="{id: 92}">Go to web_ts</f:be.link>
- * </code>
- * <output>
- * <a href="/typo3/index.php?route=%2module%2web_ts%2&moduleToken=b6e9c9f?id=92">Go to web_ts</a>
- * </output>
+ *
+ * Examples
+ * --------
+ *
+ * URI to the web_ts module on page 92::
+ *
+ *    <f:be.link route="web_ts" parameters="{id: 92}">Go to web_ts</f:be.link>
+ *
+ * ``<a href="/typo3/index.php?route=%2module%2web_ts%2&moduleToken=b6e9c9f?id=92">Go to web_ts</a>``
  */
 class LinkViewHelper extends AbstractTagBasedViewHelper
 {
index 902dd17..f305ffb 100644 (file)
@@ -19,20 +19,23 @@ use TYPO3Fluid\Fluid\Core\Parser\SyntaxTree\ViewHelperNode;
 /**
  * View helper which groups options of an option tag.
  *
- * = Example =
+ * Example
+ * -------
  *
- *     <f:be.menus.actionMenu>
- *             <f:be.menus.actionMenuItem label="Default: Welcome" controller="Default" action="index" />
- *             <f:be.menus.actionMenuItem label="Community: get in touch" controller="Community" action="index" />
+ * ::
  *
- *             <f:be.menus.actionMenuItemGroup label="Information">
- *                     <f:be.menus.actionMenuItem label="PHP Information" controller="Information" action="listPhpInfo" />
- *                     <f:be.menus.actionMenuItem label="Documentation" controller="Information" action="documentation" />
- *                     <f:be.menus.actionMenuItem label="Hooks" controller="Information" action="hooks" />
- *                     <f:be.menus.actionMenuItem label="Signals" controller="Information" action="signals" />
- *                     <f:be.menus.actionMenuItem label="XClasses" controller="Information" action="xclass" />
- *             </f:be.menus.actionMenuItemGroup>
- *     </f:be.menus.actionMenu>
+ *  <f:be.menus.actionMenu>
+ *      <f:be.menus.actionMenuItem label="Default: Welcome" controller="Default" action="index" />
+ *      <f:be.menus.actionMenuItem label="Community: get in touch" controller="Community" action="index" />
+ *
+ *      <f:be.menus.actionMenuItemGroup label="Information">
+ *          <f:be.menus.actionMenuItem label="PHP Information" controller="Information" action="listPhpInfo" />
+ *          <f:be.menus.actionMenuItem label="Documentation" controller="Information" action="documentation" />
+ *          <f:be.menus.actionMenuItem label="Hooks" controller="Information" action="hooks" />
+ *          <f:be.menus.actionMenuItem label="Signals" controller="Information" action="signals" />
+ *          <f:be.menus.actionMenuItem label="XClasses" controller="Information" action="xclass" />
+ *      </f:be.menus.actionMenuItemGroup>
+ *  </f:be.menus.actionMenu>
  */
 class ActionMenuItemGroupViewHelper extends ActionMenuViewHelper
 {
index 6e0bf2c..791e99f 100644 (file)
@@ -21,28 +21,27 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * This view helper only works in conjunction with \TYPO3\CMS\Fluid\ViewHelpers\Be\Menus\ActionMenuViewHelper
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Simple::
+ *
+ *    <f:be.menus.actionMenu>
+ *       <f:be.menus.actionMenuItem label="Overview" controller="Blog" action="index" />
+ *       <f:be.menus.actionMenuItem label="Create new Blog" controller="Blog" action="new" />
+ *       <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
+ *    </f:be.menus.actionMenu>
  *
- * <code title="Simple">
- * <f:be.menus.actionMenu>
- * <f:be.menus.actionMenuItem label="Overview" controller="Blog" action="index" />
- * <f:be.menus.actionMenuItem label="Create new Blog" controller="Blog" action="new" />
- * <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
- * </f:be.menus.actionMenu>
- * </code>
- * <output>
  * Selectbox with the options "Overview", "Create new Blog" and "List Posts"
- * </output>
  *
- * <code title="Localized">
- * <f:be.menus.actionMenu>
- * <f:be.menus.actionMenuItem label="{f:translate(key='overview')}" controller="Blog" action="index" />
- * <f:be.menus.actionMenuItem label="{f:translate(key='create_blog')}" controller="Blog" action="new" />
- * </f:be.menus.actionMenu>
- * </code>
- * <output>
+ * Localized::
+ *
+ *    <f:be.menus.actionMenu>
+ *       <f:be.menus.actionMenuItem label="{f:translate(key='overview')}" controller="Blog" action="index" />
+ *       <f:be.menus.actionMenuItem label="{f:translate(key='create_blog')}" controller="Blog" action="new" />
+ *    </f:be.menus.actionMenu>
+ *
  * localized selectbox
- * <output>
  */
 class ActionMenuItemViewHelper extends AbstractTagBasedViewHelper
 {
index 1d0d80b..d0d9db3 100644 (file)
@@ -23,28 +23,27 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * multiple actions and controllers and looks similar to TYPO3s funcMenu.
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Simple::
+ *
+ *    <f:be.menus.actionMenu>
+ *       <f:be.menus.actionMenuItem label="Overview" controller="Blog" action="index" />
+ *       <f:be.menus.actionMenuItem label="Create new Blog" controller="Blog" action="new" />
+ *       <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
+ *    </f:be.menus.actionMenu>
  *
- * <code title="Simple">
- * <f:be.menus.actionMenu>
- * <f:be.menus.actionMenuItem label="Overview" controller="Blog" action="index" />
- * <f:be.menus.actionMenuItem label="Create new Blog" controller="Blog" action="new" />
- * <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
- * </f:be.menus.actionMenu>
- * </code>
- * <output>
  * Selectbox with the options "Overview", "Create new Blog" and "List Posts"
- * </output>
  *
- * <code title="Localized">
- * <f:be.menus.actionMenu>
- * <f:be.menus.actionMenuItem label="{f:translate(key:'overview')}" controller="Blog" action="index" />
- * <f:be.menus.actionMenuItem label="{f:translate(key:'create_blog')}" controller="Blog" action="new" />
- * </f:be.menus.actionMenu>
- * </code>
- * <output>
+ * Localized::
+ *
+ *    <f:be.menus.actionMenu>
+ *       <f:be.menus.actionMenuItem label="{f:translate(key:'overview')}" controller="Blog" action="index" />
+ *       <f:be.menus.actionMenuItem label="{f:translate(key:'create_blog')}" controller="Blog" action="new" />
+ *    </f:be.menus.actionMenu>
+ *
  * localized selectbox
- * <output>
  */
 class ActionMenuViewHelper extends AbstractTagBasedViewHelper
 {
index 7c9d906..1769a19 100644 (file)
@@ -25,14 +25,14 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * View helper which return page info icon as known from TYPO3 backend modules
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <f:be.pageInfo />
  *
- * <code>
- * <f:be.pageInfo />
- * </code>
- * <output>
  * Page info icon with context menu
- * </output>
  */
 class PageInfoViewHelper extends AbstractBackendViewHelper
 {
index 02a3a04..1c87c22 100644 (file)
@@ -24,14 +24,14 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * View helper which returns the current page path as known from TYPO3 backend modules
  * Note: This view helper is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code>
- * <f:be.pagePath />
- * </code>
- * <output>
- * Current page path, prefixed with "Path:" and wrapped in a span with the class "typo3-docheader-pagePath"
- * </output>
+ * Default::
+ *
+ *    <f:be.pagePath />
+ *
+ * Current page path, prefixed with "Path:" and wrapped in a span with the class ``typo3-docheader-pagePath``.
  */
 class PagePathViewHelper extends AbstractBackendViewHelper
 {
index d9500de..c6afd37 100644 (file)
@@ -24,17 +24,16 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * View helper which allows you to create extbase based modules in the style of TYPO3 default modules.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="All options">
- * <f:be.pageRenderer pageTitle="foo" includeCssFiles="0: '{f:uri.resource(path:\'Css/Styles.css\')}'" includeJsFiles="0: '{f:uri.resource(path:\'JavaScript/Library1.js\')}', 1: '{f:uri.resource(path:\'JavaScript/Library2.js\')}'" addJsInlineLabels="{0: 'label1', 1: 'label2'}" />
- * </code>
- * <output>
+ * 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
+ *    <f:be.pageRenderer pageTitle="foo" includeCssFiles="0: '{f:uri.resource(path:\'Css/Styles.css\')}'" includeJsFiles="0: '{f:uri.resource(path:\'JavaScript/Library1.js\')}', 1: '{f:uri.resource(path:\'JavaScript/Library2.js\')}'" addJsInlineLabels="{0: 'label1', 1: 'label2'}" />
+ *
+ * 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.
- * </output>
  */
 class PageRendererViewHelper extends AbstractViewHelper
 {
index 49e5bbb..e46fd84 100644 (file)
@@ -19,31 +19,29 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 /**
  * This view helper implements an ifAuthenticated/else condition for BE users/groups.
  *
- * = Examples =
- *
- * <code title="Basic usage">
- * <f:be.security.ifAuthenticated>
- * This is being shown whenever a BE user is logged in
- * </f:be.security.ifAuthenticated>
- * </code>
- * <output>
+ * Examples
+ * --------
+ *
+ * Basic usage::
+ *
+ *    <f:be.security.ifAuthenticated>
+ *       This is being shown whenever a BE user is logged in
+ *    </f:be.security.ifAuthenticated>
+ *
  * Everything inside the <f:be.ifAuthenticated> tag is being displayed if you are authenticated with any BE user account.
- * </output>
- *
- * <code title="IfAuthenticated / then / else">
- * <f:be.security.ifAuthenticated>
- * <f:then>
- * This is being shown in case you have access.
- * </f:then>
- * <f:else>
- * This is being displayed in case you do not have access.
- * </f:else>
- * </f:be.security.ifAuthenticated>
- * </code>
- * <output>
+ *
+ * IfAuthenticated / then / else::
+ *
+ *    <f:be.security.ifAuthenticated>
+ *       <f:then>
+ *          This is being shown in case you have access.
+ *       </f:then>
+ *       <f:else>
+ *          This is being displayed in case you do not have access.
+ *       </f:else>
+ *    </f:be.security.ifAuthenticated>
+ *
  * Everything inside the "then" tag is displayed if you have access.
- * Otherwise, everything inside the "else"-tag is displayed.
- * </output>
  */
 class IfAuthenticatedViewHelper extends AbstractConditionViewHelper
 {
index 715fd0c..d1e0d81 100644 (file)
@@ -19,40 +19,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 /**
  * This view helper implements an ifHasRole/else condition for BE users/groups.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Basic usage::
+ *
+ *    <f:be.security.ifHasRole role="Administrator">
+ *       This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive)
+ *    </f:be.security.ifHasRole>
  *
- * <code title="Basic usage">
- * <f:be.security.ifHasRole role="Administrator">
- * This is being shown in case the current BE user belongs to a BE usergroup (aka role) titled "Administrator" (case sensitive)
- * </f:be.security.ifHasRole>
- * </code>
- * <output>
  * Everything inside the <f:ifHasRole> tag is being displayed if the logged in BE user belongs to the specified role.
- * </output>
  *
- * <code title="Using the usergroup uid as role identifier">
- * <f:be.security.ifHasRole role="1">
- * This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1"
- * </f:be.security.ifHasRole>
- * </code>
- * <output>
+ * Using the usergroup uid as role identifier::
+ *
+ *    <f:be.security.ifHasRole role="1">
+ *       This is being shown in case the current BE user belongs to a BE usergroup (aka role) with the uid "1"
+ *    </f:be.security.ifHasRole>
+ *
  * Everything inside the <f:ifHasRole> tag is being displayed if the logged in BE user belongs to the specified role.
- * </output>
  *
- * <code title="IfRole / then / else">
- * <f:be.security.ifHasRole role="Administrator">
- * <f:then>
- * This is being shown in case you have the role.
- * </f:then>
- * <f:else>
- * This is being displayed in case you do not have the role.
- * </f:else>
- * </f:be.security.ifHasRole>
- * </code>
- * <output>
+ * IfRole / then / else::
+ *
+ *    <f:be.security.ifHasRole role="Administrator">
+ *       <f:then>
+ *          This is being shown in case you have the role.
+ *       </f:then>
+ *       <f:else>
+ *          This is being displayed in case you do not have the role.
+ *       </f:else>
+ *    </f:be.security.ifHasRole>
+ *
  * 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.
- * </output>
  */
 class IfHasRoleViewHelper extends AbstractConditionViewHelper
 {
index 5cc47e2..9116a37 100644 (file)
@@ -22,25 +22,24 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  * View helper which renders a record list as known from the TYPO3 list module
  * Note: This feature is experimental!
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Minimal::
+ *
+ *    <f:be.tableList tableName="fe_users" />
  *
- * <code title="Minimal">
- * <f:be.tableList tableName="fe_users" />
- * </code>
- * <output>
  * 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.
- * </output>
  *
- * <code title="Full">
- * <f:be.tableList tableName="fe_users" fieldList="{0: 'name', 1: 'email'}" storagePid="1" levels="2" filter='foo' recordsPerPage="10" sortField="name" sortDescending="true" readOnly="true" enableClickMenu="false" clickTitleMode="info" />
- * </code>
- * <output>
+ * Full::
+ *
+ *    <f:be.tableList tableName="fe_users" fieldList="{0: 'name', 1: 'email'}" storagePid="1" levels="2" filter='foo' recordsPerPage="10" sortField="name" sortDescending="true" readOnly="true" enableClickMenu="false" clickTitleMode="info" />
+ *
  * 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
- * </output>
  */
 class TableListViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper
 {
index 16f2363..365c223 100644 (file)
@@ -19,20 +19,21 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
  * A view helper for creating URIs to modules.
- * = Examples =
- * <code title="URI to the web_ts module on page 92">
- * <f:be.uri route="web_ts" parameters="{id: 92}"/>
- * </code>
- * <output>
- * /typo3/index.php?M=web_ts&moduleToken=b6e9c9f?id=92
- * </output>
  *
- *  <code title="Inline notation">
- * {f:be.uri(route: 'web_ts', parameters: '{id: 92}')}
- * </code>
- * <output>
- * /typo3/index.php?route=%2module%2web_ts%2&moduleToken=b6e9c9f?id=92
- * </output>
+ * Examples
+ * --------
+ *
+ * URI to the web_ts module on page 92::
+ *
+ *    <f:be.uri route="web_ts" parameters="{id: 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
 {
index f80b07a..81bf220 100644 (file)
@@ -18,24 +18,27 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 /**
  * This ViewHelper renders a Pagination of objects for the TYPO3 Backend.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="required arguments">
- * <f:be.widget.paginate objects="{blogs}" as="paginatedBlogs">
- * use {paginatedBlogs} as you used {blogs} before, most certainly inside
- * a <f:for> loop.
- * </f:be.widget.paginate>
- * </code>
+ * required arguments::
+ *
+ *    <f:be.widget.paginate objects="{blogs}" as="paginatedBlogs">
+ *       use {paginatedBlogs} as you used {blogs} before, most certainly inside
+ *       a <f:for> loop.
+ *    </f:be.widget.paginate>
+ *
+ * full configuration::
+ *
+ *    <f:be.widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, recordsLabel: 'MyRecords'}">
+ *       use {paginatedBlogs} as you used {blogs} before, most certainly inside
+ *       a <f:for> loop.
+ *    </f:be.widget.paginate>
  *
- * <code title="full configuration">
- * <f:be.widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, recordsLabel: 'MyRecords'}">
- * use {paginatedBlogs} as you used {blogs} before, most certainly inside
- * a <f:for> loop.
- * </f:be.widget.paginate>
  * The recordsLabel can be used to replace the text in "Records 1 - 99" with a label of your own choice
- * </code>
  *
- * = 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.
index bf2fb49..48490da 100644 (file)
@@ -27,28 +27,26 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * 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::
+ *
+ *    <f:cObject typoscriptObjectPath="lib.someLibObject" />
  *
- * <code title="Render lib object">
- * <f:cObject typoscriptObjectPath="lib.someLibObject" />
- * </code>
- * <output>
  * rendered lib.someLibObject
- * </output>
  *
- * <code title="Specify cObject data & current value">
- * <f:cObject typoscriptObjectPath="lib.customHeader" data="{article}" currentValueKey="title" />
- * </code>
- * <output>
+ * Specify cObject data & current value::
+ *
+ *    <f:cObject typoscriptObjectPath="lib.customHeader" data="{article}" currentValueKey="title" />
+ *
  * rendered lib.customHeader. data and current value will be available in TypoScript
- * </output>
  *
- * <code title="inline notation">
- * {article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')}
- * </code>
- * <output>
+ * inline notation::
+ *
+ *    {article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')}
+ *
  * rendered lib.customHeader. data will be available in TypoScript
- * </output>
  */
 class CObjectViewHelper extends AbstractViewHelper
 {
index 1f964ad..d85db44 100644 (file)
@@ -23,10 +23,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
  * 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
 {
index 3713d7a..a0f0af0 100644 (file)
@@ -22,21 +22,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * This ViewHelper generates a HTML dump of the tagged variable.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Simple::
+ *
+ *    <f:debug>{testVariables.array}</f:debug>
  *
- * <code title="Simple">
- * <f:debug>{testVariables.array}</f:debug>
- * </code>
- * <output>
  * foobarbazfoo
- * </output>
  *
- * <code title="All Features">
- * <f:debug title="My Title" maxDepth="5" blacklistedClassNames="{0:'Tx_BlogExample_Domain_Model_Administrator'}" plainText="true" ansiColors="false" inline="true" blacklistedPropertyNames="{0:'posts'}">{blogs}</f:debug>
- * </code>
- * <output>
+ * All Features::
+ *
+ *    <f:debug title="My Title" maxDepth="5" blacklistedClassNames="{0:'Tx_BlogExample_Domain_Model_Administrator'}" plainText="true" ansiColors="false" inline="true" blacklistedPropertyNames="{0:'posts'}">{blogs}</f:debug>
+ *
  * [A HTML view of the var_dump]
- * </output>
  */
 class DebugViewHelper extends AbstractViewHelper
 {
index bb106a9..e59dd55 100644 (file)
@@ -26,56 +26,59 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * In case you need custom Flash Message HTML output, please write your own ViewHelper for the moment.
  *
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Simple::
+ *
+ *    <f:flashMessages />
  *
- * <code title="Simple">
- * <f:flashMessages />
- * </code>
- * <output>
  * A list of flash messages.
- * </output>
- *
- * <code title="TYPO3 core style">
- * <f:flashMessages />
- * </code>
- * <output>
- * <div class="typo3-messages">
- *  <div class="alert alert-info">
- *      <div class="media">
- *          <div class="media-left">
- *              <span class="fa-stack fa-lg">
- *                  <i class="fa fa-circle fa-stack-2x"></i>
- *                  <i class="fa fa-info fa-stack-1x"></i>
- *              </span>
- *          </div>
- *          <div class="media-body">
- *              <h4 class="alert-title">Info - Title for Info message</h4>
- *              <p class="alert-message">Message text here.</p>
+ *
+ * TYPO3 core style::
+ *
+ *    <f:flashMessages />
+ *
+ * Output::
+ *
+ *    <div class="typo3-messages">
+ *       <div class="alert alert-info">
+ *          <div class="media">
+ *             <div class="media-left">
+ *                <span class="fa-stack fa-lg">
+ *                   <i class="fa fa-circle fa-stack-2x"></i>
+ *                   <i class="fa fa-info fa-stack-1x"></i>
+ *                </span>
+ *             </div>
+ *             <div class="media-body">
+ *                <h4 class="alert-title">Info - Title for Info message</h4>
+ *                <p class="alert-message">Message text here.</p>
+ *             </div>
  *          </div>
- *      </div>
- *  </div>
- * </div>
- * </output>
- * <code title="Output flash messages as a description list">
- * <f:flashMessages as="flashMessages">
- *     <dl class="messages">
- *     <f:for each="{flashMessages}" as="flashMessage">
- *             <dt>{flashMessage.code}</dt>
- *             <dd>{flashMessage.message}</dd>
- *     </f:for>
- *     </dl>
- * </f:flashMessages>
- * </code>
- * <output>
- * <dl class="messages">
- *     <dt>1013</dt>
- *     <dd>Some Warning Message.</dd>
- * </dl>
- * </output>
- *
- * <code title="Using a specific queue">
- * <f:flashMessages queueIdentifier="myQueue" />
- * </code>
+ *       </div>
+ *    </div>
+ *
+ * Output flash messages as a description list::
+ *
+ *    <f:flashMessages as="flashMessages">
+ *       <dl class="messages">
+ *          <f:for each="{flashMessages}" as="flashMessage">
+ *             <dt>{flashMessage.code}</dt>
+ *             <dd>{flashMessage.message}</dd>
+ *          </f:for>
+ *       </dl>
+ *    </f:flashMessages>
+ *
+ * Output::
+ *
+ *    <dl class="messages">
+ *       <dt>1013</dt>
+ *       <dd>Some Warning Message.</dd>
+ *   </dl>
+ *
+ * Using a specific queue::
+ *
+ *    <f:flashMessages queueIdentifier="myQueue" />
  */
 class FlashMessagesViewHelper extends AbstractViewHelper
 {
index 9159b1d..bab4137 100644 (file)
@@ -17,21 +17,24 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * Creates a button.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Defaults">
- * <f:form.button>Send Mail</f:form.button>
- * </code>
- * <output>
- * <button type="submit" name="" value="">Send Mail</button>
- * </output>
+ * Defaults::
  *
- * <code title="Disabled cancel button with some HTML5 attributes">
- * <f:form.button type="reset" name="buttonName" value="buttonValue" disabled="disabled" formmethod="post" formnovalidate="formnovalidate">Cancel</f:form.button>
- * </code>
- * <output>
- * <button disabled="disabled" formmethod="post" formnovalidate="formnovalidate" type="reset" name="myForm[buttonName]" value="buttonValue">Cancel</button>
- * </output>
+ *    <f:form.button>Send Mail</f:form.button>
+ *
+ * Output::
+ *
+ *    <button type="submit" name="" value="">Send Mail</button>
+ *
+ * Disabled cancel button with some HTML5 attributes::
+ *
+ *    <f:form.button type="reset" name="buttonName" value="buttonValue" disabled="disabled" formmethod="post" formnovalidate="formnovalidate">Cancel</f:form.button>
+ *
+ * Output::
+ *
+ *    <button disabled="disabled" formmethod="post" formnovalidate="formnovalidate" type="reset" name="myForm[buttonName]" value="buttonValue">Cancel</button>
  */
 class ButtonViewHelper extends AbstractFormFieldViewHelper
 {
index 2940384..a4be1b9 100644 (file)
@@ -17,30 +17,36 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * View Helper which creates a simple checkbox (<input type="checkbox">).
  *
- * = Examples =
- *
- * <code title="Example">
- * <f:form.checkbox name="myCheckBox" value="someValue" />
- * </code>
- * <output>
- * <input type="checkbox" name="myCheckBox" value="someValue" />
- * </output>
- *
- * <code title="Preselect">
- * <f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" />
- * </code>
- * <output>
- * <input type="checkbox" name="myCheckBox" value="someValue" checked="checked" />
+ * Examples
+ * --------
+ *
+ * Example::
+ *
+ *    <f:form.checkbox name="myCheckBox" value="someValue" />
+ *
+ * Output::
+ *
+ *    <input type="checkbox" name="myCheckBox" value="someValue" />
+ *
+ * Preselect::
+ *
+ *    <f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" />
+ *
+ * Output::
+ *
+ *    <input type="checkbox" name="myCheckBox" value="someValue" checked="checked" />
+ *
  * (depending on $object)
- * </output>
  *
- * <code title="Bind to object property">
- * <f:form.checkbox property="interests" value="TYPO3" />
- * </code>
- * <output>
- * <input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
+ * Bind to object property::
+ *
+ *    <f:form.checkbox property="interests" value="TYPO3" />
+ *
+ * Output::
+ *
+ *    <input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
+ *
  * (depending on property "interests")
- * </output>
  */
 class CheckboxViewHelper extends AbstractFormFieldViewHelper
 {
index 6a816b7..c9f1de5 100644 (file)
@@ -17,14 +17,16 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * Renders an <input type="hidden" ...> tag.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Example">
- * <f:form.hidden name="myHiddenValue" value="42" />
- * </code>
- * <output>
- * <input type="hidden" name="myHiddenValue" value="42" />
- * </output>
+ * Example::
+ *
+ *    <f:form.hidden name="myHiddenValue" value="42" />
+ *
+ * Output::
+ *
+ *    <input type="hidden" name="myHiddenValue" value="42" />
  *
  * You can also use the "property" attribute if you have bound an object to the form.
  * See <f:form> for more documentation.
index 9bbee52..3a38f02 100644 (file)
@@ -17,14 +17,16 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * View Helper which creates a simple Password Text Box (<input type="password">).
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Example">
- * <f:form.password name="myPassword" />
- * </code>
- * <output>
- * <input type="password" name="myPassword" value="default value" />
- * </output>
+ * Example::
+ *
+ *    <f:form.password name="myPassword" />
+ *
+ * Output::
+ *
+ *    <input type="password" name="myPassword" value="default value" />
  */
 class PasswordViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index eeab4d0..9c72027 100644 (file)
@@ -17,32 +17,38 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * View Helper which creates a simple radio button (<input type="radio">).
  *
- * = Examples =
- *
- * <code title="Example">
- * <f:form.radio name="myRadioButton" value="someValue" />
- * </code>
- * <output>
- * <input type="radio" name="myRadioButton" value="someValue" />
- * </output>
- *
- * <code title="Preselect">
- * <f:form.radio name="myRadioButton" value="someValue" checked="{object.value} == 5" />
- * </code>
- * <output>
- * <input type="radio" name="myRadioButton" value="someValue" checked="checked" />
+ * Examples
+ * --------
+ *
+ * Example::
+ *
+ *    <f:form.radio name="myRadioButton" value="someValue" />
+ *
+ * Output::
+ *
+ *    <input type="radio" name="myRadioButton" value="someValue" />
+ *
+ * Preselect::
+ *
+ *    <f:form.radio name="myRadioButton" value="someValue" checked="{object.value} == 5" />
+ *
+ * Output::
+ *
+ *    <input type="radio" name="myRadioButton" value="someValue" checked="checked" />
+ *
  * (depending on $object)
- * </output>
- *
- * <code title="Bind to object property">
- * <f:form.radio property="newsletter" value="1" /> yes
- * <f:form.radio property="newsletter" value="0" /> no
- * </code>
- * <output>
- * <input type="radio" name="user[newsletter]" value="1" checked="checked" /> yes
- * <input type="radio" name="user[newsletter]" value="0" /> no
+ *
+ * Bind to object property::
+ *
+ *    <f:form.radio property="newsletter" value="1" /> yes
+ *    <f:form.radio property="newsletter" value="0" /> no
+ *
+ * Output::
+ *
+ *    <input type="radio" name="user[newsletter]" value="1" checked="checked" /> yes
+ *    <input type="radio" name="user[newsletter]" value="0" /> no
+ *
  * (depending on property "newsletter")
- * </output>
  */
 class RadioViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 266d0d8..8298d65 100644 (file)
@@ -15,8 +15,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form\Select;
  */
 
 /**
- * Adds custom `<optgroup>` tags inside an `<f:form.select>`,
- * supports further child `<f:form.select.option>` tags.
+ * Adds custom ``<optgroup>`` tags inside an ``<f:form.select>``,
+ * supports further child ``<f:form.select.option>`` tags.
  */
 class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 77fd067..36707e7 100644 (file)
@@ -16,7 +16,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form\Select;
 use TYPO3\CMS\Fluid\ViewHelpers\Form\SelectViewHelper;
 
 /**
- * Adds custom `<option>` tags inside an `<f:form.select>`
+ * Adds custom ``<option>`` tags inside an ``<f:form.select>``
  */
 class OptionViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 5306d94..fc80b88 100644 (file)
@@ -17,42 +17,48 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * This view helper generates a <select> dropdown list for the use with a form.
  *
- * = Basic usage =
+ * Basic usage
+ * -----------
  *
  * The most straightforward way is to supply an associative array as the "options" parameter.
  * The array key is used as option key, and the value is used as human-readable name.
  *
- * <code title="Basic usage">
- * <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" />
- * </code>
+ * Basic usage::
  *
- * = Pre-select a value =
+ *    <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" />
+ *
+ * Pre-select a value
+ * ------------------
  *
  * To pre-select a value, set "value" to the option key which should be selected.
- * <code title="Default value">
- * <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" value="visa" />
- * </code>
+ * Default value::
+ *
+ *    <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" value="visa" />
+ *
  * Generates a dropdown box like above, except that "VISA Card" is selected.
  *
  * If the select box is a multi-select box (multiple="1"), then "value" can be an array as well.
  *
- * = Custom options and option group rendering =
+ * Custom options and option group rendering
+ * -----------------------------------------
  *
  * Child nodes can be used to create a completely custom set of ``<option>`` and ``<optgroup>`` tags in a way compatible with
  * the HMAC generation. To do so, leave out the ``options`` argument and use child ViewHelpers:
- * <code title="Custom options and optgroup">
- * <f:form.select name="myproperty">
- *     <f:form.select.option value="1">Option one</f:form.select.option>
- *     <f:form.select.option value="2">Option two</f:form.select.option>
- *     <f:form.select.optgroup>
- *         <f:form.select.option value="3">Grouped option one</f:form.select.option>
- *         <f:form.select.option value="4">Grouped option twi</f:form.select.option>
- *     </f:form.select.optgroup>
- * </f:form.select>
- * </code>
+ * Custom options and optgroup::
+ *
+ *    <f:form.select name="myproperty">
+ *       <f:form.select.option value="1">Option one</f:form.select.option>
+ *       <f:form.select.option value="2">Option two</f:form.select.option>
+ *       <f:form.select.optgroup>
+ *          <f:form.select.option value="3">Grouped option one</f:form.select.option>
+ *          <f:form.select.option value="4">Grouped option twi</f:form.select.option>
+ *       </f:form.select.optgroup>
+ *    </f:form.select>
+ *
  * Note: do not use vanilla ``<option>`` or ``<optgroup>`` tags! They will invalidate the HMAC generation!
  *
- * = Usage on domain objects =
+ * Usage on domain objects
+ * -----------------------
  *
  * If you want to output domain objects, you can just pass them as array into the "options" parameter.
  * To define what domain object value should be used as option key, use the "optionValueField" variable. Same goes for optionLabelField.
@@ -64,9 +70,10 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * If the prependOptionLabel variable is set, an option item is added in first position, bearing an empty string or -
  * If provided, the value of the prependOptionValue variable as value.
  *
- * <code title="Domain objects">
- * <f:form.select name="users" options="{userArray}" optionValueField="id" optionLabelField="firstName" />
- * </code>
+ * Domain objects::
+ *
+ *    <f:form.select name="users" options="{userArray}" optionValueField="id" optionLabelField="firstName" />
+ *
  * In the above example, the userArray is an array of "User" domain objects, with no array key specified.
  *
  * So, in the above example, the method $user->getId() is called to retrieve the key, and $user->getFirstName() to retrieve the displayed value of each entry.
index 07386b5..86dc937 100644 (file)
@@ -17,21 +17,24 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * Creates a submit button.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Defaults">
- * <f:form.submit value="Send Mail" />
- * </code>
- * <output>
- * <input type="submit" />
- * </output>
+ * Defaults::
  *
- * <code title="Dummy content for template preview">
- * <f:submit name="mySubmit" value="Send Mail"><button>dummy button</button></f:submit>
- * </code>
- * <output>
- * <input type="submit" name="mySubmit" value="Send Mail" />
- * </output>
+ *    <f:form.submit value="Send Mail" />
+ *
+ * Output::
+ *
+ *    <input type="submit" />
+ *
+ * Dummy content for template preview::
+ *
+ *    <f:submit name="mySubmit" value="Send Mail"><button>dummy button</button></f:submit>
+ *
+ * Output::
+ *
+ *    <input type="submit" name="mySubmit" value="Send Mail" />
  */
 class SubmitViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 57e3f90..6a46a61 100644 (file)
@@ -18,14 +18,16 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * Textarea view helper.
  * The value of the text area needs to be set via the "value" attribute, as with all other form ViewHelpers.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Example">
- * <f:form.textarea name="myTextArea" value="This is shown inside the textarea" />
- * </code>
- * <output>
- * <textarea name="myTextArea">This is shown inside the textarea</textarea>
- * </output>
+ * Example::
+ *
+ *    <f:form.textarea name="myTextArea" value="This is shown inside the textarea" />
+ *
+ * Output::
+ *
+ *    <textarea name="myTextArea">This is shown inside the textarea</textarea>
  */
 class TextareaViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 9a830ed..a3694e0 100644 (file)
@@ -17,14 +17,16 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
 /**
  * View Helper which creates a text field (<input type="text">).
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Example">
- * <f:form.textfield name="myTextBox" value="default value" />
- * </code>
- * <output>
- * <input type="text" name="myTextBox" value="default value" />
- * </output>
+ * Example::
+ *
+ *    <f:form.textfield name="myTextBox" value="default value" />
+ *
+ * Output::
+ *
+ *    <input type="text" name="myTextBox" value="default value" />
  */
 class TextfieldViewHelper extends AbstractFormFieldViewHelper
 {
index 09ea8f8..913aa9a 100644 (file)
@@ -18,14 +18,16 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * A view helper which generates an <input type="file"> HTML element.
  * Make sure to set enctype="multipart/form-data" on the form!
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Example">
- * <f:form.upload name="file" />
- * </code>
- * <output>
- * <input type="file" name="file" />
- * </output>
+ * Example::
+ *
+ *    <f:form.upload name="file" />
+ *
+ * Output::
+ *
+ *    <input type="file" name="file" />
  */
 class UploadViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 6922901..8f8cee4 100644 (file)
@@ -21,47 +21,50 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * Validation results view helper
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Output error messages as a list">
- * <f:form.validationResults>
- *   <f:if condition="{validationResults.flattenedErrors}">
- *     <ul class="errors">
- *       <f:for each="{validationResults.flattenedErrors}" as="errors" key="propertyPath">
- *         <li>{propertyPath}
- *           <ul>
- *           <f:for each="{errors}" as="error">
- *             <li>{error.code}: {error}</li>
- *           </f:for>
- *           </ul>
- *         </li>
- *       </f:for>
- *     </ul>
- *   </f:if>
- * </f:form.validationResults>
- * </code>
- * <output>
- * <ul class="errors">
- *   <li>1234567890: Validation errors for argument "newBlog"</li>
- * </ul>
- * </output>
+ * Output error messages as a list::
  *
- * <code title="Output error messages for a single property">
- * <f:form.validationResults for="someProperty">
- *   <f:if condition="{validationResults.flattenedErrors}">
- *     <ul class="errors">
- *       <f:for each="{validationResults.errors}" as="error">
- *         <li>{error.code}: {error}</li>
- *       </f:for>
- *     </ul>
- *   </f:if>
- * </f:form.validationResults>
- * </code>
- * <output>
- * <ul class="errors">
- *   <li>1234567890: Some error message</li>
- * </ul>
- * </output>
+ *    <f:form.validationResults>
+ *       <f:if condition="{validationResults.flattenedErrors}">
+ *          <ul class="errors">
+ *             <f:for each="{validationResults.flattenedErrors}" as="errors" key="propertyPath">
+ *                <li>{propertyPath}
+ *                   <ul>
+ *                      <f:for each="{errors}" as="error">
+ *                         <li>{error.code}: {error}</li>
+ *                      </f:for>
+ *                   </ul>
+ *                </li>
+ *             </f:for>
+ *          </ul>
+ *       </f:if>
+ *    </f:form.validationResults>
+ *
+ * Output::
+ *
+ *    <ul class="errors">
+ *       <li>1234567890: Validation errors for argument "newBlog"</li>
+ *    </ul>
+ *
+ * Output error messages for a single property::
+ *
+ *    <f:form.validationResults for="someProperty">
+ *       <f:if condition="{validationResults.flattenedErrors}">
+ *          <ul class="errors">
+ *             <f:for each="{validationResults.errors}" as="error">
+ *                <li>{error.code}: {error}</li>
+ *             </f:for>
+ *          </ul>
+ *       </f:if>
+ *    </f:form.validationResults>
+ *
+ * Output::
+ *
+ *    <ul class="errors">
+ *      <li>1234567890: Some error message</li>
+ *    </ul>
  */
 class ValidationResultsViewHelper extends AbstractViewHelper
 {
index c32d984..ac2ab8d 100644 (file)
@@ -17,28 +17,32 @@ namespace TYPO3\CMS\Fluid\ViewHelpers;
 /**
  * Form view helper. Generates a <form> Tag.
  *
- * = Basic usage =
+ * Basic usage
+ * -----------
  *
  * Use <f:form> to output an HTML <form> tag which is targeted at the specified action, in the current controller and package.
  * It will submit the form data via a POST request. If you want to change this, use method="get" as an argument.
- * <code title="Example">
- * <f:form action="...">...</f:form>
- * </code>
+ * Example::
  *
- * = A complex form with a specified encoding type =
+ *    <f:form action="...">...</f:form>
  *
- * <code title="Form with enctype set">
- * <f:form action=".." controller="..." package="..." enctype="multipart/form-data">...</f:form>
- * </code>
+ * A complex form with a specified encoding type
+ * ---------------------------------------------
  *
- * = A Form which should render a domain object =
+ * Form with enctype set::
+ *
+ *    <f:form action=".." controller="..." package="..." enctype="multipart/form-data">...</f:form>
+ *
+ * A Form which should render a domain object
+ * ------------------------------------------
+ *
+ * Binding a domain object to a form::
+ *
+ *    <f:form action="..." name="customer" object="{customer}">
+ *       <f:form.hidden property="id" />
+ *       <f:form.textbox property="name" />
+ *    </f:form>
  *
- * <code title="Binding a domain object to a form">
- * <f:form action="..." name="customer" object="{customer}">
- * <f:form.hidden property="id" />
- * <f:form.textbox property="name" />
- * </f:form>
- * </code>
  * This automatically inserts the value of {customer.name} inside the textbox and adjusts the name of the textbox accordingly.
  */
 class FormViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormViewHelper
index 56d6929..a9c7bec 100644 (file)
@@ -23,32 +23,30 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
 /**
  * Formats an integer with a byte count into human-readable form.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Defaults">
- * {fileSize -> f:format.bytes()}
- * </code>
- * <output>
- * 123 KB
- * // depending on the value of {fileSize}
- * </output>
+ * Defaults::
  *
- * <code title="Defaults">
- * {fileSize -> f:format.bytes(decimals: 2, decimalSeparator: '.', thousandsSeparator: ',')}
- * </code>
- * <output>
- * 1,023.00 B
- * // depending on the value of {fileSize}
- * </output>
+ *    {fileSize -> f:format.bytes()}
+ *
+ * ``123 KB``
+ * Depending on the value of {fileSize}
+ *
+ * Defaults::
+ *
+ *    {fileSize -> f:format.bytes(decimals: 2, decimalSeparator: '.', thousandsSeparator: ',')}
+ *
+ * ``1,023.00 B``
+ * Depending on the value of {fileSize}
  *
  * You may provide an own set of units, like this: B,KB,MB,GB,TB,PB,EB,ZB,YB
- * <code title="custom units">
- * {fileSize -> f:format.bytes(units: '{f:translate(\'viewhelper.format.bytes.units\', \'fluid\')}'
- * </code>
- * <output>
- * 123 KB
- * // depending on the value of {fileSize}
- * </output>
+ * custom units::
+ *
+ *    {fileSize -> f:format.bytes(units: '{f:translate(\'viewhelper.format.bytes.units\', \'fluid\')}'
+ *
+ * ``123 KB``
+ * Depending on the value of {fileSize}
  */
 class BytesViewHelper extends AbstractViewHelper
 {
index 89fd609..df92f0f 100644 (file)
@@ -45,21 +45,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * @see http://php.net/manual/function.mb-convert-case.php [1]
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Example::
+ *
+ *    <f:format.case>Some Text with miXed case</f:format.case>
  *
- * <code title="Example">
- * <f:format.case>Some Text with miXed case</f:format.case>
- * </code>
- * <output>
  * SOME TEXT WITH MIXED CASE
- * </output>
  *
- * <code title="Example with given mode">
- * <f:format.case mode="capital">someString</f:format.case>
- * </code>
- * <output>
+ * Example with given mode::
+ *
+ *    <f:format.case mode="capital">someString</f:format.case>
+ *
  * SomeString
- * </output>
  */
 class CaseViewHelper extends AbstractViewHelper
 {
index 330edd2..45593b1 100644 (file)
@@ -24,43 +24,39 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * Use this view helper to crop the text between its opening and closing tags.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Defaults::
+ *
+ *    <f:format.crop maxCharacters="10">This is some very long text</f:format.crop>
  *
- * <code title="Defaults">
- * <f:format.crop maxCharacters="10">This is some very long text</f:format.crop>
- * </code>
- * <output>
  * This is…
- * </output>
  *
- * <code title="Custom suffix">
- * <f:format.crop maxCharacters="17" append="&nbsp;[more]">This is some very long text</f:format.crop>
- * </code>
- * <output>
+ * Custom suffix::
+ *
+ *    <f:format.crop maxCharacters="17" append="&nbsp;[more]">This is some very long text</f:format.crop>
+ *
  * This is some&nbsp;[more]
- * </output>
  *
- * <code title="Don't respect word boundaries">
- * <f:format.crop maxCharacters="10" respectWordBoundaries="false">This is some very long text</f:format.crop>
- * </code>
- * <output>
+ * Don't respect word boundaries::
+ *
+ *    <f:format.crop maxCharacters="10" respectWordBoundaries="false">This is some very long text</f:format.crop>
+ *
  * This is so…
- * </output>
  *
- * <code title="Don't respect HTML tags">
- * <f:format.crop maxCharacters="28" respectWordBoundaries="false" respectHtml="false">This is some text with <strong>HTML</strong> tags</f:format.crop>
- * </code>
- * <output>
+ * Don't respect HTML tags::
+ *
+ *    <f:format.crop maxCharacters="28" respectWordBoundaries="false" respectHtml="false">This is some text with <strong>HTML</strong> tags</f:format.crop>
+ *
  * This is some text with <stro
- * </output>
  *
- * <code title="Inline notation">
- * {someLongText -> f:format.crop(maxCharacters: 10)}
- * </code>
- * <output>
+ * Inline notation::
+ *
+ *    {someLongText -> f:format.crop(maxCharacters: 10)}
+ *
  * someLongText cropped after 10 characters…
  * (depending on the value of {someLongText})
- * </output>
  */
 class CropViewHelper extends AbstractViewHelper
 {
index 7861543..72e80f7 100644 (file)
@@ -21,36 +21,33 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * Formats a given float to a currency representation.
  *
- * = Examples =
- *
- * <code title="Defaults">
- * <f:format.currency>123.456</f:format.currency>
- * </code>
- * <output>
- * 123,46
- * </output>
- *
- * <code title="All parameters">
- * <f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator="," prependCurrency="true" separateCurrency="false" decimals="2">54321</f:format.currency>
- * </code>
- * <output>
- * $54,321.00
- * </output>
- *
- * <code title="Inline notation">
- * {someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: '€')}
- * </code>
- * <output>
- * 54,321,00 €
+ * Examples
+ * --------
+ *
+ * Defaults::
+ *
+ *    <f:format.currency>123.456</f:format.currency>
+ *
+ * ``123,46``
+ *
+ * All parameters::
+ *
+ *    <f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator="," prependCurrency="true" separateCurrency="false" decimals="2">54321</f:format.currency>
+ *
+ * ``$54,321.00``
+ *
+ * Inline notation::
+ *
+ *    {someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: '€')}
+ *
+ * ``54,321,00 €``
  * (depending on the value of {someNumber})
- * </output>
- *
- * <code title="use dash for decimals without value">
- * <f:format.currency useDash="true">123.00</f:format.currency>
- * </code>
- * <output>
- * 123,-
- * </output>
+ *
+ * use dash for decimals without value::
+ *
+ *    <f:format.currency useDash="true">123.00</f:format.currency>
+ *
+ * ``123,-``
  */
 class CurrencyViewHelper extends AbstractViewHelper
 {
index f12908a..20fb289 100644 (file)
@@ -23,63 +23,57 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
 /**
  * Formats an object implementing \DateTimeInterface.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Defaults">
- * <f:format.date>{dateObject}</f:format.date>
- * </code>
- * <output>
- * 1980-12-13
+ * Defaults::
+ *
+ *    <f:format.date>{dateObject}</f:format.date>
+ *
+ * ``1980-12-13``
  * (depending on the current date)
- * </output>
  *
- * <code title="Custom date format">
- * <f:format.date format="H:i">{dateObject}</f:format.date>
- * </code>
- * <output>
- * 01:23
+ * Custom date format::
+ *
+ *    <f:format.date format="H:i">{dateObject}</f:format.date>
+ *
+ * ``01:23``
  * (depending on the current time)
- * </output>
  *
- * <code title="Relative date with given time">
- * <f:format.date format="Y" base="{dateObject}">-1 year</f:format.date>
- * </code>
- * <output>
- * 2016
+ * Relative date with given time::
+ *
+ *    <f:format.date format="Y" base="{dateObject}">-1 year</f:format.date>
+ *
+ * ``2016``
  * (assuming dateObject is in 2017)
- * </output>
  *
- * <code title="strtotime string">
- * <f:format.date format="d.m.Y - H:i:s">+1 week 2 days 4 hours 2 seconds</f:format.date>
- * </code>
- * <output>
- * 13.12.1980 - 21:03:42
+ * strtotime string::
+ *
+ *    <f:format.date format="d.m.Y - H:i:s">+1 week 2 days 4 hours 2 seconds</f:format.date>
+ *
+ * ``13.12.1980 - 21:03:42``
  * (depending on the current time, see http://www.php.net/manual/en/function.strtotime.php)
- * </output>
  *
- * <code title="Localized dates using strftime date format">
- * <f:format.date format="%d. %B %Y">{dateObject}</f:format.date>
- * </code>
- * <output>
- * 13. Dezember 1980
+ * Localized dates using strftime date format::
+ *
+ *    <f:format.date format="%d. %B %Y">{dateObject}</f:format.date>
+ *
+ * ``13. Dezember 1980``
  * (depending on the current date and defined locale. In the example you see the 1980-12-13 in a german locale)
- * </output>
  *
- * <code title="Inline notation">
- * {f:format.date(date: dateObject)}
- * </code>
- * <output>
- * 1980-12-13
+ * Inline notation::
+ *
+ *    {f:format.date(date: dateObject)}
+ *
+ * ``1980-12-13``
  * (depending on the value of {dateObject})
- * </output>
  *
- * <code title="Inline notation (2nd variant)">
- * {dateObject -> f:format.date()}
- * </code>
- * <output>
- * 1980-12-13
+ * Inline notation (2nd variant)::
+ *
+ *    {dateObject -> f:format.date()}
+ *
+ * ``1980-12-13``
  * (depending on the value of {dateObject})
- * </output>
  */
 class DateViewHelper extends AbstractViewHelper
 {
index 029dd4f..5ad97ce 100644 (file)
@@ -27,29 +27,34 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * You can either specify a path to the TypoScript setting or set the parseFunc options directly.
  * By default lib.parseFunc_RTE is used to parse the string.
  *
- * == Examples ==
+ * Examples
+ * --------
+ *
+ * Default parameters::
+ *
+ *    <f:format.html>foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
+ *
+ * Output::
+ *
+ *    <p class="bodytext">foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.</p>
  *
- * <code title="Default parameters">
- * <f:format.html>foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
- * </code>
- * <output>
- * <p class="bodytext">foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.</p>
  * (depending on your TYPO3 setup)
- * </output>
- *
- * <code title="Custom parseFunc">
- * <f:format.html parseFuncTSPath="lib.parseFunc">foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
- * </code>
- * <output>
- * foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
- * </output>
- *
- * <code title="Inline notation">
- * {someText -> f:format.html(parseFuncTSPath: 'lib.parseFunc')}
- * </code>
- * <output>
- * foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
- * </output>
+ *
+ * Custom parseFunc::
+ *
+ *    <f:format.html parseFuncTSPath="lib.parseFunc">foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
+ *
+ * Output::
+ *
+ *    foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
+ *
+ * Inline notation::
+ *
+ *    {someText -> f:format.html(parseFuncTSPath: 'lib.parseFunc')}
+ *
+ * Output::
+ *
+ *    foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
  *
  * @see https://docs.typo3.org/typo3cms/TyposcriptReference/Functions/Parsefunc/
  */
index 02b985a..b4936d0 100644 (file)
@@ -21,21 +21,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * Applies html_entity_decode() to a value
  * @see http://www.php.net/html_entity_decode
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="default notation">
- * <f:format.htmlentitiesDecode>{text}</f:format.htmlentitiesDecode>
- * </code>
- * <output>
- * Text with &amp; &quot; &lt; &gt; replaced by unescaped entities (html_entity_decode applied).
- * </output>
+ * default notation::
  *
- * <code title="inline notation">
- * {text -> f:format.htmlentitiesDecode(encoding: 'ISO-8859-1')}
- * </code>
- * <output>
- * Text with &amp; &quot; &lt; &gt; replaced by unescaped entities (html_entity_decode applied).
- * </output>
+ *    <f:format.htmlentitiesDecode>{text}</f:format.htmlentitiesDecode>
+ *
+ * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities (html_entity_decode applied).
+ *
+ * inline notation::
+ *
+ *    {text -> f:format.htmlentitiesDecode(encoding: 'ISO-8859-1')}
+ *
+ * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities (html_entity_decode applied).
  */
 class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
 {
index 84477cd..ff0a187 100644 (file)
@@ -21,21 +21,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * Applies htmlentities() escaping to a value
  * @see http://www.php.net/manual/function.htmlentities.php
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="default notation">
- * <f:format.htmlentities>{text}</f:format.htmlentities>
- * </code>
- * <output>
- * Text with & " ' < > * replaced by HTML entities (htmlentities applied).
- * </output>
+ * default notation::
  *
- * <code title="inline notation">
- * {text -> f:format.htmlentities(encoding: 'ISO-8859-1')}
- * </code>
- * <output>
- * Text with & " ' < > * replaced by HTML entities (htmlentities applied).
- * </output>
+ *    <f:format.htmlentities>{text}</f:format.htmlentities>
+ *
+ * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities (htmlentities applied).
+ *
+ * inline notation::
+ *
+ *    {text -> f:format.htmlentities(encoding: 'ISO-8859-1')}
+ *
+ * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities (htmlentities applied).
  */
 class HtmlentitiesViewHelper extends AbstractEncodingViewHelper
 {
index 9927818..18ec8e6 100644 (file)
@@ -23,29 +23,27 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
 /**
  * Wrapper for PHPs json_encode function.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="encoding a view variable">
- * {someArray -> f:format.json()}
- * </code>
- * <output>
- * ["array","values"]
+ * encoding a view variable::
+ *
+ *    {someArray -> f:format.json()}
+ *
+ * ``["array","values"]``
  * // depending on the value of {someArray}
- * </output>
  *
- * <code title="associative array">
- * {f:format.json(value: {foo: 'bar', bar: 'baz'})}
- * </code>
- * <output>
- * {"foo":"bar","bar":"baz"}
- * </output>
+ * associative array::
+ *
+ *    {f:format.json(value: {foo: 'bar', bar: 'baz'})}
+ *
+ * ``{"foo":"bar","bar":"baz"}``
+ *
+ * non-associative array with forced object::
+ *
+ *    {f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)}
  *
- * <code title="non-associative array with forced object">
- * {f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)}
- * </code>
- * <output>
- * {"0":"bar","1":"baz"}
- * </output>
+ * ``{"0":"bar","1":"baz"}``
  */
 class JsonViewHelper extends AbstractViewHelper
 {
index adc6cd4..79911a6 100644 (file)
@@ -22,21 +22,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * Wrapper for PHPs nl2br function.
  * @see http://www.php.net/manual/en/function.nl2br.php
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Example">
- * <f:format.nl2br>{text_with_linebreaks}</f:format.nl2br>
- * </code>
- * <output>
- * text with line breaks replaced by <br />
- * </output>
+ * Example::
  *
- * <code title="Inline notation">
- * {text_with_linebreaks -> f:format.nl2br()}
- * </code>
- * <output>
- * text with line breaks replaced by <br />
- * </output>
+ *    <f:format.nl2br>{text_with_linebreaks}</f:format.nl2br>
+ *
+ * text with line breaks replaced by ``<br />``
+ *
+ * Inline notation::
+ *
+ *    {text_with_linebreaks -> f:format.nl2br()}
+ *
+ * text with line breaks replaced by ``<br />``
  */
 class Nl2brViewHelper extends AbstractViewHelper
 {
index 44267c0..5af2f27 100644 (file)
@@ -23,21 +23,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * @see http://www.php.net/manual/en/function.number-format.php
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Defaults">
- * <f:format.number>423423.234</f:format.number>
- * </code>
- * <output>
- * 423,423.20
- * </output>
+ * Defaults::
  *
- * <code title="With all parameters">
- * <f:format.number decimals="1" decimalSeparator="," thousandsSeparator=".">423423.234</f:format.number>
- * </code>
- * <output>
- * 423.423,2
- * </output>
+ *    <f:format.number>423423.234</f:format.number>
+ *
+ * ``423,423.20``
+ *
+ * With all parameters::
+ *
+ *    <f:format.number decimals="1" decimalSeparator="," thousandsSeparator=".">423423.234</f:format.number>
+ *
+ * ``423.423,2``
  */
 class NumberViewHelper extends AbstractViewHelper
 {
index d89f7d9..5a67587 100644 (file)
@@ -22,28 +22,26 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * Formats a string using PHPs str_pad function.
  * @see http://www.php.net/manual/en/function.str_pad.php
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Defaults">
- * <f:format.padding padLength="10">TYPO3</f:format.padding>
- * </code>
- * <output>
- * TYPO3     (note the trailing whitespace)
- * <output>
+ * Defaults::
  *
- * <code title="Specify padding string">
- * <f:format.padding padLength="10" padString="-=">TYPO3</f:format.padding>
- * </code>
- * <output>
- * TYPO3-=-=-
- * </output>
+ *    <f:format.padding padLength="10">TYPO3</f:format.padding>
  *
- * <code title="Specify padding type">
- * <f:format.padding padLength="10" padString="-" padType="both">TYPO3</f:format.padding>
- * </code>
- * <output>
- * --TYPO3---
- * </output>
+ * ``TYPO3     `` (note the trailing whitespace)
+ *
+ * Specify padding string::
+ *
+ *    <f:format.padding padLength="10" padString="-=">TYPO3</f:format.padding>
+ *
+ * ``TYPO3-=-=-``
+ *
+ * Specify padding type::
+ *
+ *    <f:format.padding padLength="10" padString="-" padType="both">TYPO3</f:format.padding>
+ *
+ * ``--TYPO3---``
  */
 class PaddingViewHelper extends AbstractViewHelper
 {
index 8436fbd..cfc5245 100644 (file)
@@ -23,35 +23,34 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  *
  * @see http://www.php.net/manual/function.strip-tags.php
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * default notation::
+ *
+ *    <f:format.stripTags>Some Text with <b>Tags</b> and an &Uuml;mlaut.</f:format.stripTags>
  *
- * <code title="default notation">
- * <f:format.stripTags>Some Text with <b>Tags</b> and an &Uuml;mlaut.</f:format.stripTags>
- * </code>
- * <output>
  * Some Text with Tags and an &Uuml;mlaut. (strip_tags() applied. Note: encoded entities are not decoded)
- * </output>
- *
- * <code title="default notation with allowedTags">
- * <f:format.stripTags allowedTags="<p><span><div><script>"><p>paragraph</p><span>span</span><div>divider</div><iframe>iframe</iframe><script>script</script></f:format.stripTags>
- * </code>
- * <output>
- * <p>paragraph</p><span>span</span><div>divider</div>iframe<script>script</script>
- * </output>
- *
- * <code title="inline notation">
- * {text -> f:format.stripTags()}
- * </code>
- * <output>
+ *
+ * default notation with allowedTags::
+ *
+ *    <f:format.stripTags allowedTags="<p><span><div><script>"><p>paragraph</p><span>span</span><div>divider</div><iframe>iframe</iframe><script>script</script></f:format.stripTags>
+ *
+ * Output::
+ *
+ *    <p>paragraph</p><span>span</span><div>divider</div>iframe<script>script</script>
+ *
+ * inline notation::
+ *
+ *    {text -> f:format.stripTags()}
+ *
  * Text without tags (strip_tags() applied)
- * </output>
  *
- * <code title="inline notation with allowedTags">
- * {text -> f:format.stripTags(allowedTags: "<p><span><div><script>")}
- * </code>
- * <output>
+ * inline notation with allowedTags::
+ *
+ *    {text -> f:format.stripTags(allowedTags: "<p><span><div><script>")}
+ *
  * Text with p, span, div and script Tags inside, all other tags are removed
- * </output>
  */
 class StripTagsViewHelper extends AbstractViewHelper
 {
index ddc3551..6cd6c2a 100644 (file)
@@ -24,21 +24,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  * @see http://www.php.net/manual/function.rawurlencode.php
  * Note: The output is not escaped. You may have to ensure proper escaping on your own.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="default notation">
- * <f:format.rawurlencode>foo @+%/</f:format.rawurlencode>
- * </code>
- * <output>
- * foo%20%40%2B%25%2F (rawurlencode() applied)
- * </output>
+ * default notation::
+ *
+ *    <f:format.rawurlencode>foo @+%/</f:format.rawurlencode>
+ *
+ * ``foo%20%40%2B%25%2F`` (rawurlencode() applied)
+ *
+ * inline notation::
+ *
+ *    {text -> f:format.urlencode()}
  *
- * <code title="inline notation">
- * {text -> f:format.urlencode()}
- * </code>
- * <output>
  * Url encoded text (rawurlencode() applied)
- * </output>
  */
 class UrlencodeViewHelper extends AbstractViewHelper
 {
index 156c6af..3b9524f 100644 (file)
@@ -22,46 +22,51 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
 /**
  * Resizes a given image (if required) and renders the respective img tag
  *
- * = Examples =
- *
- * <code title="Default">
- * <f:image src="EXT:myext/Resources/Public/typo3_logo.png" alt="alt text" />
- * </code>
- * <output>
- * <img alt="alt text" src="typo3conf/ext/myext/Resources/Public/typo3_logo.png" width="396" height="375" />
- * or (in BE mode):
- * <img alt="alt text" src="../typo3conf/ext/viewhelpertest/Resources/Public/typo3_logo.png" width="396" height="375" />
- * </output>
- *
- * <code title="Image Object">
- * <f:image image="{imageObject}" />
- * </code>
- * <output>
- * <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
- * </output>
- *
- * <code title="Inline notation">
- * {f:image(src: 'EXT:viewhelpertest/Resources/Public/typo3_logo.png', alt: 'alt text', minWidth: 30, maxWidth: 40)}
- * </code>
- * <output>
- * <img alt="alt text" src="../typo3temp/assets/images/f13d79a526.png" width="40" height="38" />
+ * Examples
+ * --------
+ *
+ * Default::
+ *
+ *    <f:image src="EXT:myext/Resources/Public/typo3_logo.png" alt="alt text" />
+ *
+ * Output::
+ *
+ *    <img alt="alt text" src="typo3conf/ext/myext/Resources/Public/typo3_logo.png" width="396" height="375" />
+ *
+ * or (in BE mode)::
+ *
+ *    <img alt="alt text" src="../typo3conf/ext/viewhelpertest/Resources/Public/typo3_logo.png" width="396" height="375" />
+ *
+ * Image Object::
+ *
+ *    <f:image image="{imageObject}" />
+ *
+ * Output::
+ *
+ *    <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
+ *
+ * Inline notation::
+ *
+ *    {f:image(src: 'EXT:viewhelpertest/Resources/Public/typo3_logo.png', alt: 'alt text', minWidth: 30, maxWidth: 40)}
+ *
+ * Output::
+ *
+ *    <img alt="alt text" src="../typo3temp/assets/images/f13d79a526.png" width="40" height="38" />
+ *
  * (depending on your TYPO3s encryption key)
- * </output>
  *
- * <code title="Other resource type (e.g. PDF)">
- * <f:image src="fileadmin/user_upload/example.pdf" alt="foo" />
- * </code>
- * <output>
+ * Other resource type (e.g. PDF)::
+ *
+ *    <f:image src="fileadmin/user_upload/example.pdf" alt="foo" />
+ *
  * If your graphics processing library is set up correctly then it will output a thumbnail of the first page of your PDF document.
- * <img src="fileadmin/_processed_/1/2/csm_example_aabbcc112233.gif" width="200" height="284" alt="foo">
- * </output>
+ * ``<img src="fileadmin/_processed_/1/2/csm_example_aabbcc112233.gif" width="200" height="284" alt="foo">``
+ *
+ * Non-existent image::
+ *
+ *    <f:image src="NonExistingImage.png" alt="foo" />
  *
- * <code title="Non-existent image">
- * <f:image src="NonExistingImage.png" alt="foo" />
- * </code>
- * <output>
  * Could not get image resource for "NonExistingImage.png".
- * </output>
  */
 class ImageViewHelper extends AbstractTagBasedViewHelper
 {
index a68e737..cf21207 100644 (file)
@@ -19,15 +19,18 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 /**
  * A view helper for creating links to extbase actions.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * link to the show-action of the current controller::
+ *
+ *    <f:link.action action="show">action link</f:link.action>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz">action link</f:link.action>
  *
- * <code title="link to the show-action of the current controller">
- * <f:link.action action="show">action link</f:link.action>
- * </code>
- * <output>
- * <a href="index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz">action link</f:link.action>
  * (depending on the current page and your TS configuration)
- * </output>
  */
 class ActionViewHelper extends AbstractTagBasedViewHelper
 {
index fa866b0..d5ed171 100644 (file)
@@ -20,22 +20,26 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Email link view helper.
  * Generates an email link incorporating TYPO3s spamProtectEmailAddresses-settings.
  *
- * = Examples
+ * Exampl
+ * ------
+ *
+ * basic email link::
+ *
+ *    <f:link.email email="foo@bar.tld" />
+ *
+ * Output::
+ *
+ *    <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">foo(at)bar.tld</a>
  *
- * <code title="basic email link">
- * <f:link.email email="foo@bar.tld" />
- * </code>
- * <output>
- * <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">foo(at)bar.tld</a>
  * (depending on your spamProtectEmailAddresses-settings)
- * </output>
  *
- * <code title="Email link with custom linktext">
- * <f:link.email email="foo@bar.tld">some custom content</f:link.email>
- * </code>
- * <output>
- * <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">some custom content</a>
- * </output>
+ * Email link with custom linktext::
+ *
+ *    <f:link.email email="foo@bar.tld">some custom content</f:link.email>
+ *
+ * Output::
+ *
+ *    <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">some custom content</a>
  */
 class EmailViewHelper extends AbstractTagBasedViewHelper
 {
index 0aaedbe..60ddc07 100644 (file)
@@ -19,21 +19,24 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 /**
  * A view helper for creating links to external targets.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code>
- * <f:link.external uri="http://www.typo3.org" target="_blank">external link</f:link.external>
- * </code>
- * <output>
- * <a href="http://www.typo3.org" target="_blank">external link</a>
- * </output>
+ * Default::
  *
- * <code title="custom default scheme">
- * <f:link.external uri="typo3.org" defaultScheme="ftp">external ftp link</f:link.external>
- * </code>
- * <output>
- * <a href="ftp://typo3.org">external ftp link</a>
- * </output>
+ *    <f:link.external uri="http://www.typo3.org" target="_blank">external link</f:link.external>
+ *
+ * Output::
+ *
+ *    <a href="http://www.typo3.org" target="_blank">external link</a>
+ *
+ * custom default scheme::
+ *
+ *    <f:link.external uri="typo3.org" defaultScheme="ftp">external ftp link</f:link.external>
+ *
+ * Output::
+ *
+ *    <a href="ftp://typo3.org">external ftp link</a>
  */
 class ExternalViewHelper extends AbstractTagBasedViewHelper
 {
index 6f96eb5..449d8a5 100644 (file)
@@ -19,31 +19,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 /**
  * A view helper for creating links to TYPO3 pages.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * link to the current page::
+ *
+ *    <f:link.page>page link</f:link.page>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=123">page link</f:link.action>
  *
- * <code title="link to the current page">
- * <f:link.page>page link</f:link.page>
- * </code>
- * <output>
- * <a href="index.php?id=123">page link</f:link.action>
  * (depending on the current page and your TS configuration)
- * </output>
  *
- * <code title="query parameters">
- * <f:link.page pageUid="1" additionalParams="{foo: 'bar'}">page link</f:link.page>
- * </code>
- * <output>
- * <a href="index.php?id=1&foo=bar">page link</f:link.action>
+ * query parameters::
+ *
+ *    <f:link.page pageUid="1" additionalParams="{foo: 'bar'}">page link</f:link.page>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=1&foo=bar">page link</f:link.action>
+ *
  * (depending on your TS configuration)
- * </output>
  *
- * <code title="query parameters for extensions">
- * <f:link.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}">page link</f:link.page>
- * </code>
- * <output>
- * <a href="index.php?id=1&extension_key[foo]=bar">page link</f:link.action>
+ * query parameters for extensions::
+ *
+ *    <f:link.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}">page link</f:link.page>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=1&extension_key[foo]=bar">page link</f:link.action>
+ *
  * (depending on your TS configuration)
- * </output>
  */
 class PageViewHelper extends AbstractTagBasedViewHelper
 {
index a564cfb..757de07 100644 (file)
@@ -25,31 +25,34 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * A ViewHelper to create links from fields supported by the link wizard
  *
- * == Example ==
+ * Example
+ * -------
  *
  * {link} contains "19 _blank - "testtitle with whitespace" &X=y"
  *
- * <code title="minimal usage">
- * <f:link.typolink parameter="{link}">
- * Linktext
- * </f:link.typolink>
- * <output>
- * <a href="index.php?id=19&X=y" title="testtitle with whitespace" target="_blank">
- * Linktext
- * </a>
- * </output>
- * </code>
+ * minimal usage::
  *
- * <code title="Full parameter usage">
- * <f:link.typolink parameter="{link}" target="_blank" class="ico-class" title="some title" additionalParams="&u=b" additionalAttributes="{type:'button'}" useCacheHash="true">
- * Linktext
- * </f:link.typolink>
- * </code>
- * <output>
- * <a href="index.php?id=19&X=y&u=b" title="some title" target="_blank" class="ico-class" type="button">
- * Linktext
- * </a>
- * </output>
+ *    <f:link.typolink parameter="{link}">
+ *       Linktext
+ *    </f:link.typolink>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=19&X=y" title="testtitle with whitespace" target="_blank">
+ *       Linktext
+ *    </a>
+ *
+ * Full parameter usage::
+ *
+ *    <f:link.typolink parameter="{link}" target="_blank" class="ico-class" title="some title" additionalParams="&u=b" additionalAttributes="{type:'button'}" useCacheHash="true">
+ *       Linktext
+ *    </f:link.typolink>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=19&X=y&u=b" title="some title" target="_blank" class="ico-class" type="button">
+ *      Linktext
+ *    </a>
  */
 class TypolinkViewHelper extends AbstractViewHelper
 {
index a5643dc..588c7e6 100644 (file)
@@ -29,28 +29,32 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * It asks the RendererRegister for the correct Renderer class and if not found it falls
  * back to the ImageViewHelper as that is the "Renderer" class for images in Fluid context.
  *
- * = Examples =
- *
- * <code title="Image Object">
- *     <f:media file="{file}" width="400" height="375" />
- * </code>
- * <output>
- *     <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
- * </output>
- *
- * <code title="MP4 Video Object">
- *     <f:media file="{file}" width="400" height="375" />
- * </code>
- * <output>
- *     <video width="400" height="375" controls><source src="fileadmin/user_upload/my-video.mp4" type="video/mp4"></video>
- * </output>
- *
- * <code title="MP4 Video Object with loop and autoplay option set">
- *     <f:media file="{file}" width="400" height="375" additionalConfig="{loop: '1', autoplay: '1'}" />
- * </code>
- * <output>
- *     <video width="400" height="375" controls loop><source src="fileadmin/user_upload/my-video.mp4" type="video/mp4"></video>
- * </output>
+ * Examples
+ * --------
+ *
+ * Image Object::
+ *
+ *    <f:media file="{file}" width="400" height="375" />
+ *
+ * Output::
+ *
+ *    <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
+ *
+ * MP4 Video Object::
+ *
+ *    <f:media file="{file}" width="400" height="375" />
+ *
+ * Output::
+ *
+ *    <video width="400" height="375" controls><source src="fileadmin/user_upload/my-video.mp4" type="video/mp4"></video>
+ *
+ * MP4 Video Object with loop and autoplay option set::
+ *
+ *    <f:media file="{file}" width="400" height="375" additionalConfig="{loop: '1', autoplay: '1'}" />
+ *
+ * Output::
+ *
+ *    <video width="400" height="375" controls loop><source src="fileadmin/user_upload/my-video.mp4" type="video/mp4"></video>
  */
 class MediaViewHelper extends AbstractTagBasedViewHelper
 {
index 5e8862d..7c29779 100644 (file)
@@ -21,31 +21,30 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 /**
  * This view helper implements an ifAuthenticated/else condition for FE users/groups.
  *
- * = Examples =
- *
- * <code title="Basic usage">
- * <f:security.ifAuthenticated>
- * This is being shown whenever a FE user is logged in
- * </f:security.ifAuthenticated>
- * </code>
- * <output>
- * Everything inside the <f:ifAuthenticated> tag is being displayed if you are authenticated with any FE user account.
- * </output>
- *
- * <code title="IfAuthenticated / then / else">
- * <f:security.ifAuthenticated>
- * <f:then>
- * This is being shown in case you have access.
- * </f:then>
- * <f:else>
- * This is being displayed in case you do not have access.
- * </f:else>
- * </f:security.ifAuthenticated>
- * </code>
- * <output>
+ * Examples
+ * --------
+ *
+ * Basic usage::
+ *
+ *    <f:security.ifAuthenticated>
+ *       This is being shown whenever a FE user is logged in
+ *    </f:security.ifAuthenticated>
+ *
+ * Everything inside the ``<f:ifAuthenticated>`` tag is being displayed if you are authenticated with any FE user account.
+ *
+ * IfAuthenticated / then / else::
+ *
+ *    <f:security.ifAuthenticated>
+ *       <f:then>
+ *          This is being shown in case you have access.
+ *       </f:then>
+ *       <f:else>
+ *          This is being displayed in case you do not have access.
+ *       </f:else>
+ *    </f:security.ifAuthenticated>
+ *
  * Everything inside the "then" tag is displayed if you have access.
  * Otherwise, everything inside the "else"-tag is displayed.
- * </output>
  */
 class IfAuthenticatedViewHelper extends AbstractConditionViewHelper
 {
index 71bf71f..c17b349 100644 (file)
@@ -22,40 +22,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 /**
  * This view helper implements an ifHasRole/else condition for FE users/groups.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Basic usage">
- * <f:security.ifHasRole role="Administrator">
- * This is being shown in case the current FE user belongs to a FE usergroup (aka role) titled "Administrator" (case sensitive)
- * </f:security.ifHasRole>
- * </code>
- * <output>
- * Everything inside the <f:ifHasRole> tag is being displayed if the logged in FE user belongs to the specified role.
- * </output>
+ * Basic usage::
  *
- * <code title="Using the usergroup uid as role identifier">
- * <f:security.ifHasRole role="1">
- * This is being shown in case the current FE user belongs to a FE usergroup (aka role) with the uid "1"
- * </f:security.ifHasRole>
- * </code>
- * <output>
- * Everything inside the <f:ifHasRole> tag is being displayed if the logged in FE user belongs to the specified role.
- * </output>
+ *    <f:security.ifHasRole role="Administrator">
+ *      This is being shown in case the current FE user belongs to a FE usergroup (aka role) titled "Administrator" (case sensitive)
+ *    </f:security.ifHasRole>
+ *
+ * Everything inside the ``<f:ifHasRole>`` tag is being displayed if the logged in FE user belongs to the specified role.
+ *
+ * Using the usergroup uid as role identifier::
+ *
+ *    <f:security.ifHasRole role="1">
+ *       This is being shown in case the current FE user belongs to a FE usergroup (aka role) with the uid "1"
+ *    </f:security.ifHasRole>
+ *
+ * Everything inside the ``<f:ifHasRole>`` tag is being displayed if the logged in FE user belongs to the specified role.
+ *
+ * IfRole / then / else::
+ *
+ *    <f:security.ifHasRole role="Administrator">
+ *       <f:then>
+ *          This is being shown in case you have the role.
+ *       </f:then>
+ *       <f:else>
+ *          This is being displayed in case you do not have the role.
+ *       </f:else>
+ *    </f:security.ifHasRole>
  *
- * <code title="IfRole / then / else">
- * <f:security.ifHasRole role="Administrator">
- * <f:then>
- * This is being shown in case you have the role.
- * </f:then>
- * <f:else>
- * This is being displayed in case you do not have the role.
- * </f:else>
- * </f:security.ifHasRole>
- * </code>
- * <output>
  * Everything inside the "then" tag is displayed if the logged in FE user belongs to the specified role.
  * Otherwise, everything inside the "else"-tag is displayed.
- * </output>
  */
 class IfHasRoleViewHelper extends AbstractConditionViewHelper
 {
index 7b56c02..7ec83a9 100644 (file)
@@ -24,52 +24,47 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Translate a key from locallang. The files are loaded from the folder
  * "Resources/Private/Language/".
  *
- * == Examples ==
+ * Examples
+ * --------
+ *
+ * Translate key::
+ *
+ *    <f:translate key="key1" />
  *
- * <code title="Translate key">
- * <f:translate key="key1" />
- * </code>
- * <output>
  * value of key "key1" in the current website language
- * </output>
  *
- * <code title="Keep HTML tags">
- * <f:format.raw><f:translate key="htmlKey" /></f:format.raw>
- * </code>
- * <output>
+ * Keep HTML tags::
+ *
+ *    <f:format.raw><f:translate key="htmlKey" /></f:format.raw>
+ *
  * value of key "htmlKey" in the current website language, no htmlspecialchars applied
- * </output>
  *
- * <code title="Translate key from custom locallang file">
- * <f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" />
- * </code>
- * <output>
+ * Translate key from custom locallang file::
+ *
+ *    <f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" />
+ *
  * value of key "key1" in the current website language
- * </output>
  *
- * <code title="Inline notation with arguments and default value">
- * {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
- * </code>
- * <output>
+ * Inline notation with arguments and default value::
+ *
+ *    {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
+ *
  * value of key "argumentsKey" in the current website language
  * with "%1" and "%2" are replaced by "dog" and "fox" (printf)
  * if the key is not found, the output is "default value"
- * </output>
  *
- * <code title="Inline notation with extension name">
- * {f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
- * </code>
- * <output>
+ * Inline notation with extension name::
+ *
+ *    {f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
+ *
  * value of key "someKey" in the current website language
  * the locallang file of extension "some_extension_name" will be used
- * </output>
  *
- * <code title="Translate id as in TYPO3 Flow">
- * <f:translate id="key1" />
- * </code>
- * <output>
+ * Translate id as in TYPO3 Flow::
+ *
+ *    <f:translate id="key1" />
+ *
  * value of id "key1" in the current website language
- * </output>
  */
 class TranslateViewHelper extends AbstractViewHelper
 {
index 11f16cd..189e73d 100644 (file)
@@ -21,15 +21,15 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * A view helper for creating URIs to extbase actions.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="URI to the show-action of the current controller">
- * <f:uri.action action="show" />
- * </code>
- * <output>
- * index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz
+ * URI to the show-action of the current controller::
+ *
+ *    <f:uri.action action="show" />
+ *
+ * ``index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz``
  * (depending on the current page and your TS configuration)
- * </output>
  */
 class ActionViewHelper extends AbstractViewHelper
 {
index a02514f..f02272e 100644 (file)
@@ -22,15 +22,18 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Email URI view helper.
  * Generates an email URI incorporating TYPO3s spamProtectEmailAddresses-settings.
  *
- * = Examples
+ * Example
+ * -------
+ *
+ * Basic email URI::
+ *
+ *    <f:uri.email email="foo@bar.tld" />
+ *
+ * Output::
+ *
+ *    javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');
  *
- * <code title="basic email URI">
- * <f:uri.email email="foo@bar.tld" />
- * </code>
- * <output>
- * javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');
  * (depending on your spamProtectEmailAddresses-settings)
- * </output>
  */
 class EmailViewHelper extends AbstractViewHelper
 {
index 0f1e729..0b99cd1 100644 (file)
@@ -22,21 +22,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * A view helper for creating URIs to external targets.
  * Currently the specified URI is simply passed through.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code>
- * <f:uri.external uri="http://www.typo3.org" />
- * </code>
- * <output>
- * http://www.typo3.org
- * </output>
+ * Default::
  *
- * <code title="custom default scheme">
- * <f:uri.external uri="typo3.org" defaultScheme="ftp" />
- * </code>
- * <output>
- * ftp://typo3.org
- * </output>
+ *    <f:uri.external uri="http://www.typo3.org" />
+ *
+ * ``http://www.typo3.org``
+ *
+ * custom default scheme::
+ *
+ *    <f:uri.external uri="typo3.org" defaultScheme="ftp" />
+ *
+ * ``ftp://typo3.org``
  */
 class ExternalViewHelper extends AbstractViewHelper
 {
index 0267d81..b7fe18c 100644 (file)
@@ -27,40 +27,37 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * Resizes a given image (if required) and returns its relative path.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="Default">
- * <f:uri.image src="EXT:myext/Resources/Public/typo3_logo.png" />
- * </code>
- * <output>
- * typo3conf/ext/myext/Resources/Public/typo3_logo.png
+ * Default::
+ *
+ *    <f:uri.image src="EXT:myext/Resources/Public/typo3_logo.png" />
+ *
+ * ``typo3conf/ext/myext/Resources/Public/typo3_logo.png``
  * or (in BE mode):
- * ../typo3conf/ext/myext/Resources/Public/typo3_logo.png
- * </output>
+ * ``../typo3conf/ext/myext/Resources/Public/typo3_logo.png``
+ *
+ * Image Object::
+ *
+ *    <f:uri.image image="{imageObject}" />
  *
- * <code title="Image Object">
- * <f:uri.image image="{imageObject}" />
- * </code>
- * <output>
- * fileadmin/images/image.png
+ * ``fileadmin/images/image.png``
  * or (in BE mode):
- * fileadmin/images/image.png
- * </output>
+ * ``fileadmin/images/image.png``
  *
- * <code title="Inline notation">
- * {f:uri.image(src: 'EXT:myext/Resources/Public/typo3_logo.png', minWidth: 30, maxWidth: 40)}
- * </code>
- * <output>
- * typo3temp/assets/images/[b4c0e7ed5c].png
+ * Inline notation::
+ *
+ *    {f:uri.image(src: 'EXT:myext/Resources/Public/typo3_logo.png', minWidth: 30, maxWidth: 40)}
+ *
+ * ``typo3temp/assets/images/[b4c0e7ed5c].png``
  * (depending on your TYPO3s encryption key)
- * </output>
  *
- * <code title="non existing image">
- * <f:uri.image src="NonExistingImage.png" />
- * </code>
- * <output>
+ * non existing image::
+ *
+ *    <f:uri.image src="NonExistingImage.png" />
+ *
  * Could not get image resource for "NonExistingImage.png".
- * </output>
  */
 class ImageViewHelper extends AbstractViewHelper
 {
index 77242d3..b968b9c 100644 (file)
@@ -21,31 +21,29 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * A view helper for creating URIs to TYPO3 pages.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="URI to the current page">
- * <f:uri.page>page link</f:uri.page>
- * </code>
- * <output>
- * index.php?id=123
+ * URI to the current page::
+ *
+ *    <f:uri.page>page link</f:uri.page>
+ *
+ * ``index.php?id=123``
  * (depending on the current page and your TS configuration)
- * </output>
  *
- * <code title="query parameters">
- * <f:uri.page pageUid="1" additionalParams="{foo: 'bar'}" />
- * </code>
- * <output>
- * index.php?id=1&foo=bar
+ * query parameters::
+ *
+ *    <f:uri.page pageUid="1" additionalParams="{foo: 'bar'}" />
+ *
+ * ``index.php?id=1&foo=bar``
  * (depending on your TS configuration)
- * </output>
  *
- * <code title="query parameters for extensions">
- * <f:uri.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}" />
- * </code>
- * <output>
- * index.php?id=1&extension_key[foo]=bar
+ * query parameters for extensions::
+ *
+ *    <f:uri.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}" />
+ *
+ * ``index.php?id=1&extension_key[foo]=bar``
  * (depending on your TS configuration)
- * </output>
  */
 class PageViewHelper extends AbstractViewHelper
 {
index e3752c8..f406330 100644 (file)
@@ -23,15 +23,18 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * A view helper for creating URIs to resources.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Defaults::
+ *
+ *    <link href="{f:uri.resource(path:'css/stylesheet.css')}" rel="stylesheet" />
+ *
+ * Output::
+ *
+ *    <link href="Resources/Packages/MyPackage/stylesheet.css" rel="stylesheet" />
  *
- * <code title="Defaults">
- * <link href="{f:uri.resource(path:'css/stylesheet.css')}" rel="stylesheet" />
- * </code>
- * <output>
- * <link href="Resources/Packages/MyPackage/stylesheet.css" rel="stylesheet" />
  * (depending on current package)
- * </output>
  */
 class ResourceViewHelper extends AbstractViewHelper
 {
index b339288..269a411 100644 (file)
@@ -24,26 +24,25 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * A ViewHelper to create uris from fields supported by the link wizard
  *
- * == Example ==
+ * Example
+ * -------
  *
- * {link} contains "19 - - - &X=y"
+ * ``{link}`` contains ``19 - - - &X=y``
  * Please note that due to the nature of typolink you have to provide a
  * full set of parameters if you use the parameter only. Target, class
  * and title will be discarded.
  *
- * <code title="minimal usage">
- * <f:uri.typolink parameter="{link}" />
- * <output>
- * index.php?id=19&X=y
- * </output>
- * </code>
+ * minimal usage::
  *
- * <code title="Full parameter usage">
- * <f:uri.typolink parameter="{link}" additionalParams="&u=b" useCacheHash="true" />
- * </code>
- * <output>
- * index.php?id=19&X=y&u=b
- * </output>
+ *    <f:uri.typolink parameter="{link}" />
+ *
+ * ``index.php?id=19&X=y``
+ *
+ * Full parameter usage::
+ *
+ *    <f:uri.typolink parameter="{link}" additionalParams="&u=b" useCacheHash="true" />
+ *
+ * ``index.php?id=19&X=y&u=b``
  */
 class TypolinkViewHelper extends AbstractViewHelper
 {
index f43bdbb..fe1dfba 100644 (file)
@@ -17,23 +17,28 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
 /**
  * Simple paginate widget
- * Note: Make sure to include jQuery and jQuery UI in the HTML, like that:
+ * Note: Make sure to include jQuery and jQuery UI in the HTML, like that::
+ *
  * <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
  * <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.4/jquery-ui.min.js"></script>
  * <link rel="stylesheet" href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.8.3/themes/base/jquery-ui.css" type="text/css" media="all" />
  * <link rel="stylesheet" href="http://static.jquery.com/ui/css/demo-docs-theme/ui.theme.css" type="text/css" media="all" />
+ *
  * You can include the provided TS template that includes the above snippet to the pages headerData.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * Render lib object::
+ *
+ *    <input type="text" id="name" />
+ *    <f:widget.autocomplete for="name" objects="{posts}" searchProperty="author">
+ *
+ * Output::
+ *
+ *    <input type="text" id="name" />
  *
- * <code title="Render lib object">
- * <input type="text" id="name" />
- * <f:widget.autocomplete for="name" objects="{posts}" searchProperty="author">
- * </code>
- * <output>
- * <input type="text" id="name" />
  * the input field and the required JavaScript for the Ajax communication (see Resources/Private/Templates/ViewHelpers/Widget/Autocomplete/Index.html
- * </output>
  */
 class AutocompleteViewHelper extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper
 {
index d3c2a95..d60c58b 100644 (file)
@@ -19,15 +19,18 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 /**
  * A view helper for creating Links to extbase actions within widets.
  *
- * = Examples =
+ * Examples
+ * --------
+ *
+ * URI to the show-action of the current controller::
+ *
+ *    <f:widget.link action="show">link</f:widget.link>
+ *
+ * Output::
+ *
+ *    <a href="index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz">link</a>
  *
- * <code title="URI to the show-action of the current controller">
- * <f:widget.link action="show">link</f:widget.link>
- * </code>
- * <output>
- * <a href="index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz">link</a>
  * (depending on the current page, widget and your TS configuration)
- * </output>
  */
 class LinkViewHelper extends AbstractTagBasedViewHelper
 {
index 071565d..1eb90f0 100644 (file)
@@ -20,23 +20,25 @@ use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper;
 /**
  * This ViewHelper renders a Pagination of objects.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="required arguments">
- * <f:widget.paginate objects="{blogs}" as="paginatedBlogs">
- * use {paginatedBlogs} as you used {blogs} before, most certainly inside
- * a <f:for> loop.
- * </f:widget.paginate>
- * </code>
+ * required arguments::
  *
- * <code title="full configuration">
- * <f:widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, maximumNumberOfLinks: 10}">
- * use {paginatedBlogs} as you used {blogs} before, most certainly inside
- * a <f:for> loop.
- * </f:widget.paginate>
- * </code>
+ *    <f:widget.paginate objects="{blogs}" as="paginatedBlogs">
+ *       use {paginatedBlogs} as you used {blogs} before, most certainly inside
+ *       a <f:for> loop.
+ *    </f:widget.paginate>
  *
- * = Performance characteristics =
+ * full configuration::
+ *
+ *    <f:widget.paginate objects="{blogs}" as="paginatedBlogs" configuration="{itemsPerPage: 5, insertAbove: 1, insertBelow: 0, maximumNumberOfLinks: 10}">
+ *       use {paginatedBlogs} as you used {blogs} before, most certainly inside
+ *       a <f:for> loop.
+ *    </f:widget.paginate>
+ *
+ * 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.
index b7f342a..974da64 100644 (file)
@@ -21,15 +21,15 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 /**
  * A view helper for creating URIs to extbase actions within widgets.
  *
- * = Examples =
+ * Examples
+ * --------
  *
- * <code title="URI to the show-action of the current controller">
- * <f:widget.uri action="show" />
- * </code>
- * <output>
- * index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz
+ * URI to the show-action of the current controller::
+ *
+ *    <f:widget.uri action="show" />
+ *
+ * ``index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz``
  * (depending on the current page, widget and your TS configuration)
- * </output>
  */
 class UriViewHelper extends AbstractViewHelper
 {
index d570bf2..c29069b 100644 (file)
@@ -33,10 +33,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Usage
  * =====
  *
- * <pre>
- * {namespace formvh=TYPO3\CMS\Form\ViewHelpers}
- * <formvh:render factoryClass="NameOfYourCustomFactoryClass" />
- * </pre>
+ * Default::
+ *
+ *    {namespace formvh=TYPO3\CMS\Form\ViewHelpers}
+ *    <formvh:render factoryClass="NameOfYourCustomFactoryClass" />
  *
  * The factory class must implement {@link TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface}.
  *