You are here

README.txt in Semantic Fields 7

-- REQUIREMENTS --

Fields (Drupal core): http://drupal.org/project/drupal


-- INSTALLATION --

Install as usual, see http://drupal.org/node/895232 for further information. 


-- SUMMARY --

Semantic Fields was created to give users the means of customizing the HTML output 
of Fields. It was inspired in part by the highly recommended module Semantic 
Views (http://drupal.org/project/semanticviews) which provides the same functionality 
for Views (http://drupal.org/project/views), and as response to the "Semantic CCK" 
feature request on the CCK issue queue (http://drupal.org/node/670040).


-- BENEFITS --

With Semantic Fields enabled, users can specify the HTML elements and classes for:

	- The entire field
	- The labels -- above and inline
	- All field items
	- Each field item

This allows users to quickly create semantically rich and meaningful HTML markup 
from CCK fields such as:

	- Definition Lists
	- Ordered Lists
	- Unordered Lists

The user can also choose to remove all (or some) markup for any Field.

By facilitating semantically rich markup, Semantic Fields makes it easy for themers and
developers to increase usability, accessibility and SEO performance of Drupal sites 
without resorting to field overrides (ie. field.tpl.php).


-- CONFIGURATION & SETUP --

To use Semantic Fields, install the module and go to Structure -> Field Formats to set up the desired formats to
use when outputting fields. Once at least one field format has been created, go to the configuration form for 
each field and select a Display format for the field. Set the Display format to "Default" if you do not want to
use Semantic Fields for a particular field; the field will then be displayed using the standard Drupal field 
template.


-- USING FIELD TPL OVERRIDES --

For those instances that do require a field template override, it is recommended that 
you not use Semantic Fields for that field (ie. select the "Default" Field format). 
That way, you can simply override the field using a normal field override, and 
still have the benefits of Semantic Fields for any other fields.

File

README.txt
View source
  1. -- REQUIREMENTS --
  2. Fields (Drupal core): http://drupal.org/project/drupal
  3. -- INSTALLATION --
  4. Install as usual, see http://drupal.org/node/895232 for further information.
  5. -- SUMMARY --
  6. Semantic Fields was created to give users the means of customizing the HTML output
  7. of Fields. It was inspired in part by the highly recommended module Semantic
  8. Views (http://drupal.org/project/semanticviews) which provides the same functionality
  9. for Views (http://drupal.org/project/views), and as response to the "Semantic CCK"
  10. feature request on the CCK issue queue (http://drupal.org/node/670040).
  11. -- BENEFITS --
  12. With Semantic Fields enabled, users can specify the HTML elements and classes for:
  13. - The entire field
  14. - The labels -- above and inline
  15. - All field items
  16. - Each field item
  17. This allows users to quickly create semantically rich and meaningful HTML markup
  18. from CCK fields such as:
  19. - Definition Lists
  20. - Ordered Lists
  21. - Unordered Lists
  22. The user can also choose to remove all (or some) markup for any Field.
  23. By facilitating semantically rich markup, Semantic Fields makes it easy for themers and
  24. developers to increase usability, accessibility and SEO performance of Drupal sites
  25. without resorting to field overrides (ie. field.tpl.php).
  26. -- CONFIGURATION & SETUP --
  27. To use Semantic Fields, install the module and go to Structure -> Field Formats to set up the desired formats to
  28. use when outputting fields. Once at least one field format has been created, go to the configuration form for
  29. each field and select a Display format for the field. Set the Display format to "Default" if you do not want to
  30. use Semantic Fields for a particular field; the field will then be displayed using the standard Drupal field
  31. template.
  32. -- USING FIELD TPL OVERRIDES --
  33. For those instances that do require a field template override, it is recommended that
  34. you not use Semantic Fields for that field (ie. select the "Default" Field format).
  35. That way, you can simply override the field using a normal field override, and
  36. still have the benefits of Semantic Fields for any other fields.