You are here

README.txt in Feeds 8.3

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 6 README.txt
  3. 7.2 README.txt
  4. 7 README.txt
## CONTENTS OF THIS FILE
------------------------

  * Introduction
  * Requirements
  * Installation
  * Configuration
  * Maintainers


## INTRODUCTION
---------------

Feeds is the module for importing or aggregating data into nodes, users,
taxonomy terms and other content entities. Data can be imported from various
formats, such as CSV, JSON*, XML* and RSS feeds.

First, site builders configure the import parameters by creating a feed type in
the UI and configure how the source data maps to the fields in Drupal.
Content editors can then import their source in the UI by creating a feed.
Multiple feeds can exist per feed type, allowing you to import from multiple
sources or allowing multiple editors to update their own content.

You can configure Feeds to update content periodically or to import content just
once. Details of how many items got imported can be found in the feeds log
reports.

* For importing from JSON and XML, you need the extension module "Feeds
Extensible Parsers".

### Features

 * Create nodes, users, taxonomy terms or other content entities from import
 * One-off imports and periodic aggregation of content
 * Import or aggregate RSS/Atom feeds
 * Import or aggregate CSV files
 * Import or aggregate OPML files
 * PubSubHubbub support
 * Extensible to import any other kind of content
 * Granular mapping of input elements to Drupal content elements
 * Modify data before import (requires the Feeds Tamper module)
 * Exportable configurations
 * Batched import for large files

### Resources

 * For a full description of the module, visit the project page:
   https://www.drupal.org/project/feeds

 * To submit bug reports and feature suggestions, or track changes:
   https://www.drupal.org/project/issues/feeds

 * For complete usage and developer documentation:
   https://www.drupal.org/docs/8/modules/feeds


## REQUIREMENTS
---------------

This module requires no modules outside of Drupal core.


## INSTALLATION
---------------

 * Install as you would normally install a contributed Drupal module. Visit
   https://www.drupal.org/node/1897420 for further information.


## CONFIGURATION
----------------

After installation, creating a new import feed in Drupal 8 requires three steps:

1. Create a "Feed type" from Administration > Structure > Feeds
   (/admin/structure/feeds) that describes import parameters, such as source
   type (for example, CSV), frequency, etc.
2. Map "sources" from the import data structure to "targets" of the entity
   (content, user, taxonomy, etc.) that you are importing to
   Administration > Structure > Feeds > {created feed} > Mapping
   (/admin/structure/feeds/*/mapping).
3. Create a "Feed" of the "Feed type" you want (/feed/add), select source
   (file or url), and import actual data.

For a complete walkthrough of configuration options and process, visit:
https://drupal.org/docs/8/modules/feeds/creating-and-editing-import-feeds


## MAINTAINERS
--------------

### Current maintainers:

 * Youri van Koppen [MegaChriz](https://www.drupal.org/u/megachriz)

### Historical maintainers:

 * Chris Leppanen [twistor](https://www.drupal.org/u/twistor)
 * [tristanoneil](https://www.drupal.org/user/340659)
 * Franz Glauber Vanderlinde [franz](https://www.drupal.org/u/franz)
 * Frank Febbraro [febbraro](https://www.drupal.org/u/febbraro)

File

README.txt
View source
  1. ## CONTENTS OF THIS FILE
  2. ------------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Maintainers
  8. ## INTRODUCTION
  9. ---------------
  10. Feeds is the module for importing or aggregating data into nodes, users,
  11. taxonomy terms and other content entities. Data can be imported from various
  12. formats, such as CSV, JSON*, XML* and RSS feeds.
  13. First, site builders configure the import parameters by creating a feed type in
  14. the UI and configure how the source data maps to the fields in Drupal.
  15. Content editors can then import their source in the UI by creating a feed.
  16. Multiple feeds can exist per feed type, allowing you to import from multiple
  17. sources or allowing multiple editors to update their own content.
  18. You can configure Feeds to update content periodically or to import content just
  19. once. Details of how many items got imported can be found in the feeds log
  20. reports.
  21. * For importing from JSON and XML, you need the extension module "Feeds
  22. Extensible Parsers".
  23. ### Features
  24. * Create nodes, users, taxonomy terms or other content entities from import
  25. * One-off imports and periodic aggregation of content
  26. * Import or aggregate RSS/Atom feeds
  27. * Import or aggregate CSV files
  28. * Import or aggregate OPML files
  29. * PubSubHubbub support
  30. * Extensible to import any other kind of content
  31. * Granular mapping of input elements to Drupal content elements
  32. * Modify data before import (requires the Feeds Tamper module)
  33. * Exportable configurations
  34. * Batched import for large files
  35. ### Resources
  36. * For a full description of the module, visit the project page:
  37. https://www.drupal.org/project/feeds
  38. * To submit bug reports and feature suggestions, or track changes:
  39. https://www.drupal.org/project/issues/feeds
  40. * For complete usage and developer documentation:
  41. https://www.drupal.org/docs/8/modules/feeds
  42. ## REQUIREMENTS
  43. ---------------
  44. This module requires no modules outside of Drupal core.
  45. ## INSTALLATION
  46. ---------------
  47. * Install as you would normally install a contributed Drupal module. Visit
  48. https://www.drupal.org/node/1897420 for further information.
  49. ## CONFIGURATION
  50. ----------------
  51. After installation, creating a new import feed in Drupal 8 requires three steps:
  52. 1. Create a "Feed type" from Administration > Structure > Feeds
  53. (/admin/structure/feeds) that describes import parameters, such as source
  54. type (for example, CSV), frequency, etc.
  55. 2. Map "sources" from the import data structure to "targets" of the entity
  56. (content, user, taxonomy, etc.) that you are importing to
  57. Administration > Structure > Feeds > {created feed} > Mapping
  58. (/admin/structure/feeds/*/mapping).
  59. 3. Create a "Feed" of the "Feed type" you want (/feed/add), select source
  60. (file or url), and import actual data.
  61. For a complete walkthrough of configuration options and process, visit:
  62. https://drupal.org/docs/8/modules/feeds/creating-and-editing-import-feeds
  63. ## MAINTAINERS
  64. --------------
  65. ### Current maintainers:
  66. * Youri van Koppen [MegaChriz](https://www.drupal.org/u/megachriz)
  67. ### Historical maintainers:
  68. * Chris Leppanen [twistor](https://www.drupal.org/u/twistor)
  69. * [tristanoneil](https://www.drupal.org/user/340659)
  70. * Franz Glauber Vanderlinde [franz](https://www.drupal.org/u/franz)
  71. * Frank Febbraro [febbraro](https://www.drupal.org/u/febbraro)