Rewrote some of the scrollkeeper and OMF sections.

2006-03-12  Brent Smith  <gnome@nextreality.net>
        * help.xml:
        Rewrote some of the scrollkeeper and OMF sections.
        * fontconfig.xml:
        * mimetypes.xml:
        * performance.xml:
        Replaced a bunch of <para> elements with <screen> where appropriate

5 files changed, 97 insertions, 124 deletions

diff --git a/gnome2-system-admin-guide/C/ChangeLog b/gnome2-system-admin-guide/C/ChangeLog
index 193f3ac..e2bef36 100644
--- a/gnome2-system-admin-guide/C/ChangeLog
+++ b/gnome2-system-admin-guide/C/ChangeLog
@@ -1,3 +1,12 @@
+2006-03-12  Brent Smith  <gnome@nextreality.net>
+
+	* help.xml:
+	Rewrote some of the scrollkeeper and OMF sections.
+	* fontconfig.xml:
+	* mimetypes.xml:
+	* performance.xml:
+	Replaced a bunch of <para> elements with <screen> where appropriate
+
 2006-03-12  Luca Ferretti  <elle.uca@libero.it>
 
 	* menustructure.xml:
diff --git a/gnome2-system-admin-guide/C/fontconfig.xml b/gnome2-system-admin-guide/C/fontconfig.xml
index 0bd3f58..19383c0 100644
--- a/gnome2-system-admin-guide/C/fontconfig.xml
+++ b/gnome2-system-admin-guide/C/fontconfig.xml
@@ -67,10 +67,7 @@ uses the first font that is defined for that alias in the <filename>/etc/fonts/f
         <para>The <literal>fontconfig</literal> library updates the list
 of fonts automatically. If the list of fonts is not updated, run the following
 command:</para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>fc-cache <replaceable>directory-name</replaceable></userinput>
-        </para>
+        <screen><userinput>fc-cache <replaceable>directory-name</replaceable></userinput></screen>
       </listitem>
     </orderedlist>
   </sect1>
@@ -91,10 +88,7 @@ directory of the user. If you drag the font file to the <literal>fonts:///</lite
         <para>The <literal>fontconfig</literal> library updates the list
 of fonts automatically. If the list of fonts is not updated, run the following
 command:</para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>fc-cache <replaceable>directory-name</replaceable></userinput>
-        </para>
+        <screen><userinput>fc-cache <replaceable>directory-name</replaceable></userinput></screen>
       </listitem>
     </orderedlist>
   </sect1>
diff --git a/gnome2-system-admin-guide/C/help.xml b/gnome2-system-admin-guide/C/help.xml
index dc126c5..f380b00 100644
--- a/gnome2-system-admin-guide/C/help.xml
+++ b/gnome2-system-admin-guide/C/help.xml
@@ -61,6 +61,9 @@ browser.</para>
         <para>A subject category to which the Help document belongs</para>
       </listitem>
     </itemizedlist>
+    <para>For more information on how to create OMF files, please see 
+    <ulink url="ghelp:writing_scrollkeeper_omf_files">Writing Scrollkeeper 
+OMF Files</ulink>.</para>
   </sect1>
   <sect1 id="help-2">
     <title>ScrollKeeper Cataloging System</title>
@@ -72,34 +75,40 @@ browser.</para>
       <primary>ScrollKeeper cataloging system</primary>
     </indexterm>
     <para><application>ScrollKeeper</application> is a cataloging
-system for documentation. The Help browser uses <application>ScrollKeeper</application> to catalog the manuals on the system. <application>ScrollKeeper</application> manages the information in the OMF files for the Help browser. </para>
-    <para><application>ScrollKeeper</application> uses the information in the
-OMF files to enable the Help browser to find Help documents on a system. When
-you install an application, the installation process installs an OMF file
-to a directory of OMF files. </para>
-    <para><application>ScrollKeeper</application> builds a table of contents for
-each Help document that has an associated OMF file. <application>ScrollKeeper</application> builds the table of contents from the XML file specified in
-the OMF file. The table of contents for the Help document is displayed in
-the left pane of the Help browser window, and enables users to navigate the
-Help document in the left pane. The title of the document in the OMF file
-is also displayed in the left pane of the Help browser window. </para>
+system for documentation.  Its primary function is to manage the information in 
+OMF files for the help browser.  When you install an application, the 
+OMF file is copied to the <filename>
+<replaceable>$prefix</replaceable>/share/omf/<replaceable>&lt;application-name&gt;</replaceable>
+</filename> directory.
+</para>
+
+    <para><application>ScrollKeeper</application> builds a table of contents from the
+collection of OMF files in the directories specified in 
+<filename><replaceable>$prefix</replaceable>/etc/scrollkeeper.conf</filename> file. 
+This file usually consists of a single line with the <varname>OMF_DIR</varname> 
+set to a comma separated list of directories to recursively search.</para>
+
+    <programlisting>OMF_DIR=/usr/share/omf:/usr/local/share/omf:/opt/gnome2/share/omf:/opt/kde/omf
+</programlisting>
+
     <para><application>ScrollKeeper</application> contains a hierarchy of subject
