Gecko [ v99win.today ]

Name	Size	Permission
gedit-change-color-scheme.page	2.54 KB	-rw-r--r--
gedit-change-default-font.page	1.82 KB	-rw-r--r--
gedit-character-encodings.page	3.09 KB	-rw-r--r--
gedit-close-file.page	1.25 KB	-rw-r--r--
gedit-create-new-file.page	1.46 KB	-rw-r--r--
gedit-edit-as-root.page	1.65 KB	-rw-r--r--
gedit-files-basic.page	1.06 KB	-rw-r--r--
gedit-full-screen.page	2.54 KB	-rw-r--r--
gedit-open-files-from-sidepane...	2.44 KB	-rw-r--r--
gedit-open-files.page	2.21 KB	-rw-r--r--
gedit-open-on-server.page	2.34 KB	-rw-r--r--
gedit-open-recent.page	1.67 KB	-rw-r--r--
gedit-plugin-guide.page	1.97 KB	-rw-r--r--
gedit-plugins-change-case.page	2.15 KB	-rw-r--r--
gedit-plugins-doc-stats.page	1.87 KB	-rw-r--r--
gedit-plugins-external-tools.p...	2.01 KB	-rw-r--r--
gedit-plugins-file-browser.pag...	1.93 KB	-rw-r--r--
gedit-plugins-insert-date-time...	2.08 KB	-rw-r--r--
gedit-plugins-install.page	2.78 KB	-rw-r--r--
gedit-plugins-modelines.page	3.54 KB	-rw-r--r--
gedit-plugins-pyconsole.page	1.47 KB	-rw-r--r--
gedit-plugins-quick-open.page	2.84 KB	-rw-r--r--
gedit-plugins-snippets.page	6.5 KB	-rw-r--r--
gedit-plugins-sort.page	2.75 KB	-rw-r--r--
gedit-printing-order.page	2.48 KB	-rw-r--r--
gedit-printing-select.page	1.75 KB	-rw-r--r--
gedit-printing.page	4.03 KB	-rw-r--r--
gedit-quickstart.page	1.66 KB	-rw-r--r--
gedit-replace.page	5.13 KB	-rw-r--r--
gedit-save-file.page	1.56 KB	-rw-r--r--
gedit-search.page	3.93 KB	-rw-r--r--
gedit-spellcheck.page	4.86 KB	-rw-r--r--
gedit-syntax-highlighting.page	1.62 KB	-rw-r--r--
gedit-tab-groups.page	3.32 KB	-rw-r--r--
gedit-tabs-moving.page	3.59 KB	-rw-r--r--
gedit-tabs.page	2.28 KB	-rw-r--r--
gedit-undo-redo.page	1.65 KB	-rw-r--r--
index.page	2 KB	-rw-r--r--
legal.xml	322 B	-rw-r--r--

Code Editor : gedit-plugins-snippets.page

<?xml version="1.0" encoding="utf-8"?>
<page xmlns="http://projectmallard.org/1.0/" type="guide" style="task 2column" id="gedit-plugins-snippets" xml:lang="gedit-en-GB">
  <info>
    <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/>
    <revision pkgversion="3.8" date="2013-02-24" status="review"/>
    <revision pkgversion="3.8" date="2013-03-22" status="review"/>
    <credit type="author">
      <name>Jim Campbell</name>
      <email>jcampbell@gnome.org</email>
    </credit>
    <credit type="author">
      <name>Sindhu S</name>
      <email>sindhus@live.in</email>
    </credit>
    <include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/>
    <desc>Use snippets to quickly insert often-used pieces of text.</desc>
  
    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">
      <mal:name>Zander Brown</mal:name>
      <mal:email>zbrown@gnome.org</mal:email>
      <mal:years>2020</mal:years>
    </mal:credit>
  </info>

<title>Snippets</title>

<p><app>Snippets</app> provide a convenient way of inserting repetitive portions of code into your files. For example, an HTML snippet for the <code>&lt;img&gt;</code> tag would insert the opening and closing portions of the tag, as well as fixed places where you can enter image attributes. This can make writing code easier and faster.</p>

<section id="enable-snippets">
    <title>Enable Snippets Plug-in</title>

<p>To enable the <gui>Snippets</gui> plug-in:</p>

<steps>
      <item>
        <p>Select <guiseq><gui style="menu">gedit</gui> <gui style="menuitem">Preferences</gui> <gui style="tab">Plug-ins</gui></guiseq>.</p>
      </item>
      <item>
        <p>Select <gui style="menuitem">Snippets</gui> to enable the plug-in.</p>
      </item>
    </steps>
  </section>

