symphonycms / markdown

Markdown Text Formatter for Symphony CMS

Symphony CMS

• Version: 3.0.0
• Date: 27th March 2020
• Release notes
• Changelog
• Github repository
• MIT Licence

Contents

• Overview
• Server requirements
• Responsible Security Disclosure

Quick links

• Installing
• Updating from LTS
• Contributing
• Documentation TOC

Overview

Symphony is a PHP & MySQL based CMS that utilises XML and XSLT as its core technologies. This repository represents version 3.0.0 and is considered stable.

Useful places:

• The Symphony website
• The Symphony forum
• Symphony Extensions
• DEV chat room
• HELP chat room

Server requirements

• PHP 5.6 or 7.0-7.3
• PHP’s LibXML module, with the XSLT extension enabled (--with-xsl)
• MySQL 5.7 or above is recommended
• A webserver (known to be used with Apache, Litespeed, Nginx and Hiawatha)
• Apache’s mod_rewrite module or equivalent
• PHP’s built in json functions, which are enabled by default in PHP 5.2 and above; if they are missing, ensure PHP wasn’t compiled with --disable-json
• PHP’s zlib module
• PHP’s pdo_mysql module

Responsible Security Disclosure

Please follow the guideline for security bug disclosure.

markdown's Issues

Mark compatibility with Symphony 2.6

I am rather sure that this extension will be compatible with Symphony 2.6.

Correct? If yes, I can send a pull request with new release information in the README.

Tab key changes focus instead of indenting.

I hope I'm submitting this in the correct place. As I use Symphony more and more, I've been running into a lot of trouble with indenting for code blocks in Symphony.

Instead of indenting, the tab key will just change input focus on the page. (Which may be intentional. Accessibility?) But, when writing content with many code blocks it can be quite cumbersome to space indent every single line.

Nonsense results, invalid HTML

The Markdown extension seems to do nonsense, at least since version 1.10 (which is the oldest version that I could test with Symphony 2.3.6).

Using the Markdown formatter and the following input:

<p>Hello</p>
<p>Michael</p>
<p>E.</p>

I get this result:

<p>Hello</p>

<p><p>Michael</p>
<p>E.</p></p>

Using Markdown (With HTML Purifier) and the same input get the following result:

<p>Hello</p>

<p></p><p>Michael</p>
<p>E.</p>

Both is terribly wrong. Markdown shouldn't touch valid HTML.

How can this be?

Fomatted output contains HTML entities instead of XML.

Stuff like <p>instead of proper XML tags.

Where to go from here?

Where shall this extension go from here? Meanwhile PHP Markdown has released version 1.8.0, and the current version of HTML Purifier is 4.10.0. So we may consider one of the following:

1. Update the libraries and keep the rest "as is".
2. Update the libraries and switch to composer.
3. Update PHP Markdown and remove HTML Purifier (has it ever been used by anybody?) – that's a breaking change, so it means a 2.0 release.

The update of PHP Markdown would solve #8 .

Regarding the third option: This has also been discussed in #6.

»Markdown Extra (With SmartyPants)« and PHP 7.4.2

When using the Markdown Extra (With SmartyPants) text formatter and PHP 7.4.2 I get a 503 response from the server when trying to save an entry.

However, I was not able to reproduce the error on a local envirenment using PHP 7.4.1.

CommonMark

You might have already seen this pop up on the interwebs: http://standardmarkdown.com/ http://commonmark.org/

Looks like there is a new markdown flavor in town and it think we should add a new formatter, 'Standard Markdown CommonMark'

I will try to find a valid php implementation, please feel free to have your own suggestions.

Fomatted output contains HTML entities instead of XML.

Stuff like <p>instead of proper XML tags.

Reconsider the inclusion of HTMLPurifier

This is a continuation of the discussion here: http://symphony-cms.com/discuss/thread/63/3/

The inclusion of an external library causes several issues:

1. The extension is subject to an external library's release schedule. Incidentally the version of HTMLPurifier in the current version of the markdown extension is outdated.
2. HTMLPurifier is a generic text filtering library. Including it as a submodule (I am using this term generically and not in terms of git) means other text formatter extensions that want to use the same library will have to include their own version.
3. HTMLPurifier is very large, bigger than Symphony's core itself.

The solution is to abstract HTMLPurifier into an event filter, rather than having this included as part of the extension.