-categories to which a Help document can belong. The Help documents are organized
-into this hierarchy of subject categories in the left pane of the Help browser
-window. The subject category of the document in the OMF file determines the
-location of the document in the hierarchy. The hierarchy of subject categories
-is defined in the following file:</para>
-    <para>
-      <filename>/usr/share/scrollkeeper/Templates/C/scrollkeeper_cl.xml</filename>
-    </para>
-    <para>The subject category of a document must correspond to a subject category
-in the following file:</para>
-    <para>
-      <filename>/usr/share/scrollkeeper/Templates/C/scrollkeeper_cl.xml</filename>
-    </para>
+categories to which a help document can belong. The subject category of the document 
+in the OMF file determines the location of the document in the table of contents presented
+by the help browser.</para>
+
+    <para>The hierarchy of subject categories is defined in the file
+<filename>
+<replaceable>$prefix</replaceable>/scrollkeeper/Templates/<replaceable>&lt;lang&gt;</replaceable>/scrollkeeper_cl.xml</filename>. 
+The subject category of a document must correspond to a category specified in this file.</para>
+
+    <para>For more information on the <application>Scrollkeeper</application> system,
+visit the website at 
+<ulink url="http://scrollkeeper.sourceforge.net/">http://scrollkeeper.sourceforge.net/</ulink>.
+</para>
+
     <note>
-      <para>If the Help document XML file is moved to a new location, then
-you might need to update the location in the OMF file.</para>
+      <para>If the help document XML file is moved to a new location, then
+the location in the OMF file needs to be updated.</para>
     </note>
   </sect1>
 </chapter>
diff --git a/gnome2-system-admin-guide/C/mimetypes.xml b/gnome2-system-admin-guide/C/mimetypes.xml
index 3c45a03..15ca2a8 100644
--- a/gnome2-system-admin-guide/C/mimetypes.xml
+++ b/gnome2-system-admin-guide/C/mimetypes.xml
@@ -652,7 +652,7 @@
         <listitem>
           <para>Update the MIME database by running
           <application>update-mime-database</application> using the system
-          account.<screen><prompt>#</prompt> <userinput>update-mime-database /usr/share/mime</userinput></screen></para>
+          account.<screen><userinput>update-mime-database /usr/share/mime</userinput></screen></para>
         </listitem>
       </orderedlist>
 
diff --git a/gnome2-system-admin-guide/C/performance.xml b/gnome2-system-admin-guide/C/performance.xml
index 21cd41f..87be271 100644
--- a/gnome2-system-admin-guide/C/performance.xml
+++ b/gnome2-system-admin-guide/C/performance.xml
@@ -81,17 +81,13 @@ as HighContrastInverse. Use Atlanta with inverse controls options.</para>
       </note>
       <para><indexterm><primary>themes</primary><secondary>window frame options</secondary><tertiary>changing</tertiary></indexterm>To change the window
 frame theme option, run the following command: </para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type string
---set /apps/metacity/general/theme <replaceable>option-name</replaceable></userinput>
-      </para>
+      <screen><userinput>gconftool-2 \
+--type string \
+--set /apps/metacity/general/theme <replaceable>option-name</replaceable></userinput></screen>
       <para>For example, to use Atlanta, run the following command:</para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type string
---set /apps/metacity/general/theme Atlanta</userinput>
-      </para>
+      <screen><userinput>gconftool-2 \
+--type string \
+--set /apps/metacity/general/theme Atlanta</userinput></screen>
       <para>Alternatively, users can use the <application>Theme</application> preference
 tool to select the appropriate option.</para>
       <tip>
