Uniformisation des pages manuels

Changes to be committed: modified: .config/files_local-share-doc modified: .config/files_local-share-man modified: local/share/doc/castopod_update.1.md modified: local/share/doc/convertPDF.1.md modified: local/share/doc/play_tophoraire.1.md modified: local/share/doc/playlist_gen.1.md modified: local/share/doc/random_music_player.1.md modified: local/share/man/castopod_update.1 modified: local/share/man/convertPDF.1 modified: local/share/man/play_tophoraire.1 modified: local/share/man/playlist_gen.1 modified: local/share/man/random_music_player.1 modified: prep.sh
2023-12-14 21:27:49 +01:00 · 2023-12-14 21:27:49 +01:00 · 34e7b33357
parent 7f7c74c288
commit 34e7b33357
13 changed files with 101 additions and 80 deletions
--- a/.config/files_local-share-doc
+++ b/.config/files_local-share-doc
@ -1,5 +1,5 @@
-castopod_update.1.md
-convertPDF.1.md
 play_tophoraire.1.md
+convertPDF.1.md
+castopod_update.1.md
 random_music_player.1.md
 playlist_gen.1.md
--- a/.config/files_local-share-man
+++ b/.config/files_local-share-man
@ -1,5 +1,5 @@
 playlist_gen.1
 random_music_player.1
-play_tophoraire.1
-convertPDF.1
 castopod_update.1
+convertPDF.1
+play_tophoraire.1
--- a/local/share/doc/castopod_update.1.md
+++ b/local/share/doc/castopod_update.1.md
@ -10,11 +10,11 @@ castopod_update - Mise à jour de CASTOPOD

 Le script **castopod_update** permet de mettre à jour le dossier Web de CASTOPOD en utilisant le fichier de mise à jour au format ZIP fourni.

-## OPTIONS
+# OPTIONS

 - Aucune option n'est nécessaire pour exécuter le script.

-## CONFIGURATION
+# CONFIGURATION

 Le script a sa propre configuration qui n'est pas modifiable.

@ -28,7 +28,7 @@ L'archive de mise à jour doit être spécifiquement nommée `castopod*.zip` et

 Le script utilise `php8.1` pour effectuer des tâches de maintenance.

-## PRÉREQUIS
+# PRÉREQUIS

 Téléchargez l'archive de mise à jour disponible sur le site https://castopod.org/.

@ -42,18 +42,17 @@ castopod_update

 # VERSIONS

-Version 23.12.1
- Messages des logs améliorés avec plus de détails lors de l'utilisation de 'cp'.
-
 Version 23.12.14
 - Suppression de l'archive TAR du dossier `save_castopod`.

+Version 23.12.1
+- Messages des logs améliorés avec plus de détails lors de l'utilisation de 'cp'.

-## AUTEUR
+# AUTEUR

 Ce script a été créé par Cédric Abonnel.

-## RAPPORT D'ERREURS
+# RAPPORT D'ERREURS

 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

--- a/local/share/doc/convertPDF.1.md
+++ b/local/share/doc/convertPDF.1.md
@ -1,23 +1,24 @@
 convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et génère le résultat d'un OCR

-## SYNOPSIS
+# SYNOPSIS
 **convertPDF**

-## DESCRIPTION
+# DESCRIPTION
+
 Ce script convertit des fichiers PDF en d'autres formats tels que JPG, TXT, et PDF en utilisant des outils comme `pdftocairo`, `pdftotext`, `tesseract`, et `convert`.

-## COMPATIBILITÉ
+# COMPATIBILITÉ

 Ce script est compatible avec les fichiers PDF (Portable Document Format).

-## EXEMPLE
+# EXEMPLE
 Convertir plusieurs fichiers PDF présent dans le dossier et sous-dossiers courants :
   ```
   convertPDF
   ```

-## AUTEUR
+# AUTEUR
 Ce script a été créé par Cédric Abonnel.

-## RAPPORT D'ERREURS
+# RAPPORT D'ERREURS
 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/doc/play_tophoraire.1.md
