Example for if - then - elseif - else

<f:if condition="{var} == 'something'">
    <f:then>do something</f:then>
    <f:else if="{other-var} == 'something else'">do something else</f:else>
    <f:else>do the other thing</f:else>
</f:if>

https://stackoverflow.com/questions/29461381/fluid-if-then-elseif-else

https://docs.typo3.org/m/typo3/guide-extbasefluid/8.7/en-us/Fluid/ViewHelper/Index.html

to switch versions with version selector.

Disclaimer: I don't know if this is easily possible. But it would probably be helpful to have it all in one place.

• people keep asking why is Fluid ViewHelper rendering broken
• and keep pushing PR

The information on the start page currently does not reflect this.There is more information in README.rst and CONTRIBUTING.rst but that is not even linked to from the start page.

Documentation/Index.rst has already been updated but does not appear to get used.

Updating the start page would not solve the problem because people keep landing on subpages and asking about the rendering. But it is at least a start.

The current state still is much better then nothing.

I would remove this

Also notice that package names are not 1:1 Composer packages. cms- is striped.

striped?

The documentation for the f:debug ViewHelper (here) is missing the argument "title", although it is present in the code example.

Maybe this is the wrong place - it is also not initialized as argument in DebugViewHelper.php:55

The documentation states

Resizes a given image (if required) and returns its relative path.

However it also returns the paths of non images with a filereference when setting treatIdAsReference.

There is a mismatch between fluid VH source in TYPO3 what is being rendered and what is in the GitHub repo. The rendered docs is based on a (very) old version (more than 2 years ago, see git blame).

In any case, in the rendered version the code example is missing for f:link.email, even though it's in the source (for 9.5)

• source (TYPO3): https://github.com/TYPO3/TYPO3.CMS/blob/9.5/typo3/sysext/fluid/Classes/ViewHelpers/Link/EmailViewHelper.php
• rendered: https://docs.typo3.org/other/typo3/view-helper-reference/9.5/en-us/typo3/fluid/latest/Link/Email.html
• source of rendered: https://docs.typo3.org/other/typo3/view-helper-reference/9.5/en-us/_sources/typo3/fluid/latest/Link/Email.rst.txt

see also PR #30

source of rendered version:

Here, you can see that <f:link.email email="[email protected]" /> is missing:

Basic email link
----------------

::


Output::

   <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">foo(at)bar.tld</a>

source in core

Basic email link
 * ----------------
 *
 * ::
 *
 *    <f:link.email email="[email protected]" />
 *
 * Output::
 *
 *    <a href="javascript:linkTo_UnCryptMailto('ocknvq,hqqBdct0vnf');">foo(at)bar.tld</a>

This page: https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/fluid/latest/CObject.html explains currentValueKey with currentValueKey, which does not provide too much insight...

Also, according to a Slack comment, a construct like this should also be possible:

<f:cObject typoscriptObjectPath="lib.someLibObject">{someValue}</f:cObject>

But it is not documented here.

I'd like to provide my own explanations - but unfortunately I have no clue what this currentValueKey is good for. Hopefully I can encourage somebody to provide some explanation and maybe 1 or 2 examples. I'd be happy to review!

be.container ViewHelper was deprecated, see https://github.com/TYPO3/typo3/blob/master/typo3/sysext/fluid/Classes/ViewHelpers/Be/ContainerViewHelper.php

• :file:EXT:your_extension/Resources/Public/JavaScript/Library2.js
• will be loaded, plus some inline labels for usage in JS code.
• @deprecated since v11, will be removed in v12.

But this is not reflected on the rendered page: https://docs.typo3.org/other/typo3/view-helper-reference/master/en-us/typo3/fluid/latest/Be/Container.html

Perhaps there is a way to interpret the @deprecated and add a visible note about the deprecation to the generated .rst.

I was looking at how to override the default template for the pagination ViewHelper and found information only on external sites (example).

The community would benefit if this information was included in the official documentation.

