Zobrazení zdroje stránky Fórum:ParcervenychBot.py (dokumentace)

Tato stránka je dokumentace bota [[Uživatel:ParcervenychBot|ParcervenychBot]], jehož zdrojový kód je umístěn na [[MediaWiki:ParcervenychBot.py]]. Tento bot v žádném případě neaspiruje na to, aby byl profesionálně a dokonale naprogramován.

== Editace, které bot provádí ==
Bot provádí automatické úpravy textu článků v hlavním [[Fórum:Jmenné prostory|jmenném prostoru]], ve jmenném prostoru ''Fórum'', ''WikiSkripta'' a ''Nápověda''  podle přesně formulovaných kriterií. Jedná se o
* úpravu obsahu článků &mdash; funkce <tt>check_page_content(pageTitle)</tt> &mdash;, zaměňují se nesprávně zapsaný název projekt &bdquo;WikiSkripta&ldquo; (absence camelcase), špatně použité znaky pro spojovník pomlčkou, tři tečky za znak pro výpustku a anglické uvozovky českými,
* přidávání redakční šablony &mdash; funkce <tt>add_redaction_template(pageTitle)</tt> &mdash; diskusním stránkám článků z hlavního prostoru, v nichž chybí.

Pro každý z těchto úkolů je vyhrazen editační limit maximálního počtu editací při jednom spuštění bota (proměnná <tt>editLimit</tt>).

'''Pokud text prošlý níže popsanými procesy není shodný s textem původním, dojde k editaci. V opačném případě k editaci nedochází.'''

=== „Wikiskripta“ → „WikiSkripta“, „wikiskripta“ → „WikiSkripta“ ===
Nejprve dojde k záměně všech sekvencí obsahujících „wikiskripta“ nebo „Wikiskripta“ za „WikiSkripta“, posléze dojde k záměně „wikiskripta.eu“ za „wikiskripta.eu“.

=== Spojovník → pomlčka ===
Pokud
* se na stránce nachází sekvence „ - “ (mezera &mdash; spojovník &mdash; mezera),
* není zde tag <tt><nowiki><gallery></nowiki></tt>,
* není zde tag <tt><nowiki><pre></nowiki></tt> a
* není zde tag <tt><nowiki><source></nowiki></tt>,
dojde k nahrazení „ - “ za „ &ndash; “ a pak se v původním textu naleznou všechny
* odkazy (text uvozený „<nowiki>[[</nowiki>“ a „<nowiki>]]</nowiki>“),
* matematické vzorce (text uvozený „<tt><nowiki><math></nowiki></tt>“ a „<tt><nowiki></math></nowiki></tt>“),
* texty uvozené tagy „<tt><nowiki><nowiki></nowiki></tt>“ a „<tt><nowiki></nowiki></nowiki></tt>“ a
* texty uvozené tagy „<tt><nowiki><code></nowiki></tt>“ a „<tt><nowiki></code></nowiki></tt>“,
u nichž dojde k ekvivalentní záměně „ - “ za „ &ndash; “ a pak zpětnému nahrazení těchto fragmentů v textu stránky.

=== „...“ → „…“ ===
Pokud
* se na stránce nachází sekvence „...“ (tři tečky),
* není zde tag <tt><nowiki><gallery></nowiki></tt>,
* není zde tag <tt><nowiki><pre></nowiki></tt> a
* není zde tag <tt><nowiki><source></nowiki></tt>,
dojde k nahrazení „...“ za „…“ a pak se v původním textu naleznou všechny
* odkazy (text uvozený „<nowiki>[[</nowiki>“ a „<nowiki>]]</nowiki>“),
* matematické vzorce (text uvozený „<tt><nowiki><math></nowiki></tt>“ a „<tt><nowiki></math></nowiki></tt>“),
* texty uvozené tagy „<tt><nowiki><nowiki></nowiki></tt>“ a „<tt><nowiki></nowiki></nowiki></tt>“ a
* texty uvozené tagy „<tt><nowiki><code></nowiki></tt>“ a „<tt><nowiki></code></nowiki></tt>“,
u nichž dojde k ekvivalentní záměně „...“ za „…“ a pak zpětnému nahrazení těchto fragmentů v textu stránky.

