<title>Pluma Manual<!-- not using app entity because of lowercase ugliness --></title>

<copyright>

<year>2007</year>

<copyright>

<year>2002</year>

<year>2003</year>

</affiliation>

</author>

<author>

<surname>Canary</surname>

<contrib>Added the Shortcut Keys Table</contrib>

<author>

<firstname>Sun Java Desktop System Documentation Team</firstname>

<surname></surname>

</orderedlist>

<para>Valid types of <replaceable>URI</replaceable> include <literal>http:</literal>, <literal>ftp:</literal>, <literal>file:</literal>, and all of the methods supported by <literal>mate-vfs</literal>.</para>

<para>Files from some types of URI are opened as read-only, and any changes you make must be saved to a different location. HTTP only allows files to be read. Files opened from FTP are read-only because because not all FTP servers may correctly work with saving remote files.</para>

</sect2>

<!-- ============= Working with tabs ======================== -->

<para>The backslash character itself must be escaped if it is being searched for.

For example, if you are looking for the "<literal>\n</literal>" literal, you will

have to type "\\n" in the <guilabel>Search for</guilabel> field. Or if you are

searched backslashes.</para>

</listitem>

</varlistentry>

</sect1>

<!-- ================ Shortcut Keys ============================= -->

<title>Shortcut Keys</title>

<para>Use shortcut keys to perform common tasks more quickly than with the mouse and menus. The following tables list all of <application>&app;</application>'s shortcut keys.</para>

<para>For more on shortcut keys, see the <ulink type="help" url="ghelp:user-guide?keyboard-skills">Desktop User Guide</ulink>.</para>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<tbody>

<entry><para>Ctrl + Alt + PageUp</para></entry>

<entry><para>Switches to the next tab to the left.</para></entry>

</row>

<entry><para>Ctrl + Alt + PageDown</para></entry>

<entry><para>Switches to the next tab to the right.</para></entry>

</row>

<entry><para>Ctrl + W</para></entry>

<entry><para>Close tab.</para></entry>

</row>

<entry><para>Ctrl + Shift + L</para></entry>

<entry><para>Save all tabs.</para></entry>

</row>

<entry><para>Ctrl + Shift + W</para></entry>

<entry><para>Close all tabs. </para></entry>

</row>

<entry><para>Alt + n</para></entry>

<entry><para>Jump to nth tab.</para></entry>

</row>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<tbody>

<entry><para>Ctrl + N</para></entry>

<entry><para>Create a new document.</para></entry>

</row>

<entry><para>Ctrl + O</para></entry>

<entry><para>Open a document.</para></entry>

</row>

<entry><para>Ctrl + L</para></entry>

<entry><para>Open a location.</para></entry>

</row>

<entry><para>Ctrl + S</para></entry>

<entry><para>Save the current document to disk.</para></entry>

</row>

<entry><para>Ctrl + Shift + S</para></entry>

<entry><para>Save the current document with a new filename.</para></entry>

</row>

<entry><para>Ctrl + P</para></entry>

<entry><para>Print the current document.</para></entry>

</row>

<entry><para>Ctrl + Shift + P</para></entry>

<entry><para>Print preview.</para></entry>

</row>

<entry><para>Ctrl + W</para></entry>

<entry><para>Close the current document.</para></entry>

</row>

<entry><para>Ctrl + Q</para></entry>

<entry><para>Quit Pluma.</para></entry>

</row>

<!-- ============= Edit ======================= -->

<bridgehead>Edit</bridgehead>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1">

<colspec colname="COLSPEC0" colwidth="50*"/>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<!-- ============= Panes ======================= -->

<bridgehead>Panes</bridgehead>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1">

<colspec colname="COLSPEC0" colwidth="50*"/>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<tbody>

<entry><para>F9</para></entry>

<entry><para>Show/hide the side pane.</para></entry>

</row>

<entry><para>Ctrl + F9</para></entry>

<entry><para>Show/hide the bottom pane.</para></entry>

</row>

<!-- ============= Search ======================= -->

<bridgehead>Search</bridgehead>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1">

<colspec colname="COLSPEC0" colwidth="50*"/>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<tbody>

<entry><para>Ctrl + F</para></entry>

<entry><para>Find a string.</para></entry>

</row>

<entry><para>Ctrl + G</para></entry>

<entry><para>Find the next instance of the string.</para></entry>

</row>

<entry><para>Ctrl + Shift + G</para></entry>

<entry><para>Find the previous instance of the string.</para></entry>

</row>

<entry><para>Ctrl + K</para></entry>

<entry><para>Interactive search.</para></entry>

</row>

<entry><para>Ctrl + H</para></entry>

<entry><para>Search and replace.</para></entry>

</row>

<entry><para>Ctrl + Shift + K</para></entry>

<entry><para>Clear highlight.</para></entry>

</row>

<entry><para>Ctrl + I</para></entry>

<entry><para>Goto line.</para></entry>

</row>

</informaltable>

<!-- ============= Tools ======================= -->

<bridgehead>Tools</bridgehead>

<informaltable frame="all">

<tgroup cols="2" colsep="1" rowsep="1">

<colspec colname="COLSPEC0" colwidth="50*"/>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<tbody>

<entry><para>Shift + F7</para></entry>

<entry><para>Check spelling (with plugin).</para></entry>

</row>

<entry><para>Alt + F12</para></entry>

<entry><para>Remove trailing spaces (with plugin).</para></entry>

</row>

<entry><para>Ctrl + T</para></entry>

