diff --git a/Documentation/PageTsconfig/Mod/Wizards.rst b/Documentation/PageTsconfig/Mod/Wizards.rst index d4cb9a48..e23fecb9 100644 --- a/Documentation/PageTsconfig/Mod/Wizards.rst +++ b/Documentation/PageTsconfig/Mod/Wizards.rst @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. index:: Wizards +.. index:: Wizards ======= wizards @@ -9,188 +9,202 @@ wizards The `wizards` section allows to customize the *New record wizard* and the *New content element wizard*. -.. contents:: - :local: +.. contents:: + :local: -.. index:: Wizards; new content element -.. _pagenewcontentelementwizard: +.. index:: Wizards; new content element +.. _pagenewcontentelementwizard: newContentElement.wizardItems ============================= -:aspect:`Datatype` - array +.. confval:: newContentElement.wizardItems + :name: mod-wizards-newContentElement-wizardItems + :type: array -:aspect:`Description` - In the new content element wizard, content element types are grouped - together by type. Each such group can be configured independently. The - four default groups are: "common", "special", "forms" and "plugins". + In the new content element wizard, content element types are grouped + together by type. Each such group can be configured independently. The + four default groups are: "common", "special", "forms" and "plugins". - The configuration options below apply to any group. + The configuration options below apply to any group. - mod.wizards.newContentElement.wizardItems.[group].before - (string) Sorts [group] in front of the group given. + mod.wizards.newContentElement.wizardItems.[group].before + (string) Sorts [group] in front of the group given. - mod.wizards.newContentElement.wizardItems.[group].after - (string) Sorts [group] after the group given. + mod.wizards.newContentElement.wizardItems.[group].after + (string) Sorts [group] after the group given. - mod.wizards.newContentElement.wizardItems.[group].header - (localized string) Name of the group. + mod.wizards.newContentElement.wizardItems.[group].header + (localized string) Name of the group. - mod.wizards.newContentElement.wizardItems.[group].show - (string) Comma-separated list of items to show in the group. Use `*` to show all, example: + mod.wizards.newContentElement.wizardItems.[group].show + (string) Comma-separated list of items to show in the group. Use `*` to show all, example: - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - # Hide bulletList - mod.wizards.newContentElement.wizardItems.common.show := removeFromList(bullets) - # Only show text and textpic in common - mod.wizards.newContentElement.wizardItems.common.show = text,textpic + # Hide bulletList + mod.wizards.newContentElement.wizardItems.common.show := removeFromList(bullets) + # Only show text and textpic in common + mod.wizards.newContentElement.wizardItems.common.show = text,textpic - mod.wizards.newContentElement.wizardItems.[group].elements - (array) List of items in the group. + mod.wizards.newContentElement.wizardItems.[group].elements + (array) List of items in the group. - mod.wizards.newContentElement.wizardItems.[group].elements.[name] - (array) Configuration for a single item. + mod.wizards.newContentElement.wizardItems.[group].elements.[name] + (array) Configuration for a single item. - mod.wizards.newContentElement.wizardItems.[group].elements.[name].iconIdentifier - (string) The icon identifier of the icon you want to display. + mod.wizards.newContentElement.wizardItems.[group].elements.[name].iconIdentifier + (string) The icon identifier of the icon you want to display. - mod.wizards.newContentElement.wizardItems.[group].elements.[name].iconOverlay - (string) The icon identifier of the overlay icon you want to use. + mod.wizards.newContentElement.wizardItems.[group].elements.[name].iconOverlay + (string) The icon identifier of the overlay icon you want to use. - mod.wizards.newContentElement.wizardItems.[group].elements.[name].title - (localized string) Name of the item. + mod.wizards.newContentElement.wizardItems.[group].elements.[name].title + (localized string) Name of the item. - mod.wizards.newContentElement.wizardItems.[group].elements.[name].description - (localized string) Description text for the item. + mod.wizards.newContentElement.wizardItems.[group].elements.[name].description + (localized string) Description text for the item. - mod.wizards.newContentElement.wizardItems.[group].elements.[name].tt_content_defValues - (array) Default values for tt_content fields. + mod.wizards.newContentElement.wizardItems.[group].elements.[name].tt_content_defValues + (array) Default values for tt_content fields. - mod.wizards.newContentElement.wizardItems.[group].elements.[name].saveAndClose - (boolean) If `true`, directs the user back to the :guilabel:`Page` module directly instead of showing the FormEngine. Default `false`. + mod.wizards.newContentElement.wizardItems.[group].elements.[name].saveAndClose + (boolean) If `true`, directs the user back to the :guilabel:`Page` module directly instead of showing the FormEngine. Default `false`. -:aspect:`Example` - .. _pageexample1: +.. _pageexample1: - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Example: Add a new element to the "common" group +------------------------------------------------ - # Add a new element (header) to the "common" group - mod.wizards.newContentElement.wizardItems.common.elements.header { - iconIdentifier = content-header - title = Header - description = Adds a header element only - tt_content_defValues { +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig + + # Add a new element (header) to the "common" group + mod.wizards.newContentElement.wizardItems.common.elements.header { + iconIdentifier = content-header + title = Header + description = Adds a header element only + tt_content_defValues { CType = header - } - } - mod.wizards.newContentElement.wizardItems.common.show := addToList(header) + } + } + mod.wizards.newContentElement.wizardItems.common.show := addToList(header) + +.. _pageexample2: - .. _pageexample2: +Example: Create a new group and add an element to it +---------------------------------------------------- - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - # Create a new group and add a (pre-filled) element to it - mod.wizards.newContentElement.wizardItems.myGroup { - header = LLL:EXT:cms/layout/locallang.xlf:advancedFunctions - elements.customText { + # Create a new group and add a (pre-filled) element to it + mod.wizards.newContentElement.wizardItems.myGroup { + header = LLL:EXT:cms/layout/locallang.xlf:advancedFunctions + elements.customText { iconIdentifier = content-text title = Introductory text for national startpage description = Use this element for all national startpages tt_content_defValues { - CType = text - bodytext ( -

