Modèle:Document

Documentation

UtilisationModifier

Permet de créer une liste triables d’œuvres structurées sous forme de tableau.

RemarquesModifier

Ce modèle sert habituellement dans l’espace « Auteur » ou dans les pages d’éditions multiples afin de créer des listes.
Chaque ligne doit contenir au minimum un titre. Le modèle {{liste documents début}} permet de définir l’en-tête du tableau et le modèle {{Liste documents fin}} de le clôturer.

  • + Avantages : Versatilité et homogénéité dans la mise en forme sans avoir à connaître la syntaxe des tableaux.
  • - Inconvénients : Plusieurs cas de figures sont possibles ce qui peut indisposer un nouvel utilisateur.

SyntaxeModifier

Pour chaque ligne de la liste, avec, entre crochets, les données facultatives :

  • {{document|[date=] ou [dates=] | titre= | [livre=] | [avancement=] | [export=] | [auteur=] | [genre=] | [scan=] | [divers=] | [revue=]}}
  • {{document|[date=] ou [dates=] | éditions= ou traductions= | [titre alpha=] | [livre=] | [avancement=] | [export=] | [auteur=] | [genre=] | [scan=] | [divers=] | [revue=]}}

ParamètresModifier

Permet de créer une liste triables d’œuvres structurées sous forme de tableau

Paramètres du modèle

La mise en forme sur une seule ligne est préférée pour ce modèle.

ParamètreDescriptionTypeStatut
Date de publicationdate

Peut contenir une valeur différente ex : Inc. ou 195?

Exemple
1908
Chaînefacultatif
Dates de début et de findates

Dates séparées par /

Exemple
1883/1885
Chaînefacultatif
Éditions multipleséditions

Nom de la page contenant la liste avec ou sans [titre alpha]

Exemple
Melchior
Chaînefacultatif
Traductions multiplestraductions

Nom de la page contenant la liste des traductions avec ou sans [titre alpha]

Chaînefacultatif
Titre de l’œuvre titre

Texte ou [lien suivi d’une description] avec ou sans [titre alpha]

Exemple
[[Arsène Lupin gentleman-cambrioleur]] le premier d’une longue série
Chaîneobligatoire
Nom du fac-similélivre

Page index sans le préfixe ''Livre''

Exemple
Desrosiers - Les Opiniâtres, 1941.djvu
Chaînefacultatif
Avancementavancement

Valeur de 1 à 5 ; 5 correspond à validé

Nombrefacultatif
Icônes pour exportations export

Nom de la page à exporter si différent de l’argument titre

Exemple
La Mare au Diable ou export=
Chaînefacultatif
Titre originalvo

Titre lors du lancement si différent avec ou sans [vo alpha]

Chaînefacultatif
Auteurauteur

Nom de l’auteur ou co-auteur avec ou sans [auteur alpha]

Chaînefacultatif
Genregenre

Genre de l’ouvrage

Exemple
roman
Chaînefacultatif
Sourcescan

lien URL

URLfacultatif
Diversdivers

Champ libre avec ou sans [divers alpha]

Chaînefacultatif
Revuerevue

Référence au numéro de la Revue Des Deux Mondes

Exemple
RDDM/numéro de la revue
Chaînefacultatif

Particularités de certains paramètres de {{Document}}Modifier

  • date : un lien automatique vers la catégorie sera créé si la valeur est numérique).
  • dates= : année et mois de publication (pour les revues), sous la forme « 1902/04 », avec un lien vers la catégorie de l’année quand elle existe.
  • dates= : dates de début et de fin de publication, exemple : dates=1909/1911
    • N.-B. : on peut remplacer la date par n’importe quoi, par exemple —, en écrivant date=— (attention toutefois à ne pas remplacer la date par un texte trop encombrant qui risque de modifier l’alignement des colonnes).
  • titre= : titre en français. Le titre devient automatiquement un lien quand la page existe ; mais on peut écrire titre=[[titre de la page{{!}}titre à afficher]].
    • sous-titre : il doit obligatoirement se placer après les deux crochets : titre=[[titre de la page{{!}}titre à afficher]] sous-titre
  • éditions= : utilisable à la place du paramètre titre, pour créer un lien vers une page contenant une liste d’éditions, suivi de [+] pour afficher cette liste directement dans la page auteur.
  • traductions= : utilisable à la place du paramètre titre, pour créer un lien vers une page contenant une liste de traductions, suivi de [+] pour afficher cette liste directement dans la page auteur.
    • affichage des éditions [+] : disponible uniquement si le gadget Auteur est activé dans vos préférences
  • export : affiche trois icônes cliquables pour télécharger un livre aux formats ePub, PDF et mobi depuis une page Auteur ou d’éditions multiples. On peut ajouter « export » seul, quand le paramètre « titre » est le titre exact de la page. Si ce n’est pas le cas, il faut obligatoirement spécifier ce titre : « export=titre ». Voir Catégorie:Bon pour export pour les critères d’utilisation.

Colonne libreModifier

Un paramètre divers= permet en outre de définir sa propre colonne. Cette colonne est dans tous les cas ajoutée tout à droite de la liste.

Autres paramètresModifier

Trois paramètres d’affichage peuvent être utilisés avec {{Liste documents début}} : class, rules et largeur.

  • Avec le paramètre class, on peut désactiver le tri :

{{Liste documents début|class=unsortable}}

  • Le paramètre rules permet d’afficher des lignes à l’intérieur des listes. Par exemple, rules=rows donnera un affichage plus lisible pour des listes bibliographiques détaillées (exemple).
  • Le paramètre largeur définit en pourcentage la largeur de la liste.

