GitHub
Luminova Framework
Toggle Theme
Version

SEO Default Schema Configuration

Last updated: 2024-08-24 15:05:57

The schema configuration settings allow you to define default SEO options for your web pages. These defaults can be overridden on individual pages, but the defaults will continue to be applied where not explicitly changed. To configure your SEO settings, modify the file located at /app/Config/Storage.php.

For more details, see the Schema Generator documentation.

  • File path: /app/Config/Schema.php

Schema Array Keys

This array contains key-value pairs used to define various attributes of your web application for search engine optimization (SEO) purposes.

The basic default settings

<?php
return [
    'name'                  => APP_NAME,
    'short_name'            => 'Short Name',
    'company_brands'        => [
        'Technology',
        'Luminova'
    ],
    'company_name'          => 'Company Name',
    'company_duns'          => null,
    'company_email'         => null,
    'company_description'   => 'Company Description',
    'title'                 => 'Website Main Title',
    'page_description'      => 'Webpage Main Description.',
    'site_id'               => href(null, true),
    'start_url'             => href('/', true),
    'assets'                => asset('/', true),
    'image_assets'          => asset('images', true),
    'host_name'             => APP_HOSTNAME,
    'logo_image_name'       => 'app-square-logo.png',
    'logo_image_width'      => 512,
    'logo_image_height'     => 106,
    'image_name'            => 'app-square-icon.png',
    'image_width'           => 512,
    'image_height'          => 512,
    'image_type'            => 'image/png',
    'published_date'        => '2022-03-04T06:45:20+00:00',
    'modified_date'         => '2023-07-15T03:47:59+00:00',
    'category'              => 'Website Category',
    'article_keywords'      => [],
    'language'              => 'en-US',
    'locale'                => locale(),
    'article_section'       => [],
    'twitter_name'          => null,
    'social_media'          => [],
    'breadcrumbs'           => [],
    'keywords'              => [],
];

The Full Schema Array Keys Descriptions

  • name (string): The name of the application.

    • Example: APP_NAME

  • short_name (string): A shortened version of the application name.

    • Example: 'Luminova'

  • company_brands (array): An array of brand names associated with the company.

    • Example: ['Technology', 'Luminova']

  • company_name (string): The official name of the company.

    • Example: 'Nanoblock Technology Ltd'

  • company_duns (string|null): The DUNS number of the company, if applicable.

    • Example: null

  • company_email (string|null): The official contact email of the company.

    • Example: null

  • company_description (string): A description of the company, emphasizing its offerings.

    • Example: 'Luminova is a PHP web application framework built for speed.'

  • keywords (array): A broader array of keywords associated with the entire site or page.

    • Example: ['Tech', 'Framework']

  • address_locality (string): The city or locality where the company is located. This information is used for geographical identification and can be part of the company's contact details.

  • address_country (string): The country where the company is based. This is useful for localization, tax information, and contact purposes.

  • address_postalcode (string): The postal or ZIP code of the company's address. This is typically used in conjunction with the street address and locality.

  • address_street (string): The street address of the company, including any suite or unit numbers. This is the physical location of the company.

  • title (string): The title of the web page, often used for SEO.

    • Example: 'Luminova - PHP Framework For Developers'

  • page_description (string): A brief description of the web page's content, used for SEO.

    • Example: 'Luminova is a PHP web application framework built for speed, with easy-to-use syntax, allowing you to create web applications with ease.'

  • site_id (string): The unique identifier of the site, usually a URL.

    • Example: https://example.com or href(null, true)

  • start_url (string): The URL where the web application starts.

    • Example: https://example.com/ or href('/', true)

  • assets (string): The base URL for the application's assets.

    • Example: https://example.com/assets/ or asset('/', true)

  • image_assets (string): The base URL for the application's image assets.

    • Example: https://example.com/assets/images/ or asset('images', true)

  • host_name (string): The hostname of the application server.

    • Example: example.com or APP_HOSTNAME

  • logo_image_name (string): The filename of the application's logo image.

    • Example: 'app-square-logo.png'

  • logo_image_width (int): The width of the logo image in pixels.

    • Example: 512

  • logo_image_height (int): The height of the logo image in pixels.

    • Example: 106

  • image_name (string): The filename of the application's primary icon image.

    • Example: 'app-square-icon.png'

  • image_width (int): The width of the primary icon image in pixels.

    • Example: 512

  • image_height (int): The height of the primary icon image in pixels.

    • Example: 512

  • image_type (string): The MIME type of the primary icon image.

    • Example: 'image/png'

  • product_image_link (string): The URL to the product image, if the page or site is associated with a product. This is used in e-commerce or product listings.

  • site_published_date (string|null): The date when the site or application was first published. This can be useful for historical records or SEO.

  • site_modified_date (string|null): The date when the site or application was last modified. This is important for tracking updates and version control.

  • published_date (string): The publication date of the web page in ISO 8601 format.

    • Example: '2022-03-04T06:45:20+00:00'

  • modified_date (string): The last modified date of the web page in ISO 8601 format.

    • Example: '2023-07-15T03:47:59+00:00'

  • headline (string): The main headline or title of the article or page. This is prominently displayed and is key for SEO and user engagement.

  • category (string): The category to which the web page belongs.

    • Example: 'Documentation'

  • article_keywords (array): An array of keywords relevant to the article or page.

    • Example: ['PHP', 'JAVA', 'SWIFT', 'JavaScript']

  • article_section (array): Sections of the article or page, useful for SEO.

    • Example: []

  • word_count (int): The word count of the article or page content. This can be used for content analysis or SEO.

  • total_comments (int): The total number of comments on the article or page. This can be used to gauge user engagement and interaction.

  • author (string): The author of the content, typically the application or company name.

  • citation (string): The article citation.

  • license (string): The article license URL.

  • language (string): The language code of the web page content (e.g., en-US).

    • Example: 'en-US'

  • locale (string): The locale of the web page, often used for internationalization (e.g., en).

    • Example: en or locale()

  • twitter_name (string|null): The Twitter handle associated with the application or company.

    • Example: null

  • social_media (array): An array of social media URLs related to the application or company.

    • Example: 
      [
'https://facebook.com/luminovang',
'https://twitter.com/luminovang',
'https://linkedin.com/company/luminovang',
'https://github.com/luminovang/luminova',
'https://github.com/luminovang/framework',
]

  • breadcrumbs (array): A breadcrumb trail for navigation, often used in structured data.

    • Example: []

  • isProduct (bool): A boolean value indicating whether the page is about a product. This is used to differentiate between content types.

  • product_type (string): The type or category of the product, if applicable. This is relevant for product listings and e-commerce.

  • product_category (string): The broader category to which the product belongs. This helps in organizing products and improving searchability.

  • search_query (string): The search query URL template used for generating search result pages. It includes a placeholder for the search term.

    • Example: /search?q={search_term_string}

  • search_input (string): The search input string placeholder, typically used in the site's search functionality.

    • Example: search_term_string

  • availability (string): The availability status of a product, such as InStock or OutOfStock. This is relevant for e-commerce sites.

  • currency (string): The currency code (e.g., NGN for Nigerian Naira) used on the product.

On this page