https://docs.sandbox.joomla.org/api.php?action=feedcontributions&feedformat=atom&user=P.AlexJoomla! Documentation - User contributions [en]2026-07-09T23:46:19ZUser contributionsMediaWiki 1.43.0https://docs.sandbox.joomla.org/index.php?title=Using_own_library_in_your_extensions&diff=122256Using own library in your extensions2014-07-15T08:15:46Z<p>P.Alex: </p>
<hr />
<div>{{version/tutor|2.5,3.1}}<br />
There are several approaches how to register your own library with Joomla's autoloader and then use it in your extension. All these approaches are based on the <code>JLoader</code> class. For this tutorial we consider that your library is located in the '''/libraries/mylib''' folder.<br />
<br />
== Discovering Classes ==<br />
Classes in a folder that follow a naming convention can be registered collectively with JLoader's [http://api.joomla.org/cms-2.5/classes/JLoader.html#method_discover discover()] method. The discover method looks at the file names in a folder and registers classes based on those names. Additional arguments can be used to update the class register and recurse into sub-folders.<br />
<source lang="php"><br />
// Register all files in the /libraries/mylib folder as classes with a name like: MyLib<Filename><br />
JLoader::discover('Mylib', JPATH_LIBRARIES . '/mylib');<br />
</source><br />
<br />
As you can see this method is working if you follow special naming convention:<br />
* <code>/mylib/user.php</code> will be equal to <code>MylibUser</code><br />
* <code>/mylib/userhelper.php</code> will be equal to <code>MylibUserHelper</code><br />
<br />
== The Prefix Loader ==<br />
Since Joomla Platform 12.1 (Joomla! CMS 3+), there is the ability to register where the auto-loader will look based on a class prefix (previously only the "J" prefix was supported, bound to the /libraries/joomla folder). This is done with the [http://api.joomla.org/Joomla-Platform/JLoader.html#registerPrefix registerPrefix()] method and allows for several scenarios:<br />
<br />
* A developer can register the prefix of custom classes, and a root path to allow the auto-loader to find them.<br />
* A developer can register an extra path for an existing prefix (for example, this allows the Joomla CMS to have custom libraries but still using the "J" prefix).<br />
* A developer can register a force override for a prefix. This could be used to completely override the core classes with a custom replacement.<br />
<br />
=== Convention ===<br />
The class name must be in camel case and each segment of the name will represent a folder path where the last segment of the name is the name of the class file. If there is only one part to the class name, the auto-loader will look for the file in a folder of the same name. Folder names must be in lower case.<br />
<br />
'''Examples:'''<br />
* <code>PrefixUserModel</code> class should be located in <code>PATH_TO_PREFIX/user/model.php</code><br />
* <code>PrefixUser</code> class should be located in <code>PATH_TO_PREFIX/user/user.php</code><br />
<br />
'''Our scenario examples:'''<br />
* <code>MylibUserHelper</code> class should be located in <code>/libraries/mylib/user/helper.php</code><br />
* <code>MylibUser</code> class should be located in <code>/libraries/mylib/user/user.php</code><br />
<br />
<br />
There is no limit to the depth to which the auto-loader will search, providing it forms a valid path based on the camel case natural of the class name. Note that while acronyms and names such as HTML, XML and MySQL have a standard presention in text, such terms should observe camel case rules programmatically ("HTML" becomes "Html", "XML" becomes "Xml" and so on).<br />
<br />
=== Usage ===<br />
<source lang="php"><br />
// Tell the auto-loader to look for classes starting with "Mylib" in a specific folder.<br />
JLoader::registerPrefix('Mylib', JPATH_LIBRARIES . '/mylib');</source><br />
<source lang="php"><br />
// Tell the auto-loader to also look in the /libraries/cms folder for "J" prefixed classes.<br />
JLoader::registerPrefix('J', JPATH_PLATFORM . '/cms');</source><br />
<source lang="php"><br />
// Tell the auto-loader to reset the "J" prefix and point it to a custom fork of the platform.<br />
JLoader::registerPrefix('J', '/my/platform/fork', true);</source><br />
<br />
=== Note on registerPrefix ===<br />
For Joomla CMS 2.5, prefix cannot start with the same letter, otherwise the first matched will be tried to load. For example if we register prefix 'JM', as 'J' prefix exists so JLoader will find 'J' prefix. When it tries to search for class in the registered path of 'J', no class found.<br />
<br />
== Namespace Loader ==<br />
As of Joomla CMS v3.1.2, the core autoloader has had support for autoloading [http://www.php-fig.org/psr/psr-0/ PSR-0] style namespaced libraries. (You can read up on PHP namespaces [http://php.net/manual/en/language.namespaces.php here]. If you only support Joomla on PHP 5.3+ (which you do if you only support Joomla CMS v3.x or greater), then you can utilize code that uses native PHP namespaces. In accordance with PSR-0 rules, the directory and file casing must match that of the PHP namespace and class.<br />
<br />
'''Example'''<br />
* <code>MyLib\User\UserHelper</code> class must be located in <code>LIBROOT/src/MyLib/User/UserHelper.php</code><br />
<br />
=== Usage ===<br />
<source lang="php"><br />
// Tell the auto-loader to look for namespaced classes starting with MyLib in the LIBROOT/src directory<br />
JLoader::registerNamespace('MyLib', LIBROOT . '/src');</source><br />
<br />
== Accessing library from any place ==<br />
To access our library from any place of an application we should create a system plugin which will register our library with the JLoader. This plugin should fire on <code>onAfterInitialise</code> event:<br />
<br />
=== Manifest file ===<br />
<source lang="xml"><br />
<?xml version="1.0" encoding="utf-8"?><br />
<extension version="3.0" type="plugin" group="system" method="upgrade"><br />
<name>System - Mylib</name><br />
<author>Joomla! Project</author><br />
<creationDate>March 2013</creationDate><br />
<copyright>Copyright (C) 2005 - 2013 Open Source Matters. All rights reserved.</copyright><br />
<license>GNU General Public License version 2 or later.</license><br />
<authorEmail>admin@joomla.org</authorEmail><br />
<authorUrl>www.joomla.org</authorUrl><br />
<version>1.0.0</version><br />
<description>Simple example plugin to register custom library.</description><br />
<br />
<files><br />
<filename plugin="mylib">mylib.php</filename><br />
<filename>index.html</filename><br />
</files><br />
</extension><br />
</source><br />
<br />
=== Plugin file ===<br />
<source lang="php"><br />
<?php<br />
/**<br />
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.<br />
* @license GNU General Public License version 2 or later.<br />
*/<br />
<br />
defined('_JEXEC') or die;<br />
<br />
/**<br />
* Mylib plugin class.<br />
*<br />
* @package Joomla.plugin<br />
* @subpackage System.mylib<br />
*/<br />
class plgSystemMylib extends JPlugin<br />
{<br />
/**<br />
* Method to register custom library.<br />
*<br />
* return void<br />
*/<br />
public function onAfterInitialise()<br />
{<br />
JLoader::registerPrefix('Mylib', JPATH_LIBRARIES . '/mylib');<br />
}<br />
}<br />
</source><br />
<br />
Now you will be able to call classes from your library (located in /libraries/mylib) from any component, module or plugin.<br />
[[Category:Development]][[Category:Tutorials]]<br />
[[Category:Component Development]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117279Microdata2014-04-07T18:49:00Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
</source><br />
So let's suppose that you have the following string which is part of your article:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
As you've added a fallback <tt>->fallback('Person', 'name')</tt>, it will fallback to the <i>Person</i> type, and you will not lose any meaningful semantic.<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Product'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
If you don't need all that microdata information, you just disable that feature by calling: <tt>$microdata->enable(false);</tt><br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
$microdata->enable(false);<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117251Microdata2014-04-07T17:03:41Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
</source><br />
So let's suppose that you have the following string which is part of your article:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
As you've added a fallback <tt>->fallback('Person', 'name')</tt>, it will fallback to the <i>Person</i> type, and you will not lose any meaningful semantic.<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Product'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
If you don't need all that microdata information, you just disable that feature by calling: <tt>$microdata->enable(false);</tt><br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
$microdata->enable(false);<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span>Written by Alexandru Pruteanu</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117250Microdata2014-04-07T16:54:47Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
</source><br />
So let's suppose that you have the following string which is part of your article:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
Well it will fallback, so you will not lose any meaningful semantic:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Product'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
If you don't need all that microdata information, you just disable that feature by calling <tt>$microdata->enable(false);</tt><br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span>Written by Alexandru Pruteanu</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117249Microdata2014-04-07T16:50:19Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
</source><br />
So let's suppose that you have the following string which is part of your article:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
Well it will fallback, so you will not lose any meaningful semantic:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Product'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
If you don't need all that microdata information, you just disable that feature by calling <code>$microdata->enable(false);</code><br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span>Written by Alexandru Pruteanu</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117248Microdata2014-04-07T16:49:47Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Article');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
<?php<br />
$microdata = new JMicrodata('Product');<br />
?><br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
Well it will fallback, so you will not lose any meaningful semantic:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Product'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
If you don't need all that microdata information, you just disable that feature by calling <code>$microdata->enable(false);</code><br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span>Written by Alexandru Pruteanu</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117247Microdata2014-04-07T16:41:11Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
$microdata = new JMicrodata('Product');<br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->fallback('Person', 'name')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
Well it will fallback, so you will not lose any meaningful semantic:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Thing'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
<div><br />
<!-- Author of the content --><br />
<span>Written by Alexandru Pruteanu</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117246Microdata2014-04-07T16:31:40Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article, and you setup the current scope type as <i>Article</i>:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
<br />
<div><br />
<!-- Author of the content --><br />
<span><br />
Written by Alexandru Pruteanu<br />
</span><br />
<!-- The content --><br />
Here is the article text...<br />
<div><br />
</source><br />
And you want to add microdata semantics:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
<div itemscope itemtype='https://schema.org/Article'><br />
<!-- Author of the content --><br />
<span><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'>Alexandru Pruteanu</span><br />
</span><br />
</span><br />
<!-- The content --><br />
<span itemprop='articleBody'>Here is the article text...</span><br />
<div><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> and <i>articleBody</i> property?<br />
<source lang="php"><br />
$microdata = new JMicrodata('Product');<br />
<br />
<div <?php echo $microdata->displayScope();?>><br />
<!-- Author of the content --><br />
<span><br />
Written by <?php echo $microdata->content('Alexandru Pruteanu')->property('author')->display();?><br />
</span><br />
<!-- The content --><br />
<?php echo $microdata->content('Here is the article text...')->property('articleBody')->display();?><br />
<div><br />
</source><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117210Microdata2014-04-06T20:17:29Z<p>P.Alex: /* JMicrodata documentation */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<source lang="php"><br />
$microdata = new JMicrodata('Product');<br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117209Microdata2014-04-06T20:15:49Z<p>P.Alex: /* JMicrodata */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement and output http://schema.org microdata semantics.<br />
<br><br />
<br><br />
The library was designed with this goals in mind:<br />
# Having the '''possibility to switch the Microdata Type dynamically''', you just change the Type (there are 558 different available types).<br />
# '''Display validated semantics''', the library takes care to display data correctly.<br />
# '''Enable/disable the microdata''' semantics.<br />
# '''Fallbacks''', you should never lose any meaningful semantic.<br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>, that file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<source lang="php"><br />
$microdata = new JMicrodata('Product');<br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117208Microdata2014-04-06T20:01:10Z<p>P.Alex: /* How do I use the JMicrodata library? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>'''types.json'''</code> file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<source lang="php"><br />
$microdata = new JMicrodata('Product');<br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117207Microdata2014-04-06T19:56:59Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>'''types.json'''</code> file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=117206Microdata2014-04-06T19:52:54Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly.<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a library to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>'''types.json'''</code> file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=115081Microdata2014-03-10T21:57:32Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a {{JVer|3.2}} [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>'''types.json'''</code> file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=115080Microdata2014-03-10T21:53:39Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a {{JVer|3.2}} [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>'''types.json'''</code> file was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlScope($scope);'''</code><br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlProperty($property);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlSpan($content, $property = "", $scope = "", $inverse = false);'''</code><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<code>'''JMicrodata::htmlMeta($content, $property, $scope = "", $inverse = false);'''</code><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content="$content"><br />
</source><br />
the microdata in a <meta> tag with the <i>content for machines</i>, this method does not add the meta tag in the <head> section of the page.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata = JMicrodata($type = "", $flag = true);'''</code><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->enable($flag = true);'''</code><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->isEnabled();'''</code><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->setType($type);'''</code><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->property($name);'''</code><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->content($value, $machineValue = null);'''</code><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->fallback($type, $property);'''</code> <br />
<br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->displayScope();'''</code><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<code>'''$microdata->display($displayType = "", $emptyOutput = false);'''</code><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = "meta") ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>", if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope">$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by ' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106436Microdata2013-12-13T18:58:04Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a {{JVer|3.2}} [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>types.json</code> was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<big><br />
<code><br />
JMicrodata::htmlScope($scope);<br />
</code><br />
</big> <br />
<br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
JMicrodata::htmlProperty($property);<br />
</code></big><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</code></big><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</code></big><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</code></big><br> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
$microdata->enable($flag = true);<br />
</code></big><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->isEnabled();<br />
</code></big><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->setType($type);<br />
</code></big><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->property($name);<br />
</code></big><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
$microdata->content($value, $machineValue = null);<br />
</code></big><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
$microdata->fallback($type, $property);<br />
</code> <br />
</big><br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->displayScope();<br />
</code></big><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</code></big><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106435Microdata2013-12-13T18:55:46Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a {{JVer|3.2}} [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>types.json</code> was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<big><br />
<code><br />
JMicrodata::htmlScope($scope);<br />
</code><br />
</big> <br />
<br><br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
JMicrodata::htmlProperty($property);<br />
</code></big><br> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</code></big><br> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</code></big><br><br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
$microdata->enable($flag = true);<br />
</code></big><br> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->isEnabled();<br />
</code></big><br> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->setType($type);<br />
</code></big><br><br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->property($name);<br />
</code></big><br> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
$microdata->content($value, $machineValue = null);<br />
</code></big><br> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<big><code><br />
$microdata->fallback($type, $property);<br />
</code> <br />
</big><br>Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->displayScope();<br />
</code></big><br><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><big><br />
<code><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</code></big><br><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106434Microdata2013-12-13T18:51:13Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a {{JVer|3.2}} [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>types.json</code> was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<big><br />
<source><br />
JMicrodata::htmlScope($scope);<br />
</source><br />
</big> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source></big> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source></big> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106433Microdata2013-12-13T18:50:23Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla!''' {{JVer|3.2}} there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] is a {{JVer|3.2}} [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org <i>Types</i> and <i>Properties</i>.<br />
<br><br />
The <code>types.json</code> was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<big><br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source><br />
</big> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source></big> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<big><source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source></big> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106430Microdata2013-12-13T12:11:49Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the Microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106429Microdata2013-12-13T12:07:21Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the Microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br><br />
<br><br />
For a more detailed documentation of the library see the gist created by the author:<br />
<br><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"</source><br />
* normal → example: <source lang="php"><br />
itemprop="$property"</source>, if there is available a $content will output <source lang="php"><br />
<span itemprop="$property">$content</span></source><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106428Microdata2013-12-13T12:04:07Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the Microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br><br />
<br><br />
For a more detailed documentation of the library see the gist created by the author:<br />
<br><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: <source lang="php"><br />
itemprop="$property" itemscope itemtype="http://schema.org/$scope</source>, if there is also available a $content it will output <source lang="php"><br />
<span itemprop="$property" itemscope itemtype="http://schema.org/$scope>$content</span></source><br />
* meta → example: <source lang="php"><br />
<meta content="$content" itemprop="$property"></source>, if no $content is available will output <source lang="php"><br />
itemprop="$property"<br />
* normal → example: itemprop="$property"</source>, if there is available a $content will output <span itemprop="$property">$content</span><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106427Microdata2013-12-13T11:56:28Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the Microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br><br />
<br><br />
For a more detailed documentation of the library see the gist created by the author:<br />
<br><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
* inline<br />
* span<br />
* html<br />
* meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
* nested → example: itemprop="author" itemscope itemtype="http://schema.org/Person, if there is also available a $content it will output <span itemprop="author" itemscope itemtype="http://schema.org/Person>$content</span><br />
* meta → example: <meta content="2011-01-01" itemprop="datePublished">, if no $content is available will output itemprop="datePublished"<br />
* normal → example: itemprop="author", if there is available a $content will output <span itemprop="author">$content</span><br />
==How do I use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106426Microdata2013-12-13T11:53:26Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the Microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br><br />
<br><br />
For a more detailed documentation of the library see the gist created by the author:<br />
<br><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->displayScope();<br />
</source><br />
Return: <br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope<br />
</source><br />
the HTML with the <i>Scope</i> of the current <i>Type</i>, must be inserted inside a tag element.<br />
<br><br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->display($displayType = '', $emptyOutput = false);<br />
</source><br />
Return the Microdata HTML, if the <i>Property</i> isn't available it checks for a Fallback, otherwise return ''.<br />
<br><br />
<br><br />
There are 4 types of $displayType:<br />
*inline<br />
*span<br />
*html<br />
*meta<br />
<u>This method contains the HTML Microdata display logic</u>,<br />
If you specify the <i>$displayType</i> param, the Microdata will be returned the way you specified and expect — to,<br />
Otherwise if the <i>$displayType</i> param is empty it will be processed by the <i>display()</i> method and returned the HTML in the right way, with the expected <i>Property</i> Type (example of expectedTypes = URL, Text, Person ...)<br />
<br><br />
<br><br />
— What happens if you call display($displayType = 'meta') ?<br />
<br><br />
The returned HTML will be inside a <meta> HTML tag.<br />
<br><br />
<br><br />
— What happend if you call display()?<br />
<br><br />
The method will automatically check the expected type for the given Property, and will return the right Microdata HTML.<br />
<br><br />
<br><br />
There are 3 types of Microdata:<br />
*nested → example: itemprop="author" itemscope itemtype="http://schema.org/Person, if there is also available a $content it will output <span itemprop="author" itemscope itemtype="http://schema.org/Person>$content</span><br />
*meta → example: <meta content="2011-01-01" itemprop="datePublished">, if no $content is available will output itemprop="datePublished"<br />
*normal → example: itemprop="author", if there is available a $content will output <span itemprop="author">$content</span><br />
==How to use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that you have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106425Microdata2013-12-12T21:59:29Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
To understand how search engines use the Microdata information take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br><br />
<br><br />
For a more detailed documentation of the library see the gist created by the author:<br />
<br><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata documentation==<br />
All Microdata HTML output is handled by the JMicrodata class.<br />
<source lang="php"><br />
JMicrodata::htmlScope($scope);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemscope itemtype="http://schema.org/$scope"<br />
</source><br />
the HTML <i>Scope</i> of the given <i>Type</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlProperty($property);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
itemprop="$property"<br />
</source><br />
the HTML of the given <i>Property</i>, must be inside a HTML tag element.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlSpan($content, $property = '', $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<span itemscope itemtype="http://schema.org/$scope itemprop="$property"><br />
$content<br />
</span><br />
</source><br />
the microdata in a <span> tag, there is also available a JMicrodata::htmlDiv() method with the same functionalities.<br />
<br><br />
<br><br />
<source lang="php"><br />
JMicrodata::htmlMeta($content, $property, $scope = '', $inverse = false);<br />
</source> <br />
Return:<br />
<source lang="php"><br />
<meta $property $scope content='$content'><br />
</source><br />
the microdata in a <meta> tag with <i>content for machines</i>.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata = JMicrodata($type = '', $flag = true);<br />
</source> <br />
Create a new instance of the <i>JMicrodata</i> class and setup the current <i>Type</i>, the flag param is for enabling or disabling HTML microdata semantics output. Fallback to <i>Thing</i> Type if the Type isn't available or given.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->enable($flag = true);<br />
</source> <br />
Enable or Disable HTML Microdata semantics output.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->isEnabled();<br />
</source> <br />
Return true if Microdata semantics HTML output are enabled.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->setType($type);<br />
</source> <br />
Set a new Schema.org <i>Type</i>, there is also a $microdata->getType() function to retrieve the current <i>Type</i>.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->property($name);<br />
</source> <br />
Setup the <i>Property</i> if available in the current <i>Type</i> Scope, there is also a $microdata->getProperty() function to retrieve the current <i>Property</i>.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->content($value, $machineValue = null);<br />
</source> <br />
Setup a <i>Text value</i> or <i>Content value</i> for the Microdata, there is also a $microdata->getContent() function to retrieve the current <i>Text value</i>.<br />
<br><br />
<br><br />
<source lang="php"><br />
$microdata->fallback($type, $property);<br />
</source> <br />
Setup a Fallback <i>Type</i> and <i>Property</i>, there are also the $microdata->getFallbackType() and $microdata->getFallbackProperty() to retrieve the Fallback <i>Type</i> and Fallback <i>Property</i>. Fallback to <i>Thing Type</i> if the <i>Type</i> isn't available, Fallback to <i>null</i> the Property if isn't available.<br />
==How to use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that we have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106424Microdata2013-12-12T21:21:26Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br><br />
Take a look at [https://www.youtube.com/watch?v=A-kX0Aut-18 this short video] to see how search engines use the Microdata information.<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
<u>As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly</u>. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==JMicrodata==<br />
[https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/microdata.php JMicrodata] (since version 3.2) is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] to implement http://schema.org microdata semantics.<br />
<br><br />
The JMicrodata class uses the [https://github.com/joomla/joomla-cms/blob/master/libraries/joomla/microdata/types.json types.json] file which contains all available http://schema.org Types and Properties.<br />
<br><br />
The types.json was automatically created with the https://github.com/PAlexcom/Spider4Schema web crawler.<br />
<br><br />
<br><br />
For some usage examples you can see the library test file https://github.com/joomla/joomla-cms/blob/master/tests/unit/suites/libraries/joomla/microdata/JMicrodataTest.php<br />
<br><br />
<br><br />
For a more detailed documentation of the library see the gist created by the author:<br />
<br><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==How to use the JMicrodata library?==<br />
First of all you need to make an instance of the library in your extensions:<br />
<source lang="php"><br />
$microdata = new JMicrodata('Article');<br />
</source><br />
So let's suppose that we have the following string which is part of your article and the current scope is <i>Article</i>:<br />
<source lang="php"><br />
echo 'Written by Alexandru Pruteanu';<br />
</source><br />
And the microdata you need to add is an <i>author</i> property:<br />
<source lang="php"><br />
echo 'Written by' . $microdata->content(“Alexandru Pruteanu”)->property('author')->fallback('Person', 'name')->display();<br />
</source><br />
The library will display:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemprop='author' itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
What happens if the current scope is something else than <i>Article</i>, for example a <i>Product</i> scope, and the current scope doesn't have an <i>author</i> property?<br />
<br><br />
Well it will fallback in:<br />
<source lang="html4strict"><br />
Written by<br />
<span itemscope itemtype='https://schema.org/Person'><br />
<span itemprop='name'><br />
Alexandru Pruteanu<br />
</span><br />
</span><br />
</source><br />
If I want to disable the microdata semantics output?<br />
<br><br />
You can simply disable the microdata output by calling the following function:<br />
<source lang="php"><br />
$microdata->enable(false);<br />
</source><br />
The library will display the following:<br />
<source lang="html4strict"><br />
Written by Alexandru Pruteanu<br />
</source><br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106423Microdata2013-12-12T20:27:07Z<p>P.Alex: /* How do I use Microdata? */</p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br><br />
As of '''Joomla! 3.2''' there is a [https://github.com/joomla/joomla-cms/tree/master/libraries/joomla/microdata library] within Joomla! which allows developers to pull in microdata without needing to format it correctly. The following resources are available by the author of the microdata library introducing the library and how to use it:<br />
*http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
*https://gist.github.com/PAlexcom/6339949<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=Microdata&diff=106341Microdata2013-12-08T18:31:43Z<p>P.Alex: </p>
<hr />
<div>{{incomplete}}<br />
<br />
==What is Microdata?==<br />
<br />
{{underconstruction}}<br />
Microdata is a way of adding contextual information to your website and its contents, allowing search engines to better understand the information you provide them with.<br />
<br />
Contextual information allows search engines to understand the meaning of the information presented on your website, which allows it to better answer more verbose 'natural language' queries where an understanding of the meaning helps to interpret the most relevant content to be displayed.<br />
<br />
Microdata can be used to explain just about anything you would ever want to explain, and there are more 'schemas' being added on a regular basis. There are several vocabularies in existence, however at present the system favoured by search engines is that of [https://schema.org schema.org].<br />
<br />
==How do I use Microdata?==<br />
Microdata can be added to Joomla! using template overrides or with the use of plugins which allow you to insert microdata into specific resources.<br />
<br />
As of Joomla! 3.2 there is a library within Joomla! which allows developers to pull in microdata without needing to format it correctly. Currently, the following articles are available by the author of the microdata library:<br />
<br /><br />
http://magazine.joomla.org/issues/issue-oct-2013/item/1551-what-about-microdata-rich-snippets-in-joomla<br />
<br /><br />
https://gist.github.com/PAlexcom/6339949<br />
<br />
==How To implement Microdata yourself==<br />
* [[How To Implement Rich Snippet for Breadcrumbs]]<br />
[[Category:Search Engine Optimisation]]</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=User:P.Alex&diff=106340User:P.Alex2013-12-08T18:27:54Z<p>P.Alex: </p>
<hr />
<div>Hi, I'm a young web master born in Moldavia and I love the web. Now, I'm living in Italy where I'm studies Web & Multimedia Technologies at the University of Udine. I wake up every morning with the desire to learn something damn new and always try to widen my knowledge. Currently I'm working on several projects putting together experience, passion and creativity.<br />
<br><br />
Also a happy Linux user, and a Open Source advocate.<br />
<br><br />
https://twitter.com/PAlexcom<br />
<br><br />
http://p-alex.com</div>P.Alexhttps://docs.sandbox.joomla.org/index.php?title=User:P.Alex&diff=106339User:P.Alex2013-12-08T18:21:39Z<p>P.Alex: Created page with "Hi, I'm a young web master born in Moldavia and I love the web. Now, I'm living in Italy where I'm studies Web & Multimedia Technologies at the University of Udine. I wake up ..."</p>
<hr />
<div>Hi, I'm a young web master born in Moldavia and I love the web. Now, I'm living in Italy where I'm studies Web & Multimedia Technologies at the University of Udine. I wake up every morning with the desire to learn something damn new and always try to widen my knowledge. Currently I'm working on several projects putting together experience, passion and creativity.<br />
<br><br />
Also a happy Linux user, and a Open Source advocate.</div>P.Alex