r6109 - in trunk/BOOK: . general/genutils gnome/core introduction/welcome

randy at linuxfromscratch.org randy at linuxfromscratch.org
Thu May 18 12:15:16 PDT 2006


Author: randy
Date: 2006-05-18 13:15:15 -0600 (Thu, 18 May 2006)
New Revision: 6109

Added:
   trunk/BOOK/general/genutils/scrollkeeper.xml
Removed:
   trunk/BOOK/gnome/core/scrollkeeper.xml
Modified:
   trunk/BOOK/general.ent
   trunk/BOOK/general/genutils/genutils.xml
   trunk/BOOK/gnome/core/core.xml
   trunk/BOOK/introduction/welcome/changelog.xml
Log:
Moved the ScrollKeeper instructions from Chapter 31 - GNOME Core Packages to Chapter 10 - General Utilities as the package installation prefix is /usr and other-than-GNOME packages can utilize it

Modified: trunk/BOOK/general/genutils/genutils.xml
===================================================================
--- trunk/BOOK/general/genutils/genutils.xml	2006-05-18 18:58:03 UTC (rev 6108)
+++ trunk/BOOK/general/genutils/genutils.xml	2006-05-18 19:15:15 UTC (rev 6109)
@@ -20,6 +20,7 @@
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="imagemagick.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="hd2u.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gtk-doc.xml"/>
+  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="scrollkeeper.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="intltool.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="screen.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="tidy.xml"/>

