Installation
Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.
Usage
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
- via Open Graph protocol
- 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 :)
This plugin uses this common fields from Schema.org:
| Article / NewsArticle / TechArticle / BlogPosting / Recipe | 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 meta tag |
useJSONLD | 1 | Add JSON-LD |
defaultSchemaOrgType | Article | Default Schema.org type for JSON-LD |
excludedPages | (wiki|playground) | Excluded pages (insert a regex) |
Development
ChangeLog
- 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)
Known Bugs and Issues
Please report bugs or feature requests at the Bug tracker.
Giuseppe Di Terlizzi