PLIP: Better default options for markup mime types

[thet]

PLIP: Better default options for markup mime types.

Responsible Persons

Proposer: Johannes Raggam

Seconder: none of yet.

Abstract

Plone supports different markup languages for it's richtext fields. Per default, text/html and text/x-web-textile are configured. We should use different defaults to reflect the popularity of markup languages better, remove obsolete mime types from that list and translate the list of mime types to somethin a editor better understands.

Motivation

Provide sensible default options for the markup selection and display them in an user friendly way.

Assumptions

The markup mime types text/structured and text/x-web-textile are rarely used. The mime types text/restructured is an alias for text/x-rst and can safely removed, text/python is an alias fro rst or structured, plain-pre can be replaced with x-web-intelligent.

Proposal & Implementation

• Remove obsolete markup option entries:

  • text/restructured (redundant with text/x-rst, which is the recommendet mime type. See http://docutils.sourceforge.net/FAQ.html#what-s-the-official-mime-type-for-restructuredtext-data . Upgrade step necessary)
  • text/x-web-markdown (Since 2016 there is a RFC adding text/markdown https://tools.ietf.org/html/rfc7763 )
  • text/x-python (what is that anyways?)
  • Eventually text/plain-pre (Upgrade existing to text/x-web-intelligent)

• Provide the following markup options only, if Plone is installed with the necessary parsers via setup.py extra requirements:

  • text/structured
  • text/x-web-textile

• Change default markup options to:

  • text/html
  • text/x-web-intelligent
  • text/markdown
  • eventually text/x-rst.

• Translate entries for easier reading:

  • text/html: HTML
  • text/plain Plain Text
  • text/x-rst ReStructured Text
  • text/x-web-intelligent: Preformatted Plain Text
  • text/x-markdown: Markdown

• Provide upgrade steps for text/x-rst and text/plain-pre texts.

Deliverables

• Provide default mimetype entries in registry.xml and remove defaul registration elsewhere (looks like the defaults come from Products.MimetypesRegistry)
• Remove support for obsolete markup entries.
• Add setup.py extra requirements in CMFPlone for rarely used mimetypes.
• Add mimetype entry translations in plone.app.locales
• Provide upgrade steps for removed mime types.

Risks

• Existing installations which depend on lesser used mime types need to depend on the setup.py extra requirement.
• The defaults for existing installations are not changed.

Participants

• Johannes Raggam
• If you can/want to help out, drop me a note.

Related

https://github.com/plone/Products.CMFPlone/issues/3016

References

https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Complete_list_of_MIME_types http://www.iana.org/assignments/media-types/media-types.xhtml

[thet]

Changed:

• Replaced text/x-web-markdown with text/markdown
• Removed mime type from proposed translations.