Section Header

-

Lorem ipsum dolor sit amet, consectetur, sadipisci velit ...

- ) - header = Section Header - header_layout = 100 + CType = text + bodytext ( +

Section Header

+

Lorem ipsum dolor sit amet, consectetur, sadipisci velit ...

+ ) + header = Section Header + header_layout = 100 } - } - } - mod.wizards.newContentElement.wizardItems.myGroup.show = customText + } + } + mod.wizards.newContentElement.wizardItems.myGroup.show = customText - With the second example, the bottom of the new content element wizard shows: +With the second example, the bottom of the new content element wizard shows: - .. figure:: /Images/ManualScreenshots/List/PageTsModWizardsNewContentElementExample2.png - :alt: Added entry in the new content element wizard +.. figure:: /Images/ManualScreenshots/List/PageTsModWizardsNewContentElementExample2.png + :alt: Added entry in the new content element wizard - Added entry in the new content element wizard + Added entry in the new content element wizard -.. index:: - Wizards; record - New Record wizard; order -.. _pagewebrecordwizard: +.. index:: + Wizards; record + New Record wizard; order +.. _mod-wizards-newRecord-order: newRecord.order =============== -:aspect:`Datatype` - list of values +.. confval:: newRecord.order + :name: mod-wizards-newRecord-order + :type: list of values + + Define an alternate order for the groups of records in the new records + wizard. Pages and content elements will always be on top, but the + order of other record groups can be changed. -:aspect:`Description` - Define an alternate order for the groups of records in the new records - wizard. Pages and content elements will always be on top, but the - order of other record groups can be changed. + Records are grouped by extension keys, plus the special key "system" + for records provided by the TYPO3 Core. - Records are grouped by extension keys, plus the special key "system" - for records provided by the TYPO3 Core. +.. _mod-wizards-newRecord-order-example: -:aspect:`Example` - Place the tt_news group at the top (after pages and content - elements), other groups follow unchanged: +Example: Place the tt_news group at the top of the new record dialog +-------------------------------------------------------------------- - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Place the tt_news group at the top (after pages and content +elements), other groups follow unchanged: - mod.wizards.newRecord.order = tt_news +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - .. figure:: /Images/ManualScreenshots/List/NewRecordWizardNewOrder.png - :alt: The position of News changed after modifying the New record screen + mod.wizards.newRecord.order = tt_news - The position of News changed after modifying the New record screen +.. figure:: /Images/ManualScreenshots/List/NewRecordWizardNewOrder.png + :alt: The position of News changed after modifying the New record screen + The position of News changed after modifying the New record screen -.. index:: - Wizards; record - New Record wizard; After page button - New Record wizard; Inside page button + +.. index:: + Wizards; record + New Record wizard; After page button + New Record wizard; Inside page button +.. _mod-wizards-newRecord-pages: newRecord.pages =============== -:aspect:`Datatype` - boolean +.. confval:: newRecord.pages + :name: mod-wizards-newRecord-pages + :type: boolean + + Use the following sub-properties to show or hide the specified links. + Setting any of these properties to 0 will hide the corresponding link, + but setting to 1 will leave it visible. + + show.pageAfter + Show or hide the link to create new pages after the selected page. -:aspect:`Description` - Use the following sub-properties to show or hide the specified links. - Setting any of these properties to 0 will hide the corresponding link, - but setting to 1 will leave it visible. + show.pageInside + Show or hide the link to create new pages inside the selected page. - show.pageAfter - Show or hide the link to create new pages after the selected page. + show.pageSelectPosition + Show or hide the link to create new pages at a selected position. - show.pageInside - Show or hide the link to create new pages inside the selected page. +.. _mod-wizards-newRecord-pages-example: - show.pageSelectPosition - Show or hide the link to create new pages at a selected position. +Example: Hide the "Page (inside)" link in the "New Record" dialog +----------------------------------------------------------------- -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - mod.wizards.newRecord.pages.show { - # Hide the "Page (inside)" link. - pageInside = 0 - } + mod.wizards.newRecord.pages.show { + # Hide the "Page (inside)" link. + pageInside = 0 + } - .. figure:: /Images/ManualScreenshots/List/PageTsModWizardsNewRecordHideInside.png - :alt: The modified New record screen without Page (inside) +.. figure:: /Images/ManualScreenshots/List/PageTsModWizardsNewRecordHideInside.png + :alt: The modified New record screen without Page (inside) - The modified new record screen without page (inside) + The modified new record screen without page (inside)