The file appears to be at TYPO3CMS-Reference-ViewHelper/Documentation/typo3/fluid/9.5/Widget/Paginate.rst

The syntax of code examples here is broken, But there is no edit me on Github Button yet:

https://docs.typo3.org/other/typo3/view-helper-reference/master/en-us/typo3fluid/fluid/latest/Switch.html

https://docs.typo3.org/other/typo3/view-helper-reference/9.5/en-us/typo3fluid/fluid/latest/Index.html

Subtopics cache and format are not ordered correctly as I assume the ordering for the navigation should be alphabetical. Both are on top of the list.

Btw: The button 'Edit mit on github' was quite ueseful - will it be integrated again?

On the page for format.padding (https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/fluid/latest/Format/Padding.html) the link to php manual is broken.

The correct link is:
https://www.php.net/manual/en/function.str-pad

makes the text difficult to read and interpret.

Examples

1. Conversion of arguments to ViewHelper for be.uri referenceType

https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/fluid/latest/Be/Uri.html

for

$this->registerArgument(
            'referenceType',
            'string',
            'The type of reference to be generated (one of the constants)',
            false,
            UriBuilder::ABSOLUTE_PATH
        );

https://github.com/TYPO3/TYPO3.CMS/blob/master/typo3/sysext/fluid/Classes/ViewHelpers/Be/UriViewHelper.php

In this case, it would probably be better to show UriBuilder::ABSOLUTE_PATH as string.

2. be.tableList: fieldList etc.

https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/fluid/latest/Be/TableList.html

ViewHelper and sub-ViewHelpers are on seperate pages which leads to duplicate entries in the menu.

Also, the sorting in menu is not immediately intuitive: First ViewHelpers with sub-ViewHelpers are displayed. Then, ViewHelpers without sub-ViewHelpers.

Example: moduleLayout

• ViewHelper moduleLayout: https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/backend/latest/ModuleLayout/Index.html#
• ViewHelpers moduleLayout.*: https://docs.typo3.org/typo3cms/ViewHelperReference/typo3/backend/latest/ModuleLayout.html

Most of the ViewHelper documentation is generated from the ViewHelper source code. Only the home page is maintained manually. Therefore, the "Edit on GitHub" workflow is counterproductive because it applies PRs to the reST files that will be overwritten during the next generation run. Remove the "Edit on GitHub" workflow and instead add a contribution page that explains all the manual steps.

If I am not mistaken, it is currently not possible to prerender changes in the ViewHelper documentation (because they are documented in comments).

Suggestions:

• think about using additional .rst files to manage the documentation and not document in comments

The pages fluidtypo3/fluid are not formatted and rendered correctly:

Example:

https://docs.typo3.org/typo3cms/ViewHelperReference/typo3fluid/fluid/latest/Cache/Disable.html

Related:

• PR: TYPO3/Fluid#436
• TYPO3/Fluid#442
• TYPO3/Fluid#458
• TYPO3/Fluid#444

Goal: Make it as easy as possible for contributors.

This should probably be defined separately for

• the TYPO3 core
• for Fluid

And I guess it would be best to put it in the Contribution Guide for the core and CONTRIBUTING guidelines in fluid (for standalone version).

Before people use various kinds of markup or despair at the difficulties of which markup to use, it might be a good idea to give general guidelines for markup.

Additionally, it might be helpful to use only a small subset of markup, maybe even one that is very similar for reStructuredText and Markdown.

See "Common markup for Markdown and reStructuredText"

Related: PR #2

I could not change it directly.

Bad example:

