You are here

README.txt in Domain Access 7.3

README file for Domain Source.

File

domain_source/README.txt
View source
  1. /**
  2. * @file
  3. * README file for Domain Source.
  4. */
  5. Domain Source
  6. Creates a source domain for linking to content from other domains.
  7. CONTENTS
  8. --------
  9. 1. Introduction
  10. 1.1 Sponsors
  11. 2. Installation
  12. 2.1 Dependencies
  13. 2.2 Warning
  14. 3. Module Behavior
  15. 3.1 Inherited Permissions
  16. 3.2 Content Editing Forms
  17. 3.3 Integration with Domain Content
  18. 4. Developer Notes
  19. 4.1 Database Schema
  20. ----
  21. 1. Introduction
  22. The Domain Source module is a small module that extends Domain Access
  23. by allowing site and affiliate editors to select a primary "source" domain for
  24. all content.
  25. When links are written to content from another domain using the SEO strict
  26. rules, cross-domain searching or the "Special Page Requests" rules, the links
  27. will go to the "source" domain specified for the node.
  28. ----
  29. 1.1 Sponsors
  30. The Domain Source module is sponsored by Dzone, the developer's network.
  31. http://www.dzone.com
  32. ----
  33. 2. Installation
  34. This section is not finished. It requires http://drupal.org/node/210248.
  35. ----
  36. 2.1 Dependencies
  37. Domain Source requires the Domain Access module be installed and active.
  38. ----
  39. 2.2 Warning
  40. When this module is enabled, existing content is not automatically assigned
  41. to a source domain.
  42. You must either edit the nodes individually or use the Domain Content
  43. module to perform batch edits.
  44. ----
  45. 3. Module Behaviors
  46. The Domain Source module alters the core Domain Access module in a few
  47. subtle ways. It is only used in the following instances:
  48. -- You wish to allow searching of all domains from any domain.
  49. -- You use a content aggregation module such as MySite.
  50. -- You get "access denied" errors when linking to items on a
  51. user's Track page.
  52. -- You want to turn on the advanced setting "Search Engine
  53. Optimization" to avoid content from being indexed on multiple
  54. domains.
  55. The default Domain Access behavior in these instances is to rewrite links
  56. to point to the first accessible domain. With the Domain Source module,
  57. editors with the proper permissions can specify which domain should be
  58. considered "authoritative" for a specific piece of content.
  59. ----
  60. 3.1 Inherited Permissions
  61. The Domain Source module uses the following permissions from the Domain
  62. Access module:
  63. -- 'set domain access'
  64. This permission allows an editor to assign any content to any registered
  65. domain. With Domain Source, it also allows users to assign that content to
  66. any domain as the "source" domain.
  67. -- 'publish to any assigned domain'
  68. This permission lets affiliate editors select publishing options for the
  69. domains on which they are editors. If these users are allowed to select
  70. the affiliate domains for their content, they will also be allowed to assign
  71. the "source" domain from the list of their editable domains.
  72. Note that in all cases, the "source" domain must be selected as a publishing
  73. option. Failure to do so will return an error when the edit form is submitted.
  74. All other users will have the currently active domain set as the "source"
  75. domain.
  76. ----
  77. 3.2 Content Editing Forms
  78. Only users with the 'set domain access' or 'publish to any assigned domain'
  79. permission will be able to select a "source" domain.
  80. Otherwise, domain assignments will be done automatically, based on the currently
  81. active domain.
  82. Users may select any assigned domain as the source for the content. They may
  83. also choose to use the 'Use current domain' option. if that option is selected,
  84. the links to the content will not be rewritten unless the current domain denies
  85. access to the content.
  86. NOTE: Inactive domains may not be selected as a source domain.
  87. When viewing content in debug mode, the module will show you the source
  88. domain for the content and the means used to determine that domain.
  89. Possible options are:
  90. -- Domain sitename
  91. Indicates the content is expressly assigned to a source domain.
  92. -- Domain sitename 'determined automatically'
  93. Indicates that no source domain is set, and the module is using default
  94. behavior to determine the proper source domain.
  95. -- Domain sitename 'using current domain'
  96. Indicates the content link should not be rewritten, unless necessary, and to
  97. view it on the current domain.
  98. ----
  99. 3.3 Integration with Domain Content
  100. This module adds an element to the Domain Content batch editing screen to
  101. allow for the batch assignment of source domains. It is also available to
  102. editors who can use the default Content administration form.
  103. However, this feature is currently only available to users with the 'set domain
  104. access' permission.
  105. When using this form, you may select to ignore Domain Source by selecting
  106. 'Do not change' in the form element. When using this feature, you will not
  107. be allowed to remove the source domain from any content being updated.
  108. ----
  109. 4. Developer Notes
  110. The Domain Source module is recommended for most uses. It is an extension
  111. module because it alters the original design of the Domain Access module.
  112. It is possible that Domain Source will be incorporated into the main module in
  113. later releases.
  114. ----
  115. 4.1 Database Schema
  116. Installing the module creates a {domain_source} table that contains:
  117. - nid
  118. Integer, unique, primary key
  119. The node id for this record, foreign key to the {node} table.
  120. - domain_id
  121. Integer, unique
  122. The lookup key for this record, foreign key to the {domain} table.