Outil Book
Cette page est conservée pour son intérêt historique. Les règles mentionnées peuvent ne plus être d’usage. Si vous voulez relancer le sujet, vous pouvez utiliser la page de discussion ou commencer une nouvelle discussion sur le forum de la communauté. |
Il est prévu de déployer la Collection Extension dans un plus grand nombre de projets WMF, ce qui permet le classement d'article et la conversion en PDF. Cette page a pour but de guider les communautés pour un déploiement réussi de cette extension. Elle se concentre ainsi sur Wikipedia et ses différentes langues. Pour avoir une idée sur la façon dont cet outil fonctionne visitez en.wikipedia.org et cherchez "Imprimer/exporter" > "créer un livre" dans la barre latérale.
Introduction
Cet outil permet aux utilisateurs d'organiser des sélections de pages personnelles dans un livre. Les livres peuvent être:
- edité & structuré en utilissant les chapitres
- permanent & chargé, partagé
- transformé en PDF (exemple)
- exporté comme document texte ODF
- commandé en tant que livre imprimé avec PediaPress (exemple)
Voir l'extrait de presse Wikis Go Printable pour plus d'informations sur ce projet.
L'extension a été testée sur *.wikibooks.org depuis Octobre 2008 et tourne sur le Wikipedia allemand depuis le 27 Janvier 2009. D'autres déploiements sont prévus.
Comment faire
Peut être visitez vous cette page depuis que vous avez éré informé que votre Wikipedia va implémenter cette extension bientôt. Quelques éléments doivent être configurés et ces pages (voir toutes) essaient de vous servir de guide.
- Traduction de l'aide. Il y a quatre pages d'aide qui doivent être traduites. Voir #Pages used by this extension pour les suggestions sur où créer ces pages dans votre wiki.
- Traduction de la page d'aide condensée de l'outil Book
- En ce qui concerne la page des retours utilisateur, il y aura probablement beaucoup de messages et vous devez trouver une manière de filtrer et de rediriger les problèmes traduits vers la page anglaise Feedback sur le meta. Pour plus d'information, voir
#Reporting Bugs, Collecting Feedback & Getting Help. En plus de cela, plusieurs utilisateurs se servent souvent de la page de discussion de l'Aide pour disserter sur l'outil, et non pas sur l'Aide.
- Un lien vers la page des feedbacks, au début des pages de discussion résoud cela.
- Remarque pour les traducteurs: attribuer à cette extension un disque de test sur http://simple.wikipedia.org pour avoir une meilleure compréhension des fonctions et des concepts utilisés avec cette extension. Ayez aussi présent à l'esprit que quand vous traduisez le mot "page" il peut représenter une page wiki (ou un article) tout comme une page d'un PDF ou d'un livre imprimé.
- Créer d'autres pages relatives, d'autres catégories et modèles. Le mieux, quand l'extension est déployée, voir #Pages used by this extension.
- Rassembler une liste de modèles dont le contenu ne devra pas apparaitre dans les PDF, voir #Templates to exclude in offline exports.
Une fois que ces actions de base sont réalisées, il existe plusieurs améliorations possibles :
- Consider managing books to the benefit of all users, see #Organizing stored books
- Prepare MainPage for visitors brought by press coverage, see #Preparing MainPage
Contenu
- livre
- se rapporte habituellement à une collection de pages (éventuellement avec des chapitres, des titres, des sous-titres), peut aussi se rapporter à un PDF dérivé, à un livre imprimé ou un livre sauvegardé.
- livre intermédiaire
- une collection d'articles, mémorisés dans la session courante du navigateur. La liste des articles d'un livre intermédiaire peut être vue sur [[Special:Book]].
- livre sauvegardé
- une collection sauvegardée d'articles, permanents sur une page wiki régulière, soit dans le namespace de l'utilisateur ([[User:Name/Books/Bookname]]) soit dans le namespace global ([[Wikipedia:Books/Bookname]]). Les livres enregistrés peuvent être chargés. Ensuite, le livre transitoire n'est qu'une copie du livre enregistré.
- page de livre
- se rapporte habituellement à [[Special:Book]] où tous les articles d'un livre de transition sont listés et le livre peut être modifié, sauvegardé, classé, exporté. Peut aussi s'appliquer à un livre sauvegardé.
- portlet (de livre)
- boîte avec le titre "créer un livre" dans la barre latérale (encapsule les liens 'ajouter/enlever un article'-, 'Montrer le livre (N articles)'-, 'Charger le livre'-, 'effacer le livre'-, 'Aide sur les livres').
- aide sur le livre
- La page [[Help:Books]] redirigée à partir du portlet.
- "exporter hors connexion", "exporter", "impression en cours", "imprimer version", ...
- se rapporte à l'exportation d'un livre soit sous forme digitale (PDF, ODF) ou physique (livre imprimé).
- "Suggestions", "Pages suggérées"
- se rattache à une caractéristique qui suggère des pages qui sont relatives à l'ensemble courant des pages du livre.
Changer la localisation
Essayer d'assimiler les concepts correctement. Par exemple "Visualiser le livre (19 pages)" peut être interprété a tort comme si le PDF avait 19 pages bien que cela soit basé sur les 19 articles et probablement qu'il y aura beacoup plus de pages dans un PDF ou un livre imprimé. Qu'est-ce qu'un livre propre quand on vient de charger un livre sauvegardé qui maintenant est aussi appelé livre intermédiaire?
Si vous avez besoin de modifier les messages, soit vous les changez dans translatewiki.net (ext-collection) (effectif après la prochaine mise à jour du logiciel) ou bien dans le wiki en visitant [[Special:Allmessages]] et en filtrant sur "coll-*" pour voir tous les messages concernés. Un coup d'oeil rapide dans source peut vous aider à trouver le bon identificateur de message en cas de doute.
Note: Le livre des métaphores marche bien sur la plupart des wikis. Mais il ne fonctionne pas sur *.wikibooks.org où il contredit leur concept de livre. Si vous modifiez des traductions dans translatewiki.net il serait bon de notifier tous les projets (e.g. wikibook) qui utilisent le même langage.
La localisation des messages utilisés dans les PDF générés peut aussi être changée dans translatewiki.net (mwlibrl).
- Vérifiaction complémentaire avec translatewiki.net pour s'assurer que tous les messages système utilisés dans cette extension sont traduits dans votre langue.
Pages utilisées par cette extension
Liste des pages, catégories et modèles qui devraient être créés.
Pages
[[Special:Book?bookcmd=book_creator]]
(ne nécessite pas de création)- Une page spéciale d'introduction (la page qui apparait quand un utilisateur tape sur "Créer un livre") qui permet d'autoriser le "créateur de livre" et inclut une petite page d'aide. Le nom de cette page d'aide peut être mis à jour dans
coll-book_creator_text_article
Par défaut il vaut :Help:Books/Book creator text
i.e. une sous-page de la page d'aide qui a été configurée et qui porte le nom "Book creator text". [[Special:Book]]
(ne nécessite pas de création)- Une page spéciale qui autorise toutes les interactions communes sur les livres intermédiaires.
[[Special:Book/rendering]]
(ne nécessite pas de création)- La page de rendu montre une barre de progression pendant que le document est généré. Une fois le rendu terminé, elle donne un lien pour rapatrier le document. Elle peut aussi afficher une erreur si le rendu a échoué. Vous pouvez configurer le texte dans
coll-rendering_text
,coll-rendering_article
,coll-rendering_status
,coll-rendering_page
,coll-rendering_finished_text
,coll-is_cached
,coll-excluded_templates
,coll-blacklisted_templates
. [[Special:Book/load_collection]]
(ne nécessite pas de création)- Utilisé quand on charge des livres sauvegardés. Visible par l'utilisateur seulement si on veut charger un livre alors qu'il y en a déja un d'ouvert dans la session. Le texte peut être configuré dans
coll-load_overwrite_text
,coll-overwrite
,coll-append
,coll-cancel
[[Help:Books]]
- Page d'aide principale (exemple) pour cet outil, reliée à partir du "portlet". Son adresse peut être configurée dans le message système
coll-helppage
- Tous les modèles référencés à partir de cette page seront exclus lors de l'impression. Il est recommandé de ne pas utiliser cette fonction parce que c'est une approche centralisée et inflexible. A la place utiliser le [[Category:Exclude in print]] (voir ci-dessous). L4adresse peut être changée dans
coll-template_blacklist_title
.
Catégories
[[Category:Wikipedia:outil Livre]]
- Utilisé pour sauvegarder toute la documentation avec les pages associées ainsi que les modèles.
[[Category:Wikipedia:Books]]
- Catégorie qui regroupe tous les livres enregistrés. Cette catégorie est spéciale car toutes les pages inclues peuvent être chargées tout comme un livre par un lien "charger le livre" qui apparait dans le portlet quand on visite une page de cette catégorie. Ce qui signifie que les livres enregistrés sont ajoutés automatiquement lorsqu'ils sont créés, tandis que les pages des livres non enregistrés ne devraient pas exister dans cette catégorie. Peut être configuré par
coll-bookscategory
. Probablement vous voudrez changer ce message en "Wikipedia:Books" (la catégorie "Books" est la valeur par défaut). [[Category:Exclude in print]]
- Utilisé pour pister tous les modèles qui insèrent des informations inutiles ou qui perturbe les exportations (voir ci dessous pour vous persuader). Peut être configuré par
coll-exclusion_category_title
.
Modèles
[[Template:Saved book]]
- Ce modèle (exemple) est automatiquement inclus en tête de chaque livre enregistré. Il peut être adapté pour rendre une page du livre enregistré plus attrayante et pour héberger quelques métadata. L'adresse peut être configurée par
coll-savedbook_template
. [[Template:Hide in print]]
- Ce modèle (exemple) retourne toutes les balises qui furent passés dans le premier paramètre (read: ne fait rien). S'il est ajouté au [[Category:Exclude in print]] il permet d'omettre sélectivement le contenu dans les livres imprimés ou les PDF. Très pratique! Vous pouvez appeler cela comme vous le voulez, mais n'oubliez pas de le rajouter à la catégorie et de le documenter/relier dans l'aide de l'expert. Note: Ce modèle a été adopté rapidement et devint l'un des modèles le plus inclus aussi vous pourriez avoir l'envie de le protéger.
[[Template:Only in print]]
et[[Template:PrintOnly in print]]
- Ce modèle (exemple) retourne aucune des balises passées dans le premier paramètre, tandis que le modèle correspondant [[Template:Only in print/Print]] (exemple) retourne les balises passées. Voir Aide pour les experts pour plus de détails sur la sous-page de */Print utilisée pour substituer des modèles lors de l'impression. Le préfixe qui est utilisé pour substituer des modèles lors de l'impression peut être configuré par
coll-print_template_prefix
.
Déclarer le source d'une licence utilisateur
Des communautés peuvent vouloir ajouter un texte supplémentaire à la licence dans le PDF.
La licence qui doit être incluse dans le PDF est configurable en positionnant MediaWiki:Coll-license_url
sur une URL qui pointe vers le simple texte wiki qui sera utilisé pour générer la licence. Par défaut, sur les sites publics Wikimedia ceci est mis à https://creativecommons.org/licenses/by-sa/3.0/
.
Modèles à exclure dans le cas des exportations hors connexion
Il y a beaucoup de modèles avec un contenu qui devraient être exclu dans les versions imprimées. Il y a au moins trois catégories principales :
- Messages de maintenance
- Ils sont inutiles et gênants dans les exportations hors ligne comme on ne peut pas contribuer si on est déconnecté. Exemples: Maintenance, Nettoyage...
- Messages d'avertissement et de trace
- Ils sont inutiles et gênants dans les exportations hors ligne comme l'ont mentionné les utilisateurs quand ils ont sélectionné le contenu et choisi de l'ajouter quand même. Exemples: Source des articles,
Règlement des différents, Suppression, Généralités...
- Contenu navigationnel
- Les liens de navigation sont inutiles et gênants dans les exportations. Exemples: Table des matières compacte, projets frères Wikimedia...
De tels modèles devraient utiliser la classe CSS noprint
.
Il est recommandé d'identifier et d'ajouter plus tôt, les modèles relatifs à cette catégorie - si possible, avant le déploiement.
Dans le Wikipedia allemand, nous avons pu identifier rapidement 130 modèles en regardant les catégories relatives. Nous les avons toutes listées sur une page et nous avons utilisé un robot pour assigner la catégorie. Depuis, seuls 14 modèles ont été identifiés comme ayant besoin d'être rajoutés manuellement.
Remarque: certains modèles servent de modèles pour d'autre modèles. Dans ce cas, il peut suffir d'ajouter ce modèle (parent) à la catégorie; ce qui a pour conséquence d'exclure une classe complète de modèles.
Communiquer la disponiblilité du créateur du livre et des livres imprimés
Il est possible de rendre une page transparente au moment du rendu PDF, page vue par un utilisateur qui choisit Télécharger en tant que PDF. A cette page les utilisateurs (qui sont visiblement dans un état de désir déconnecté) peuvent être présentés au créateur du livre avec l'option de recevoir des livres imprimés.
Voir en:Help:Books/Rendering page info text pour un exemple de cette page sur en.wp et ici pour voir à quoi il ressemble sur une page de rendu PDF.
Si la page existe à l'adresse configurée dans ce message système Coll-rendering_page_info_text_article
(exemple sur en.wp), elle apparaitra sur la page de rendu PDF.
Organiser les livres sauvegardés
Tandis que plusieurs pourraient se réjouir de créer leurs propres livres, d'autres seraient ravis s'ils pouvaient accéder aux livres directement sur certains sujets.
La page [[Wikipedia:Books]] peut être utilisée pour promouvoir la disponibility et l'accès aux livres enregistrés. Il n'y a pas encore beaucoup d'expérience sur ce sujet mais les quelques idées qui émergent sont listées dans les sous-sections ci-dessous.
Promouvoir la céation de livres
- Fournir un guide sur comment créer de "grands livres"
- comment choisir un titre approprié;
- comment inclure une préface;
- comment choisir les articles;
- nombre recommandé d'articles.
- Developper des guides pour les livres qui sont autorisés à exister dans le namespace global. Ce qui pourrait nécessiter (exemples) :
- nombre raisonnable d'articles inclus(e.g. plus de 5 moins de 200);
- avoir un titre significatif, un sous-titre
- ciblé un sujet;
- qualité raisonnable des articles inclus (e.g. non litigieux, provisoires, candidats à la supression, etc.).
- Coordonner les sujets.
Rendre les livres accessibles
- Lister quelques livres de la semaine, du mois, de l'année.
- Etiqueter et commenter les excellents livres.
- Attacher aux articles, catégories ou portails concernés, une boîte "Il existe un livre sur ce sujet".
- Liens ou parties rapportées de l'étagère A-Z.
Etagère
Les livres enregistrés sont listés dans la catégorie [[Category:Wikipedia:Books]], mais celle-ci devient rapidement pleine (le de.wp atteint près de 1.000 livres enregistrés - la plupart dans l'espace utilisateur - et a été créé en l'espace de 10 jours). De plus, la liste par catégorie ne permet pas de voir les métadata ou d'accéder aux livres par sujet. Il serait possible de relier les livres aux catégories mais cela encombrerait les catégories principales avec des livres ou nécessiterait/résulterait en une réplication de l'arbre des catégories dans un namespace différent.
Il existe un robot qui peut générer automatiquement une étagère ce qui permet de rechercher des livres par titre (A-Z) ou par mot-clés. Bien sûr, une étagère peut aussi être créée manuellement. Allez voir la page sur l' étagère pour plus de détails sur l'approche par robot.
Préparation de la page principale
Les pages principales qui font suite aux portails sont spéciales car elles utilisent souvent un affichage web multicolonne. De telles pages ont réellement un mauvais aspect dans les rendus PDF (contraintes de largeur fixe des pages en format portrait). Mais là encore, c'est la page que presque tout nouvel utilisateur de l'outil, va ajouter en premier dans son livre.
Une manière d'éviter la déception prématurée et de préparer la page principale afin qu'elle soit plus présentable dans les PDF. C'est possible en utilisant le [[Hide in print]] template de telle sorte que la page principale (lors de l'impression) ne contienne aucune table ou ne soit constituée que d'une colonne. (FIXME:example)
Un autre problème est la visibilité du portlet. Les visiteurs (pas vous) du Wikipedia ignorent tout simplement la barre latérale. S'il y avait une notice à propos de cette nouvelle fonctionalité, cela pourrait les aider, avec un lien vers la page d'aide à partir de la boîte "Nouvelles concernant Wikipedia" de la page principale (si cette boîte existe) et ceci pour une durée limitée.
Signaler les bogues, prendre en compte les retours utilisateurs et obtenir de l'aide
dans le wiki
Il existe une page des retours utilisateur centrale sur le meta (en anglais) dont le but est de recueillir toutes les demandes d'évolution, les suggestions, les bogues signalés, les questions, etc. Les Wikipedias non anglais peuvent vouloir utiliser une page similaire (exemple) sur leur wiki et définissent une police sur quand et comment les problèmes sont traduits et remontés sur la page des retours utilisateurs du meta.
Suivi des bogues
Utiliser le composant "Collection" sur bugzilla.
IRC
Il existe un canal IRC #pediapress pour ce qui a rapport à l'outil Book.
Expérience des déploiements passés
Wikipedia allemand
Ce qui a marché: la recette de l'outil a été la plupart du temps positive. Beaucoup de livres enregistrés ont été créés dans une courte période de temps. Les Media ont rapidement couvert ce sujet une fois qu'un communiqué de presse émanant du chapitre Allemand soit sorti.
Ce qui ne marchait pas: On avait envisagé de limiter le nouvel outil aux utilisateurs connectés durant la première semaine. Mais en quelque sorte, ce plan n'a pas été appliqué. Finalement, la fonction a été activée alors que la documentation et la localisation n'étaient pas vraiement terminées. Pour certains utilisateurs, le portlet n'apparaissait pas sur quelques pages, probablement à cause du cache. La page principale ne disposait pas de l'option d'impression conviviale. Finalement, il y a eu un effet boomrang après que le populaire magazine d'actualités allemand en ligne Heise ait couvert l'histoire. Le serveur de rendu s'est effondré (charge près de 300) au lieu de servir les visiteurs.
Mises à jour
Les mises à jour - spécialement celles qui nécessitent l'attention de la communauté - seront annoncées ici.
- October 2014: Book tool bug day.
- September 2014: statistics for sales have been updated till the end of 2013, at [1].
- 2013–2014 – See mw:PDF rendering and talk page for updates.
- 3 Mar 2009 – PDF-server update & ColExt update
- Important Change: The template substitution was changed from a prefix to a suffix */Print. The license to be included in the PDF is now configurable by setting
MediaWiki:Coll-license_url
- updated to mwlib release 0.9.11 (changelog)
- updated to mwlib.rl release 0.9.8 (changelog)
- Collection-Extension was updated to trunk (changelog)
- Important Change: The template substitution was changed from a prefix to a suffix */Print. The license to be included in the PDF is now configurable by setting
- 19 Feb 2009 – PDF-server update & ColExt update
- 8 Feb 2009 – PDF-server update
- 27 Jan 2009 – PDF-server & ColExt update
mwlib + mwlib.rl are used for rendering documents, Collection-Extension implements the UI in Mediawiki