+++ b/local/share/doc/play_tophoraire.1.md
@ -10,23 +10,23 @@ top_horaire - Gestion du jingle et de l'annonce de l'heure

 Le script **top_horaire** permet de gérer la lecture d'un jingle en arrière-plan suivi de l'annonce de l'heure actuelle en utilisant espeak-ng.

-## OPTIONS
+# OPTIONS

 - Aucune option n'est requise pour exécuter le script.

-## CONFIGURATION
+# CONFIGURATION

 Le script peut lire la configuration à partir d'un fichier de configuration situé dans le répertoire `~/.config/`. Si le fichier de configuration n'existe pas, il sera créé avec un commentaire indiquant la date de création.

-## CONFIGURATION DU CHEMIN DU JINGLE
+# CONFIGURATION DU CHEMIN DU JINGLE

 Le chemin du jingle est configuré par la variable `jingle_tophoraire`. Si cette variable n'est pas définie dans le fichier de configuration, elle sera initialisée avec le chemin par défaut du jingle.

-## LECTURE DU JINGLE EN ARRIÈRE-PLAN
+# LECTURE DU JINGLE EN ARRIÈRE-PLAN

 Une fois le chemin du jingle configuré, le script utilise la commande `paplay` pour lire le jingle en arrière-plan.

-## ANNONCE DE L'HEURE ACTUELLE
+# ANNONCE DE L'HEURE ACTUELLE

 Le script obtient l'heure actuelle et crée un message d'annonce contenant l'heure. Il utilise ensuite la commande `espeak-ng` pour annoncer l'heure en français.

@ -38,10 +38,10 @@ Pour exécuter le script sans aucune option :
 top_horaire
 ```

-## AUTEUR
+# AUTEUR
 Ce script a été créé par Cédric Abonnel.

-## RAPPORT D'ERREURS
+# RAPPORT D'ERREURS
 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

 # VOIR AUSSI
--- a/local/share/doc/playlist_gen.1.md
+++ b/local/share/doc/playlist_gen.1.md
@ -1,14 +1,14 @@
 # playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio

-## SYNOPSIS
+# SYNOPSIS

 **playlist_gen** [-n \<nombre de fichiers\>] [-d \<répertoire\>] [-o \<fichier de sortie\>]

-## DESCRIPTION
+# DESCRIPTION

 **playlist_gen** est un script Bash qui permet de générer une playlist M3U à partir de fichiers audio situés dans un répertoire spécifié.

-## OPTIONS
+# OPTIONS

 - **-n \<nombre de fichiers\>** : Spécifie le nombre de fichiers à inclure dans la playlist. Par défaut, le nombre de fichiers est 100.

@ -16,17 +16,17 @@

 - **-o \<fichier de sortie\>** : Spécifie le nom du fichier M3U de sortie. Par défaut, le fichier est créé dans le répertoire de la musique de l'utilisateur.

-## UTILISATION
+# UTILISATION

 ```
 playlist_gen -n 50 -d /chemin/vers/repertoire -o playlist.m3u
 ```

-## COMPATIBILITÉ
+# COMPATIBILITÉ

 Ce script est compatible avec les fichiers audio aux formats MP3, Opus, Ogg et M4A.

-## EXEMPLES
+# EXEMPLES

 1. Générer une playlist M3U à partir du répertoire de musique par défaut de l'utilisateur :

@ -40,11 +40,11 @@ Ce script est compatible avec les fichiers audio aux formats MP3, Opus, Ogg et M
   playlist_gen -n 25 -d /chemin/vers/repertoire
   ```

-## AUTEUR
+# AUTEUR

 Ce script a été écrit par Cédric Abonnel.

-## RAPPORTS D'ERREURS
+# RAPPORTS D'ERREURS

 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

--- a/local/share/doc/random_music_player.1.md
+++ b/local/share/doc/random_music_player.1.md
@ -1,15 +1,16 @@
 random_music_player(1) - Lecteur de musique aléatoire en ligne de commande

