[TASK] Improve ViewHelper documentation 04/61104/9
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Fri, 21 Jun 2019 07:42:44 +0000 (09:42 +0200)
committerTymoteusz Motylewski <t.motylewski@gmail.com>
Mon, 1 Jul 2019 21:30:20 +0000 (23:30 +0200)
* Add examples to ViewHelpers that did not have any example yet.
* Add cross references between ViewHelpers where a different ViewHelper
  was mentioned.
* Add full stop to end if sentences.
* Fix indentation within examples.
* Add some syntax like code.
* Fix escaping of PHP classes with namespaces by wrapping them with
  :php:`` text role.
* Use https for urls to php.net.
* Remove '/en/' path from urls to php.net. This ensures the current user
  language is auto detected. Not forcing anyone to keep english.

Relates: #88600
Releases: master, 9.5
Change-Id: I2394890a20adba06719fa35990044057346dfb2b
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/61104
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Tested-by: Tymoteusz Motylewski <t.motylewski@gmail.com>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Tymoteusz Motylewski <t.motylewski@gmail.com>
81 files changed:
typo3/sysext/backend/Classes/ViewHelpers/AvatarViewHelper.php
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/ModuleLinkViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/Uri/EditRecordViewHelper.php
typo3/sysext/backend/Classes/ViewHelpers/Uri/NewRecordViewHelper.php
typo3/sysext/core/Classes/ViewHelpers/IconForRecordViewHelper.php
typo3/sysext/core/Classes/ViewHelpers/IconForResourceViewHelper.php
typo3/sysext/core/Classes/ViewHelpers/IconViewHelper.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/Labels/CshViewHelper.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/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/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 ff7fa99..d2a4064 100644 (file)
@@ -22,7 +22,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Render the avatar img tag for a given backend user
+ * Render the avatar img tag for a given backend user.
  */
 class AvatarViewHelper extends AbstractViewHelper
 {
index 237b9bf..579dfd6 100644 (file)
@@ -24,7 +24,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * pass the uid and table to FormEngine.
  *
  * The uid must be given as a positive integer.
- * For new records, use the newRecordViewHelper
+ * For new records, use the :ref:`<be:link.newRecordViewHelper> <typo3-backend-link-newrecord>`.
  *
  * Examples
  * ========
@@ -36,7 +36,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Output::
  *
  *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][42]=edit&returnUrl=foo/bar">
- *      Edit record
+ *        Edit record
  *    </a>
  *
  * Link to edit page uid=3 and then return back to the BE module "web_MyextensionList"::
index a1286d7..8e67c11 100644 (file)
@@ -26,7 +26,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  * The table argument is mandatory, it decides what record is to be created.
  *
- * The pid argument will put the new record on this page, if 0 given it will
+ * The pid argument will put the new record on this page, if ``0`` given it will
  * be placed to the root page.
  *
  * The uid argument accepts only negative values. If this is given, the new
@@ -37,7 +37,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * An exception will be thrown, if both uid and pid are given.
  * An exception will be thrown, if the uid argument is not a negative integer.
  *
- * To edit records, use the editRecordViewHelper
+ * To edit records, use the :ref:`<be:link.editRecordViewHelper> <typo3-backend-link-editrecord>`.
  *
  * Examples
  * ========
@@ -49,7 +49,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Output::
  *
  *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
- *      Edit record
+ *        Edit record
  *    </a>
  *
  * Link to create a new record of a_table on root page::
@@ -59,7 +59,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Output::
  *
  *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][]=new&returnUrl=foo/bar">
- *      Edit record
+ *        Edit record
  *    </a>
  *
  * Link to create a new record of a_table on page 17::
@@ -69,7 +69,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Output::
  *
  *    <a href="/typo3/index.php?route=/record/edit&edit[a_table][-17]=new&returnUrl=foo/bar">
- *      Edit record
+ *        Edit record
  *    </a>
  *
  * Link to create a new record then return back to the BE module "web_MyextensionList"::
index d19c9ae..f7fc2cd 100644 (file)
@@ -21,7 +21,7 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
  * A ViewHelper for adding a link button to the doc header area.
- * It must be a child of <be:moduleLayout>
+ * It must be a child of :ref:`<be:moduleLayout> <typo3-backend-modulelayout>`.
  *
  * Examples
  * --------
@@ -29,11 +29,11 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * Default::
  *
  *    <be:moduleLayout>
- *      <be:moduleLayout.button.linkButton
- *          icon="actions-add"
- *          title="Add record')}"
- *          link="{be:uri.newRecord(table: 'tx_my_table')}"
- *      />
+ *        <be:moduleLayout.button.linkButton
+ *            icon="actions-add"
+ *            title="Add record')}"
+ *            link="{be:uri.newRecord(table: 'tx_my_table')}"
+ *        />
  *    </be:moduleLayout>
  */
 class LinkButtonViewHelper extends AbstractButtonViewHelper
index 141bdd7..d36cd29 100644 (file)
@@ -24,7 +24,7 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
  * A ViewHelper for adding a shortcut button to the doc header area.
- * It must be a child of <be:moduleLayout>
+ * It must be a child of :ref:`<be:moduleLayout> <typo3-backend-modulelayout>`.
  *
  * Examples
  * --------
@@ -32,7 +32,7 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  * Default::
  *
  *    <be:moduleLayout>
- *      <be:moduleLayout.button.shortcutButton displayName="Shortcut label" />
+ *        <be:moduleLayout.button.shortcutButton displayName="Shortcut label" />
  *    </be:moduleLayout>
  */
 class ShortcutButtonViewHelper extends AbstractButtonViewHelper
index 6cdfc81..2695538 100644 (file)
@@ -26,7 +26,7 @@ use TYPO3Fluid\Fluid\View\Exception;
 
 /**
  * A ViewHelper for adding a menu item to a doc header menu.
- * It must be a child of <be:moduleLayout.menu>
+ * It must be a child of :ref:`<be:moduleLayout.menu> <typo3-backend-modulelayout-menu>`.
  *
  * Examples
  * ========
@@ -34,9 +34,9 @@ use TYPO3Fluid\Fluid\View\Exception;
  * 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.menu identifier="MenuIdentifier">
+ *            <be:moduleLayout.menuItem label="Menu item 1" uri="{f:uri.action(action: 'index')}"/>
+ *        </be:moduleLayout.menu>
  *    </be:moduleLayout>
  */
 class MenuItemViewHelper extends AbstractViewHelper
index 6c3444c..640933d 100644 (file)
@@ -25,9 +25,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\ViewHelperVariableContainer;
 use TYPO3Fluid\Fluid\View\Exception;
 
 /**
- * A ViewHelper 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.
+ * A ViewHelper for adding a menu to the doc header area
+ * of :ref:`<be:moduleLayout> <typo3-backend-modulelayout>`. It accepts only
+ * :ref:`<be:moduleLayout.menuItem> <typo3-backend-modulelayout-menuitem>` view
+ * helpers as children.
  *
  * Examples
  * ========
@@ -35,9 +36,9 @@ use TYPO3Fluid\Fluid\View\Exception;
  * 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.menu identifier="MenuIdentifier">
+ *            <be:moduleLayout.menuItem label="Menu item 1" uri="{f:uri.action(action: 'index')}"/>
+ *        </be:moduleLayout.menu>
  *    </be:moduleLayout>
  */
 class MenuViewHelper extends AbstractViewHelper
index 16bd32c..260ea00 100644 (file)
@@ -35,7 +35,7 @@ use TYPO3Fluid\Fluid\View\Exception;
  * Default::
  *
  *    <be:moduleLayout>
- *     <f:render section="content" />
+ *       <f:render section="content" />
  *    </be:moduleLayout>
  *
  * Output::