@@ -99,17 +95,10 @@ tool to select the appropriate option.</para>
 to measure the performance of a window frame option, and to preview the option.
 To start <application>Metacity Theme Viewer</application>, use the following
 command:</para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>metacity-theme-viewer <replaceable>option-name</replaceable></userinput>
-        </para>
+        <screen><userinput>metacity-theme-viewer <replaceable>option-name</replaceable></userinput></screen>
         <para>For example, to measure the performance of Atlanta and preview Atlanta,
 run the following command: </para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>metacity-theme-viewer
-Atlanta</userinput>
-        </para>
+        <screen><userinput>metacity-theme-viewer Atlanta</userinput></screen>
       </tip>
     </sect2>
     <sect2 id="performance-2">
@@ -128,11 +117,9 @@ Atlanta</userinput>
       </indexterm>
       <para>Some items in menus display an icon beside the
 item. To turn off this feature, run the following command: </para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type bool
---set /desktop/gnome/interface/menus_have_icons false</userinput>
-      </para>
+      <screen><userinput>gconftool-2 \
+--type bool \
+--set /desktop/gnome/interface/menus_have_icons false</userinput></screen>
       <para>Alternatively, users can use the <application>Menus &amp; Toolbars</application>
 preference tool to deselect the <guilabel>Show icons in menus</guilabel> option.</para>
     </sect2>
@@ -147,11 +134,9 @@ a splash screen is displayed. Icons are displayed on the splash screen while
 the user logs in. You can turn off the splash screen to reduce CPU usage during
 login. </para>
       <para><indexterm><primary>splash screen</primary><secondary>turning off</secondary></indexterm>To turn off the splash screen, run the following command:</para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type bool
---set /apps/gnome-session/options/show_splash_screen false</userinput>
-      </para>
+      <screen><userinput>gconftool-2 \
+--type bool \
+--set /apps/gnome-session/options/show_splash_screen false</userinput></screen>
       <para>Alternatively, users can use the <application>Sessions</application>
 preference tool to deselect the <guilabel>Show splash screen on login</guilabel>
 option.</para>
@@ -164,11 +149,9 @@ option.</para>
       </indexterm>
       <para>When users show or hide panels, the panels can show or hide
 in an animated style. To turn off panel animation, run the following command: </para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type bool
---set /apps/panel/global/enable_animations false</userinput>
-      </para>
+      <screen><userinput>gconftool-2 \
+--type bool \
+--set /apps/panel/global/enable_animations false</userinput></screen>
       <para>Alternatively, users can use the <application>Panel</application> preference
 tool to deselect the <guilabel>Drawer and panel animation</guilabel> option.</para>
     </sect2>
@@ -269,11 +252,9 @@ manager. For the fastest performance, set the value of the preferences to <liter
                   <para>Specifies when to preview the content of text files
 in the icon that represents the file. To never preview the content of text
 files, run the following command: </para>
-                  <para>
-                    <computeroutput>#</computeroutput>
-                    <userinput>gconftool-2 --type string --set /apps/nautilus/preferences/</userinput>
-                    <userinput>show_icon_text never</userinput>
-                  </para>
+                  <screen><userinput>gconftool-2 \
+--type string \
+--set /apps/nautilus/preferences/show_icon_text never</userinput></screen>
                   <para>Alternatively, users can perform
 the following steps:</para>
                   <orderedlist>
@@ -296,11 +277,9 @@ preference.</para>
                 <entry valign="top">
                   <para>Specifies when to show the number of items in folders.
 To never show the number of items in folders, run the following command:</para>
-                  <para>
-                    <computeroutput>#</computeroutput>
-                    <userinput>gconftool-2 --type string --set /apps/nautilus/preferences/</userinput>
-                    <userinput>show_directory_item_counts never</userinput>
-                  </para>
+                  <screen><userinput>gconftool-2 \
+--type string \
+--set /apps/nautilus/preferences/show_directory_item_counts never</userinput></screen>
                   <para>Alternatively, users can perform the following steps:</para>
                   <orderedlist>
                     <listitem>
@@ -322,11 +301,9 @@ preference.</para>
                 <entry valign="top">
                   <para>Specifies when to show thumbnails of image files.
 To never show thumbnails, run the following command:</para>
