[+TASK] Fluid (ViewHelpers): Fix, cleanup and extend inline documentation of ViewHelpers
authorBastian Waidelich <bastian@typo3.org>
Thu, 30 Dec 2010 16:21:11 +0000 (16:21 +0000)
committerBastian Waidelich <bastian@typo3.org>
Thu, 30 Dec 2010 16:21:11 +0000 (16:21 +0000)
Resolves #10908

50 files changed:
typo3/sysext/fluid/Classes/ViewHelpers/Be/AbstractBackendViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/CshViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/IconViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/Buttons/ShortcutViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.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/TableListViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/DebugViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/EscapeViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/FlashMessagesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/CheckboxViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/ErrorsViewHelper.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/SubmitViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextareaViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextboxViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/TextfieldViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Form/UploadViewHelper.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/Nl2brViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/NumberViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/PaddingViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/PrintfViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/GroupedForViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/IfViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/ImageViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/LayoutViewHelper.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/RenderViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/SectionViewHelper.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/Widget/LinkViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Widget/UriViewHelper.php

index d09646e..67adf09 100644 (file)
  * @version $Id:
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  *
- * @author      Steffen Kamper <info@sk-typo3.de>
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 abstract class Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
 
index 904e7c9..056c65f 100644 (file)
  * <code title="Default">
  * <f:be.buttons.csh />
  * </code>
- *
- * Output:
+ * <output>
  * CSH button as known from the TYPO3 backend.
+ * </output>
  *
+ * <code title="Full configuration">
+ * <f:be.buttons.csh table="xMOD_csh_corebe" field="someCshKey" iconOnly="1" styleAttributes="border: 1px solid red" />
+ * </code>
+ * <output>
+ * CSH button as known from the TYPO3 backend with some custom settings.
+ * </output>
  *
