Manuel:Pywikibot/pagefromfile.py

pagefromfile.py est un script Pywikibot utilisé pour téléverser des pages sur un wiki à partir d'un fichier texte.

Ce robot tire son entrée du fichier texte UTF-8 qui contient un certain nombre de pages à mettre sur le wiki. Les pages doivent toutes avoir le même texte de début et de fin (qui ne peut pas se replier). Par défaut, le texte de début et de fin n'est pas téléversé avec le contenu de la page.

Un nom de page est par défaut récèupéré à partir du premier bloc de texte du contenu de la page qui est marqué en gras (encadré par ''' et '''). Si vous vous souhaitez que le titre de la page ne soit pas présent dans le texte ni balisé par différents marqueurs, utilisez les paramètres -titlestart, -titleend et -notitle.

Arguments spécifiques

Paramètre	Description
-file:xxx	Nom du fichier de où nous avons tiré de nos informations; valeur par défaut : dict.txt. Notice that if the source file name contains any space character, you should wrap it with double quotations (i.e. -file:"Page title").
-begin:xxx	Texte qui marque le début d'une page, la valeur par défaut est {{-start-}}
-end:xxx	Le texte qui marque la fin de la page, la valeur par défaut est {{-stop-}}
-include	Inclure les marqueurs de début et de fin à la page
-textonly	Le texte est passé sans balise. Un seul texte de page est fourni. Les options -begin et -end sont ignorées.
-titlestart:xxx	Texte utilisé à la place de ''' pour identifier le début d'un titre de page
-titleend:xxx	Texte utilisé à la place de ''' pour identifier la fin du titre de page
-notitle	Dans la page, ne pas inclure son titre, ni le début ni la fin de celui-ci. Peut être utilisé pour spécifier le titre unique de la page au-dessus du contenu de celle-ci
-title:xxx	Le titre de la page est donné directement. Ignore les options -titlestart, -titleend et -notitle
-nocontent:xxx	Si la page existante contient la déclaration spécifique, la page n'est pas prise en compte pour la modification
-noredirect	Ne pas téléverser sur des pages de redirection
-summary:xxx	Texte utilisé comme résumé de modification pour le téléversement. Si la page existe, les messages standard pour l'ajout avant, après ou en remplacement sont concaténés après elle
-autosummary	Utiliser le résumé automatique de MediaWiki lors de la création d'une nouvelle page, réécrase -summary
-minor	Positionne la marque modification mineure sur les modifications de la page
-showdiff	Afficher la différence entre la page actuelle et la page à téléverser, oblige également le robot à demander la confirmation à chaque modification

Si la page à téléverser existe déjà, elle est sautée par défaut. Mais vous pouvez modifier ce comportement si vous voulez :

Paramètre	Description
-appendtop	Ajoute le texte au début de la page existante
-appendbottom	Ajoute le texte à la fin de la page existante
-force	Réécrase la page existante

Il est possible de définir un séparateur après les modes append qui est ajouté entre le texte existant et le nouveau texte. Par exemple le paramètre -appendtop:foo ajouterait 'foo' entre eux. Une nouvelle ligne peut être ajoutée entre eux en spécifiant '\n' comme une valeur.

Exemples

Exemple de base

Dans sa forme la plus basique, pagefromfile prend un seul fichier texte avec plusieurs pages wiki en tant qu'entrée. Par exemple le contenu pourrait être :

{{-start-}}
'''Pywikibot''' est une bibliothèque ''Python'' et une collection de scripts qui automatisent le travail sur les sites MediaWiki.
Initialement conçu pour Wikipedia, il est maintenant utilisé dans tous les projets de la Fondation Wikimedia et sur de nombreux autres wikis.
{{-stop-}}
{{-start-}}
'''AutoWikiBrowser''' (souvent abgrégé en  '''AWB''') est un éditeur MediaWiki semi-automatisé conçu pour réaliser plus rapidement et plus facilement des tâches d'édition fastidieuses ou répétitives.
{{-stop-}}

