README.txt 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. The File (Field) Paths module extends the default functionality of Drupals core
  2. File module, Image module and many other File upload modules, by adding the
  3. ability to use entity based tokens in destination paths and filenames.
  4. In simple terms, File (Field) Paths allows you to automatically sort and rename
  5. your uploaded files using token based replacement patterns to maintain a nice
  6. clean filesystem.
  7. File (Field) Paths was written and is maintained by Stuart Clark (deciphered).
  8. - http://stuar.tc/lark
  9. - http://twitter.com/Decipher
  10. Features
  11. --------------------------------------------------------------------------------
  12. * Configurable file paths now use entity tokens in addition to user tokens.
  13. * Configurable filenames.
  14. * Support for:
  15. * Drupal core File module.
  16. * Drupal core Image module.
  17. * Video module.
  18. * File path and filename cleanup options:
  19. * Filter out words and punctuation by taking advantage of the Pathauto module.
  20. * Convert unicode characters into US-ASCII with the Transliteration module.
  21. * Automatically updates unprocessed file paths in any Text fields on the entity.
  22. * Retroactive updates - rename and/or move previously uploaded files (Use with
  23. caution)
  24. Required Modules
  25. --------------------------------------------------------------------------------
  26. * Token - http://drupal.org/project/token
  27. Recommended Modules
  28. --------------------------------------------------------------------------------
  29. * Pathauto - http://drupal.org/project/pathauto
  30. * Transliteration - http://drupal.org/project/transliteration
  31. Usage/Configuration
  32. --------------------------------------------------------------------------------
  33. Once installed, File (Field) Paths needs to be configured for each file field
  34. you wish to use.
  35. * Drupal core File/Image and other Field based supported modules
  36. Settings an be found on the fields configuration page.
  37. Example:
  38. Administration > Structure > Content types > Article > Manage fields > Image
  39. http://[www.yoursite.com/path/to/drupal]/admin/structure/types/manage/article/fields/field_image
  40. Frequently Asked Questions
  41. --------------------------------------------------------------------------------
  42. Q. Aren't tokens already supported in the File module?
  43. A. A limited selection of tokens are supported in the File module.
  44. Entity based tokens allow you to use the Entity ID, Title, creation date and
  45. much more in your directory/filenames where you would otherwise be unable.
  46. Q. Why aren't my files in the correct folder?
  47. A. When you are creating or updating an entity the full values for the tokens
  48. may not yet be known by Drupal, so the File (Field) Paths module will upload
  49. your files to the Fields old file path temporarily and then once you save the
  50. entity and Drupal is provided with the tokens values the file will be moved
  51. to the appropriate location.
  52. Q. Why is there a warning on the 'Retroactive updates' feature?
  53. A. Retroactive updates will go through every single entity of the particular
  54. bundle and move and/or rename the files.
  55. While there have been no reports of errors caused by the feature, it is quite
  56. possible that the moving/renaming of these files could break links. It is
  57. strongly advised that you only use this functionality on your developmental
  58. servers so that you can make sure not to introduce any linking issues.