Commit 18236eb4 authored by Waqar Ahmed's avatar Waqar Ahmed Committed by Christoph Cullmann
Browse files

Add docs for quickopen

Quick open docs from the project plugin are removed.
parent b3227bbe
Pipeline #242946 passed with stage
in 16 minutes and 18 seconds
......@@ -517,6 +517,65 @@ if nothing else is indicated on the command line.</para>
</sect1>
<sect1 id="fundamentals-quick-open">
<title>Quick Open</title>
<para>To be able to quickly open/switch between files, Kate comes with a built-in quick open
dialog. You can open it with <keycombo action="simul">&Ctrl;&Alt;<keycap>O</keycap></keycombo>.
</para>
<para>
Quick open can show all open documents in Kate as well as all files in open projects. To
be able to see project files, you need to enable <link linkend="kate-application-plugin-projects">Project Plugin</link>.
</para>
<sect2>
<title>Using Quick Open</title>
<para>
Using quick open is very simple. Once you open it, just type the name or portions of the name of the file
you want to open and quick open will filter the list based on what you typed. Hitting &Enter; opens the selected file,
while &Esc; hides the quick open.
</para>
<para>
By default, only the file name is matched while filtering. If you want to match path, you need
to have a "/" in the typed text. For example: "doc/index" will match all the files that contain
"index" inside the folder "doc".
</para>
<para>
The documents which are already open are highlighted in bold and are listed at the top when the dialog
opens. Also, when quick open shows up the previous open document is already selected so you can just
press &Enter; and it will take you to that document.
</para>
</sect2>
<sect2>
<title>Configuring Quick Open</title>
<screenshot id="screenshot-project-quickopen">
<screeninfo>Quick Open</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="project-quickopen.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>
Quick open provides a couple of config options. To access these options, right-click in the input line edit.
</para>
<variablelist>
<varlistentry>
<term>Currently available options are:</term>
<listitem>
<para><userinput>Current Project</userinput> - Show files from current project only</para>
<para><userinput>All Projects</userinput> - Show files from all open projects</para>
<para><userinput>Fuzzy Filtering</userinput> - Use fuzzy matching algorithm to filter files</para>
<para><userinput>Wildcard Filtering</userinput>- Use wildcard matching to filter files</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 id="fundamentals-getting-help">
<title>Getting Help</title>
......
......@@ -1956,31 +1956,6 @@ exits, so the plugin does not pollute any folder with unwanted files.</para>
</sect2>
<sect2 id="project-quickopen">
<title>Quick Opening Files</title>
<para>As clicking on files in the tree view is not the fastest way to open a file, &kate;
provides a built-in quick open mechanism you can activate with
<keycombo action="simul">&Ctrl;&Alt;<keycap>O</keycap></keycombo>.
What you the get is a list like this:</para>
<screenshot id="screenshot-project-quickopen">
<screeninfo>Quick Open</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="project-quickopen.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>You can filter by typing parts of the file name you are looking for, and you can
also navigate with the arrow keys and page up/down through the list.
Hitting &Enter; activates the selected file, while &Esc; hides the quick open view again.</para>
<para>Further, the quick open remembers the previous file. So when you change to the
quick open view the previously activated file is automatically selected and you just
need to hit &Enter;, which comes very handy at times.</para>
</sect2>
<sect2 id="project-build">
<title>Support for Building the Project</title>
......
doc/kate/project-quickopen.png

188 KB | W: | H:

doc/kate/project-quickopen.png

72.3 KB | W: | H:

doc/kate/project-quickopen.png
doc/kate/project-quickopen.png
doc/kate/project-quickopen.png
doc/kate/project-quickopen.png
  • 2-up
  • Swipe
  • Onion skin
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment