4 <title>User documentation for TiledViz</title>
5 <link rel="stylesheet" href="doc_style_light.css" />
8<h1>User documentation for TiledViz</h1>
10<p>This documentation aims to provide the user of TiledViz with basic knowledge about the interface and how to use it.</p>
14<p>The tiles may contain an image, a video, or other kind of visual data.
15<img style="background-color:black" src="tiles.png" alt="Schematic tile" /></p>
19<p>On the left side of the tile, the black vertical zone enables to interact with the environment. It will be called the “hitbox” in the following.</p>
21<p>Its color changes according to the current action :</p>
33<td> The mouse is over the tile (only with desktop browsers).</td>
37<td> The tile is selected to be swapped with another one.</td>
41<td> The tile is selected for zoom mode or master-slave mode.</td>
49<p>On the right side, a vertical blank zone is designed to show the stickers of the tiles. These are colored squares representing filters or tags given to the tile. Each time they are shown, a legend is also displayed at the top of the screen.</p>
53<p>At the bottom left corner, a hand-shaped icon is dedicated to drag and drop actions.</p>
55<p>Its color changes according to the current state of the tile:</p>
68<td><img style="background-color:black" src="/static/images/tiles/drag-handle-on.png" alt="Handle-on" /></td>
69<td> The tile may be drag-and-dropped.</td>
73<td><img style="background-color:black" src="/static/images/tiles/drag-handle-dragging.png" alt="Handle-dragging" /></td>
74<td> The tile is currently draggable.</td>
78<td><img style="background-color:black" src="/static/images/tiles/drag-handle-off.png" alt="Handle-off" /></td>
79<td> Drag-and-drop is not available at this time.</td>
85<h2>Interacting with the tiles</h2>
89<p>For the movements, the animation and animation speeds can be defined in the config file.</p>
91<h4>Swapping two individual tiles</h4>
93<p>The tiles are not exactly swapped, rather, the second one is moved next to the first one, and the neighbouring tiles are re-arranged to preserve the coherence of the data.
94This action can be undone with the “Undo” button of the Global menu.</p>
100<th> Behaviour on desktop browser </th>
101<th> Behaviour on WildOS</th>
106<td>1. Hover over the first tile. </td>
107<td> The hitbox becomes dark red. </td>
108<td> The hitbox stays black (the cursor is not detected by design).</td>
111<td>2. Click on the hitbox. </td>
112<td> It becomes red. </td>
113<td> It becomes red.</td>
116<td>3. Hover over the second tile. </td>
117<td> Its hitbox becomes dark red. </td>
118<td> Its hitbox stays black.</td>
121<td>4. Click on the hitbox of the second tile. </td>
129<h4>“Drag-and-drop”-ing tiles (only on desktop browsers)</h4>
131<p>This can be done when selecting the little hand at the bottom left corner of the tile and moving it to its destination. Like with the swap, the two tiles become contiguous, rather than really swapping their position.</p>
133<p>When drag and dropping a transparent tile, the tile is ovelapped on the underlaying tile, enabling the user to compare
134data by transparency.</p>
136<p>Options in <code>config_default.js</code> as well as in the option menu enable to unload the tile when dragging (“Move only a
137border”) or to move them along a grid (“Move on grid”).</p>
139<h4>Swapping entire lines or columns</h4>
141<p>The two last options in the individual menu of each tile allow the user to swap the line (resp. column) of this tile
142with another line (resp. column) by clicking the same button on a tile of the destination line (resp. column). See
143documentation on these icons (in the <em>Tile menu</em> section) for more information.</p>
146<h2> Global menu </h2>
147<p><div id="GlobalMenu" alt="Preview of the tag menu" title="Preview of the tag menu">
148 <img style="background-color:black" src="/static/images/icons/globalmenu/search.png" title="" />
149 <img style="background-color:black" src="/static/images/icons/globalmenu/clearSelection.png" title="" />
150 <img style="background-color:black" src="/static/images/icons/globalmenu/nextTiles.png" title="" />
151 <img style="background-color:black" src="/static/images/icons/globalmenu/Rotate.png" title="" />
152 <img style="background-color:black" src="/static/images/icons/globalmenu/refresh.png" title="" />
153 <img style="background-color:black" src="/static/images/icons/globalmenu/tags.png" title="" />
154 <img style="background-color:black" src="/static/images/icons/globalmenu/Action.png" title="" />
155 <img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/zoom.png" title="" />
156 <img style="background-color:black" src="/static/images/icons/globalmenu/management/options.png" title="" />
157 <img style="background-color:black" src="/static/images/icons/globalmenu/statemenu/showInfo.png" title="" />
158 <img style="background-color:black" src="/static/images/icons/globalmenu/openNodeMenu.png" title="" />
159 <img style="background-color:black" src="/static/images/icons/globalmenu/cancel/back.png" title="" />
160 <img style="background-color:black" src="/static/images/icons/globalmenu/updown/up_arrow.png" title="" />
164<p>The menu lies on the left side of the interface. For each option or item in the global menu, the tag menu or the tile menu, the icon will appear white if the option is not selected or used, and grey if it is selected. To select a menu item, you have to click on it. If you entered an option and do not wish anymore to go further with it, clicking on the grey icon will exit it.</p>
166<h3><img style="background-color:black" src="/static/images/icons/globalmenu/search.png" alt="Icon to search with filters" /> Filter with keywords</h3>
168<p>Type keywords in the research bar, they will be matched with a list of keywords extracted from the meta-data of the tiles. Auto-completion is enabled for this field. The “&” can be used to combine several keywords. Upon hitting “Enter”, the tiles corresponding to the keywords are moved to the top, and little stickers appears on their right side to show to which keyword(s) they fit. The legend for the colors is shown at the top right of the interface.</p>
170<ul style="list-style-type: normal;" id="list">Filter node through tags and zoom on
172 <li> <ul> Launch a simple research
173 <li> type the keyword in the search bar and press enter :
174 <br> the matchiang nodes will move to the top of the grid, the
175 other ones will stay at the bottom and become darker.
179 <li> <ul> Launch a multiple research
180 <li> type the keywords in the search bar, using the symbol "&" as separator
181 ("pressure&heat" to search for both terms) :
183 <li> a legend with different colors will be shown at the top of the screen.
185 <li> Clean search : click on the Eraser icon on the upper-right corner. <br>
186 This filter use Jquery UI modules : autocompletes, see https://jqueryui.com/autocomplete/ for details
192<h3><img style="background-color:black" src="/static/images/icons/globalmenu/clearSelection.png" alt="Icon for to clear all selections on the grid" /> Clear all selections</h3>
194<p> Click on the icon clear all the selections on the session.</p>
196<h3><img style="background-color:black" src="/static/images/icons/globalmenu/nextTiles.png" alt="Show next tiles" /> Show next tiles</h3>
198<p> Click on the icon will reorganize the grid and show the next page of tiles below.</p>
200<h3><img style="background-color:black" src="/static/images/icons/globalmenu/Rotate.png" alt="Icon to rotate a tile" /> Rotate tiles</h3>
202<p>Shows little rotation icons for each tile (only activated with a touch table or a tablet if it is detected).</p>
204<h3><img style="background-color:black" src="/static/images/icons/globalmenu/refresh.png" alt="Icon to revert a tile" /> Refresh tiles</h3>
206<p>Refresh all the nodes with their original sources.</p>
208<h3><img style="background-color:black" src="/static/images/icons/globalmenu/tags.png" alt="Icon for tags menu" /> Menu for tags</h3>
210<p> Tags are representation of metadata of each tile. </p>
212<p> You can sort, select, hide or delete tiles with them in this menu. And you manage them : add or remove tags</p>
213<p> See below in Tags menu section.</p>
215<h3><img style="background-color:black" src="/static/images/icons/globalmenu/Action.png" alt="Icon for actions menu" /> Menu for actions on each TileSets</h3>
217<p> Actions are specific functions programmed with each tilesets. </p>
219<p> Action functions are programmed in the case python script for CONNECTION TileSets only.</p>
220<p> You can programm change of the source and with the first button it will force TiledViz to update </p>
221<p> the list of nodes and the metadata (title, tags, ...).</p>
223<h3><img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/zoom.png" alt="Icon for zooms menu" /> Zoom sub-menu</h3>
225<p> All zoom functions on tiles : Global, master-slave, fast zoom.</p>
227<h3><img style="background-color:black" src="/static/images/icons/globalmenu/management/options.png" alt="Icon for managements menu" /> Management sub-menu</h3>
229<p> All management functions : Draws, save, options, help.</p>
231<h3><img style="background-color:black" src="/static/images/icons/globalmenu/statemenu/showInfo.png" alt="Icon for information" /> Informations</h3>
233<p>Clicking on this icon displays the title (or name) of each tile at their upper right corner, if this feature is not
234activated by default in the Settings menu.</p>
236<h3><img style="background-color:black" src="/static/images/icons/globalmenu/openNodeMenu.png" alt="Icon to open the tile menus" /> Menu for Tile</h3>
238<p> In this menu, you can write information or draw on each tile. You can sort with column or lines with one tile.</p>
239<p> See below in Tile menu section.</p>
241<h3><img style="background-color:black" src="/static/images/icons/globalmenu/cancel/back.png" alt="Cancel menu" /> Menu for cancel/redo tiles moves' menu</h3>
243<p> Cancel/Redo and buttons </p>
245<h3><img style="background-color:black" src="/static/images/icons/globalmenu/updown/up_arrow.png" alt="UpDown menu" /> Menu for moving up and down lines</h3>
247<p> Up and Down buttons : all the grid will switch a line. </p>
248<p> For up button, the first line will go to be the last one and for down it will be the last one wich appear at the first line position.</p>
252<h2><img style="background-color:black" src="/static/images/icons/globalmenu/tags.png" alt="Icon for tags menu" /> Tags menu </h2>
253<p>This icon opens the tag menu and shows the tags on the tiles, and the legend of already present tags. It allows further operations on the tags.</p>
255<p><div id="TagMenu" alt="Preview of the tag menu" title="Preview of the tag menu">
256 <img style="background-color:black" src="/static/images/icons/tagmenu/alignTags.png" title="Switch align/group similarly tagged nodes" />
257 <img style="background-color:black" src="/static/images/icons/tagmenu/alignOrderTags.png" title="Menu Order floatting tagged nodes" />
258 <img style="background-color:black" src="/static/images/icons/tagmenu/HideTag.png" title="Menu Hide/Show nodes with tags menu" />
259 <img style="background-color:black" src="/static/images/icons/tagmenu/KillTag.png" title="Switch kill tiles with selected tag" />
260 <img style="background-color:black" src="/static/images/icons/tagmenu/selection/selectTags.png" title="Menu selections" />
261 <img style="background-color:black" src="/static/images/icons/tagmenu/management/addTag.png" title="Menu tags management" />
265<h4>Give a tag to a tile</h4>
267<p>Click on the tag in the legend, it will get a red border. Then, you have to click on the hitbox of the tile to see the tag appear on its right side.</p>
269<h4>Remove a tag from a tile</h4>
271<p>Click on the sticker to remove a single tag from a tile.</p>
273<h4><img style="background-color:black" src="/static/images/icons/tagmenu/alignTags.png" alt="Icon to group the tiles" /> Group all tiles with the same tag</h4>
275<p>Click on this icon, then on a tag in the legend. All the tiles bearing this tag (as displayed by their stickers) will be moved towards the upper left corner of the grid.</p>
277<h4><img style="background-color:black" src="/static/images/icons/tagmenu/alignOrderTags.png" alt="Change sort order with align/group tags function." /> Change sort order with align/group tags function.</h4>
279<p>Click on this icon, then a menu for sort order appear. Default order is ascendant. Client to descendant button to change it for next alignTags action.</p>
281<h4><img style="background-color:black" src="/static/images/icons/tagmenu/HideTag.png" alt="hide nodes with the tags" /> Hidding nodes with the tags</h4>
283<p>Click on this button then click on a tag to hide all nodes with this tag. Click again on this button an a tag and unhide all nodes with this other tag.</p>
285<h4><img style="background-color:black" src="/static/images/icons/tagmenu/KillTag.png" alt="kill nodes with the tags" /> Kill nodes with the tags</h4>
287<p>Suppress all nodes with selected tags.</p>
289<p>All suppressed nodes are not saved if save button is clicked in global menu.</p>
291<h3> Selections and Tags sub-menu </h3>
293<h4><img style="background-color:black" src="/static/images/icons/tagmenu/selection/selectTags.png" alt="Icon to select the tiles" /> Select tiles with the same tag</h4>
295<p>Click the zoom or MS global menu icon, then click on tag menu to enable tag
296 selection with this icon. Click on a tag in the legend. All the tiles bearing this
297 tag (as displayed by their green hitbox) will be selected for the first action.</p>
299<h4><img style="background-color:black" src="/static/images/icons/tagmenu/selection/selectionToTag.png" alt="Selection to tag" /> Selection to a tag</h4>
301<p>Link actual selection to a tag after click on this button.</p>
303<h4><img style="background-color:black"
304 src="/static/images/icons/tagmenu/selection/MultipleTags.png" alt="Multiple tags selection" /> Multiple tags selection</h4>
306<p>Build union of tiles of multiple tags in a new Sel# tag. If you click any other
307 tag tools, it close the actuel multiple tags selection.</p>
309<h3> Tags management sub-menu </h3>
311<h4><img style="background-color:black" src="/static/images/icons/tagmenu/management/addTag.png" alt="Icon to add a tag" /> Add a tag</h4>
313<p>Prompts a text field to enter the name of the new tag. Please avoid to insert special characters, they should be treated and replaced, but it may cause further problems.</p>
315<h4><img style="background-color:black" src="/static/images/icons/tagmenu/management/removeTag.png" alt="Icon to remove a tag" /> Remove a tag</h4>
317<p>Click on this icon, then on the tag to remove in the legend. The tag will disappear, as well as the corresponding stickers on the tiles.</p>
319<h4><img style="background-color:black" src="/static/images/icons/globalmenu/brush.png" alt="Icon to erase the tags" /> Erase the tags</h4>
321<p>Clicking on this icon will remove all the tags and the stickers.</p>
323<h4><img style="background-color:black" src="/static/images/icons/drawmenu/palette.png" alt="Palette to change drawing color" /> Change color of a tag</h4>
325<p>Clicking on this icon will open a palette. You can click on a tag and change its colors by choosing a new on in the palette.</p>
328<h2> Zoom Global Menu </h2>
330<p>Once the zoom interface with all the tiles appears, you can then move them all at once.</p>
332<h3><img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/zoom.png" alt="Icon to zoom on nodes" /> Zoom</h3>
334<p>After clicking on this icon, select the tiles you wish to zoom on. To select them, click on the corresponding hitbox on the left of the tile, it will become green, meaning that the tile has correctly been selected.</p>
336<p>Then, click on the button <img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/validateZoomSelection.png" alt="Icon to expand selected nodes" /> to expand the view to only the selected nodes.</p>
338<p>To go back to the initial view, click again on the button <img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/closeZoomButton.png" alt="Icon to unzoom selected nodes" /> .</p>
340<h3><img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/masterslave.png" alt="Icon for Master-slave mode" /> Master-slave mode</h3>
342<p>This mode enables to control all selected tiles using one of them as a controller.
343 It gives a parallel interaction on iteractive tiles without any adaptation on the TileSet case.</p>
344<p> Every move or key hit on the Master Tile will be replicated on other chosen tiles.</p>
345<p> Note that keyboard will work only after user has given the hand to the master tile by clicking on the title bar or on the grey part on the sides.</p>
347<p>To chose tiles, click on the hitbox, that will become green.
348 then, click on the button <img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/validateZoomSelection.png" alt="Selected nodes for master slave" />
349 to activate master-slave mode on this selection.
352<h3><img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/zoomNode.png" alt="Icon for individual zoom" /> Individual zoom</h3>
354<p>Adds a Zoom icon at the bottom right corner of each tile: when clicked, the tile is magnified.</p>
357<h2> Management Buttons </h2>
359<h3><img style="background-color:black" src="/static/images/icons/globalmenu/management/drawManagement.png" alt="Global menu for draws" /> Draws management</h3>
361<p>This menu is used to manage draws reported by the draw on a tile button in draw menu.</p>
363<p>A tabular is given for each reported draw with the number of the origin of the draw in first column and the number of clones on all nodes reporting on second column.</p>
365<p>If you click on the first check box, it will erase the draw and all its clones and the second check box will only hide all the draws.</p>
367<h3><img style="background-color:black" src="/static/images/icons/globalmenu/management/save.png" alt="Icon to save the notes" /> Save</h3>
369<p>Upon clicking on this button, the notes written for each tile, the tags and the position of the tiles are saved in an auxiliary file which can later be reopened to continue the session or to be used as a starting point for the next.</p>
371<h3><img style="background-color:black" src="/static/images/icons/globalmenu/management/options.png" alt="Icon for settings" /> Settings</h3>
373<p>This icon opens the settings menu, that will allow (in the next versions) to change on the fly some parameters of the application.</p>
376<h2> Info and state of tiles global menu</h2>
378<h3><img style="background-color:black" src="/static/images/icons/globalmenu/statemenu/OnOff.png" alt="Icon to turn on/off the tiles" /> On/off buttons</h3>
380<p>Creates at the top of each tile hitbox a green square bearing its initial number on the grid.
381Clicking on it unloads the content of the tile (the square becomes red, clicking on it again reloads the content), which
382could allow for better performance.</p>
384<p><strong>Below</strong>: on the left, an “on” tile: green square, content loaded; on the right, an “off” tile: red square, content
387<p><img style="background-color:black" src="on_off_option.png" alt="Exemple" /></p>
389<p>All off-nodes are not saved if save button is clicked in global menu.</p>
391<p><strong>Note</strong>: May conflict with the QR codes option, since their icons are both located at the bottom right corner of the
394<h3><img style="background-color:black" src="/static/images/icons/globalmenu/statemenu/QRcode.png" alt="Icon for QR codes" /> QR codes</h3>
396<p>Adds a QR code at the bottom right corner of each tile: when scanned with a tablet, the tablet will show the zoomed
399<p><strong>Note</strong>: May conflict with the individual zoom option, since their icons are both located at the bottom right corner of the
406<p><img style="background-color:black" src="tilemenu.png" alt="Preview of the tile menu" /></p>
408<p>The first icon opens the Tile menu on each tile, and gives access to its options.</p>
410<h4><img style="background-color:black" src="/static/images/icons/nodemenu/transparent.png" alt="Icon for transparency" /> Transparency</h4>
412<p>Clicking on this icon makes the related tile transparent, and will allow (in a next version) to overlay it on other tiles to enhance various phenomenons or to compare data.</p>
414<h4><img style="background-color:black" src="/static/images/icons/nodemenu/write.png" alt="Icon for notes" /> Notes</h4>
416<p>Creates a post-it on the tile to write observations on its content.
417Post-its are saved when the user clicks on the “Save” icon of the Global menu.</p>
419<h4><img style="background-color:black" src="/static/images/icons/nodemenu/draw.png" alt="Icon for draw" /> Draw</h4>
421<p> Draw menu is explained on section below.</p>
423<h3><img style="background-color:black" src="/static/images/icons/nodemenu/column.png" alt="Icon to swap columns" /> Column swap</h4>
425<p>Click on the icon on a tile of the first column to be swapped, this column will then appear with a green border. Then click on the icon on a tile of the second column, to swap the two selected set of tiles. Depending on the configuration of TiledViz, an animation may be shown.</p>
427<h3><img style="background-color:black" src="/static/images/icons/nodemenu/line.png" alt="Icon to swap lines" /> Line swap</h4>
429<p>Click on the icon on a tile of the first line to be swapped, this line will then appear with a yellow border. Then click on the icon on a tile of the second line, to swap the two selected set of tiles. Depending on the configuration of TiledViz, an animation may be shown.</p>
434<p>Opens the draw menu and enables drawing on the tile, to enhance a phenomenon for example. This fonction is more suited to static images.</p>
436<p><img style="background-color:black" src="drawmenu.png" alt="Preview of the draw menu" /></p>
438<h5><img style="background-color:black" src="/static/images/icons/drawmenu/palette.png" alt="Palette to change drawing color" /> Choose colors</h5>
440<p>Opens a pop-up window with a color wheel, allowing the user to select a suitable color.</p>
442<h5><img style="background-color:black" src="/static/images/icons/drawmenu/lineWidth.png" alt="Choose line width" /> Choose line width</h5>
444<p>Enables to change the width of the drawing.</p>
446<h5><img style="background-color:black" src="/static/images/icons/globalmenu/brush.png" alt="Erase drawing" /> Erase the drawing</h5>
448<p>Erases the drawing and let the user start again.</p>
450<h5><img style="background-color:black" src="/static/images/icons/globalmenu/management/save.png" alt="Save drawing" /> Save the drawing</h5>
452<p>Prompts a window to save the drawing. Only the lines drawn on the tile will be saved, a script is then provided to combine the original image and the drawing (still in progress), maybe another smoother solution will be found later.</p>
454<h5><img style="background-color:black" src="/static/images/icons/drawmenu/drawonNode.png" alt="Transfer draw" /> Transfer a draw on the tile</h5>
456<p>Rescale the draw to be printed on the tile in grid view mode.</p>
458<h5><img style="background-color:black" src="/static/images/icons/globalmenu/zoommenu/masterslave.png" alt="Transfer all draw" /> Transfer a draw on all tiles</h5>
460<p>Report the draw on all tiles to simplify comparisons in grid view mode.</p>
463<h2> Cancel/Redo buttons </h2>
465<h3><img style="background-color:black" src="/static/images/icons/globalmenu/cancel/back.png" alt="Icon to undo last action" /> Cancel last movement</h3>
467<p>Clicking on this button cancels the last movement of tiles ; if the last user-made move involved several intermediate states, it will be necessary to click multiple times on the button to cancel this action.</p>
469<h3><img style="background-color:black" src="/static/images/icons/globalmenu/cancel/forward.png" alt="Icon to redo last cancelled action" /> Repeat last cancelled action</h3>
471<p>Like with the “Undo last action”, the user will have to repeat clicking on this icon if they wishes to redo a move composed of multiple individuals moves.</p>
474<h2> Up and Down buttons </h2>
476<h3><img style="background-color:black" src="/static/images/icons/globalmenu/updown/up_arrow.png" alt="Icon to go up" /> Up arrow</h3>
478<p>Moves the grid one row up (to use when scrolling is not available, ie with WildOS).</p>
480<h3><img style="background-color:black" src="/static/images/icons/globalmenu/updown/down_arrow.png" alt="Icon to go down" /> Down arrow</h3>
482<p>Moves the grid one row down (to use when scrolling is not available, ie with WildOS).</p>
487<p>The Dark color theme corresponds to light text on a dark background, and is more suited to be displayed on Mandelbrot, whereas the Light mode is black on white, more confortable on desktops. Those themes are applied for the option menu and the help page.</p>
489<h3><img style="background-color:black" src="/static/images/icons/globalmenu/management/help.png" alt="Icon for help: Interrogation mark" /> Help</h3>
491<p>Opens the help page; to close it, click again on the interrogation mark.</p>
494<h2>Configuration</h2>
496<h3>Default configuration</h3>
498<p>A default configuration is loaded by TiledViz from the <code>config_default.js</code> file. It contains the following parameters
499* Colors: for the different stickers (for filters and tags), and markers of state (selected tile, tile to be zoomed, …)
500* Tile configuration: how to use the parameters contained in tiles.js
501* Behavioural constants: number of tiles, of columns, should they be fixed, spaces between tiles, …</p>
503<h3>Custom configuration</h3>
505<p>In order to specify custom parameters and to enhance the user experience, it is possible to add in the Case folder a copy of <code>config_default.js</code> (to be named <code>config.js</code>). It is not mandatory to add in this custom file all the parameters from the default configuration file, but one has to be cautious of the syntax when writing those custom parameters.</p>
510<th>In <code>config_default.js</code> </th>
511<th> In <code>config.js</code> </th>
512<th> Result in TiledViz</th>
517<td><code>param_1 = value_1</code> </td>
518<td> <code>param_1 = value_2</code> </td>
519<td> <code>param_1 = value_2</code></td>
522<td><code>param_1 = value_1</code> </td>
523<td> Nothing or no <code>config.js</code> </td>
524<td> <code>param_1 = value_1</code></td>