- * @author             Steffen Kamper <info@sk-typo3.de>
- * @author             Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_Buttons_CshViewHelper extends Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper {
 
index a843321..566b103 100644 (file)
  * <code title="Default">
  * <f:be.buttons.icon uri="{f:uri.action()}" />
  * </code>
- *
- * Output:
+ * <output>
  * An icon button as known from the TYPO3 backend, skinned and linked with the default action of the current controller.
  * Note: By default the "close" icon is used as image
+ * </output>
  *
  * <code title="Default">
  * <f:be.buttons.icon uri="{f:uri.action(action='new')}" icon="new_el" title="Create new Foo" />
  * </code>
- *
- * Output:
+ * <output>
  * This time the "new_el" icon is returned, the button has the title attribute set and links to the "new" action of the current controller.
+ * </output>
  *
- * @author             Steffen Kamper <info@sk-typo3.de>
- * @author             Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_Buttons_IconViewHelper extends Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper {
 
index 8b3a606..6f17204 100644 (file)
  * <code title="Default">
  * <f:be.buttons.shortcut />
  * </code>
- *
- * Output:
+ * <output>
  * Shortcut button as known from the TYPO3 backend.
  * By default the current page id, module name and all module arguments will be stored
+ * </output>
  *
  * <code title="Explicitly set parameters to be stored in the shortcut">
  * <f:be.buttons.shortcut getVars="{0: 'M', 1: 'myOwnPrefix'}" setVars="{0: 'function'}" />
  * </code>
- *
- * Output:
+ * <output>
  * Shortcut button as known from the TYPO3 backend.
  * This time only the specified GET parameters and SET[]-settings will be stored.
  * Note:
  * Normally you won't need to set getVars & setVars parameters in Extbase modules
+ * </output>
  *
- * @author             Steffen Kamper <info@sk-typo3.de>
- * @author             Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_Buttons_ShortcutViewHelper extends Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper {
 
index 6b1cbfe..03c62b7 100644 (file)
  * <code title="Simple">
  * <f:be.container>your module content</f:be.container>
  * </code>
- *
- * Output:
+ * <output>
  * "your module content" wrapped with propper head & body tags.
  * Default backend CSS styles and JavaScript will be included
+ * </output>
  *
  * <code title="All options">
  * <f:be.container pageTitle="foo" enableJumpToUrl="false" enableClickMenu="false" loadPrototype="false" loadScriptaculous="false" scriptaculousModule="someModule,someOtherModule" loadExtJs="true" loadExtJsTheme="false" extJsAdapter="jQuery" enableExtJsDebug="true" addCssFile="{f:uri.resource(path:'styles/backend.css')}" addJsFile="{f:uri.resource('scripts/main.js')}">your module content</f:be.container>
  * </code>
- *
- * Output:
+ * <output>
  * "your module content" wrapped with propper head & body tags.
  * Custom CSS file EXT:your_extension/Resources/Public/styles/backend.css and JavaScript file EXT:your_extension/Resources/Public/scripts/main.js will be loaded
+ * </output>
  *
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_ContainerViewHelper extends Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper {
 
index 61b74e1..80ac263 100644 (file)
  * This view helper only works in conjunction with Tx_Fluid_ViewHelpers_Be_Menus_ActionMenuViewHelper
  * Note: This view helper is experimental!
  *
+ * = Examples =
  *
- * @author      Steffen Kamper <info@sk-typo3.de>
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
+ * <code title="Simple">
+ * <f:be.menus.actionMenu>
+ *   <f:be.menus.actionMenuItem label="Overview" controller="Blog" action="index" />
+ *   <f:be.menus.actionMenuItem label="Create new Blog" controller="Blog" action="new" />
+ *   <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
+ * </f:be.menus.actionMenu>
+ * </code>
+ * <output>
+ * Selectbox with the options "Overview", "Create new Blog" and "List Posts"
+ * </output>
+ *
+ * <code title="Localized">
+ * <f:be.menus.actionMenu>
+ *   <f:be.menus.actionMenuItem label="{f:translate(key='overview')}" controller="Blog" action="index" />
+ *   <f:be.menus.actionMenuItem label="{f:translate(key='create_blog')}" controller="Blog" action="new" />
+ * </f:be.menus.actionMenu>
+ * </code>
+ * <output>
+ * localized selectbox
+ * <output>
+ *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_Menus_ActionMenuItemViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractTagBasedViewHelper {
 
index b4a5ae4..89e32ae 100644 (file)
@@ -33,9 +33,9 @@
  *   <f:be.menus.actionMenuItem label="List Posts" controller="Post" action="index" arguments="{blog: blog}" />
  * </f:be.menus.actionMenu>
  * </code>
- *
- * Output:
+ * <output>
  * Selectbox with the options "Overview", "Create new Blog" and "List Posts"
+ * </output>
  *
  * <code title="Localized">
  * <f:be.menus.actionMenu>
  *   <f:be.menus.actionMenuItem label="{f:translate(key='create_blog')}" controller="Blog" action="new" />
  * </f:be.menus.actionMenu>
  * </code>
+ * <output>
+ * localized selectbox
+ * <output>
  *
- * @author      Steffen Kamper <info@sk-typo3.de>
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_Menus_ActionMenuViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractTagBasedViewHelper implements Tx_Fluid_Core_ViewHelper_Facets_ChildNodeAccessInterface {
 
index cdffcec..e2839b3 100644 (file)
  * <code>
  * <f:be.pageInfo />
  * </code>
- *
- * Output:
+ * <output>
  * Page info icon with context menu
+ * </output>
  *
- * @author      Steffen Kamper <info@sk-typo3.de>
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_PageInfoViewHelper extends Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper {
 
index 9302e02..6a6b807 100644 (file)
  * <code>
  * <f:be.pagePath />
  * </code>
- *
- * Output:
+ * <output>
  * Current page path, prefixed with "Path:" and wrapped in a span with the class "typo3-docheader-pagePath"
+ * </output>
  *
- *
- * @author      Steffen Kamper <info@sk-typo3.de>
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Steffen Kamper <info@sk-typo3.de>
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 class Tx_Fluid_ViewHelpers_Be_PagePathViewHelper extends Tx_Fluid_ViewHelpers_Be_AbstractBackendViewHelper {
 
index 0d36110..fc15665 100644 (file)
  * <code title="Minimal">
  * <f:be.tableList tableName="fe_users" />
  * </code>
- *
- * Output:
+ * <output>
  * List of all "Website user" records stored in the configured storage PID.
  * Records will be editable, if the current BE user has got edit rights for the table "fe_users".
  * Only the title column (username) will be shown.
  * Context menu is active.
+ * </output>
  *
  * <code title="Full">
  * <f:be.tableList tableName="fe_users" fieldList="{0: 'name', 1: 'email'}" storagePid="1" levels="2" filter='foo' recordsPerPage="10" sortField="name" sortDescending="true" readOnly="true" enableClickMenu="false" clickTitleMode="info" alternateBackgroundColors="true" />
  * </code>
- *
- * Output:
+ * <output>
  * List of "Website user" records with a text property of "foo" stored on PID 1 and two levels down.
  * Clicking on a username will open the TYPO3 info popup for the respective record
+ * </output>
  *
- * @author      Bastian Waidelich <bastian@typo3.org>
- * @license     http://www.gnu.org/copyleft/gpl.html
- * @version     SVN: $Id:
- *
+ * @author Bastian Waidelich <bastian@typo3.org>
+ * @license http://www.gnu.org/copyleft/gpl.html
  */
 require_once (PATH_typo3 . 'class.db_list.inc');
 require_once (PATH_typo3 . 'class.db_list_extra.inc');
index f2daa98..9af51bb 100644 (file)
  *                                                                        */
 
 /**
+ * Wrapper for TYPO3s famous debug() function
  *
+ * = Examples =
+ *
+ * <code title="Simple">
+ * <f:debug>{testVariables.array}</f:debug>
+ * </code>
+ * <output>
+ * foobarbazfoo
+ * </output>
  */
 class Tx_Fluid_ViewHelpers_DebugViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
 
        /**
-        * Wrapper for TYPO3s famous debug()
+        * Wrapper for TYPO3s famous debug() function
         *
         * @param string $title
-        * @return string the altered string. 
+        * @return string the altered string.
         * @author Bastian Waidelich <bastian@typo3.org>
         */
        public function render($title = NULL) {
index 60cea75..9975003 100644 (file)
  * <code title="HTML">
  * <f:escape>{text}</f:escape>
  * </code>
- *
- * Output:
+ * <output>
  * Text with & " ' < > * replaced by HTML entities (htmlspecialchars applied).
+ * </output>
  *
  * <code title="Entities">
  * <f:escape type="entities">{text}</f:escape>
  * </code>
- *
- * Output:
+ * <output>
  * Text with all possible chars replaced by HTML entities (htmlentities applied).
+ * </output>
  *
  * <code title="URL">
  * <f:escape type="url">{text}</f:escape>
  * </code>
- *
- * Output:
+ * <output>
  * Text encoded for URL use (rawurlencode applied).
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 7714a67..cb0c233 100644 (file)
  * <code title="Simple">
  * <f:flashMessages />
  * </code>
- * Renders an ul-list of flash messages.
+ * <output>
+ * An ul-list of flash messages.
+ * </output>
  *
  * <code title="Output with css class">
  * <f:flashMessages class="specialClass" />
  * </code>
- *
- * Output:
+ * <output>
  * <ul class="specialClass">
  *  ...
  * </ul>
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 11784b8..3867668 100644 (file)
  * <code title="Example">
  * <f:form.checkbox name="myCheckBox" value="someValue" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="checkbox" name="myCheckBox" value="someValue" />
+ * </output>
  *
  * <code title="Preselect">
  * <f:form.checkbox name="myCheckBox" value="someValue" checked="{object.value} == 5" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="checkbox" name="myCheckBox" value="someValue" checked="checked" />
  * (depending on $object)
+ * </output>
  *
  * <code title="Bind to object property">
  * <f:form.checkbox property="interests" value="TYPO3" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="checkbox" name="user[interests][]" value="TYPO3" checked="checked" />
  * (depending on property "interests")
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 7aa3595..4e857ae 100644 (file)
  *
  * <code title="Output error messages as a list">
  * <ul class="errors">
- *   <f:errors>
+ *   <f:form.errors>
  *     <li>{error.code}: {error.message}</li>
- *   </f:errors>
+ *   </f:form.errors>
  * </ul>
  * </code>
- *
- * Output:
+ * <output>
  * <ul>
  *   <li>1234567890: Validation errors for argument "newBlog"</li>
  * </ul>
+ * </output>
+ *
+ * <code title="Output error messages for a single property">
+ * <f:form.errors for="someProperty">
+ *   <div class="error">
+ *     <strong>{error.propertyName}</strong>: <f:for each="{error.errors}" as="errorDetail">{errorDetail.message}</f:for>
+ *   </div>
+ * </f:form.errors>
+ * </code>
+ * <output>
+ * <div class="error>
+ *   <strong>someProperty:</strong> errorMessage1 errorMessage2
+ * </div>
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index eca044b..e251d7e 100644 (file)
@@ -28,9 +28,9 @@
  * <code title="Example">
  * <f:form.hidden name="myHiddenValue" value="42" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="hidden" name="myHiddenValue" value="42" />
+ * </output>
  *
  * You can also use the "property" attribute if you have bound an object to the form.
  * See <f:form> for more documentation.
index b82dbde..8ab565b 100644 (file)
@@ -28,9 +28,9 @@
  * <code title="Example">
  * <f:form.password name="myPassword" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="password" name="myPassword" value="default value" />
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 6914d8f..d8e15a7 100644 (file)
  * <code title="Example">
  * <f:form.radio name="myRadioButton" value="someValue" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="radio" name="myRadioButton" value="someValue" />
+ * </output>
  *
  * <code title="Preselect">
  * <f:form.radio name="myRadioButton" value="someValue" checked="{object.value} == 5" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="radio" name="myRadioButton" value="someValue" checked="checked" />
  * (depending on $object)
+ * </output>
  *
  * <code title="Bind to object property">
  * <f:form.radio property="newsletter" value="1" /> yes
  * <f:form.radio property="newsletter" value="0" /> no
  * </code>
- *
- * Output:
+ * <output>
  * <input type="radio" name="user[newsletter]" value="1" checked="checked" /> yes
  * <input type="radio" name="user[newsletter]" value="0" /> no
  * (depending on property "newsletter")
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 7e6ffdf..2237c63 100644 (file)
  * <code title="Defaults">
  * <f:form.submit value="Send Mail" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="submit" />
+ * </output>
  *
  * <code title="Dummy content for template preview">
  * <f:submit name="mySubmit" value="Send Mail"><button>dummy button</button></f:submit>
  * </code>
- *
-  * Output:
+ * <output>
  * <input type="submit" name="mySubmit" value="Send Mail" />
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 6f8523c..2b2da33 100644 (file)
  * = Examples =
  *
  * <code title="Example">
- * <f:textarea name="myTextArea" value="This is shown inside the textarea" />
+ * <f:form.textarea name="myTextArea" value="This is shown inside the textarea" />
  * </code>
- *
- * Output:
+ * <output>
  * <textarea name="myTextArea">This is shown inside the textarea</textarea>
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 5b0361a..b84d2e6 100644 (file)
@@ -30,9 +30,9 @@
  * <code title="Example">
  * <f:form.textbox name="myTextBox" value="default value" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="text" name="myTextBox" value="default value" />
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 8266c8b..dce3f4d 100644 (file)
@@ -28,9 +28,9 @@
  * <code title="Example">
  * <f:form.textfield name="myTextBox" value="default value" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="text" name="myTextBox" value="default value" />
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 7e1c230..d196475 100644 (file)
@@ -29,9 +29,9 @@
  * <code title="Example">
  * <f:form.upload name="file" />
  * </code>
- *
- * Output:
+ * <output>
  * <input type="file" name="file" />
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 85b62f9..ac9d8c6 100644 (file)
  * <code title="Defaults">
  * <f:format.crop maxCharacters="10">This is some very long text</f:format.crop>
  * </code>
- *
- * Output:
+ * <output>
  * This is...
+ * </output>
  *
  * <code title="Custom suffix">
  * <f:format.crop maxCharacters="17" append="&nbsp;[more]">This is some very long text</f:format.crop>
  * </code>
- *
- * Output:
+ * <output>
  * This is some&nbsp;[more]
+ * </output>
  *
  * <code title="Don't respect word boundaries">
  * <f:format.crop maxCharacters="10" respectWordBoundaries="false">This is some very long text</f:format.crop>
  * </code>
- *
- * Output:
+ * <output>
  * This is so...
+ * </output>
  *
  * <code title="Don't respect HTML tags">
  * <f:format.crop maxCharacters="28" respectWordBoundaries="false" respectHtml="false">This is some text with <strong>HTML</strong> tags</f:format.crop>
  * </code>
- *
- * Output:
+ * <output>
  * This is some text with <stro
+ * </output>
+ *
+ * <code title="Inline notation">
+ * {someLongText -> f:format.crop(maxCharacters: 10)}
+ * </code>
+ * <output>
+ * someLongText cropped after 10 characters...
+ * (depending on the value of {someLongText})
+ * </output>
  *
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License, version 2
  */
index 3cb1e8e..4f47383 100644 (file)
  * <code title="Defaults">
  * <f:format.currency>123.456</f:format.currency>
  * </code>
- *
- * Output:
+ * <output>
  * 123,46
+ * </output>
  *
  * <code title="All parameters">
  * <f:format.currency currencySign="$" decimalSeparator="." thousandsSeparator=",">54321</f:format.currency>
  * </code>
- *
- * Output:
+ * <output>
  * 54,321.00 $
+ * </output>
+ *
+ * <code title="Inline notation">
+ * {someNumber -> f:format.currency(thousandsSeparator: ',', currencySign: '€')}
+ * </code>
+ * <output>
+ * 54,321,00 €
+ * (depending on the value of {someNumber})
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 9307553..6eaa2b2 100644 (file)
  * <code title="Defaults">
  * <f:format.date>{dateObject}</f:format.date>
  * </code>
- *
- * Output:
+ * <output>
  * 1980-12-13
  * (depending on the current date)
+ * </output>
  *
  * <code title="Custom date format">
  * <f:format.date format="H:i">{dateObject}</f:format.date>
  * </code>
- *
- * Output:
+ * <output>
  * 01:23
  * (depending on the current time)
+ * </output>
  *
  * <code title="strtotime string">
  * <f:format.date format="d.m.Y - H:i:s">+1 week 2 days 4 hours 2 seconds</f:format.date>
  * </code>
- *
- * Output:
+ * <output>
  * 13.12.1980 - 21:03:42
  * (depending on the current time, see http://www.php.net/manual/en/function.strtotime.php)
+ * </output>
  *
- * <code title="inline notation">
+ * <code title="output date from unix timestamp">
+ * <f:format.date format="d.m.Y - H:i:s">@{someTimestamp}</f:format.date>
+ * </code>
+ * <output>
+ * 13.12.1980 - 21:03:42
+ * (depending on the current time. Don't forget the "@" in front of the timestamp see http://www.php.net/manual/en/function.strtotime.php)
+ * </output>
+ *
+ * <code title="Inline notation">
  * {f:format.date(date: dateObject)}
  * </code>
+ * <output>
+ * 1980-12-13
+ * (depending on the value of {dateObject})
+ * </output>
  *
- * Output:
+ * <code title="Inline notation (2nd variant)">
+ * {dateObject -> f:format.date()}
+ * </code>
+ * <output>
  * 1980-12-13
- * (depending on the current date)
+ * (depending on the value of {dateObject})
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 10d6a8d..5778489 100644 (file)
  * 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.
  *
- * Example:
+ * == Examples ==
  *
- * (1) default parameters:
+ * <code title="Default parameters">
  * <f:format.html>foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
- *
- * Result:
+ * </code>
+ * <output>
  * <p class="bodytext">foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.</p>
  * (depending on your TYPO3 setup)
+ * </output>
  *
- * (2) custom parseFunc
+ * <code title="Custom parseFunc">
  * <f:format.html parseFuncTSPath="lib.parseFunc">foo <b>bar</b>. Some <LINK 1>link</LINK>.</f:format.html>
+ * </code>
+ * <output>
+ * foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
+ * </output>
  *
- * Output:
+ * <code title="Inline notation">
+ * {someText -> f:format.html(parseFuncTSPath: 'lib.parseFunc')}
+ * </code>
+ * <output>
  * foo <b>bar</b>. Some <a href="index.php?id=1" >link</a>.
+ * </output>
  *
  * @see http://typo3.org/documentation/document-library/references/doc_core_tsref/4.2.0/view/1/5/#id4198758
  *
index 27a168e..924e6af 100644 (file)
  * <code title="Example">
  * <f:format.nl2br>{text_with_linebreaks}</f:format.nl2br>
  * </code>
+ * <output>
+ * text with line breaks replaced by <br />
+ * </output>
  *
- * Output:
+ * <code title="Inline notation">
+ * {text_with_linebreaks -> f:format.nl2br()}
+ * </code>
+ * <output>
  * text with line breaks replaced by <br />
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 79d0da1..d9978d1 100644 (file)
  * <code title="Defaults">
  * <f:format.number>423423.234</f:format.number>
  * </code>
- *
- * Output:
+ * <output>
  * 423,423.20
+ * </output>
  *
  * <code title="With all parameters">
  * <f:format.number decimals="1" decimalSeparator="," thousandsSeparator=".">423423.234</f:format.number>
  * </code>
- *
- * Output:
+ * <output>
  * 423.423,2
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 7187e4d..9fa1148 100644 (file)
  * <code title="Defaults">
  * <f:format.padding padLength="10">TYPO3</f:format.padding>
  * </code>
- *
- * Output:
+ * <output>
  * TYPO3     (note the trailing whitespace)
+ * <output>
  *
  * <code title="Specify padding string">
  * <f:format.padding padLength="10" padString="-=">TYPO3</f:format.padding>
  * </code>
- *
- * Output:
+ * <output>
  * TYPO3-=-=-
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 86b264b..9cbec1e 100644 (file)
  * = Examples =
  *
  * <code title="Scientific notation">
- * <f:format.printf arguments="{number : 362525200}">%.3e</f:format.printf>
+ * <f:format.printf arguments="{number: 362525200}">%.3e</f:format.printf>
  * </code>
- *
- * Output:
+ * <output>
  * 3.625e+8
+ * </output>
  *
  * <code title="Argument swapping">
- * <f:format.printf arguments="{0: 3,1: 'Kasper'}">%2$s is great, TYPO%1$d too. Yes, TYPO%1$d is great and so is %2$s!</f:format.printf>
+ * <f:format.printf arguments="{0: 3, 1: 'Kasper'}">%2$s is great, TYPO%1$d too. Yes, TYPO%1$d is great and so is %2$s!</f:format.printf>
  * </code>
- *
- * Output:
+ * <output>
  * Kasper is great, TYPO3 too. Yes, TYPO3 is great and so is Kasper!
+ * </output>
  *
  * <code title="Single argument">
- * <f:format.printf arguments="{1:'TYPO3'}">We love %s</f:format.printf>
+ * <f:format.printf arguments="{1: 'TYPO3'}">We love %s</f:format.printf>
  * </code>
+ * <output>
+ * We love TYPO3
+ * </output>
  *
- * Output:
+ * <code title="Inline notation">
+ * {someText -> f:format.printf(arguments: {1: 'TYPO3'})}
+ * </code>
+ * <output>
  * We love TYPO3
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index bf3aecc..b3c9f5b 100644 (file)
@@ -51,8 +51,7 @@
  *   </f:groupedFor>
  * </ul>
  * </code>
- *
- * Output:
+ * <output>
  * <ul>
  *   <li>green fruits
  *     <ul>
@@ -73,6 +72,7 @@
  *     </ul>
  *   </li>
  * </ul>
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 3156227..e8a8204 100644 (file)
  *   </f:else>
  * </f:if>
  * </code>
- *
+ * <output>
  * Everything inside the "then" tag is displayed if the condition evaluates to TRUE.
  * Otherwise, everything inside the "else"-tag is displayed.
+ * </output>
  *
  * <code title="inline notation">
  * {f:if(condition: someCondition, then: 'condition is met', else: 'condition is not met')}
  * </code>
- *
+ * <output>
  * The value of the "then" attribute is displayed if the condition evaluates to TRUE.
  * Otherwise, everything the value of the "else"-attribute is displayed.
+ * </output>
  *
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
index a17aaf0..6873474 100644 (file)
  *                                                                        */
 
 /**
+ * Resizes a given image (if required) and renders the respective img tag
  *
- * @todo documentation
+ * = Examples =
  *
- */
-
-/**
+ * <code title="Default">
+ * <f:image src="EXT:myext/Resources/Public/typo3_logo.png" alt="alt text" />
+ * </code>
+ * <output>
+ * <img alt="alt text" src="typo3conf/ext/myext/Resources/Public/typo3_logo.png" width="396" height="375" />
+ * or (in BE mode):
+ * <img alt="alt text" src="../typo3conf/ext/viewhelpertest/Resources/Public/typo3_logo.png" width="396" height="375" />
+ * </output>
  *
+ * <code title="Inline notation">
+ * {f:image(src: 'EXT:viewhelpertest/Resources/Public/typo3_logo.png', alt: 'alt text', minWidth: 30, maxWidth: 40)}
+ * </code>
+ * <output>
+ * <img alt="alt text" src="../typo3temp/pics/f13d79a526.png" width="40" height="38" />
+ * (depending on your TYPO3s encryption key)
+ * </output>
+ *
+ * <code title="non existing image">
+ * <f:image src="NonExistingImage.png" alt="foo" />
+ * </code>
+ * <output>
+ * Could not get image resource for "NonExistingImage.png".
+ * </output>
  */
 class Tx_Fluid_ViewHelpers_ImageViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractTagBasedViewHelper {
 
        /**
-        * @var tslib_cObj
+        * @var tslib_cObj
         */
        protected $contentObject;
 
@@ -35,12 +55,12 @@ class Tx_Fluid_ViewHelpers_ImageViewHelper extends Tx_Fluid_Core_ViewHelper_Abst
        protected $tagName = 'img';
 
        /**
-        * @var t3lib_fe contains a backup of the current $GLOBALS['TSFE'] if used in BE mode
+        * @var t3lib_fe contains a backup of the current $GLOBALS['TSFE'] if used in BE mode
         */
        protected $tsfeBackup;
 
        /**
-        * @var string
+        * @var string
         */
        protected $workingDirectoryBackup;
 
@@ -74,7 +94,7 @@ class Tx_Fluid_ViewHelpers_ImageViewHelper extends Tx_Fluid_Core_ViewHelper_Abst
        }
 
        /**
-        * Render the img tag.
+        * Resizes a given image (if required) and renders the respective img tag
         * @see http://typo3.org/documentation/document-library/references/doc_core_tsref/4.2.0/view/1/5/#id4164427
         *
         * @param string $src
index cca503d..f131ea5 100644 (file)
  *                                                                        */
 
 /**
- * With this tag, you can select a layout to be used..
+ * With this tag, you can select a layout to be used for the current template.
  * <code><f:layout name="main" /></code>
- * 
- *
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 3cacb8a..d6a1494 100644 (file)
  * <code title="link to the show-action of the current controller">
  * <f:link.action action="show">action link</f:link.action>
  * </code>
- *
- * Output:
+ * <output>
  * <a href="index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz">action link</f:link.action>
  * (depending on the current page and your TS configuration)
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  */
index 74d4596..9712473 100644 (file)
  * <code title="basic email link">
  * <f:link.email email="foo@bar.tld" />
  * </code>
- *
- * Output:
+ * <output>
  * <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">foo(at)bar.tld</a>
  * (depending on your spamProtectEmailAddresses-settings)
+ * </output>
  *
  * <code title="Email link with custom linktext">
  * <f:link.email email="foo@bar.tld">some custom content</f:emaillink>
  * </code>
- *
- * Output:
+ * <output>
  * <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">some custom content</a>
+ * </output>
  *
  */
 class Tx_Fluid_ViewHelpers_Link_EmailViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractTagBasedViewHelper {
 
        /**
-        * @var string
+        * @var string
         */
        protected $tagName = 'a';
 
index ec3e99e..5ca3ee1 100644 (file)
@@ -28,9 +28,9 @@
  * <code>
  * <f:link.external uri="http://www.typo3.org" target="_blank">external link</f:link.external>
  * </code>
- *
- * Output:
+ * <output>
  * <a href="http://www.typo3.org" target="_blank">external link</a>
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 43cf22b..fe2c9a4 100644 (file)
  * <code title="link to the current page">
  * <f:link.page>page link</f:link.page>
  * </code>
- *
- * Output:
+ * <output>
  * <a href="index.php?id=123">page link</f:link.action>
  * (depending on the current page and your TS configuration)
+ * </output>
  *
  * <code title="query parameters">
  * <f:link.page pageUid="1" additionalParams="{foo: 'bar'}">page link</f:link.page>
  * </code>
- *
- * Output:
+ * <output>
  * <a href="index.php?id=1&foo=bar">page link</f:link.action>
  * (depending on your TS configuration)
+ * </output>
  *
  * <code title="query parameters for extensions">
  * <f:link.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}">page link</f:link.page>
  * </code>
- *
- * Output:
+ * <output>
  * <a href="index.php?id=1&extension_key[foo]=bar">page link</f:link.action>
  * (depending on your TS configuration)
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  */
index a9fa334..8353f4d 100644 (file)
  *                                                                        */
 
 /**
+ * ViewHelper that renders a section or a specified partial
+ *
+ * == Examples ==
+ *
+ * <code title="Rendering partials">
+ * <f:render partial="SomePartial" arguments="{foo: someVariable}" />
+ * </code>
+ * <output>
+ * the content of the partial "SomePartial". The content of the variable {someVariable} will be available in the partial as {foo}
+ * </output>
+ *
+ * <code title="Rendering sections">
+ * <f:section name="someSection">This is a section. {foo}</f:section>
+ * <f:render section="someSection" arguments="{foo: someVariable}" />
+ * </code>
+ * <output>
+ * the content of the section "someSection". The content of the variable {someVariable} will be available in the partial as {foo}
+ * </output>
+ *
+ * <code title="Rendering recursive sections">
+ * <f:section name="mySection">
+ *  <ul>
+ *    <f:for each="{myMenu}" as="menuItem">
+ *      <li>
+ *        {menuItem.text}
+ *        <f:if condition="{menuItem.subItems}">
+ *          <f:render section="mySection" arguments="{myMenu: menuItem.subItems}" />
+ *        </f:if>
+ *      </li>
+ *    </f:for>
+ *  </ul>
+ * </f:section>
+ * <f:render section="mySection" arguments="{myMenu: menu}" />
+ * </code>
+ * <output>
+ * <ul>
+ *   <li>menu1
+ *     <ul>
+ *       <li>menu1a</li>
+ *       <li>menu1b</li>
+ *     </ul>
+ *   </li>
+ * [...]
+ * (depending on the value of {menu})
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 7e8823b..18db145 100644 (file)
 /**
  * A Section view helper
  *
+ * == Examples ==
+ *
+ * <code title="Rendering sections">
+ * <f:section name="someSection">This is a section. {foo}</f:section>
+ * <f:render section="someSection" arguments="{foo: someVariable}" />
+ * </code>
+ * <output>
+ * the content of the section "someSection". The content of the variable {someVariable} will be available in the partial as {foo}
+ * </output>
+ *
+ * <code title="Rendering recursive sections">
+ * <f:section name="mySection">
+ *  <ul>
+ *    <f:for each="{myMenu}" as="menuItem">
+ *      <li>
+ *        {menuItem.text}
+ *        <f:if condition="{menuItem.subItems}">
+ *          <f:render section="mySection" arguments="{myMenu: menuItem.subItems}" />
+ *        </f:if>
+ *      </li>
+ *    </f:for>
+ *  </ul>
+ * </f:section>
+ * <f:render section="mySection" arguments="{myMenu: menu}" />
+ * </code>
+ * <output>
+ * <ul>
+ *   <li>menu1
+ *     <ul>
+ *       <li>menu1a</li>
+ *       <li>menu1b</li>
+ *     </ul>
+ *   </li>
+ * [...]
+ * (depending on the value of {menu})
+ * </output>
+ *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
  */
index d19ba3c..c21a956 100644 (file)
  * Translate a key from locallang. The files are loaded from the folder
  * "Resources/Private/Language/".
  *
+ * == Examples ==
+ *
+ * <code title="Translate key">
+ * <f:translate key="key1" />
+ * </code>
+ * <output>
+ * // value of key "key1" in the current website language
+ * </output>
+ *
+ * <code title="Keep HTML tags">
+ * <f:translate key="htmlKey" htmlEscape="false" />
+ * </code>
+ * <output>
+ * // value of key "htmlKey" in the current website language, no htmlspecialchars applied
+ * </output>
+ *
+ * <code title="Translate key from custom locallang file">
+ * <f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xml:key1" />
+ * </code>
+ * <output>
+ * // value of key "key1" in the current website language
+ * </output>
+ *
+ * <code title="Inline notation with arguments and default value">
+ * {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
+ * </code>
+ * <output>
+ * // value of key "argumentsKey" in the current website language
+ * // with "%1" and "%2" are replaced by "dog" and "fox" (printf)
+ * // if the key is not found, the output is "default value"
+ * </output>
  */
 class Tx_Fluid_ViewHelpers_TranslateViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
 
index d7dad2b..366fbfa 100644 (file)
  * <code title="URI to the show-action of the current controller">
  * <f:uri.action action="show" />
  * </code>
- *
- * Output:
+ * <output>
  * index.php?id=123&tx_myextension_plugin[action]=show&tx_myextension_plugin[controller]=Standard&cHash=xyz
  * (depending on the current page and your TS configuration)
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  *
index 5132ec7..de06ec4 100644 (file)
  * <code title="basic email URI">
  * <f:uri.email email="foo@bar.tld" />
  * </code>
- *
- * Output:
+ * <output>
  * javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');
  * (depending on your spamProtectEmailAddresses-settings)
+ * </output>
  *
  */
 class Tx_Fluid_ViewHelpers_Uri_EmailViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
index 2154895..8261795 100644 (file)
@@ -29,9 +29,9 @@
  * <code>
  * <f:uri.external uri="http://www.typo3.org" />
  * </code>
- *
- * Output:
+ * <output>
  * http://www.typo3.org
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
index 679ccd2..1b3294d 100644 (file)
  *                                                                        */
 
 /*
- * renders a image according to the given dimensions
+ * Resizes a given image (if required) and returns its relative path.
  *
- * @return relative path to the image (typo3temp/...)
+ * = Examples =
  *
+ * <code title="Default">
+ * <f:uri.image src="EXT:myext/Resources/Public/typo3_logo.png" />
+ * </code>
+ * <output>
+ * typo3conf/ext/myext/Resources/Public/typo3_logo.png
+ * or (in BE mode):
+ * ../typo3conf/ext/myext/Resources/Public/typo3_logo.png
+ * </output>
+ *
+ * <code title="Inline notation">
+ * {f:uri.image(src: 'EXT:myext/Resources/Public/typo3_logo.png' minWidth: 30, maxWidth: 40)}
+ * </code>
+ * <output>
+ * typo3temp/pics/[b4c0e7ed5c].png
+ * (depending on your TYPO3s encryption key)
+ * </output>
+ *
+ * <code title="non existing image">
+ * <f:uri.image src="NonExistingImage.png" />
+ * </code>
+ * <output>
+ * Could not get image resource for "NonExistingImage.png".
+ * </output>
  */
 class Tx_Fluid_ViewHelpers_Uri_ImageViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
 
        /**
-        * @var tslib_cObj
+        * @var tslib_cObj
         */
        protected $contentObject;
 
index 13e0065..e6a4023 100644 (file)
  * <code title="URI to the current page">
  * <f:uri.page>page link</f:uri.page>
  * </code>
- *
- * Output:
+ * <output>
  * index.php?id=123
  * (depending on the current page and your TS configuration)
+ * </output>
  *
  * <code title="query parameters">
  * <f:uri.page pageUid="1" additionalParams="{foo: 'bar'}" />
  * </code>
- *
- * Output:
+ * <output>
  * index.php?id=1&foo=bar
  * (depending on your TS configuration)
+ * </output>
  *
  * <code title="query parameters for extensions">
- * <f:link.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}">page link</f:link.page>
+ * <f:uri.page pageUid="1" additionalParams="{extension_key: {foo: 'bar'}}" />
  * </code>
- *
- * Output:
- * <a href="index.php?id=1&extension_key[foo]=bar">page link</f:link.action>
+ * <output>
+ * index.php?id=1&extension_key[foo]=bar
  * (depending on your TS configuration)
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  */
index 4e26e83..f14264c 100644 (file)
  * <code title="Defaults">
  * <link href="{f:uri.resource(path:'css/stylesheet.css')}" rel="stylesheet" />
  * </code>
- *
- * Output:
+ * <output>
  * <link href="Resources/Packages/MyPackage/stylesheet.css" rel="stylesheet" />
  * (depending on current package)
+ * </output>
  *
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  */
index 1a99ffe..331f704 100644 (file)
  *                                                                        */
 
 /**
+ * A view helper for creating Links to extbase actions within widets.
+ *
+ * = Examples =
+ *
+ * <code title="URI to the show-action of the current controller">
+ * <f:widget.link action="show">link</f:widget.link>
+ * </code>
+ * <output>
+ * <a href="index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz">link</a>
+ * (depending on the current page, widget and your TS configuration)
+ * </output>
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
  */
index 0e2ef73..3fa8953 100644 (file)
@@ -1,7 +1,5 @@
 <?php
 
-
-
 /*
  * This script belongs to the FLOW3 package "Fluid".                      *
  *                                                                        *
  *                                                                        */
 
 /**
+ * A view helper for creating URIs to extbase actions within widgets.
+ *
+ * = Examples =
+ *
+ * <code title="URI to the show-action of the current controller">
+ * <f:widget.uri action="show" />
+ * </code>
+ * <output>
+ * index.php?id=123&tx_myextension_plugin[widgetIdentifier][action]=show&tx_myextension_plugin[widgetIdentifier][controller]=Standard&cHash=xyz
+ * (depending on the current page, widget and your TS configuration)
+ * </output>
  * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
  * @api
  */