metamaps/metamaps

View on GitHub
app/views/shared/_cheatsheet.html.erb

Summary

Maintainability
Test Coverage
<%#
  # @file
  # The inner HTML of the cheatsheet
  #%>

<h3>HELP</h3>

<div id="cheatSheet">
<ul id="helpWrapper">
    <li><a href="#quickReference">QUICK REFERENCE</a></li>
    <li><a href="#tutorials">TUTORIAL</a></li>
    <li><a href="#moreResources">MORE RESOURCES</a></li>
</ul>

<div id="quickReference">
  <ul>
    <li><a href="#csCreatingTopics">Creating Topics</a></li>
    <li><a href="#csEditingTopics">Editing Topics</a></li>
    <li><a href="#csCreatingSynapses">Creating Synapses</a></li>
    <li><a href="#csEditingSynapses">Editing Synapses</a></li>
    <li><a href="#csNavigation">Navigation</a></li>
    <li><a href="#csSelection">Selection</a></li>
    <li><a href="#csSearch">Search</a></li>
    <li><a href="#csTopicView">Topic View</a></li>
    <li><a href="#csKeyboardShortcuts">Keyboard Shortcuts</a></li>
  </ul>

  <div id="csTopicView">
    <div class="csItem"><span class="csTitle">Enter Topic (radial) View:</span> Click on a Topic result from Search, or click the synapse <img src="<%= asset_path 'synapse16.png' %>" width="16" align="middle" /> icon inside open Topic Card on map</div>
    <div class="csItem"><span class="csTitle">Recenter Topics around chosen Topic:</span> Alt + click on the topic OR Alt + E</div>
    <div class="csItem"><span class="csTitle">Reveal the siblings for a Topic:</span> Right-click and choose 'Reveal siblings' OR Alt + R</div>
    <div class="csItem"><span class="csTitle">Center topic and reveal siblings:</span> Alt + T</div>
    <div class="csItem"><span class="csTitle">Filter out visible Topics:</span> Open Filter menu *** and toggle off/on</div>
  </div>

  <div id="csCreatingTopics">
    <div class="csItem"><span class="csTitle">Double-click on canvas:</span> Bring up the metacode spinner</div>
    <div class="csItem indented"><span class="csTitle">Scroll:</span> change metacode spinner selection</div>
    <div class="csItem indented"><span class="csTitle">Tab:</span> rotate spinner counter-clockwise</div>
    <div class="csItem indented"><span class="csTitle">Shift + tab:</span> rotate spinner clockwise</div>
    <div class="csItem indented"><span class="csTitle">Esc:</span> Hides auto-suggestion results</div>
    <div class="csItem indented"><span class="csTitle">Enter:</span> create a new topic</div>
    <div class="csItem indented"><span class="csTitle">Gear Icon:</span> open up metacode settings</div>
    <div class="csItem"><br><a href="https://docs.metamaps.cc/creating_topics.html" target= "_blank">Learn More</a></div>
  </div>

  <div id="csEditingTopics">
    <div class="csItem">
            <span class="csTitle">Open Topic card:</span> Double-click on topic icon
    </div>
    <div class="csItem indented">
            <span class="csTitle">Move Topic card:</span> Click and drag on topic card metacode
    </div>
    <div class="csItem indented">
            <span class="csTitle">Change metacode:</span> Mouse over metacode icon, then click on solid colored bar for metacode menu
    </div>
    <div class="csItem indented">
            <span class="csTitle">Edit Topic title, description, link:</span> Click on text in respective area (click small "X" to reset link)
    </div>
    <div class="csItem indented">
        <span class="csTitle">Save Topic title, description, link:</span> Hit enter, or click away
    </div>
    <div class="csItem indented">
        <span class="csTitle">Change Topic permission:</span> Click on 'Permission' icon (only for topic creator)
    </div>
    <div class="csItem indented">
        <span class="csTitle">Open Topic view:</span> Click on <img src="<%= asset_path 'synapse16.png' %>" width="16" align="middle" /> icon within topic card bar
    </div>
    <div class="csItem indented">
        <span class="csTitle">Close Topic card:</span> Click on canvas
    </div>
    <div class="csItem">
        <span class="csTitle">Open 'Context Menu':</span> Right-click/alt+click on topic icon or synapse or selection (multiple) to Hide/Remove/Delete, change metacode or permission
    </div>
    <div class="csItem"><br><a href="https://docs.metamaps.cc/creating_topics.html" target= "_blank">Learn More</a></div>

  </div>

  <div id="csCreatingSynapses">
    <div class="csItem"><span class="csTitle">Open 'Create Synapse' prompt:</span> Right-click & drag from one topic to another</div>
    <div class="csItem indented"><span class="csTitle">Enter a label</span> Begin typing (or leave blank)</div>
    <div class="csItem indented"><span class="csTitle">Confirm new Synapse:</span> Enter or Tab</div>
    <div class="csItem indented"><span class="csTitle">Cancel new Synapse:</span> Escape or Delete</div>
    <div class="csItem"><span class="csTitle">Create new Topic with Synapse:</span> Right-click + drag from existing topic to open canvas</div>
    <div class="csItem indented"><span class="csTitle">Create Topic:</span> Same as elsewhere</div>
    <div class="csItem indented"><span class="csTitle">Create Synapse:</span> Same as above</div>
    <div class="csItem"><br><a href="https://docs.metamaps.cc/creating_synapses.html" target= "_blank">Learn More</a></div>

  </div>

  <div id="csEditingSynapses">
    <div class="csItem"><span class="csTitle">Open Synapse card:</span> Double-click on Synapse </div>
    <div class="csItem indented"><span class="csTitle">Edit Synapse description:</span> Click on current description text</div>
    <div class="csItem indented"><span class="csTitle">Save Synapse description:</span> Hit enter</div>
    <div class="csItem indented"><span class="csTitle">Edit directionality:</span> Select appropriate arrow boxes</div>
    <div class="csItem indented"><span class="csTitle">Change synapse permission:</span> Click on 'permission' icon (only for synapse creator)</div>
    <div class="csItem indented"><span class="csTitle">Browse / select from multiple (stacked) synapses:</span> Click dropdown icon and select desired synapse</div>
    <div class="csItem"><span class="csTitle">Open 'Context Menu':</span> Right-click/alt-click on Synapse</div>
    <div class="csItem indented">*Hide/Remove/Delete synapse within context menu</div>
    <div class="csItem"><br><a href="https://docs.metamaps.cc/creating_synapses.html" target= "_blank">Learn More</a></div>

  </div>

  <div id="csNavigation">
    <div class="csItem"><span class="csTitle">Move around Canvas:</span> Click and drag</div>
    <div class="csItem indented"><span class="csTitle">Zoom in/out:</span> Scroll OR click on <div id="zoomIn"> </div> & <div id="zoomOut"> </div></div>
    <div class="csItem indented"><span class="csTitle">Zoom to see all:</span> Click <div id="centerMap"></div> OR Ctrl + E</div>
    <div class="csItem"><span class="csTitle">Filter Map Contents:</span> Open the Filter Menu *** and toggle items off/on</div>
    <div class="csItem"><span class="csTitle">Return to 'Explore Maps' (home) page:</span> Click the Metamaps logo in the upper left corner</div>
    <div class="csItem"><br><a href="https://docs.metamaps.cc/exploring_maps.html" target= "_blank">Learn More</a></div>

  </div>

  <div id="csSelection">
    <div class="csItem"><span class="csTitle">Select/Deselect Topic:</span> Click on topic icon</div>
    <div class="csItem"><span class="csTitle">Select/Deselect Synapse:</span> Click on synapse</div>
    <div class="csItem"><span class="csTitle">Select multiple Topics/Synapses:</span> Shift + click to include each</div>
    <div class="csItem"><span class="csTitle">Select multiple with Selection Box:</span> Right-click/Shift-click + drag on Canvas</div>
    <div class="csItem"><span class="csTitle">Move all selected Topics & Synapses:</span> Click + drag on selected topic(s)/synapse(s)</div>
    <div class="csItem"><span class="csTitle">Open 'Context Menu':</span> Right-click/Alt-click on selected topic(s)</div>
    <div class="csItem indented">*Hide/Remove/Delete/Change permissions of multiple topics & synapses within context menu</div>
    <div class="csItem"><span class="csTitle">Zoom to selection box</span> Ctrl-click + drag</div>
    <div class="csItem"><span class="csTitle">Deselect all topics & Synapses:</span> Click on background or Esc</div>
  </div>

  <div id="csSearch">
    <div class="csItem"><span class="csTitle">Search for Topics and Maps:</span> Type query terms into search bar, wait for results below</div>
    <div class="csItem"><span class="csTitle">Limit search results:</span> Click checkbox for only items you created; click arrow above Topics or Maps section to collapse</div>
    <div class="csItem"><span class="csTitle">Add Topic to current Map:</span> Click "+" on a topic result</div>
    <div class="csItem"><span class="csTitle">Jump to Topic View:</span> Click anywhere else on a topic result</div>
    <div class="csItem"><span class="csTitle">Search by metacode:</span> type "[name of metacode]:", then your search query. i.e. idea:create...</div>
    <div class="csItem"><span class="csTitle">Search for map:</span> type "map:", then your search query. i.e. map:exploring...</div>
    <div class="csItem"><span class="csTitle">Search for mapper:</span> type "mapper:", then your search query. i.e. mapper:Robert</div>
  </div>

  <div id="csKeyboardShortcuts">
    <div class="csItem"><span class="csTitle">Ctrl + /:</span> Open 'Search' prompt</div>
    <div class="csItem"><span class="csTitle">Ctrl + H:</span> Hide selection on map</div>
    <div class="csItem"><span class="csTitle">Ctrl + M:</span> Remove selection from map</div>
    <div class="csItem"><span class="csTitle">Ctrl + D:</span> Delete selection</div>
    <div class="csItem"><span class="csTitle">Ctrl + A:</span> Select all topics</div>
    <div class="csItem"><span class="csTitle">Ctrl + E:</span> See all on map (zoom to extents)</div>
    <div class="csItem"><span class="csTitle">Esc (while in search):</span> Close search</div>
    <div class="csItem"><span class="csTitle">Esc (with selection):</span> Deselect all</div>
  </div>
