mirror of
https://github.com/wrolpi/wrolpi-help.git
synced 2026-11-22 07:56:19 -05:00
Slowly building all WROLPi help docs.
This commit is contained in:
commit
b2167cf098
25 changed files with 340 additions and 0 deletions
BIN
docs/archives/archive-page.png
Normal file
BIN
docs/archives/archive-page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 112 KiB |
39
docs/archives/files.md
Normal file
39
docs/archives/files.md
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
# Archive Files
|
||||
|
||||
WROLPi creates several files when archiving a webpage:
|
||||
|
||||
1. A [Singlefile](#singlefile) which stores an exact copy of the web page.
|
||||
2. A [Readability](#readability) file.
|
||||
3. A Readability text file.
|
||||
4. A Readability JSON file.
|
||||
5. A screenshot file of the web page.
|
||||
|
||||
These files are all share the same file name, but different suffixes.
|
||||
|
||||
| File Suffix | Purpose |
|
||||
|-------------------|--------------------------------------------|
|
||||
| .html | The Singlefile. |
|
||||
| .readability.html | The Readability extract of the Singlefile. |
|
||||
| .readability.txt | The article text extracted by Readability. |
|
||||
| .readability.json | Data from Readability (URL/author/etc). |
|
||||
| .png | The screenshot of the web page. |
|
||||
|
||||
Archive files are named using three parts:
|
||||
|
||||
1. The domain directory
|
||||
2. The archive date time (YYYY-mm-dd-HH-MM-SS).
|
||||
3. The title of the web page.
|
||||
|
||||
If archiving [https://wrolpi.org/getting-started](https://wrolpi.org/getting-started), the resulting files would be
|
||||
named like so:
|
||||
|
||||
```
|
||||
wrolpi.org/2023-01-01-12-00-00_Getting Started.html
|
||||
wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.html
|
||||
wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.txt
|
||||
wrolpi.org/2023-01-01-12-00-00_Getting Started.readability.json
|
||||
wrolpi.org/2023-01-01-12-00-00_Getting Started.png
|
||||
```
|
||||
|
||||
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.
|
||||
32
docs/archives/index.md
Normal file
32
docs/archives/index.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
# Archives
|
||||
|
||||
The Archives module allows viewing, organizing, and downloading of webpages as SingleFile files. Each Archive's URL
|
||||
is retained, they are organized by their domain in the Domains tab.
|
||||
|
||||

|
||||
|
||||
## Singlefile
|
||||
|
||||
A Singlefile is an HTML file which contains encoded copies of all files necessary to render a webpage. Normally a
|
||||
webpage will link to many resources outside the page you are viewing, this causes problems when you attempt to save the
|
||||
webpage because you will need to download and organize all of these files. Singlefile solves this problem by encoding
|
||||
and embedding all the related files within a single HTML file.
|
||||
|
||||
The Singlefile project has many advantages.
|
||||
|
||||
* A single HTML file that can be easily shared with others.
|
||||
* All that is necessary to view the archive is a compatible browser. No external files or services.
|
||||
* An exact copy that handles rendering of Javascript that the page will contain.
|
||||
* Images and style is preserved.
|
||||
|
||||
## Readability
|
||||
|
||||
[Readability](https://github.com/mozilla/readability) is a Mozilla project which extracts the article from a web page.
|
||||
Because a web page is made up of many HTML, CSS, Javascript words that we do not want to search, WROLPi uses Readability
|
||||
to extract the words that will be indexed.
|
||||
|
||||

|
||||
|
||||
## Domain
|
||||
|
||||
A domain is the host of the archived URL. For example, the host of https://wrolpi.org/getting-started is wrolpi.org.
|
||||
BIN
docs/archives/readability-preview.png
Normal file
BIN
docs/archives/readability-preview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
Loading…
Add table
Add a link
Reference in a new issue