Просмотр исходного кода

* Documentation has been cleaned up for typos/spelling errors.

Morten Brix Pedersen 22 лет назад
Родитель
Сommit
e8b9aa52ef
2 измененных файлов с 37 добавлено и 34 удалено
  1. 1 0
      docs/Changelog
  2. 36 34
      docs/pisg-doc.xml

+ 1 - 0
docs/Changelog

@@ -2,6 +2,7 @@ pisg (x.xx)
    * Added new option, ShowFoulDecimals which configures the number of
    * Added new option, ShowFoulDecimals which configures the number of
    decimals used in statistics in foul numbers. (thanks, Thorbjörn Svensson)
    decimals used in statistics in foul numbers. (thanks, Thorbjörn Svensson)
    * HTML documentation now has sane filenames.
    * HTML documentation now has sane filenames.
+   * Documentation has been cleaned up for typos/spelling errors.
 
 
 pisg (0.57) - Sat Aug, 28th 2004
 pisg (0.57) - Sat Aug, 28th 2004
    Changes by Christoph Berg:
    Changes by Christoph Berg:

+ 36 - 34
docs/pisg-doc.xml

@@ -36,7 +36,7 @@
      <listitem>
      <listitem>
        <para>
        <para>
         You run pisg, pisg runs the log through and create statistics, it
         You run pisg, pisg runs the log through and create statistics, it
-        then creates an HTML page which you can upload to a server.
+        then creates an HTML page which you can upload to a webserver.
        </para>
        </para>
       </listitem>
       </listitem>
     </itemizedlist>
     </itemizedlist>
@@ -56,7 +56,7 @@
       </listitem>
       </listitem>
      <listitem>
      <listitem>
        <para>
        <para>
-        Any operating system which Perl runs on, this includes popular OS'es
+        Any operating system which Perl runs on, this includes popular OSes
         such as Linux, FreeBSD, Windows and Mac. You will have a hard time
         such as Linux, FreeBSD, Windows and Mac. You will have a hard time
         finding an OS where Perl isn't supported. For Windows this means
         finding an OS where Perl isn't supported. For Windows this means
         that you need to download <ulink
         that you need to download <ulink
@@ -94,7 +94,7 @@
 
 
    <para>
    <para>
    An element called <command>channel</command> is made for defining
    An element called <command>channel</command> is made for defining