</div>

<div id="tutorials">
    <iframe id="tutorialVideo" src="//player.vimeo.com/video/88334167" width="552" height="320" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
</div>

<div id="moreResources">
    <p>For more information about Metamaps.cc, visit our Knowledge Base or skip directly to a section by clicking on one of the categories below.</p>
    <div class="resourcesColumnOne resourcesColumn">
        <a href="https://hylo.com/c/metamaps" target="_blank" class="button">Hylo User Community</a>
        <ul>
            <li><a href="https://docs.metamaps.cc/getting_started.html" target="_blank">Getting Started</a></li>
            <li><a href="https://docs.metamaps.cc/best_practices.html" target="_blank">Best Practices</a></li>
            <li><a href="https://docs.metamaps.cc/applications_and_use_cases.html" target="_blank">Applications & Use Cases</a></li>
            <li><a href="https://docs.metamaps.cc/advanced_features.html" target="_blank">Advanced Features</a></li>
        </ul>
    </div>
    <div class="resourcesColumnTwo resourcesColumn">
        <a href="https://docs.metamaps.cc" target="_blank"  class="button">KNOWLEDGE BASE</a>
        <ul>
            <li><a href="https://docs.metamaps.cc/general_questions.html" target="_blank">General Questions</a></li>
            <li><a href="https://docs.metamaps.cc/project_organization_and_governance.html" target="_blank">Organization & Governance</a></li>
            <li><a href="https://docs.metamaps.cc/realtime_collaboration_junto.html" target="_blank">Realtime Collaboration</a></li>
            <li><a href="https://docs.metamaps.cc/importing_and_exporting_data.html" target="_blank">Importing and Exporting Data</a></li>
        </ul>
    </div>
</div>


</div>