From 67fb426f08b4bbedf8959c203fd6e4476adcee29 Mon Sep 17 00:00:00 2001
From: Timo Stollenwerk <timo@zmag.de>
Date: Fri, 27 Aug 2010 20:52:38 +0000
Subject: [PATCH] Javascript doc added.

svn path=/plone.app.discussion/trunk/; revision=39146
---
 .../browser/javascripts/javascripts.txt       | 42 +++++++++++++++++++
 1 file changed, 42 insertions(+)
 create mode 100644 plone/app/discussion/browser/javascripts/javascripts.txt

diff --git a/plone/app/discussion/browser/javascripts/javascripts.txt b/plone/app/discussion/browser/javascripts/javascripts.txt
new file mode 100644
index 0000000..59fffb5
--- /dev/null
+++ b/plone/app/discussion/browser/javascripts/javascripts.txt
@@ -0,0 +1,42 @@
+===============================
+plone.app.discussion Javascript
+===============================
+
+This document contains a description of how the plone.app.discussion javascript
+code works.
+
+HTML Structure
+--------------
+
+The "discussion" div contains all comments that have been posted to a specific
+content object. Each comment div has a unique id::
+
+  <div class="discussion">
+    <div class="comment" id="1282720906349675">
+      <h3 class="commentTitle"></h3>
+      <div class="documentByLine"></div>
+      <div class="commentBody"> </div>
+      <div class="commentActions">
+        <button class="reply-to-comment-button">Reply</button> 
+      </div>
+    </div>
+
+The comment form is rendered inside a "commenting" div::
+
+  <div id="commenting" class="reply">
+    <fieldset>
+      <legend i18n:translate="label_add_comment">Add comment</legend>
+      <p>
+        You can add a comment by filling out the form below. Plain text
+        formatting.
+      </p>
+      <form>
+        <div id="formfield-form-widgets-in_reply_to">
+          <input id="form-widgets-in_reply_to"
+                 name="form.widgets.in_reply_to" value=
+                 type="hidden" 
+           />
+        </div>
+      </form>
+    </fieldset>
+  </div>