source: gnome/add/gtkhtml.xml@ b66ece35

<?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 gtkhtml-download-http "&gnome-download-http;/gtkhtml/3.30/gtkhtml-&gtkhtml-version;.tar.bz2">
<!ENTITY gtkhtml-download-ftp  "&gnome-download-http;/gtkhtml/3.30/gtkhtml-&gtkhtml-version;.tar.bz2">
<!ENTITY gtkhtml-md5sum        "590c626e507a2ef9c9026699283d4004">
<!ENTITY gtkhtml-size          "1.3 MB">
<!ENTITY gtkhtml-buildsize     "36 MB">
<!ENTITY gtkhtml-time          "0.7 SBU">
]>

<sect1 id="gtkhtml" xreflabel="GtkHTML-&gtkhtml-version;">
  <?dbhtml filename="gtkhtml.html"?>

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

  <title>GtkHTML-&gtkhtml-version;</title>

  <indexterm zone="gtkhtml">
    <primary sortas="a-GtkHTML">GtkHTML</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GtkHTML</title>

    <para>The <application>GtkHTML</application> package contains a
    lightweight HTML rendering/printing/editing engine.</para>

    &lfs65_built;

    <!-- Gnome-Sharp can use this package, and Beagle can use these
         extensions, so I suppose this package is no longer
         "Evolution specific"
    This is an
    <application>Evolution</application> specific application at
    this time.</para> -->

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

    <bridgehead renderas="sect3">GtkHTML Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="enchant"/>,
    <xref linkend="GConf"/>,
    <xref linkend="gnome-icon-theme"/>,
    <xref linkend="gtk2"/>, and
    <xref linkend="iso-codes"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="libsoup"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of GtkHTML</title>

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

<screen><userinput>./configure --prefix=$(pkg-config --variable=prefix ORBit-2.0) \
            --libexecdir=$(pkg-config \
                --variable=prefix ORBit-2.0)/lib/gtkhtml &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"/>

    <para><parameter>--libexecdir=$(pkg-config --variable=prefix
    ORBit-2.0)/lib/gtkhtml</parameter>: This parameter causes the libexec
    files to be installed in the preferred location of
    <filename class="directory">$GNOME_PREFIX/lib/gtkhtml</filename> instead of
    <filename class="directory">$GNOME_PREFIX/libexec</filename>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gtkhtml-editor-test</seg>
        <seg>libgtkhtml-3.14.so and libgtkhtml-editor.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/libgtkhtml-3.14/{editor,
        gtkhtml},share/gtkhtml-3.14/icons}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gtkhtml-editor-test">
        <term><command>gtkhtml-editor-test</command></term>
        <listitem>
          <para>is a simple HTML editor widget.</para>
          <indexterm zone="gtkhtml gtkhtml-editor-test">
            <primary sortas="b-gtkhtml-editor-test">gtkhtml-editor-test</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgtkhtml-3">
        <term><filename class='libraryfile'>libgtkhtml-3.14.so</filename></term>
        <listitem>
          <para>provide the functions to render HTML within applications.</para>
          <indexterm zone="gtkhtml libgtkhtml-3">
            <primary sortas="c-libgtkhtml-3">libgtkhtml-3.14.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>