README.md

## Decription

Datasets of articles extracted from https://pzwiki.net/wiki/Project_Zomboid_Wiki

## Format

JSONL

```python
import json

data = []
with open('zomboid_articles.jsonl') as f:
    for line in f:
        data.append(json.loads(line))

print(data[0].keys())
```

## Fields

  - url (e.g., `https://pzwiki.net/wiki/Mechanics`)
  - title (e.g., `Mechanics`)
  - wiki_notes (e.g., `This page has been revised for the current stable version (41.78.16).`)
  - content
  - navigation (e.g., `Project Zomboid > Game mechanics > Character > Skills > Mechanics`)
  - footer

## Limitation

### Images

It's pure text so images are simply referred to by their path

### Tables

Tables are converted to markdown strings.
For instance, [Trapping table](https://pzwiki.net/wiki/Trapping)

```
Item  | Description  | ![Weight](/w/images/9/9f/Moodle_Icon_HeavyLoad.png) | Strength  | Can catch ![Mouse](/w/images/5/5c/Mouse.png)?  | Can catch ![Rat](/w/images/8/8b/Rat.png)?  | Can catch ![Squirrel](/w/images/4/41/Squirrel.png)?  | Can catch ![Rabbit](/w/images/f/fd/Rabbit.png)?  | Can catch ![Small Bird](/w/images/7/70/Bird.png)?  | Item ID  | Skill Level   
---|---|---|---|---|---|---|---|---|---|---  
![Mouse Trap](/w/images/7/75/Mousetrap.png)  
Mouse Trap | Small trap used by beginner trappers. Used to catch mice and rats.  | 0.3  | 50  | Yes (30%)  | Yes (25%)  | No  | No  | No  | Base.TrapMouse | Uncraftable   
![Trap Stick](/w/images/e/ea/TrapStick.png)  
Stick Trap | Small trap used by beginner trappers. Used to catch small birds.  | 0.5  | 15  | No  | No  | No  | No  | Yes (40%)  | Base.TrapStick | Trapping 0   
![Snare Trap](/w/images/4/4a/TrapSnare.png)  
Snare Trap | Medium size trap used by novice trappers. Used to catch squirrels and rabbits.  | 0.5  | 10  | No  | No  | Yes (30%)  | Yes (30%)  | No  | Base.TrapSnare | Trapping 1   
![Trap Box](/w/images/6/62/TrapBox.png)  
Trap Box | Medium size trap used by apprentice trappers. Used to catch squirrels and rabbits.  | 1  | 15  | No  | No  | Yes (25%)  | Yes (30%)  | No  | Base.TrapBox | Trapping 2, Carpentry 1   
![Trap Crate](/w/images/6/64/TrapCrate.png)  
Trap Crate | Medium size trap used by beginner trappers. Used to catch squirrels and rabbits.  | 1  | 15  | No  | No  | Yes (30%)  | Yes (30%)  | No  | Base.TrapCrate | Trapping 0   
![Cage Trap](/w/images/7/73/TrapCage.png)  
Cage Trap | Medium size trap used by journeyman trappers. Used to catch squirrels and rabbits.  | 1  | 20  | No  | No  | Yes (40%)  | Yes (40%)  | No  | Base.TrapCage | Trapping 3
```