aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBurkhard Lück <[email protected]>2016-05-26 20:43:15 +0200
committerBurkhard Lück <[email protected]>2016-05-26 20:43:15 +0200
commit535749305137f5ccc112aa56a36a3d7f267686ff (patch)
tree61ff31b2077049540613156107e53f5355cb972b
parentb86f3a6ed33945ca89e9030ba46b747eb4cdf0cf (diff)
add sect for rust plugin
REVIEW:128025
-rw-r--r--doc/kate/plugins.docbook50
-rw-r--r--doc/kate/rust-completion.pngbin0 -> 21890 bytes
-rw-r--r--doc/kate/rust-configuration.pngbin0 -> 21707 bytes
3 files changed, 47 insertions, 3 deletions
diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index 95659b6..c70fc15 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -83,7 +83,8 @@ is a Autocompletion Plugin for D, using the DCD autocompletion server</para>
<para>Replicode</para>
</listitem>
<listitem>
-<para>Rust code completion - Code completion for Rust source code</para>
+<para><link linkend="kate-application-plugin-rust">Rust code completion</link>
+- Code completion for Rust source code</para>
</listitem>
<listitem>
<para><link linkend="kate-application-plugin-searchinfiles">Search &amp; Replace</link> -
@@ -1575,8 +1576,51 @@ context menu Project->Lookup:xxx
<!--FIXME Replicode
Projects Replicode run / stop-->
-<!--FIXME Rust
-Edit Find definition-->
+<sect1 id="kate-application-plugin-rust">
+<!--https://blogs.kde.org/2015/05/18/basic-code-completion-rust-kdes-kate-and-later-kdevelop
+https://blogs.kde.org/2015/05/22/updates-kates-rust-plugin-syntax-highlighting-and-rust-source-mime-type-->
+<title>Rust code completion Plugin</title>
+
+<para>This plugin provides code completion for the <ulink url="https://www.rust-lang.org/">Rust</ulink>
+programming language.</para>
+
+<para>Once you have enabled the Rust code completion item in the plugin page, a new
+page will appear in your &kate; configuration dialog.
+</para>
+
+<screenshot id="screenshot-rust-configuration">
+<screeninfo>Rust Configuration</screeninfo>
+<mediaobject>
+<imageobject><imagedata fileref="rust-configuration.png" format="PNG"/></imageobject>
+</mediaobject>
+</screenshot>
+
+<para>Edit the command to run <ulink url="https://github.com/phildawes/racer">Racer</ulink>,
+an utility intended to provide Rust code completion for editors.</para>
+
+<para>You also need the Rust source code and have to provide the path to the source tree.
+</para>
+
+<para>While typing code a popup list appears with items for completion:
+</para>
+
+<screenshot id="screenshot-rust-completion">
+<screeninfo>Rust Completion</screeninfo>
+<mediaobject>
+<imageobject><imagedata fileref="rust-completion.png" format="PNG"/></imageobject>
+</mediaobject>
+</screenshot>
+
+<para>In addition to code completion popups, the plugin also installs
+a <guimenuitem>Go to Definition</guimenuitem> action in the <guimenu>Edit</guimenu> menu and
+in the context menu. You can configure a keyboard shortcut for it as well.
+</para>
+
+<para>This action will open the document containing the definition if needed, activate
+its view and place the cursor at the start of the definition.
+</para>
+
+</sect1>
<sect1 id="kate-application-plugin-searchinfiles">
<sect1info>
diff --git a/doc/kate/rust-completion.png b/doc/kate/rust-completion.png
new file mode 100644
index 0000000..276b251
--- /dev/null
+++ b/doc/kate/rust-completion.png
Binary files differ
diff --git a/doc/kate/rust-configuration.png b/doc/kate/rust-configuration.png
new file mode 100644
index 0000000..6bc4c7e
--- /dev/null
+++ b/doc/kate/rust-configuration.png
Binary files differ