source: gnome/add/epiphany-extensions.xml@ 16efe57

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY epiphany-extensions-download-http "&gnome-download-http;/epiphany-extensions/&gnome-version;/epiphany-extensions-&epiphany-extensions-version;.tar.xz">
  <!ENTITY epiphany-extensions-download-ftp  "&gnome-download-ftp;/epiphany-extensions/&gnome-version;/epiphany-extensions-&epiphany-extensions-version;.tar.xz">
  <!ENTITY epiphany-extensions-md5sum      "abe7a73d7be0414a2ea0c0b634f12093">
  <!ENTITY epiphany-extensions-size       "1.3 MB">
  <!ENTITY epiphany-extensions-buildsize  "22 MB">
  <!ENTITY epiphany-extensions-time       "0.4 SBU">
]>

<sect1 id="epiphany-extensions" xreflabel="Epiphany-Extensions-&epiphany-extensions-version;">
  <?dbhtml filename="epiphany-extensions.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Epiphany-Extensions-&epiphany-extensions-version;</title>

  <indexterm zone="epiphany-extensions">
    <primary sortas="a-Epiphany-extensions">Epiphany Extensions</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Epiphany Extensions</title>

    <para><application>Epiphany Extensions</application> is a collection of
    extensions for <application>Epiphany</application>, the
    <application>GNOME</application> browser.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&epiphany-extensions-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&epiphany-extensions-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &epiphany-extensions-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &epiphany-extensions-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &epiphany-extensions-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &epiphany-extensions-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Epiphany Extensions Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="epiphany"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="opensp"/> and
    <xref linkend="dbus-glib"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/epiphany-extensions"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Epiphany Extensions</title>

    <para>Install <application>Epiphany Extensions</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=$GNOME_PREFIX &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gnome-prefix.xml"/>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Epiphany Extensions</title>

    <para>The extensions are all turned off until you go to
    <application>Epiphany</application>&apos;s tools menu and enable the extensions
    you wish to use.</para>

    <para>To use the html5tube extension, you need to go to <ulink
    url="http://www.youtube.com/html5">http://www.youtube.com/html5</ulink>
    and click on 'Join the HTML5 Trial' (needs cookies enabled, and must be
    repeated for each browser on which you wish to use HTML5).</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libactionsextension.so, libadblockextension.so, libautoreloadextension.so,
        libcertificatesextension.so, libextensionsmanagerrui.so, libgesturesextension.so,
        libgreasemonkeyextension.so, libhtml5tubeextension.so, libpushscrollerextension.so,
        libsoupflyextension.so, librssextension.so, libtabkeytabnavigateextension.so,
        libtabstatesextension.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{lib/epiphany/3.2/extensions,
        share/{epiphany-extensions,{gnome-help,omf}/epiphany-extensions}}</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libactionsextension">
        <term><filename class='libraryfile'>libactionsextension.so</filename></term>
        <listitem>
          <para>contains functions to execute arbitrary commands from the context menu.</para>
          <indexterm zone="epiphany-extensions libactionsextension">
            <primary sortas="c-libactionsextension">libactionsextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libadblockextension">
        <term><filename class='libraryfile'>libadblockextension.so</filename></term>
        <listitem>
          <para>contains functions to block adverts.</para>
          <indexterm zone="epiphany-extensions libadblockextension">
            <primary sortas="c-libadblockextension">libadblockextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libautoreloadextension">
        <term><filename class='libraryfile'>libautoreloadextension.so</filename></term>
        <listitem>
          <para>contains functions to reload a tab periodically.</para>
          <indexterm zone="epiphany-extensions libautoreloadextension">
            <primary sortas="c-libautoreloadextension">libautoreloadextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libcertificatesextension">
        <term><filename class='libraryfile'>libcertificatesextension.so</filename></term>
        <listitem>
          <para>contains functions to view the page certificate and manage certificates.</para>
          <indexterm zone="epiphany-extensions libcertificatesextension">
            <primary sortas="c-libcertificatesextension">libcertificatesextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgesturesextension">
        <term><filename class='libraryfile'>libgesturesextension.so</filename></term>
        <listitem>
          <para>contains functions to perform actions with mouse gestures.</para>
          <indexterm zone="epiphany-extensions libgesturesextension">
            <primary sortas="c-libgesturesextension">libgesturesextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgreasemonkeyextension">
        <term><filename class='libraryfile'>libgreasemonkeyextension.so</filename></term>
        <listitem>
          <para>contains functions to run user scripts to modify web page&apos;s behaviour.
          </para>
          <indexterm zone="epiphany-extensions libgreasemonkeyextension">
            <primary sortas="c-libgreasemonkeyextension">libgreasemonkeyextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libhtml5tubeextension">
        <term><filename class='libraryfile'>libhtml5tubeextension.so</filename></term>
        <listitem>
          <para>contains functions to view most Youtube videos using Webkit&apos;s HTML5
          media player.</para>
          <indexterm zone="epiphany-extensions libhtml5tubeextension">
            <primary sortas="c-libhtml5tubeextension">libhtml5tubeextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpushscrollerextension">
        <term><filename class='libraryfile'>libpushscrollerextension.so</filename></term>
        <listitem>
          <para>contains functions to drag the page with the middle mouse button.</para>
          <indexterm zone="epiphany-extensions libpushscrollerextension">
            <primary sortas="c-libpushscrollerextension">libpushscrollerextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="librssextension">
        <term><filename class='libraryfile'>librssextension.so</filename></term>
        <listitem>
          <para>contains functions to subscribe to a news feed offered by the webpage.</para>
          <indexterm zone="epiphany-extensions librssextension">
            <primary sortas="c-librssextension">librssextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libsoupflyextension">
        <term><filename class='libraryfile'>libsoupflyextension.so</filename></term>
        <listitem>
          <para>contains functions to debug the Soup session which Webkit uses.</para>
          <indexterm zone="epiphany-extensions libsoupflyextension">
            <primary sortas="c-libsoupflyextension">libsoupflyextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtabkeynavigateextension">
        <term><filename class='libraryfile'>libtabkeynavigateextension.so</filename></term>
        <listitem>
          <para>contains functions to use the tab key to navigate between tabs.</para>
          <indexterm zone="epiphany-extensions libtabkeynavigateextension">
            <primary sortas="c-libtabkeynavigateextension">libtabkeynavigateextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtabstatesextension">
        <term><filename class='libraryfile'>libtabstatesextension.so</filename></term>
        <listitem>
          <para>contains functions to indicate new content in background tabs.</para>
          <indexterm zone="epiphany-extensions libtabstatesextension">
            <primary sortas="c-libtabstatesextension">libtabstatesextension.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>