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:
$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
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.
*
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']);
}
// 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']);
}
}
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.
*
{
// 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;
}
/**
* Test sanitize_html().
*/
- function testSanitizeHtml() {
+ function testSanitizeHtml()
+ {
$input = '< script src="js.js"/>';
$input .= '< script attr>alert(\'xss\');</script>';
$input .= '<style> * { display: none }</style>';
$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']);
+ }
}