You are here

Home » API reference » File (Field) Paths 6.2

README.txt in File (Field) Paths 6.2

Same filename and directory in other branches
  1. 5 README.txt
  2. 6 README.txt
The FileField Paths module extends the default functionality of Drupals core
Upload module, the FileField module and many other File Upload modules by adding
the ability to use node tokens in destination paths and filenames.

In simple terms, FileField Paths allows you to automatically sort and rename
your uploaded files using token based replacement patterns to maintain a nice
clean filesystem.

FileField Paths was written and is maintained by Stuart Clark (deciphered).
- http://stuar.tc/lark


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

* Configurable file paths now use node tokens instead of user tokens.
* Configurable filenames.
* Support for:
  * FileField module.
  * ImageField module.
  * ImageField Crop module.
* File path and filename cleanup options:
  * Filter out words and punctuation by taking advantage of the Pathauto module.
  * Convert unicode characters into US-ASCII with the Transliteration module.
* Automatically updates unprocessed file paths in the node body on save.
* Retroactive updates - rename and/or move previously uploaded files (Use with
  caution).
* Improved trash cleanup - removes all temporary and empty FileField Paths
  directories on Cron.


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

* CCK               - http://drupal.org/project/cck
* Token             - http://drupal.org/project/token


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

* ImageField Tokens - http://drupal.org/project/imagefield_tokens
* File Aliases      - http://drupal.org/project/file_aliases
* Pathauto          - http://drupal.org/project/pathauto
* Transliteration   - http://drupal.org/project/transliteration


Usage/Configuration
--------------------------

Once installed, FileField Paths needs to be configured for each file type you
wish to use.

* FileField/ImageField module

  Settings can be found on the fields configuration page in 'Page settings >
  FileField Path settings'.
  http://[www.yoursite.com/path/to/drupal]/admin/content/node-type/[node-type]/fields/[field-name]


Frequently Asked Questions
--------------------------

Q. Aren't tokens already supported in the FileField module?

A. Only User tokens are supported in the FileField module.

   Node tokens allow you to use the Node ID, Node Title, Node creation date and
   much more in your directory/filenames where User tokens are very limited.


Q. Why are my files uploaded to 'files/[nid]' instead of 'files/1'?

A. When you are creating or updating a node the full values for the Node tokens
   may not yet be known by Drupal, so the FileField Paths module will upload
   your files to a temporary path based on your filepath pattern ('files/[nid]')
   and then once you save the node and Drupal is provided with the Node tokens
   values the file will be moved to the appropriate location.


Q. Why is there a warning on the 'Retroactive updates' feature?

A. Retroactive updates will go through every single node of the particular
   content type and move and/or rename the files.

   While there have been no reports of errors caused by the feature, it is quite
   possible that the moving/renaming of these files could break links. It is
   strongly advised that you only use this functionality on your developmental
   servers so that you can make sure not to introduce any linking issues.

File

README.txt
View source 
  1. 

  2. The FileField Paths module extends the default functionality of Drupals core

  3. Upload module, the FileField module and many other File Upload modules by adding

  4. the ability to use node tokens in destination paths and filenames.

  5. 

  6. In simple terms, FileField Paths allows you to automatically sort and rename

  7. your uploaded files using token based replacement patterns to maintain a nice

  8. clean filesystem.

  9. 

  10. FileField Paths was written and is maintained by Stuart Clark (deciphered).

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

  12. 

  13. 

  14. Features

  15. --------------------------

  16. 

  17. * Configurable file paths now use node tokens instead of user tokens.

  18. * Configurable filenames.

  19. * Support for:

  20.   * FileField module.

  21.   * ImageField module.

  22.   * ImageField Crop module.

  23. * File path and filename cleanup options:

  24.   * Filter out words and punctuation by taking advantage of the Pathauto module.

  25.   * Convert unicode characters into US-ASCII with the Transliteration module.

  26. * Automatically updates unprocessed file paths in the node body on save.

  27. * Retroactive updates - rename and/or move previously uploaded files (Use with

  28.   caution).

  29. * Improved trash cleanup - removes all temporary and empty FileField Paths

  30.   directories on Cron.

  31. 

  32. 

  33. Required Modules

  34. --------------------------

  35. 

  36. * CCK               - http://drupal.org/project/cck

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

  38. 

  39. 

  40. Recommended Modules

  41. --------------------------

  42. 

  43. * ImageField Tokens - http://drupal.org/project/imagefield_tokens

  44. * File Aliases      - http://drupal.org/project/file_aliases

  45. * Pathauto          - http://drupal.org/project/pathauto

  46. * Transliteration   - http://drupal.org/project/transliteration

  47. 

  48. 

  49. Usage/Configuration

  50. --------------------------

  51. 

  52. Once installed, FileField Paths needs to be configured for each file type you

  53. wish to use.

  54. 

  55. * FileField/ImageField module

  56. 

  57.   Settings can be found on the fields configuration page in 'Page settings >

  58.   FileField Path settings'.

  59.   http://[www.yoursite.com/path/to/drupal]/admin/content/node-type/[node-type]/fields/[field-name]

  60. 

  61. 

  62. Frequently Asked Questions

  63. --------------------------

  64. 

  65. Q. Aren't tokens already supported in the FileField module?

  66. 

  67. A. Only User tokens are supported in the FileField module.

  68. 

  69.    Node tokens allow you to use the Node ID, Node Title, Node creation date and

  70.    much more in your directory/filenames where User tokens are very limited.

  71. 

  72. 

  73. Q. Why are my files uploaded to 'files/[nid]' instead of 'files/1'?

  74. 

  75. A. When you are creating or updating a node the full values for the Node tokens

  76.    may not yet be known by Drupal, so the FileField Paths module will upload

  77.    your files to a temporary path based on your filepath pattern ('files/[nid]')

  78.    and then once you save the node and Drupal is provided with the Node tokens

  79.    values the file will be moved to the appropriate location.

  80. 

  81. 

  82. Q. Why is there a warning on the 'Retroactive updates' feature?

  83. 

  84. A. Retroactive updates will go through every single node of the particular

  85.    content type and move and/or rename the files.

  86. 

  87.    While there have been no reports of errors caused by the feature, it is quite

  88.    possible that the moving/renaming of these files could break links. It is

  89.    strongly advised that you only use this functionality on your developmental

  90.    servers so that you can make sure not to introduce any linking issues.

  91.