You are here

README.txt in User Merge 7.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
# User merge

## Notes for version 2.x

A new interface allows users with the right permissions to choose how each user
property should be merged. This includes the ability to merge fields,
referencing entities, and other entities owned by the selected users. This aims
to provide a more finely tuned merge process, as well as to minimize errors and
information loss.

### General changes

`usermerge.module` provides only the API, and doesn't actually do any merging of
its own. It implements `hook_hook_info()`, so other modules can provide their
own `<module>.usermerge.inc` files. It also provides the `usermerge_do()`
function, which, given two user objects, merges them preserving information from
the "new" account (a behavior similar to version 1, but which takes into account
integration with other modules).

Core-specific functionality (default user properties, fields) is managed in
`usermerge.usermerge.inc`, which also includes support for entities that have a
`uid` column, and basic display support for non-default user properties that
aren't structured like fields (such as `rdf_mapping`).

### Configuration page
The configuration page is located at `admin/config/people/usermerge`, and allows
admins to select which core properties of the user entity should be exposed in
the review table. By default, no properties are exposed.

### Integration with other modules

Immediate integration with other modules is contained in module-specific files in
the `includes` directory.

Modules supported out of the box:

- Entity Reference
- Multiple E-mail
- Profile (code from User merge 1, left untouched)
- Profile 2
- RDF
- Real Name
- User Reference (References)
- User Points

### Self-Serve User Merge

Self-Serve User Merge is a submodule that allows users with the "Merge own
accounts" permission to merge a different account into the currently active one,
by visiting `user/%/edit/merge`. The user will have to enter the e-mail address
and password of the account that will be merged.

File

README.txt
View source
  1. # User merge
  2. ## Notes for version 2.x
  3. A new interface allows users with the right permissions to choose how each user
  4. property should be merged. This includes the ability to merge fields,
  5. referencing entities, and other entities owned by the selected users. This aims
  6. to provide a more finely tuned merge process, as well as to minimize errors and
  7. information loss.
  8. ### General changes
  9. `usermerge.module` provides only the API, and doesn't actually do any merging of
  10. its own. It implements `hook_hook_info()`, so other modules can provide their
  11. own `.usermerge.inc` files. It also provides the `usermerge_do()`
  12. function, which, given two user objects, merges them preserving information from
  13. the "new" account (a behavior similar to version 1, but which takes into account
  14. integration with other modules).
  15. Core-specific functionality (default user properties, fields) is managed in
  16. `usermerge.usermerge.inc`, which also includes support for entities that have a
  17. `uid` column, and basic display support for non-default user properties that
  18. aren't structured like fields (such as `rdf_mapping`).
  19. ### Configuration page
  20. The configuration page is located at `admin/config/people/usermerge`, and allows
  21. admins to select which core properties of the user entity should be exposed in
  22. the review table. By default, no properties are exposed.
  23. ### Integration with other modules
  24. Immediate integration with other modules is contained in module-specific files in
  25. the `includes` directory.
  26. Modules supported out of the box:
  27. - Entity Reference
  28. - Multiple E-mail
  29. - Profile (code from User merge 1, left untouched)
  30. - Profile 2
  31. - RDF
  32. - Real Name
  33. - User Reference (References)
  34. - User Points
  35. ### Self-Serve User Merge
  36. Self-Serve User Merge is a submodule that allows users with the "Merge own
  37. accounts" permission to merge a different account into the currently active one,
  38. by visiting `user/%/edit/merge`. The user will have to enter the e-mail address
  39. and password of the account that will be merged.