-   channels, a quick example of a channel is this:
+   channels, a quick example of a channel is here:
 
 
    <programlisting>
    <programlisting>
    <![CDATA[
    <![CDATA[
@@ -122,7 +122,7 @@
    <para>
    <para>
    Also be-aware of the fact that pisg uses various images to show the
    Also be-aware of the fact that pisg uses various images to show the
    time-related bars. These images are placed in the
    time-related bars. These images are placed in the
-   <filename>gfx/</filename> folder and should be putted into the same
+   <filename>gfx/</filename> folder and should be placed into the same
    directory as your outputted HTML file.
    directory as your outputted HTML file.
    </para>
    </para>
 
 
@@ -159,7 +159,8 @@
     </programlisting>
     </programlisting>
 
 
     You can include * or ? to enable filename globbing to randomly choose one
     You can include * or ? to enable filename globbing to randomly choose one
-    from several pictures: (see <command>ImageGlobPath</command> below)
+    from several pictures: (see documentation for the
+    <command>ImageGlobPath</command> option)
     <programlisting>
     <programlisting>
     <![CDATA[<user nick="Ben" pic="ben_*.jpg">]]>
     <![CDATA[<user nick="Ben" pic="ben_*.jpg">]]>
     </programlisting>
     </programlisting>
@@ -277,7 +278,7 @@
     </para>
     </para>
 
 
     <para>
     <para>
-    There are a few predefined colorschemes for you to use, use the
+    There are a few predefined color schemes for you to use, use the
     ColorScheme option when using them. The available colorschemes are:
     ColorScheme option when using them. The available colorschemes are:
     'default', 'darkgalaxy', 'ocean', 'darkred'.
     'default', 'darkgalaxy', 'ocean', 'darkred'.
     </para>
     </para>
@@ -544,7 +545,7 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    <command>OutputTag</command>specifies a string that will replace
+    <command>OutputTag</command> specifies a string that will replace
     occurrences of "%t" in <command>OutputFile</command>. This option is most
     occurrences of "%t" in <command>OutputFile</command>. This option is most
     useful when used as a command line switch (-t) to pisg in conjunction with
     useful when used as a command line switch (-t) to pisg in conjunction with
     <command>NFiles</command> (-nf). Example:
     <command>NFiles</command> (-nf). Example:
@@ -670,7 +671,7 @@
     process at most that much files from <command>LogDir</command>. Useful to
     process at most that much files from <command>LogDir</command>. Useful to
     create statistics that cover the last week or month. Note that if multiple
     create statistics that cover the last week or month. Note that if multiple
     <command>LogDir</command> options are provided, <command>NFiles</command>
     <command>LogDir</command> options are provided, <command>NFiles</command>
-    referrs to the number of files which will be processed from each
+    refers to the number of files which will be processed from each
     <command>LogDir</command>
     <command>LogDir</command>
     </para>
     </para>
     </refsect1>
     </refsect1>
@@ -706,7 +707,7 @@
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
     <command>Maintainer</command> is used to define the name of the
     <command>Maintainer</command> is used to define the name of the
-    maintaner of the statistics page, this can be either the person
+    maintainer of the statistics page, this can be either the person
     generating the stats or the bot/client doing the logging.
     generating the stats or the bot/client doing the logging.
     The maintainer is displayed in the outputted stats page.
     The maintainer is displayed in the outputted stats page.
     </para>
     </para>
@@ -724,7 +725,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>ColorScheme</refname>
     <refname>ColorScheme</refname>
-    <refpurpose>use a different colorscheme for stats page</refpurpose>
+    <refpurpose>use a different color scheme for stats page</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -742,10 +743,10 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    <command>ColorScheme</command> is used to define the colorscheme used
+    <command>ColorScheme</command> is used to define the color scheme used
     for the statistics page. Actually it's the CSS file being included.
     for the statistics page. Actually it's the CSS file being included.
     Available options are: default, darkgalaxy, darkred, justgrey, ocean,
     Available options are: default, darkgalaxy, darkred, justgrey, ocean,
-    softgreen.
+    softgreen, orange_grey.
     </para>
     </para>
     </refsect1>
     </refsect1>
     <refsect1>
     <refsect1>
@@ -880,7 +881,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>LogPrefix</refname>
     <refname>LogPrefix</refname>
-    <refpurpose>only parse logs LogPrefixed with a userdefined string</refpurpose>
+    <refpurpose>only parse logs LogPrefixed with a user defined string</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -959,7 +960,7 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    This option is useful mainly from commandline when invoking pisg with
+    This option is useful mainly from command line when invoking pisg with
     <command>--silent 1</command>. But it can also used in the configuration
     <command>--silent 1</command>. But it can also used in the configuration
     file. It will suppress all standard output from pisg. Error messages
     file. It will suppress all standard output from pisg. Error messages
     will still be sent.
     will still be sent.
@@ -1105,7 +1106,7 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    With this option you can enable the "words per line" coloumn in the
+    With this option you can enable the "words per line" column in the
     "Most Active Nicks" section. It will add a column describing the average
     "Most Active Nicks" section. It will add a column describing the average
     words per line for a person.
     words per line for a person.
     </para>
     </para>
@@ -1141,7 +1142,7 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    With this option you can enable the "characters per line" coloumn in the
+    With this option you can enable the "characters per line" column in the
     "Most Active Nicks" section. It will add a column describing the average
     "Most Active Nicks" section. It will add a column describing the average
     number of characters per line for a person.
     number of characters per line for a person.
     </para>
     </para>
@@ -1214,7 +1215,7 @@
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
     With this option enabled, a column will be added to the "Most Active
     With this option enabled, a column will be added to the "Most Active
-    Nicks" section to display when a user was last seen. Eg. "2 days ago".
+    Nicks" section to display when a user was last seen. E.g. "2 days ago".
     </para>
     </para>
     </refsect1>
     </refsect1>
     <refsect1>
     <refsect1>
@@ -1606,7 +1607,7 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    By default, pisg shows example violentlines in the "Most aggresive"
+    By default, pisg shows example violentlines in the "Most aggressive"
     and "Most attacked"-stats.  With this option it can be disabled.
     and "Most attacked"-stats.  With this option it can be disabled.
     </para>
     </para>
     </refsect1>
     </refsect1>
@@ -1748,7 +1749,7 @@
     <para>
     <para>
     By default, pisg has op statistics in the "Most interesting numbers"
     By default, pisg has op statistics in the "Most interesting numbers"
     section. Here you can disable the feature, it's useful if you don't feel
     section. Here you can disable the feature, it's useful if you don't feel
-    that the information is of any value, or your logformat doesn't support
+    that the information is of any value, or your log format doesn't support
     ops/deops.
     ops/deops.
     </para>
     </para>
     </refsect1>
     </refsect1>
@@ -2129,7 +2130,7 @@
     The random quotes displayed in the "Most Active Nicks" section has a
     The random quotes displayed in the "Most Active Nicks" section has a
     certain range specified. With this option you can change the minimum
     certain range specified. With this option you can change the minimum
     number of letters required for a random quote. Also see the
     number of letters required for a random quote. Also see the
-    <command>maxquote</command> option.
+    <command>MaxQuote</command> option.
     </para>
     </para>
     </refsect1>
     </refsect1>
     <refsect1>
     <refsect1>
@@ -2166,7 +2167,7 @@
     The random quotes displayed in the "Most Active Nicks" section has a
     The random quotes displayed in the "Most Active Nicks" section has a
     certain range specified. With this option you can change the maximum
     certain range specified. With this option you can change the maximum
     number of letters required for a random quote. Also see the
     number of letters required for a random quote. Also see the
-    <command>minquote</command> option.
+    <command>MinQuote</command> option.
     </para>
     </para>
     </refsect1>
     </refsect1>
     <refsect1>
     <refsect1>
@@ -2218,7 +2219,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>QuoteWidth</refname>
     <refname>QuoteWidth</refname>
-    <refpurpose>Maximum allowed length of a "word" with no spaces</refpurpose>
+    <refpurpose>maximum allowed length of a "word" with no spaces</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -2236,7 +2237,7 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    Pisg will automaticaly insert a space in words that have a length
+    Pisg will automatically insert a space in words that have a length
     over the amount quotewidth is set to.  When used in breaking up
     over the amount quotewidth is set to.  When used in breaking up
     URL's it will insert a space in the displayed URL, but not in the
     URL's it will insert a space in the displayed URL, but not in the
     actual URL referenced by the HREF.
     actual URL referenced by the HREF.
@@ -2606,7 +2607,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>NickTracking</refname>
     <refname>NickTracking</refname>
-    <refpurpose>track nickchanges and create aliases</refpurpose>
+    <refpurpose>track nick changes and create aliases</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -2635,7 +2636,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>SortByWords</refname>
     <refname>SortByWords</refname>
-    <refpurpose>Sort "most active nicks" by words</refpurpose>
+    <refpurpose>sort "most active nicks" by words</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -2934,7 +2935,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>Charset</refname>
     <refname>Charset</refname>
-    <refpurpose>Charset to use for stats page</refpurpose>
+    <refpurpose>character set to use for stats page</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -2952,12 +2953,13 @@
     <refsect1>
     <refsect1>
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
-    The pisg stats page defines a charset in a meta tag, this can be used if
-    your country is using a different one than the default. Pisg will also use
-    this setting to convert the language templates from
+    The pisg stats page defines a character set in a meta tag, this can be
+    used if your country is using a different one than the default. Pisg
+    will also use this setting to convert the language templates from
     <command>LangFile</command> if the language defines a source charset.
     <command>LangFile</command> if the language defines a source charset.
-    Note: you also have to tell your webserver to transmit the charset to the
-    browser. With Apache, use "AddDefaultCharset off" in the server config.
+    Note: you also have to tell your webserver to transmit the charset to
+    the browser. With Apache, use "AddDefaultCharset off" in the server
+    config.
     </para>
     </para>
     </refsect1>
     </refsect1>
     <refsect1>
     <refsect1>
@@ -2973,7 +2975,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>LogCharset</refname>
     <refname>LogCharset</refname>
-    <refpurpose>charset for logfiles</refpurpose>
+    <refpurpose>character set for logfiles</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -3011,7 +3013,7 @@
 
 
     <refnamediv>
     <refnamediv>
     <refname>LogCharsetFallback</refname>
     <refname>LogCharsetFallback</refname>
-    <refpurpose>fallback charset for logfiles</refpurpose>
+    <refpurpose>fallback character set for logfiles</refpurpose>
     </refnamediv>
     </refnamediv>
 
 
     <refsynopsisdiv><programlisting>
     <refsynopsisdiv><programlisting>
@@ -3171,7 +3173,7 @@
     <title>Description</title>
     <title>Description</title>
     <para>
     <para>
     <command>CssDir</command> is used to define the paths to the CSS files
     <command>CssDir</command> is used to define the paths to the CSS files
-    (the colorschemes). Usually you don't need to change this.
+    (the color schemes). Usually you don't need to change this.
     </para>
     </para>
     </refsect1>
     </refsect1>
     <refsect1>
     <refsect1>