Cuisine et Web

nom du plugin : PLX_reading_lapse

Ce plugin configurable vous permet d'afficher le temps de lecture estimé d'un article à l'aide d'un Hook (point d'accroche) dans vos théme , là, ou vous souhaitez le faire apparaitre.

! Ce plugin ne prend pas en compte les vidéos ou pistes Audios qu'il contient.

Cette article vous décrit son installation, ses options de configuration et son intégration.

Sur la page github du plugin, vous y trouverez 4 versions, de l'essentiel à la plus flexible. Ces versions peuvent être cloner ou vous servir de base.

L'installation

L'installation se déroule comme tout les plugins de PluXml.

1. télécharger l'archive au format zip depuis son dépôt GITHUB.
2. Dézipper l'archive
3. copier le répertoire timeLapseReading dans le répertoire /plugins à la racine de votre PluXml.
4. Connectez vous à l'administration de votre site avec le statut d'administrateur.
5. Activer le plugin.
6. A ce stade, il ne se passera rien à l'affichage, sauf si vous aviez déjà installé ce plugin ou ajouté le hook dans vos fichiers de thèmes.

Les configurations d'affichages

Visuel de l'interface:

Le plugin a une configuration par défaut qui le rend opérationnel dés l'activation si le hook est ajouté au(x) fichier(s) du thème actif.

Le plugin est multilingue, la version initiale dispose d'un fichier pour le français fr.php et d'un autre pour l'anglais en.php.(pour créer un nouveaux fichier de langue, il suffit de copier et renommer l'un des fichier langue disponible et de traduire les textes qu'il contient.)

Détails

Le morceau de code à ajouter à vos thèmes se trouve dans l'interface de configuration, cliquez dessus pour le copier.

Le nombre de mots par minute

Selon le profil de vos lecteurs ou les sujets de votre blog. Une valeur entre 150 et 300 refletera une vitesse de lecture, - de jeune écolier ou de vive voix, - d'un tutoriel ou d'un roman, par exemples.

Vous pouvez modifier cette valeur à partir de la page de configuration du plugin accessible depuis l'administration. Sans modification de votre part, le temps de lecture est basé sur 220 mots lus à la minute.

Le format d'affichage

Par defaut, le temps de lecture, definie par #_estimateReadingTime est inclus dans un <span class="tempsLecture"></span>. La class est accessoire, elle peut servir dans votre feuille de style.

Ceci est modifiable excepter pour le code d'affichage de durée de lecture:#_estimateReadingTime.

Exemple:utiliser un paragraphe au lieu d'un span et ajouter une icone devant: <p><i class="fa-solid fa-timer"></i>#_estimateReadingTime</p>

Afficher une unité de valeur.

2 Champs vous permettent de choisir ce que vous souhaiter afficher derriere les minutes et secondes estimées. Par défaut c'est min et sec, vous pouvez vider ces champs pour ne rien afficher ou ne mettre que : pour le champs des minutes par exemple.

Afficher les secondes

Vous pouvez omettre l'affichage des secondes

Validez les MAJ : Enregistrer

N'oubliez pas d'enregistrer vos modification pour qu'elles prennent effets.

Valeurs par défaut :Réinitialiser

En cliquant ce bouton, les valeurs par défaut sont réappliquées et enregistrées.

Affichage Dans le théme

Pour afficher le temps de lecture estimé d'un article, il vous faut inserer dans le fichier du théme le code suivant: <?php if (eval($plxMotor->plxPlugins->callHook('showReadingtime'))) return; ?> à l'endroit ou vous voulez le faire apparaitre.

Les fichiers du thème en cours sont éditables depuis l’administration du site. Accessible sur le menu à l'onglet Paramètres puis Thème et le bouton "Éditer les fichiers du thème". Une liste déroulante s'affiche vous permettant de sélectionner le fichier à modifier.

Exemple: Dans le fichier home.php du théme par défaut, vous pouvez l'inserer juste derrier le titre de l'article.(extrait du code du fichier ci-dessous)

<header>
	<span class="art-date">
		<time datetime="<?php $plxShow->artDate('#num_year(4)-#num_month-#num_day'); ?>">
			<?php $plxShow->artDate('#num_day #month #num_year(4)'); ?>
		</time>
	</span>
	<h2>
		<?php $plxShow->artTitle('link'); ?>
	</h2>
<!--  insertion du code --><?php if (eval($plxMotor->plxPlugins->callHook('showReadingtime'))) return; ?>
	<div>
		<small>
			<span class="written-by">
				<?php $plxShow->lang('WRITTEN_BY'); ?> <?php $plxShow->artAuthor() ?>
			</span>
			<span class="art-nb-com">
				<?php $plxShow->artNbCom(); ?>
			</span>
		</small>
	</div>

Voilà, votre plugin est fonctionnel