melodactyl/locale/en-US/intro.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <?xml-stylesheet type="text/xsl" href="dactyl://content/help.xsl"?>
   3
   4 <!DOCTYPE overlay SYSTEM "dactyl://content/dtd">
   5
   6 <overlay
   7     xmlns="&xmlns.dactyl;"
   8     xmlns:html="&xmlns.html;">
   9
  10 <p replace="intro-text">
  11     <link topic="&dactyl.apphome;">&dactyl.appName;</link>
  12     is a free media player add-on for &dactyl.host;, which combines the best
  13     features of the <link topic="http://cmus.sourceforge.net">CMus</link> music
  14     player and the <link topic="http://www.vim.org">Vim</link> text editor.
  15 </p>
  16
  17 <!-- TODO: make Melodactyl specific -->
  18 <ol replace="topics-list">
  19     <!--
  20     <li>
  21         <link topic="tutorial">Quick-start tutorial</link>:
  22         A quick-start tutorial for new users.
  23     </li>
  24     -->
  25     <li>
  26         <link topic="starting">Starting &dactyl.appName;</link>:
  27         How &dactyl.appName; starts up, where it reads the config file, etc.
  28     </li>
  29     <li>
  30         <link topic="player">Player mode</link>:
  31         Interacting with the media player.
  32     </li>
  33     <li>
  34         <link topic="browsing">Browsing</link>:
  35         Basic key mappings and commands needed for a browsing
  36         session (how to open a web page, go back in history, etc.)
  37     </li>
  38     <li>
  39         <link topic="buffer">Buffer</link>:
  40         Operations on the current document (scrolling, copying text,
  41         etc.)
  42     </li>
  43     <li>
  44         <link topic="cmdline">Command Line mode</link>:
  45         Command-line editing.
  46     </li>
  47     <li>
  48         <link topic="editing">Editing text</link>:
  49         Text area and input field editing.
  50     </li>
  51     <li>
  52         <link topic="options">Options</link>:
  53         A description of all options.
  54     </li>
  55     <li>
  56         <link topic="pattern">Text search commands</link>:
  57         Searching for text in the current buffer.
  58     </li>
  59     <li>
  60         <link topic="tabs">Tabs</link>:
  61         Managing your tabbed browsing session.
  62     </li>
  63     <li>
  64         <link topic="hints">Hints</link>:
  65         Selecting hyperlinks and other page elements.
  66     </li>
  67     <li>
  68         <link topic="map">Keyboard shortcuts and commands</link>:
  69         Defining new key mappings, abbreviations and user commands.
  70     </li>
  71     <li>
  72         <link topic="eval">Expression evaluation</link>:
  73         Executing JavaScript.
  74     </li>
  75     <li>
  76         <link topic="marks">Marks</link>:
  77         Using bookmarks, QuickMarks, history and local marks.
  78     </li>
  79     <li>
  80         <link topic="repeat">Repeating commands</link>:
  81         Using macros to repeat recurring workflows.
  82     </li>
  83     <li>
  84         <link topic="autocommands">Automatic commands</link>:
  85         Automatically executing code on certain events.
  86     </li>
  87     <li>
  88         <link topic="print">Printing</link>:
  89         Printing pages.
  90     </li>
  91     <li>
  92         <link topic="gui">&dactyl.appName;'s GUI</link>:
  93         Accessing &dactyl.host; menus, dialogs and the display panels.
  94     </li>
  95     <li>
  96         <link topic="styling">Styling the GUI and web pages</link>:
  97         Changing the styling of content pages and &dactyl.appName; itself.
  98     </li>
  99     <li>
 100         <link topic="message">Error and informational messages</link>:
 101         A description of informational and error messages.
 102     </li>
 103     <li>
 104         <link topic="developer">Developer information</link>:
 105         How to write plugins and documentation.
 106     </li>
 107     <li>
 108         <link topic="various">Various commands</link>:
 109         Other help which doesn't readily fit into any other category.
 110     </li>
 111     <li>
 112         <link topic="plugins">Plugins</link>:
 113         Documentation for any plugins you have installed.
 114     </li>
 115     <li>
 116         <link topic="index">Index</link>:
 117         An index of all commands and options.
 118     </li>
 119 </ol>
 120
 121 <!-- TODO: make Melodactyl specific -->
 122 <ul replace="features-list">
 123     <li>Vim-like keybindings (<k>h</k>, <k>j</k>, <k>gg</k>, <k>ZZ</k>, <k name="C-f"/>, etc.)</li>
 124     <li>Ex commands (<ex>:quit</ex>, <ex>:open www.foo.com</ex>, …)</li>
 125     <li>Tab completion for all commands, highly configurable via <o>wildmode</o>, <o>autocomplete</o>, ...</li>
 126     <li>Hit-a-hint like navigation of links (start with <k>f</k> to follow a link)</li>
 127     <li>Advanced completion of bookmark and history URLs</li>
 128     <li>Vim-like status line with a Wget-like progress bar</li>
 129     <li>Minimal GUI (easily hide superfluous menubar and toolbar with <se opt="guioptions"/>)</li>
 130     <li>Ability to <ex>:source</ex> JavaScript, CSS, and &dactyl.appName; command files</li>
 131     <li>Easy quick searches (see <ex>:open</ex>)</li>
 132     <li>Count supported for many commands (<em>3</em><k name="C-o"/> will go back 3 pages)</li>
 133     <li>Visual bell for errors (<o>visualbell</o>)</li>
 134     <li>Marks support (<k>m</k><em>a</em> to set mark a, <k>'</k><em>a</em> to jump to it)</li>
 135     <li><link topic="quickmarks">QuickMark</link> support</li>
 136     <li><ex>:map</ex>, <ex>:command</ex>, <ex>:normal</ex>, and <t>macros</t></li>
 137     <li><link topic="i_&lt;C-i>">Editing of text fields</link> with an <link topic="'editor'">external editor</link></li>
 138     <li>AutoCommands to execute actions on certain events</li>
 139     <li>A comprehensive help system, explaining all commands, mappings, options, and plugins</li>
 140 </ul>
 141
 142 </overlay>
 143
 144 <!-- vim:se sts=4 sw=4 et: -->