help.html

<?xml version="1.0" encoding="UTF-8"?>
<article>
    <section>
        <img src="resources/images/help1.png"/>
        <h1>Auto-completion</h1>
        <p>Press <code>Ctrl-Space</code> to see a list
        of possible completions at the current cursor position. There are two types of completions:</p>
        <ul>
            <li>XQuery Functions</li>
            <li>Code Templates (start with [S])</li>
        </ul>
        <p>In the popup, use the cursor keys to choose a suggested code or function template. Press
        <code>Enter</code> to select the current template. It will be inserted at the current
        cursor position.</p>
        <p>For example, to add a new function, enter "fun" and press <code>Ctrl-Space</code>.</p>
        <h3>Variables</h3>
        <p>Completion also works for variables: if the cursor is located behind the start of a variable,
        e.g. "$c", pressing <code>Ctrl-Space</code> shows all variables in the current context starting
        with "$c".</p>
    </section>
    <section>
        <img src="resources/images/help2.png"/>
        <h1>Navigating within templates</h1>
        <p>Within a code or function template, press <code>Tab</code> to cycle between template parameters.
        Press <code>Escape</code> when you are done with the parameters and want to input an ordinary
        tab character.</p>
    </section>
    <section>
        <h1>Browsing the code</h1>
        <p>eXide not only parses the code currently open in the editor, it also knows all imported modules.
        To directly jump to the definition of a function in an imported module, place the cursor somewhere in
        the name of the called function and press <code>F3</code>. If the function is in an imported
        XQuery module, eXide will open it in a new tab. Note: this only works for modules written in XQuery, which
        reside in the database, not Java modules.</p>
        <p>To get help on a called function, press <code>F1</code> instead of F3 while the cursor is positioned
        within the function's name.</p>
    </section>
    <section>
        <h1>Browsing and importing modules</h1>
        <p>To open or import an XQuery module, press <code>F4</code> anywhere in the editor to see all 
        modules available in the database. To insert an import statement for a module at the current cursor position, click on the
        <code>Import</code> button. eXide automatically determines the path to use for the import. Modules residing in the same
        application collection will be imported with a relative path.</p>
        <p>Note: the <code>Import</code> button will only be shown if the active editor tab contains an XQuery document.</p>
    </section>
</article>