From 5d3f588582ff0bd27df34139e4fae4517c177ba7 Mon Sep 17 00:00:00 2001
From: Patrick Simianer <p@simianer.de>
Date: Thu, 10 Mar 2016 15:49:41 +0100
Subject: improved help, hid meta stuff, fix db

---
 inc/db.inc.php               |  8 ++++++++
 inc/help.inc.php             | 24 ++++++++----------------
 inc/session-overview.inc.php |  4 ----
 interface.php                | 28 ++++++++++++++++++----------
 4 files changed, 34 insertions(+), 30 deletions(-)
 create mode 100644 inc/db.inc.php

diff --git a/inc/db.inc.php b/inc/db.inc.php
new file mode 100644
index 0000000..f08eda5
--- /dev/null
+++ b/inc/db.inc.php
@@ -0,0 +1,8 @@
+<?php
+
+$SESSION_DIR="/fast_scratch/simianer/lfpe/sessions";
+$json = file_get_contents($SESSION_DIR."/".$_GET["key"]."/data.json");
+$db = json_decode($json);
+
+?>
+
diff --git a/inc/help.inc.php b/inc/help.inc.php
index 0977776..c29d989 100644
--- a/inc/help.inc.php
+++ b/inc/help.inc.php
@@ -1,32 +1,31 @@
 <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 the post-edit is finished ('Target' text area is focused).</p>
+In the textual interface, you may just press return when the post-edit is finished (and 'Target' text area is in focus).</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>The session can be paused at any time and continued later -- just press 'Pause'. Note that we are collecting timing information, so pausing your session on inactivity is important for us. 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> 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 (phrases are highlighted in dark gray color).</p>
+<p>Mark all phrases as finished (phrases are highlighted in dark gray color) and press 'Next' to submit a post-edition in the graphical interface. Keyboard interface:</p>
 <ul>
-  <li><strong>Moving around:</strong> Press <strong>Shift+S</strong>, then select phrases using the arrow keys. This is the default mode.</li>
+  <li><strong>Moving around:</strong> Press <strong>Shift+S</strong>, then select phrases using the arrow keys. This is the default mode. Use <strong>Shift+I</strong> to jump to the first phrase, or <strong>Shift+O</strong> to the very last phrase.</li>
   <li><strong>Editing text:</strong> Double click on a phrase or press <strong>Shift+E</strong> to edit the contents of the current phrase. Press 'Return' to save.</li>
   <li><strong>Reordering of target phrases:</strong> Press <strong>Shift+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>Adding target phrases:</strong> To add a phrase right next to the currently selected one, press <strong>Shift+A</strong>.</li>
   <li><strong>Removing target phrases:</strong> Press <strong>Shift+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 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>Shift+U</strong> to undo alignments, text edits and deletion of phrases.</li>
-  <li><strong>Reset:</strong> Click 'Reset' button to start from scratch.</li>
+  <li><strong>Reset:</strong> Click 'Reset' button to restart editing of the current segment.</li>
 </ul>
 
 <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>
+<!--<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>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>
@@ -36,12 +35,5 @@ Alternatively, in the textual interface, you may just press return when the post
   <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"]; ?> |
-  <a href="http://postedit.cl.uni-heidelberg.de:<?php echo $db->port; ?>/debug" target="_blank">Debug</a>
-</p>
+</ul>-->
 
diff --git a/inc/session-overview.inc.php b/inc/session-overview.inc.php
index a6d46b8..793120a 100644
--- a/inc/session-overview.inc.php
+++ b/inc/session-overview.inc.php
@@ -1,9 +1,5 @@
 <?php
 
-$SESSION_DIR="/fast_scratch/simianer/lfpe/sessions";
-$json = file_get_contents($SESSION_DIR."/".$_GET["key"]."/data.json");
-$db = json_decode($json);
-
 $class = "";
 $i = 0;
 foreach($db->raw_source_segments as $s) {
diff --git a/interface.php b/interface.php
index 3dcffa9..8df7fd0 100644
--- a/interface.php
+++ b/interface.php
@@ -8,15 +8,18 @@
   <script src="js/raphael-min.js"                                   type="text/javascript" charset="utf-8"></script>
   <script src="js/derivation_editor/raphael.inline_text_editing.js" type="text/javascript" charset="utf-8"></script>
   <script src="js/derivation_editor/derivation-editor.js"           type="text/javascript" charset="utf-8"></script>
+  <script src="js/jquery.scrollTo.min.js"                           type="text/javascript" charset="utf-8"></script>
 </head>
 
 <body>
 
+<?php include("inc/db.inc.php"); ?>
+
 <?php include("inc/header.inc.php"); ?>
 
 <!-- Derivation editor -->
 <div id="derivation_editor">
-  <div id="holder"><img id="placeholder" src="static/placeholder.png" /></div>
+  <div id="holder" style="width:100px; overflow-x:scroll"></div>
 </div>
 <!-- /Derivation editor-->
 
@@ -47,6 +50,7 @@ Note that the source word may be distorted.
 
 <!-- Buttons -->
 <div>
+  <button id="help_button" class="button" onclick="$('#help').toggle('blind')">Help</button>
   <button id="pause_button" class='button' type="button" onclick="pause()">Pause</button>
   <button id="reset_button" class='button' type="button" onclick="DE_init()">Reset</button>
   <button id="next" type="button" class='button' onclick="next();">Start/Continue</button>
@@ -54,6 +58,19 @@ Note that the source word may be distorted.
 </div>
 <!-- /Buttons -->
 
+<!-- Help -->
+<div id="help">
+  <?php include("inc/help.inc.php"); ?>
+  <p class="tiny">
+    Support: <a href="mailto://simianer@cl.uni-heidelberg.de">Mail</a>
+  </p>
+  <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>
+</div>
+<!-- /Help -->
+
+
 <!-- Debug -->
 <div id="debug"></div>
 <!-- /Debug -->
@@ -67,15 +84,6 @@ Note that the source word may be distorted.
 </div>
 <!-- /Session overview -->
 
-<!-- Help -->
-<button id="help_button" class="button" onclick="$('#help').toggle('blind')">
-  Help
-</button>
-<div id="help">
-  <?php include("inc/help.inc.php"); ?>
-</div>
-<!-- /Help -->
-
 <?php include("inc/footer.inc.php"); ?>
 
 </body>
-- 
cgit v1.2.3