{f:translate(key: 'someKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}

Value of key someKey in the current website language
with the given arguments (dog and fox) assigned for the specified
%s conversions (:php:sprintf()) in the language file::

The output will be "Some text about a dog and a fox".

Better example

Bad example:
{f:translate(key: 'someKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}

Value of key someKey in the current website language
with the given arguments (dog and fox) assigned for the specified
%s or ordered %1$s conversions (:php:sprintf()) in the language file::

The output will be "Some text about a fox being smaller than a dog".

When switching to 8.7 from either https://docs.typo3.org/other/typo3/view-helper-reference/master/en-us/typo3fluid/fluid/latest/Index.html or https://docs.typo3.org/other/typo3/view-helper-reference/9.5/en-us/typo3fluid/fluid/latest/Index.html the user receives a 403 forbidden.

The reason is that there is a different file structure for 8.7, it should be https://docs.typo3.org/other/typo3/view-helper-reference/8.7/en-us/typo3fluid/fluid/ but actually is https://docs.typo3.org/other/typo3/view-helper-reference/8.7/en-us/typo3fluid/fluid/2.5.5/Index.html.

This is due the fact that 8.7 was generated once by hand and deployed by hand.

The documentation for <f:render> seems to be broken:

https://docs.typo3.org/other/typo3/view-helper-reference/master/en-us/typo3fluid/fluid/latest/Render.html

https://docs.typo3.org/typo3cms/ViewHelperReference/Index.html

all available Fluid ViewHelper

ViewHelpers

Also notice that package names are not 1:1 Composer packages. cms- is striped.

Should probably be "stripped".

The view helper <f:transform.html> is not visible on https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/Index.html

It was introduced in https://review.typo3.org/c/Packages/TYPO3.CMS/+/70977 for https://forge.typo3.org/issues/95176 in TYPO3 v11.5: https://docs.typo3.org/c/typo3/cms-core/11.5/en-us/Changelog/11.5/Feature-95176-IntroduceFtransformhtmlView-helper.html

I would have expected that the view helper reference lists the namespaces that need to be declared when a view helper is used.

For example the "typo3/backend" docs should show the namespace (and an example for {namespace be=TYPO3\CMS\Backend\ViewHelpers} and xmlns:be="http://typo3.org/ns/TYPO3/CMS/Backend/ViewHelpers").
https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/backend/latest/Index.html

https://docs.typo3.org/typo3cms/ViewHelperReference/

Suggestions:

Add information about how to contribute (including links to issues) on start page.

Disadvantage: information only visible on start page.

Add related links section with link to issues and repository

This might be a challenge because reporting an issue here may not always be the ideal solution because a change might be requested in the core or typo3fluid, but adding a link to issues in "Related Links" has the advantage, that:

• right now we are providing no information where to contribute on rendered ViewHelper reference. This would be a first step
• If someone writes an issue, they will see a link to CONTRIBUTING file with information (once #2 is merged)

f:image.height should link to the typoscript reference.

The rST patch would be

- See imgResource.width for possible options.
+ See :ref:`imgResource.width <t3tsref:imgresource-width>` for possible options.

.. but I do not know if that works when added to the typo3 source code.

• https://docs.typo3.org/other/typo3/view-helper-reference/12.4/en-us/typo3/fluid/latest/Image.html#image_height
• https://docs.typo3.org/m/typo3/reference-typoscript/12.4/en-us/Functions/Imgresource.html#width

I realize this might be a little difficult because we have generated docs from 2 source repos (core and fluid) and the paths of the files would need to be determined as well, but it would be quite helpful because:

• Make it easier to contribute (esp. for current non-core / Fluid contributors)

Example page: https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/core/latest/Form/TypoScriptConstants.html

Alternatives:

• show a banner on the top of the page with information about how to contribute and where the source code is

There have been some new changes, but it does not get rendered, so the new Information is missing.

For Example how it should be: https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/fluid/latest/Link/Typolink.html#addquerystring

Outdated Information: https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/typo3/fluid/latest/Link/Page.html#addquerystring

I have looked into the Core Files, but it's correct there, so it must be a rendering problem.

The f:switch documentation does not render as intended:

https://docs.typo3.org/other/typo3/view-helper-reference/master/en-us/typo3fluid/fluid/latest/Switch.html

Hi,

I noticed that the code part seems to be broken in the documention for the viewhelpers.
It's hard to read:
https://docs.typo3.org/other/typo3/view-helper-reference/9.5/en-us/typo3fluid/fluid/latest/Cycle.html

best regards