From 53e8b1106a1ebaf13a5482477b67e04aacd4405d Mon Sep 17 00:00:00 2001
From: Patrick Simianer <p@simianer.de>
Date: Wed, 17 Feb 2016 18:05:27 +0100
Subject: prep/notes for beta test, get feature weights/rates

---
 inc/help.inc.php | 32 +++++++++++++++++++-------------
 1 file changed, 19 insertions(+), 13 deletions(-)

(limited to 'inc')

diff --git a/inc/help.inc.php b/inc/help.inc.php
index 2bd511e..9f2e7f6 100644
--- a/inc/help.inc.php
+++ b/inc/help.inc.php
@@ -1,41 +1,47 @@
 <p>Press the 'Next' button to <strong>submit</strong> your post-edit and to request the next segment for post-edition.
-Alternatively, in the textual interface, you may just press return when you finished the post-edit ('Target' text area is in focus).</p>
+Alternatively, in the textual interface, you may just press return when the post-edit is finished ('Target' text area is focused).</p>
 
-<p>The session can be paused at any time and continued later; However, if you have to pause your session, wait until the activity notification disappears and then press 'Pause', as we are collecting timing information. You may also just reload this site and re-request the segment to reset the timer.</p>
+<p>The session can be paused at any time and continued later; However, if you have to pause your session, wait until the activity notification disappears and then press 'Pause', as we are collecting timing information. You may also just reload this site upon your return and re-request the segment to reset the timer.</p>
 
-<p>Please use only a <strong>single browser window</strong> at the same time. Going back to earlier examples is not possible, please take great care when interacting with the system.</p>
+<p>Please use only a <strong>single browser window</strong> per session at the same time. Going back to earlier examples is not possible, please take great care when interacting with the system.</p>
 
 <p><span style="border-bottom:1px solid #ccc">Instructions for the graphical interface:</span></p>
-<p>To submit a post-edition in the graphical interface all phrases have to be marked as finished.</p>
+<p>To submit a post-edition in the graphical interface all phrases have to be marked as finished (phrases are highlighted in dark gray color).</p>
 <ul>
-  <li><strong>Moving around:</strong> Press <strong>'S'</strong>, then select phrases using the arrow keys.</li>
+  <li><strong>Moving around:</strong> Press <strong>'S'</strong>, then select phrases using the arrow keys. This is the default mode.</li>
   <li><strong>Editing text:</strong> Double click on a phrase or press <strong>'E'</strong> to edit the contents of the current phrase. Press 'Return' to save.</li>
-  <li><strong>Reordering of target phrases:</strong> Press <strong>'M'</strong>, then use the arrow keys to move the selected phrase. Press 'Return' to fix the position.</li>
-  <li><strong>Mark phrase as finished:</strong> Press <strong>'Return'</strong> to mark phrases as finished (press 'Return' again to undo). Moving, editing or deleting of finished phrases is not possible.</li>
-  <li><strong>Adding target phrases:</strong> To add a phrase right next to the currently selected one press <strong>'A'</strong>.</li>
+  <li><strong>Reordering of target phrases:</strong> Press <strong>'M'</strong>, then use the arrow keys to move the selected phrase. Press 'Return' to fix its position.</li>
+  <li><strong>Mark phrase as finished:</strong> Press <strong>'Return'</strong> to mark phrases as finished (press 'Return' again to undo). Moving, editing, aligning or deleting of finished phrases is not possible.</li>
+  <li><strong>Adding target phrases:</strong> To add a phrase right next to the currently selected one, press <strong>'A'</strong>.</li>
   <li><strong>Removing target phrases:</strong> Press <strong>'D'</strong> to delete the currently selected phrase.</li>
-  <li><strong>Adding/removing alignments:</strong> Select a source phrase by clicking on it, then click on a suitable target phrase to connect or disconnect. Click the selected source phrase again to cancel.</li>
+  <li><strong>Adding/removing alignments:</strong> Select a source phrase by clicking on it, then click on a target phrase to connect or disconnect it with the selected source phrase. Click the selected source phrase again to cancel.</li>
   <li><strong>Undo:</strong> Press <strong>'U'</strong> to undo alignments, text edits and deletion of phrases.</li>
   <li><strong>Reset:</strong> Click 'Reset' button to start from scratch.</li>
 </ul>
 
-<p>The interface was tested with Firefox 31, 38 and 43.</p>
+<p>The interface was tested with <strong>Firefox</strong> 31, 38 and 43.</p>
 
 <p><span style="border-bottom:1px solid #ccc">Known issues:</span></p>
 <ul>
   <li>The width of the canvas of graphical editor may be to small when adding a lot of phrases.</li>
   <li>The in-line editor may change height and span several lines.</li>
   <li>When editing phrases that have no contents, the input box is lower than normal.</li>
-  <li>Post-edits in the session overview may be partially tokenized due to phrase segmentation.</li>
-  <li>Horizontal scrollbar doesn't follow highlighted phrase.</li>
+  <li>The horizontal scrollbar doesn't follow highlighted phrase.</li>
   <li>Mouseover is not detected for undoing.</li>
   <li>The interface only works with Firefox.</li>
 </ul>
 
+<p><span style="border-bottom:1px solid #ccc">Notes on debugging:</span></p>
+<ul>
+  <li>If the <em>string</em> of the translation is not changed (compared to the original MT output), there will be no pairwise ranking update. </li>
+  <li>New rules are added (and known rules are annotated) in a leave-one-out fashion. Amongst other things, this implies that 'new' rules will first receive a weight upon their second occurrence. As OOV rules are added prior to translation, they are added immediately.</li>
+  <li>Most tables are sortable (click on respective column in header row).</li>
+</ul>
+
 <p class="tiny">
   Support: <a href="mailto://simianer@cl.uni-heidelberg.de">Mail</a>
 </p>
-<p class="tiny">Session: #<?php echo $_GET["key"]; ?> |
+<p class="tiny">Session: <?php echo $_GET["key"]; ?> |
   <a href="http://postedit.cl.uni-heidelberg.de:<?php echo $db->port; ?>/debug" target="_blank">Debug</a>
 </p>
 
-- 
cgit v1.2.3