-## Synopsis
+# SYNOPSIS
 **random_music_player** [OPTIONS]

-## Description
+# DESCRIPTION
+
 Le script **random_music_player** est un lecteur de musique aléatoire en ligne de commande qui lit des fichiers audio à partir d'un répertoire spécifié.

-## Options
+# OPTIONS
 - Aucune option n'est requise.

-## Configuration
+# CONFIGURATION
 Le script utilise un fichier de configuration situé à `~/.config/random_music_player`. Si ce fichier de configuration n'existe pas, il sera créé avec les paramètres par défaut suivants :
 ```shell
 # Fichier de configuration créé [date de création]
@ -19,21 +20,21 @@ volume=0.06

 Vous pouvez éditer ce fichier de configuration pour personnaliser les réglages du lecteur de musique.

-## Utilisation
+# UTILISATION
 Pour utiliser le lecteur de musique aléatoire, exécutez simplement le script sans aucune option. Il sélectionnera au hasard un fichier audio à partir du répertoire spécifié dans le fichier de configuration et le lira.

 ```shell
 random_music_player
 ```

-## Exemple
+# EXEMPLE
 ```shell
 $ random_music_player
 ```

-## Auteur
+# AUTEUR
 Ce script a été créé par Cédric Abonnel.

-## Rapport d'erreurs
+# RAPPORT D'ERREURS
 Pour signaler des erreurs ou des problèmes : https://git.abonnel.fr/cedricAbonnel/scripts-bash

--- a/local/share/man/castopod_update.1
+++ b/local/share/man/castopod_update.1
@ -27,10 +27,10 @@ castopod_update - Mise à jour de CASTOPOD
 Le script \f[B]castopod_update\f[R] permet de mettre à jour le dossier
 Web de CASTOPOD en utilisant le fichier de mise à jour au format ZIP
 fourni.
-.SS OPTIONS
+.SH OPTIONS
 .IP \[bu] 2
 Aucune option n\[cq]est nécessaire pour exécuter le script.
-.SS CONFIGURATION
+.SH CONFIGURATION
 .PP
 Le script a sa propre configuration qui n\[cq]est pas modifiable.
 .PP
@ -49,7 +49,7 @@ script et le dossier Web de CASTOPOD.
 .PP
 Le script utilise \f[V]php8.1\f[R] pour effectuer des tâches de
 maintenance.
-.SS PRÉREQUIS
+.SH PRÉREQUIS
 .PP
 Téléchargez l\[cq]archive de mise à jour disponible sur le site
 https://castopod.org/.
@ -64,15 +64,15 @@ castopod_update
 .fi
 .SH VERSIONS
 .PP
-Version 23.12.1 - Messages des logs améliorés avec plus de détails lors
-de l\[cq]utilisation de `cp'.
-.PP
 Version 23.12.14 - Suppression de l\[cq]archive TAR du dossier
 \f[V]save_castopod\f[R].
