From 7bdc8f76f0774e7ff65be3f5b5604c72de800598 Mon Sep 17 00:00:00 2001 From: TripleCamera Date: Fri, 26 Dec 2025 16:17:20 +0800 Subject: [PATCH 1/3] docs: init docs Upload docs written by myself. Early revisions are kept at [GitHub Gist](https://gist.github.com/TripleCamera/16411db348e4237b8636614f3831e543). - README - Tutorial - Dump Types - Dump Structure - `export-0.11-wikiteam3.xsd` --- docs/README.md | 7 + docs/dump_structure.md | 53 +++++ docs/dump_types.md | 71 +++++++ docs/export-0.11-wikiteam3.xsd | 350 +++++++++++++++++++++++++++++++++ docs/tutorial.md | 126 ++++++++++++ 5 files changed, 607 insertions(+) create mode 100644 docs/README.md create mode 100644 docs/dump_structure.md create mode 100644 docs/dump_types.md create mode 100644 docs/export-0.11-wikiteam3.xsd create mode 100644 docs/tutorial.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..ce34cf0a --- /dev/null +++ b/docs/README.md @@ -0,0 +1,7 @@ +# `wikiteam3` Documentation +Welcome to the (WIP) documentation of `wikiteam3`! + +References: + - [WikiTeam wiki](https://github.com/WikiTeam/wikiteam/wiki) + - [WikiTeam](https://wiki.archiveteam.org/index.php/WikiTeam) at the ArchiveTeam Wiki + - [WikiTeam3 tutorial](https://meta.miraheze.org/wiki/Backups#WikiTeam3) at Miraheze Meta diff --git a/docs/dump_structure.md b/docs/dump_structure.md new file mode 100644 index 00000000..6ecf1eaa --- /dev/null +++ b/docs/dump_structure.md @@ -0,0 +1,53 @@ +# Dump Structure + +``` +--wikidump +├── images +│ └── ... +├── images_mismatch +│ └── ... +├── config.json +├── --titles.txt +├── --history.xml +├── --images.txt +├── index.html +├── SpecialVersion.html +├── siteinfo.json +├── all_dumped.mark +└── errors.log +``` + +``` +wiki-- +├── --dumpMeta +│ ├── config.json +│ ├── index.html +│ ├── SpecialVersion.html +│ ├── siteinfo.json +│ ├── errors.log +│ └── ... +├── x +├── x +├── x +└── x +``` + + +## General + - `config.json`: Dump configuration. Used when [resuming an incomplete dump](https://github.com/saveweb/wikiteam3/blob/v4-main/README.md#resuming-an-incomplete-dump). + - `index.html`: Archive of `index.php` (the main page). + - `SpecialVersion.html`: Archive of `[[Special:Version]]`. + - `siteinfo.json`: Archive of Siteinfo API response. + - `all_dumped.mark`: Marks the end of the dump. Content: `