Semantic Plugin

Compatible with DokuWiki

2023-04-04 "Jack Jackrum" yes
2022-07-31 "Igor" yes
2020-07-29 "Hogfather" yes
2018-04-22 "Greebo" yes

Add semantic data to your DokuWiki for SEO

Last updated on: 2023-02-02
Provides: Syntax, Action
Repository: Source

Tagged with dublincore, json-ld, opengraph, schema.org, semantic, seo, webservice

By Giuseppe Di Terlizzi

Installation

Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.

Usage

This plugin add semantic data to your DokuWiki for SEO:

Meta tag Description
Meta tag Author
Dublin Core meta tag
Open Graph protocol meta tag
JSON-LD with Schema.org structured data

This plugin uses this common fields from Schema.org:

Article / NewsArticle / TechArticle / BlogPosting	Description
headline	Title of page
name	Title of page
image	The first image of the page
datePublished	Create date of the page
dateCreated	Create date of the page
dateModified	Last modified date of the page
description	First 500 characters from page
license	DokuWiki license (if applicable)
url	Page URL
creator	The creator user of the page
contributor	All contributing users of the page

Syntax

By default this plugin use the defaultSchemaOrgType configuration for JSON-LD data. If you want to override the default config use this macro in your pages:

Macro	Description
`~~Article~~`	Use Schema.org/Article
`~~NewsArticle~~`	Use Schema.org/NewsArticle
`~~TechArticle~~`	Use Schema.org/TechArticle
`~~BlogPosting~~`	Use Schema.org/BlogPosting
`~~Recipe~~`	Use Schema.org/Recipe
`~~NOSEMANTIC~~`	Disable semantic data for page

Configuration and Settings

The plugin can be configured in the DokuWiki configuration manager available in the admin menu.

Configuration Option	Default Value	Description
`useMetaDescription`	`1`	Add description meta tag
`useMetaAuthor`	`1`	Add author meta tag
`useDublinCore`	`0`	Add Dublin Core meta tag
`useOpenGraph`	`0`	Add Open Graph protocol meta tag
`useJSONLD`	`1`	Add JSON-LD
`defaultSchemaOrgType`	`Article`	Default Schema.org type for JSON-LD (`Article`, `NewsArticle`, `TechArticle`, `BlogPosting`)
`excludedPages`	`(wiki\|playground)`	Excluded pages (insert a regex)
`exposeWebService`	`1`	Expose Ajax WebService
`hideMail`	`0`	Show/Hide email Semantic data (useful for reduce loading of page when using “AuthLDAP/AD” plugin)

AJAX Service

jQuery.post(
  DOKU_BASE + 'lib/exe/ajax.php',
  {
    call : 'plugin_semantic',
    id : ':wiki:syntax'
  }
);

Development

Change Log

Updated plugin.info.txt by giterlizzi (2023-02-03 00:05)
Merge branch 'develop' by giterlizzi (2023-02-03 00:04)
FIX "TypeError: Cannot access offset of type string on string" by giterlizzi (2023-02-03 00:04)
Added trailing slash in @context by giterlizzi (2020-08-25 12:49)
Code beautifications and some little improvments by giterlizzi (2020-08-25 12:13)
Another FIX for Travis CI by giterlizzi (2019-10-08 11:14)
Fixed Travis CI by giterlizzi (2019-10-08 11:10)
Added "hideMail" option for enable/disable email in Semantic data by giterlizzi (2019-10-08 11:07)

Known Bugs and Issues

Please report bugs or feature requests at the Bug tracker.

ToDo/Wish List

FAQ

I would like to be able to manually set the 2 most important SEO indicators: namely the title tag and the meta description. Your plugin takes the first 500 chars from the page which is not really practical for the meta description and quite often the title tag needs to be optimised. Can you add a syntax to the page to allow for these to be added manually please?

Thank you for your great work here, I have one question, should I be able to see the semantic data somewhere in my Doku, or does it all happen in the background after this plugin is loaded? Thank you so much! — John Morris 2016-01-08 17:47
The same question here too. - Florin 2016-02-20

This plugin adds semantic data (structured data) in your DokuWiki pages, to increase the search engine visibility:

* via Standard HTML <meta/> tags (to add Author, Description, etc)
* via Dublin Core metadata Dublin Core
* via JSON-LD with Schema.org metadata (for License, Author, Description, Search, etc)

To see Semantic Plugin in action, use Google Structured Data Testing Tool. This tool analyze your DokuWiki pages and display the structured data added by Semantic Plugin.

In alternative use CTRL+U in your browser to see the source :) Giuseppe Di Terlizzi 2016-02-21

I'm grateful to you for your work. I have one question. Can this plugin add Open Graph image metadata?
If not, I think it is better that become to make first image as OpenGraph image-tag.

　Hi, i have added og:image tag in v2017-05-23 release.
— Giuseppe Di Terlizzi 2017-05-23 16:44

I saw new release. It's good. Thanks you. And I noticed one problem.
It can't refer an external image on top of the page. There is a character entity references matter like thet “&” become “&amp;”.

I don't know what is meant by “AJAX Service”. Has it to be implemented? And what is “exposeWebService”?

Good day, I was curious if there is a way to truncate the hover over information for a linked page? At this point when hovering over a linked page, the hover over brings in a review of the first image which is wonderful, but also the entire text of the page. I'd like to display perhaps the first paragraph, or the first few lines of a page such as a page preview. Thanks! — courtland 2022-09-28 16:55

Discussion