diff src/DML/MainVisBundle/Resources/views/Components/templates/help-content.html.twig @ 0:493bcb69166c

added public content

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/DML/MainVisBundle/Resources/views/Components/templates/help-content.html.twig	Tue Feb 09 20:54:02 2016 +0100
@@ -0,0 +1,83 @@
+{%- jstmpl id="help-content" -%}
+<h1 data-id="" data-toc="Help &amp; Info">{{ project.title }} VIS – a tool for analysing large music collections</h1>
+
+<h2>Demo video</h2>
+<p>The video <a target ="_blank" href="https://vimeo.com/123985996">can be watched in high definition on Vimeo</a>.</p>
+<iframe style="margin-top: .5em;" src="https://player.vimeo.com/video/123985996?color=fff&title=0&byline=0&portrait=0" width="700" height="350" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
+
+<h2>Functionality</h2>
+<p>DML VIS enables you to explore, analyse and compare music recordings from three large libraries originating from the British Library's Sound Archives, CHARM and I Like Music{# (see ‘<a class="a_type_pseudo" href="#help/datasets">datasets</a>’ section below)#}.
+{#-#}</p>
+
+<p>The interface operates in two modes – <span class="mode mode_collection">collection-level analysis</span> and <span class="mode mode_recording">recording level analysis.</span>
+{#-#} You can switch between the modes by clicking on the button at the top-right corner of the screen.
+{#-#}</p> 
+
+<p>Collections and recordings are represented by columns and their different views are represented by rows.
+{#-#}</p>
+
+<p><span class="mode mode_collection mode_no-margin-left">Collections,</span> being a set of recordings that fulfil certain search criteria, are defined in the top row of the screen.
+{#-#} For example, to select all recordings of music by Mozart available from the British Library, one should tick the BL library on the left, specify ‘Mozart’ in the ‘composer’ field and then click ‘apply’ <span class="config-grid-panel-command-demo config-grid-panel-command-demo_action_apply"></span> button on the left or press <i class="key">Enter</i>. The available search fields vary dynamically according to the selected libraries. You may select any combination of the three libraries on the left, and watch the search criteria change accordingly.
+{#-#}</p>
+
+<p>Views, represented by rows, visualize summaries of features extracted from the collection.</p> 
+
+<p>The simplest view is the list of recordings.
+{#-#} You can use the list to play tracks (this is only possible for certain recordings due to copyright).
+{#-#} You can select individual recordings from the list by clicking the green dot next to them.
+{#-#} This will have the effect that the selected recordings will appear when you switch to the <span class="mode mode_recording">music recording analysis</span> mode for looking at individual recordings (by clicking at the top-right corner).
+{#-#}</p>
+
+<p>Other views include pitch and tempo related features.
+{#-#} You can obtain a brief description of each by selecting it from the drop-down menu in the left sidebars.
+{#-#}</p>
+
+<p>You can duplicate and delete currently selected columns or rows by clicking on the ‘duplicate’ <span class="config-grid-panel-command-demo config-grid-panel-command-demo_action_clone"></span> / ‘delete’ <span class="config-grid-panel-command-demo config-grid-panel-command-demo_action_delete"></span> buttons.
+{#-#} If you double-click a header of a column, a comparison column will appear, consisting of either a superposition or the difference between the column and the one to its right.
+{#-#}</p>
+
+<p>A typical workflow may involve duplicating and modifying.
+{#-#} For example, once you’ve duplicated a column, you can refine the selection criteria in the top row, and select the ‘apply’ <span class="config-grid-panel-command-demo config-grid-panel-command-demo_action_apply"></span> button for the modification to take effect.
+{#-#} Another typical workflow is duplicate, modify and compare.
+{#-#}</p>
+
+<h2>Datasets</h2>
+<p>DML VIS is currently connected to three large music collections, which vary significantly in size, provenance and character.</p> 
+
+<p class="p_indented">The <b>BL</b> collection contains a curated subset of the British Library Sounds Archive, (<a target="_blank" href="http://sounds.bl.uk/">sounds.bl.uk</a>) currently consisting of nearly 50,000 individual recordings, out of which nearly 30,000 are from the World and traditional music collection and nearly 20,000 from the Classical music collection.</p>
+
+<p class="p_indented">The <b>CHARM</b> collection contains nearly 5,000 individual recordings, digitised by the AHRC-funded CHARM project (<a target="_blank" href="http://charm.rhul.ac.uk/">charm.rhul.ac.uk</a>).
+{#-#} These are exclusively classical music recordings, originating mainly from the early 20<span class="sup">th</span> century.</p>
+
+<p class="p_indented">The <b>ILM</b> collection contains over 287,000 individual recordings, provided by I Like Music, (<a target="_blank" href="http://ilikemusic.com/">ilikemusic.com</a>).
+{#-#} It has a significant proportion of popular music of various genres, classical music, world music and production music.</p>
+
+<h2>Keyboard shortcuts</h2>
+{{-' '-}}    <dl class="controls-dl-1">
+{{-' '-}}        <dt class="sameline"><i class="key">H</i></dt>
+{{-' '-}}        <dd>opens or closes help</dd>
+
+{{-' '-}}        <dt class="sameline"><i class="key">F</i></dt>
+{{-' '-}}        <dd>flips the grid (toggles between the visualizations of collections and recordings)</dd>
+
+{{-' '-}}        <dt><i class="key">Page Up</i><i class="action-comma">, </i><i class="key">Page Up</i></dt>
+{{-' '-}}        <dd>increases or decreases the width of the columns in the currently opened grid</dd>
+{{-' '-}}    </dl>
+{{-' '-}}    <dl class="controls-dl-2">
+
+{{-' '-}}        <dt><i class="key">Alt</i><i class="action-plus">+</i><i class="key key_arrow">←</i><i class="action-comma"> </i><i class="key key_arrow">→</i></dt>
+{{-' '-}}        <dd>if a column in the currently opened grid is selected, moves it left or right</dd>
+
+{{-' '-}}        <dt><i class="key">Alt</i><i class="action-plus">+</i><i class="key key_arrow">↑</i><i class="action-comma"> </i><i class="key key_arrow">↓</i></dt>
+{{-' '-}}        <dd>if a row in the currently opened grid is selected, moves it up or down</dd>
+
+{{-' '-}}        <dt><i class="key"><%= Ctrl %></i><i class="action-plus">+</i><i class="key">Z</i><i class="action-comma">, </i><i class="key"><%= Ctrl %></i><i class="action-plus">+</i><i class="key">Shift</i><i class="action-plus">+</i><i class="key key_arrow">Z</i></dt>
+{{-' '-}}        <dd>undoes or redoes changes in the vis</dd>
+{#{-' '-}}        <dt><i class="key">H</i><i class="action-or"> or </i><i class="action">click on the current maximum range value</i></dt>
+{{-' '-}}        <dd>opens or closes help</dd>
+{{-' '-}#}        
+{{-' '-}}    </dl>
+
+<h2>Acknowledgements</h2>
+{#--#}<p>See <a target="_blank" href="http://dml.city.ac.uk/">dml.city.ac.uk</a>.</p>
+{% endjstmpl %}
\ No newline at end of file