Git Product home page Git Product logo

typo3cms-reference-tca's Introduction

typo3cms-reference-tca's People

Contributors

alexander-nitsche avatar brotkrueml avatar cweiske avatar danielsiepmann avatar davidbruchmann avatar derhansen avatar floriant03 avatar franzholz avatar fsuter avatar garvinhicking avatar georg-tiefenbrunn avatar liayn avatar linawolf avatar lolli42 avatar macjohnny avatar maddy2101 avatar marble avatar mbrodala avatar michadu avatar neoblack avatar nhovratov avatar noldeni avatar ohader avatar remonator avatar runepiper avatar sgrossberndt avatar susannemoog avatar sypets avatar tmotyl avatar xperseguers avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

typo3cms-reference-tca's Issues

Mention deprecation of renderMode

renderMode has been deprecated since 7.6 and renderType is now mandatory. Mention that on : https://docs.typo3.org/m/typo3/reference-tca/7.6/en-us/Reference/Columns/Select/Index.html

changelog:

"Using the TCA field type select without specifying a valid renderType has been marked as deprecated."
Additionally the usage of renderMode for select fields has been marked as deprecated.

https://docs.typo3.org/c/typo3/cms-core/master/en-us/Changelog/7.6/Deprecation-69822-DeprecateSelectFieldTca.html

Suggest wizard misses addWhere docs

It is possible to define "addWhere" for suggest wizards, this property is only documented for pageTS, but is also possible as direct TCA config:

Task: Test and play around with this TCA setting and document it.

tca reference of suggest wizard:
https://docs.typo3.org/typo3cms/TCAReference/AdditionalFeatures/WizardsConfiguration/Index.html#suggest-wizards

page ts config docs of addWhere:
https://docs.typo3.org/typo3cms/TSconfigReference/PageTsconfig/TCEform/Index.html (search "addWhere")

Add additional subheaders for properties (values, default, requirements)

The TCA docs are quite extensive and often helpful, but a little hard to read in some places.

Would adding some extra headers in a consistent way be more helpful? I can add a PR, but wanted to get a second opinion first.

Currently, you have Datatype, Scope, Description and sometimes Default.

You could add:

  • Required (only if field is required)
  • Default (more often, often the default is just mentioned in the description)
  • Values (list possible values)
  • Requirements (or name it Prerequisites)
  • Example (as already used in some places, but more often not)

That way you won't have this information someplace in the description which is sometimes quite long. This information would be easier to spot quickly.

Example: suggestOptions

Here, you could have:

  • Requirements:
    • internal_type='db'
    • hideSuggest = False
  • Values:
    • additionalSearchFields
    • addWhere
    • ...

Whats about Chapter "Additional TCA features"?

In Version 8 the whole chapter "Additional TCA features" is dropped, is there any reason?
Concerning the new kind of building TYPO3\CMS\Backend\Form on Base of NodeFactory there is some info missing then, if someone is not switching between the versions.

Providing a proper example and description on formattedLabel_userFunc

Links to the "Inline" element of the Ctrl column are missing and an understandable example to show how formattedLabel_userFunc is included in the TCA code of an extension so that someone can see that it only works with these column elements.

The same applies to the options - there is no explanation as to what the options of the formatted Label_userFunc do or how many of them are available.

Add information about removing additional fields from Form for plugins (subtypes_excludelist)

I am copying some text which had to be removed from a PR and which I am not sure where to put currently.

Maybe we could add the example and some more context to subtypes_excludelist in TCA ref https://docs.typo3.org/m/typo3/reference-tca/master/en-us/Types/Index.html#subtypes-excludelist

image


How to remove extra fields from Form

In :file:Configuration/TCA/Overrides/tt_content.php add for example
the following::

$GLOBALS['TCA']['tt_content']['types']['list']['subtypes_excludelist']['example_registration'] = 'recursive,pages';

:ref:t3tca:types-properties-subtypes-excludelist can be used to exclude the fields
recursive and pages from the Form view in case these fields are not used

