tkriplean / slash-reflect-sandbox Goto Github PK

Reflect implements an interface change to the comments section that helps people listen, while at the same time producing useful summaries. Next to every comment, readers are prompted to succinctly restate/summarize a point they hear the commenter making. The summaries are displayed in a bulleted list. Commenters can engage with summarizers to make sure that the summarized points accurately portray the points they were trying to make.

== Dependencies ==

1. The Ajax Slash plugin. 
2. jQuery 1.3+

== Installing Reflect into Slashcode ==

1. Create a Reflect directory in your Slashcode plugin directory and clone this repo. 

    git clone [email protected]:tkriplean/Slash-Reflect-sandbox.git /path/to/slashcode/plugins/Reflect

2. Run the slash installer or plugin installer. Make sure to select the Reflect and Ajax plugins. 

3. Add the following to the appropriate place in your theme's templates (e.g. themes/templates/html-header):

	[% IF constants.plugin.Reflect && (user.currentPage == "article" || user.currentPage == "comments") && story_title -%]
	   [% commentstatus = Slash.db.sqlSelect('commentstatus', 'discussions', "title='$story_title'"); -%]
	   [% IF commentstatus=='reflect_enabled' -%]
	      <script src="/js/reflect.third_party.min.js" type="text/javascript"></script>
	      <script src="/js/reflect.js" type="text/javascript"></script>
	      <script src="/js/reflect.slash.js" type="text/javascript"></script>
	   [% END -%]
	[% END -%]


4. Depending on the theme you are using, you may have to modify some of the settings in /js/reflect.slash.jsraw. Currently it is ready for the current Slashdot theme and the slashcode theme. 

5. Integrate plugin:
    /path/to/slashcode/bin/symlink-tool -U
    /path/to/slashcode/bin/template-tool -U

6. Win!

== Uninstalling Reflect ==

SQL: 
    DELETE FROM css WHERE file IN ('css/reflect.slash.css', 'css/reflect.css');
    DELETE FROM message_codes WHERE type='Reflect summary';

	UPDATE discussions set commentstatus='enabled' where commentstatus='reflect_enabled';
	ALTER TABLE discussions MODIFY COLUMN commentstatus ENUM('disabled','enabled','friends_only','friends_fof_only','no_foe','no_foe_eof','logged_in');

    DROP TABLE reflect_bullet;
    DROP TABLE reflect_bullet_revision;
    DROP TABLE reflect_bullet_rating;
    DROP TABLE reflect_response;
    DROP TABLE reflect_response_revision;
    DROP TABLE reflect_highlight;