Příručka:Pywikibot/pagefromfile.py

pagefromfile.py je skript Pywikibota používaný k nahrávání stránek na wiki z textového souboru.

Tento robot bere svůj vstup z textového souboru UTF-8, který obsahuje několik stránek, které mají být umístěny na wiki. Všechny stránky by měly mít stejný začátek a konec textu (který se nesmí překrývat). Počáteční a koncový text není ve výchozím nastavení nahrán s obsahem stránky.

Název stránky je ve výchozím nastavení převzat z prvního textového bloku obsahu stránky, který je označen tučně (zalomený mezi ''' a '''). Pokud očekáváte, že název stránky nebude v textu uveden nebo označen jinými značkami, použijte parametry -titlestart, -titleend a -notitle.

Specifické parametry

Parametr	Popis
-file:xxx	Název souboru, ze kterého získáváme náš materiál, výchozí hodnota je "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	Text, který označuje začátek stránky, výchozí hodnota je "{{-start-}}"
-end:xxx	Text, který označuje konec stránky, výchozí hodnota je "{{-stop-}}"
-include	Přidejte na stránku značky začátku a konce
-textonly	Text je uveden bez značek. Je uveden pouze text na jedné stránce. Možnosti -begin a -end jsou ignorovány.
-titlestart:xxx	Text použitý místo ''' pro identifikaci začátku názvu stránky
-titleend:xxx	Text použitý místo ''' pro identifikaci konce nadpisu stránky
-notitle	Nevkládejte na stránku název stránky, včetně titlestartu a titleendu. Lze použít k určení jedinečného názvu stránky nad obsahem stránky
-title:xxx	Název stránky je uveden přímo. Ignoruje možnosti -titlestart, -titleend a -notitle
-nocontent:xxx	Pokud existující stránka obsahuje zadaný příkaz, stránka se z úprav vynechá
-noredirect	Nenahrávejte na stránky s přesměrováním
-summary:xxx	Text použitý jako souhrn úprav pro nahrání. Pokud stránka existuje, jsou za ni připojeny standardní zprávy pro předřazení, připojení nebo nahrazení
-autosummary	Při vytváření nové stránky použijte autosummary MediaWiki, přepíše -summary
-minor	Nastavte příznak drobných úprav při úpravách stránky
-showdiff	Zobrazit rozdíl mezi aktuální stránkou a stránkou k nahrání, také přinutí robota požádat o potvrzení při každé úpravě

Pokud stránka k nahrání již existuje, je ve výchozím nastavení přeskočena. Toto chování však můžete přepsat, pokud chcete:

Parametr	Popis
-appendtop	Přidejte text do horní části stávající stránky
-appendbottom	Přidejte text na konec stávající stránky
-force	Přepsat existující stránku

Za režimy 'append' je možné definovat oddělovač, který je přidán mezi stávající a nový text. Například parametr -appendtop:foo by mezi ně přidal 'foo'. Mezi ně lze přidat nový řádek zadáním hodnoty '\n'.

Příklady

Základní ukázka

V nejzákladnější formě, pagefromfile bere jako vstup jeden textový soubor s několika wiki stránkami. Obsah může být například:

{{-start-}}
'''Pywikibot''' je knihovna Pythonu a sbírka skriptů, které automatizují práci na stránkách MediaWiki.
Původně byl navržen pro Wikipedii, nyní se používá v projektech Wikimedia Foundation a na mnoha dalších wikinách.
{{-stop-}}
{{-start-}}
'''AutoWikiBrowser''' (často zkráceně '''AWB''') je poloautomatický editor MediaWiki navržený tak, aby zrychlil a usnadnil únavné nebo opakující se úpravy.
{{-stop-}}

Uložte to jako textový soubor s kódováním UTF-8, například jako 'pages.txt'. Poté můžete spustit python pwb.py pagefromfile -showdiff -file:pages.txt. To robotovi umožní vytvořit Pywikibot a AutoWikiBrowser – první '''bolded''' prvky na obou stránkách. -showdiff vám dá příležitost zkontrolovat změny před jejich provedením.