-                  <para>
-                    <computeroutput>#</computeroutput>
-                    <userinput>gconftool-2 --type string --set /apps/nautilus/preferences/</userinput>
-                    <userinput>show_image_thumbnails never</userinput>
-                  </para>
+                  <screen><userinput>gconftool-2 \
+--type string \
+--set /apps/nautilus/preferences/show_image_thumbnails never</userinput></screen>
                   <para>Alternatively, users can perform the following steps:</para>
                   <orderedlist>
                     <listitem>
@@ -348,11 +325,9 @@ preference.</para>
                 <entry valign="top">
                   <para>Specifies when to preview the content of sound files.
 To never preview the content of sound files, run the following command:</para>
-                  <para>
-                    <computeroutput>#</computeroutput>
-                    <userinput>gconftool-2 --type string --set /apps/nautilus/preferences/preview_sound
-never </userinput>
-                  </para>
+                  <screen><userinput>gconftool-2 \
+--type string \
+--set /apps/nautilus/preferences/preview_sound never</userinput></screen>
                   <para>Alternatively, users can perform the following
 steps:</para>
                   <orderedlist>
@@ -380,28 +355,22 @@ preference.</para>
 you to turn off the side pane and the toolbar. To improve file manager performance,
 turn off the side pane and the toolbar.</para>
         <para>To turn off the side pane, run the following command: </para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>gconftool-2 --type bool
---set /apps/nautilus/preferences/start_with_sidebar false</userinput>
-        </para>
+        <screen><userinput>gconftool-2 \
+--type bool \
+--set /apps/nautilus/preferences/start_with_sidebar false</userinput></screen>
         <para><indexterm><primary>file manager</primary><secondary>toolbar, turning
 off</secondary></indexterm>To turn off the toolbar, run the following command: </para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>gconftool-2 --type bool
---set /apps/nautilus/preferences/start_with_toolbar false</userinput>
-        </para>
+        <screen><userinput>gconftool-2 \
+--type bool \
+--set /apps/nautilus/preferences/start_with_toolbar false</userinput></screen>
         <para>You can also turn off the location bar. Users can use the <keycombo><keycap>Ctrl</keycap><keycap>L</keycap></keycombo> keyboard shortcut to display a location bar
 when required.  </para>
         <para><indexterm><primary>file manager</primary><secondary>location bar, turning
 off</secondary></indexterm>To turn off the location bar, run the following
 command:</para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>gconftool-2 --type bool
---set /apps/nautilus/preferences/start_with_location_bar false</userinput>
-        </para>
+        <screen><userinput>gconftool-2 \
+--type bool \
+--set /apps/nautilus/preferences/start_with_location_bar false</userinput></screen>
       </sect3>
       <sect3 id="performance-11">
         <title>To Turn Off the Desktop</title>
@@ -432,11 +401,9 @@ The desktop objects are not displayed on the desktop. </para>
           </listitem>
         </itemizedlist>
         <para>To disable the desktop, run the following command: </para>
-        <para>
-          <computeroutput>#</computeroutput>
-          <userinput>gconftool-2 --type bool
---set /apps/nautilus/preferences/show_desktop false</userinput>
-        </para>
+        <screen><userinput>gconftool-2 \
+--type bool \
+--set /apps/nautilus/preferences/show_desktop false</userinput></screen>
       </sect3>
     </sect2>
   </sect1>
@@ -590,21 +557,15 @@ for the GNOME Desktop and for applications.</para>
       <para>Use a solid color for the desktop background. Use of a solid
 color reduces the number of colors used by the GNOME Desktop. </para>
       <para>To set a solid color for the background, run the following commands: </para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type string
---set /desktop/gnome/background/picture_options none</userinput>
-      </para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type string
---set /desktop/gnome/background/color_shading_type solid</userinput>
-      </para>
-      <para>
-        <computeroutput>#</computeroutput>
-        <userinput>gconftool-2 --type string
---set /desktop/gnome/background/primary_color \#<replaceable>hexadecimal-color</replaceable></userinput>
-      </para>
+      <screen><userinput>gconftool-2 \
+--type string \
+--set /desktop/gnome/background/picture_options none</userinput></screen>
+      <screen><userinput>gconftool-2 \
+--type string \
+--set /desktop/gnome/background/color_shading_type solid</userinput></screen>
+      <screen><userinput>gconftool-2 \
+--type string \
+--set /desktop/gnome/background/primary_color #<replaceable>hexadecimal-color</replaceable></userinput></screen>
       <para>Alternatively, users can use the <application>Background</application>
 preference tool to choose a solid color for the background.</para>
     </sect2>