README.txt 5.02 KB
Newer Older
nsuit's avatar
nsuit committed
1 2
MODULE DEPENDENCIES

3 4 5 6 7
- comment
- community_tags
- jquery_update
- libraries
- page_manager
nsuit's avatar
nsuit committed
8 9 10
- panels
- tagadelic
- taxonomy
11
- text
nsuit's avatar
nsuit committed
12
- views
13
- views_data_export
nsuit's avatar
nsuit committed
14 15 16 17


INSTALLATION OF ECOMMA MODULE
 
18 19
Instructions below are based on navigation in admin menu (admin_menu module).

20
1.  Modules: enable ecomma module and dependencies
21
2.  Configuration > Search and metadata > Clean URLs: Check checkbox.
22

23 24 25 26
(Go to content management > Content types for step 3-5)
3.  Structure > Taxonomy: Add Vocabulary.
4.  Add content type: Add custom content type.
5.  Edit new content type > Comment settings > Preview comment:Optional
27 28
6.  Manage fields > Add a new text area field with unlimited values
7.  Enable ecomma commentary features for that text area field in the settings.
29
8.  Manage fields > Add new field > Term reference > Autocomplete term w.
30 31
9.  Select your Vocabulary from tag field settings.
10. Configuration > Community tags: Enable community tagging for new vocabulary.
32 33
11. Configuration > jQuery update > jQuery and jQuery UI CDN > Select None.
12. Edit new content type  > Community tags settings > Block.
34 35

(Go to People > Permissions for step 12-14)
36
13. Community_tags: Enable "tag content" for authenticated and anonymous users.
37
    (Enables unauthenticated users to see the tags, but not to tag.)
38
14. Community_tags: Enable "edit own tags" for authenticated.
39 40 41 42
15. Comment: 
	-Enable “View comments" for anonymous and authenticated users. 
	 (Enables unauthenticated users to see the comments, but not to comment.)
	-Enable "Administer comments and comment settings" for authenticated users.
43
16. Structure > Pages:
nsuit's avatar
nsuit committed
44
	-Enable node_view and click on edit. 
45
	-Selection rules > select "Node:type" and then check new content type
46
	-Left column: Add content > Node > Field: your-text-field
47 48 49
17. Create a node of the new node type. 
18. Enter your text in the text field (not in the body).
19. View the node and select text with mouse cursor to start annotating.
nsuit's avatar
nsuit committed
50

51
Current restrictions:
52 53
	* Does currently not work on all IE browser.
	* Must use clean URLs.
54 55
	* Once a group/class has started to tag or comment on a text the text 
	  cannot be changed in any way or the annotations will be off.
nsuit's avatar
nsuit committed
56

57
*****************************************************************************
nsuit's avatar
nsuit committed
58 59 60 61 62

USE OF ECOMMA MODULE (see also screenshots at admin/help/ecomma)

1. Tags and Comments
		
63 64 65 66 67
	-A "tag" is a label that you can use to mark a word or series of words that
	 interest you.
	-A "comment" is a remark on passage of a text.
	-A user might mark an instance of metaphor with the tag "metaphor" or tag a
	 famous passage with "well-known"
nsuit's avatar
nsuit committed
68
	-You may use tags that previous readers have created or create your own.
69 70
	-Tags are arranged in a "tag cloud". The tags in the cloud are arranged
	 alphabetically, and tags that are used more frequently will appear larger.
nsuit's avatar
nsuit committed
71 72 73 74
	
2. Adding tags and comments to an eComma text

	Simply use your mouse to select a range of text in the text provided.
75 76 77 78 79 80 81
	This will cause a draggable dialog box to appear. You can select either
	to create a tag or a comment with the selected text.
	You can type one of more words into the tag creation box to add them to
	your selected text, or you can type a longer observation or question into
	the comment creation box. You can also reply to another user's comment
	by clicking the link that will appear under the comment if you are logged
	in. And you can edit and delete your already submitted comments.
nsuit's avatar
nsuit committed
82 83 84 85 86
	Tags can be deleted, but not edited.


3. The eComma interface

87 88 89 90 91 92 93 94
	-Use the centered icon tabs to navigate between the text's word cloud,
	 tag view, comment view, comment word cloud, and user annotation list.
	-Clicking a tag in the tag cloud shows all phrases in the text that have
	 been given this tag, as well as which users have added the tag, and when.
	-Clicking on the highlight button in the comment view will show all phrases
	 in the text that relate to that comment.
	-Clicking on the user name in the user annotation list to a list of all the
	 user's comments and tags for the current text.
nsuit's avatar
nsuit committed
95 96 97 98
		
	
4. Download eComma comments
			
99 100 101 102 103 104 105 106 107 108 109
	-Download  eComma comments data as XML or import to Google docs
	spreadsheet. To download an XML file of the comment data, simply
	click download comments button at the top of the comment view panel.
	-If you need to export the data to a spreadsheet format you can import
	(stream) the xml directly and without downloading to a google spreadsheet. 
	  *You will need a google account to work with this method.
	  *You also need the text identification number of your ecomma text.
	   You can obtain the text id from the URL. It is the number that 
	   follows /ecomma/node/.
	  *Open a google spreadsheet and paste the following code into
	   the first cell:
nsuit's avatar
nsuit committed
110
		
111 112
	    =importXML("http://www.coerll.utexas.edu/ecomma/ecomma_comments_export/
	    [replace this (including brackets) with text-id]","//node")
nsuit's avatar
nsuit committed
113 114 115 116
	
	
5. Other drupal modules to consider

117
	-For collaborative class or group assignments try using the organic groups
118 119 120
	 module.
	-The eComma module provides some views through ecomma.views.inc that can be used
	 to run queries and download comment data.