RubyGems - flnews_post_proc - Versions diffs - 1.72 → 1.74 - Mend

flnews_post_proc 1.72 → 1.74

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

checksums.yaml +4 -4
data/README.md +20 -19
data/doc/fr/html/flnews_post_proc.html +104 -85
data/doc/fr/man/flnews_post_proc.1.gz +0 -0
data/doc/fr/pdf/flnews_post_proc.pdf +0 -0
data/doc/fr/rst/flnews_post_proc.rst +94 -89
data/doc/html/flnews_post_proc.html +194 -573
data/doc/man/flnews_post_proc.1.gz +0 -0
data/doc/pdf/flnews_post_proc.pdf +0 -0
data/doc/rst/flnews_post_proc.rst +174 -237
data/lib/basic_logging.rb +1 -1
data/lib/body.rb +2 -2
data/lib/configuration.rb +1 -1
data/lib/flnews_post_proc.conf +3 -3
data/lib/flnews_post_proc.rb +1 -1
data/lib/headers.rb +3 -10
data/lib/newsgroups.rb +38 -19
data/lib/override.rb +1 -1
data/lib/version.rb +3 -3
metadata +6 -5

data/doc/html/flnews_post_proc.html CHANGED Viewed

@@ -4,649 +4,270 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils 0.21.2: https://docutils.sourceforge.io/" />
-<title>Flnews_post_proc</title>
+<title>flnews_post_proc</title>
 <style type="text/css">
 /*
-:Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
-:Copyright: This stylesheet has been placed in the public domain.
+:Author: Michael Uplawski
+:Contact: michael.uplawski@uplawski.eu
+:License: WTFPL 2.0, see http://www.wtfpl.net/about/
-Default cascading style sheet for the HTML output of Docutils.
-Despite the name, some widely supported CSS2 features are used.
-See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
-customize this style sheet.
+Stylesheet for use with Docutils.
 */
-/* used to remove borders from tables and images */
-.borderless, table.borderless td, table.borderless th {
-  border: 0 }
-table.borderless td, table.borderless th {
-  /* Override padding for "table.docutils td" with "! important".
-     The right padding separates the table cells. */
-  padding: 0 0.5em 0 0 ! important }
-.first {
-  /* Override more specific margin styles with "! important". */
-  margin-top: 0 ! important }
-.last, .with-subtitle {
-  margin-bottom: 0 ! important }
-.hidden {
-  display: none }
-.subscript {
-  vertical-align: sub;
-  font-size: smaller }
-.superscript {
-  vertical-align: super;
-  font-size: smaller }
+/* The defaults for docutils */
+@import url(html4css1.css);
-a.toc-backref {
-  text-decoration: none ;
-  color: black }
-blockquote.epigraph {
-  margin: 2em 5em ; }
-dl.docutils dd {
-  margin-bottom: 0.5em }
-object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
-  overflow: hidden;
+body {
+  background-color:#e0f0a0;
+  font-family: Verdana,Helvetica,Univers;
 }