Enregistrer ceci en tant que fichier texte encodé UTF-8, par exemple comme 'pages.txt'. Vous pouvez ensuite exécuter python pwb.py pagefromfile -showdiff -file:pages.txt. Ceci permettra au robot de créer Pywikibot et AutoWikiBrowser -- les premiers éléments '''en gras''' dans les deux pages. -showdiff permet de relire les modifications avant qu'elles ne soient réalisées.

Différents titres de page

Souvent le premier élément en gras n'est pas nécessairement le titre correct de la page. Nous voudrions par exemple à la place, mettre l'article concernant AutoWikiBrowser sur AWB . Pour faire cela, ajouter une ligne devant chaque article, avec le titre correct de la page encadré de trois apostrophes (c'est à dire en gras) :

{{-start-}}
'''Pywikibot'''
'''Pywikibot''' est une bibliothèque ''Python'' et une collection de scripts qui automatisent le travail sur les sites MediaWiki.
Initialement conçu pour Wikipedia, il est maintenant utilisé dans tous les projets de la Fondation Wikimedia et sur de nombreux autres wikis.
{{-stop-}}
{{-start-}}
'''AWB'''
'''AutoWikiBrowser''' (souvent abgrégé en  '''AWB''') est un éditeur MediaWiki semi-automatisé conçu pour réaliser plus rapidement et plus facilement des tâches d'édition fastidieuses ou répétitives.
{{-stop-}}

et ajouter le paramètre -notitle dans l'appel, par exemple : python pwb.py pagefromfile -showdiff -file:pages.txt -notitle .

Arguments globaux disponibles

Ces options remplaceront celles définies dans le fichier de configuration user-config.py .

Options globales

Paramètre	Description	Nom du paramètre de configuration dans user-config.py
-dir:PATH	Lit les données de configuration du robot dans le dossier donné par PATH, au lieu du dossier par défaut.
-config:fichier	Nom du fichier de configuration utilisateur. Default is user-config.py.	user-config.py
-lang:xx	Définit la langue du wiki sur lequel vous voulez travailler, en outrepassant la configuration de user-config.py. xx doit être le code de la langue (exemple : fr).	mylang
-family:xyz	Définit la famille du wiki sur lequel vous voulez travailler, tel que wikipedia, wiktionary, wikitravel... Cela outrepassera la configuration de user-config.py.	family
-user:xyz	Se connecter en tant qu'utilisateur xyz au lieu du nom d'utilisateur par défaut.	usernames
-daemonize:xyz	Rend le contrôle immédiatement au terminal et redirige la sortie standard (stdout) et la sortie en erreur (stderr) vers le fichier xyz (seulement utilisé pour les robots qui n'ont pas besoin de l'entrée standard (stdin) ).
-help	Affiche le texte d'aide.
-log	Active l'enregistrement des journaux de connexion, en utilisant le nom de fichier par défaut "nom_du_script-bot.log" dans le sous dossier logs.	log
-log:xyz	Active l'enregistrement des logs dans un fichier avec xyz pour nom.	logfilename
-nolog	Désactive l'enregistrement des logs (activé par défaut)
-maxlag	Définir le maxlag, en secondes. Reporte les modifications du robot lors de périodes de latence du serveur. La valeur par défaut est celle de config.py.	maxlag
-putthrottle:n -pt:n -put_throttle:n	Définit le temps minimum (en secondes) que le robot doit attendre entre deux enregistrements de pages.	put_throttle
-debug:item -debug	Active le fichier de log et incluant plus particulièrement les données de débogage pour l'élément item (1er cas) ou pour tous les éléments (2nd cas)	debug_log
-verbose -v	Demande au robot d'être plus verbeux ce qui peut aider pour le débogage.	verbose_output
-cosmeticchanges -cc	Inverse et outrepasse la valeur du paramètre cosmetic_changes de config.py ou de user-config.py (l'active si rien n'est mentionné dans ces fichiers). Tous les autre paramètres et restrictions restent inchangés.	cosmetic_changes
-simulate	Désactiver l'écriture sur serveur. Utile pour les tests et le débogage de nouveau code (si utilisé, ne fait aucun changement réel, mais montre ce qui aurait été changé).	simulate
-<variable de configuration>:n	Vous pouvez utilisez toutes les variables numériques de configuration données en tant qu'options et les modifier avec une ligne de commande.