README.txt in Domain Access 5

README file for Domain Content

File

domain_content/README.txt

/**
 * @file
 * README file for Domain Content
 */

Domain Access: Content Administration
Provides a Content list screen for each active domain.

CONTENTS
--------

1.  Introduction
1.1   Use-Case
1.2   Sponsors
2.  Installation
2.1   Permissions
3.  Menu Items
3.1   Access Control
3.2   Affiliated Content
3.3   Active Domains
4.  Content Editing
4.1   Affiliates
4.2   Domain Access Options
5.  Developer Notes


----
1.  Introduction

The Domain Content provides an alternate view for batch editing site content.
The module is part of the Domain Access module group.

----
1.1 Use-Case

Domain Access is a node access module.  By design, Drupal's default content
administration page does not respect node access rules.

The Domain Content provides an additional set of batch content administration
pages that respect the node access rules set by the Doamin Access module.

----
1.2 Sponsors

Domain Content is sponsored by Morris DigitalWorks.
  http://morrisdigitalworks.com

----
2.  Installation

To install the module, simply untar the download and put it in your site's
modules directory.  After reading this document, enable the module normally.

When you enable the module, no new tables will be created in your Drupal
database.

If you wish for users with the 'edit domain nodes' permission to access the
Domain Content interface, you must enable the 'Use access control for
editors' option under Advanced Settings on the Domains configuration page:

  Administer > Site Building > Domains

----
2.1 Permissions

The Domain Content module does not add any new Access Control permissions.

The module uses the existing permissions from the Domain Access module.

----
3.  Menu Items

When the module is installed, a new top-level Administration menu is created.
This menu is titled 'Affiliated Content'.

----
3.1 Access Control

The Access Control permissions for the module are set by the root Domain Access
module. The relevant permissions are:

  - 'edit domain nodes'
  - 'set domain access'

Users with the 'edit domain nodes' permission can view content for domains where
they are assigned editors.  Users with the 'set domain access' permission can
view content for domains where they are assigned editors _and_ reassign content
to one or more affiliates.

Users with the core 'administer nodes' permission may view and edit content on any
affiliate.

Either the 'administer nodes' or the 'edit domain nodes' permission is required to
access the 'Affiliate content' screen.

----
3.2 Affiliated Content

The Affiliated Content link resides at the path 'admin/domain/content'.  This
page returns a list of all domains for which the user can edit or view content.

By design, the first menu item under Affiliated Content is the 'Content for all
affiliate sites' link.  This page will show all content that is viewable across
all site affiliates.  [Technically, the page shows all content assigned to the
'domain_site' access realm.]

----
3.3 Active Domains

For each active domain in your Domain Access configuration, the Domain Content
module will set a new menu item.  This page shows a list of all content that is
assigned to that domain.

If users have the appropriate access to edit content for that domain, the menu
item will be available.

----
4.  Content Editing

The batch editing forms for Domain Content work identically to those for the
default Drupal 'administer content' screen.

----
4.1 Affiliates

On the batch editing form is an additional column labelled 'Affiliates.'

This column shows the Domain Access rules for each node.  Remember that content
that is assigned to more than one domain can be edited by multiple users, so
be careful when editing content that is published to multiple affiliates.

----
4.2 Domain Access Options

You may use this form to batch update the Domain Access rules for your nodes.

If you have the 'set domain access' permission, you will see the Domain Access
Options form elements beneath the node list.

If you select the operation "Change affiliate publishing options", any nodes that you
select can be batch updated to the new settings you select.

By default, the currently active domain will be chosen, as will the value set for
promoting new nodes to all affiliates.

WARNING: It is possible that you may move some nodes to domains other
than the currently active domain.  If so, some nodes will be reomved from
the form after you submit the update.  This behavior is normal and desired.

----
5.  Developer Notes

A companion module that handles this function for Comments is also needed.

Contributions welcome.