diff --git a/2930579-add-read-me.patch b/2930579-add-read-me.patch new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 199958b..6ba2288 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,130 @@ -# Installation -This module change the callback of link twig extenstion. +CONTENTS OF THIS FILE +--------------------- -From your drupal root run the following commands: - drush en -y menu_twig + * Introduction + * Requirements + * Recommended Modules + * Installation + * Configuration + * Maintainers -This module provide the textarea to rewrite the menu or render the twig extestions and twig filters. +INTRODUCTION +------------ -Some of the sample code find below: +Menu Twig is a Drupal module that provides text-area to render the HTML or Twig +extensions. -1 . Add some text / image after the Link +This module provides flexibility to exclude the menu item and +rewrite code in your own pattern. -Step 1. Navigate through : Structure > Menu > Main navigation > Add Link + * For a full description of the module visit: + https://www.drupal.org/project/menu_twig -Step 2. Expend the link "MENU TWIG" by click on it. + * To submit bug reports and feature suggestions, or to track changes visit: + https://www.drupal.org/project/issues/menu_twig + -Step 3. See the textarea inside the link "MENU TWIG". Now choose the text editor then write some text/ insert image inside the textarea and save the form. +REQUIREMENTS +------------ +This module requires no modules outside of Drupal core. -2 . Rewrite the link / Add attributes to link -Step 1. Navigate through : Structure > Menu > Main navigation > Add Link +RECOMMENDED MODULES +------------------- -Step 2. Expend the link "MENU TWIG" by click on it. +To enhance the module capability you can enable the Twig tweak +module so blocks can be rendered inside the menu item. -Step 3. Check the checkbox says "Exclude the menu item or override the menu item with text editor". + * Twig Tweak - https://www.drupal.org/project/twig_tweak -Step 4. Please find the some examples help to rewrite the link twig link function. - Example 1: {{ link(title, url)}} - Example 2: {{ link(title, url, { 'class':['overwrite_link']}) }} - Example 3: {{title}} +INSTALLATION +------------ +From your drupal root run the following commands: + drush en -y menu_twig -3 . Render the custom block / view block +Or install the Menu Twig module as you would normally install a contributed +Drupal module. -Step 1. To render the custom block / view block I am using the additional module "Twig tweak". See some examples +Visit https://www.drupal.org/node/1897420 for further information. -Step 2. Navigate through : Structure > Menu > Main navigation > Add Link -Step 3. Expend the link "MENU TWIG" by click on it. +CONFIGURATION +------------- -Step 4. Write the twig extension code inside the textarea to render the block with link itself. +To add text or an image after a link": - Example 1: {{ drupal_view('who_s_new', 'block_1') }} + 1. Navigate to: Structure > Menu > Main navigation > Add Link. + 2. Open the "MENU TWIG" section. + 3. In the textarea choose the text editor and write some text or insert + image inside the textarea. + 4. Save the form. -4 . How to use twig extension filters / functions with Menu Twig -Step 1. Navigate through : Structure > Menu > Main navigation > Add Link +To Rewrite or add attributes to a link: -Step 2. Expend the link "MENU TWIG" by click on it. + 1. Navigate to: Structure > Menu > Main navigation > Add Link + 2. Open the "MENU TWIG" section. + 3. Select the checkbox that says "Exclude the menu item or override the menu + item with text editor". + 4. Add your Twig markup. Three examples are listed below. -Step 3. You will find the link says "filters" and "functions" under description of textarea. Click on the links and you will find the all availble twig functions and filters available in system. + {{ link(title, url)}} + {{ link(title, url, { 'class':['overwrite_link']}) }} + {{title}} -Step 4. Twig provides a number of handy functions that can be used directly within Templates. For more infomation please go through the article. -Step 5. Filters in Twig can be used to modify variables. Filters are separated from the variable by a pipe symbol. They may have optional arguments in parentheses. Multiple filters can be chained. The output of one filter is applied to the next. For more infomation please go through the article. +To render a custom block or view block: - Example 1: {{ 'View all content'|t }} + 1. To render the custom block or view block, you need to install and enable + the "Twig tweak" module. + 2. Navigate to: Structure > Menu > Main navigation > Add Link. + 3. Open the "MENU TWIG" section. + 4. Write the Twig extension code inside the textarea to render the block + within the link itself. -5 . Optimize the html output render by twig extension + {{ drupal_view('who_s_new', 'block_1') }} + -Step 1. Navigate through : Structure > Menu > Main navigation > Add Link +How to use Twig extension filters and functions with Menu Twig: -Step 2. Expend the link "MENU TWIG" by click on it. + 1. Navigate to: Structure > Menu > Main navigation > Add Link. + 2. Open the "MENU TWIG" section. + 3. You will find "filters" and "functions" links in the description section + of the textarea. Click on the links and you will find all the availble + Twig functions and filters available in the system. + 4. Twig provides a number of handy functions that can be used directly + within the templates. + 5. Filters in Twig can be used to modify variables. Filters are separated + from the variable by a pipe symbol. They may have optional arguments in + parentheses. Multiple filters can be chained. The output of one filter + is applied to the next. -Step 3. Now we have two ways to optimize the output of twig extension. Let say twig extension example + + {{ 'View all content'|t }} + -{{ drupal_view('who_s_new', 'block_1') }} -. -Step 4. First 1: You can restrict the output of the twig extension by choose the textarea filter. For example choose Text format 'Restricted HTML' to get clean content. +To Optimize the HTML output render by adding a Twig extension: -Step 5. First 2: You can use twig extension filters for the same to strip the html using filter "striptags". See exmaple below: + 1. Navigate to: Structure > Menu > Main navigation > Add Link. + 2. Open the "MENU TWIG" section. + 3. There are two ways to optimize the output of Twig extension. + 4. First option: You can restrict the output of the Twig extension by + choosing the textarea filter. Choose the text format 'Restricted HTML' + to get clean content. + 5. Second option: You can use Twig extension filters to strip the HTML using + filter "striptags". + + See the example below: {% set whonew = drupal_view('who_s_new', 'block_1') %} {{ whonew|render|striptags('') |raw }} + + +MAINTAINERS +----------- + + * aloknarwaria