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ètre | Description | Type | Statut | |
|---|---|---|---|---|
| Date de publication | date | Peut contenir une valeur différente ex : Inc. ou 195?
| Chaîne | facultatif |
| Dates de début et de fin | dates | Dates séparées par /
| Chaîne | facultatif |
| Éditions multiples | éditions | Nom de la page contenant la liste avec ou sans [titre alpha]
| Chaîne | facultatif |
| Traductions multiples | traductions | Nom de la page contenant la liste des traductions avec ou sans [titre alpha] | Chaîne | facultatif |
| Titre de l’œuvre | titre | Texte ou [lien suivi d’une description] avec ou sans [titre alpha]
| Chaîne | obligatoire |
| Nom du fac-similé | livre | Page index sans le préfixe ''Livre''
| Chaîne | facultatif |
| Avancement | avancement | Valeur de 1 à 5 ; 5 correspond à validé | Nombre | facultatif |
| Icônes pour exportations | export | Nom de la page à exporter si différent de l’argument titre
| Chaîne | facultatif |
| Titre original | vo | Titre lors du lancement si différent avec ou sans [vo alpha] | Chaîne | facultatif |
| Auteur | auteur | Nom de l’auteur ou co-auteur avec ou sans [auteur alpha] | Chaîne | facultatif |
| Genre | genre | Genre de l’ouvrage
| Chaîne | facultatif |
| Source | scan | lien URL | URL | facultatif |
| Divers | divers | Champ libre avec ou sans [divers alpha] | Chaîne | facultatif |
| Revue | revue | Référence au numéro de la Revue Des Deux Mondes
| Chaîne | facultatif |
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=rowsdonnera 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
- On place
{{liste documents début}}au début de la liste et{{Liste documents fin}}à la fin de la liste :
| 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=Arsène Lupin contre Herlock Sholmès | avancement=4}}
{{liste documents fin}} |
|
Exemple 2 - Titre et éditionsModifier
- Colonne Titre et éditions
| Code wiki | Rendu | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
{{liste documents début|type=Articles}}
|
| ||||||||||||||||||
{{liste documents début|type=}}
|
| ||||||||||||||||||
|
|
Exemple 3 - Différents cas de figuresModifier
- Différents cas de figure
| Code wiki | Rendu |
|---|---|
|
Exemple 4 - en contexteModifier
- Voir un exemple complet : Auteur:Baltasar Gracián