www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/better_formats/README.txt

   1 This very basic documentation for during development.
   2 Better docs will be generated closer to a full release.
   3
   4
   5 The only items currently implemented in the D8 version of Better Formats are:
   6
   7 1. Display options: When BF is enabled you will have permissions at
   8    admin/people/permissions to control per role display of:
   9    1. format tips
  10    2. format tips link
  11    3. format selection for [entity]
  12
  13    #3 is actually several permissions. There is one for each entity in your site.
  14
  15 2. Simple field level default format.
  16    This allows you set a field level default format using the standard "Default Value"
  17    setting of a field. This is only possibly normally if you enter something in the
  18    text field for the field api to save the format too. BF gives you the ability
  19    to set the format WITHOUT having to set a value in the field.
  20
  21    1. At admin/config/content/formats/settings enable "Use field default" option.
  22    2. Create a field on one of your entities with one of the following types: Text, Long Text, Long text with summary.
  23    3. Save the field.
  24    4. Now go back and edit the field you just saved. This is required because of
  25       how the field default value option works.
  26    5. You will now see a "Text format" dropdown below your field in the
  27       "Default Value" area. Set the default format in the dropdown.
  28    6. Save the field. Default will now be used on all new content forms for that field.
  29
  30 3. Allowed format selection for each text field.
  31
  32 4. Ordering of formats in Formats select box for each text field.