flnews_post_proc 1.93 → 1.94

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e6e9b868f3b13e1037ebf89c7b2d9245358bda76b115831d63b5a137af5b090
-  data.tar.gz: 01d2e7e729338b1ac18c47050e16756ff9a13e0190333a4308c7106674125c1c
+  metadata.gz: 56252ac144947269f2c3da32cd3515c156e2291035ddbb3e5639833e82db2b8e
+  data.tar.gz: f496b15533d85ef6193555c2fc0fae8a9ddc0fcd84cc74fd929db71228d74c2c
 SHA512:
-  metadata.gz: 825ef12b6621d7e41d2dc39999d244a1af4d8c1a9ab80fa330b04b85c26b4acf3a5413b9172c2547d67c5899aa694b4f20247d95ba07cd92081aa54c471a961f
-  data.tar.gz: 2e207259576e65bb114caecd37fede29a73775c13fb0059acdfdbeb1aaafa2ed2b8141c968463137ed412cb25e74d6ee53d8a22b389261e613983ea33480f485
+  metadata.gz: c04cae0d061deedadfa4fbd08adf9ef2bedecaa68e0f2c2bed977c99eea2967aa463c653419a68fc124ee6ef147a9f1b6e152c5ef146be7beeb7f758721cccdd
+  data.tar.gz: 0fc009b0228e5c9e8370f7eb2105acc2dd02857319d47905ec44872df015eed20e4ebb6a0c1b80e423515c4aa81c97c5113c2bb6eb94c5a388102976a25b767e

data/doc/fr/html/flnews_post_proc.html

@@ -104,7 +104,7 @@
         </li>
 
         <li>
-          <p><a class="reference internal" href="#configuration"
+          <p><a class="reference internal" href="#configuration-1"
           id="toc-entry-5">CONFIGURATION</a>
           </p>
 
@@ -125,34 +125,41 @@
           </p>
 
           <ul>
+            <li>
+              <p><a class="reference internal" href=
+              "#creation-des-notes-de-bas-de-page-1" id=
+              "toc-entry-8">Création des notes de bas de page</a>
+              </p>
+            </li>
+
             <li>
               <p><a class="reference internal" href=
               "#remplacement-avec-signature" id=
-              "toc-entry-8">Remplacement avec signature</a>
+              "toc-entry-9">Remplacement avec signature</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#tester" id=
-              "toc-entry-9">Tester</a>
+              "toc-entry-10">Tester</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#code-source"
-              id="toc-entry-10">Code source</a>
+              id="toc-entry-11">Code source</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#license" id=
-              "toc-entry-11">License</a>
+              "toc-entry-12">License</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#auteur" id=
-              "toc-entry-12">Auteur</a>
+              "toc-entry-13">Auteur</a>
               </p>
             </li>
           </ul>
@@ -302,7 +309,10 @@
 
             <p>Exemple (avec séparateur <strong>%=</strong> ) : «
             Ceci est un objet %=et ceci devient la note en bas de
-            page, qui décrit l'objet plus précisément=% »</p>
+            page, qui décrit l'objet plus précisément=% » (voir
+            plus bas : <a class="reference internal" href=
+            "#creation-des-notes-de-bas-de-page">Création des notes
+            de bas de page</a>:</p>
           </li>
         </ul>
       </section>
@@ -363,7 +373,8 @@
       </section>
     </section>
 
-    <section id="configuration">
+    <section id="configuration-1">
+      <span id="configuration"></span>
       <h2>CONFIGURATION</h2>
 
       <p>La première fois que vous exécutez le logiciel, une copie
@@ -618,7 +629,7 @@ alt.fr.test: /home/[utilisateur]/.signatures</pre>
           <p>EXEMPLE: '%?'</p>
         </blockquote>
 
-        <p><strong>REFERENCE_FORMAT</strong>
+        <p id="reference-format"><strong>REFERENCE_FORMAT</strong>
         </p>
 
         <blockquote>
@@ -695,6 +706,24 @@ alt.fr.test: /home/[utilisateur]/.signatures</pre>
     <section id="autres-informations">
       <h2>Autres Informations</h2>
 