<section id="browse-snippets">
    <title>Browse Snippets</title>

<p>To browse available snippets:</p>
    <steps>
      <item>
        <p>Select <guiseq><gui style="menu">Tools</gui> <gui style="menuitem">Manage Snippets</gui></guiseq>.</p>
        <note style="important">
          <p>Make sure the syntax is set appropriately. The status bar at the bottom of the <app>gedit</app> window will show the current language setting. This language setting is what allows gedit to insert the proper snippets. <app>Gedit</app> will normally detect the language or syntax of the file that you're using, but sometimes you may need to set it.</p>
          <figure>
            <desc>In this example, the language is set to HTML.</desc>
            <media type="image" mime="image/png" src="figures/gedit-html-snippet.png"/>
        </figure>
        </note>
      </item>
      <item>
        <p>Browse the snippets that are available for your language or syntax.</p>
      </item>
    </steps>
  </section>

<section id="using-snippets">
    <title>Using Snippets</title>

<p>To insert a snippet into your current document:</p>

<steps>
      <item>
        <p>Type the desired snippet name anywhere in your current document.</p>
      </item>
      <item>
        <p>Press <key>Tab</key> to insert the snippet associated with the input term.</p>
      </item>
    </steps>
  </section>

<section id="example-insert-snippet">
    <title>Snippet Example Usage</title>

<p>For example, if you have set the syntax to <em>HTML</em>, type <code>head </code>, and press the <key>Tab</key> key. The text would have auto completed into a snippet as:</p>

<code>
      &lt;head&gt;
      &lt;meta http-equiv="Content-type" content="text/html; charset=utf-8" /&gt;
      &lt;title&gt;Page Title&lt;/title&gt;
      &lt;/head&gt;
    </code>

</section>

<section id="adding-snippets">
    <title>Adding Snippets</title>

<p>You can add new Snippets that work either globally (that is, they are language agnostic) or only in a particular syntax.</p>

<steps>
      <item>
        <p>Select <guiseq style="menu"><gui style="menuitem">Tools</gui> <gui style="menuitem">Manage Snippets</gui></guiseq>.</p>
      </item>
      <item>
        <p>From the <gui>Manage Snippets</gui> sidebar select the desired syntax and click on the "+" button to list existing snippets for the selected syntax.</p>
        <note style="tip">
          <p>To add a snippet that works globally (that is, when no particular syntax or language has been set for the document), select <gui>Global</gui> from the <gui>Manage Snippets</gui> sidebar.</p>
        </note>
      </item>
      <item>
        <p>To add a new snippet, click on the "plus" icon in the <gui>Manage Snippets</gui> sidebar.</p>
      </item>
      <item>
        <p>Input a name for the new snippet. The name of the snippet can be different from the snippet you want to add.</p>
      </item>
      <item>
        <p>Under the <gui style="group">Activation</gui> section, you must input a term for the <gui style="input">Tab trigger:</gui> textarea. You will be using this term to insert your snippet.</p>
        <note style="tip">
          <p>If you wish to insert a snippet with a keyboard shortcut, then click your mouse pointer on <gui style="input">Shortcut key:</gui> textarea and press the desired combination of keys. Once you have pressed and released the keys, the keyboard shortcut will be set.</p>
        </note>
      </item>
      <item>
        <p>Under the textarea for <gui style="input">Edit:</gui>, input the desired text for the snippet. You may use <code>${n}</code> to indicate variables, where <em>n</em> is replaced with a number that represents the numerical order of variables included.</p>
      </item>
    </steps>

</section>

<section id="example-add-snippet">
    <title>New Snippet Example</title>

<p>Consider you have created a snippet with the term <var>greetings</var> in <gui style="input">Tab trigger:</gui>. The <gui style="input">Edit:</gui> textarea contains:</p>

<code>
      &lt;greetings&gt;Hello ${1:wonderful}${2:amazing} world!
      &lt;/greetings&gt;
    </code>

<p>You can insert this snippet by typing <var>greetings</var> in the document and pressing the <key>Tab</key> key. The following text snippet will be inserted:</p>

<code>
      &lt;greetings&gt;Hello wonderfulamazing world!&lt;/greetings&gt;
    </code>

<p>The words "wonderful" and "amazing" can be retained or deleted depending on your choice of usage. To do so, press <key>Tab</key> to choose between "wonderful" and "amazing" and press <key>Del</key> to delete the least preferred option.</p>
  </section>

<!--TODO: <section id="modifying-snippets">
    <title>Modifying Existing Snippets</title>

</section>-->
</page>

${this.title}

Code Editor : gedit-plugins-snippets.page