You are here

Home » API reference » Custom Formatters 6

README.txt in Custom Formatters 6 

The Custom Formatters module allows users to easily create custom CCK Formatters
without the need to write a custom module. Custom Formatters can then be
exported as Features or Drupal API Formatters.

Custom Formatters was written and is maintained by Stuart Clark (deciphered).
- http://stuar.tc/lark
- http://twitter.com/Decipher


Features
--------------------------------------------------------------------------------

* Two different editor modes:
  * Basic: A HTML based editor with Token support.
  * Advanced: A PHP based editor with support for multiple fields and multiple
    values.
* Support for:
  * CCK fields.
  * CCK Fieldgroups.
  * CCK 3.x Multigroups.
  * Display Suite fields.
  * Views.
* Exportable as:
  * Drupal API formatter via:
    * Custom Formatters export interface.
  * Custom Formatters exportable via:
    * Custom Formatters export interface.
    * Features module.
* Live preview (requires Devel generate module).
* Integrates with:
  * Features module - Adds dependent Custom Formatters (from Views or Content
      types) to Feature.
  * Insert module - Exposes Custom Formatters to the Insert module.
  * Libraries API module and the EditArea javascript library - Adds real-time
      syntax highlighting.


Required Modules
--------------------------------------------------------------------------------

* Content Construction Kit (CCK)  - http://drupal.org/project/cck
* Token - http://drupal.org/project/token


Recommended Modules
--------------------------------------------------------------------------------

* Devel (includes Devel generate) - http://drupal.org/project/devel
* Libraries API - http://drupal.org/project/libraries


Usage
--------------------------------------------------------------------------------

Custom Formatters can be managed on the 'Custom Formatters'
overview page: 'Administer > Site configuration > Custom Formatters'.
http://[www.yoursite.com/path/to/drupal]/admin/build/formatters

More information on usage, including tips & tricks, can be found in help:
http://[www.yoursite.com/path/to/drupal]/admin/help/custom_formatters


EditArea - Real-time syntax highlighting
--------------------------------------------------------------------------------

The EditArea javascript library adds real-time syntax highlighting, to install
it follow these steps:

1. Download and install the Libraries API module.
    http://drupal.org/project/libraries

2. Download the EditArea library and extract and move it into your libraries
   folder as 'editarea' (eg. sites/all/libraries/editarea).
    http://sourceforge.net/projects/editarea/files/EditArea/EditArea%200.8.2/editarea_0_8_2.zip/download


Upgrading
--------------------------------------------------------------------------------

Custom Formatters 1.2 adds the requirement of the Token module, you MUST install
and enable the module if you have not already done so or you will run into
issues.

And as always, be sure to run update.php after updating Custom Formatters.
http://[www.yoursite.com/path/to/drupal]/update.php


Developers
--------------------------------------------------------------------------------

Please refer to DEVELOPERS.txt for information on provided improved support for
your modules defined CCK fields with the Custom Formatters module.

File

README.txt
View source 
  1. The Custom Formatters module allows users to easily create custom CCK Formatters

  2. without the need to write a custom module. Custom Formatters can then be

  3. exported as Features or Drupal API Formatters.

  4. 

  5. Custom Formatters was written and is maintained by Stuart Clark (deciphered).

  6. - http://stuar.tc/lark

  7. - http://twitter.com/Decipher

  8. 

  9. 

  10. Features

  11. --------------------------------------------------------------------------------

  12. 

  13. * Two different editor modes:

  14.   * Basic: A HTML based editor with Token support.

  15.   * Advanced: A PHP based editor with support for multiple fields and multiple

  16.     values.

  17. * Support for:

  18.   * CCK fields.

  19.   * CCK Fieldgroups.

  20.   * CCK 3.x Multigroups.

  21.   * Display Suite fields.

  22.   * Views.

  23. * Exportable as:

  24.   * Drupal API formatter via:

  25.     * Custom Formatters export interface.

  26.   * Custom Formatters exportable via:

  27.     * Custom Formatters export interface.

  28.     * Features module.

  29. * Live preview (requires Devel generate module).

  30. * Integrates with:

  31.   * Features module - Adds dependent Custom Formatters (from Views or Content

  32.       types) to Feature.

  33.   * Insert module - Exposes Custom Formatters to the Insert module.

  34.   * Libraries API module and the EditArea javascript library - Adds real-time

  35.       syntax highlighting.

  36. 

  37. 

  38. Required Modules

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

  40. 

  41. * Content Construction Kit (CCK)  - http://drupal.org/project/cck

  42. * Token - http://drupal.org/project/token

  43. 

  44. 

  45. Recommended Modules

  46. --------------------------------------------------------------------------------

  47. 

  48. * Devel (includes Devel generate) - http://drupal.org/project/devel

  49. * Libraries API - http://drupal.org/project/libraries

  50. 

  51. 

  52. Usage

  53. --------------------------------------------------------------------------------

  54. 

  55. Custom Formatters can be managed on the 'Custom Formatters'

  56. overview page: 'Administer > Site configuration > Custom Formatters'.

  57. http://[www.yoursite.com/path/to/drupal]/admin/build/formatters

  58. 

  59. More information on usage, including tips & tricks, can be found in help:

  60. http://[www.yoursite.com/path/to/drupal]/admin/help/custom_formatters

  61. 

  62. 

  63. EditArea - Real-time syntax highlighting

  64. --------------------------------------------------------------------------------

  65. 

  66. The EditArea javascript library adds real-time syntax highlighting, to install

  67. it follow these steps:

  68. 

  69. 1. Download and install the Libraries API module.

  70.     http://drupal.org/project/libraries

  71. 

  72. 2. Download the EditArea library and extract and move it into your libraries

  73.    folder as 'editarea' (eg. sites/all/libraries/editarea).

  74.     http://sourceforge.net/projects/editarea/files/EditArea/EditArea%200.8.2/editarea_0_8_2.zip/download

  75. 

  76. 

  77. Upgrading

  78. --------------------------------------------------------------------------------

  79. 

  80. Custom Formatters 1.2 adds the requirement of the Token module, you MUST install

  81. and enable the module if you have not already done so or you will run into

  82. issues.

  83. 

  84. And as always, be sure to run update.php after updating Custom Formatters.

  85. http://[www.yoursite.com/path/to/drupal]/update.php

  86. 

  87. 

  88. Developers

  89. --------------------------------------------------------------------------------

  90. 

  91. Please refer to DEVELOPERS.txt for information on provided improved support for

  92. your modules defined CCK fields with the Custom Formatters module.