-/* Uncomment (and remove this text!) to get bold-faced definition list terms
-dl.docutils dt {
-  font-weight: bold }
-*/
-div.abstract {
-  margin: 2em 5em }
-div.abstract p.topic-title {
-  font-weight: bold ;
-  text-align: center }
-div.admonition, div.attention, div.caution, div.danger, div.error,
-div.hint, div.important, div.note, div.tip, div.warning {
-  margin: 2em ;
-  border: medium outset ;
-  padding: 1em }
-div.admonition p.admonition-title, div.hint p.admonition-title,
-div.important p.admonition-title, div.note p.admonition-title,
-div.tip p.admonition-title {
-  font-weight: bold ;
-  font-family: sans-serif }
-div.attention p.admonition-title, div.caution p.admonition-title,
-div.danger p.admonition-title, div.error p.admonition-title,
-div.warning p.admonition-title, .code .error {
-  color: red ;
-  font-weight: bold ;
-  font-family: sans-serif }
-/* Uncomment (and remove this text!) to get reduced vertical space in
-   compound paragraphs.
-div.compound .compound-first, div.compound .compound-middle {
-  margin-bottom: 0.5em }
-div.compound .compound-last, div.compound .compound-middle {
-  margin-top: 0.5em }
-*/
-div.dedication {
-  margin: 2em 5em ;
-  text-align: center ;
-  font-style: italic }
-div.dedication p.topic-title {
-  font-weight: bold ;
-  font-style: normal }
-div.figure {
-  margin-left: 2em ;
-  margin-right: 2em }
-div.footer, div.header {
-  clear: both;
-  font-size: smaller }
-div.line-block {
-  display: block ;
-  margin-top: 1em ;
-  margin-bottom: 1em }
-div.line-block div.line-block {
-  margin-top: 0 ;
-  margin-bottom: 0 ;
-  margin-left: 1.5em }
-div.sidebar {
-  margin: 0 0 0.5em 1em ;
-  border: medium outset ;
-  padding: 1em ;
-  background-color: #ffffee ;
-  width: 40% ;
-  float: right ;
-  clear: right }
-div.sidebar p.rubric {
-  font-family: sans-serif ;
-  font-size: medium }
+h1 {color:darkblue;font-size:1.5em;}
+h1.title {color:#a0a0f0;font-size:2em;}
-div.system-messages {
-  margin: 5em }
+p, ul.simple, ol.simple, dt {margin-left:2em;}
+dd {margin-left:4em;}
-div.system-messages h1 {
-  color: red }
+/* correct left margin of nested block tags*/
+dd p, li p {margin-left:0;}
+dd * ul {margin-left:0 ! important; }
+dd ul {margin-left:0 ! important; }
+dd dl dt, dd dl dd {margin-left:0 ! important;}
-div.system-message {
-  border: medium outset ;
-  padding: 1em }
-div.system-message p.system-message-title {
-  color: red ;
-  font-weight: bold }
-div.topic {
-  margin: 2em }
-h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
-h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
-  margin-top: 0.4em }
-h1.title {
-  text-align: center }
-h2.subtitle {
-  text-align: center }
-hr.docutils {
-  width: 75% }
-img.align-left, .figure.align-left, object.align-left, table.align-left {
-  clear: left ;
-  float: left ;
-  margin-right: 1em }
-img.align-right, .figure.align-right, object.align-right, table.align-right {
-  clear: right ;
-  float: right ;
-  margin-left: 1em }
-img.align-center, .figure.align-center, object.align-center {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
-}
-table.align-center {
-  margin-left: auto;
-  margin-right: auto;
+em {color:#000080;
+  background-color:#ffffa0;
 }
-.align-left {
-  text-align: left }
-.align-center {
-  clear: both ;
-  text-align: center }
-.align-right {
-  text-align: right }
-/* reset inner alignment in figures */
-div.align-right {
-  text-align: inherit }
-/* div.align-center * { */
-/*   text-align: left } */
-.align-top    {
-  vertical-align: top }
-.align-middle {
-  vertical-align: middle }
-.align-bottom {
-  vertical-align: bottom }
-ol.simple, ul.simple {
-  margin-bottom: 1em }
-ol.arabic {
-  list-style: decimal }
-ol.loweralpha {
-  list-style: lower-alpha }
-ol.upperalpha {
-  list-style: upper-alpha }
-ol.lowerroman {
-  list-style: lower-roman }
-ol.upperroman {
-  list-style: upper-roman }
-p.attribution {
-  text-align: right ;
-  margin-left: 50% }
-p.caption {
-  font-style: italic }
-p.credits {
-  font-style: italic ;
-  font-size: smaller }
-p.label {
-  white-space: nowrap }
-p.rubric {
-  font-weight: bold ;
-  font-size: larger ;
-  color: maroon ;
-  text-align: center }
-p.sidebar-title {
-  font-family: sans-serif ;
-  font-weight: bold ;
-  font-size: larger }
-p.sidebar-subtitle {
-  font-family: sans-serif ;
-  font-weight: bold }
-p.topic-title {
-  font-weight: bold }
-pre.address {
-  margin-bottom: 0 ;
-  margin-top: 0 ;
-  font: inherit }
-pre.literal-block, pre.doctest-block, pre.math, pre.code {
-  margin-left: 2em ;
-  margin-right: 2em }
-pre.code .ln { color: gray; } /* line numbers */
-pre.code, code { background-color: #eeeeee }
-pre.code .comment, code .comment { color: #5C6576 }
-pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
-pre.code .literal.string, code .literal.string { color: #0C5404 }
-pre.code .name.builtin, code .name.builtin { color: #352B84 }
-pre.code .deleted, code .deleted { background-color: #DEB0A1}
-pre.code .inserted, code .inserted { background-color: #A3D289}
-span.classifier {
-  font-family: sans-serif ;
-  font-style: oblique }
-span.classifier-delimiter {
-  font-family: sans-serif ;
-  font-weight: bold }
-span.interpreted {
-  font-family: sans-serif }
-span.option {
-  white-space: nowrap }
-span.pre {
-  white-space: pre }
-span.problematic, pre.problematic {
-  color: red }
-span.section-subtitle {
-  /* font-size relative to parent (h1..h6 element) */
-  font-size: 80% }
-table.citation {
-  border-left: solid 1px gray;
-  margin-left: 1px }
-table.docinfo {
-  margin: 2em 4em }
-table.docutils {
-  margin-top: 0.5em ;
-  margin-bottom: 0.5em }
-table.footnote {
-  border-left: solid 1px black;
-  margin-left: 1px }
-table.docutils td, table.docutils th,
-table.docinfo td, table.docinfo th {
-  padding-left: 0.5em ;
-  padding-right: 0.5em ;
-  vertical-align: top }
-table.docutils th.field-name, table.docinfo th.docinfo-name {
-  font-weight: bold ;
-  text-align: left ;
-  white-space: nowrap ;
-  padding-left: 0 }
-/* "booktabs" style (no vertical lines) */
-table.docutils.booktabs {
-  border: 0px;
-  border-top: 2px solid;
-  border-bottom: 2px solid;
-  border-collapse: collapse;
-}
-table.docutils.booktabs * {
-  border: 0px;
+blockquote {background-color:#ffc090;
+  padding:0.5em;
+  border-radius:0.5em;
 }
-table.docutils.booktabs th {
-  border-bottom: thin solid;
-  text-align: left;
-}
-h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
-h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
-  font-size: 100% }
-ul.auto-toc {
-  list-style-type: none }
 </style>
 </head>
 <body>
 <div class="document" id="flnews-post-proc">
 <h1 class="title">flnews_post_proc</h1>
-<h2 class="subtitle" id="post-processor-for-the-flnews-newsreader">Post-Processor for the flnews newsreader</h2>
+<h2 class="subtitle" id="post-processor-for-the-flnews-newsreader">Post-Processor for the flnews Newsreader</h2>
 <div class="section" id="synopsis">
 <h1>SYNOPSIS</h1>
-<p>An article is piped-in to the post-processor. This is normally done
-automatically as soon as the variable “post_proc“ in the flnews configuration
-file is set to the flnews_post_proc.</p>
-<p>Locally stored articles can be piped in to the post-processor, as needed
-for testing purposes, with a command-line like the following:</p>
+<p>The post-processor is invoked by piping an article into it. This typically occurs
+automatically when the &quot;post_proc&quot; variable is set to <cite>flnews_post_proc</cite> in the
+flnews configuration file.</p>
+<p>For testing purposes, you can also pipe locally stored articles into the post-processor
+using a command like:</p>
 <p><strong>flnews_post_proc &lt; article</strong></p>
 </div>
 <div class="section" id="description">
 <h1>DESCRIPTION</h1>
-<p>The flnews newsreader is sufficient for Usenet access, i.e. to receive and read
-articles from -, as well as to write and post articles to newsgroups.</p>
-<p>When you compare news-clients, you will always notice the differences and
-choose the software that you prefer. Flnews however, has the charm that you can
-influence how the program itself works but also modify posts that flnews
-produces, just before the program will transmit them to the chosen nntp-server.</p>
-<p>The flnews_post_proc can add and change details of a post, in ways that are
-currently not possible with flnews alone.  As the program is configurable, it
-can probably respond to the needs of some Usenet users. You should, however,
-rather take it as an example for what can be done and an inspiration for your
-own creations.</p>
-<div class="section" id="the-limits-of-a-basic-newsreader-what-the-program-can-do">
-<h2>The limits of a basic newsreader — what the program can do</h2>
-<p>While the articles that flnews creates, are complete and ready to be posted,
-some users may not always agree with the result and for arbitrary reasons:</p>
+<p>The flnews newsreader fully supports Usenet access, enabling the reception and reading
+of articles from newsgroups, as well as composing and posting them.</p>
+<p>When comparing various news clients, differences will often influence your choice of
+preferred client. Flnews distinguishes itself by not only offering control over its
+internal behavior, but also by allowing you to modify outgoing posts just before they
+are sent to the configured NNTP server.</p>
+<p>The <cite>flnews_post_proc</cite> program can be used to modify and enhance a post in ways that
+flnews alone cannot. It is configurable and may meet the needs of some Usenet users,
+though it is primarily intended as a starting point for creating your own custom solutions.</p>
+<div class="section" id="limitations-of-basic-newsreaders">
+<h2>Limitations of Basic Newsreaders</h2>
+<p>While flnews creates posts that are generally complete and ready for submission, there are
+instances where users might find the output unsatisfactory for arbitrary reasons:</p>
 <ul>
-<li><p class="first">There may be inconveniences when you post to different newsgroups in
-different languages, as an introductory line which refers to a previous
-post can only be set once in the flnews-configuration. The consequence
-can be that your post to a french newsgroup begins with an introduction
-in English.
-My post-processor program can set an introductory line specifically
-chosen for one or several newsgroups.</p>
+<li><p class="first">If you're posting to different newsgroups in multiple languages, the introductory line
+referencing a prior post can only be set once in the flnews configuration file. As a
+result, posts to a French newsgroup, for example, may start with an introduction in
+English. The post-processor can address this by setting specific introductory lines
+for each newsgroup.</p>
 </li>
-<li><p class="first">The same conflict arises, when you have set a standard signature-text and
-would like to replace it against another, based on the newsgroup you are
-about to post to.
-The post-processor program sets specific signatures as configured for one
-or several newsgroups. You can even specify that a signature should be
-picked randomly from a file, containing several signatures.</p>
+<li><p class="first">Similar issues arise when you set a standard signature and want it to vary based on
+the newsgroup. The post-processor allows different signatures to be used for different
+newsgroups, and you can even randomize the selection from a list of signatures stored
+in a file.</p>
 </li>
-<li><p class="first">Some custom headers may serve to convey additional information to
-interested readers of your post, like GnuPG key IDs, your language skills
-or the like. The signature may be a better choice than custom headers.
-You are free. I just mention face and x-face but prefer that you do not
-remember I did.
-Custom-headers may be defined in the configuration file for the program
-and will then be added to each outgoing post.</p>
+<li><p class="first">Custom headers, such as GnuPG key IDs or your language proficiency, can also be added
+to posts, though signatures may be a better alternative. Custom headers can be defined
+in the configuration file and will be added to outgoing posts.</p>
 </li>
-<li><p class="first">The Archive- and the X-No-Archive header are sometimes set to avoid that an
-article be saved and stays available to search-engines (Google, notably).
-Test- postings, for example, do probably not justify at all that they would
-be referenced in search-results.
-The post-processor program can impose both headers for all posts to certain
-newsgroups.</p>
-<p><strong>ATTN</strong> As of 2024, the header “X-No-Archive“ has lost most of its utility
-and it is the decision of server operators to honor it or not.</p>
+<li><p class="first">Headers like &quot;Archive&quot; and &quot;X-No-Archive&quot; are sometimes set to prevent an article from
+being indexed by search engines (e.g., Google). For example, test posts likely don't need
+to be included in search results. The post-processor can apply both headers to all posts
+sent to certain newsgroups.</p>
+<p><strong>NOTE</strong>: As of 2024, the &quot;X-No-Archive&quot; header has limited effectiveness, and it is
+up to server operators whether or not to honor it.</p>
 </li>
-<li><p class="first">If a news post contains many references to either other posts or Web
-pages, the text can be cluttered with URLs.
-The post-processor can identify marked text fragments and transform them
-into footnotes, which will be attached as a list at the bottom of the
-post.
-This works almost like the &lt;ref/&gt; link in Wikipedia, but the delimiter
-can be determined in the configuration file.
-Example (with %=):
-This is an object %=and this becomes the footnote, describing the object
-further=%</p>
+<li><p class="first">Posts that include many references to other posts or URLs can become cluttered. The
+post-processor can convert marked text into footnotes, similar to the &lt;ref/&gt; link format
+used in Wikipedia, with the delimiter configurable in the configuration file.
+Example (using %=):
+&quot;This is an object %=and this becomes the footnote, describing the object further=%&quot;</p>
 </li>
 </ul>
 </div>
-<div class="section" id="dialog-to-override-settings">
-<h2>Dialog to override settings</h2>
-<p>ATTN! As of version 1.72, YAD or Zenity cannot be used for the dialog.</p>
-<p>You can have a dialog displayed just before the post-processor is invoked, to
-<strong>disable</strong> some configuration options. Provided that Whiptail or only xterm
-are available on your computer, you can choose from the following options. You
-<strong>cannot</strong> use the dialog to enable options which have not yet been set in the
-configuration.</p>
+<div class="section" id="dialog-for-overriding-settings">
+<h2>Dialog for Overriding Settings</h2>
+<p><strong>IMPORTANT</strong>: As of version 1.72, YAD or Zenity cannot be used for the dialog interface.</p>
+<p>Before the post-processor runs, a dialog can be displayed to allow users to <strong>disable</strong>
+certain configuration options. If Whiptail or xterm are available, you can choose to
+disable the following options. You <strong>cannot</strong> enable options that haven't already been set
+in the configuration.</p>
 <ul class="simple">
-<li>Signatures, as set in the configuration <strong>can be ignored</strong>. Either
-a default signature will appear as set in flnews or none.</li>
-<li>Custom Headers, if configured, can be <strong>omitted</strong>.</li>
-<li>The Archive- and X-No-Archive headers, if set for the current newsgroup,
-<strong>can be ignored</strong>.</li>
-<li>Logging can be <strong>switched off</strong>, if set.</li>
+<li>Signatures (if set in the configuration) can be <strong>ignored</strong>. A default signature will
+be used, or no signature at all.</li>
+<li>Custom headers can be <strong>omitted</strong>.</li>
+<li>The &quot;Archive&quot; and &quot;X-No-Archive&quot; headers can be <strong>ignored</strong> if set for the current
+newsgroup.</li>
+<li>Logging can be <strong>disabled</strong>, if enabled.</li>
 </ul>
-<p>Pushing Esc or the cancle-button of the dialog interrupts the process, flnews
+<p>Pressing Esc or the Cancel button on the dialog will interrupt the process, and flnews
 will not post the article.</p>
-<p>You can disable the dialog, which ensures that all configured options will be
-applied, without the need for further interaction (see below, option
-OVERRIDE_CONFIG).</p>
+<p>To disable the dialog entirely (and apply all configured options without further interaction),
+set the <strong>OVERRIDE_CONFIG</strong> option.</p>
 </div>
 </div>
 <div class="section" id="configuration">
 <h1>CONFIGURATION</h1>
-<p>On first execution of the program, a copy of the original configuration file is
-created in <em>/home/[user]/.flnews_post_proc.conf</em>
-It is this file which is used from then on. If you delete it, it will be
-recreated, on the next occasion, but your own changes will be lost.</p>
-<p>The configuration file is in YAML syntax and full of explanations. The
-variables defined in this file can be classified as belonging to one of two
-categories:</p>
-<ul class="simple">
-<li>Variables describing values originally set by flnews, which should be used or
-replaced. The important elements are usually matched in a capture group.</li>
-<li>Variables defining the new or altered content.</li>
-</ul>
-<dl class="docutils">
-<dt><strong>FUP_NAME</strong></dt>
-<dd><p class="first">A Regular Expression, describing the string which contains the name of
-previous poster who is the author of a quoted post.  This string is
-recognized in the original article and may be used with the fitting element
-from <em>GROUP_INTRO</em>, below. The Regexp-format is that of the Regexp class in
-Ruby, noted as a String. Beware to mask a backslash '\' by another one,
-like in the example. A capture-group '()' serves to extract the name from the
-match result.</p>
-<p>Leave this field empty to keep the default from the FLNews configuration
-intact.</p>
-<p>CONTENT: A String equivalent of a regular expression.</p>
+<p>Upon first execution of the program, a copy of the original configuration file is created
+in <em>/home/[user]/.flnews_post_proc.conf</em>. This file is used thereafter. Deleting it will
+cause the file to be recreated, but any custom changes will be lost.</p>
+<p>The configuration file uses YAML syntax and includes detailed explanations. The variables
+within it fall into two categories:</p>
+<ol class="arabic simple">
+<li>Variables that represent values originally set by flnews, which can be used or replaced.
+These elements are typically captured using regular expressions.</li>
+<li>Variables that define new or modified content.</li>
+</ol>
+<div class="section" id="example-configuration-variables">
+<h2>Example Configuration Variables</h2>
+<p><strong>FUP_NAME</strong>
+A regular expression that matches the name of the previous poster in a quoted post. This
+string is recognized in the original article and used with the matching element from
+<em>GROUP_INTRO</em>.</p>
+<p>Leave this field empty to retain the default value from the FLNews configuration.</p>
+<p>CONTENT: A string representing a regular expression.</p>
 <p>DEFAULT: EMPTY</p>
 <p>EXAMPLE1: &quot;On \\d+.\\d+.\\d{2,4} at \\d+:\\d+ <strong>(.*)</strong> wrote:&quot;</p>
-<p class="last">EXAMPLE2: &quot;<strong>(.*)</strong> wrote:&quot;</p>
-</dd>
-<dt><strong>FUP_GROUP</strong></dt>
-<dd><p class="first">A Regular Expression, describing the string which contains the newsgroup
-where the previous post, that you are referring to in the followup, had been
-published.</p>
-<p>Leave this field empty to ignore the precise group.</p>
-<p>CONTENT: A String equivalent of a regular expression.</p>
+<p>EXAMPLE2: &quot;<strong>(.*)</strong> wrote:&quot;</p>
+<p><strong>FUP_GROUP</strong>
+A regular expression that matches the newsgroup where the quoted post was published.</p>
+<p>Leave this field empty to ignore the exact group.</p>
+<p>CONTENT: A string representing a regular expression.</p>
 <p>DEFAULT: EMPTY</p>
-<p class="last">EXAMPLE: &quot;wrote in <strong>(.*)</strong>:&quot;</p>
-</dd>
-<dt><strong>GROUP_INTROS</strong></dt>
-<dd><p class="first">Introductory strings, referring to the previous poster who is the author of a
-quoted post. If you match the newsgroup of the post (see FUP_GROUP), you can
-use these variables in the result.
-Currently only %fup_name% and %fup_group% are reproduced in the resulting
-introductory string.</p>
-<p>CONTENT: A newsgroup or regexp per line, followed by a colon, a space and a String</p>
-<p>DEFAULT: As configured in FLNews</p>
-<p class="last">EXAMPLE: alt.test: &quot;Thus spoke %fup_name% on that baleful %fup_date%:&quot;</p>
-</dd>
-<dt><strong>GROUP_SIGS</strong></dt>
-<dd><p class="first">A signature line per Newsgroup or a file path. The file should contain signatures,
-already formatted and separated by 1 empty line. The program will randomly pick
-one signature from the list.</p>
-<p>ATTN! In multi line signatures, you have to use \r\n for line breaks.</p>
-<p>CONTENT: A newsgroup or regexp per line, followed by a colon, a space and a String.</p>
-<p>DEFAULT: As configured in flnews</p>
-<p>EXAMPLE: alt.test: &quot;Signature for alt.test\r\nsecond line&quot;</p>
-<p class="last">EXAMPLE: comp.*: /home/[user]/.my_sigs</p>
-</dd>
-<dt><strong>CUSTOM_HEADERS</strong></dt>
-<dd><p class="first">Additional headers for the outgoing article</p>
-<p>CONTENT: 1 line per header : a dash and space, then a String, comprising the
-name of the header, ending in a colon and the value of the header.</p>
-<p>DEFAULT: undefined</p>
-<div class="last line-block">
-<div class="line">EXAMPLE (2 headers):</div>
-<div class="line">- 'X-My-Header: nothing fancy'</div>
-<div class="line">- 'X-Another-Header: care not!'</div>
-</div>
-</dd>
-<dt><strong>NO_ARCHIVE_GROUPS</strong></dt>
-<dd><p class="first">The newsgroups, where the headers “Archive: no” and “X-No-Archive: YES” shall
-be set.</p>
-<p>CONTENT: a dash and space, then a String, containing the name of the group or a regexp.</p>
-<p>DEFAULT: empty</p>
-<div class="last line-block">
-<div class="line">EXAMPLE (1 group, 1 hierarchy):</div>
-<div class="line">- &quot;alt.test&quot;</div>
-<div class="line">- &quot;^news.*&quot;</div>
-</div>
-</dd>
-<dt><strong>DEBUG_LOG</strong></dt>
-<dd><p class="first">The name of a file, where debug messages are written. Setting this
-variable will enable the log. Leave empty to disable logging.</p>
-<p>CONTENT: The name of a writable file, which will be created if inexistent
-and overwritten if need be.</p>
-<p>DEFAULT: empty</p>
-<p class="last">EXAMPLE: '/tmp/a_log-file.txt'</p>
-</dd>
-<dt><strong>LOG LEVEL</strong></dt>
-<dd>One of debug, fatal, error, info, warn</dd>
-<dt><strong>REFERENCES_SEPARATOR</strong></dt>
-<dd><p class="first">A symbol or sequence of symbols marking the end of the message-body and the
-beginning of a list of “references” or “footnotes”. It will only appear, if
-the original message-body contains text marked for use as such a footnote.
-See <em>REFERENCES_DELIMITER</em>.</p>
-<p>If the option is not defined or empty, the list of footnotes will appear
-below the last line of the message body and no separator will be inserted.</p>
-<p>CONTENT: A quoted symbol or sequence of symbols.</p>
-<p>DEFAULT: empty</p>
-<p class="last">EXAMPLE: '---------'</p>
-</dd>
-<dt><strong>REFERENCES_DELIMITER</strong></dt>
-<dd><p class="first">A sequence of at least two symbols marking the beginning of a text which will
-serve as footnote (or reference). The <strong>reversed sequence</strong> musst be used to
-mark the end of the text. The presence of this sequence or symbol in the
-original message body will cause the enclosed text to be moved below the
-message body.  The <em>REFERENCES_SEPARATOR</em>, if defined, will separate the
-message from the list of footnotes.
-If this option is not defined or empty, footnotes are not created.</p>
-<p>CONTENT a quoted symbol or sequence of symbols.</p>
-<p>DEFAULT: none/empty</p>
-<p class="last">EXAMPLE: '%?'</p>
+<p>EXAMPLE: &quot;wrote in <strong>(.*)</strong>:&quot;</p>
+<p><strong>GROUP_INTROS</strong>
+Introductory strings referring to the previous poster in a quoted post. When the newsgroup
+matches <em>FUP_GROUP</em>, these variables are used in the resulting introduction.</p>
+<p>CONTENT: A newsgroup or regular expression per line, followed by a colon, space, and string.</p>
+<p>DEFAULT: As configured in FLNews.</p>
+<p>EXAMPLE: alt.test: &quot;Thus spoke %fup_name% on that baleful %fup_date%:&quot;</p>
+<p><strong>GROUP_SIGS</strong>
+Signature lines for each newsgroup or a path to a file containing signatures, which should be
+formatted and separated by one empty line. A random signature is picked from the file for each
+newsgroup. You can also source another file within the signature file by starting a line with
+&quot;. /path/to/other/file&quot;.</p>
+<p>CONTENT: A newsgroup or regular expression per line, followed by a colon, space, and string.</p>
+<p>DEFAULT: As configured in flnews.</p>
+<p>EXAMPLE: alt.test: &quot;Signature for alt.test\r\nsecond line&quot;
+EXAMPLE: comp.*: /home/[user]/.my_sigs</p>
+<p><strong>CUSTOM_HEADERS</strong>
+Additional custom headers to be added to outgoing articles.</p>
+<p>CONTENT: One line per header, starting with a dash and space, followed by the header name and value.</p>
+<p>DEFAULT: Undefined</p>
+<dl class="docutils">
+<dt>EXAMPLE:</dt>
+<dd><ul class="first last simple">
+<li>'X-My-Header: nothing fancy'</li>
+<li>'X-Another-Header: care not!'</li>
+</ul>
 </dd>
-<dt><strong>REFERENCE_FORMAT</strong></dt>
-<dd><p class="first">A format-string, using %s for a number, replacing the reference-
-text in the message body.</p>
-<p>DEFAULT: &quot; %s)&quot;  -&gt; becomes 1) ... 2)  ... 3)</p>
-<p class="last">EXAMPLE: &quot;(%s)&quot;  -&gt; becomes (1) ... (2)  ... (3)</p>
+</dl>
+<p><strong>NO_ARCHIVE_GROUPS</strong>
+Newsgroups where the &quot;Archive: no&quot; and &quot;X-No-Archive: YES&quot; headers should be set.</p>
+<p>CONTENT: A line with a dash and space, followed by the group name or a regular expression.</p>
+<p>DEFAULT: Empty</p>
+<dl class="docutils">
+<dt>EXAMPLE:</dt>
+<dd><ul class="first last simple">
+<li>&quot;alt.test&quot;</li>
+<li>&quot;^news.*&quot;</li>
+</ul>
 </dd>
-<dt><strong>VFY_URLS</strong></dt>
-<dd><p class="first">A Boolean constant. It determines if the program shall verify and possibly
-try to correct URLs. Even if URLs are identified as such, only a few
-manipulations are attempted :
-* Angular brackets '&lt;' and '&gt;' are added, if missing
-* Slashes are added, if they are found missing after &quot;http(s):&quot;</p>
-<p>If the variable is not set, a value 'yes' is assumed.</p>
-<p>CONTENT: One of YES, yes, NO, no, and other variations of case.</p>
+</dl>
+<p><strong>DEBUG_LOG</strong>
+The name of the file where debug messages are logged. If specified, logging will be enabled.
+If empty, logging is disabled.</p>
+<p>CONTENT: The name of a writable file, which will be created if it doesn't exist and overwritten if necessary.</p>
+<p>DEFAULT: Empty</p>
+<p>EXAMPLE: '/tmp/a_log-file.txt'</p>
+<p><strong>LOG LEVEL</strong>
+One of: debug, fatal, error, info, warn.</p>
+<p><strong>REFERENCES_SEPARATOR</strong>
+A symbol or sequence marking the end of the message body and the beginning of a footnote list.
+If not defined, footnotes are appended directly after the message body.</p>
+<p>CONTENT: A quoted symbol or sequence.</p>
+<p>DEFAULT: Empty</p>
+<p>EXAMPLE: '---------'</p>
+<p><strong>REFERENCES_DELIMITER</strong>
+A sequence marking the beginning and end of text to be used as a footnote or reference. The reversed
+sequence is used to mark the end.</p>
+<p>CONTENT: A quoted symbol or sequence.</p>
+<p>DEFAULT: None (empty)</p>
+<p>EXAMPLE: '%?'</p>
+<p><strong>REFERENCE_FORMAT</strong>
+A format string using <cite>%s</cite> for a number to replace the reference text in the body.</p>
+<p>DEFAULT: &quot; %s)&quot; → becomes 1) ... 2) ... 3)</p>
+<p>EXAMPLE: &quot;(%s)&quot; → becomes (1) ... (2) ... (3)</p>
+<p><strong>VFY_URLS</strong>
+A boolean constant determining whether URLs should be verified and corrected if necessary.
+URL manipulations include adding angular brackets ('&lt;', '&gt;') and slashes after &quot;http(s):&quot;.</p>
+<p>CONTENT: One of YES, yes, NO, no (case insensitive).</p>
 <p>DEFAULT: yes</p>
