Mode d’emploi de DLM sur ce site

Share

On donne quelques notes sur utilisation qui est faite sur ce site du gestionnaire documentaire « Download Monitor » (DLM) avec des templates « custom ». Ces templates sont stockés dans :
/wp-content/themes/customizr-pro/download-monitor/.
Au cas où l’on change de thème, une copie de sauvegarde se trouve dans :
/wp-content/themes/copie-templates-download-monitor/.

Attention : lorsque l’on ouvre un téléchargement en « Modification rapide », la case « Téléchargement mis en avant » est décochée, quelque soit son état avant ouverture. Lorsque l’on referme, l’état devient donc « false » si l’on ne prend pas attention de cocher la case.

Ce drapeau fournit un moyen très commode pour scinder la documenthèque en deux :

  1. les documents pérennes devant apparaître dans différentes listes publiques (ex. règlements, cahiers des charges, résultats…) : featured = true
  2. les documents archivés et ne paraissant plus dans les listes publiques :
    • soit des documents ponctuels comme le programme d’une finale, une liste de compétiteurs…
    • soit des documents périmés, et ne devant plus être listés (ex. règlement d’une compétition caduque) : featured = false

Noms de version

Le gestionnaire DLM apporte la possibilité de gérer plusieurs versions d’un même document :

  • différents versions chronologiques
  • différents formats de fichiers

Un nom de version est obligatoire si l’on veut citer une version particulière autre que celle qui se trouve en premier dans la liste. On propose les conventions de nom développées ci-après.

Conventions proposées :

  • a-[[version auteur.-type}]] : fichier auteur inclut un nom de version – exemple a-2020-10-31.docx
  • r-[[date_réception_document.type]] : pas de nom de version donné par l’auteur – exemple r-20201101.pdf
  • dd-[[numéro delightful downloads]] : fichier migré depuis Delightful Downloads ) exemple dd-12345
  • sportscanins (exemple) : raccourci d’URL en cas de référencement externe, ici sportscanins.fr

Citation au sein d’un texte

Pour citer un document au sein d’un texte, comme ceci : Cahier des charges de l’organisation du Championnat de France et GPF dog-dancing, en utilisant le shortcode [download id=NNNNN template=title-DP]. En effet, par rapport au template natif title, le template title-DP ajoute l’icône du type de fichier, ce qui permet au lecteur de distinguer la citation d’un document de celle d’une page, d’une article….

Citation documents spécifiques

Pour citer une liste de documents spécifiques, les templates title-DP ou titleplus-DP ou encore titleplusplus-DP sont recommandés. Exemples :

Exemple title-DP

Exemple titleplusplus-DP

Exemple title-checkversion-DP

Le template title-checkversion-DP permet de citer une version spécifique d’un document et d’afficher un avertissement si la version citée n’est pas la plus récente. C’est utile surtout lorsque l’on se réfère à la version d’un document qui a servi de référence pour la création d’une page du site.

[download id="31237" version="a-2020-09-16.pdf" template="title-checkversion-DP"]

L'agility - mode d'emploi pour le compétiteur (version : a-2020-09-16.pdf)
ATTENTION : il existe apparement une version plus récente de ce document :
MODE-D-EMPLOI-COMPETITEUR-AGILITY_2021-05-17.pdf (version = a-2021-05-17.pdf)

Attention : DLM ne signale pas d’erreur si l’on spécifie un nom de version qui n’existe pas – c’est la première version de la liste qui est prise par défaut.

Listes automatiques

Exemple title

[downloads featured="true" tag="%exemple-shortcodes" sort="title" order="ASC" template="title"]

Exemple title-DP

[downloads featured="true" tag="%exemple-shortcodes" template="title-DP"]

Exemple titleplus-DP

[downloads featured="true" tag="%exemple-shortcodes" template="titleplus-DP"]

Exemple titleplusplus-DP

[downloads featured="true" tag="%exemple-shortcodes" template="titleplusplus-DP"]

Exemple index-DP

[downloads featured="true" tag="%exemple-shortcodes" template="index-DP"]

Exemple indexplus-DP

[downloads featured="true" tag="%exemple-shortcodes" template="indexplus-DP"]

Exemple version-list-DP

[downloads featured="true" tag="%exemple-shortcodes" template="version-list-DP"]

Remarques sur les dates

Dans les templates affichant une date, celle-ci correspond à la date des la 1ère version dans la liste des versions (habituellement, c’est la version la plus récente). Cette date ne correspond pas nécessairement à la date de publication, qui n’est pas modifiée lorsqu’une nouvelle version est ajoutée. Cependant, la date de publication peut être modifiée manuellement pour correspondre à celle de la dernière version. C’est la convention que nous utilisons.

Le paramètre orderby dans [downloads] peut prendre deux valeurs correspondant à des dates :

  • date : c’est la date de publication (cf. remarque précédente)
  • modified : c’est la date de modification de l’enregistrement « téléchargement », quelqu’en soit la modification : ajout d’une version, d’une étiquette, changement de valeur de featured, …

Conventions mots-clés

La logique suivante de préfixes est utilisée pour distinguer les différents types de mot-clé :

!mot-clé événement
@mot-clé générique (multi-discipline)
#mot-clé spécifique (ex. pour un type de stage donné)
&mot-clé archivé
%mot-clé GT internet (exemples, tests, rappels, etc.)
Xmot-clé périmé (à effacer)

Re-direction vers différents formats

Il avait été envisagé d’utiliser la notion de version pour stocker différents formats accessibles à l’utilisateur (par exemple, un formulaire), mais cette approche a été abandonnée car elle manque de souplesse et allonge les listes de documents. Le choix final dans ce cas s’est porté sur la création d’une page intermédiaire permettant de choisir entre les différents formats, la page étant référencée via un document fantôme avec une version qui re-dirige vers cette page.

Cela offre les deux possibilités :

  • de référencer individuellement les documents de formats différents, comme tout autre document
  • de référencer le document fantôme de direction vers la page de choix de format

Exemple :

  • Document de format F1
    • Titre = « Nom du document (F1) »
    • ID=11111 (exemple)
    • Une ou plusieurs versions : Version 1 de format F1
    • Tag %format (pour la maintenance)
    • Case « Mis en avant » décochée
  • Document de format F2
    • Titre = « Nom du document (F2) »
    • ID=22222 (exemple)
    • Une ou plusieurs versions : Version 1 de format F2
    • Tag %format (pour la maintenance)
    • Case « Mis en avant » décochée
  • Document de re-direction vers la page 99999-redirect
    • Titre = « Nom du document »
    • ID : 99999 (exemple)
    • Une version « Redirection 11111 / 22222  » vers la page : « …/Redirections/99999-redirect »
    • Tag %redirection (pour la maintenance)
    • Case « Redirection vers le fichier » cochée
    • Case « Mise en avant » cochée
  • Page de redirection (sous-page de …/Redirections)
    • Titre = « 99999 – Nom du document »
    • Slug = 99999-redirect

Voir l’existant sur la page : Redirections.