-
-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Moves the supported formats list to the front page of the User Guide - Hierarchy improvements to the Loading Archived Items page
- Loading branch information
Showing
10 changed files
with
79 additions
and
117 deletions.
There are no files selected for viewing
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# User Guide | ||
|
||
Welcome to the ReplayWeb.page official user guide and developer docs. | ||
|
||
- To load and view your first archived item in ReplayWeb.page, check out [Loading Archived Items](loading). | ||
|
||
## Supported Formats | ||
|
||
While ReplayWeb.page aims to support a variety of formats for archived web content, for best performance we recommend using WACZ files. To archive webpages to WACZ files on a per-page basis, we recommend [ArchiveWeb.page](https://archiveweb.page). If you need to crawl and save entire websites, check out [Browsertrix](https://browsertrix.com). | ||
|
||
ReplayWeb.Page supports the following file formats listed as "Supported". Format type is determined based on the file's extension. | ||
|
||
| Format | Extensions | Status | | ||
|:--------|:--------------------|:---------------| | ||
| WACZ | `.wacz` | Supported | | ||
| WARC | `.warc`, `.warc.gz` | Supported | | ||
| HAR | `.har` | Not Supported | | ||
| WBN | `.wbn` | Experimental | | ||
| ARC | `.arc` | Not Supported | | ||
| CDX | `.cdx`, `.cdxj` | Supported | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Loading Archived Items | ||
|
||
ReplayWeb.page can load archived items from the local filesystem, or from remote locations. If you don't have any archived items yet, try archiving a website with [ArchiveWeb.page](https://archiveweb.page)! | ||
|
||
--- | ||
|
||
## Loading Local Files | ||
|
||
From [replayweb.page](https://replayweb.page), press the _Choose File..._ button, pick any local archived item file from your computer, then press _Load_ to start viewing the file's archived content. | ||
|
||
<img alt="screenshot of replayweb.page (online)" src="../../assets/replaywebpage-online-local.png"> | ||
|
||
The archived item is loaded directly in the browser and is _not_ uploaded anywhere — your data never leaves your computer! | ||
|
||
Once loaded, the archived item will appear in the list of Loaded Archives and will be identified by its filename with a a `file://` URL as its source. This URL is not shareable as it doesn't exist outside of your computer. | ||
|
||
## Loading Files from a URL | ||
|
||
To load an archived item stored in a remote location, enter the URL of the file and press _Load_. | ||
|
||
The archived item will be downloaded, either fully or on-demand (if possible) and presented when ready. | ||
|
||
See the [Supported Locations](../../develop/locations/) page for details on supported external sources for serving archived items. | ||
|
||
## Loading Files from Within Google Drive | ||
|
||
In addition to loading remote content from URLs, ReplayWeb.page also supports loading WARC and WACZ files directly from Google Drive. | ||
|
||
### Add-on Installation | ||
|
||
First, install the [ReplayWeb.page Google Drive Addon](https://gsuite.google.com/u/2/marketplace/app/replaywebpage/160798412227). | ||
|
||
* Press the _Install_ button, Google will walk you through the steps of installation. | ||
* Once installed, Google will confirm the install and display where to find ReplayWeb.page in your drive. | ||
|
||
<figure> | ||
<img alt="animated gif of replayweb.page google drive add-on install process" src="../../assets/replaywebpage-googledrive-install.gif"> | ||
<figcaption>Installing the ReplayWeb.page Google Drive add-on</figcaption> | ||
</figure> | ||
|
||
### Usage | ||
|
||
1. Navigate to any WARC or WACZ files that available on your Google Drive. | ||
|
||
2. Under the file's _More Actions_ :bootstrap-three-dots-vertical: menu, select _Open With_ and choose _ReplayWeb.page_ from the menu. | ||
|
||
This will redirect to ReplayWeb.page and begin loading the file. Items loaded from Google Drive will have a source URL starting with `googledrive://`. | ||
|
||
--- | ||
|
||
Once an archived item has been successfully loaded, the app will display the archive viewer and you can begin exploring your loaded archive. |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters