Added ~~Recipe~~ macro (thanks to @coastgnu on #1 issue) and several improvements
This commit is contained in:
Giuseppe Di Terlizzi
parent
95f02e1bff
commit
77f2311ffe
4 changed files with 206 additions and 199 deletions
334
action.php
334
action.php
|
|
@ -1,9 +1,9 @@
|
|||
<?php
|
||||
/**
|
||||
* Semantic Action Plugin
|
||||
*
|
||||
*
|
||||
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
|
||||
* @author Giuseppe Di Terlizzi <giuseppe.diterlizzi>
|
||||
* @author Giuseppe Di Terlizzi <giuseppe.diterlizzi@gmail.com>
|
||||
* @copyright (C) 2015, Giuseppe Di Terlizzi
|
||||
*/
|
||||
|
||||
|
|
@ -16,202 +16,202 @@ if(!defined('DOKU_INC')) die();
|
|||
* Add semantic data to DokuWiki
|
||||
*/
|
||||
class action_plugin_semantic extends DokuWiki_Action_Plugin {
|
||||
|
||||
/**
|
||||
* Register events
|
||||
*
|
||||
* @param Doku_Event_Handler $controller
|
||||
*/
|
||||
public function register(Doku_Event_Handler $controller) {
|
||||
|
||||
if ($this->getConf('useJSONLD')) {
|
||||
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'json_ld');
|
||||
}
|
||||
|
||||
if ($this->getConf('useMetaDescription')) {
|
||||
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'meta_description');
|
||||
}
|
||||
|
||||
if ($this->getConf('useMetaAuthor')) {
|
||||
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'meta_author');
|
||||
}
|
||||
/**
|
||||
* Register events
|
||||
*
|
||||
* @param Doku_Event_Handler $controller
|
||||
*/
|
||||
public function register(Doku_Event_Handler $controller) {
|
||||
|
||||
if ($this->getConf('useJSONLD')) {
|
||||
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'json_ld');
|
||||
}
|
||||
|
||||
/**
|
||||
* JSON-LD Event handler
|
||||
*
|
||||
* @param Doku_Event &$event
|
||||
*/
|
||||
public function json_ld(Doku_Event &$event, $param) {
|
||||
|
||||
global $INFO;
|
||||
global $ID;
|
||||
if ($this->getConf('useMetaDescription')) {
|
||||
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'meta_description');
|
||||
}
|
||||
|
||||
if ((bool) preg_match_all('/'.$this->getConf('excludedPages').'/', $ID)) {
|
||||
return false;
|
||||
if ($this->getConf('useMetaAuthor')) {
|
||||
$controller->register_hook('TPL_METAHEADER_OUTPUT', 'BEFORE', $this, 'meta_author');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* JSON-LD Event handler
|
||||
*
|
||||
* @param Doku_Event &$event
|
||||
*/
|
||||
public function json_ld(Doku_Event &$event, $param) {
|
||||
|
||||
global $INFO;
|
||||
global $ID;
|
||||
|
||||
if ((bool) preg_match('/'.$this->getConf('excludedPages').'/', $ID)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (! $INFO['perm']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
global $license;
|
||||
global $auth;
|
||||
global $conf;
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
|
||||
if (isset($meta['semantic']['enabled']) && ! $meta['semantic']['enabled']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (isset($meta['date']) && $meta['date'] !== '') {
|
||||
|
||||
$type = ((isset($meta['semantic']['schema.org']['type']))
|
||||
? $meta['semantic']['schema.org']['type']
|
||||
: $this->getConf('defaultSchemaOrgType'));
|
||||
$user_data = $auth->getUserData($meta['user']);
|
||||
$license_url = @$license[$conf['license']]['url'];
|
||||
$page_url = wl($ID, '', true);
|
||||
$image_url = (($meta['relation']['firstimage']) ? ml($meta['relation']['firstimage'], '', true, '&', true) : null);
|
||||
$description = trim(ltrim($meta['description']['abstract'], @$meta['title']));
|
||||
$created = date(DATE_W3C, $meta['date']['created']);
|
||||
$modified = date(DATE_W3C, $meta['date']['modified']);
|
||||
|
||||
$json_ld = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => $type,
|
||||
'headline' => @$meta['title'],
|
||||
'name' => @$meta['title'],
|
||||
'image' => array($image_url),
|
||||
'datePublished' => $created,
|
||||
'dateCreated' => $created,
|
||||
'dateModified' => $modified,
|
||||
'description' => $description,
|
||||
'license' => $license_url,
|
||||
'url' => $page_url,
|
||||
);
|
||||
|
||||
if (isset($meta['creator']) && $meta['creator'] !== '') {
|
||||
|
||||
$json_ld['creator'] = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => 'Person',
|
||||
'name' => $meta['creator'],
|
||||
'email' => $user_data['mail']
|
||||
);
|
||||
|
||||
if (isset($meta['contributor'])) {
|
||||
foreach ($meta['contributor'] as $uid => $fullname) {
|
||||
$contributor_data = $auth->getUserData($uid);
|
||||
$json_ld['contributor'][] = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => 'Person',
|
||||
'name' => $fullname,
|
||||
'email' => $contributor_data['mail']
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
if ($INFO['perm'] > 0) {
|
||||
}
|
||||
|
||||
global $license;
|
||||
global $auth;
|
||||
global $conf;
|
||||
if (isset($meta['relation']['references'])) {
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
$json_ld_webpage = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => 'WebPage'
|
||||
);
|
||||
|
||||
if (isset($meta['semantic']['enabled']) && ! $meta['semantic']['enabled']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (isset($meta['date']) && $meta['date'] !== '') {
|
||||
|
||||
$type = ((isset($meta['semantic']['schema.org']['type']))
|
||||
? $meta['semantic']['schema.org']['type']
|
||||
: $this->getConf('defaultSchemaOrgType'));
|
||||
$user_data = $auth->getUserData($meta['user']);
|
||||
$license_url = $license[$conf['license']]['url'];
|
||||
$page_url = wl($ID, '', true);
|
||||
$image_url = (($meta['relation']['firstimage']) ? ml($meta['relation']['firstimage'], '', true, '&', true) : null);
|
||||
$description = trim(ltrim($meta['description']['abstract'], $meta['title']));
|
||||
$created = date(DATE_W3C, $meta['date']['created']);
|
||||
$modified = date(DATE_W3C, $meta['date']['modified']);
|
||||
|
||||
$json_ld = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => $type,
|
||||
'headline' => $meta['title'],
|
||||
'name' => $meta['title'],
|
||||
'image' => array($image_url),
|
||||
'datePublished' => $created,
|
||||
'dateCreated' => $created,
|
||||
'dateModified' => $modified,
|
||||
'description' => $description,
|
||||
'license' => $license_url,
|
||||
'url' => $page_url,
|
||||
);
|
||||
|
||||
if (isset($meta['creator']) && $meta['creator'] !== '') {
|
||||
$json_ld['creator'] = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => 'Person',
|
||||
'name' => $meta['creator'],
|
||||
'email' => $user_data['mail']
|
||||
);
|
||||
|
||||
if (isset($meta['contributor'])) {
|
||||
foreach ($meta['contributor'] as $uid => $fullname) {
|
||||
$contributor_data = $auth->getUserData($uid);
|
||||
$json_ld['contributor'][] = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => 'Person',
|
||||
'name' => $fullname,
|
||||
'email' => $contributor_data['mail']
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if (isset($meta['relation']['references'])) {
|
||||
|
||||
$json_ld_webpage = array(
|
||||
'@context' => 'http://schema.org',
|
||||
'@type' => 'WebPage'
|
||||
);
|
||||
|
||||
foreach ($meta['relation']['references'] as $page => $status) {
|
||||
if ($status) {
|
||||
$json_ld_webpage['relatedLink'][] = wl($page, '', true);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($json_ld_webpage['relatedLink'])) {
|
||||
|
||||
$event->data["script"][] = array (
|
||||
"type" => "application/ld+json",
|
||||
"_data" => json_encode($json_ld_webpage),
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
$event->data["script"][] = array (
|
||||
"type" => "application/ld+json",
|
||||
"_data" => json_encode($json_ld),
|
||||
);
|
||||
|
||||
}
|
||||
foreach ($meta['relation']['references'] as $page => $status) {
|
||||
if ($status) {
|
||||
$json_ld_webpage['relatedLink'][] = wl($page, '', true);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($json_ld_webpage['relatedLink'])) {
|
||||
|
||||
$event->data["script"][] = array (
|
||||
"type" => "application/ld+json",
|
||||
"_data" => json_encode($json_ld_webpage),
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
$event->data["script"][] = array (
|
||||
"type" => "application/ld+json",
|
||||
"_data" => json_encode($json_ld),
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public function meta_description(Doku_Event &$event, $params) {
|
||||
|
||||
global $INFO;
|
||||
global $ID;
|
||||
public function meta_description(Doku_Event &$event, $params) {
|
||||
|
||||
if ((bool) preg_match_all('/'.$this->getConf('excludedPages').'/', $ID)) {
|
||||
return false;
|
||||
}
|
||||
global $INFO;
|
||||
global $ID;
|
||||
|
||||
if ($INFO['perm'] > 0) {
|
||||
if ((bool) preg_match_all('/'.$this->getConf('excludedPages').'/', $ID)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
if (! $INFO['perm']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (isset($meta['semantic']['enabled']) && ! $meta['semantic']['enabled']) {
|
||||
return false;
|
||||
}
|
||||
$meta = $INFO['meta'];
|
||||
|
||||
if (isset($meta['date']) && $meta['date'] !== '') {
|
||||
|
||||
$description = str_replace("\n", ' ', trim(ltrim($meta['description']['abstract'], $meta['title'])));
|
||||
if (isset($meta['semantic']['enabled']) && ! $meta['semantic']['enabled']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$event->data['meta'][] = array(
|
||||
'name' => 'description',
|
||||
'content' => $description,
|
||||
);
|
||||
if (isset($meta['date']) && $meta['date'] !== '') {
|
||||
|
||||
}
|
||||
$description = str_replace("\n", ' ', trim(ltrim($meta['description']['abstract'], @$meta['title'])));
|
||||
|
||||
}
|
||||
$event->data['meta'][] = array(
|
||||
'name' => 'description',
|
||||
'content' => $description,
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
public function meta_author(Doku_Event &$event, $params) {
|
||||
|
||||
global $INFO;
|
||||
global $ID;
|
||||
public function meta_author(Doku_Event &$event, $params) {
|
||||
|
||||
if ((bool) preg_match_all('/'.$this->getConf('excludedPages').'/', $ID)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ($INFO['perm'] > 0) {
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
|
||||
if (isset($meta['semantic']['enabled']) && ! $meta['semantic']['enabled']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ((isset($meta['date']) && $meta['date'] !== '')) {
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
|
||||
$event->data['meta'][] = array(
|
||||
'name' => 'author',
|
||||
'content' => $meta['creator'],
|
||||
);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
global $INFO;
|
||||
global $ID;
|
||||
|
||||
if ((bool) preg_match_all('/'.$this->getConf('excludedPages').'/', $ID)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (! $INFO['perm']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
|
||||
if (isset($meta['semantic']['enabled']) && ! $meta['semantic']['enabled']) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if ((isset($meta['date']) && $meta['date'] !== '')) {
|
||||
|
||||
$meta = $INFO['meta'];
|
||||
|
||||
$event->data['meta'][] = array(
|
||||
'name' => 'author',
|
||||
'content' => $meta['creator'],
|
||||
);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,5 @@
|
|||
$meta['useMetaDescription'] = array('onoff');
|
||||
$meta['useMetaAuthor'] = array('onoff');
|
||||
$meta['useJSONLD'] = array('onoff');
|
||||
$meta['defaultSchemaOrgType'] = array('multichoice','_choices' => array('Article', 'NewsArticle', 'TechArticle', 'BlogPosting'));
|
||||
$meta['defaultSchemaOrgType'] = array('multichoice','_choices' => array('Article', 'NewsArticle', 'TechArticle', 'BlogPosting', 'Recipe'));
|
||||
$meta['excludedPages'] = array('regex');
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
base semantic
|
||||
author Giuseppe Di Terlizzi
|
||||
email giuseppe.diterlizzi@gmail.com
|
||||
date 2015-03-30
|
||||
date 2015-10-30
|
||||
name Semantic Plugin
|
||||
desc Add Semantic Data in Dokuwiki
|
||||
desc Add Semantic Data in DokuWiki
|
||||
url http://www.dokuwiki.org/plugin:semantic
|
||||
|
|
|
|||
64
syntax.php
64
syntax.php
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* Semantic plugin: Add Schema.org News Article using JSON-LD
|
||||
*
|
||||
*
|
||||
* @license GPL 2 (http://www.gnu.org/licenses/gpl.html)
|
||||
* @author Giuseppe Di Terlizzi <giuseppe.diterlizzi@gmail.com>
|
||||
*/
|
||||
|
|
@ -12,37 +12,45 @@ if (!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
|
|||
|
||||
class syntax_plugin_semantic extends DokuWiki_Syntax_Plugin {
|
||||
|
||||
function getType() { return 'substition'; }
|
||||
function getSort() { return 99; }
|
||||
private $macros = array(
|
||||
'~~NewsArticle~~', '~~Article~~', '~~TechArticle~~',
|
||||
'~~BlogPosting~~', '~~Recipe~~', '~~NOSEMANTIC~~'
|
||||
);
|
||||
|
||||
function connectTo($mode) {
|
||||
$this->Lexer->addSpecialPattern('~~NewsArticle~~', $mode, 'plugin_semantic');
|
||||
$this->Lexer->addSpecialPattern('~~Article~~', $mode, 'plugin_semantic');
|
||||
$this->Lexer->addSpecialPattern('~~TechArticle~~', $mode, 'plugin_semantic');
|
||||
$this->Lexer->addSpecialPattern('~~BlogPosting~~', $mode, 'plugin_semantic');
|
||||
$this->Lexer->addSpecialPattern('~~NOSEMANTIC~~', $mode, 'plugin_semantic');
|
||||
function getType() { return 'substition'; }
|
||||
function getSort() { return 99; }
|
||||
|
||||
function connectTo($mode) {
|
||||
|
||||
foreach ($this->macros as $macro) {
|
||||
$this->Lexer->addSpecialPattern($macro, $mode, 'plugin_semantic');
|
||||
}
|
||||
|
||||
function handle($match, $state, $pos, Doku_Handler $handler) {
|
||||
return array($match, $state, $pos);
|
||||
}
|
||||
|
||||
function handle($match, $state, $pos, Doku_Handler $handler) {
|
||||
return array($match, $state, $pos);
|
||||
}
|
||||
|
||||
function render($mode, Doku_Renderer $renderer, $data) {
|
||||
|
||||
if ($mode == 'xthml') {
|
||||
return true; // don't output anything
|
||||
} elseif ($mode == 'metadata') {
|
||||
|
||||
list($match, $state, $pos) = $data;
|
||||
|
||||
|
||||
|
||||
if ($match == '~~NOSEMANTIC~~') {
|
||||
$renderer->meta['semantic']['enabled'] = false;
|
||||
} else {
|
||||
$renderer->meta['semantic']['schema.org']['type'] = trim(str_replace('Schema.org/', '', $match), '~~');
|
||||
$renderer->meta['semantic']['enabled'] = true;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
function render($mode, Doku_Renderer $renderer, $data) {
|
||||
|
||||
if ($mode == 'xthml') {
|
||||
return true; // don't output anything
|
||||
} elseif ($mode == 'metadata') {
|
||||
|
||||
list($match, $state, $pos) = $data;
|
||||
|
||||
if ($match == '~~NOSEMANTIC~~') {
|
||||
$renderer->meta['semantic']['enabled'] = false;
|
||||
} else {
|
||||
$renderer->meta['semantic']['schema.org']['type'] = trim(str_replace('Schema.org/', '', $match), '~~');
|
||||
$renderer->meta['semantic']['enabled'] = true;
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in a new issue