+      <section id="creation-des-notes-de-bas-de-page-1">
+        <span id="creation-des-notes-de-bas-de-page"></span>
+        <h3>Création des notes de bas de page</h3>
+
+        <p>Il peut être tentant d'écrire le texte des notes de bas
+        de page (ou les références URL) en ligne lors de la
+        rédaction d'un article, mais cela risque de perturber la
+        mise en forme de vos lignes. Il est difficile de prévoir la
+        longueur des lignes après le déplacement automatique des
+        notes de bas de page à la fin. Écrivez plutôt votre article
+        dans son intégralité, puis ajoutez les notes de bas de page
+        juste avant la publication. Cela vous permettra d'anticiper
+        l'apparence finale de l'article une fois que les marqueurs
+        de notes de bas de page auront remplacé le texte intégré
+        (voir <a class="reference internal" href=
+        "#reference-format">REFERENCE_FORMAT</a>, ci-dessus).</p>
+      </section>
+
       <section id="remplacement-avec-signature">
         <h3>Remplacement avec signature</h3>
 
@@ -813,16 +842,9 @@ alt.fr.test: /home/[utilisateur]/.signatures</pre>
       <section id="auteur">
         <h3>Auteur</h3>
 
-        <div class="line-block">
-          <div class="line">
-            <strong>flnews_post_proc</strong> a été développé par
-          </div>
-
-          <div class="line">
-            Michael Uplawski &lt;<a class="reference external"
-            href="mailto:michael.uplawski@uplawski.eu">michael.uplawski@uplawski.eu</a>&gt;
-          </div>
-        </div>
+        <p><strong>flnews_post_proc</strong> a été développé par
+        Michael Uplawski &lt;<a class="reference external" href=
+        "mailto:michael.uplawski@uplawski.eu">michael.uplawski@uplawski.eu</a>&gt;</p>
 
         <p>Ω</p>
       </section>

data/doc/fr/rst/flnews_post_proc.rst

@@ -106,7 +106,8 @@ des raisons parfois arbitraires :
 
   Exemple (avec séparateur **%=** ) :
   « Ceci est un objet %=et ceci devient la note en bas de page, qui décrit
