{\rtf1\ansi\ansicpg1252\cocoartf2638
\cocoatextscaling0\cocoaplatform0{\fonttbl\f0\fswiss\fcharset0 Helvetica-Bold;\f1\fswiss\fcharset0 Helvetica;\f2\fswiss\fcharset0 Helvetica-Oblique;
}
{\colortbl;\red255\green255\blue255;}
{\*\expandedcolortbl;;}
\margl1440\margr1440\vieww13140\viewh14100\viewkind0
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\qc\partightenfactor0

\f0\b\fs28 \cf0 How to Use these Scripts\
by iritscen@yahoo.com
\f1\b0 \
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
\cf0 \
In the course of maintaining the OniGalore wiki, I have written some Python and Bash shell scripts for Pywikibot.  My Bash shell scripts call Python scripts which are bundled with Pywikibot.  My Python scripts utilize the Pywikibot API to perform new tasks not covered by the bundled scripts.  To run the scripts, first {\field{\*\fldinst{HYPERLINK "https://www.mediawiki.org/wiki/Manual:Pywikibot/Installation"}}{\fldrslt install Pywikibot}}, then read below.\
\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
\cf0 \ul \ulc0 Python\ulnone \
In Terminal, 'cd' into the core/ directory and run the command "python pwb.py /path/to/script [arguments for script]".  When running a built-in Pywikibot script, you would simply invoke it with "python pwb.py [name of script without suffix] [arguments]", but since these scripts are outside the core/ directory they need full pathname qualification.\
\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0

\f0\b \cf0 check_interwiki_links.py
\f1\b0 \
This script scans a given page, or all the pages in a given category, for interwiki links such as [[wp:Example]] and [[wikt:definition|some word]].  It then tests those links to make sure they're valid and prints an "ERROR:" message if (1) the page is not found, (2) a redirect is encountered, or (3) the page exists but the specified section cannot be found.\
\
Usage:\
python pwb.py check_interwiki_links -page:"Daodan"\
python pwb.py check_interwiki_links -cat:"Wiki Support" \
\

\f0\b check_intrawiki_section_links.py
\f1\b0 \
This script scans a given page, or all the pages in a given category, for intrawiki links with section links in them such as [[Konoko#In-game_appearance]].  It then tests those links to make sure they're valid and prints a "WARNING:" or "ERROR:" message if a problem is encountered.  "ADVICE:" messages are printed when a link cannot be tested because transclusion is being used to construct it dynamically.\
\
Usage: The syntax is the same as for check_interwiki_links.py.\
\

\f0\b find_external_images.py
\f1\b0 \
This script scrapes the HTML of the supplied category's pages and alerts you to externally-linked images so you can consider uploading them to the wiki.  Special attention is drawn to images hosted elsewhere on oni2.net.  This script isn't totally finished and the argument-handling code is in a bit of disarray, but it should support showing inline and/or non-embedded external image links.\
\
Usage:\
python pwb.py find_external_images -page:"State of Emergency"\
python pwb.py find_external_images -justshown -cat:"Category:Real World"\
\

\f0\b uncapitalize_image_suffixes.py
\f1\b0 \
This script checks all the images on the wiki for capitalized file suffixes (.JPG instead of .jpg, etc.) and renames them to be non-capitalized.  Note that any pages linking to the images will need to be corrected manually afterward, but the script will tell you which pages link to or embed each image that it renames.\
\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
\cf0 \ul \ulc0 Bash\ulnone \
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0

\f0\b \cf0 drive_https_upgrade.sh
\f1\b0 \
This script was designed to take a TXT report from a Validate External Links session run \ul without\ulnone  the --show-https-upgrades argument and use it to mass-change all the URLs for sites that wanted an upgrade from HTTP to HTTPS.  In such a TXT report, links which wanted an HTTPS upgrade would have the phrase "Skipping URL 
\f2\i x
\f1\i0  because I have not been asked to show http->https upgrades" in it, so the script uses regex to search for "http->https".  It edits all such links from the one numbered FIX_START to the one numbered FIX_END.  This script served its purpose and probably won't be needed again, but it has value as a tutorial.\
\

\f0\b drive_slash_adding.sh
\f1\b0 \
This script was designed to take a TXT report from a Validate External Links session run \ul without\ulnone  the --show-added-slashes argument and use it to mass-change all the URLs that wanted a trailing slash added to them.  In such a TXT report, URLs where the server asked for a trailing '/' to be added to the URL would have the phrase "Skipping URL 
\f2\i x
\f1\i0  because I have not been asked to show added trailing slashes", so the script searches for the word "trailing".  This script served its purpose and probably won't be needed again, but it has value as a tutorial.\
\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
\cf0 \ul \ulc0 Docs\
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0

\f0\b \cf0 \ulnone Generator and replace options.txt
\f1\b0 \ul \
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0
\cf0 \ulnone This is the help text generated by "python pwb.py replace -help".  It shows the many options you have for using the built-in replace.py script and for asking any built-in Pywikibot script to limit its scope to certain pages.\ul \
\ulnone \
\pard\tx720\tx1440\tx2160\tx2880\tx3600\tx4320\tx5040\tx5760\tx6480\tx7200\tx7920\tx8640\pardirnatural\partightenfactor0

\f0\b \cf0 Pywikibot commands.rtf
\f1\b0 \
General advice on how to use Pywikibot properly.\
\

\f0\b Read-me.rtf
\f1\b0 \
You are here.}