-<p class="last">Example: ... I let you guess.</p>
-</dd>
-<dt><strong>OVERRIDE_CONFIG</strong></dt>
-<dd><p class="first">A Boolean constant. You can choose to override the following configuration
-options before an article is posted: GROUP_SIGS, XNAY_GROUPS, CUSTOM_HEADERS,
-DEBUG_LOG and VFY_URLS.  A dialog may be displayed which allows you to disable
-any of these five options, so that the defaults from flnews prevail.</p>
-<p>ATTN! Canceling the dialog or pushing the Esc-key does interrupt the process.
-Flnews will not post the article.</p>
-<p>Set this option to no, NO or similar to disable the dialog.</p>
+<p>EXAMPLE: ... I leave this to your discretion.</p>
+<p><strong>OVERRIDE_CONFIG</strong>
+A boolean constant that controls whether configuration options can be overridden before posting.</p>
+<p>Set this to &quot;no&quot; to disable the dialog.</p>
 <p>DEFAULT: yes</p>
-<p class="last">EXAMPLE: No</p>
-</dd>
-</dl>
+<p>EXAMPLE: No</p>
+</div>
 </div>
 <div class="section" id="other-information">
 <h1>Other Information</h1>
 <div class="section" id="testing">
 <h2>Testing</h2>