Různé názvy stránek

První tučný prvek často nemusí být nutně správný název stránky. Místo toho bychom mohli například chtít umístit článek o AutoWikiBrowser na AWB. Chcete-li to provést, přidejte před každý článek řádek se správným názvem stránky mezi trojitými uvozovkami (tj. tučně):

{{-start-}}
'''Pywikibot'''
'''Pywikibot''' je knihovna Pythonu a sbírka skriptů, které automatizují práci na stránkách MediaWiki.
Původně byl navržen pro Wikipedii, nyní se používá v projektech Wikimedia Foundation a na mnoha dalších wikinách.
{{-stop-}}
{{-start-}}
'''AWB'''
'''AutoWikiBrowser''' (často zkráceně '''AWB''') je poloautomatický editor MediaWiki navržený tak, aby zrychlil a usnadnil únavné nebo opakující se úpravy.
{{-stop-}}

a do volání přidejte parametr -notitle, tj.: python pwb.py pagefromfile -showdiff -file:pages.txt -notitle.

Dostupné globální parametry

Tyto možnosti přepíší konfiguraci v nastavení user-config.py .

Globální parametry

Parametr	Popis	Proměnná konfigurace
-dir:PATH	Čtěte konfigurační data robota z adresáře daného PATH namísto z výchozího adresáře.
-config:file	Název souboru konfigurace uživatele. Default is user-config.py.	user-config.py
-lang:xx	Nastavte jazyk wiki, na kterém chcete pracovat, a přepište konfiguraci v user-config.py. xx by měl být kód jazyka.	mylang
-family:xyz	Nastavte rodinu wiki, na které chcete pracovat, např. wikipedie, wikislovník, wikitravel, ... Tím přepíšete konfiguraci v user-config.py.	family
-user:xyz	Přihlaste se jako uživatel 'xyz' namísto výchozího uživatelského jména.	usernames
-daemonize:xyz	Okamžitě vraťte řízení do terminálu a přesměrujte stdout a stderr do souboru xyz. (použijte pouze pro roboty, které nevyžadují žádný vstup z stdin).
-help	Zobrazí text nápovědy.
-log	Povolte soubor protokolu pomocí výchozího názvu souboru 'script_name-bot.log' Protokoly budou uloženy v podadresáři logs.	log
-log:xyz	Povolte soubor protokolu pomocí 'xyz' jako názvu souboru.	logfilename
-nolog	Zakázat soubor protokolu (pokud je ve výchozím nastavení povolen).
-maxlag	Nastaví nový parametr maxlag na počet sekund. Odložte úpravy bota během období zpoždění databázového serveru. Výchozí hodnota je nastavena na config.py	maxlag
-putthrottle:n -pt:n -put_throttle:n	Nastavte minimální dobu (v sekundách), po kterou bude robot čekat mezi ukládáním stránek.	put_throttle
-debug:item -debug	Povolte soubor protokolu a zahrňte rozsáhlá ladicí data pro komponentu "item" (pro všechny komponenty, pokud je použit druhý formulář).	debug_log
-verbose -v	Nechte robota poskytnout další výstup konzoly, který může být užitečný při ladění.	verbose_output
-cosmeticchanges -cc	Přepne nastavení cosmetic_changes provedené v config.py nebo user-config.py na jeho inverzní hodnotu a potlačí jej. Všechna ostatní nastavení a omezení zůstávají nedotčené.	cosmetic_changes
-simulate	Zakáže zápis na server. Užitečné pro testování a ladění nového kódu (pokud je zadán, neprovádí žádné skutečné změny, ale ukazuje pouze to, co by se změnilo).	simulate
-<proměnná nastavení>:n	Všechny dané číselné konfigurační proměnné můžete použít jako volbu a upravit je pomocí příkazového řádku.