=== "*" → „*“ ===
Pokud
* se na stránce nachází anglické uvozovky,
* nejsou zde nikde na stránce české (pravé české uvozovky využívají stejný znak jako anglické levé, což by při záměnách dělalo neplechu),
* není zde tag <tt><nowiki><gallery></nowiki></tt>,
* není zde tag <tt><nowiki><pre></nowiki></tt> a
* není zde tag <tt><nowiki><source></nowiki></tt>,
je každý text uvozený anglickými uvozovkami nahrazen stejným textem uvozeným českými uvozovkami &mdash; '''v případě, že tyto uvozovky těsně nepředchází znak pro rovnítko'''. (Zabrání se tak nahrazování uvozeného textu ve zdrojovém kódu HTML, CSS a JavaScriptu.)

Zároveň je zde připojen cyklus, který prochází všechny možné části uvozeného textu rozděleného dle případných dalších uvozovek a provádí další případné náhrady, jelikož regulární výrazy v Pythonu neprovádí nejkratší možný match, nýbrž nejdelší.

=== Redakční šablona ===
Pokud
* vlastní článek neobsahuje text „<tt><nowiki>{{Pracuje se</nowiki></tt>“,
* vlastní článek neobsahuje text „<tt><nowiki>{{Rozcestník</nowiki></tt>“,
* vlastní článek obsahuje více než 100 znaků,
* diskusní stránka neobsahuje text „<tt><nowiki>{{Redakce</nowiki></tt>“,
* diskusní stránka neobsahuje text „<tt><nowiki>{{Zkontrolovat</nowiki></tt>“,
* diskusní stránka neobsahuje text „<tt><nowiki>#PŘESMĚRUJ</nowiki></tt>“ (diskusní stránka by pak přesměrovávala na jinou diskusní stránku),
před vlastní text diskusní stránky je vložen text „<tt><nowiki>{{Redakce\n|citace\n|členění\n|kategorie\n|licence\n|nadpisy\n|synonyma\n|obrázky\n|prolinkování|\nzdroje\n|portály\n|pravopis\n|typografie}}</nowiki></tt>“. (Sekvence „\n“ je Pythonem interpretována jako nový řádek.)

== Seznamy, které bot generuje ==
Bot generuje seznamy článků se specifickým obsahem:
* [[WikiSkripta:Check WikiSkripta/Wikifikace]] &mdash; články, které potřebují z různého důvodu wikifikaci
* [[WikiSkripta:Check WikiSkripta/Portály]] &mdash; články, na něž neodkazuje žádný portál
* [[WikiSkripta:Check WikiSkripta/Redirects]] &mdash; návrhy přesměrování

=== Wikifikace ===
* Jedním z nežádoucích jevů na wiki je používání html tagů, které se dají opsat wikikódem. Do seznamu '''Články, které potřebují wikifikaci''' je článek zařazen, pokud se v něm nachází jeden z těchto řetězců
** „<nowiki><br></nowiki>“, „<nowiki><br /></nowiki>“, „<nowiki><br/></nowiki>“,
** „<nowiki><hr></nowiki>“, „<nowiki><hr /></nowiki>“, „<nowiki><hr/></nowiki>“,
** „<nowiki><h1></nowiki>“, „<nowiki><h2></nowiki>“, „<nowiki><h3></nowiki>“, „<nowiki><h1 /></nowiki>“, „<nowiki><h2 /></nowiki>“, „<nowiki><h3 /></nowiki>“, „<nowiki><h1/></nowiki>“, „<nowiki><h2/></nowiki>“, „<nowiki><h3/></nowiki>“, „<nowiki></h1></nowiki>“, „<nowiki></h2></nowiki>“, „<nowiki></h3></nowiki>“,
** „<nowiki><li></nowiki>“, „<nowiki><li /></nowiki>“, „<nowiki><li/></nowiki>“, „<nowiki></li></nowiki>“,
** „<nowiki><b></nowiki>“, „<nowiki><b /></nowiki>“, „<nowiki><b/></nowiki>“, „<nowiki></b></nowiki>“,
** „<nowiki><p></nowiki>“, „<nowiki><p /></nowiki>“, „<nowiki><p/></nowiki>“, „<nowiki></p></nowiki>“,
** „<nowiki><i></nowiki>“, „<nowiki><i /></nowiki>“, „<nowiki><i/></nowiki>“, „<nowiki></i></nowiki>“,
** „<nowiki><u></nowiki>“, „<nowiki><u /></nowiki>“, „<nowiki><u/></nowiki>“, „<nowiki></u></nowiki>“,
** „<nowiki><a></nowiki>“, „<nowiki><a /></nowiki>“, „<nowiki><a/></nowiki>“ nebo „<nowiki><a></nowiki>“.
* Do seznamu '''Stránky, které špatně používají CSS styly''' je článek zařazen, pokud se v něm nachází řetězec „style="“ nebo „style='“ (styly by měly být definovány pomocí parametru ''class'').
* Do seznamu '''Stránky s neuzavřenými závorkami''' je článek zařazen, pokud
** se v jeho název nezačíná řetězcem „Fórum:“ (na stránkách na fóru se velmi často vyskytují emotikony); a zároveň
** není v článku shodný počet znaků „<nowiki>[</nowiki>“ a „<nowiki>]</nowiki>“; nebo
** není v článku shodný počet znaků „<nowiki>{</nowiki>“ a „<nowiki>}</nowiki>“; nebo
** není v článku shodný počet znaků „<nowiki>(</nowiki>“ a „<nowiki>)</nowiki>“; nebo
** není sudý počet apostrofů.
* Do seznamu „'''Opravy obsahu'''“ je článek zařazen, pokud se u něj bot pokusil o automatickou opravu obsahu („Wikiskripta“ → „WikiSkripta“, „wikiskripta“ → „WikiSkripta“, spojovník → pomlčka, „...“ → „…“, "*" → „*“).

=== Portály ===
Článek je zařazen do seznamu '''„Stránky bez odkazu na portálu“''' v případě, že Aplication programming interface (API) WikiSkript nevrací žádné ''backlinks'' (stránky, jež na článek odkazují) ve jmenném prostoru ''Portál'', a do seznamu '''„Stránky s odkazem jen na portálu zkouškových otázek“''' v případě, že jsou API vráceny pouze portály s řetězcem „Otázky“ nebo „otázky“ v názvu, a zároveň pokud

* není ve whitelistu
* [[Speciální:Co odkazuje na|speciální stránka ''Odkazuje sem'']] pro daný článek v sobě nemá řetězec „Portál“ (API občas špatně vyhodnotí přesměrovávání &ndash; pokud portál odkazuje na stránku A, která přesměrovává stránku B, API může chybně vracet backlinks pro stránku B)
* nemá kategorii ''Kategorie:Rozcestník'' (rozcestníky nepotřebují odkaz na portálu, ten potřebují cílové stránky)
* nemá v názvu „/PGS“ &mdash; v daném případě je zařazen do seznamu '''„Články postgraduálního studia bez odkazu na portálu“'''
* nemá v názvu „/“ &mdash; v daném případě, pokud nemá v názvu „/PGS“, je zařazen do seznamu '''„Podstránky bez odkazu na portálu“'''
* nemá kategorii ''Kategorie:Heslo'' &mdash; v daném případě je zařazen do seznamu '''„Hesla bez odkazu na portálu“'''

=== Seznam navrhovaných redirectů ===
Seznam navrhovaných redirectů se tvoří tak, že v seznamu všech stránek (kromě whitelistu) se oboustranně nahradí dvojice řetězců:
* „asa“ a „áza“,
* „asy“ a „ázy“,
* „osa“ a „óza“,
* „asie“ a „ázie“,
* „asia“ a „ázia“,
* „itis“ a „itida“,
* „choroba“ a „nemoc“,
* „Choroba“ a „Nemoc“,
* „emia“ a „émie“,
* „emie“ a „émie“,
* „poesa“ a „poéza“,
* „poeza“ a „poéza“,
* „ismus“ a „izmus“,
* „pathie“ a „patie“,
* „Chromosom“ a „Chromozom“,
* „chromosom“ a „chromozom“.
Z tohoto seznamu se dále vyřadí položky obsahující řetězce „ochoroba“, „Dignosa“, „diagosa“, „žlas“, „chémie“ a „vasan“. Pokud nově vytvořený název stránky není v seznamu všech stránek, zařadí se do seznamu navrhovaných redirectů.

== Přehled úvodních nastavení ==
{| class='wikitable sortable'
|-
! Proměnná !! Standardní hodnota !! Význam proměnné
|-
| <tt>user_name</tt>  || <source lang='python'>'parcervenychBot'</source> || Přihlašovací jméno (login) účtu, na něhož se bot přihlašuje
|-
| <tt>password</tt> || heslo k účtu [[Uživatel:ParcervenychBot|ParcervenychBot]] || Heslo k účtu uvedeném v proměnné <tt>user_name</tt>
|-
| <tt>testurl</tt> || <source lang='python'>'http://www.test-wiki.lf1.cuni.cz/api.php'</source> || URI API serveru testovací wiki; pokud chcete spouštět bota na testovací wiki, je nutné tuto hodnotu přiřadit do proměnné <tt>url</tt>: <source lang='python'>url = testurl</source>
|-
| <tt>url</tt> || <source lang='python'>'https://www.wikiskripta.eu/api.php'</source> || URI API serveru WikiSkript
|-
| <tt>urlWikiHome</tt> || <source lang='python'>'https://www.wikiskripta.eu/index.php'</source> || URI WikiSkript, slouží k vyhledávání nenapřímených odkazů na portálu pomocí speciální stránky, tedy vyhledávání mimo API
|-
| <tt>upload_server</tt> || <source lang='python'>'http://myform.xf.cz/wiki/upload.php'</source> || URI serveru, který provádí nahrávání výstupu bota na internet; pokud bot edituje a nahrává tak výstup přímo do WikiSkript ([[WikiSkripta:Check WikiSkripta|Check WikiSkripta]]), zůstává nevyužito
|-
| <tt>logfile_name</tt> || <source lang='python'>'parcervenychbot.log'</source> || Název textového souboru, kam má bot ukládat výstup na příkazovou řádku, pokud nenastaveno ("<nowiki>''</nowiki>"), tiskne pouze do standardního výstupu
|-
| <tt>noportal_whitelist_link</tt> || <source lang='python'>'http://myform.xf.cz/wiki/NPWhiteList.txt'</source> || URI stránky, v níž jsou uvedeny tituly článků, které má bot při vyhledávání článků postrádajících odkaz na portálu ignorovat; každý titul musí být na samostatném řádku
|-
| <tt>redirect_whitelist_link</tt> || <source lang='python'>'http://myform.xf.cz/wiki/RedirectWhiteList.txt'</source> || stejné jako <tt>noportal_whitelist_link</tt>, jen pro navrhování redirectů (aby byl návrh ignorován, lze zadat jak stávající název článku, tak návrh redirectu)
|-
| <tt>cj</tt> || <source lang='python'>cookielib.CookieJar()</source> || Objekt, který se stará o Cookies při komunikaci se servery (API to potřebuje pro identifikaci); zkratka z CookieJar
|-
| <tt>editCount</tt> || <source lang='python'>0</source> || Proměnná, která udává počet provedených editací, standardně se na začátek určuje jako 0, stejně tak před editací [[WikiSkripta:Check WikiSkripta|Check WikiSkripta]]
|-
| <tt>editLimit</tt> || <source lang='python'>60</source> || Limit editací na jedno spuštění bota
|}
[[Kategorie:Dokumentace]]