README.txt

   1
   2 -- SUMMARY --
   3
   4 The co-ment module provides Drupal with an interface to co-ment�,
   5 a Web service/Free software for submitting texts to comments and
   6 annotations. When annotating a text in co-ment, you just select the
   7 word, sentence or chunk of text you want to comment, and your comment
   8 will appear in the left margin, being potentially available for a
   9 thread of discussion in response to this comment.
  10
  11
  12 -- REQUIREMENTS --
  13
  14 You should either have an account on co-ment website, since co-ment is
  15 provided as a web service (see http://www.co-ment.com/ for details) ;
  16 or you can run your own instance of co-ment, since co-ment can also be
  17 download, installed and used as a Free software  (see
  18 http://www.co-ment.org/ for details).
  19
  20 For a full experience of co-ment, the Jquery UI Dialog Drupal
  21 Contributed Module is required (see Jquery UI Dialog below).
  22
  23
  24 -- INSTALLATION --
  25
  26 Install the Drupal module as usual, see http://drupal.org/node/70151
  27 for further information.
  28
  29
  30 -- ACCESS RIGHTS --
  31
  32 * On your co-ment Workspace, you can create up to three users that
  33   will be used by Drupal to access your workspace. One user, acting as
  34   an Editor, will be able to create/edit/delete texts. A second user,
  35   acting as a Commentator, will be able to comment texts. Finally, a
  36   third user, acting like an observer, will only be able to view texts
  37   and comments (but not to post comments herself).
  38
  39 * Configure Drupal user permissions in Administer >> User management
  40   >> Permissions >> co-ment module:
  41
  42   - administer co-ment
  43
  44     Users in roles with the "administer co-ment" permission will be
  45     able to configure co-ment settings.
  46
  47   - create co_ment_text nodes
  48
  49     Users in roles with the "create co_ment_text nodes"
  50     permission will be able to create new text in your co-ment
  51     workspace.
  52
  53   - edit own co_ment_text nodes
  54
  55     Users in roles with the "edit own co_ment_text nodes"
  56     permission will be able to update texts they've created in your
  57     co-ment workspace.
  58
  59   - edit any co_ment_text nodes
  60
  61     Users in roles with the "edit any co_ment_text node"
  62     permission will be able to update any text in your co-ment
  63     workspace.
  64
  65   - delete own co_ment_text nodes
  66
  67     Users in roles with the "delete own co_ment_text nodes"
  68     permission will be able to delete texts they've created in your
  69     co-ment workspace.
  70
  71   - delete any co_ment_text nodes
  72
  73     Users in roles with the "delete any co_ment_text node"
  74     permission will be able to delete any text in your co-ment
  75     workspace.
  76
  77   - post comments on co_ment_text nodes
  78
  79     Users in roles with the "post comments on co_ment_text nodes"
  80     permission will be able to comment any text in your co-ment
  81     workspace and reply to existing comment threads.
  82
  83
  84 -- CONFIGURATION --
  85
  86 * Customize in Administer >> Site configuration >> co-ment settings:
  87
  88   - the URL of your co-ment workspace.
  89
  90   - the login and passwords of co-ment users (Editor, Commentator and
  91     Observer).
  92
  93
  94 -- USAGE --
  95
  96 Creating/editing/deleting co-ment texts is done as for any content in
  97 Drupal. The only particularity of a co-ment text is that you have an
  98 option to keep (default) or delete comments not affected by the edit,
  99 when you're updating a content. Also, as detailed below in section
 100 Jquery UI Dialog, comments left without scope during an update can be
 101 detached or deleted. co-ment texts are also fully compatible with
 102 Drupal core revisions mechanism, allowing to access to succesive
 103 revisions of a content and to revert to a specific revision.
 104
 105 But, the main interest of co-ment module is when viewing texts. Users
 106 in roles with the "post comments on co_ment_text nodes" permission
 107 will be able to comment any text in your co-ment workspace and reply
 108 to existing comment threads. Annotations in co-ment are linked to a
 109 word, a group of words or letters, a sentence, in short to any chunk
 110 of text that is selected with mouse pointer. Annotations can be
 111 displayed in a left margin and are opened to discussion threads.
 112
 113
 114 -- JQUERY UI DIALOG --
 115
 116 When an existing text is edited, it may happen that some chunks of
 117 text where comments were attached to are deleted. In other words,
 118 these comments are left without any scope. In this context, you can
 119 choose to keep these comments and they will still appear in the new
 120 revision, but detached from the text. Or you can choose to delete
 121 these comments in the new revision of the text.
 122
 123 To enable this choice, the Jquery UI Dialog Drupal contributed module
 124 is required. Otherwise, comments without scope are detached by
 125 default.
 126
 127
 128 -- CONTACT --
 129
 130 Current maintainer:
 131 * G�rald S�DRATI-DINET - http://drupal.org/user/616006
 132
 133 This project has been sponsored by:
 134 * SOPINSPACE
 135   One of the European reference solution providers for participatory democracy
 136   and public debate using the Internet. Integrator of agile solutions
 137   for Web-based collaborative work, including user support. Visit
 138   http://www.sopinspace.com for more information.