[Ticket#20170907609000113] Small inconsistencies

[Ticket#20170907609000113] Ticket erstellt: Small inconsistencies in the TCA documentation

Florian Schöppe wrote:

Hello Typo3 documentation team,
today I studied the TCA Reference under https://docs.typo3.org/typo3cms/TCAReference/7.6/ and found some smaller inconsistencies.
Crtl/title:

https://docs.typo3.org/typo3cms/TCAReference/7.6/Reference/Ctrl/Index.html#title
The example for table "sys_template" is not correct (anymore? - I looked into the sources of Typo3 7.6.22). The Translation of "sys_template" is found in the file EXT:frontend/Resources/Private/Language/locallang_tca.xlf not locallang_ttc.xlf.

In the explanation text below the example, the correct file is mentioned but the wrong (old?) prefix code is given: EXT:cms has to be EXT:frontend.

Thank you for your efforts!
Best regards
Florian Schöppe

shadowColumnsForMovePlaceholders referencing non existing value

In the
https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/blob/latest/Documentation/Reference/Ctrl/Index.rst#shadowcolumnsformoveplaceholders
there is a sentence:

Move placeholders are used only when property :ref:`versioningWS <ctrl-reference-versioningws>` is set to 2 (instead of 1 or TRUE).

however since https://review.typo3.org/#/c/50462/8 versioningWS is a bolean value.
Not sure whether we should remove the sentence, or change it's meaning.

Overhaul of TCA manual

Includes of type .rs.txt cannot be easily edited with the "Edit me on Github" button.

The larger the page the harder to edit for users as well. So I would like to suggest breaking the reference up into more pages, usually along the lines of the current includes and get rid of unnessesary includes alltogether.

Properties with subproperties not easily distinguishable from other properties

In the list of properties, there are some properties with possible values which are also formatted like properties. The only thing that makes these look differently are the header levels, but they look pretty much the same.

This makes it difficult to keep track, what is a property of a column type and what is a possible value of another property.

Examples

These are for example:

  • behaviour -> allowLanguageSynchronization
  • fieldWizard -> defaultLanguageDifferences
'behaviour' => [
                    'allowLanguageSynchronization' => true,
                ]

For example here: https://docs.typo3.org/m/typo3/reference-tca/10.4/en-us/ColumnsConfig/Type/Check.html we have these 3 properties:

├── behaviour
│   └── allowLanguageSynchronization
└── cols

image

Possible solutions:

  • Describe the subproperty within the description of parent property
  • change the title, e.g. to "behaviour => allowLanguageSynchronization"
  • ....

type=inline node expansion hint and example

People are confused why type=inline has no fieldWizard / fieldInformation like the other elements. In fact, it has, but it needs to be configured on 'ctrl' level (see ctrl container property). This is because inline in the rendering is a container and not an element.

We should at least hint for that in the type=inline docs, including an example. It would be even better if ext:styleguide would have a dedicated table to show-off some different node expansion setups on various type's.

dbType 'date' not useable in searchFields

Problem

Adding a column of dbType => date and renderType => inputDateTime into the searchFields list yields no results when searching for a record with this date in the List module.

Question

Am I right to assume that date fields are being omitted in Line 310 of LiveSearch.php?

Impact

If so, this should definitely be mentioned in the documentation of the searchFields section here and the search section of the inputDateTime render type here

eval / custom class example with class path as string does not work with double-slashes for FlexForm

I am using the example for "eval" => "Vendor ...", but using this in FlexForms

The string as specified in the example with double-slashes does not work in my example. String with single-slashes does, e.g.

not:
'eval' => 'trim,Vendor\\Extension\\Evaluation\\ExampleEvaluation,required'

but:
'eval' => 'trim,Vendor\Extension\Evaluation\ExampleEvaluation,required'

(However, as stated above this was tested with FlexForm, not with TCA directly)

Change order of examples to put code-block directly under each screenshot

in PR #251 some examples were rearranged in the following manner:

before there were several screenshots in one block and then several code examples on the "checkbox" page. The PR split that up into several examples. That way you could see the screenshot (how it looks) directly above the code snippet

I have not looked at the other examples. Possibly, we could check them if there are other cases where the examples could be improved and do it consistently.


Document missing fields for type inline

See forge issue https://forge.typo3.org/issues/63928

There is documentation missing for the possible fields of type inline:

     'parents' => [
            'exclude' => 1,
            'label' => 'parents',
            'config' => [
                'type' => 'inline',
                'foreign_table' => 'tx_styleguide_inline_mm_child',
                'MM' => 'tx_styleguide_inline_mm_child_childchild_rel',
                'MM_hasUidField' => true,
                'MM_opposite_field' => 'inline_2',
                'maxitems' => 10,
                'appearance' => [
                    'showSynchronizationLink' => 1,
                    'showAllLocalizationLink' => 1,
                    'showPossibleLocalizationRecords' => 1,
                    'showRemovedLocalizationRecords' => 1,
                ],
            ],
        ],

Some header labels do not work with intersphinx mechanism (using includes)

This works (meaning we can link to this header):


.. _columns-text-renderType-belayoutwizard:

Properties renderType = 'belayoutwizard'
========================================

This does not (meaning, a link to this section fails):

.. _columns-text-properties-wrap:
.. include:: ../Properties/TextWrap.rst.txt

Both on page: https://docs.typo3.org/typo3cms/TCAReference/ColumnsConfig/Type/Text.html

Test used:

does not work:

is done via :ref:`t3tca:enableRichtext`, and a specific configuration
can be set via :ref:`t3tca:richtextConfiguration`

does work:
test: :ref:t3tca:columns-text-renderType-belayoutwizard, start: :ref:t3tca:start.
This was already noticed and has been fixed in a security section in TYPO3 Explained.

Slugs with two path segments

Hi.

I'm wondering why the documentation says it's possible to use slugs with more than one path segment, but that leads always in an error like Parameter "tx_database_database__product" for route "tx_database_database_0" must match "[^/]++" ("nr-000065/test-2016-city" given) to generate a corresponding URL.

Is that a bug or is there a description missing how to use it properly?

I'm using T3V10.4.1

Header levels and internal structure of TCA not easily visible for [‘columns’][*][‘config’] with subfields

Example:

Type 'check' contains several properties in a hierarchical structure:

'behaviour' => [
      'allowLanguageSynchronization' => 1,
   ],

tca

You can see the hierarchy in the menu. But in the content, the only hint is the differently styled title. I sometimes find it difficult to see where in the TCA hierarchy the option must be put.


Only a few of the fields have subfields (e.g. behaviour, fieldWizard). Perhaps these sections could be indented, or the hierarchy added in the title, e.g. instead of

allowLanguageSynchronization
behaviour > allowLanguageSynchronization


type "group" internal_type file_reference warning: is this still necessary

file_reference
This will create a field where files can be referenced. In contrast to “file”, referenced files (usually from fileadmin/) will not be copied to the upload folder. Warning: use this carefully. Your references will be broken if you delete referenced files in the filesystem!

Do we still want this warning? Shouldn't using references be encouraged instead?

https://docs.typo3.org/m/typo3/reference-tca/master/en-us/ColumnsConfig/Type/Group.html#internal-type

Show all default values

One of my biggest problems when working on a TYPO3 extension is that I do not know what the default values are for configuration options. It would be a tremendous help to see them everywhere. And that's not limited to the TCA ref.

When I'm having some spare time I will make a pull request intended as a proposal.

Add clarification and possible values for subtypes_excludelist

“[field value]” => “[comma-separated list of fields (from the main types-config) which are removed]”
https://docs.typo3.org/m/typo3/reference-tca/master/en-us/Types/Index.html#subtypes-excludelist

https://docs.typo3.org/m/typo3/reference-tca/master/en-us/Types/Index.html#subtypes-excludelist

For me, the explanation is a little vague.

Also, a typical usecase - if used in Flexform - is to remove the record storage (pages) and recursive field (recursive). I don't know how I would be able to lookup this information.

Values are (if used in Flexform), e.g.

  • pages (record storage page)
  • recursive
  • layout (?)
  • select_key (?)

see also https://stackoverflow.com/questions/39386018/typo3-hide-plugin-mode-and-record-storage-page-in-a-plugin

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.