-<p>The effects that the execution of the program will have on a posting can be
-verified in two ways:</p>
+<p>You can verify the post-processor’s effect by using one of two methods:</p>
 <ol class="arabic">
-<li><p class="first">By piping-in a post that had previously been saved to a file:</p>
+<li><p class="first">Pipe a saved post into the program:</p>
 <p><strong>:~$ /usr/local/bin/[post-processor] &lt; [test-article]</strong></p>
-<p>This will show the resulting new version of the article on screen, but you
-can also pipe the output into another file. This is a great way to test a
-program during development or to test your own configuration of the program.</p>
+<p>This will show the modified article, and you can pipe it into another file for further testing.</p>
 </li>
-<li><p class="first">By posting directly into a test-newsgroup (like alt.test or similar).  This
-is mandatory before you really post to thematic newsgroups and when the
-settings of the post-processor will affect the article.</p>
+<li><p class="first">Post directly to a test newsgroup (e.g., alt.test). This is essential before posting to
+real newsgroups, especially when the post-processor will alter the article.</p>
 </li>
 </ol>
 </div>
 <div class="section" id="source-code">
-<h2>Source-Code</h2>
-<p>The gem-file that you get with the gem-utility or from rubygems.org contains
-all the code of the program and some documentation (this page notably). To read
-its content, you must</p>
+<h2>Source Code</h2>
+<p>The gem file for the program, available via the gem utility or rubygems.org, contains all
+the source code and documentation (this page included). To extract it, do the following:</p>
 <ol class="arabic simple">
