You are here

Home » API reference » Iframe 8

README.txt in Iframe 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

* Introduction
* Requirements
* Recommended Modules
* Installation
* Configuration
* Maintainers


INTRODUCTION
------------

The Iframe module creates a custom field, which lets you add a complete iframe
to your content types; including src-URL, setting width and height, optionally
a title above, and optionally a target attribute.

* For a full description of the module, visit this page:
https://www.drupal.org/project/iframe

* To submit bug reports and feature suggestions, or to track changes:
https://www.drupal.org/project/issues/iframe


REQUIREMENTS
------------

This module requires no other modules outside of Drupal core.


RECOMMENDED MODULES
-------------------

Token - https://www.drupal.org/project/token


INSTALLATION
------------

Install the Iframe module as you would normally install a contributed Drupal
module.
Visit: https://www.drupal.org/docs/8/extending-drupal-8/installing-modules
for further information.


CONFIGURATION
-------------

1. Navigate to Administration > Structure > Content types
   > [Content to edit] > Manage fields.
2. Add a new field and select "Iframe" as the Field type. 
3. There are three choices for Widget types: URL only, URL with height,
   and URL with width and height.

Field Settings
1. Navigate to Administration > Structure > Content types
   > [Content to edit] > Manage fields > Field to edit > Field Settings.
2. The width and height of an iframe can be set.
   They can be set in either fixed pixels (numbers only without "px" suffix) or
   in percentages with the percentage symbol following the number (%).
   ie. "50%" or for 500 pixels just "500".
3. Additional CSS classes can be defined.
   Multiple classes should be separated by spaces.
   Check the "Expose Additional CSS Class" box to allow authors to specify an
   additional class attribute.
4. A frameborder can be set. The default is set to zero (0), or no border.
5. Scrolling can be set to Automatic, Disabled, or Enabled.
   Scrollbars help the user to reach all iframe content despite the real height
   of the iframe content.
6. Transparency can be set to on or off to allow transparency per CSS in the
   outer iframe tag.
7. Token support can be set to "no tokens allowed",
   "tokens only in title field", or "tokens for title and URL field".
   The Token module must be enabled for some of this functionality.


MAINTAINERS
-----------

* neffets - https://www.drupal.org/u/neffets

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4. * Introduction

  5. * Requirements

  6. * Recommended Modules

  7. * Installation

  8. * Configuration

  9. * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. The Iframe module creates a custom field, which lets you add a complete iframe

  16. to your content types; including src-URL, setting width and height, optionally

  17. a title above, and optionally a target attribute.

  18. 

  19. * For a full description of the module, visit this page:

  20. https://www.drupal.org/project/iframe

  21. 

  22. * To submit bug reports and feature suggestions, or to track changes:

  23. https://www.drupal.org/project/issues/iframe

  24. 

  25. 

  26. REQUIREMENTS

  27. ------------

  28. 

  29. This module requires no other modules outside of Drupal core.

  30. 

  31. 

  32. RECOMMENDED MODULES

  33. -------------------

  34. 

  35. Token - https://www.drupal.org/project/token

  36. 

  37. 

  38. INSTALLATION

  39. ------------

  40. 

  41. Install the Iframe module as you would normally install a contributed Drupal

  42. module.

  43. Visit: https://www.drupal.org/docs/8/extending-drupal-8/installing-modules

  44. for further information.

  45. 

  46. 

  47. CONFIGURATION

  48. -------------

  49. 

  50. 1. Navigate to Administration > Structure > Content types

  51.    > [Content to edit] > Manage fields.

  52. 2. Add a new field and select "Iframe" as the Field type. 

  53. 3. There are three choices for Widget types: URL only, URL with height,

  54.    and URL with width and height.

  55. 

  56. Field Settings

  57. 1. Navigate to Administration > Structure > Content types

  58.    > [Content to edit] > Manage fields > Field to edit > Field Settings.

  59. 2. The width and height of an iframe can be set.

  60.    They can be set in either fixed pixels (numbers only without "px" suffix) or

  61.    in percentages with the percentage symbol following the number (%).

  62.    ie. "50%" or for 500 pixels just "500".

  63. 3. Additional CSS classes can be defined.

  64.    Multiple classes should be separated by spaces.

  65.    Check the "Expose Additional CSS Class" box to allow authors to specify an

  66.    additional class attribute.

  67. 4. A frameborder can be set. The default is set to zero (0), or no border.

  68. 5. Scrolling can be set to Automatic, Disabled, or Enabled.

  69.    Scrollbars help the user to reach all iframe content despite the real height

  70.    of the iframe content.

  71. 6. Transparency can be set to on or off to allow transparency per CSS in the

  72.    outer iframe tag.

  73. 7. Token support can be set to "no tokens allowed",

  74.    "tokens only in title field", or "tokens for title and URL field".

  75.    The Token module must be enabled for some of this functionality.

  76. 

  77. 

  78. MAINTAINERS

  79. -----------

  80. 

  81. * neffets - https://www.drupal.org/u/neffets