<page xmlns="http://projectmallard.org/1.0/"
      type="topic" style="task"
      id="gedit-plugins-tag-list">

<info>
  <link type="guide" xref="gedit-plugin-guide#gedit-default-plugins"/>
  <revision pkgversion="3.2" version="1.0" date="2011-08-15" status="candidate"/>
  <credit type="author">
    <name>Daniel Neel</name>
    <email>dneelyep@gmail.com</email>
  </credit>
  <credit type="author">
    <name>Jim Campbell</name>
    <email>jwcampbell@gmail.com</email>
  </credit>
  <desc>Automatically insert tags, strings and special characters into a document</desc>
</info>

<title>Tag list</title>

  <p>The <app>Tag List</app> plugin allows you to insert common tags and special characters from a list in the side pane. By default, the plugin can insert tags and special characters for HTML, XHTML, XSLT, XUL and LaTeX.</p>

  <section id="using-tag-list">
    <title>Using the Tag List plugin</title>

      <p>To use the <app>Tag List</app> plugin, you will need to enable the plugin, and then activate the tag-list portion of the side pane.</p>

    <section id="enable-tag-list-plugin">
        <title>Enabling the Plugin</title>
<p>You can activate the plugin by selecting <guiseq><gui>Edit</gui><gui>Preferences</gui><gui>Plugins</gui><gui>Tag List</gui></guiseq>. Once you have activated the plugin, access it by selecting <guiseq><gui>View</gui><gui>Side Pane</gui></guiseq>, or by pressing <key>F9</key>.</p>

<p>The side pane initially shows a list of open documents, so to view and use the <app>tag list</app>, you will need to click on the tab showing the "plus" icon at the bottom of the side pane. The icon will look similar to this:</p>

    <p>
      <media type="image" mime="image/png" src="figures/gedit-side-pane3.png"/>
    </p>
    </section>
    <section id="inserting-tags">
      <title>Inserting Tags and Special Characters</title>

  <p>The <app>tag list</app> uses a drop-down menu to let you choose from the different types of tags. For example, one tag option is <gui>HTML - Tags</gui>.</p>

  <p>To start inserting tags, complete the following:</p>

<list type="numbered">
<item><p>Move the cursor to where you will want to insert the tag or special character.</p></item>
<item><p>Select the desired tag type from the drop-down menu at the top of the side pane.</p></item>
<item><p>Scroll through the list to find the desired tag or character.</p></item>
<item><p>Double-click on the tag in the tag list.</p></item>
</list>

<p>The tag or special character you've chosen will then be displayed in your document.</p>
    </section>
  </section>
<section id="tag-list-tips">
  <title>Tag List Tips</title>
<note style="tip"><p>You can also insert a tag by pressing <key>Return</key> or <keyseq><key>Shift</key><key>Return</key></keyseq>.</p> 
 <p>Pressing the <key>Return</key> key will insert the tag at the cursor position, and then return focus to the document. Pressing <keyseq><key>Shift</key><key>Return</key></keyseq> will insert the tag at the cursor position, but will keep the focus on the <app>tag-list</app>.</p></note>

<note style="tip"><p>You can see a preview of what text will be inserted for each tag and special character by clicking on the word the <gui>Preview</gui> at the bottom of the side pane.</p></note>
  </section>
</page>
