23
edits
Difference between revisions of "Tools/en"
Jump to navigation
Jump to search
Tools summary section
(Translation of the Generation section) |
(Tools summary section) |
||
| Line 36: | Line 36: | ||
* the storage space you have for the final result | * the storage space you have for the final result | ||
* how to make the selection if necessary. | * how to make the selection if necessary. | ||
==Usage== | |||
Here is a list of available scripts (many of them are specific to Mediawiki): | |||
===Mediawiki Maintenance=== | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/backupMediawikiInstall.pl?view=log backupMediawikiInstall.pl] creates a tgz archive of a complete existing Mediawiki installation (code + resources + database). | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/installMediawiki.pl?view=log installMediawiki.pl] brings up an instance of Mediawiki from source code without human intervention. This actually simulates the manual Mediawiki installation process. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/resetMediawikiDatabase.pl?view=log resetMediawikiDatabase.pl] empties a local instance of Mediawiki of all pages. | |||
===Mirroring Tools=== | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/buildHistoryFile.pl?view=log buildHistoryFile.pl] given a list of articles and an online Mediawiki site, obtains complete histories of each page on the list. | |||
** [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/extractContributorsFromHistoryFile.pl?view=log extractContributorsFromHistoryFile.pl] extracts a list of authors from the histories obtained by the buildHistoryFile.pl script. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/buildContributorsHtmlPages.pl?view=log buildContributorsHtmlPages.pl] given a template and a list of authors, builds a custom set of HTML pages containing all of the authors on the list. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/checkMediawikiPageCompleteness.pl?view=log checkMediawikiPageCompleteness.pl] check if the local copies of pages from an online Mediawiki site are complete, i.e. have no dependencies (template files, multimedia resources, etc.) missing. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/checkPageExistence.pl?view=log checkPageExistence.pl] given a list of page titles and an online Mediawiki site, checks whether such pages exist in it. This can be handy, for example, to see what pages have been replicated. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/checkRedirects.pl?view=log checkRedirects.pl] checks if there are no pages redirecting to non-existent pages (i.e. broken redirects). Eventually, it should also check against pages redirecting to each other. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/listAllImages.pl?view=log listAllImages.pl] lists all images of an online Mediawiki site. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/listAllPages.pl?view=log listAllPages.pl] lists all pages in an online Mediawiki site. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/listCategoryEntries.pl?view=log listCategoryEntries.pl] lists the pages belonging to a category, recursively. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/listRedirects.pl?view=log listRedirects.pl] list page redirects in an online Mediawiki site. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/mirrorMediawikiCode.pl?view=log mirrorMediawikiCode.pl] downloads the exact same version used by an online MediaWiki site; this includes both Mediawiki code and Mediawiki extensions. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/mirrorMediawikiInterwikis.pl?view=log mirrorMediawikiInterwikis.pl] installs to a local Mediawiki site the InterWikis (cross-language links) exactly identical to an online Mediawiki site. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/mirrorMediawikiPages.pl?view=log mirrorMediawikiPages.pl] copies a set of pages and their dependencies (template and multimedia resources) from an online Mediawiki site to a local Mediawiki site. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/mirroring_tools/scripts/modifyMediawikiEntry.pl?view=log modifyMediawikiEntry.pl] removes, deletes, or replaces a list of pages from an online Mediawiki site. | |||
===Dumping Tools=== | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/scripts/checkEmptyFilesInHtmlDirectory.pl?view=log checkEmptyFilesInHtmlDirectory.pl] checks whether a directory and its subdirectories contain empty files. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/scripts/dumpHtml.pl?view=log dumpHtml.pl] given a local Mediawiki site, makes all-static copies of pages, i.e. creates a directory with all needed HTML. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/scripts/launchTntreader.pl?view=log launchTntreader.pl] easily launches the tntreader program. | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/scripts/optimizeContents.pl?view=log optimizeContents.pl] optimizes a directory with HTML pages and resources. This script calls the following extensions: [http://tidy.sourceforge.net/ HTML Tidy] for HTML files; The [http://sourceforge.net/projects/littleutils/ Little utils] for images. | |||
===ZIM Generation=== | |||
* [http://kiwix.svn.sourceforge.net/viewvc/kiwix/dumping_tools/scripts/buildZimFileFromDirectory.pl?view=log buildZimFileFromDirectory.pl] creates a ZIM file from a directory tree containing static HTML and other content files. | |||