<entry><para>Indent (with plugin).</para></entry>

</row>

<entry><para>Ctrl + Shift + T</para></entry>

<entry><para>Remove Indent (with plugin).</para></entry>

</row>

<entry><para>F8</para></entry>

<entry><para>Run "make" in current directory (with plugin).</para></entry>

</row>

<entry><para>Ctrl + Shift + D</para></entry>

<entry><para>Directory listing (with plugin).</para></entry>

</row>

<row valign="top">

<entry colname="COLSPEC0">

<para>Shortcut Key</para></entry>

<para>Command</para></entry>

</row>

</thead>

<tbody>

<entry><para>F1</para></entry>

<entry><para>Open <application>&app;</application>'s user manual.</para></entry>

</row>

<varlistentry><term>Description</term>

<listitem>

<para>This description is shown in the statusbar when the menu command is chosen.</para>

</varlistentry>

<varlistentry><term>Accelerator</term>

<listitem>

<para>Enter a keyboard shortcut for the command.</para>

</varlistentry>

<varlistentry><term>Commands</term>

<listitem>

<para>The actual commands to be run. Several <application>&app;</application> environment variables can be used to pass content to these commands: see <xref linkend="pluma-external-tools-plugin-variables"/>.</para>

</varlistentry>

<varlistentry><term>Input</term>

<listitem>

<para>The content to give to the commands (as <systemitem>stdin</systemitem>): the entire text of the current document, the current selection, line, or word.</para>

</varlistentry>

<varlistentry><term>Output</term>

<listitem>

<para>What to do with the output of the commands: display in the bottom pane, put in a new document, or place in the current document, at the end, at the cursor position, or replacing the selection or the entire document.</para>

</varlistentry>

<varlistentry><term>Applicability</term>

<listitem>

<para>Determines which sort of documents can be affected by the command, for example whether saved or not, and local or remote.</para>

</varlistentry>

</variablelist>

</sect3>

<sect3 id="pluma-external-tools-plugin-edit">

<title>Editing and Removing Tools</title>

<para>To edit a tool, select it in the list and make changes to its properties.</para>

<para>To restore a built-in tool that you have changed, press <guilabel>Revert</guilabel>.</para>

<para>To remove a tool, select it in the list and press <guibutton>Remove</guibutton>. You can not remove built-in tools, only those you have created yourself.</para>

</sect3>

<title>Variables</title>

<para>You can use the following variables in the <guilabel>Commands</guilabel> field of the command definition:</para>

<itemizedlist>

</sect3>

</sect2>

<title>File Browser Plugin</title>

<para>The <application>File Browser</application> Plugin shows your files and folders in the side pane, allowing you to quickly open files.</para>

<para>To view the File Browser, choose <menuchoice><guimenu>View</guimenu> <guimenuitem>Side Pane</guimenuitem> </menuchoice> and then click on the tab showing the File Browser icon at the bottom of the side pane.</para>

<title>Browsing your Files</title>

<para>The File Browser tab initially shows your file manager bookmarks. To browse the contents of any item, double-click it.</para>

<para>To show a parent folder, choose from the drop-down list, or press the up arrow on the File Browser's toolbar.</para>

<para>To show the folder that contains the document you are currently working on, right-click in the file list and choose <guimenuitem>Set root to active document</guimenuitem>.</para>

</sect3>

<title>Opening a File</title>

<para>To open a file in <application>&app;</application>, double-click it in the file list.</para>

</sect3>

<title>Creating Files and Folders</title>

<para>To create a new, empty text file in the current folder shown in the browser, right-click in the file list and choose <guimenuitem>New File</guimenuitem>.</para>

<para>To create a new folder in the current folder shown in the browser, right-click in the file list and choose <guimenuitem>New Folder</guimenuitem>.</para>

</sect3>

</sect2>

<title>Python Console Plugin</title>

<para>The <application>Python Console</application> Plugin allows you to run commands in the python programming language from <application>&app;</application>. Enabling the plugin adds a tab to the bottom pane. This shows recent output and a command prompt field.</para>

<caution><para>Commands entered into the python console are not checked before they are run. It is therefore possible to hang <application>&app;</application>, for example by entering an infinite loop.</para></caution>

<listitem>

<para><literal>$(<replaceable>cmd</replaceable>)</literal> is replaced by the result of executing <replaceable>cmd</replaceable> in a shell. </para>

<para><literal>$(<replaceable>n</replaceable>:<replaceable>cmd</replaceable>)</literal> allows you to give this placeholder a reference, where <replaceable>n</replaceable> is any number from 1 upwards. Use <literal>$<replaceable>n</replaceable></literal> to use the output from one shell placeholder as input in another.</para>

</varlistentry>

<varlistentry><term>Python placeholders</term>

<listitem>

<para><literal>$&lt;<replaceable>cmd</replaceable>&gt;</literal> is replaced by the result of evaluating <replaceable>cmd</replaceable> in the python interpreter.</para>

<para><literal>$&lt;<replaceable>a</replaceable>:<replaceable>cmd</replaceable>&gt;</literal> specifies another python placeholder as a dependency, where <replaceable>a</replaceable> gives its order in the snippet. This allows you to use python functions defined in another snippet. To specify several dependencies, separate the numbers with commas thus: <literal>$&lt;<replaceable>a</replaceable>,<replaceable>b</replaceable>:<replaceable>cmd</replaceable>&gt;</literal></para>

<para>To use a variable in all other python snippets, declare it as <literal>global</literal>.</para>

</varlistentry>

</variablelist>

</sect3>