-.SS AUTEUR
+.PP
+Version 23.12.1 - Messages des logs améliorés avec plus de détails lors
+de l\[cq]utilisation de `cp'.
+.SH AUTEUR
 .PP
 Ce script a été créé par Cédric Abonnel.
-.SS RAPPORT D\[cq]ERREURS
+.SH RAPPORT D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/convertPDF.1
+++ b/local/share/man/convertPDF.1
@ -19,26 +19,26 @@
 .PP
 convertPDF(1) - Compresse des fichiers PDF pour gagner en volume et
 génère le résultat d\[cq]un OCR
-.SS SYNOPSIS
+.SH SYNOPSIS
 .PP
 \f[B]convertPDF\f[R]
-.SS DESCRIPTION
+.SH DESCRIPTION
 .PP
 Ce script convertit des fichiers PDF en d\[cq]autres formats tels que
 JPG, TXT, et PDF en utilisant des outils comme \f[V]pdftocairo\f[R],
 \f[V]pdftotext\f[R], \f[V]tesseract\f[R], et \f[V]convert\f[R].
-.SS COMPATIBILITÉ
+.SH COMPATIBILITÉ
 .PP
 Ce script est compatible avec les fichiers PDF (Portable Document
 Format).
-.SS EXEMPLE
+.SH EXEMPLE
 .PP
 Convertir plusieurs fichiers PDF présent dans le dossier et
 sous-dossiers courants : \f[V]convertPDF\f[R]
-.SS AUTEUR
+.SH AUTEUR
 .PP
 Ce script a été créé par Cédric Abonnel.
-.SS RAPPORT D\[cq]ERREURS
+.SH RAPPORT D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/play_tophoraire.1
+++ b/local/share/man/play_tophoraire.1
@ -27,27 +27,27 @@ top_horaire - Gestion du jingle et de l\[cq]annonce de l\[cq]heure
 Le script \f[B]top_horaire\f[R] permet de gérer la lecture d\[cq]un
 jingle en arrière-plan suivi de l\[cq]annonce de l\[cq]heure actuelle en
 utilisant espeak-ng.
-.SS OPTIONS
+.SH OPTIONS
 .IP \[bu] 2
 Aucune option n\[cq]est requise pour exécuter le script.
-.SS CONFIGURATION
+.SH CONFIGURATION
 .PP
 Le script peut lire la configuration à partir d\[cq]un fichier de
 configuration situé dans le répertoire \f[V]\[ti]/.config/\f[R].
 Si le fichier de configuration n\[cq]existe pas, il sera créé avec un
 commentaire indiquant la date de création.
-.SS CONFIGURATION DU CHEMIN DU JINGLE
+.SH CONFIGURATION DU CHEMIN DU JINGLE
 .PP
 Le chemin du jingle est configuré par la variable
 \f[V]jingle_tophoraire\f[R].
 Si cette variable n\[cq]est pas définie dans le fichier de
 configuration, elle sera initialisée avec le chemin par défaut du
 jingle.
-.SS LECTURE DU JINGLE EN ARRIÈRE-PLAN
+.SH LECTURE DU JINGLE EN ARRIÈRE-PLAN
 .PP
 Une fois le chemin du jingle configuré, le script utilise la commande
 \f[V]paplay\f[R] pour lire le jingle en arrière-plan.
-.SS ANNONCE DE L\[cq]HEURE ACTUELLE
+.SH ANNONCE DE L\[cq]HEURE ACTUELLE
 .PP
 Le script obtient l\[cq]heure actuelle et crée un message d\[cq]annonce
 contenant l\[cq]heure.
@ -62,10 +62,10 @@ Pour exécuter le script sans aucune option :
 top_horaire
 \f[R]
 .fi
-.SS AUTEUR
+.SH AUTEUR
 .PP
 Ce script a été créé par Cédric Abonnel.
-.SS RAPPORT D\[cq]ERREURS
+.SH RAPPORT D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/playlist_gen.1
+++ b/local/share/man/playlist_gen.1
@ -17,16 +17,16 @@
 .TH "" "" "" "" ""
 .hy
 .SH playlist_gen(1) - Génère une playlist M3U à partir de fichiers audio
-.SS SYNOPSIS
+.SH SYNOPSIS
 .PP
 \f[B]playlist_gen\f[R] [-n <nombre de fichiers>] [-d <répertoire>] [-o
 <fichier de sortie>]
-.SS DESCRIPTION
+.SH DESCRIPTION
 .PP
 \f[B]playlist_gen\f[R] est un script Bash qui permet de générer une
 playlist M3U à partir de fichiers audio situés dans un répertoire
 spécifié.
-.SS OPTIONS
+.SH OPTIONS
 .IP \[bu] 2
 \f[B]-n <nombre de fichiers>\f[R] : Spécifie le nombre de fichiers à
 inclure dans la playlist.
@ -40,18 +40,18 @@ Par défaut, le répertoire actuel est utilisé.
 sortie.
 Par défaut, le fichier est créé dans le répertoire de la musique de
 l\[cq]utilisateur.
-.SS UTILISATION
+.SH UTILISATION
 .IP
 .nf
 \f[C]
 playlist_gen -n 50 -d /chemin/vers/repertoire -o playlist.m3u
 \f[R]
 .fi
-.SS COMPATIBILITÉ
+.SH COMPATIBILITÉ
 .PP
 Ce script est compatible avec les fichiers audio aux formats MP3, Opus,
 Ogg et M4A.
-.SS EXEMPLES
+.SH EXEMPLES
 .IP "1." 3
 Générer une playlist M3U à partir du répertoire de musique par défaut de
 l\[cq]utilisateur :
@ -74,10 +74,10 @@ playlist_gen -n 25 -d /chemin/vers/repertoire
 \f[R]
 .fi
 .RE
-.SS AUTEUR
+.SH AUTEUR
 .PP
 Ce script a été écrit par Cédric Abonnel.
-.SS RAPPORTS D\[cq]ERREURS
+.SH RAPPORTS D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/local/share/man/random_music_player.1
+++ b/local/share/man/random_music_player.1
@ -19,18 +19,18 @@
 .PP
 random_music_player(1) - Lecteur de musique aléatoire en ligne de
 commande
-.SS Synopsis
+.SH SYNOPSIS
 .PP
 \f[B]random_music_player\f[R] OPTIONS
-.SS Description
+.SH DESCRIPTION
 .PP
 Le script \f[B]random_music_player\f[R] est un lecteur de musique
 aléatoire en ligne de commande qui lit des fichiers audio à partir
 d\[cq]un répertoire spécifié.
-.SS Options
+.SH OPTIONS
 .IP \[bu] 2
 Aucune option n\[cq]est requise.
-.SS Configuration
+.SH CONFIGURATION
 .PP
 Le script utilise un fichier de configuration situé à
 \f[V]\[ti]/.config/random_music_player\f[R].
@ -47,7 +47,7 @@ volume=0.06
 .PP
 Vous pouvez éditer ce fichier de configuration pour personnaliser les
 réglages du lecteur de musique.
-.SS Utilisation
+.SH UTILISATION
 .PP
 Pour utiliser le lecteur de musique aléatoire, exécutez simplement le
 script sans aucune option.
@ -59,17 +59,17 @@ spécifié dans le fichier de configuration et le lira.
 random_music_player
 \f[R]
 .fi
-.SS Exemple
+.SH EXEMPLE
 .IP
 .nf
 \f[C]
 $ random_music_player
 \f[R]
 .fi
-.SS Auteur
+.SH AUTEUR
 .PP
 Ce script a été créé par Cédric Abonnel.
-.SS Rapport d\[cq]erreurs
+.SH RAPPORT D\[cq]ERREURS
 .PP
 Pour signaler des erreurs ou des problèmes :
 https://git.abonnel.fr/cedricAbonnel/scripts-bash
--- a/prep.sh
+++ b/prep.sh
@ -1,5 +1,13 @@
 #!/bin/bash

+# Script Bash - prep.sh
+# Auteur : Cédric Abonnel
+
+# Description : Prépare les fichiers de DOC et listing.
+
+# Version 23.12.14
+# - Modification du traitement des résumés des DOC. La fonctionnalité n'est pas encore accessible.
+

 # Spécifier le chemin du fichier journal
 log_dir="$HOME/log"
@ -107,11 +115,23 @@ ls local/share/man/ -c1 >.config/files_local-share-man



+########
+# Résumé des DOC

-## Résumé des DOC

 for fichier in local/share/doc/*.md; do
  echo "Résumé pour $fichier :"
-  awk '/DESCRIPTION/{flag=1; next} /^$/{flag=0} flag' "$fichier"
+  description_found=0
+
+  while IFS= read -r ligne; do
+    if [ "$description_found" -eq 1 ] && [ -n "$ligne" ]; then
+      echo "$ligne"
+      break
+    elif [ "$ligne" = "# DESCRIPTION" ]; then
+      description_found=1
+    fi
+  done < "$fichier"
+
  echo "..."
 done
+