summaryrefslogtreecommitdiffstats
path: root/help/C/gedit-plugins-install.page
blob: b76ba6a4abb7bee2479c1bcbdc8573374d08642c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<page xmlns="http://projectmallard.org/1.0/"
      type="topic" style="task"
      id="gedit-plugins-install">
  <info>
    <link type="guide" xref="gedit-plugin-guide#gedit-additional-plugins"/>
    <desc>How to install third-party plugins.</desc>
  </info>

  <title>Additional gedit plugins</title>

  <p>Installing third-party plugins gives you extra functionality that isn't 
  available in default <app>gedit</app> plugins, or even the extra plugins that 
  are part of the <app>gedit-plugins</app> package. An online list of 
  third-party plugins is 
  <link href="https://wiki.gnome.org/Apps/Gedit">kept here</link>.
  </p>
  
  <p>Installing a third-party plugin involves downloading the plugin, placing 
  the plugin files in the right directory, and activating the plugin.</p>
  
  <steps>
    <item><p>You can usually download a plugin from the plugin's website, but 
    may need to use a revision-control program like <app>git</app>, <app>
    bazaar</app>, or <app>subversion</app> to copy a plugin's software 
    repository from the internet. Refer to the plugin's documentation for 
    information on getting the plugin.</p></item>
    <item><p>Place the plugin files into the 
    <file>/home/<var>username</var>/.local/share/gedit/plugins</file> directory.
    </p>
    <p>Of course, replace the word <var>username</var> with your own username.
    </p></item>
    <item><p>After you have placed the plugin files into the correct directory, 
    the plugin will appear in the Preferences menu. Press the menu button in the
    top-right corner of the window and select <guiseq><gui style="menuitem">
    Preferences</gui><gui style="tab">Plugins</gui><gui>[Name of Plugin]</gui>
    </guiseq> to enable the plugin.</p></item>
    <item><p>Click <gui>Close</gui>.</p></item>
  </steps>
  
  <p>After you have enabled the plugin, it should be available for you to use.
  </p>
  
  <note style="tip">
    <p>The <file>.local</file> directory is hidden by default. To view it and 
    other hidden files, select <guiseq><gui>View</gui><gui>Show Hidden 
    Files</gui></guiseq>, or press <keyseq><key>Ctrl</key><key>H</key></keyseq>.
    </p>
  </note>

  <note style="tip">
    <p>If the directory <file>.local/share/gedit/plugins/</file> is not 
    present on your system, you will need to create it.</p>
  </note>
  
</page>