-  l'objet plus précisément=% »
+  l'objet plus précisément=% » (voir plus bas : `Création des notes de bas
+  de page`_:
 
 Dialogue pour désactiver des options
 ---------------------------------------
@@ -140,6 +141,8 @@ Vous pouvez même désactiver le dialogue, ce qui garantit que toutes les option
 configurées seront appliquées sans interaction supplémentaire (voir ci-dessous :
 option OVERRIDE_CONFIG).
 
+.. _configuration:
+
 CONFIGURATION
 =============
 La première fois que vous exécutez le logiciel, une copie de la configuration
@@ -332,6 +335,8 @@ Options de configuration
 
     EXEMPLE: '%?'
 
+.. _REFERENCE_FORMAT:
+
 **REFERENCE_FORMAT**
 
     Une chaîne de formatage, contenant %s pour représenter une nombre, qui
@@ -385,6 +390,20 @@ Options de configuration
 Autres Informations
 ===================
 
+.. _Création des notes de bas de page:
+
+Création des notes de bas de page
+-------------------------------------
+Il peut être tentant d'écrire le texte des notes de bas de page (ou les
+références URL) en ligne lors de la rédaction d'un article, mais cela risque de
+perturber la mise en forme de vos lignes. Il est difficile de prévoir la
+longueur des lignes après le déplacement automatique des notes de bas de page à
+la fin.
+Écrivez plutôt votre article dans son intégralité, puis ajoutez les notes de
+bas de page juste avant la publication.  Cela vous permettra d'anticiper
+l'apparence finale de l'article une fois que les marqueurs de notes de bas de
+page auront remplacé le texte intégré (voir REFERENCE_FORMAT_, ci-dessus).
+
 Remplacement avec signature
 ---------------------------
 
@@ -449,7 +468,6 @@ répertoire « doc » de la gem ).
 
 Auteur
 ------
-| |program| a été développé par 
-| Michael Uplawski <michael.uplawski@uplawski.eu>
+|program| a été développé par Michael Uplawski <michael.uplawski@uplawski.eu>
 
 Ω

data/doc/html/flnews_post_proc.html

@@ -124,34 +124,41 @@
           </p>
 
           <ul>
+            <li>
+              <p><a class="reference internal" href=
+              "#editing-footnotes-1" id="toc-entry-8">Editing
+              footnotes</a>
+              </p>
+            </li>
+
             <li>
               <p><a class="reference internal" href=
               "#signatures-in-supersedes-1" id=
-              "toc-entry-8">Signatures in Supersedes</a>
+              "toc-entry-9">Signatures in Supersedes</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#testing-1"
-              id="toc-entry-9">Testing</a>
+              id="toc-entry-10">Testing</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href=
-              "#source-code-1" id="toc-entry-10">Source Code</a>
+              "#source-code-1" id="toc-entry-11">Source Code</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#license-1"
-              id="toc-entry-11">License</a>
+              id="toc-entry-12">License</a>
               </p>
             </li>
 
             <li>
               <p><a class="reference internal" href="#author-1" id=
-              "toc-entry-12">Author</a>
+              "toc-entry-13">Author</a>
               </p>
             </li>
           </ul>
@@ -166,8 +173,7 @@
       <p>The post-processor is invoked by piping an article into
       it. This typically occurs automatically when the "post_proc"
       variable is set to <strong>flnews_post_proc</strong> in the
-      flnews <a class="reference internal" href=
-      "#configuration">configuration</a> file.</p>
+      flnews configuration file.</p>
 
       <p>For testing purposes, you can also pipe locally stored
       articles into the post-processor using a command like:</p>
@@ -217,13 +223,12 @@
           <li>
             <p>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 <a class=
-            "reference internal" href=
-            "#configuration">configuration</a> 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>
+            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>
@@ -239,10 +244,8 @@
             <p>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 <a class=
-            "reference internal" href=
-            "#configuration">configuration</a> file and will be
-            added to outgoing posts.</p>
+            headers can be defined in the configuration file and
+            will be added to outgoing posts.</p>
           </li>
 
           <li>
@@ -264,11 +267,12 @@
             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 <a class=
-            "reference internal" href=
-            "#configuration">configuration</a> file. Example (using
-            %=): "This is an object %=and this becomes the
-            footnote, describing the object further=%"</p>
+            delimiter configurable in the configuration file.
+            Example (using %=): "This is an object %=and this
+            becomes the footnote, describing the object further=%".
+            See also the hints under <a class="reference internal"
+            href="#editing-footnotes">EDITING FOOTNOTES</a>,
+            below.</p>
           </li>
         </ul>
       </section>
@@ -283,18 +287,17 @@
         <p>Before the post-processor runs, a dialog can be
         displayed to allow users to <strong>disable</strong>
         certain <a class="reference internal" href=
-        "#configuration">configuration</a> options. If Whiptail or
+        "#configuration">CONFIGURATION</a> 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 <a class=
-        "reference internal" href=
-        "#configuration">configuration</a>.</p>
+        options that haven't already been set in the
+        configuration.</p>
 
         <ul class="simple">
           <li>
             <p>Signatures (if set in the <a class=
             "reference internal" href=
-            "#configuration">configuration</a>) can be
+            "#configuration">CONFIGURATION</a>) can be
             <strong>ignored</strong>. A default signature will be
             used, or no signature at all.</p>
           </li>
@@ -529,7 +532,7 @@ comp.*: /home/[user]/.my_sigs</pre>
           <p>EXAMPLE: '%?'</p>
         </blockquote>
 
-        <p><strong>REFERENCE_FORMAT</strong>
+        <p id="reference-format"><strong>REFERENCE_FORMAT</strong>
         </p>
 
         <blockquote>
@@ -578,6 +581,26 @@ comp.*: /home/[user]/.my_sigs</pre>
       <span id="other-information"></span>
       <h2>Other Information</h2>
 
+      <section id="editing-footnotes-1">
+        <span id="editing-footnotes"></span>
+        <h3>Editing footnotes</h3>
+
+        <p>Writing footnote text (or URL-references) inline when
+        you are about to redact a news article, may be tempting,
+        but it can –and probably will– mess up the line breaks in
+        the post: It is too difficult to estimate the length of a
+        text line, after the footnote is automatically removed and
+        put at the end of the article.</p>
+
+        <p>You should rather prepare the entire article and
+        <strong>insert</strong> footnote text right before posting.
+        This way you have a realistic grasp of the appearance of
+        the authentic article, after the additional text has been
+        replaced by your choice of a symbol (see <a class=
+        "reference internal" href=
+        "#reference-format">REFERENCE_FORMAT</a>, above).</p>
+      </section>
+
       <section id="signatures-in-supersedes-1">
         <span id="signatures-in-supersedes"></span>
         <h3>Signatures in Supersedes</h3>

data/doc/rst/flnews_post_proc.rst

@@ -21,7 +21,7 @@ SYNOPSIS
 ===========================
 The post-processor is invoked by piping an article into it. This typically
 occurs automatically when the "post_proc" variable is set to |program|
-in the flnews `configuration`_ file.
+in the flnews configuration file.
 
 For testing purposes, you can also pipe locally stored articles into the
 post-processor using a command like:
@@ -60,7 +60,7 @@ unsatisfactory for arbitrary reasons:
 
 * 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,
+  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.
 
@@ -71,7 +71,7 @@ unsatisfactory for arbitrary reasons:
 
 * 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
+  headers can be defined in the configuration file and will be added to
   outgoing posts.
 
 * Headers like "Archive" and "X-No-Archive" are sometimes set to prevent an
@@ -86,9 +86,10 @@ unsatisfactory for arbitrary reasons:
 * 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 <ref/> link format used in Wikipedia, with the delimiter configurable
-  in the `configuration`_ file.
+  in the configuration file.
   Example (using %=): "This is an object %=and this becomes the footnote,
-  describing the object further=%"
+  describing the object further=%". See also the hints under 
+  `EDITING FOOTNOTES`_, below.
 
 .. _Dialog for Overriding Settings:
 
@@ -98,11 +99,11 @@ Dialog for Overriding Settings
 interface.
 
 Before the post-processor runs, a dialog can be displayed to allow users to
-**disable** certain `configuration`_ options. If Whiptail or xterm are available,
+**disable** certain `CONFIGURATION`_ options. If Whiptail or xterm are available,
 you can choose to disable the following options. You **cannot** enable options
-that haven't already been set in the `configuration`_.
+that haven't already been set in the configuration.
 
-* Signatures (if set in the `configuration`_) can be **ignored**. A default
+* Signatures (if set in the `CONFIGURATION`_) can be **ignored**. A default
   signature will be used, or no signature at all.
 * Custom headers can be **omitted**.
 * The "Archive" and "X-No-Archive" headers can be **ignored** if set for the
@@ -155,7 +156,7 @@ Configuration Options
      
     EXAMPLE2: "**(.*)** wrote:"
 
-    .. _fup_group:
+    .. _FUP_GROUP:
 
 **FUP_GROUP**
 
@@ -170,7 +171,7 @@ Configuration Options
      
     EXAMPLE: "wrote in **(.*)**:"
 
-    .. _group_intros:
+    .. _GROUP_INTROS:
 
 **GROUP_INTROS**
 
@@ -271,6 +272,8 @@ Configuration Options
      
     EXAMPLE: '%?'
 
+.. _REFERENCE_FORMAT:
+
 **REFERENCE_FORMAT**
 
     A format string using `%s` for a number to replace the reference text in
@@ -310,6 +313,18 @@ Configuration Options
 Other Information
 ========================
 
+.. _EDITING FOOTNOTES:
+
+Editing footnotes
+-----------------
+Writing footnote text (or URL references) inline while composing an article may
+be tempting, but it will likely break your line formatting. It's difficult to
+predict line lengths after footnotes are automatically moved to the end.
+Instead, write your complete article first, then add footnotes just before
+posting.
+This lets you anticipate how the final article will look after footnote markers
+replace the inline text (see REFERENCE_FORMAT_, above).
+
 .. _Signatures in Supersedes:
 
 Signatures in Supersedes

data/lib/version.rb

@@ -14,8 +14,8 @@
 =end
 
 PROGNAME = 'flnews_post_proc'
-PROGVERSION = "1.93"
+PROGVERSION = "1.94"
 AUTHORS = "Michael Uplawski"
 EMAIL = "michael.uplawski@uplawski.eu"
 YEARS = "2023 - 2026"
-SUMMARY = "References precede a signature, also in Supersedes"
+SUMMARY = "Documentation improved (concerns mainly the PDF)"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: flnews_post_proc
 version: !ruby/object:Gem::Version
-  version: '1.93'
+  version: '1.94'
 platform: ruby
 authors:
 - Michael Uplawski
 bindir: bin
 cert_chain: []
-date: 2026-01-22 00:00:00.000000000 Z
+date: 2026-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -94,14 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.4
 specification_version: 4
-summary: References precede a signature, also in Supersedes
+summary: Documentation improved (concerns mainly the PDF)
 test_files: []