Copied: trunk/BOOK/general/genutils/scrollkeeper.xml (from rev 6108, trunk/BOOK/gnome/core/scrollkeeper.xml)
===================================================================
--- trunk/BOOK/general/genutils/scrollkeeper.xml	                        (rev 0)
+++ trunk/BOOK/general/genutils/scrollkeeper.xml	2006-05-18 19:15:15 UTC (rev 6109)
@@ -0,0 +1,205 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
+  <!ENTITY % general-entities SYSTEM "../../general.ent">
+  %general-entities;
+
+  <!ENTITY scrollkeeper-download-http "&gnome-download-http;/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
+  <!ENTITY scrollkeeper-download-ftp  "&gnome-download-ftp;/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
+  <!ENTITY scrollkeeper-md5sum        "b175e582a6cec3e50a9de73a5bb7455a">
+  <!ENTITY scrollkeeper-size          "546 KB">
+  <!ENTITY scrollkeeper-buildsize     "12 MB">
+  <!ENTITY scrollkeeper-time          "0.1 SBU">
+]>
+
+<sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
+  <?dbhtml filename="scrollkeeper.html"?>
+
+  <sect1info>
+    <othername>$LastChangedBy$</othername>
+    <date>$Date$</date>
+    <keywordset>
+      <keyword role="package">scrollkeeper-&scrollkeeper-version;.tar</keyword>
+      <keyword role="ftpdir">scrollkeeper</keyword>
+    </keywordset>
+  </sect1info>
+
+  <title>ScrollKeeper-&scrollkeeper-version;</title>
+
+  <indexterm zone="scrollkeeper">
+    <primary sortas="a-ScrollKeeper">ScrollKeeper</primary>
+  </indexterm>
+
+  <sect2 role="package">
+    <title>Introduction to ScrollKeeper</title>
+
+    <para>The <application>ScrollKeeper</application> package contains a
+    cataloging system for documentation. This is useful for managing
+    documentation metadata and providing an API to help browsers find, sort
+    and search the document catalog.</para>
+
+    <bridgehead renderas="sect3">Package Information</bridgehead>
+    <itemizedlist spacing="compact">
+      <listitem>
+        <para>Download (HTTP): <ulink url="&scrollkeeper-download-http;"/></para>
+      </listitem>
+      <listitem>
+        <para>Download (FTP): <ulink url="&scrollkeeper-download-ftp;"/></para>
+      </listitem>
+      <listitem>
+        <para>Download MD5 sum: &scrollkeeper-md5sum;</para>
+      </listitem>
+      <listitem>
+        <para>Download size: &scrollkeeper-size;</para>
+      </listitem>
+      <listitem>
+        <para>Estimated disk space required: &scrollkeeper-buildsize;</para>
+      </listitem>
+      <listitem>
+        <para>Estimated build time: &scrollkeeper-time;</para>
+      </listitem>
+    </itemizedlist>
+
+    <bridgehead renderas="sect3">ScrollKeeper Dependencies</bridgehead>
+
+    <bridgehead renderas="sect4">Required</bridgehead>
+    <para role="required"><xref linkend="libxslt"/>,
+    <xref linkend="DocBook"/>, and
+    <xref linkend="perl-xml-parser"/></para>
+
+    <bridgehead renderas="sect4">Optional</bridgehead>
+    <para role="optional"><xref linkend="intltool"/></para>
+
+    <para condition="html" role="usernotes">User Notes:
+    <ulink url="&blfs-wiki;/scrollkeeper"/></para>
+
+  </sect2>
+
+  <sect2 role="installation">
+    <title>Installation of ScrollKeeper</title>
+
+    <para>Install <application>ScrollKeeper</application> by running the
+    following commands:</para>
+
+<screen><userinput>./configure --prefix=/usr \
+            --sysconfdir=/etc \
+            --localstatedir=/var \
+            --disable-static \
+            --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
+/opt/kde-&kde-version;/share/omf:\
+/opt/gnome-&gnome-version;&gnome-minor-version;/share/omf &&
+
+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>
+
+    <para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
+    configuration files in <filename class="directory">/etc</filename>
+    instead of <filename class='directory'>/usr/etc</filename>.</para>
+
+    <para><parameter>--localstatedir=/var</parameter>: This switch puts
+    <application>ScrollKeeper</application>'s database directory in
+    <filename class="directory">/var/lib/scrollkeeper</filename>.</para>
+
+    <para><parameter>--disable-static</parameter>: This switch prevents
+    the static library from being built.</para>
+
+    <para><parameter>--with-omfdirs=...</parameter>: This switch defines the
+    locations of <filename>OMF</filename> files for
+    <application>ScrollKeeper</application>. Change the locations if you have
+    <application>KDE</application> and/or <application>GNOME</application>-2
+    installed in a prefix other than the ones shown. This information is stored
+    in <filename>/etc/scrollkeeper.conf</filename> and can be updated manually,
+    if necessary.</para>
+
+  </sect2>
+
+  <sect2 role="configuration">
+    <title>Configuring ScrollKeeper</title>
+
+    <sect3 id="scrollkeeper-config">
+      <title>Config Files</title>
+
+      <para><filename>/etc/scrollkeeper.conf</filename></para>
+
+      <indexterm zone="scrollkeeper scrollkeeper-config">
+        <primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
+      </indexterm>
+
+    </sect3>
+
+    <sect3>
+      <title>Configuration Information</title>
+
+      <para>The configuration file sets the <envar>OMF_DIR</envar> variable
+      to the location of all of the <filename class="directory">omf</filename>
+      directories in the system. This was set in the
+      <command>configure</command> command so no further action is needed until
+      another <filename>OMF</filename> directory is created.</para>
+
+    </sect3>
+
+  </sect2>
+
+  <sect2 role="content">
+    <title>Contents</title>
+
+    <segmentedlist>
+      <segtitle>Installed Programs</segtitle>
+      <segtitle>Installed Library</segtitle>
+      <segtitle>Installed Directories</segtitle>
+
+      <seglistitem>
+        <seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid,
+        scrollkeeper-get-cl, scrollkeeper-get-content-list,
+        scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath,
+        scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id,
+        scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb,
+        scrollkeeper-uninstall, and scrollkeeper-update</seg>
+        <seg>libscrollkeeper.so</seg>
+        <seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;,
+        /usr/share/{omf, {,xml/}scrollkeeper}, and
+        /var/lib/scrollkeeper</seg>
+      </seglistitem>
+    </segmentedlist>
+
+    <variablelist>
+      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
+      <?dbfo list-presentation="list"?>
+      <?dbhtml list-presentation="table"?>
+
+      <varlistentry>
+        <term><command>ScrollKeeper utility programs</command></term>
+        <listitem>
+          <para>The <application>ScrollKeeper</application> utility programs
+          and scripts listed above are for performing installation, building,
+          getting and updating table of contents files.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry id="libscrollkeeper">
+        <term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
+        <listitem>
+          <para>provides the API necessary for help
+          browsers to interact with documentation written to utilize
+          <application>ScrollKeeper</application>.</para>
+          <indexterm zone="scrollkeeper libscrollkeeper">
+            <primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
+          </indexterm>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </sect2>
+
+</sect1>

Modified: trunk/BOOK/general.ent
===================================================================
--- trunk/BOOK/general.ent	2006-05-18 18:58:03 UTC (rev 6108)
+++ trunk/BOOK/general.ent	2006-05-18 19:15:15 UTC (rev 6109)
@@ -138,6 +138,7 @@
 <!ENTITY imagemagick-version          "6.2.7">
 <!ENTITY hd2u-version                 "1.0.0">
 <!ENTITY gtk-doc-version              "1.6">
+<!ENTITY scrollkeeper-version         "0.3.14">
 <!ENTITY intltool-version             "0.34.2">
 <!ENTITY screen-version               "4.0.2">
 <!ENTITY tidy-version                 "051026">
@@ -414,7 +415,6 @@
 <!ENTITY libgnomeui-version           "2.12.0">
 <!ENTITY gtk-engines-version          "2.6.6">
 <!ENTITY gnome-themes-version         "2.12.1">
-<!ENTITY scrollkeeper-version         "0.3.14">
 <!ENTITY gnome-doc-utils-version      "0.4.4">
 <!ENTITY gnome-desktop-version        "2.12.2">
 <!ENTITY gnome-backgrounds-version    "2.12.2">

Modified: trunk/BOOK/gnome/core/core.xml
===================================================================
--- trunk/BOOK/gnome/core/core.xml	2006-05-18 18:58:03 UTC (rev 6108)
+++ trunk/BOOK/gnome/core/core.xml	2006-05-18 19:15:15 UTC (rev 6109)
@@ -38,7 +38,6 @@
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="libgnomeui.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gtk-engines.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gnome-themes.xml"/>
-  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="scrollkeeper.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gnome-doc-utils.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gnome-desktop.xml"/>
   <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="gnome-backgrounds.xml"/>

