Dev: added comments to question index twig file.

templates/default/views/subviews/navigation/question_index_menu.twig

@@ -1,5 +1,28 @@
 {#
-    Shows the question index
+    LimeSurvey
+    Copyright (C) 2007-2017 The LimeSurvey Project Team / Louis Gac
+    All rights reserved.
+    License: GNU/GPL License v2 or later, see LICENSE.php
+    LimeSurvey is free software. This version may have been modified pursuant
+    to the GNU General Public License, and as distributed it includes or
+    is derivative of works licensed under the GNU General Public License or
+    other free or open source software licenses.
+    See COPYRIGHT.php for copyright notices and details.
+
+    (¯`·._.·(¯`·._.·  Question index  ·._.·´¯)·._.·´¯)
+
+    Show the question index in top menu.
+
+    There is two type of index:
+    - Full:         show all the questions/groups
+    - Incremental:  only show the previous questions/groups
+
+    There is two possible displays for index, depending on Survey Mode:
+    - Group by Group       : Survey mode is in Group By Group mode, so the entry of the index should be groups
+    - Question by Question : Survey mode is in Question By Question mode, so the entry of the index should be questions
+    - All in One           : No index needed
+
+    NOTE: This file is still too much complex. Before LS3 master release,  a lot of code should be bring back to SurveyRuntime helper, and the result made available to via an array aIndexMenu
 #}
 
 {% if aSurveyInfo.oSurvey.questionindex > 1 %}
@@ -8,6 +31,9 @@
     {% set indexType = 'incremental'  %}
 {% endif %}
 
+
+
+
 {# Question index in group by group mode #}
 {% if aSurveyInfo.format == 'G' %}
     <!-- Question index, group, {{ indexType }} -->