| Next revision | Previous revision |
| wiki:plugin:semantic [2015/04/01 17:26] – creata Giuseppe Di Terlizzi | wiki:plugin:semantic [2016/12/13 00:17] (current) – Giuseppe Di Terlizzi |
|---|
| | <jumbotron> |
| ====== Semantic Plugin ====== | ====== Semantic Plugin ====== |
| |
| For more information see [[doku>:plugin:semantic|Plugin Semantic]] page on [[http://dokuwiki.org|DokuWiki.org]]! | For more information see [[doku>:plugin:semantic|Plugin Semantic]] page on [[http://dokuwiki.org|DokuWiki.org]]! |
| | |
| | \\ |
| | \\ |
| | |
| | <btn type="success" icon="fa fa-download">[[https://github.com/LotarProject/dokuwiki-plugin-semantic/zipball/master|Download]]</btn> <btn type="default" icon="fa fa-bug">[[https://github.com/LotarProject/dokuwiki-plugin-semantic/issues|Bug tracker]]</btn> <btn type="default" icon="fa fa-paypal">[[https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9LJDLVSNGYSA2|Donate]]</btn> |
| | </jumbotron> |
| | |
| | ===== Installation ===== |
| | |
| | Install the plugin using the [[doku>plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[doku>plugins|Plugins]] on how to install plugins manually. |
| |
| ===== Usage ===== | ===== Usage ===== |
| |
| This plugin add semantic data to your DokuWiki: | This plugin adds semantic data (structured data) in your DokuWiki pages, to increase the search engine visibility: |
| | |
| | * via Standard HTML ''<nowiki><meta/></nowiki>'' tags (to add Author, Description, etc) |
| | * via [[wp>Dublin_Core|Dublin Core]] metadata |
| | * via [[wp>Open_Graph|Open Graph]] protocol |
| | * via [[wp>JSON-LD]] with [[http://schema.org/|Schema.org]] metadata (for License, Author, Description, Search, etc) |
| | |
| | To see Semantic Plugin in action, use [[https://developers.google.com/structured-data/testing-tool/|Google Structured Data Testing Tool]]. This tool analyze your DokuWiki pages and display the structured data added by Semantic Plugin. |
| |
| * Meta tag Description | In alternative use CTRL+U in your browser to see the source :) |
| * Meta tag Author | |
| * JSON-LD with Schema.org structured data | |
| |
| This plugin uses this common fields from Schema.org: | This plugin uses this common fields from Schema.org: |
| |
| ^ Article / NewsArticle / \\ TechArticle / BlogPosting ^ Description ^ | ^ Article / NewsArticle / \\ TechArticle / BlogPosting \\ / Recipe ^ Description ^ |
| ^ headline | Title of page | | ^ headline | Title of page | |
| ^ name | Title of page | | ^ name | Title of page | |
| ===== Syntax ===== | ===== Syntax ===== |
| |
| By default this plugin use the ''defaultSchemaOrgType'' configuration for JSON-LD data. If you want override the default config use this macro in your pages: | 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 ^ | ^ Macro ^ Description ^ |
| ^ ''<nowiki>~~Article~~</nowiki>'' | Use [[http://Schema.org/Article|Schema.org/Article]] | | ^ ''<nowiki>~~Article~~</nowiki>'' | Use [[http://Schema.org/Article|Schema.org/Article]] | |
| ^ ''<nowiki>~~NewsArticle~~</nowiki>'' | Use [[http://Schema.org/NewsArticle|Schema.org/NewsArticle]] | | ^ ''<nowiki>~~NewsArticle~~</nowiki>'' | Use [[http://Schema.org/NewsArticle|Schema.org/NewsArticle]] | |
| ^ ''<nowiki>~~TechArticle~~</nowiki>'' | Use [[http://Schema.org/TechArticle|Schema.org/TechArticle]] | | ^ ''<nowiki>~~TechArticle~~</nowiki>'' | Use [[http://Schema.org/TechArticle|Schema.org/TechArticle]] | |
| ^ ''<nowiki>~~BlogPosting~~</nowiki>'' | Use [[http://Schema.org/BlogPosting|Schema.org/BlogPosting]] | | ^ ''<nowiki>~~BlogPosting~~</nowiki>'' | Use [[http://Schema.org/BlogPosting|Schema.org/BlogPosting]] | |
| | ^ ''<nowiki>~~Recipe~~</nowiki>'' | Use [[http://Schema.org/Recipe|Schema.org/Recipe]] | |
| ^ ''<nowiki>~~NOSEMANTIC~~</nowiki>'' | Disable semantic data for page | | ^ ''<nowiki>~~NOSEMANTIC~~</nowiki>'' | Disable semantic data for page | |
| |
| ^ ''useMetaDescription'' | ''1'' | Add description meta tag | | ^ ''useMetaDescription'' | ''1'' | Add description meta tag | |
| ^ ''useMetaAuthor'' | ''1'' | Add author 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 | | ^ ''useJSONLD'' | ''1'' | Add JSON-LD | |
| ^ ''defaultSchemaOrgType'' | ''Article'' | Default Schema.org type for JSON-LD | | ^ ''defaultSchemaOrgType'' | ''Article'' | Default Schema.org type for JSON-LD | |
| ^ ''excludedPages'' | ''(wiki|playground)'' | Excluded pages (insert a regex) | | ^ ''excludedPages'' | ''(wiki|playground)'' | Excluded pages (insert a regex) | |
| |
| | ===== Development ===== |
| | |
| | [[https://travis-ci.org/LotarProject/dokuwiki-plugin-semantic|{{ https://travis-ci.org/LotarProject/dokuwiki-plugin-datatables.png?nocache|Build Status}}]] |
| | |
| | === ChangeLog === |
| | |
| | {{rss>http://lotar.altervista.org/feed-wrapper.php?feed=https%3A%2F%2Fgithub.com%2FLotarProject%2Fdokuwiki-plugin-semantic%2Fcommits%2Fmaster.atom 5 author date 1h }} |
| | |
| | === Known Bugs and Issues === |
| | |
| | Please report bugs or feature requests at the [[https://github.com/LotarProject/dokuwiki-plugin-semantic/issues|Bug tracker]]. |
| |
| {{tag>dokuwiki plugin}} | {{tag>dokuwiki plugin}} |
Giuseppe Di Terlizzi