Feature #28325

htmlArea RTE: Deprecate/restructure various RTE configuration properties

Added by Stanislas Rolland about 6 years ago. Updated over 3 years ago.

Status:
Closed
Priority:
Should have
Category:
RTE (rtehtmlarea + ckeditor)
Target version:
-
Start date:
2011-07-20
Due date:
% Done:

100%

PHP Version:
5.3
Tags:
Complexity:
Sprint Focus:

Description

Problem: Configuring the RTE in Page TS Config is difficult. The fact that there are a number of legacy properties, sometimes redundant, maintained mostly for backward compatibility with the pre-TYPO3 4 Classic RTE, makes it even more difficult to understand the overall structure of the configuration object.

Solution: This feature is a first step at simplifying the RTE configuration.

This feature:
1. deprecates various, mostly legacy properties, and restructure some others in order to make the configuration structure more homogeneous;
2. removes any deprecated properties from the default RTE configurations;
3. provides an Install tool upgrade wizard for substituting some of the deprecated properties by their replacement properties and reporting the uid's of pages that specify deprecated properties that could not be replaced by the wizard; the wizard warns that some deprecated properties may be specified in included external files; those will need to be updated by the user;
4. logs to the deprecation log any usage of deprecated properties;
5. allows to disable logging of deprecated properties by setting Page TS Config property RTE.default.logDeprecatedProperties.disabled = 1;
6. allows to optionally log also to the BE log by setting RTE.default.logDeprecatedProperties.logAlsoToBELog = 1

The following Page TS Config RTE properties are deprecated as of TYPO3 4.6 and will be removed in TYPO3 4.8.

Deprecated property -> Use instead
  • disableRightClick -> contextMenu.disable
  • disableContextMenu -> contextMenu.disable
  • hidePStyleItems -> buttons.formatblock.removeItems
  • hideFontFaces -> buttons.fontstyle.removeItems
  • fontFace -> buttons.fontstyle.addItems
  • hideFontSizes -> buttons.fontsize.removeItems
  • fontSize -> buttons.fontsize.addItems
  • classesCharacter -> buttons.textstyle.tags.span.allowedClasses
  • classesParagraph -> buttons.blockstyle.tags.div.allowedClasses
  • classesTable -> buttons.blockstyle.tags.table.allowedClasses
  • classesTD -> buttons.blockstyle.tags.td.allowedClasses
  • classesImage -> buttons.image.properties.class.allowedClasses
  • classesLinks -> buttons.link.properties.class.allowedClasses
  • blindImageOptions -> buttons.image.options.removeItems
  • blindLinkOptions -> buttons.link.options.removeItems
  • defaultLinkTarget -> buttons.link.properties.target.default
  • RTE.default.classesAnchor -> RTE.default.buttons.link.properties.class.allowedClasses
  • RTE.default.classesAnchor.default.[link-type] -> RTE.default.buttons.link.[link-type].properties.class.default
  • mainStyleOverride -> contentCSS
  • mainStyleOverride_add.[key] -> contentCSS
  • mainStyle_font -> contentCSS
  • mainStyle_size -> contentCSS
  • mainStyle_color -> contentCSS
  • mainStyle_bgcolor -> contentCSS
  • inlineStyle.[any-keystring] -> contentCSS
  • ignoreMainStyleOverride -> n.a.
  • disableTYPO3Browsers -> buttons.image.TYPO3Browser.disabled and buttons.link.TYPO3Browser.disabled
  • showTagFreeClasses -> buttons.blockstyle.showTagFreeClasses and buttons.textstyle.showTagFreeClasses
  • disablePCexamples -> buttons.blockstyle.disableStyleOnOptionLabel and buttons.textstyle.disableStyleOnOptionLabel

Related issues

Related to Core - Feature #16484: replace classesXXX. with classes.XXX Resolved 2006-08-22
Related to Core - Bug #28593: Upgrade Wizard "Deprecated RTE properties in Page TS Config" fails if no deprecated properties are used at all. Closed 2011-07-30
Related to Core - Bug #28597: Upgrade wizard "finds" deprecated properties, which are not there Closed 2011-07-30
Related to Core - Bug #28600: Small improvements for the Upgrade Wizard Closed 2011-07-31

Associated revisions

Revision 7c9d0a72 (diff)
Added by Stanislas Rolland about 6 years ago

[FEATURE][!!!][CONF] Deprecate various RTE configuration properties

This feature is a first step at simplifying the RTE configuration.

  • Deprecate various, mostly legacy properties, and restructure
    some others in order to make the configuration structure more
    homogeneous.
  • Remove any deprecated properties from the default RTE
    configurations.
  • Provide an Install tool upgrade wizard for substituting some
    of the deprecated properties by their replacement properties and
    reporting the uid's of pages that specify deprecated properties
    that could not be replaced by the wizard; the wizard warns that
    some deprecated properties may be specified in included external
    files; those will need to be updated by the user.
  • Log to the deprecation log any usage of deprecated properties. Allow to
    disable logging of deprecated properties by setting Page
    TS Config property RTE.default.logDeprecatedProperties.disabled = 1.
    Allow to optionally log also to the BE log by setting
    RTE.default.logDeprecatedProperties.logAlsoToBELog = 1.

Change-Id: I3992d308702500ea39a2e7944eea687150995791
Resolves: #28325
Releases: 4.6
Reviewed-on: http://review.typo3.org/3425
Reviewed-by: Stanislas Rolland
Tested-by: Stanislas Rolland
Reviewed-by: Georg Ringer

History

#1 Updated by Mr. Hudson about 6 years ago

Patch set 1 of change I3992d308702500ea39a2e7944eea687150995791 has been pushed to the review server.
It is available at http://review.typo3.org/3425

#2 Updated by Mr. Hudson about 6 years ago

Patch set 2 of change I3992d308702500ea39a2e7944eea687150995791 has been pushed to the review server.
It is available at http://review.typo3.org/3425

#3 Updated by Mr. Hudson about 6 years ago

Patch set 3 of change I3992d308702500ea39a2e7944eea687150995791 has been pushed to the review server.
It is available at http://review.typo3.org/3425

#4 Updated by Stanislas Rolland about 6 years ago

The BE log is used rather than the deprecation log, because this is a site admin issue rather than a developer issue.

#5 Updated by Mr. Hudson about 6 years ago

Patch set 4 of change I3992d308702500ea39a2e7944eea687150995791 has been pushed to the review server.
It is available at http://review.typo3.org/3425

#6 Updated by Stanislas Rolland about 6 years ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100

#7 Updated by Xavier Perseguers over 5 years ago

  • Status changed from Resolved to Closed

#8 Updated by Ernesto Baschny over 4 years ago

  • Target version deleted (4.6.0-beta1)

Also available in: Atom PDF