Skip to content

docs: init docs#61

Open
TripleCamera wants to merge 6 commits intosaveweb:v4-mainfrom
TripleCamera:init-docs
Open

docs: init docs#61
TripleCamera wants to merge 6 commits intosaveweb:v4-mainfrom
TripleCamera:init-docs

Conversation

@TripleCamera
Copy link

Upload docs written by myself. Early revisions are kept at GitHub Gist.

  • README
  • Tutorial
  • Dump Types
  • Dump Structure
  • export-0.11-wikiteam3.xsd

The docs are in early stages. Suggestions are welcomed!

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`
Now with images!
- Tutorial
- Schema History (WIP)
- Database-API-XML Relation (WIP)
@TripleCamera TripleCamera marked this pull request as ready for review January 12, 2026 08:57
@TripleCamera
Copy link
Author

This is now ready for review.

* Dump Types
* `export-0.11-wikiteam3.xsd`
@TripleCamera
Copy link
Author

@yzqzss Please review again

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Output formats are various dependent on the target site you want to archive and the wikiteam3 config you passed in.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What should I do then?

Comment on lines +48 to +68
Wikiteam3 is a Python package. There is a detailed tutorial for [**installing packages**](https://packaging.python.org/en/latest/tutorials/installing-packages/) at Python Packaging User Guide. Please follow it to install Python (if you haven't installed) and wikiteam3.

Key points:
1. First, install Python 3 if you haven't installed it. Make sure you can run both Python and pip from the command line:

```console
$ python3 --version
$ python3 -m pip --version
```

2. Then, simply install wikiteam3 from [pip](https://pypi.org/project/wikiteam3/). However, it is recommended to install wikiteam3 in a *virtual environment*, which isolates wikiteam3 and other Python packages.

```console
$ python3 -m pip install wikiteam3
```

If you have installed wikiteam3 correctly, a help message would appear if you run the following command:

```console
$ wikiteam3dumpgenerator --help
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest people to install wikiteam3 via uv, pipx and so on.

* Dump Structure
* Dump Types
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants