File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content typex:	`text/markdown`
Description:	Documentation
Class:	wepesi PHP Metadata Generator Generate metadata with the details of HTML pages
Author:	By Boss Ibrahim Mussa
Last change:
Date:	3 years ago
Size:	`10,622 bytes`

Download

Wepesi Metadata generator

Integration

The integration is simple and does not require too much knowledge. The fist step required to is to call generate a static method that give u the possibility to access all the methode defined.

    use Wepesi\MetaData;
    $meta = MetaData::structure();

To get a structure of data to be display call the structure method, it will return an array object of field generated et to have build to be display call the build method.

`generate` & `build` In case there is no element defined if will return en empty array in case of structure methode and a metadata without information. No `title`,`description`.

  use Wepesi\MetaData;
  MetaData::structure()->generate();
  /
      array(0) {
      }
    /

Description

To build a useful metadata, method are well design to help no struggle with it.

`title` method

The title tag is the first HTML element that specifies what your web page is about. Title tags are important for SEO and visitors because they appear in the search engine results page (SERP) and in browser tabs.

    use Wepesi\MetaData;
    $structure= MetaData::structure()->title("Welcome To Wepesi")->generate();
    /
    array(1) {
        ["title"]=>"Welcome To Wepesi"
    }
    */

`lang` method

A meta lang is an HTML element that help to set the language of the webpage.

    use Wepesi\MetaData;
    $structure= MetaData::structure()
                ->title("Welcome To Wepesi")
                ->lang("fr")
                ->generate();
    /
    array(1) {
      ["title"]=>"Welcome To Wepesi"
      ["lang"]=>"fr"
    }
    */

`cover` method

A meta cover is an HTML element that help to set the image to be play on the card that will be display. supported image are jpg and png.

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To Wepesi")
                ->lang("en")
                ->cover("https://www.domaine.com/cover.jpg")
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To Wepesi"
    //  ["lang"]=>"en"
    //  ["cover"]=>"https://www.domaine.com/cover.jpg"
    // }

`author` method

A meta author is an HTML element that help to provide more detail about the author.

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To Wepesi")
                ->author("Wepesi.")
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To Wepesi"
    //  ["author"]=>"Wepesi"
    // }

`descriptions` method

A meta description is an HTML element that sums up the content on your web page. Search engines typically show the meta description in search results below your title tag.

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To Wepesi")
                ->descriptions("Search engines typically show the meta description in search results below your title tag.")
                ->lang("fr")
                ->cover("https://www.domaine.com/cover.jpg")
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To Wepesi",
    //  ["descriptions"]=>"Search engines typically show the meta description in search results below your title tag.",
    //  ["lang"]=>"fr",
    //  ["cover"]=>"https://www.domaine.com/cover.jpg",
    // }

`type` method

The type help to define whether it's about an article or website or a blog, there few types of metadata {article,blog,...}

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To Wepesi")
                ->descriptions("Search engines typically show the meta description in search results below your title tag.")
                ->lang("sw")
                ->type("article")
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To Wepesi",
    //  ["descriptions"]=>"Search engines typically show the meta description in search results below your title tag.",
    //  ["lang"]=>"sw",
    //  ["type"]=>"article",
    // }

`link` method

The link method help to define whether the website link or the link of your article for redirection. in case of an article you should provide the link of the blog post, to help reach directly to the post.

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To our Article")
                ->descriptions("Description of the article")
                ->lang("sw")
                ->type("article")
                ->link("https://www.domaine.com/article/welcom-to-wepesi")
                ->cover("https://www.domaine.com/article-cover/cover.jpg")
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To our Article",
    //  ["descriptions"]=>"Description of the article",
    //  ["lang"]=>"sw",
    //  ["type"]=>"article",
    //  ["link"]=>"https://www.domaine.com/article/welcom-to-wepesi",
    //  ["cover"]=>"https://www.domaine.com/article-cover/cover.jpg",
    // }

Robots Meta Tag

List a tags to be applied e.g.,: follow,index,nofollow,noindex FOLLOW: The search engine crawler will follow all the links in that webpage, INDEX: The search engine crawler will index the whole webpage. NOFOLLOW The search engine crawler will NOT follow the page and any links in that webpage. NOINDEXThe search engine crawler will NOT index that webpages.

Use the following syntax for your robots meta tag: Oly 2 Robots tags can be used

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To our Article")
                ->descriptions("About Description of the article")
                ->lang("sw")
                ->type("article")
                ->link("https://www.domaine.com/about")
                ->cover("https://www.domaine.com/article-cover/cover.jpg")
                ->index()
                ->follow()
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To our Article",
    //  ["descriptions"]=>"About Description of the article",
    //  ["lang"]=>"sw",
    //  ["type"]=>"article",
    //  ["link"]=>"https://www.domaine.com/article/welcom-to-wepesi",
    //  ["cover"]=>"https://www.domaine.com/article-cover/cover.jpg",
    //  ["tags"]=>["index","follow"],
    // }

in case you don't need to index and follow the pages use:

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To our Article")
                ->descriptions("About Description of the article")                
                ->noindex()
                ->nofollow()
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To our Article",
    //  ["descriptions"]=>"About Description of the article",
    //  ["tags"]=>["noindex","nofollow"],
    // }

checkout they would be the output for both example


<meta name="robots" content="index, follow"> Means index and follow this webpage.
<meta name="robots" content="noindex, nofollow"> Means not to index or not to follow this webpage.

`keyword` method

It?s used to add keyword witch will be help for the search engine to easily map your website. It takes parameter as string if you have one keyword, by in other way u can pass an array with multiple keyword

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To our Article")
                ->descriptions("About Description of the article")                
                ->keyword(["HTML","CSS","JavaScript"])
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To our Article",

    //  ["descriptions"]=>"About Description of the article",
    //  ["keyword"]=>["HTML","CSS","JavaScript"]
    // }

`canonical` method

It?s used to indicate that there are other versions of this webpage. By implementing the canonical tag in the code, your website tells search engines that this URL is the main page and that the engines shouldn?t index other pages.

    use Wepesi\MetaData;
$structure= MetaData::structure()
                ->title("Welcome To our Article")
                ->descriptions("About Description of the article")                
                ->canonical("https://www.domaine.com")
                ->generate();
    //array(1) {
    //  ["title"]=>"Welcome To our Article",
    //  ["descriptions"]=>"About Description of the article",
    //  ["canonical"]=>"https://www.domaine.com",
    // }

BUILD

The build method will help to generate the metadata tag to be display in your head html tags,

    use Wepesi\MetaData;
    $meta= MetaData::structure()
            ->title("Welcome To our Article")
            ->descriptions("About Description of the article")
            ->lang("sw")
            ->type("article")
            ->link("https://www.domaine.com/about")
            ->cover("https://www.domaine.com/article-cover/cover.jpg")
            ->index()
            ->follow()
            ->build();

    <!-- Open Graph data-->
<meta property="og:site_name" content="Doctawetu"/>
<meta property="og:title" content="Welcome To our Article"/>
<meta property="og:description" content="About Description of the article"/>
<meta property="og:url" content="https://www.domaine.com/about"/>
<meta property="og:type" content="article"/>
<meta property="og:image:secure_url" content="https://www.domaine.com/article-cover/cover.jpg"/>
<meta property="og:local" content="sw"/>
<meta property="og:image:type" content="image/jpeg">
<!-- Size of image. Any size up to 300. Anything above 300px will not work in WhatsApp -->
<meta property="og:image:width" content="300">
<meta property="og:image:height" content="300">
<!-- Twitter MetaData -->
<meta name="twitter:card" content="summary"/>
<meta name="twitter:title" content="Welcome To our Article"/>
<meta name="twitter:description" content="About Description of the article"/>
<meta name="twitter:url" content="https://www.domaine.com/about"/>
<meta name="twitter:type" content="article"/>
<meta name="twitter:image" content="https://www.domaine.com/article-cover/cover.jpg"/>
<meta name="twitter:local" content="sw"/>
<meta name="twitter:site" content="">
<meta name="twitter:creator" content="">
<!-- Extra information -->
<meta name="mobile-web-app-capable" content="yes"/>
<meta name="apple-mobile-web-app-title" content="yes"/>
<meta name="robots" content="index,follow">
<link rel="canonical" href=""/>"