You are here

Home » API reference » Formatter Suite 8

README.txt in Formatter Suite 8 

                        Formatter Suite module for Drupal

                      by the San Diego Supercomputer Center
                   at the University of California at San Diego


CONTENTS OF THIS FILE
---------------------
 * Introduction
 * Requirements
 * Installation
 * Configuration for entity view pages
 * Configuration for views
 * Troubleshooting


INTRODUCTION
------------
The Formatter Suite module for Drupal provides multiple field formatters
to assist in presenting values within a web page. See the module's help
page for descriptions of the individual formatters.

This project has been sponsored by the National Science Foundation.
See NSF.txt.


REQUIREMENTS
------------
See RELEASENOTES.htm for the latest requirements.

The module only requires the Drupal core Field module, which is mandatory at
all sites. No third-party contributed modules or libraries are required.

Some formatters are only available if additional Drupal core modules are
enabled, such as formatters for Datetime, Email, File, Image, Link, and Text
fields.


INSTALLATION
------------
Install the module as you would normally install a contributed Drupal module.
Visit:
  https://www.drupal.org/docs/user_guide/en/config-install.html


CONFIGURATION FOR ENTITY VIEW PAGES
-----------------------------------
To configure field formatters for an entity view page, you must have the
Drupal core Field UI module enabled. Field UI provides a "Manage display"
page for each entity type. From this page you can select the field formatter
to use for each field, then click on the formatter's gear icon to the right
of the field row. This presents the formatter's configuration page. Click
"Update" to save that configuration, and "Save" to save the display.

Thereafter, each time the field is shown on an entity view page, Drupal will
invoke the chosen field formatter to present the value.


CONFIGURATION FOR VIEWS
-----------------------
To configure field formatters for a view, you must have the Drupal core
View UI module enabled. View UI provides a page for each view from which
you can select the fields to include in a table or list of entities. For
each field, you can configure how the field is presented by selecting a
field formatter and adjusting that formatter's settings.

Thereafter, each time the field is shown for an entity in a row of a view,
Drupal will invoke the chosen field formatter to present the value.


TROUBLESHOOTING
---------------
The module does not have a database schema and it has no configuration
settings of its own. There is nothing to change or reset if there is trouble.

File

README.txt
View source 
  1.                         Formatter Suite module for Drupal

  2. 

  3.                       by the San Diego Supercomputer Center

  4.                    at the University of California at San Diego

  5. 

  6. 

  7. CONTENTS OF THIS FILE

  8. ---------------------

  9.  * Introduction

  10.  * Requirements

  11.  * Installation

  12.  * Configuration for entity view pages

  13.  * Configuration for views

  14.  * Troubleshooting

  15. 

  16. 

  17. INTRODUCTION

  18. ------------

  19. The Formatter Suite module for Drupal provides multiple field formatters

  20. to assist in presenting values within a web page. See the module's help

  21. page for descriptions of the individual formatters.

  22. 

  23. This project has been sponsored by the National Science Foundation.

  24. See NSF.txt.

  25. 

  26. 

  27. REQUIREMENTS

  28. ------------

  29. See RELEASENOTES.htm for the latest requirements.

  30. 

  31. The module only requires the Drupal core Field module, which is mandatory at

  32. all sites. No third-party contributed modules or libraries are required.

  33. 

  34. Some formatters are only available if additional Drupal core modules are

  35. enabled, such as formatters for Datetime, Email, File, Image, Link, and Text

  36. fields.

  37. 

  38. 

  39. INSTALLATION

  40. ------------

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

  42. Visit:

  43.   https://www.drupal.org/docs/user_guide/en/config-install.html

  44. 

  45. 

  46. CONFIGURATION FOR ENTITY VIEW PAGES

  47. -----------------------------------

  48. To configure field formatters for an entity view page, you must have the

  49. Drupal core Field UI module enabled. Field UI provides a "Manage display"

  50. page for each entity type. From this page you can select the field formatter

  51. to use for each field, then click on the formatter's gear icon to the right

  52. of the field row. This presents the formatter's configuration page. Click

  53. "Update" to save that configuration, and "Save" to save the display.

  54. 

  55. Thereafter, each time the field is shown on an entity view page, Drupal will

  56. invoke the chosen field formatter to present the value.

  57. 

  58. 

  59. CONFIGURATION FOR VIEWS

  60. -----------------------

  61. To configure field formatters for a view, you must have the Drupal core

  62. View UI module enabled. View UI provides a page for each view from which

  63. you can select the fields to include in a table or list of entities. For

  64. each field, you can configure how the field is presented by selecting a

  65. field formatter and adjusting that formatter's settings.

  66. 

  67. Thereafter, each time the field is shown for an entity in a row of a view,

  68. Drupal will invoke the chosen field formatter to present the value.

  69. 

  70. 

  71. TROUBLESHOOTING

  72. ---------------

  73. The module does not have a database schema and it has no configuration

  74. settings of its own. There is nothing to change or reset if there is trouble.