Comment utiliser le triModifier

Les boutons de tri permettent de consulter la liste des textes par ordre chronologique et antéchronologique, par ordre alphabétique des titres, et par ordre alphabétique des auteurs et des titres originaux quand ces colonnes existent.

Les tris se font directement sur les paramètres date, titre, auteur et vo. Quand le paramètre livre est utilisé, le tri se fait également d’après le paramètre titre.

Pour que le tri fonctionne bien, il faut veiller à indiquer pour chaque ligne une date et un titre, et pour éviter de mélanger les éditions, on pourra utiliser le paramètre éditions plutôt que de faire la liste dans la page auteur (ce paramètre n’est pour le moment pas en fonction par défaut). Dans le cas où la fonction de tri est inutilisable, on pourra la désactiver en ajoutant class=unsortable dans {{Liste documents début}}.

Si un titre commence par un article, il sera trié d’après cet article. Pour qu’il soit trié correctement (dans le cas des articles le, la, les), il faut utiliser le paramètre titre alpha.

Utilisation détaillée et exemplesModifier

Exemple 1 - normalModifier

Code wiki Rendu

{{liste documents début}}

{{document| date=1758 |titre= Exemple 1 | avancement=}}

{{document| date=1760 |titre= Exemple 2 | avancement=4}}

{{document| date= |éditions= éditions= Arsène Lupin contre Herlock Sholmès | avancement=4}}

[…]

{{liste documents fin}}

 Titre et éditions
1758 :  Exemple 1 
1760 :  Exemple 2 Relu et corrigé
Plusieurs éditions disponibles
Arsène Lupin contre Herlock Sholmès Relu et corrigé Voir et modifier les données sur Wikidata

Exemple 2 - Titre et éditionsModifier

  • Colonne Titre et éditions
Code wiki Rendu
Le nom de la colonne des œuvres est par défaut Titre et éditions. Pour changer ce nom, par exemple pour faire une liste d’articles :
{{liste documents début|type=Articles}}
Articles
1758 :  Exemple 1 
Pour supprimer le titre :
{{liste documents début|type=}}
1758 :  Exemple 1 Relu et corrigé
Pour ajouter des colonnes prédéfinies
Des colonnes prédéfinies peuvent être ajoutées pour les titres originaux, les auteurs d’une liste bibliographique, des liens vers des fac-similés. Ces colonnes s’activent en ajoutant des paramètres dans {{liste documents début}}.
Liste des colonnes prédéfinies :
  • liste avec les titres originaux, utiliser : {{liste documents début|vo}}
  • liste bibliographique sur un auteur, utiliser : {{liste documents début|auteur}}
  • liste bibliographique sur un auteur avec les titres originaux, utiliser : {{liste documents début|vo|auteur}}
  • liste simple, date + titre, livre ou éditions, avec liens externes (uniquement Gallica, Internet Archive ou Google Livres) vers un fac-similé : {{liste documents début|scan}}
  • liste avec une colonne genre : fonctionne avec vo et scan (mais pas avec auteur), par exemple : {{liste documents début|vo|scan|genre}}
Deux remarques importantes :
Quand on ajoute plus d’une colonne prédéfinie, il faut le faire obligatoirement de l’une ou l’autre de ces manières : vo|auteur|scan, ou vo|scan, ou auteur|scan.
L’ajout de plus d’une colonne oblige à mentionner les paramètres vo, auteur ou scan, même en les laissant vide, ceci pour conserver l’alignement des données de la liste.
 Titre et éditions  Titre original
 Titre et éditions  Auteur
 Titre et éditions  Titre original  Auteur
 Titre et éditions Fac-similé
 Titre et éditions  Titre original  Genre Fac-similé

Exemple 3 - Différents cas de figuresModifier

Différents cas de figure
Code wiki Rendu
Utilisation minimale avec le titre seul

{{document|titre=[[Le Héros]] (première édition)}}

Pour indiquer seulement une date et un titre

{{document|date=1637|titre=Le Héros}}

Pour ajouter un lien vers un index (espace « Livre »)

{{document|date=1838|titre=Éloge historique de Jean-Antoine Chaptal|livre=Mémoires de l’Académie des sciences, Tome 15.djvu}}

ou, pour afficher un autre titre que le lien :

{{document|date=1882|titre=[[Ainsi parlait Zarathoustra{{!}}Ainsi parlait Zarathoustra, Albert 1901]]|livre=Nietzsche - Ainsi parlait Zarathoustra (trad. Albert, 1903).djvu}}

Pour le classement alphabétique correct d’une œuvre dans la liste

{{document|date=1637|titre=Le Héros|titre alpha=Héros}}

Pour ajouter le titre original

{{document|date=1637|titre=Le Héros|titre alpha=Héros|vo=''El Héroe''}}

Pour ajouter l’avancement

{{document|date=1637|titre=Le Héros|titre alpha=Héros|vo=''El Héroe''|avancement=2}}

 Titre et éditions  Titre original
Le Héros (première édition)  
1637 :  Le Héros 
1838 : 
Open book nae 02.svg
Éloge historique de Jean-Antoine Chaptal  Voir et modifier les données sur Wikidata
1882 : 
Open book nae 02.svg
Ainsi parlait Zarathoustra, Albert 1901  Relu et corrigé Voir et modifier les données sur Wikidata
1637 :  Le Héros 
1637 :  Le Héros  El Héroe
1637 :  Le Héros Texte complet non-formaté El Héroe

Exemple 4 - en contexteModifier