<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                "http://www.docbook.org/xml/4.3/docbookx.dtd">

<sect2 xmlns:xi="http://www.w3.org/2001/XInclude" id="gimp-filter-id"> <!--for 
  GEGL filters using xi:include-->
<!--<sect2 id="plug-in-help-id">-->
  <title><!-- filter name --></title>


  <indexterm>
    <primary>Filters</primary>
    <secondary><!-- Category --></secondary>
    <tertiary><!--filter name or what the filter does--></tertiary>
    <!-- this tertiary is
    necessary to get entries in Index one above the other instead of side by
    side (and not only page number in PDF)-->
  </indexterm>
  <indexterm><primary><!-- filter name --></primary></indexterm>

  <!-- This section gives an overview of what the filter does -->
  <sect3>
    <title>Overview</title>

    <!-- First show a double of images to show the effect the filter creates -->
    <figure>
      <title>Example for the <quote><!-- filter name --></quote></title>
      <!-- original image first -->
      <mediaobject>
        <imageobject>
          <imagedata format="JPG"
            fileref="images/filters/examples/original_image.jpg" />
        </imageobject>
        <caption>
          <para>Original image</para>
        </caption>
      </mediaobject>

      <!-- image with filter applied follows here -->
      <mediaobject>
        <imageobject>
          <imagedata format="JPG"
            fileref="images/filters/examples/image_with_filter_applied.jpg" />
        </imageobject>

        <caption>
          <para><quote><!-- filter name --></quote> applied</para>
        </caption>
      </mediaobject>
    </figure>

    <para>
      <!--
        Describe what the filter does, which algorithms it uses.
        Give the user an idea what to use the filter for
       -->
    </para>
  </sect3>


  <!--
    The next section describes where to find the filter in the menu and how to
    call it.
  -->
  <sect3>
    <title>Activating the Filter</title>

    <para>
      This filter is found in the image window menu under
      <menuchoice>
        <guimenu>Filters</guimenu>
        <guisubmenu><!-- filter category --></guisubmenu>
        <guimenuitem><!-- filter name --></guimenuitem>
      </menuchoice>.
    </para>
  </sect3>


  <!--
    The next section describes the options of the filter. If it hasn't
    any, remove this part
  -->
  <sect3>
    <title>Options</title>

    <para>
      <!--
        Describe how the filter options are organized in general.
        This part is optional, but helps if the filter options dialog is a bit
        more complex e.g. has some tabs etc.
       -->
    </para>


    <!--
      If the dialog is organized in tabs, there is one level 4 section for
      the options outside of the tabs (mostly the preview) and one level 4
      section for each tab.
      If the dialog is not tabbed, just remove the level 4 sections
    -->
    <sect4>
      <title><!-- Preview domain / <quote>tab-name</quote> Options tab --></title>

      <figure>
        <title>
          <quote><!-- filter name --></quote> <!-- tab name --> options tab
        </title>

        <mediaobject>
          <imageobject>
            <imagedata format="PNG"
              fileref="images/filters/category/(submenu)/name-tab.png" />
          </imageobject>
          <!-- or: images/filters/category/(submenu)/name-tab-options.png" -->
        </mediaobject>
      </figure>

      <para><!-- Describe what the preview/tab is good for --></para>

      <!-- The following list contains one item per option. -->
      <variablelist>
        <varlistentry>
          <term><!-- name of the option / gui-element --></term>

          <listitem>
            <para>
              <!-- Description of the option / gui-element -->
            </para>
          </listitem>
        </varlistentry>
        <!-- next option / gui-element -->
      </variablelist>
    </sect4>
    <!-- next options tab -->


    <!--
      If the dialog is not tabbed, use the following structure to describe
      the options and gui elements.
      Otherwise remove content down to the end of the level 3 section.
    -->
    <figure>
      <title><quote><!-- filter name --></quote> options</title>

      <mediaobject>
        <imageobject>
          <imagedata format="PNG"
            fileref="images/filters/category/(submenu)/name.png" />
        </imageobject>
        <!-- or: images/filters/category/(submenu)/name-tab-options.png" -->
      </mediaobject>
    </figure>

    <!-- The following list contains one item per option. -->
    <variablelist>
      <varlistentry>
        <term><!-- name of the option / gui-element --></term>

        <listitem>
          <para>
            <!-- Description of the option / gui-element -->
          </para>
        </listitem>
      </varlistentry>
      <!-- next option / gui-element -->
    </variablelist>
  </sect3>
</sect2>
