https://github.com/shockwavemk/magento2-module-templatehints

Magento 2 "Templatehints" module adds new features to Template Path Hints functionality of Magento 2: Template information, cache status, layout information
https://github.com/shockwavemk/magento2-module-templatehints

composer hints magento2 magento2-module template

Last synced: about 1 month ago
JSON representation

Magento 2 "Templatehints" module adds new features to Template Path Hints functionality of Magento 2: Template information, cache status, layout information

• Host: GitHub
• URL: https://github.com/shockwavemk/magento2-module-templatehints
• Owner: shockwavemk
• License: osl-3.0
• Created: 2015-12-17T07:35:43.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-01-10T06:52:05.000Z (almost 8 years ago)
• Last Synced: 2024-01-22T17:01:42.982Z (12 months ago)
• Topics: composer, hints, magento2, magento2-module, template
• Language: CSS
• Homepage: https://packagist.org/packages/shockwavemk/magento2-module-templatehints
• Size: 29.3 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Magento 2 - Enhanced template hints

# Introduction



The creation, modification and debugging of Magento 2 frontend templates can be supported by enabling the build in "Template Path Hints for Storefront" in Admin configuration of Magento 2.

  Store > Configuration > Advanced > Developer > Debug > Enabled Template Path Hints for Storefront > Yes

The result are graphical enhanced frontend blocks with basic information about template pathes.



This information is useful for template-designer and developers to create or modify Magento 2 features, but the information is provided is kept at a very low level:

## Default Template-file behavior

# Features

This Magento 2 "Templatehints" module addresses that point. New features are added to Template Path Hints functionality of Magento 2:

 * General information is displayed for each block

   * Template file

   * Block type

   * Name of block in layout

   * Module for block

   * Information about parent block

 *  Cache information

   *  Cache key of current block

   *  Cache Tags of current block

   *  Configured lifetime for current block

   *  Cache key info string

   *  Current status of current block in cache (found, disabled, not found)

# Installation of the magento2 template path hints extension

Add the module to your composer file:

  {

  ...

  "require": {

  ...

  "shockwavemk/magento2-module-templatehints": "dev-master",

  ...

  },

Add my packages server to your composer file:

  {

      "repositories": [

          {

              "type": "composer",

              "url": "https://packages.martin-kramer.com"

          }

      ]

  }