-<li>untar the gem-file with tar -xf flnews_post_proc-0.1.gem</li>
-<li>uncompress the data.gz archive: gunzip data.gz</li>
-<li>untar the resultig data.tar archive: tar -xf data.tar</li>
+<li>Extract the gem file: <cite>tar -xf flnews_post_proc-0.1.gem</cite></li>
+<li>Uncompress the data archive: <cite>gunzip data.gz</cite></li>
+<li>Extract the data archive: <cite>tar -xf data.tar</cite></li>
 </ol>
-<p>This creates the directories bin, doc and lib.</p>
+<p>This will create the directories <cite>bin</cite>, <cite>doc</cite>, and <cite>lib</cite>.</p>
 </div>
 <div class="section" id="license">
 <h2>License</h2>
-<p>flnews_post_proc is distributed under the conditions of the WTFPL-2.0 or later
-License (see <a class="reference external" href="http://www.wtfpl.net/txt/copying/">http://www.wtfpl.net/txt/copying/</a> or license-text in the doc
-directory of the gem-file).</p>
+<p>The flnews_post_proc is distributed under the WTFPL-2.0 or later License.
+For more details, visit <a class="reference external" href="http://www.wtfpl.net/txt/copying/">http://www.wtfpl.net/txt/copying/</a> or refer to the license file in the
+documentation directory of the gem.</p>
 </div>
 <div class="section" id="author">
 <h2>Author</h2>
-<div class="line-block">
-<div class="line">flnews_post_proc has been developed by</div>
-<div class="line">Michael Uplawski &lt;<a class="reference external" href="mailto:michael.uplawski&#64;uplawski.eu">michael.uplawski&#64;uplawski.eu</a>&gt;</div>
-</div>
+<p>flnews_post_proc has been developed by
+Michael Uplawski &lt;<a class="reference external" href="mailto:michael.uplawski&#64;uplawski.eu">michael.uplawski&#64;uplawski.eu</a>&gt;</p>
 </div>
 </div>
 <div class="section" id="section-1">