typo3/sysext/form/Documentation/Config/formManager/Index.rst

   1 .. include:: ../../Includes.txt
   2
   3
   4 .. _typo3.cms.form.formmanager:
   5
   6 =============
   7 [formManager]
   8 =============
   9
  10
  11 .. _typo3.cms.form.formmanager-properties:
  12
  13 Properties
  14 ==========
  15
  16
  17 .. _typo3.cms.form.formmanager.dynamicrequirejsmodules.app:
  18
  19 dynamicRequireJsModules.app
  20 ---------------------------
  21
  22 :aspect:`Option path`
  23       TYPO3.CMS.Form.formManager.dynamicRequireJsModules.app
  24
  25 :aspect:`Data type`
  26       string
  27
  28 :aspect:`Needed by`
  29       Backend (form manager)
  30
  31 :aspect:`Mandatory`
  32       Yes
  33
  34 :aspect:`Default value`
  35       .. code-block:: yaml
  36          :linenos:
  37          :emphasize-lines: 2
  38
  39          dynamicRequireJsModules:
  40            app: TYPO3/CMS/Form/Backend/FormManager
  41            viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel
  42
  43 :aspect:`Description`
  44       Internal setting. RequireJS path for the form manager JavaScript app.
  45
  46
  47 .. _typo3.cms.form.formmanager.dynamicrequirejsmodules.viewmodel:
  48
  49 dynamicRequireJsModules.viewModel
  50 ---------------------------------
  51
  52 :aspect:`Option path`
  53       TYPO3.CMS.Form.formManager.dynamicRequireJsModules.viewModel
  54
  55 :aspect:`Data type`
  56       string
  57
  58 :aspect:`Needed by`
  59       Backend (form manager)
  60
  61 :aspect:`Mandatory`
  62       Yes
  63
  64 :aspect:`Default value`
  65       .. code-block:: yaml
  66          :linenos:
  67          :emphasize-lines: 3
  68
  69          dynamicRequireJsModules:
  70            app: TYPO3/CMS/Form/Backend/FormManager
  71            viewModel: TYPO3/CMS/Form/Backend/FormManager/ViewModel
  72
  73 :aspect:`Description`
  74       Internal setting. RequireJS path for the form manager JavaScript view model.
  75
  76
  77 .. _typo3.cms.form.formmanager.stylesheets:
  78
  79 stylesheets
  80 -----------
  81
  82 :aspect:`Option path`
  83       TYPO3.CMS.Form.formManager.stylesheets
  84
  85 :aspect:`Data type`
  86       array
  87
  88 :aspect:`Needed by`
  89       Backend (form manager)
  90
  91 :aspect:`Mandatory`
  92       Yes
  93
  94 :aspect:`Default value`
  95       .. code-block:: yaml
  96          :linenos:
  97
  98          stylesheets:
  99            100: 'EXT:form/Resources/Public/Css/form.css'
 100
 101 :aspect:`Description`
 102       Internal setting. Path for the form manager CSS file.
 103
 104
 105 .. _typo3.cms.form.formmanager.translationfile:
 106
 107 translationFile
 108 ---------------
 109
 110 :aspect:`Option path`
 111       TYPO3.CMS.Form.formManager.translationFile
 112
 113 :aspect:`Data type`
 114       string/ array
 115
 116 :aspect:`Needed by`
 117       Backend (form manager)
 118
 119 :aspect:`Mandatory`
 120       Yes
 121
 122 :aspect:`Default value`
 123       .. code-block:: yaml
 124          :linenos:
 125
 126          translationFile: 'EXT:form/Resources/Private/Language/Database.xlf'
 127
 128 :aspect:`Good to know`
 129       :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
 130
 131 :aspect:`Description`
 132       The translation file(s) which should be used to translate parts of the form manager.
 133
 134
 135 .. _typo3.cms.form.formmanager.javascripttranslationfile:
 136
 137 javaScriptTranslationFile
 138 -------------------------
 139
 140 :aspect:`Option path`
 141       TYPO3.CMS.Form.formManager.javaScriptTranslationFile
 142
 143 :aspect:`Data type`
 144       string
 145
 146 :aspect:`Needed by`
 147       Backend (form manager)
 148
 149 :aspect:`Mandatory`
 150       Yes
 151
 152 :aspect:`Default value`
 153       .. code-block:: yaml
 154          :linenos:
 155
 156          javaScriptTranslationFile: 'EXT:form/Resources/Private/Language/locallang_formManager_javascript.xlf'
 157
 158 :aspect:`Description`
 159       Internal setting. Path for the inline language labels for the form manager app.
 160
 161
 162 .. _typo3.cms.form.formmanager.selectableprototypesconfiguration:
 163
 164 selectablePrototypesConfiguration
 165 ---------------------------------
 166
 167 :aspect:`Option path`
 168       TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration
 169
 170 :aspect:`Data type`
 171       array
 172
 173 :aspect:`Needed by`
 174       Backend (form manager)
 175
 176 :aspect:`Mandatory`
 177       Yes
 178
 179 :aspect:`Default value`
 180       .. code-block:: yaml
 181          :linenos:
 182
 183          selectablePrototypesConfiguration:
 184            100:
 185              identifier: standard
 186              label: formManager.selectablePrototypesConfiguration.standard.label
 187              newFormTemplates:
 188                100:
 189                  templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml'
 190                  label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label
 191                200:
 192                  templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml'
 193                  label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label
 194
 195 :aspect:`Good to know`
 196       - :ref:`"Start templates"<concepts-formmanager-starttemplate>`
 197       - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
 198
 199 :aspect:`Description`
 200       Array with numerical Keys. Configure the ``Start template`` selection list within the ``form manager`` "Advanced settings" step.
 201
 202
 203 .. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.identifier:
 204
 205 selectablePrototypesConfiguration.*.identifier
 206 ----------------------------------------------
 207
 208 :aspect:`Option path`
 209       TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.identifier
 210
 211 :aspect:`Data type`
 212       string
 213
 214 :aspect:`Needed by`
 215       Backend (form manager)
 216
 217 :aspect:`Mandatory`
 218       Yes
 219
 220 :aspect:`Related options`
 221       - :ref:`TYPO3.CMS.Form.prototypes <typo3.cms.form.prototypes>`
 222
 223 :aspect:`Good to know`
 224       - :ref:`"Start templates"<concepts-formmanager-starttemplate>`
 225
 226 :aspect:`Description`
 227       Reference to a ``prototype`` which should be used for the newly created form definition.
 228
 229
 230 .. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.label:
 231
 232 selectablePrototypesConfiguration.*.label
 233 -----------------------------------------
 234
 235 :aspect:`Option path`
 236       TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.label
 237
 238 :aspect:`Data type`
 239       string
 240
 241 :aspect:`Needed by`
 242       Backend (form manager)
 243
 244 :aspect:`Mandatory`
 245       Yes
 246
 247 :aspect:`Good to know`
 248       - :ref:`"Start templates"<concepts-formmanager-starttemplate>`
 249       - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
 250
 251 :aspect:`Description`
 252       The ``Form prototype`` selectlist label for this ``prototype`` within the ``form manager`` "Advanced settings" step.
 253
 254
 255 .. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates:
 256
 257 selectablePrototypesConfiguration.*.newFormTemplates
 258 ----------------------------------------------------
 259
 260 :aspect:`Option path`
 261       TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates
 262
 263 :aspect:`Data type`
 264       array
 265
 266 :aspect:`Needed by`
 267       Backend (form manager)
 268
 269 :aspect:`Mandatory`
 270       Yes
 271
 272 :aspect:`Default value`
 273       .. code-block:: yaml
 274          :linenos:
 275          :emphasize-lines: 5-
 276
 277          selectablePrototypesConfiguration:
 278            100:
 279              identifier: standard
 280              label: formManager.selectablePrototypesConfiguration.standard.label
 281              newFormTemplates:
 282                100:
 283                  templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/BlankForm.yaml'
 284                  label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.blankForm.label
 285                200:
 286                  templatePath: 'EXT:form/Resources/Private/Backend/Templates/FormEditor/Yaml/NewForms/SimpleContactForm.yaml'
 287                  label: formManager.selectablePrototypesConfiguration.standard.newFormTemplates.simpleContactForm.label
 288
 289 :aspect:`Good to know`
 290       - :ref:`"Start templates"<concepts-formmanager-starttemplate>`
 291       - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
 292
 293 :aspect:`Description`
 294       Array with numerical Keys. Configure the ``Start templates`` selectlist for this ``prototype`` within the ``form manager`` "Advanced settings" step.
 295
 296
 297 .. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates.*.templatepath:
 298
 299 selectablePrototypesConfiguration.*.newFormTemplates.*.templatePath
 300 -------------------------------------------------------------------
 301
 302 :aspect:`Option path`
 303       TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates.*.templatePath
 304
 305 :aspect:`Data type`
 306       string
 307
 308 :aspect:`Needed by`
 309       Backend (form manager)
 310
 311 :aspect:`Mandatory`
 312       Yes
 313
 314 :aspect:`Good to know`
 315       - :ref:`"Start templates"<concepts-formmanager-starttemplate>`
 316       - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
 317
 318 :aspect:`Description`
 319       The filesystem path to the `Start template`` yaml file.
 320
 321
 322 .. _typo3.cms.form.formmanager.selectableprototypesconfiguration.*.newformtemplates.*.label:
 323
 324 selectablePrototypesConfiguration.*.newFormTemplates.*.label
 325 ------------------------------------------------------------
 326
 327 :aspect:`Option path`
 328       TYPO3.CMS.Form.formManager.selectablePrototypesConfiguration.*.newFormTemplates.*.label
 329
 330 :aspect:`Data type`
 331       string
 332
 333 :aspect:`Needed by`
 334       Backend (form manager)
 335
 336 :aspect:`Mandatory`
 337       Yes
 338
 339 :aspect:`Good to know`
 340       - :ref:`"Start templates"<concepts-formmanager-starttemplate>`
 341       - :ref:`Translate "Start template" options<concepts-formmanager-translation-starttemplate>`
 342
 343 :aspect:`Description`
 344       The ``Start template`` selectlist label for this ``Start template`` within the ``form manager`` "Advanced settings" step.
 345
 346
 347 .. _typo3.cms.form.formmanager.controller:
 348
 349 controller
 350 ----------
 351
 352 :aspect:`Option path`
 353       TYPO3.CMS.Form.formManager.controller
 354
 355 :aspect:`Data type`
 356       array
 357
 358 :aspect:`Needed by`
 359       Backend (form manager)
 360
 361 :aspect:`Mandatory`
 362       Yes
 363
 364 :aspect:`Default value`
 365       .. code-block:: yaml
 366          :linenos:
 367
 368          controller:
 369            deleteAction:
 370              errorTitle: formManagerController.deleteAction.error.title
 371              errorMessage: formManagerController.deleteAction.error.body
 372
 373 :aspect:`Description`
 374       Internal setting. Configure the ``form manager`` flash message texts.
 375
 376
 377 .. _typo3.cms.form.formmanager.controller.deleteaction.errortitle:
 378
 379 controller.deleteAction.errorTitle
 380 ----------------------------------
 381
 382 :aspect:`Option path`
 383       TYPO3.CMS.Form.formManager.controller.deleteAction.errorTitle
 384
 385 :aspect:`Data type`
 386       string
 387
 388 :aspect:`Needed by`
 389       Backend (form manager)
 390
 391 :aspect:`Mandatory`
 392       Yes
 393
 394 :aspect:`Default value`
 395       .. code-block:: yaml
 396          :linenos:
 397          :emphasize-lines: 3
 398
 399          controller:
 400            deleteAction:
 401              errorTitle: formManagerController.deleteAction.error.title
 402              errorMessage: formManagerController.deleteAction.error.body
 403
 404 :aspect:`Description`
 405       Internal setting. Configure the ``form manager`` flash message texts.
 406
 407
 408 .. _typo3.cms.form.formmanager.controller.deleteaction.errormessage:
 409
 410 controller.deleteAction.errorMessage
 411 ------------------------------------
 412
 413 :aspect:`Option path`
 414       TYPO3.CMS.Form.formManager.controller.deleteAction.errorMessage
 415
 416 :aspect:`Data type`
 417       string
 418
 419 :aspect:`Needed by`
 420       Backend (form manager)
 421
 422 :aspect:`Mandatory`
 423       Yes
 424
 425 :aspect:`Default value`
 426       .. code-block:: yaml
 427          :linenos:
 428          :emphasize-lines: 4
 429
 430          controller:
 431            deleteAction:
 432              errorTitle: formManagerController.deleteAction.error.title
 433              errorMessage: formManagerController.deleteAction.error.body
 434
 435 :aspect:`Description`
 436       Internal setting. Configure the ``form manager`` flash message texts.