From 3ce20d9e84a715c6890988999a8ecac210a42d9c Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Mon, 21 Mar 2016 18:46:34 +0100 Subject: Markdown: Add the 'meta-tag' `.nomarkdown` which prevent a shaare from being parsed with markdown Also add the tag in tag list in edit_link, so it will appear on autocompletion. --- plugins/markdown/markdown.php | 30 +++++++++++++++++++++++++++++ tests/plugins/PluginMarkdownTest.php | 37 +++++++++++++++++++++++++++++++++++- 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/plugins/markdown/markdown.php b/plugins/markdown/markdown.php index 5a702c7b..544ed22e 100644 --- a/plugins/markdown/markdown.php +++ b/plugins/markdown/markdown.php @@ -8,6 +8,12 @@ require_once 'Parsedown.php'; +/* + * If this tag is used on a shaare, the description won't be processed by Parsedown. + * Using a private tag so it won't appear for visitors. + */ +define('NO_MD_TAG', '.nomarkdown'); + /** * Parse linklist descriptions. * @@ -18,6 +24,9 @@ require_once 'Parsedown.php'; function hook_markdown_render_linklist($data) { foreach ($data['links'] as &$value) { + if (!empty($value['tags']) && noMarkdownTag($value['tags'])) { + continue; + } $value['description'] = process_markdown($value['description']); } @@ -36,6 +45,9 @@ function hook_markdown_render_daily($data) // Manipulate columns data foreach ($data['cols'] as &$value) { foreach ($value as &$value2) { + if (!empty($value2['tags']) && noMarkdownTag($value2['tags'])) { + continue; + } $value2['formatedDescription'] = process_markdown($value2['formatedDescription']); } } @@ -43,6 +55,18 @@ function hook_markdown_render_daily($data) return $data; } +/** + * Check if noMarkdown is set in tags. + * + * @param string $tags tag list + * + * @return bool true if markdown should be disabled on this link. + */ +function noMarkdownTag($tags) +{ + return strpos($tags, NO_MD_TAG) !== false; +} + /** * When link list is displayed, include markdown CSS. * @@ -75,6 +99,12 @@ function hook_markdown_render_editlink($data) { // Load help HTML into a string $data['edit_link_plugin'][] = file_get_contents(PluginManager::$PLUGINS_PATH .'/markdown/help.html'); + + // Add no markdown 'meta-tag' in tag list if it was never used, for autocompletion. + if (! in_array(NO_MD_TAG, $data['tags'])) { + $data['tags'][NO_MD_TAG] = 0; + } + return $data; } diff --git a/tests/plugins/PluginMarkdownTest.php b/tests/plugins/PluginMarkdownTest.php index 8e1a128a..fa7e1d52 100644 --- a/tests/plugins/PluginMarkdownTest.php +++ b/tests/plugins/PluginMarkdownTest.php @@ -102,7 +102,8 @@ class PluginMarkdownTest extends PHPUnit_Framework_TestCase /** * Test sanitize_html(). */ - function testSanitizeHtml() { + function testSanitizeHtml() + { $input = '< script src="js.js"/>'; $input .= '< script attr>alert(\'xss\');'; $input .= ''; @@ -114,4 +115,38 @@ class PluginMarkdownTest extends PHPUnit_Framework_TestCase $input = escape($input); $this->assertEquals($input, sanitize_html($input)); } + + /** + * Test the no markdown tag. + */ + function testNoMarkdownTag() + { + $str = 'All _work_ and `no play` makes Jack a *dull* boy.'; + $data = array( + 'links' => array(array( + 'description' => $str, + 'tags' => NO_MD_TAG + )) + ); + + $data = hook_markdown_render_linklist($data); + $this->assertEquals($str, $data['links'][0]['description']); + + $data = array( + // Columns data + 'cols' => array( + // First, second, third. + 0 => array( + // nth link + 0 => array( + 'formatedDescription' => $str, + 'tags' => NO_MD_TAG + ), + ), + ), + ); + + $data = hook_markdown_render_daily($data); + $this->assertEquals($str, $data['cols'][0][0]['formatedDescription']); + } } -- cgit v1.2.3 From 340252ae5de67f46ad43793858532da0cce8b4e2 Mon Sep 17 00:00:00 2001 From: ArthurHoaro Date: Sat, 26 Mar 2016 16:43:14 +0100 Subject: Update markdown plugin README documentation * Add the `.nomarkdown` section. * Update misleading statements. --- plugins/markdown/README.md | 34 +++++++++++++++++++++++----------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/plugins/markdown/README.md b/plugins/markdown/README.md index defaacd1..4f021871 100644 --- a/plugins/markdown/README.md +++ b/plugins/markdown/README.md @@ -2,25 +2,31 @@ Convert all your shaares description to HTML formatted Markdown. -Read more about Markdown syntax here. +[Read more about Markdown syntax](http://daringfireball.net/projects/markdown/syntax). + +Markdown processing is done with [Parsedown library](https://github.com/erusev/parsedown). ### Installation -Clone this repository inside your `tpl/plugins/` directory, or download the archive and unpack it there. +As a default plugin, it should already be in `tpl/plugins/` directory. +If not, download and unpack it there. + The directory structure should look like: ``` -??? plugins -    ??? markdown - ??? help.html - ??? markdown.css - ??? markdown.meta - ??? markdown.php - ??? Parsedown.php -    ??? README.md +--- plugins + |--- markdown + |--- help.html + |--- markdown.css + |--- markdown.meta + |--- markdown.php + |--- Parsedown.php + |--- README.md ``` -To enable the plugin, add `markdown` to your list of enabled plugins in `data/config.php` +To enable the plugin, just check it in the plugin administration page. + +You can also add `markdown` to your list of enabled plugins in `data/config.php` (`ENABLED_PLUGINS` array). This should look like: @@ -29,6 +35,12 @@ This should look like: $GLOBALS['config']['ENABLED_PLUGINS'] = array('qrcode', 'any_other_plugin', 'markdown') ``` +### No Markdown tag + +If the tag `.nomarkdown` is set for a shaare, it won't be converted to Markdown syntax. + +> Note: it's a private tag (leading dot), so it won't be displayed to visitors. + ### Known issue #### Redirector -- cgit v1.2.3