wrolpi-help/docs/modules/archives/files.md

38 lines
1.6 KiB
Markdown
Raw Normal View History

2023-10-15 16:31:49 -06:00
# Archive Files
WROLPi creates several files when archiving a webpage:
2023-10-29 18:20:36 -06:00
1. A [Singlefile](index.md#singlefile) that stores an exact copy of the web page.
2. A [Readability](index.md#readability) file.
2023-10-15 16:31:49 -06:00
3. A Readability text file.
4. A Readability JSON file.
5. A screenshot file of the web page.
2023-10-29 18:20:36 -06:00
These files all share the same filename but have different suffixes.
2023-10-15 16:31:49 -06:00
| File Suffix | Purpose |
|-------------------|--------------------------------------------|
| .html | The Singlefile. |
| .readability.html | The Readability extract of the Singlefile. |
| .readability.txt | The article text extracted by Readability. |
2023-10-29 18:20:36 -06:00
| .readability.json | Data from Readability (URL/author/etc.). |
2023-10-15 16:31:49 -06:00
| .png | The screenshot of the web page. |
Archive files are named using three parts:
2023-10-29 18:20:36 -06:00
1. The domain directory.
2. The archive date time (YYYY-MM-DD-HH-MM-SS).
2023-10-15 16:31:49 -06:00
3. The title of the web page.
2023-10-29 18:20:36 -06:00
If archiving `https://wrolpi.org/getting-started`, the resulting files might be named as follows:
2023-10-15 16:31:49 -06:00
```
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.html
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.html
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.txt
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.json
/media/wrolpi/archive/wrolpi.org/2023-01-01-12-00-00_Getting Started.png
2023-10-15 16:31:49 -06:00
```
2023-10-29 18:20:36 -06:00
WROLPi will attempt to extract the Readability and create a screenshot from the Singlefile. If this is not possible,
WROLPi will still keep the lone Singlefile.