Tinymce customization

[stevepiercy]

Closes #1806.

---

📚 Documentation preview 📚: https://plone6--1807.org.readthedocs.build/

[stevepiercy]

Direct link to preview https://plone6--1807.org.readthedocs.build/classic-ui/tinymce-customization.html

[petschki]

@stevepiercy I've changed the order of information and enhanced it:

1. customize formats (with recommended JSON config option and example how to update)
2. remove formats

[stevepiercy]

@petschki I made a few more revisions to better explain why someone should choose one option over another, and turned the .css file option into more of a how-to-guide.

[petschki]

👍🏼

[szakitibi]

Please note following the instructions of Edit the Formats option in the TinyMCE control panel will not add the new item to the "Format" menu. Editing the "Formats" JSON will only add the format to the configurations, but it will be still invisible in the TinyMCE's menu. E.g. "discreet" for classic demo portal is registered as one of the "Formats" in the JSON, but it is nowhere to be found in the TinyMCE menu.

As a last step "Formats" must be registered under one of styles (in the case of "myformat", under "Block styles" of the controlpanel), only then will it pop up in the TinyMCE's menu.

[yurj]

What about

  <records interface="Products.CMFPlone.interfaces.ITinyMCESchema" prefix="plone">
    <value key="other_settings">
      {
        "extended_valid_elements":"i[class],script[type|src]",
        "style_formats": [
          {
            "title": "Highlight",
            "block": "p",
            "attributes": {
              "class": "featured"
            }
          },
          {
            "title": "Alert",
            "block": "p",
            "attributes": {
              "class": "redalert"
            }
          }
        ],
        "style_formats_merge": true
      }
    </value>
  </records>

[petschki]

Beware: other_settings will override all previously made settings. This is meant to inject settings which are not populated in other config fields.

And the style_formats_merge options provides the default "tinymce styles" but that's not exactly the same as the plone default tinymce styles ...

[petschki]

@szakitibi yes you're right. forgot about that. But depending on the format you can also add it to the "Inline formats"

[szakitibi]

@szakitibi yes you're right. forgot about that. But depending on the format you can also add it to the "Inline formats"

Exactly. That is why I used "under one of the styles". The official documentation should be clear about this part, that the registered "formats" can be registered under different styles, and that will determine their position in the TinyMCE menu.

[petschki]

Last but not least there should be a warning, that the provided genericsetup xml will kill the default formats. If those should be preserved, you need to copy them over to your tinymce.xml

[szakitibi]

Also another comment regarding the use of "formats" JSON. I think it is not possible to add top level items (like the highlight-inline) to "Formats" dropdown menu with the available "* styles" configurations. It seems currently only the tinymce-formats.css is able to do that trick.

[stevepiercy]

I would be happy to accept a pull request with revisions to this document. These comments are great, but they won't get into the documentation unless someone who has the technical knowledge writes them up in PR.

I do not have this technical knowledge. I am only a technical writer who translates Plone-ish to English and sprinkles some MyST syntax on top to make it pretty. Thanks for your collaboration.