index 02ec6b2..1a37958 100644 (file)
@@ -23,7 +23,22 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Create internal link within backend app
+ * Create internal link within backend.
+ *
+ * Examples
+ * ========
+ *
+ * Default::
+ *
+ *     <form action="{be:moduleLink(route:'pages_new', arguments:'{id:pageUid}')}" method="post">
+ *         <!-- form content -->
+ *     </form>
+ *
+ * Output::
+ *
+ *     <form action="/pages/new" method="post">
+ *         <!-- form content -->
+ *     </form>
  */
 class ModuleLinkViewHelper extends AbstractViewHelper
 {
index 531e075..0b13020 100644 (file)
@@ -27,7 +27,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * pass the uid and table to FormEngine.
  *
  * The uid must be given as a positive integer.
- * For new records, use the newRecordViewHelper
+ * For new records, use the :ref:`<be:uri.newRecord> <typo3-backend-uri-newrecord>`.
  *
  * Examples
  * ========
index 29944f3..78d138f 100644 (file)
@@ -28,7 +28,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * The table argument is mandatory, it decides what record is to be created.
  *
- * The pid argument will put the new record on this page, if 0 given it will
+ * The pid argument will put the new record on this page, if ``0`` given it will
  * be placed to the root page.
  *
  * The uid argument accepts only negative values. If this is given, the new
@@ -39,7 +39,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * An exception will be thrown, if both uid and pid are given.
  * An exception will be thrown, if the uid argument is not a negative integer.
  *
- * To edit records, use the editRecordViewHelper
+ * To edit records, use the :ref:`<be:uri.editRecord> <typo3-backend-uri-editrecord>`.
  *
  * Examples
  * ========
index 131f09d..99d2275 100644 (file)
@@ -22,7 +22,22 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Displays icon for record
+ * Displays icon for record.
+ *
+ * Examples
+ * ========
+ *
+ * Default::
+ *
+ *    <core:iconForRecord table="tt_content" row="{record}" />
+ *
+ * Output::
+ *
+ *     <span class="t3js-icon icon icon-size-small icon-state-default icon-mimetypes-x-content-text" data-identifier="mimetypes-x-content-text">
+ *         <span class="icon-markup">
+ *             <img src="/typo3/sysext/core/Resources/Public/Icons/T3Icons/mimetypes/mimetypes-x-content-text.svg" width="16" height="16">
+ *         </span>
+ *     </span>
  */
 class IconForRecordViewHelper extends AbstractViewHelper
 {
index c72b9a4..fdae94e 100644 (file)
@@ -24,7 +24,22 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Displays icon for a FAL resource (file or folder means a TYPO3\CMS\Core\Resource\ResourceInterface)
+ * Displays icon for a FAL resource (file or folder means a :php:`TYPO3\CMS\Core\Resource\ResourceInterface`).
+ *
+ * Examples
+ * ========
+ *
+ * Default::
+ *
+ *    <core:iconForResource resource="{file.resource}" />
+ *
+ * Output::
+ *
+ *     <span class="t3js-icon icon icon-size-small icon-state-default icon-mimetypes-text-html" data-identifier="mimetypes-text-html">
+ *         <span class="icon-markup">
+ *             <img src="/typo3/sysext/core/Resources/Public/Icons/T3Icons/mimetypes/mimetypes-text-html.svg" width="16" height="16">
+ *         </span>
+ *     </span>
  */
 class IconForResourceViewHelper extends AbstractViewHelper
 {
index 6ece8d0..1f45a55 100644 (file)
@@ -23,7 +23,34 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Displays icon identified by icon identifier
+ * Displays icon identified by icon identifier.
+ *
+ * Examples
+ * ========
+ *
+ * Default::
+ *
+ *    <core:icon identifier="actions-menu" />
+ *
+ * Output::
+ *
+ *     <span class="t3js-icon icon icon-size-small icon-state-default icon-actions-menu" data-identifier="actions-menu">
+ *         <span class="icon-markup">
+ *             <img src="/typo3/sysext/core/Resources/Public/Icons/T3Icons/actions/actions-menu.svg" width="16" height="16">
+ *         </span>
+ *     </span>
+ *
+ * Inline::
+ *
+ *    <core:icon identifier="actions-menu" alternativeMarkupIdentifier="inline" />
+ *
+ * Output::
+ *
+ *     <span class="t3js-icon icon icon-size-small icon-state-default icon-actions-menu" data-identifier="actions-menu">
+ *         <span class="icon-markup">
+ *             <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16"><g class="icon-color"><path d="M9 12v2H7v-2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM9 7v2H7V7h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM9 2v2H7V2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM4 7v2H2V7h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM4 2v2H2V2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM4 12v2H2v-2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM14 7v2h-2V7h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM14 2v2h-2V2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5zM14 12v2h-2v-2h2m.5-1h-3c-.3 0-.5.2-.5.5v3c0 .3.2.5.5.5h3c.3 0 .5-.2.5-.5v-3c0-.3-.2-.5-.5-.5z"/></g></svg>
+ *         </span>
+ *     </span>
  */
 class IconViewHelper extends AbstractViewHelper
 {
index c2a0d28..89b4c95 100644 (file)
@@ -19,9 +19,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * ViewHelper which creates a <base href="..."></base> tag. The Base URI is taken from the
- * current request.
- * In TYPO3 Flow, you should always include this ViewHelper to make the links work.
+ * ViewHelper which creates a :html:`<base href="..."></base>` tag.
+ *
+ * The Base URI is taken from the current request.
  *
  * Examples
  * ========
@@ -34,7 +34,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <base href="http://yourdomain.tld/" />
  *
- * (depending on your domain)
+ * Depending on your domain.
  */
 class BaseViewHelper extends AbstractViewHelper
 {
index 3bf2c87..8e82f85 100644 (file)
@@ -19,10 +19,15 @@ use TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
- * ViewHelper which returns CSH (context sensitive help) button with icon
- * Note: The CSH button will only work, if the current BE user has the "Context Sensitive Help mode"
- * set to something else than "Display no help information" in the Users settings
- * Note: This ViewHelper is experimental!
+ * ViewHelper which returns CSH (context sensitive help) button with icon.
+ *
+ * .. note::
+ *    The CSH button will only work, if the current BE user has the "Context
+ *    Sensitive Help mode" set to something else than "Display no help
+ *    information" in the Users settings.
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
@@ -45,7 +50,7 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  *       some text to link
  *    </f:be.buttons.csh>
  *
- * A link with text "some text to link" to link the help
+ * A link with text "some text to link" to link the help.
  */
 class CshViewHelper extends AbstractBackendViewHelper
 {
index 036f557..28cddc0 100644 (file)
@@ -20,8 +20,10 @@ use TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
- * ViewHelper which returns shortcut button with icon
- * Note: This ViewHelper is experimental!
+ * ViewHelper which returns shortcut button with icon.
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
@@ -31,7 +33,7 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  *    <f:be.buttons.shortcut />
  *
  * Shortcut button as known from the TYPO3 backend.
- * By default the current page id, module name and all module arguments will be stored
+ * By default the current page id, module name and all module arguments will be stored.
  *
  * Explicitly set parameters to be stored in the shortcut::
  *
@@ -42,7 +44,7 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
  *
  * .. note:
  *
- *    Normally you won't need to set getVars & setVars parameters in Extbase modules
+ *    Normally you won't need to set getVars & setVars parameters in Extbase modules.
  */
 class ShortcutViewHelper extends AbstractBackendViewHelper
 {
index 18bd6ea..19f5d5f 100644 (file)
@@ -28,15 +28,22 @@ use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
  *    <f:be.container>your module content</f:be.container>
  *
  * "your module content" wrapped with proper head & body tags.
- * Default backend CSS styles and JavaScript will be included
+ * Default backend CSS styles and JavaScript will be included.
  *
  * 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>
+ *    <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 :file:`EXT:your_extension/Resources/Public/Css/styles.css` and
+ * JavaScript files :file:`EXT:your_extension/Resources/Public/JavaScript/Library1.js` and
+ * :file:`EXT:your_extension/Resources/Public/JavaScript/Library2.js`
  * will be loaded, plus some inline labels for usage in JS code.
  */
 class ContainerViewHelper extends AbstractBackendViewHelper
index a7df935..34362aa 100644 (file)
@@ -20,10 +20,15 @@ use TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
- * ViewHelper which returns CSH (context sensitive help) label with icon hover
- * Note: The CSH label will only work, if the current BE user has the "Context Sensitive Help mode"
- * set to something else than "Display no help information" in the Users settings
- * Note: This ViewHelper is experimental!
+ * ViewHelper which returns CSH (context sensitive help) label with icon hover.
+ *
+ * .. note::
+ *    The CSH label will only work, if the current BE user has the "Context
+ *    Sensitive Help mode" set to something else than "Display no help
+ *    information" in the Users settings.
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
index 01ca0e0..3cc72a7 100644 (file)
@@ -18,8 +18,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
 /**
  * ViewHelper which returns an option tag.
- * This ViewHelper only works in conjunction with \TYPO3\CMS\Fluid\ViewHelpers\Be\Menus\ActionMenuViewHelper
- * Note: This ViewHelper is experimental!
+ * This ViewHelper only works in conjunction with :php:`\TYPO3\CMS\Fluid\ViewHelpers\Be\Menus\ActionMenuViewHelper`.
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
@@ -32,7 +34,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *       <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
  *    </f:be.menus.actionMenu>
  *
- * Selectbox with the options "Overview", "Create new Blog" and "List Posts"
+ * Selectbox with the options "Overview", "Create new Blog" and "List Posts".
  *
  * Localized::
  *
@@ -41,7 +43,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *       <f:be.menus.actionMenuItem label="{f:translate(key='create_blog')}" controller="Blog" action="new" />
  *    </f:be.menus.actionMenu>
  *
- * localized selectbox
+ * Localized selectbox.
  */
 class ActionMenuItemViewHelper extends AbstractTagBasedViewHelper
 {
index eddbd5b..7f29d7c 100644 (file)
@@ -21,7 +21,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 /**
  * ViewHelper which returns a select box, that can be used to switch between
  * multiple actions and controllers and looks similar to TYPO3s funcMenu.
- * Note: This ViewHelper is experimental!
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
@@ -34,7 +36,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *       <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
  *    </f:be.menus.actionMenu>
  *
- * Selectbox with the options "Overview", "Create new Blog" and "List Posts"
+ * Selectbox with the options "Overview", "Create new Blog" and "List Posts".
  *
  * Localized::
  *
@@ -43,7 +45,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *       <f:be.menus.actionMenuItem label="{f:translate(key:'create_blog')}" controller="Blog" action="new" />
  *    </f:be.menus.actionMenu>
  *
- * localized selectbox
+ * Localized selectbox.
  */
 class ActionMenuViewHelper extends AbstractTagBasedViewHelper
 {
index 91a58f4..cc535cf 100644 (file)
@@ -22,8 +22,10 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
- * ViewHelper which return page info icon as known from TYPO3 backend modules
- * Note: This ViewHelper is experimental!
+ * ViewHelper which return page info icon as known from TYPO3 backend modules.
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
index d5f385a..4b61844 100644 (file)
@@ -21,8 +21,10 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 
 /**
- * ViewHelper which returns the current page path as known from TYPO3 backend modules
- * Note: This ViewHelper is experimental!
+ * ViewHelper which returns the current page path as known from TYPO3 backend modules.
+ *
+ * .. note::
+ *    This ViewHelper is experimental!
  *
  * Examples
  * ========
index c3c64ab..804d01d 100644 (file)
@@ -29,10 +29,14 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * 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'}" />
+ *    <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``
+ * Custom CSS file :file:`EXT:your_extension/Resources/Public/Css/styles.css` and
+ * JavaScript files :file:`EXT:your_extension/Resources/Public/JavaScript/Library1.js` and
+ * :file:`EXT:your_extension/Resources/Public/JavaScript/Library2.js`
  * will be loaded, plus some inline labels for usage in JS code.
  */
 class PageRendererViewHelper extends AbstractViewHelper
index a2ee66a..c2e7523 100644 (file)
@@ -17,7 +17,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Be\Security;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 
 /**
- * This ViewHelper implements an ifAuthenticated/else condition for BE users/groups.
+ * This ViewHelper implements an ifAuthenticated/else condition for backend
+ * users and backend groups.
  *
  * Examples
  * ========
@@ -28,7 +29,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       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.
+ * Everything inside the :html:`<f:be.ifAuthenticated>` tag is being displayed
+ * if the user is authenticated with any backend user account.
  *
  * IfAuthenticated / then / else::
  *
@@ -41,7 +43,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       </f:else>
  *    </f:be.security.ifAuthenticated>
  *
- * Everything inside the "then" tag is displayed if you have access.
+ * Everything inside the :html:`<f:then></f:then>` is displayed the backend user is logged in.
+ * :html:`<f:else></f:else>` is displayed if no backend user is logged in.
  */
 class IfAuthenticatedViewHelper extends AbstractConditionViewHelper
 {
index 8a9f3c2..6e55b41 100644 (file)
@@ -17,7 +17,11 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Be\Security;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 
 /**
- * This ViewHelper implements an ifHasRole/else condition for BE users/groups.
+ * This ViewHelper implements an ifHasRole/else condition for backend users
+ * and backend groups.
+ *
+ * Role refers to backend user groups. The :html:`role` attribute can either be
+ * the title of a group, or the uid.
  *
  * Examples
  * ========
@@ -28,7 +32,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       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>
  *
- * Everything inside the <f:ifHasRole> tag is being displayed if the logged in BE user belongs to the specified role.
+ * Everything inside the :html:`<f:ifHasRole>` tag is being displayed if the
+ * logged in backend user belongs to the specified backend group.
  *
  * Using the usergroup uid as role identifier::
  *
@@ -36,7 +41,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       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.
+ * Everything inside the :html:`<f:ifHasRole>` tag is being displayed if the
+ * logged in backend user belongs to the specified backend group.
  *
  * IfRole / then / else::
  *
@@ -49,8 +55,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       </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.
+ * Everything inside the :html:`<f:then></f:then>` tag is displayed if the
+ * logged in backend user belongs to the specified backend group.
+ * Otherwise, everything inside the :html:`<f:else></f:else>` tag is displayed.
  */
 class IfHasRoleViewHelper extends AbstractConditionViewHelper
 {
index 9d707bc..24b4fd0 100644 (file)
@@ -19,8 +19,10 @@ use TYPO3\CMS\Core\Type\Bitmask\Permission;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 
 /**
- * ViewHelper which renders a record list as known from the TYPO3 list module
- * Note: This feature is experimental!
+ * ViewHelper which renders a record list as known from the TYPO3 list module.
+ *
+ * .. note::
+ *    This feature is experimental!
  *
  * Examples
  * ========
@@ -30,15 +32,27 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
  *    <f:be.tableList tableName="fe_users" />
  *
  * 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".
+ * Records will be editable, if the current backend user has got edit rights for the table ``fe_users``.
+ *
  * Only the title column (username) will be shown.
+ *
  * Context menu is active.
  *
  * 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" />
+ *    <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.
+ * List of "Website user" records with a text property of ``foo`` stored on PID ``1`` and two levels down.
  * Clicking on a username will open the TYPO3 info popup for the respective record
  */
 class TableListViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Be\AbstractBackendViewHelper
index f165957..4573dfc 100644 (file)
@@ -21,26 +21,26 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
  * Examples
  * ========
  *
- * required arguments::
+ * Minimum call with required arguments only::
  *
  *    <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::
+ * Full example with all configuration options::
  *
  *    <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
+ * The ``recordsLabel`` option can be used to replace the text in "Records 1 - 99" with a custom label.
  *
  * Performance characteristics
  * ===========================
  *
- * In the above examples, it looks like {blogs} contains all Blog objects, thus
+ * In the above examples, it looks like ``{blogs}`` contains all Blog objects, thus
  * you might wonder if all objects were fetched from the database.
  * However, the blogs are NOT fetched from the database until you actually use them,
  * so the paginate ViewHelper will adjust the query sent to the database and receive
index a56e44e..b7e0f62 100644 (file)
@@ -25,28 +25,56 @@ 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!
+ *
+ * .. note::
+ *    You have to ensure proper escaping (htmlspecialchars/intval/etc.) on your own!
  *
  * Examples
  * ========
  *
- * Render lib object::
+ * Render lib object
+ * -----------------
+ *
+ * ::
  *
  *    <f:cObject typoscriptObjectPath="lib.someLibObject" />
  *
- * rendered lib.someLibObject
+ * Rendered :ts:`lib.someLibObject`.
  *
- * Specify cObject data & current value::
+ * 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
+ * Rendered :ts:`lib.customHeader`. Data and current value will be available in TypoScript.
+ *
+ * Inline notation
+ * ---------------
  *
- * inline notation::
+ * ::
  *
  *    {article -> f:cObject(typoscriptObjectPath: 'lib.customHeader')}
  *
- * rendered lib.customHeader. data will be available in TypoScript
+ * Rendered :ts:`lib.customHeader`. Data will be available in TypoScript.
+ *
+ * Accessing the data in TypoScript
+ * --------------------------------
+ *
+ * ::
+ *
+ *    lib.customHeader = COA
+ *    lib.customHeader {
+ *        10 = TEXT
+ *        10.field = author
+ *        20 = TEXT
+ *        20.current = 1
+ *    }
+ *
+ * When passing an object with ``{data}`` the properties of the object are accessable with :ts:`.field` in
+ * TypoScript. If only a single value is passed or the ``currentValueKey`` is specified :ts:`.current = 1`
+ * can be used in the TypoScript.
  */
 class CObjectViewHelper extends AbstractViewHelper
 {
index a95c59f..3ea24f3 100644 (file)
@@ -19,14 +19,13 @@ use TYPO3\CMS\Core\Utility\PathUtility;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 
 /**
- * Debuggable version of f:render - performs the same
- * rendering operation but wraps the output with HTML
- * that can be inspected with the admin panel in FE.
+ * Debuggable version of :ref:`f:render <typo3-fluid-render>` - performs the
+ * same rendering operation but wraps the output with HTML that can be
+ * inspected with the admin panel in frontend.
  *
- * 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.
+ * Replaces ``f:render`` when the admin panel decides (see
+ * :php:`ViewHelperResolver` class). Also possible to use explicitly by using
+ * ``f:debug.render`` instead of the normal ``f:render`` statement.
  */
 class RenderViewHelper extends AbstractViewHelper
 {
index 57ddf45..e6d35ea 100644 (file)
@@ -25,15 +25,28 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * Simple::
+ * Simple
+ * ------
+ *
+ * ::
  *
  *    <f:debug>{testVariables.array}</f:debug>
  *
  * foobarbazfoo
  *
- * All Features::
+ * 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>
+ *    <f:debug title="My Title" maxDepth="5"
+ *        blacklistedClassNames="{0:'Tx_BlogExample_Domain_Model_Administrator'}"
+ *        blacklistedPropertyNames="{0:'posts'}"
+ *        plainText="true" ansiColors="false"
+ *        inline="true"
+ *        >
+ *            {blogs}
+ *        </f:debug>
  *
  * [A HTML view of the var_dump]
  */
index d0f3f40..d4fe210 100644 (file)
@@ -25,17 +25,22 @@ 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
  * ========
  *
- * Simple::
+ * Simple
+ * ------
+ *
+ * ::
  *
  *    <f:flashMessages />
  *
  * A list of flash messages.
  *
- * TYPO3 core style::
+ * TYPO3 core style
+ * ----------------
+ *
+ * ::
  *
  *    <f:flashMessages />
  *
@@ -58,7 +63,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *       </div>
  *    </div>
  *
- * Output flash messages as a description list::
+ * Output flash messages as a description list
+ * -------------------------------------------
+ *
+ * ::
  *
  *    <f:flashMessages as="flashMessages">
  *       <dl class="messages">
@@ -76,7 +84,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *       <dd>Some Warning Message.</dd>
  *   </dl>
  *
- * Using a specific queue::
+ * Using a specific queue
+ * ----------------------
+ *
+ * ::
  *
  *    <f:flashMessages queueIdentifier="myQueue" />
  */
index 15d2ef3..d7f4f32 100644 (file)
@@ -30,7 +30,12 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  * 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>
+ *    <f:form.button type="reset" disabled="disabled"
+ *        name="buttonName" value="buttonValue"
+ *        formmethod="post" formnovalidate="formnovalidate"
+ *    >
+ *        Cancel
+ *    </f:form.button>
  *
  * Output::
  *
index c385dde..445bf8d 100644 (file)
@@ -15,12 +15,15 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * ViewHelper which creates a simple checkbox (<input type="checkbox">).
+ * ViewHelper which creates a simple checkbox :html:`<input type="checkbox">`.
  *
  * Examples
  * ========
  *
- * Example::
+ * Simple one
+ * ----------
+ *
+ * ::
  *
  *    <f:form.checkbox name="myCheckBox" value="someValue" />
  *
@@ -28,7 +31,10 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  *    <input type="checkbox" name="myCheckBox" value="someValue" />
  *
- * Preselect::
+ * Preselect
+ * ---------
+ *
+ * ::
  *
  *    <f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" />
  *
@@ -36,9 +42,12 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  *    <input type="checkbox" name="myCheckBox" value="someValue" checked="checked" />
  *
- * (depending on $object)
+ * Depending on bound ``object`` to surrounding :ref:`f:form <typo3-fluid-form>`.
+ *
+ * Bind to object property
+ * -----------------------
  *
- * Bind to object property::
+ * ::
  *
  *    <f:form.checkbox property="interests" value="TYPO3" />
  *
@@ -46,7 +55,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  *    <input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
  *
- * (depending on property "interests")
+ * Depending on property ``interests``.
  */
 class CheckboxViewHelper extends AbstractFormFieldViewHelper
 {
index 4711ea5..0ee7480 100644 (file)
@@ -15,7 +15,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * Renders an <input type="hidden" ...> tag.
+ * Renders an :html:`<input type="hidden" ...>` tag.
  *
  * Examples
  * ========
@@ -29,7 +29,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *    <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.
+ * See :ref:`<f:form> <typo3-fluid-form>` for more documentation.
  */
 class HiddenViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 0aceda1..ee51182 100644 (file)
@@ -15,7 +15,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * ViewHelper which creates a simple Password Text Box (<input type="password">).
+ * ViewHelper which creates a simple Password Text Box :html:`<input type="password">`.
  *
  * Examples
  * ========
index 5e5db9d..03460b3 100644 (file)
@@ -15,12 +15,15 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * ViewHelper which creates a simple radio button (<input type="radio">).
+ * ViewHelper which creates a simple radio button :html:`<input type="radio">`.
  *
  * Examples
  * ========
  *
- * Example::
+ * Simple
+ * ------
+ *
+ * ::
  *
  *    <f:form.radio name="myRadioButton" value="someValue" />
  *
@@ -28,7 +31,10 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  *    <input type="radio" name="myRadioButton" value="someValue" />
  *
- * Preselect::
+ * Preselect
+ * ---------
+ *
+ * ::
  *
  *    <f:form.radio name="myRadioButton" value="someValue" checked="{object.value} == 5" />
  *
@@ -36,9 +42,12 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  *    <input type="radio" name="myRadioButton" value="someValue" checked="checked" />
  *
- * (depending on $object)
+ * Depending on bound ``object`` to surrounding :ref:`f:form <typo3-fluid-form>`.
+ *
+ * Bind to object property
+ * -----------------------
  *
- * Bind to object property::
+ * ::
  *
  *    <f:form.radio property="newsletter" value="1" /> yes
  *    <f:form.radio property="newsletter" value="0" /> no
@@ -48,7 +57,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *    <input type="radio" name="user[newsletter]" value="1" checked="checked" /> yes
  *    <input type="radio" name="user[newsletter]" value="0" /> no
  *
- * (depending on property "newsletter")
+ * Depending on property ``newsletter``.
  */
 class RadioViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index d4070d1..b2ad057 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 :html:`<optgroup>` tags inside an :ref:`<f:form.select> <typo3-fluid-form-select>`,
+ * supports further child :ref:`<f:form.select.option> <typo3-fluid-form-select-option>` tags.
  */
 class OptgroupViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 11434cc..f2d9851 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 :html:`<option>` tags inside an :ref:`<f:form.select> <typo3-fluid-form-select>`.
  */
 class OptionViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index e2efe0a..37e247d 100644 (file)
@@ -15,35 +15,38 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * This ViewHelper generates a <select> dropdown list for the use with a form.
+ * This ViewHelper generates a :html:`<select>` dropdown list for the use with a form.
  *
  * Basic usage
  * ===========
  *
- * The most straightforward way is to supply an associative array as the "options" parameter.
+ * 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.
  *
  * Basic usage::
  *
  *    <f:form.select name="paymentOptions" options="{payPal: 'PayPal International Services', visa: 'VISA Card'}" />
  *
- * Pre-select a value
+ * Pre select a value
  * ------------------
  *
- * To pre-select a value, set "value" to the option key which should be selected.
+ * To pre select a value, set ``value`` to the option key which should be selected.
  * 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.
+ * If the select box is a multi-select box :html:`multiple="1"`, then "value" can be an array as well.
  *
  * 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:
+ * Child nodes can be used to create a completely custom set of
+ * :html:`<option>` and :html:`<optgroup>` tags in a way compatible with the
+ * HMAC generation.
+ * To do so, leave out the ``options`` argument and use child ViewHelpers:
+ *
  * Custom options and optgroup::
  *
  *    <f:form.select name="myproperty">
@@ -55,30 +58,34 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *       </f:form.select.optgroup>
  *    </f:form.select>
  *
- * Note: do not use vanilla ``<option>`` or ``<optgroup>`` tags! They will invalidate the HMAC generation!
+ * .. note::
+ *    Do not use vanilla :html:`<option>` or :html:`<optgroup>` tags!
+ *    They will invalidate the HMAC generation!
  *
  * 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.
- * If neither is given, the Identifier (UID/uid) and the __toString() method are tried as fallbacks.
+ * 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``.
+ * If neither is given, the Identifier (UID/uid) and the :php:`__toString()` method are tried as fallbacks.
  *
- * If the optionValueField variable is set, the getter named after that value is used to retrieve the option key.
- * If the optionLabelField variable is set, the getter named after that value is used to retrieve the option value.
+ * If the ``optionValueField`` variable is set, the getter named after that value is used to retrieve the option key.
+ * If the ``optionLabelField`` variable is set, the getter named after that value is used to retrieve the option value.
  *
- * 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.
+ * 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.
  *
  * 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.
+ * 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.
+ * So, in the above example, the method :php:`$user->getId()` is called to
+ * retrieve the key, and :php:`$user->getFirstName()` to retrieve the displayed
+ * value of each entry.
  *
- * The "value" property now expects a domain object, and tests for object equivalence.
+ * The ``value`` property now expects a domain object, and tests for object equivalence.
  */
 class SelectViewHelper extends \TYPO3\CMS\Fluid\ViewHelpers\Form\AbstractFormFieldViewHelper
 {
index 1ede0f7..a380b4c 100644 (file)
@@ -20,7 +20,10 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
+ *
+ * ::
  *
  *    <f:form.submit value="Send Mail" />
  *
@@ -28,7 +31,10 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  *
  *    <input type="submit" />
  *
- * Dummy content for template preview::
+ * Dummy content for template preview
+ * ----------------------------------
+ *
+ * ::
  *
  *    <f:submit name="mySubmit" value="Send Mail"><button>dummy button</button></f:submit>
  *
index b19031d..b7ce8d5 100644 (file)
@@ -15,8 +15,9 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * Textarea ViewHelper.
- * The value of the text area needs to be set via the "value" attribute, as with all other form ViewHelpers.
+ * Generates an :html:`<textarea>`.
+ *
+ * The value of the text area needs to be set via the ``value`` attribute, as with all other form ViewHelpers.
  *
  * Examples
  * ========
index 96f9582..0b416d6 100644 (file)
@@ -15,7 +15,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * ViewHelper which creates a text field (<input type="text">).
+ * ViewHelper which creates a text field :html:`<input type="text">`.
  *
  * Examples
  * ========
index 5664562..577c210 100644 (file)
@@ -15,8 +15,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
  */
 
 /**
- * A ViewHelper which generates an <input type="file"> HTML element.
- * Make sure to set enctype="multipart/form-data" on the form!
+ * A ViewHelper which generates an :html:`<input type="file">` HTML element.
+ * Make sure to set ``enctype="multipart/form-data"`` on the form!
  *
  * Examples
  * ========
index 30d159f..937c3ba 100644 (file)
@@ -15,16 +15,15 @@ namespace TYPO3\CMS\Fluid\ViewHelpers;
  */
 
 /**
- * Form ViewHelper. Generates a <form> Tag.
+ * Form ViewHelper. Generates a :html:`<form>` Tag.
  *
  * 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.
- * Example::
- *
- *    <f:form action="...">...</f:form>
+ * Use :html:`<f:form>` to output an HTML :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 :html:`method="get"` as an argument.
  *
  * Examples
  * ========
@@ -46,7 +45,8 @@ namespace TYPO3\CMS\Fluid\ViewHelpers;
  *       <f:form.textbox property="name" />
  *    </f:form>
  *
- * This automatically inserts the value of {customer.name} inside the textbox and adjusts the name of the textbox accordingly.
+ * 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 c7b1a52..6e90c5e 100644 (file)
@@ -21,32 +21,42 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Formats an integer with a byte count into human-readable form.
+ * Formats an integer with a byte count into human readable form.
  *
  * Examples
  * ========
  *
- * Defaults::
+ * Simple
+ * ------
+ *
+ * ::
  *
  *    {fileSize -> f:format.bytes()}
  *
  * ``123 KB``
- * Depending on the value of {fileSize}
+ * Depending on the value of ``{fileSize}``.
+ *
+ * With arguments
+ * --------------
  *
- * Defaults::
+ * ::
  *
  *    {fileSize -> f:format.bytes(decimals: 2, decimalSeparator: '.', thousandsSeparator: ',')}
  *
  * ``1,023.00 B``
- * Depending on the value of {fileSize}
+ * 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``.
+ *
+ * Custom units
+ * ------------
  *
- * You may provide an own set of units, like this: B,KB,MB,GB,TB,PB,EB,ZB,YB
- * custom units::
+ * ::
  *
  *    {fileSize -> f:format.bytes(units: '{f:translate(\'viewhelper.format.bytes.units\', \'fluid\')}'
  *
  * ``123 KB``
- * Depending on the value of {fileSize}
+ * Depending on the value of ``{fileSize}``.
  */
 class BytesViewHelper extends AbstractViewHelper
 {
index 314a1c5..63fc700 100644 (file)
@@ -21,7 +21,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Modifies the case of an input string to upper- or lowercase or capitalization.
- * The default transformation will be uppercase as in ``mb_convert_case`` [1].
+ * The default transformation will be uppercase as in `mb_convert_case`_.
  *
  * Possible modes are:
  *
@@ -40,25 +40,35 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * ``capitalWords``
  *   Not supported yet: Transforms the input string to each containing word being capitalized
  *
- * Note that the behavior will be the same as in the appropriate PHP function ``mb_convert_case`` [1];
+ * Note that the behavior will be the same as in the appropriate PHP function `mb_convert_case`_;
  * especially regarding locale and multibyte behavior.
  *
- * @see http://php.net/manual/function.mb-convert-case.php [1]
+ * .. _mb_convert_case: https://www.php.net/manual/function.mb-convert-case.php
  *
  * Examples
  * ========
  *
- * Example::
+ * Default
+ * -------
+ *
+ * ::
  *
  *    <f:format.case>Some Text with miXed case</f:format.case>
  *
- * SOME TEXT WITH MIXED CASE
+ * Output::
+ *
+ *    SOME TEXT WITH MIXED CASE
  *
- * Example with given mode::
+ * Example with given mode
+ * -----------------------
+ *
+ * ::
  *
  *    <f:format.case mode="capital">someString</f:format.case>
  *
- * SomeString
+ * Output::
+ *
+ *    SomeString
  */
 class CaseViewHelper extends AbstractViewHelper
 {
index 77e5265..50c7d3b 100644 (file)
@@ -27,36 +27,59 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
  *
- *    <f:format.crop maxCharacters="10">This is some very long text</f:format.crop>
+ * ::
  *
- * This is…
+ *    <f:format.crop maxCharacters="10">
+ *        This is some very long text
+ *    </f:format.crop>
  *
- * Custom suffix::
+ * ``This is…``
  *
- *    <f:format.crop maxCharacters="17" append="&nbsp;[more]">This is some very long text</f:format.crop>
+ * Custom suffix
+ * -------------
  *
- * This is some&nbsp;[more]
+ * ::
  *
- * Don't respect word boundaries::
+ *    <f:format.crop maxCharacters="17" append="&nbsp;[more]">
+ *        This is some very long text
+ *    </f:format.crop>
  *
- *    <f:format.crop maxCharacters="10" respectWordBoundaries="false">This is some very long text</f:format.crop>
+ * ``This is some&nbsp;[more]``
  *
- * This is so…
+ * Don't respect word boundaries
+ * -----------------------------
  *
- * 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>
+ *    <f:format.crop maxCharacters="10" respectWordBoundaries="false">
+ *        This is some very long text
+ *    </f:format.crop>
  *
- * This is some text with <stro
+ * ``This is so…``
  *
- * Inline notation::
+ * 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``
+ *
+ * Inline notation
+ * ---------------
+ *
+ * ::
  *
  *    {someLongText -> f:format.crop(maxCharacters: 10)}
  *
- * someLongText cropped after 10 characters…
- * (depending on the value of {someLongText})
+ * ``someLongText cropped after 10 characters…``
+ * Depending on the value of ``{someLongText}``.
  */
 class CropViewHelper extends AbstractViewHelper
 {
index 7bb7543..f3df792 100644 (file)
@@ -24,30 +24,55 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
+ *
+ * ::
  *
  *    <f:format.currency>123.456</f:format.currency>
  *
- * ``123,46``
+ * Output::
+ *
+ *     123,46
+ *
+ * All parameters
+ * --------------
+ *
+ * ::
+ *
+ *    <f:format.currency decimalSeparator="." thousandsSeparator="," decimals="2"
+ *        currencySign="$" prependCurrency="true" separateCurrency="false"
+ *    >
+ *        54321
+ *    </f:format.currency>
  *
- * All parameters::
+ * Output::
  *
- *    <f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator="," prependCurrency="true" separateCurrency="false" decimals="2">54321</f:format.currency>
+ *     $54,321.00
  *
- * ``$54,321.00``
+ * Inline notation
+ * ---------------
  *
- * Inline notation::
+ * ::
  *
- *    {someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: '')}
+ *    {someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: 'EUR')}
  *
- * ``54,321,00 €``
- * (depending on the value of {someNumber})
+ * Output::
  *
- * use dash for decimals without value::
+ *    54,321,00 EUR
+ *
+ * Depending on the value of ``{someNumber}``.
+ *
+ * Use dash for decimals without value
+ * -----------------------------------
+ *
+ * ::
  *
  *    <f:format.currency useDash="true">123.00</f:format.currency>
  *
- * ``123,-``
+ * Output::
+ *
+ *     123,-
  */
 class CurrencyViewHelper extends AbstractViewHelper
 {
index a5913ab..3664128 100644 (file)
@@ -23,59 +23,80 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Formats an object implementing \DateTimeInterface.
+ * Formats an object implementing :php:`\DateTimeInterface`.
  *
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
+ *
+ * ::
  *
  *    <f:format.date>{dateObject}</f:format.date>
  *
  * ``1980-12-13``
- * (depending on the current date)
+ * Depending on the current date.
+ *
+ * Custom date format
+ * ------------------
  *
- * Custom date format::
+ * ::
  *
  *    <f:format.date format="H:i">{dateObject}</f:format.date>
  *
  * ``01:23``
- * (depending on the current time)
+ * Depending on the current time.
  *
- * Relative date with given time::
+ * Relative date with given time
+ * -----------------------------
+ *
+ * ::
  *
  *    <f:format.date format="Y" base="{dateObject}">-1 year</f:format.date>
  *
  * ``2016``
- * (assuming dateObject is in 2017)
+ * Assuming dateObject is in 2017.
+ *
+ * strtotime string
+ * ----------------
  *
- * 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)
+ * Depending on the current time, see https://www.php.net/manual/function.strtotime.php.
  *
- * Localized dates using strftime date format::
+ * 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)
+ * Depending on the current date and defined locale. In the example you see the 1980-12-13 in a german locale.
+ *
+ * Inline notation
+ * ---------------
  *
- * Inline notation::
+ * ::
  *
  *    {f:format.date(date: dateObject)}
  *
  * ``1980-12-13``
- * (depending on the value of {dateObject})
+ * Depending on the value of ``{dateObject}``.
+ *
+ * Inline notation (2nd variant)
+ * -----------------------------
  *
- * Inline notation (2nd variant)::
+ * ::
  *
  *    {dateObject -> f:format.date()}
  *
  * ``1980-12-13``
- * (depending on the value of {dateObject})
+ * Depending on the value of ``{dateObject}``.
  */
 class DateViewHelper extends AbstractViewHelper
 {
index 48b3d4c..ef84dfd 100644 (file)
@@ -23,14 +23,17 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * Renders a string by passing it to a TYPO3 parseFunc.
- * 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.
+ * Renders a string by passing it to a TYPO3 `parseFunc`_.
+ * You can either specify a path to the TypoScript setting or set the `parseFunc`_ options directly.
+ * By default :ts:`lib.parseFunc_RTE` is used to parse the string.
  *
  * Examples
  * ========
  *
- * Default parameters::
+ * Default parameters
+ * ------------------
+ *
+ * ::
  *
  *    <f:format.html>foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
  *
@@ -38,9 +41,12 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <p class="bodytext">foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.</p>
  *
- * (depending on your TYPO3 setup)
+ * Depending on TYPO3 setup.
+ *
+ * Custom parseFunc
+ * ----------------
  *
- * Custom parseFunc::
+ * ::
  *
  *    <f:format.html parseFuncTSPath="lib.parseFunc">foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
  *
@@ -48,7 +54,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
  *
- * Inline notation::
+ * Inline notation
+ * ---------------
+ *
+ * ::
  *
  *    {someText -> f:format.html(parseFuncTSPath: 'lib.parseFunc')}
  *
@@ -56,7 +65,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
  *
- * @see https://docs.typo3.org/typo3cms/TyposcriptReference/Functions/Parsefunc/
+ * .. _parseFunc: https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Functions/Parsefunc.html
  */
 class HtmlViewHelper extends AbstractViewHelper
 {
index 626cf71..7816cc2 100644 (file)
@@ -18,23 +18,29 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Applies html_entity_decode() to a value
- * @see http://www.php.net/html_entity_decode
+ * Applies :php:`html_entity_decode()` to a value.
+ * See https://www.php.net/html_entity_decode.
  *
  * Examples
  * ========
  *
- * default notation::
+ * Default notation
+ * ----------------
+ *
+ * ::
  *
  *    <f:format.htmlentitiesDecode>{text}</f:format.htmlentitiesDecode>
  *
- * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities (html_entity_decode applied).
+ * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities :php:`html_entity_decode` applied.
+ *
+ * Inline notation
+ * ---------------
  *
- * inline notation::
+ * ::
  *
  *    {text -> f:format.htmlentitiesDecode(encoding: 'ISO-8859-1')}
  *
- * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities (html_entity_decode applied).
+ * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities :php:`html_entity_decode` applied.
  */
 class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
 {
@@ -68,7 +74,7 @@ class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
     /**
      * Converts all HTML entities to their applicable characters as needed using PHPs html_entity_decode() function.
      *
-     * @see http://www.php.net/html_entity_decode
+     * @see https://www.php.net/html_entity_decode
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
index 6d52b58..3e520cf 100644 (file)
@@ -18,23 +18,29 @@ use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Applies htmlentities() escaping to a value
- * @see http://www.php.net/manual/function.htmlentities.php
+ * Applies :php:`htmlentities()` escaping to a value.
+ * See https://www.php.net/manual/function.htmlentities.php.
  *
  * Examples
  * ========
  *
- * default notation::
+ * Default notation
+ * ----------------
+ *
+ * ::
  *
  *    <f:format.htmlentities>{text}</f:format.htmlentities>
  *
- * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities (htmlentities applied).
+ * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities :php:`htmlentities` applied.
+ *
+ * Inline notation
+ * ---------------
  *
- * inline notation::
+ * ::
  *
  *    {text -> f:format.htmlentities(encoding: 'ISO-8859-1')}
  *
- * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities (htmlentities applied).
+ * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities :php:`htmlentities` applied.
  */
 class HtmlentitiesViewHelper extends AbstractEncodingViewHelper
 {
@@ -68,7 +74,7 @@ class HtmlentitiesViewHelper extends AbstractEncodingViewHelper
     /**
      * Escapes special characters with their escaped counterparts as needed using PHPs htmlentities() function.
      *
-     * @see http://www.php.net/manual/function.htmlentities.php
+     * @see https://www.php.net/manual/function.htmlentities.php
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
index 9435586..1f6ca24 100644 (file)
@@ -21,25 +21,35 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Wrapper for PHPs json_encode function.
+ * Wrapper for PHPs :php:`json_encode` function.
+ * See https://www.php.net/manual/function.json-encode.php.
  *
  * Examples
  * ========
  *
- * encoding a view variable::
+ * Encoding a view variable
+ * ------------------------
+ *
+ * ::
  *
  *    {someArray -> f:format.json()}
  *
  * ``["array","values"]``
- * // depending on the value of {someArray}
+ * Depending on the value of ``{someArray}``.
+ *
+ * Associative array
+ * -----------------
  *
- * associative array::
+ * ::
  *
  *    {f:format.json(value: {foo: 'bar', bar: 'baz'})}
  *
  * ``{"foo":"bar","bar":"baz"}``
  *
- * non-associative array with forced object::
+ * Non associative array with forced object
+ * ----------------------------------------
+ *
+ * ::
  *
  *    {f:format.json(value: {0: 'bar', 1: 'baz'}, forceObject: true)}
  *
@@ -75,7 +85,7 @@ class JsonViewHelper extends AbstractViewHelper
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
-     * @see http://www.php.net/manual/en/function.json-encode.php
+     * @see https://www.php.net/manual/function.json-encode.php
      * @return string
      */
     public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
index f83c24e..5efb7cb 100644 (file)
@@ -19,23 +19,29 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Wrapper for PHPs nl2br function.
- * @see http://www.php.net/manual/en/function.nl2br.php
+ * Wrapper for PHPs :php:`nl2br` function.
+ * See https://www.php.net/manual/function.nl2br.php.
  *
  * Examples
  * ========
  *
- * Example::
+ * Default
+ * -------
+ *
+ * ::
  *
  *    <f:format.nl2br>{text_with_linebreaks}</f:format.nl2br>
  *
- * text with line breaks replaced by ``<br />``
+ * Text with line breaks replaced by ``<br />``
+ *
+ * Inline notation
+ * ---------------
  *
- * Inline notation::
+ * ::
  *
  *    {text_with_linebreaks -> f:format.nl2br()}
  *
- * text with line breaks replaced by ``<br />``
+ * Text with line breaks replaced by ``<br />``
  */
 class Nl2brViewHelper extends AbstractViewHelper
 {
index 76eee53..38dcb74 100644 (file)
@@ -20,21 +20,28 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Formats a number with custom precision, decimal point and grouped thousands.
- *
- * @see http://www.php.net/manual/en/function.number-format.php
+ * See https://www.php.net/manual/function.number-format.php.
  *
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
+ *
+ * ::
  *
  *    <f:format.number>423423.234</f:format.number>
  *
  * ``423,423.20``
  *
- * With all parameters::
+ * With all parameters
+ * -------------------
+ *
+ * ::
  *
- *    <f:format.number decimals="1" decimalSeparator="," thousandsSeparator=".">423423.234</f:format.number>
+ *    <f:format.number decimals="1" decimalSeparator="," thousandsSeparator=".">
+ *        423423.234
+ *    </f:format.number>
  *
  * ``423.423,2``
  */
index 9813a85..1e542eb 100644 (file)
@@ -19,25 +19,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Formats a string using PHPs str_pad function.
- * @see http://www.php.net/manual/en/function.str_pad.php
+ * Formats a string using PHPs :php:`str_pad` function.
+ * See https://www.php.net/manual/function.str_pad.php.
  *
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
+ *
+ * ::
  *
  *    <f:format.padding padLength="10">TYPO3</f:format.padding>
  *
- * ``TYPO3     `` (note the trailing whitespace)
+ * Output::
+ *
+ *     TYPO3␠␠␠␠␠
+ *
+ * ``TYPO3␠␠␠␠␠``
  *
- * Specify padding string::
+ * Specify padding string
+ * ----------------------
+ *
+ * ::
  *
  *    <f:format.padding padLength="10" padString="-=">TYPO3</f:format.padding>
  *
  * ``TYPO3-=-=-``
  *
- * Specify padding type::
+ * Specify padding type
+ * --------------------
+ *
+ * ::
  *
  *    <f:format.padding padLength="10" padString="-" padType="both">TYPO3</f:format.padding>
  *
index 3a54467..c6f4101 100644 (file)
@@ -19,38 +19,54 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Removes tags from the given string (applying PHPs strip_tags() function)
- *
- * @see http://www.php.net/manual/function.strip-tags.php
+ * Removes tags from the given string (applying PHPs :php:`strip_tags()` function)
+ * See https://www.php.net/manual/function.strip-tags.php.
  *
  * Examples
  * ========
  *
- * default notation::
+ * Default notation
+ * ----------------
+ *
+ * ::
  *
  *    <f:format.stripTags>Some Text with <b>Tags</b> and an &Uuml;mlaut.</f:format.stripTags>
  *
- * Some Text with Tags and an &Uuml;mlaut. (strip_tags() applied. Note: encoded entities are not decoded)
+ * Some Text with Tags and an &Uuml;mlaut. :php:`strip_tags()` applied.
+ *
+ * .. note::
+ *    Encoded entities are not decoded.
  *
- * default notation with allowedTags::
+ * 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>
+ * ::
+ *
+ *    <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::
+ * Inline notation
+ * ---------------
+ *
+ * ::
  *
  *    {text -> f:format.stripTags()}
  *
- * Text without tags (strip_tags() applied)
+ * Text without tags :php:`strip_tags()` applied.
+ *
+ * Inline notation with allowedTags
+ * --------------------------------
  *
- * 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
+ * Text with p, span, div and script Tags inside, all other tags are removed.
  */
 class StripTagsViewHelper extends AbstractViewHelper
 {
@@ -88,7 +104,7 @@ unction');
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param \TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface $renderingContext
-     * @see http://www.php.net/manual/function.strip-tags.php
+     * @see https://www.php.net/manual/function.strip-tags.php
      * @return string
      */
     public static function renderStatic(
index 1489ecd..11c50cc 100644 (file)
@@ -20,24 +20,33 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderStatic;
 
 /**
- * Encodes the given string according to http://www.faqs.org/rfcs/rfc3986.html (applying PHPs rawurlencode() function)
- * @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.
+ * Encodes the given string according to http://www.faqs.org/rfcs/rfc3986.html
+ * Applying PHPs :php:`rawurlencode()` function.
+ * See https://www.php.net/manual/function.rawurlencode.php.
+ *
+ * .. note::
+ *    The output is not escaped. You may have to ensure proper escaping on your own.
  *
  * Examples
  * ========
  *
- * default notation::
+ * Default notation
+ * ----------------
+ *
+ * ::
  *
  *    <f:format.rawurlencode>foo @+%/</f:format.rawurlencode>
  *
- * ``foo%20%40%2B%25%2F`` (rawurlencode() applied)
+ * ``foo%20%40%2B%25%2F`` :php:`rawurlencode()` applied.
+ *
+ * Inline notation
+ * ---------------
  *
- * inline notation::
+ * ::
  *
  *    {text -> f:format.urlencode()}
  *
- * Url encoded text (rawurlencode() applied)
+ * Url encoded text :php:`rawurlencode()` applied.
  */
 class UrlencodeViewHelper extends AbstractViewHelper
 {
@@ -63,7 +72,7 @@ class UrlencodeViewHelper extends AbstractViewHelper
     /**
      * Escapes special characters with their escaped counterparts as needed using PHPs rawurlencode() function.
      *
-     * @see http://www.php.net/manual/function.rawurlencode.php
+     * @see https://www.php.net/manual/function.rawurlencode.php
      * @param array $arguments
      * @param \Closure $renderChildrenClosure
      * @param RenderingContextInterface $renderingContext
index 0a59a20..6661fac 100644 (file)
@@ -20,24 +20,30 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
 
 /**
- * Resizes a given image (if required) and renders the respective img tag
+ * Resizes a given image (if required) and renders the respective img tag.
  *
  * Examples
  * ========
  *
- * Default::
+ * Default
+ * -------
+ *
+ * ::
  *
  *    <f:image src="EXT:myext/Resources/Public/typo3_logo.png" alt="alt text" />
  *
- * Output::
+ * Output in frontend::
  *
  *    <img alt="alt text" src="typo3conf/ext/myext/Resources/Public/typo3_logo.png" width="396" height="375" />
  *
- * or (in BE mode)::
+ * or in backend::
  *
  *    <img alt="alt text" src="../typo3conf/ext/viewhelpertest/Resources/Public/typo3_logo.png" width="396" height="375" />
  *
- * Image Object::
+ * Image Object
+ * ------------
+ *
+ * ::
  *
  *    <f:image image="{imageObject}" />
  *
@@ -45,7 +51,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
  *
  *    <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
  *
- * Inline notation::
+ * Inline notation
+ * ---------------
+ *
+ * ::
  *
  *    {f:image(src: 'EXT:viewhelpertest/Resources/Public/typo3_logo.png', alt: 'alt text', minWidth: 30, maxWidth: 40)}
  *
@@ -53,20 +62,26 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Exception;
  *
  *    <img alt="alt text" src="../typo3temp/assets/images/f13d79a526.png" width="40" height="38" />
  *
- * (depending on your TYPO3s encryption key)
+ * Depending on your TYPO3s encryption key.
+ *
+ * Other resource type (e.g. PDF)
+ * ------------------------------
  *
- * 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.
+ * 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">``
  *
- * Non-existent image::
+ * Non-existent image
+ * ------------------
+ *
+ * ::
  *
  *    <f:image src="NonExistingImage.png" alt="foo" />
  *
- * Could not get image resource for "NonExistingImage.png".
+ * ``Could not get image resource for "NonExistingImage.png".``
  */
 class ImageViewHelper extends AbstractTagBasedViewHelper
 {
index 912aacc..11cfea3 100644 (file)
@@ -30,7 +30,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  *    <a href="index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz">action link</a>
  *
- * (depending on the current page and your TS configuration)
+ * Depending on the current page and your TypoScript configuration.
  */
 class ActionViewHelper extends AbstractTagBasedViewHelper
 {
index a1df586..ee6c8f4 100644 (file)
@@ -18,12 +18,17 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
 /**
  * Email link ViewHelper.
- * Generates an email link incorporating TYPO3s spamProtectEmailAddresses-settings.
+ * Generates an email link incorporating TYPO3s `spamProtectEmailAddresses`_ TypoScript setting.
+ *
+ * .. _spamProtectEmailAddresses: https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Setup/Config/Index.html#spamprotectemailaddresses
  *
  * Examples
  * ========
  *
- * basic email link::
+ * Basic email link
+ * ----------------
+ *
+ * ::
  *
  *    <f:link.email email="foo@bar.tld" />
  *
@@ -31,15 +36,20 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  *    <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">foo(at)bar.tld</a>
  *
- * (depending on your spamProtectEmailAddresses-settings)
+ * Depending on `spamProtectEmailAddresses`_ setting.
  *
- * Email link with custom linktext::
+ * 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>
+ *
+ * Depending on `spamProtectEmailAddresses`_ setting.
  */
 class EmailViewHelper extends AbstractTagBasedViewHelper
 {
index e3ba90a..6a565c2 100644 (file)
@@ -22,7 +22,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Examples
  * ========
  *
- * Default::
+ * Default
+ * -------
+ *
+ * ::
  *
  *    <f:link.external uri="http://www.typo3.org" target="_blank">external link</f:link.external>
  *
@@ -30,7 +33,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  *    <a href="http://www.typo3.org" target="_blank">external link</a>
  *
- * custom default scheme::
+ * Custom default scheme
+ * ---------------------
+ *
+ * ::
  *
  *    <f:link.external uri="typo3.org" defaultScheme="ftp">external ftp link</f:link.external>
  *
index 458d005..6aead9f 100644 (file)
@@ -22,35 +22,44 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  * Examples
  * ========
  *
- * link to the current page::
+ * Link to the current page
+ * ------------------------
+ *
+ * ::
  *
  *    <f:link.page>page link</f:link.page>
  *
  * Output::
  *
- *    <a href="index.php?id=123">page link</a>
+ *    <a href="/page/path/name.html">page link</a>
+ *
+ * Depending on current page, routing and page path configuration.
  *
- * (depending on the current page and your TS configuration)
+ * Query parameters
+ * ----------------
  *
- * 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</a>
+ *    <a href="/page/path/name.html?foo=bar">page link</a>
+ *
+ * Depending on current page, routing and page path configuration.
  *
- * (depending on your TS configuration)
+ * Query parameters for extensions
+ * -------------------------------
  *
- * 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</a>
+ *    <a href="/page/path/name.html?extension_key[foo]=bar">page link</a>
  *
- * (depending on your TS configuration)
+ * Depending on current page, routing and page path configuration.
  */
 class PageViewHelper extends AbstractTagBasedViewHelper
 {
index 79a8907..113bc39 100644 (file)
@@ -28,9 +28,12 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Example
  * =======
  *
- * {link} contains "19 _blank - "testtitle with whitespace" &X=y"
+ * ``{link}`` contains: ``19 _blank - "testtitle with whitespace" &X=y``.
  *
- * minimal usage::
+ * Minimal usage
+ * -------------
+ *
+ * ::
  *
  *    <f:link.typolink parameter="{link}">
  *       Linktext
@@ -38,21 +41,33 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  * Output::
  *
- *    <a href="index.php?id=19&X=y" title="testtitle with whitespace" target="_blank">
+ *    <a href="/page/path/name.html?X=y" title="testtitle with whitespace" target="_blank">
  *       Linktext
  *    </a>
  *
- * Full parameter usage::
+ * Depending on current page, routing and page path configuration.
+ *
+ * Full parameter usage
+ * --------------------
  *
- *    <f:link.typolink parameter="{link}" target="_blank" class="ico-class" title="some title" additionalParams="&u=b" additionalAttributes="{type:'button'}" useCacheHash="true">
+ * ::
+ *
+ *    <f:link.typolink parameter="{link}" additionalParams="&u=b"
+ *        target="_blank"
+ *        class="ico-class" title="some title"
+ *        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 href="/page/path/name.html?X=y&u=b" title="some title" target="_blank" class="ico-class" type="button">
+ *        Linktext
  *    </a>
+ *
+ * Depending on routing and page path configuration.
  */
 class TypolinkViewHelper extends AbstractViewHelper
 {
index ca06fe7..e826a6d 100644 (file)
@@ -26,13 +26,16 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 /**
  * Render a given media file with the correct html tag.
  *
- * 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.
+ * It asks the :php:`RendererRegistry` for the correct Renderer class and if not found it falls
+ * back to the :php:`ImageViewHelper` as that is the "Renderer" class for images in Fluid context.
  *
  * Examples
  * ========
  *
- * Image Object::
+ * Image Object
+ * ------------
+ *
+ * ::
  *
  *    <f:media file="{file}" width="400" height="375" />
  *
@@ -40,7 +43,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  *    <img alt="alt set in image record" src="fileadmin/_processed_/323223424.png" width="396" height="375" />
  *
- * MP4 Video Object::
+ * MP4 Video Object
+ * ----------------
+ *
+ * ::
  *
  *    <f:media file="{file}" width="400" height="375" />
  *
@@ -48,7 +54,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  *    <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::
+ * MP4 Video Object with loop and autoplay option set
+ * --------------------------------------------------
+ *
+ * ::
  *
  *    <f:media file="{file}" width="400" height="375" additionalConfig="{loop: '1', autoplay: '1'}" />
  *
index 93b7dea..37a6ca6 100644 (file)
@@ -19,20 +19,27 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 
 /**
- * This ViewHelper implements an ifAuthenticated/else condition for FE users/groups.
+ * This ViewHelper implements an ifAuthenticated/else condition for frontend users.
  *
  * Examples
  * ========
  *
- * Basic usage::
+ * 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.
+ * Everything inside the :html:`<f:security.ifAuthenticated>` tag is being displayed if
+ * current frontend user is authenticated.
+ *
+ * IfAuthenticated / then / else
+ * -----------------------------
  *
- * IfAuthenticated / then / else::
+ * ::
  *
  *    <f:security.ifAuthenticated>
  *       <f:then>
@@ -43,8 +50,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       </f:else>
  *    </f:security.ifAuthenticated>
  *
- * Everything inside the "then" tag is displayed if you have access.
- * Otherwise, everything inside the "else"-tag is displayed.
+ * Everything inside the :html:`<f:then></f:then>` tag is displayed if frontend user is authenticated.
+ * Otherwise, everything inside the :html:`<f:else></f:else>` tag is displayed.
  */
 class IfAuthenticatedViewHelper extends AbstractConditionViewHelper
 {
index c12dc18..4f7f2a0 100644 (file)
@@ -20,28 +20,41 @@ use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
 
 /**
- * This ViewHelper implements an ifHasRole/else condition for FE users/groups.
+ * This ViewHelper implements an ifHasRole/else condition for frontend groups.
  *
  * Examples
  * ========
  *
- * Basic usage::
+ * 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)
+ *        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.
+ * Everything inside the :html:`<f:security.ifHasRole>` tag is being displayed if the
+ * logged in frontend user belongs to the specified frontend user group.
+ * Comparison is done by comparing to title of the user groups.
+ *
+ * Using the usergroup uid as role identifier
+ * ------------------------------------------
  *
- * 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.
+ * Everything inside the :html:`<f:security.ifHasRole>` tag is being displayed if the
+ * logged in frontend user belongs to the specified role. Comparison is done
+ * using the ``uid`` of frontend user groups.
+ *
+ * IfRole / then / else
+ * --------------------
  *
- * IfRole / then / else::
+ * ::
  *
  *    <f:security.ifHasRole role="Administrator">
  *       <f:then>
@@ -52,8 +65,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractConditionViewHelper;
  *       </f:else>
  *    </f:security.ifHasRole>
  *
- * 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.
+ * Everything inside the :html:`<f:then></f:then>` tag is displayed if the logged in FE user belongs to the specified role.
+ * Otherwise, everything inside the :html:`<f:else></f:else>` tag is displayed.
  */
 class IfHasRoleViewHelper extends AbstractConditionViewHelper
 {
index 0845cd2..a29a917 100644 (file)
@@ -22,49 +22,63 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Translate a key from locallang. The files are loaded from the folder
- * "Resources/Private/Language/".
+ * :file:`Resources/Private/Language/`.
  *
  * Examples
  * ========
  *
- * Translate key::
+ * Translate key
+ * -------------
+ *
+ * ::
  *
  *    <f:translate key="key1" />
  *
- * value of key "key1" in the current website language
+ * Value of key "key1" in the current website language. Alternatively id can be used instead of
+ * key:
+ *
+ *    <f:translate id="key1" />
+ *
+ * This will output the same as above. If both id and key are set, id will take precedence.
+ *
+ * Keep HTML tags
+ * --------------
  *
- * 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
+ * Value of key "htmlKey" in the current website language, no :php:`htmlspecialchars` applied.
  *
- * Translate key from custom locallang file::
+ * 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
+ *    <f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" />
  *
- * Inline notation with arguments and default value::
+ * Value of key "key1" in the current website language.
  *
- *    {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
+ * Inline notation with arguments and 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"
+ * ::
  *
- * Inline notation with extension name::
+ *    {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
  *
- *    {f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
+ * Value of key "argumentsKey" in the current website language
+ * with "%1" and "%2" are replaced by "dog" and "fox" (:php:`printf`).
+ * If the key is not found, the output is "default value".
  *
- * value of key "someKey" in the current website language
- * the locallang file of extension "some_extension_name" will be used
+ * Inline notation with extension name
+ * -----------------------------------
  *
- * Translate id as in TYPO3 Flow::
+ * ::
  *
- *    <f:translate id="key1" />
+ *    {f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
  *
- * value of id "key1" in the current website language
+ * Value of key "someKey" in the current website language.
+ * The locallang file of extension "some_extension_name" will be used.
  */
 class TranslateViewHelper extends AbstractViewHelper
 {
@@ -85,7 +99,7 @@ class TranslateViewHelper extends AbstractViewHelper
     public function initializeArguments()
     {
         $this->registerArgument('key', 'string', 'Translation Key');
-        $this->registerArgument('id', 'string', 'Translation Key compatible to TYPO3 Flow');
+        $this->registerArgument('id', 'string', 'Translation ID. Same as key.');
         $this->registerArgument('default', 'string', 'If the given locallang key could not be found, this value is used. If this argument is not set, child nodes will be used to render the default');
         $this->registerArgument('arguments', 'array', 'Arguments to be replaced in the resulting string');
         $this->registerArgument('extensionName', 'string', 'UpperCamelCased extension key (for example BlogExample)');
@@ -110,7 +124,7 @@ class TranslateViewHelper extends AbstractViewHelper
         $extensionName = $arguments['extensionName'];
         $translateArguments = $arguments['arguments'];
 
-        // Wrapper including a compatibility layer for TYPO3 Flow Translation
+        // Use key if id is empty.
         if ($id === null) {
             $id = $key;
         }
@@ -138,7 +152,7 @@ class TranslateViewHelper extends AbstractViewHelper
     /**
      * Wrapper call to static LocalizationUtility
      *
-     * @param string $id Translation Key compatible to TYPO3 Flow
+     * @param string $id Translation Key
      * @param string $extensionName UpperCamelCased extension key (for example BlogExample)
      * @param array $arguments Arguments to be replaced in the resulting string
      * @param string $languageKey Language key to use for this translation
index 8f0ad70..8708c00 100644 (file)
@@ -28,8 +28,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <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)
+ * ``/page/path/name.html?tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz``
+ *
+ * Depending on current page, routing and page path configuration.
  */
 class ActionViewHelper extends AbstractViewHelper
 {
index be4f3af..e3050cd 100644 (file)
@@ -20,7 +20,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
  * Email URI ViewHelper.
- * Generates an email URI incorporating TYPO3s spamProtectEmailAddresses-settings.
+ * Generates an email URI incorporating TYPO3s `spamProtectEmailAddresses`_ TypoScript setting.
+ *
+ * .. _spamProtectEmailAddresses: https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Setup/Config/Index.html#spamprotectemailaddresses
  *
  * Example
  * =======
@@ -33,7 +35,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');
  *
- * (depending on your spamProtectEmailAddresses-settings)
+ * Depending on `spamProtectEmailAddresses`_ setting.
  */
 class EmailViewHelper extends AbstractViewHelper
 {
index dddc5bd..ca763c5 100644 (file)
@@ -25,13 +25,19 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * Default::
+ * Default
+ * -------
+ *
+ * ::
  *
  *    <f:uri.external uri="http://www.typo3.org" />
  *
  * ``http://www.typo3.org``
  *
- * custom default scheme::
+ * Custom default scheme
+ * ---------------------
+ *
+ * ::
  *
  *    <f:uri.external uri="typo3.org" defaultScheme="ftp" />
  *
index 389b24b..9300f0b 100644 (file)
@@ -30,34 +30,55 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * Default::
+ * Default
+ * -------
+ *
+ * ::
  *
  *    <f:uri.image src="EXT:myext/Resources/Public/typo3_logo.png" />
  *
+ * Results in the following output within TYPO3 frontend:
+ *
  * ``typo3conf/ext/myext/Resources/Public/typo3_logo.png``
- * or (in BE mode):
+ *
+ * and the following output inside TYPO3 backend:
+ *
  * ``../typo3conf/ext/myext/Resources/Public/typo3_logo.png``
  *
- * Image Object::
+ * Image Object
+ * ------------
+ *
+ * ::
  *
  *    <f:uri.image image="{imageObject}" />
  *
+ * Results in the following output within TYPO3 frontend:
+ *
  * ``fileadmin/images/image.png``
- * or (in BE mode):
+ *
+ * and the following output inside TYPO3 backend:
+ *
  * ``fileadmin/images/image.png``
  *
- * Inline notation::
+ * 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)
  *
- * non existing image::
+ * Depending on your TYPO3s encryption key.
+ *
+ * Non existing image
+ * ------------------
+ *
+ * ::
  *
  *    <f:uri.image src="NonExistingImage.png" />
  *
- * Could not get image resource for "NonExistingImage.png".
+ * ``Could not get image resource for "NonExistingImage.png".``
  */
 class ImageViewHelper extends AbstractViewHelper
 {
index 99e166a..75194c7 100644 (file)
@@ -24,26 +24,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * URI to the current page::
+ * 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)
+ * ``/page/path/name.html``
+ *
+ * Depending on current page, routing and page path configuration.
+ *
+ * Query parameters
+ * ----------------
  *
- * query parameters::
+ * ::
  *
  *    <f:uri.page pageUid="1" additionalParams="{foo: 'bar'}" />
  *
- * ``index.php?id=1&foo=bar``
- * (depending on your TS configuration)
+ * ``/page/path/name.html?foo=bar``
  *
- * query parameters for extensions::
+ * Depending on current page, routing and page path configuration.
+ *
+ * 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)
+ * ``/page/path/name.html?extension_key[foo]=bar``
+ *
+ * Depending on current page, routing and page path configuration.
  */
 class PageViewHelper extends AbstractViewHelper
 {
index 84dbc61..980deca 100644 (file)
@@ -26,15 +26,29 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  * Examples
  * ========
  *
- * Defaults::
+ * Defaults
+ * --------
+ *
+ * ::
  *
  *    <link href="{f:uri.resource(path:'css/stylesheet.css')}" rel="stylesheet" />
  *
  * Output::
  *
- *    <link href="Resources/Packages/MyPackage/stylesheet.css" rel="stylesheet" />
+ *    <link href="typo3conf/ext/example_extension/Resources/Resources/Public/css/stylesheet.css" rel="stylesheet" />
+ *
+ * Depending on current extension.
+ *
+ * With extension name
+ * -------------------
+ *
+ * ::
+ *
+ *    <link href="{f:uri.resource(path:'css/stylesheet.css', extensionName: 'AnotherExtension')}" rel="stylesheet" />
+ *
+ * Output::
  *
- * (depending on current package)
+ *    <link href="typo3conf/ext/another_extension/Resources/Resources/Public/css/stylesheet.css" rel="stylesheet" />
  */
 class ResourceViewHelper extends AbstractViewHelper
 {
index 0729e3e..acd86fc 100644 (file)
@@ -22,27 +22,38 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * A ViewHelper to create uris from fields supported by the link wizard
+ * A ViewHelper to create uris from fields supported by the link wizard.
  *
  * Example
  * =======
  *
  * ``{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.
  *
- * minimal usage::
+ * Please note that due to the nature of typolink you have to provide a full
+ * set of parameters.
+ * If you use the parameter only, then target, class and title will be discarded.
+ *
+ * Minimal usage
+ * -------------
+ *
+ * ::
  *
  *    <f:uri.typolink parameter="{link}" />
  *
- * ``index.php?id=19&X=y``
+ * ``/page/path/name.html?X=y``
+ *
+ * Depending on routing and page path configuration.
  *
- * Full parameter usage::
+ * Full parameter usage
+ * --------------------
+ *
+ * ::
  *
  *    <f:uri.typolink parameter="{link}" additionalParams="&u=b" />
  *
- * ``index.php?id=19&X=y&u=b``
+ * ``/page/path/name.html?X=y&u=b``
+ *
+ * Depending on routing and page path configuration.
  */
 class TypolinkViewHelper extends AbstractViewHelper
 {
index 8b6b674..1e11949 100644 (file)
@@ -16,15 +16,17 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Widget;
 use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
 
 /**
- * Simple paginate widget
- * Note: Make sure to include jQuery and jQuery UI in the HTML, like that::
+ * Simple autocomplete widget.
  *
- * <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" />
+ * .. note::
+ *     Make sure to include jQuery and jQuery UI in the HTML, like that::
  *
- * You can include the provided TS template that includes the above snippet to the pages headerData.
+ *         <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 TypoScript template that includes the above snippet to the pages headerData.
  *
  * Examples
  * ========
@@ -38,7 +40,8 @@ use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
  *
  *    <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
+ * The input field and the required JavaScript for the Ajax communication.
+ * See Resources/Private/Templates/ViewHelpers/Widget/Autocomplete/Index.html
  */
 class AutocompleteViewHelper extends \TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper
 {
index 8249973..82b7ec5 100644 (file)
@@ -17,7 +17,7 @@ namespace TYPO3\CMS\Fluid\ViewHelpers\Widget;
 use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
 
 /**
- * A ViewHelper for creating Links to extbase actions within widets.
+ * A ViewHelper for creating Links to Extbase actions within widgets.
  *
  * Examples
  * ========
@@ -30,7 +30,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractTagBasedViewHelper;
  *
  *    <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)
+ * Depending on current page, routing and page path configuration.
  */
 class LinkViewHelper extends AbstractTagBasedViewHelper
 {
index 7a1f305..9204436 100644 (file)
@@ -23,14 +23,20 @@ use TYPO3\CMS\Fluid\Core\Widget\AbstractWidgetViewHelper;
  * Examples
  * ========
  *
- * required arguments::
+ * 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>
  *
- * full configuration::
+ * 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
index 130c387..3383ffb 100644 (file)
@@ -19,7 +19,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
 use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
 
 /**
- * A ViewHelper for creating URIs to extbase actions within widgets.
+ * A ViewHelper for creating URIs to Extbase actions within widgets.
  *
  * Examples
  * ========
@@ -28,8 +28,9 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <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)
+ * ``/page/path/name.html?tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz``
+ *
+ * Depending on current page, routing and page path configuration.
  */
 class UriViewHelper extends AbstractViewHelper
 {
index c29069b..6f26068 100644 (file)
@@ -38,7 +38,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *    {namespace formvh=TYPO3\CMS\Form\ViewHelpers}
  *    <formvh:render factoryClass="NameOfYourCustomFactoryClass" />
  *
- * The factory class must implement {@link TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface}.
+ * The factory class must implement :php:`TYPO3\CMS\Form\Domain\Factory\FormFactoryInterface`.
  *
  * Scope: frontend
  */