Deleted: trunk/BOOK/gnome/core/scrollkeeper.xml
===================================================================
--- trunk/BOOK/gnome/core/scrollkeeper.xml	2006-05-18 18:58:03 UTC (rev 6108)
+++ trunk/BOOK/gnome/core/scrollkeeper.xml	2006-05-18 19:15:15 UTC (rev 6109)
@@ -1,205 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
-   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
-  <!ENTITY % general-entities SYSTEM "../../general.ent">
-  %general-entities;
-
-  <!ENTITY scrollkeeper-download-http "&gnome-download-http;/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
-  <!ENTITY scrollkeeper-download-ftp  "&gnome-download-ftp;/scrollkeeper/0.3/scrollkeeper-&scrollkeeper-version;.tar.bz2">
-  <!ENTITY scrollkeeper-md5sum        "b175e582a6cec3e50a9de73a5bb7455a">
-  <!ENTITY scrollkeeper-size          "546 KB">
-  <!ENTITY scrollkeeper-buildsize     "12 MB">
-  <!ENTITY scrollkeeper-time          "0.1 SBU">
-]>
-
-<sect1 id="scrollkeeper" xreflabel="ScrollKeeper-&scrollkeeper-version;">
-  <?dbhtml filename="scrollkeeper.html"?>
-
-  <sect1info>
-    <othername>$LastChangedBy$</othername>
-    <date>$Date$</date>
-    <keywordset>
-      <keyword role="package">scrollkeeper-&scrollkeeper-version;.tar</keyword>
-      <keyword role="ftpdir">scrollkeeper</keyword>
-    </keywordset>
-  </sect1info>
-
-  <title>ScrollKeeper-&scrollkeeper-version;</title>
-
-  <indexterm zone="scrollkeeper">
-    <primary sortas="a-ScrollKeeper">ScrollKeeper</primary>
-  </indexterm>
-
-  <sect2 role="package">
-    <title>Introduction to ScrollKeeper</title>
-
-    <para>The <application>ScrollKeeper</application> package contains a
-    cataloging system for documentation. This is useful for managing
-    documentation metadata and providing an API to help browsers find, sort
-    and search the document catalog.</para>
-
-    <bridgehead renderas="sect3">Package Information</bridgehead>
-    <itemizedlist spacing="compact">
-      <listitem>
-        <para>Download (HTTP): <ulink url="&scrollkeeper-download-http;"/></para>
-      </listitem>
-      <listitem>
-        <para>Download (FTP): <ulink url="&scrollkeeper-download-ftp;"/></para>
-      </listitem>
-      <listitem>
-        <para>Download MD5 sum: &scrollkeeper-md5sum;</para>
-      </listitem>
-      <listitem>
-        <para>Download size: &scrollkeeper-size;</para>
-      </listitem>
-      <listitem>
-        <para>Estimated disk space required: &scrollkeeper-buildsize;</para>
-      </listitem>
-      <listitem>
-        <para>Estimated build time: &scrollkeeper-time;</para>
-      </listitem>
-    </itemizedlist>
-
-    <bridgehead renderas="sect3">ScrollKeeper Dependencies</bridgehead>
-
-    <bridgehead renderas="sect4">Required</bridgehead>
-    <para role="required"><xref linkend="libxslt"/>,
-    <xref linkend="DocBook"/>, and
-    <xref linkend="perl-xml-parser"/></para>
-
-    <bridgehead renderas="sect4">Optional</bridgehead>
-    <para role="optional"><xref linkend="intltool"/></para>
-
-    <para condition="html" role="usernotes">User Notes:
-    <ulink url="&blfs-wiki;/scrollkeeper"/></para>
-
-  </sect2>
-
-  <sect2 role="installation">
-    <title>Installation of ScrollKeeper</title>
-
-    <para>Install <application>ScrollKeeper</application> by running the
-    following commands:</para>
-
-<screen><userinput>./configure --prefix=/usr \
-            --sysconfdir=/etc \
-            --localstatedir=/var \
-            --disable-static \
-            --with-omfdirs=/usr/share/omf:/opt/gnome-1.4/share/omf:\
-/opt/kde-&kde-version;/share/omf:\
-/opt/gnome-&gnome-version;&gnome-minor-version;/share/omf &&
-
-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>
-
-    <para><parameter>--sysconfdir=/etc</parameter>: This switch puts the
-    configuration files in <filename class="directory">/etc</filename>
-    instead of <filename class='directory'>/usr/etc</filename>.</para>
-
-    <para><parameter>--localstatedir=/var</parameter>: This switch puts
-    <application>ScrollKeeper</application>'s database directory in
-    <filename class="directory">/var/lib/scrollkeeper</filename>.</para>
-
-    <para><parameter>--disable-static</parameter>: This switch prevents
-    the static library from being built.</para>
-
-    <para><parameter>--with-omfdirs=...</parameter>: This switch defines the
-    locations of <filename>OMF</filename> files for
-    <application>ScrollKeeper</application>. Change the locations if you have
-    <application>KDE</application> and/or <application>GNOME</application>-2
-    installed in a prefix other than the ones shown. This information is stored
-    in <filename>/etc/scrollkeeper.conf</filename> and can be updated manually,
-    if necessary.</para>
-
-  </sect2>
-
-  <sect2 role="configuration">
-    <title>Configuring ScrollKeeper</title>
-
-    <sect3 id="scrollkeeper-config">
-      <title>Config Files</title>
-
-      <para><filename>/etc/scrollkeeper.conf</filename></para>
-
-      <indexterm zone="scrollkeeper scrollkeeper-config">
-        <primary sortas="e-etc-scrollkeeper.conf">/etc/scrollkeeper.conf</primary>
-      </indexterm>
-
-    </sect3>
-
-    <sect3>
-      <title>Configuration Information</title>
-
-      <para>The configuration file sets the <envar>OMF_DIR</envar> variable
-      to the location of all of the <filename class="directory">omf</filename>
-      directories in the system. This was set in the
-      <command>configure</command> command so no further action is needed until
-      another <filename>OMF</filename> directory is created.</para>
-
-    </sect3>
-
-  </sect2>
-
-  <sect2 role="content">
-    <title>Contents</title>
-
-    <segmentedlist>
-      <segtitle>Installed Programs</segtitle>
-      <segtitle>Installed Library</segtitle>
-      <segtitle>Installed Directories</segtitle>
-
-      <seglistitem>
-        <seg>scrollkeeper-config, scrollkeeper-extract, scrollkeeper-gen-seriesid,
-        scrollkeeper-get-cl, scrollkeeper-get-content-list,
-        scrollkeeper-get-extended-content-list, scrollkeeper-get-index-from-docpath,
-        scrollkeeper-get-toc-from-docpath, scrollkeeper-get-toc-from-id,
-        scrollkeeper-install, scrollkeeper-preinstall, scrollkeeper-rebuilddb,
-        scrollkeeper-uninstall, and scrollkeeper-update</seg>
-        <seg>libscrollkeeper.so</seg>
-        <seg>/usr/share/doc/scrollkeeper-&scrollkeeper-version;,
-        /usr/share/{omf, {,xml/}scrollkeeper}, and
-        /var/lib/scrollkeeper</seg>
-      </seglistitem>
-    </segmentedlist>
-
-    <variablelist>
-      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
-      <?dbfo list-presentation="list"?>
-      <?dbhtml list-presentation="table"?>
-
-      <varlistentry>
-        <term><command>ScrollKeeper utility programs</command></term>
-        <listitem>
-          <para>The <application>ScrollKeeper</application> utility programs
-          and scripts listed above are for performing installation, building,
-          getting and updating table of contents files.</para>
-        </listitem>
-      </varlistentry>
-
-      <varlistentry id="libscrollkeeper">
-        <term><filename class='libraryfile'>libscrollkeeper.so</filename></term>
-        <listitem>
-          <para>provides the API necessary for help
-          browsers to interact with documentation written to utilize
-          <application>ScrollKeeper</application>.</para>
-          <indexterm zone="scrollkeeper libscrollkeeper">
-            <primary sortas="c-libscrollkeeper">libscrollkeeper.so</primary>
-          </indexterm>
-        </listitem>
-      </varlistentry>
-
-    </variablelist>
-
-  </sect2>
-
-</sect1>

Modified: trunk/BOOK/introduction/welcome/changelog.xml
===================================================================
--- trunk/BOOK/introduction/welcome/changelog.xml	2006-05-18 18:58:03 UTC (rev 6108)
+++ trunk/BOOK/introduction/welcome/changelog.xml	2006-05-18 19:15:15 UTC (rev 6109)
@@ -45,6 +45,12 @@
       <para>May 18th, 2006</para>
       <itemizedlist>
         <listitem>
+          <para>[randy] - Moved the ScrollKeeper instructions from Chapter 31
+          - GNOME Core Packages to Chapter 10 - General Utilities as the
+          package installation prefix is /usr and other-than-GNOME packages
+          can utilize it.</para>
+        </listitem>
+        <listitem>
           <para>[randy] - Added libacl as an optional dependency of
           Samba.</para>
         </listitem>




More information about the blfs-book mailing list