Skip to content

Commit

Permalink
Moves loading archive guide
Browse files Browse the repository at this point in the history
- Moves the supported formats list to the front page of the User Guide
- Hierarchy improvements to the Loading Archived Items page
  • Loading branch information
Shrinks99 committed Dec 25, 2023
1 parent c2470ab commit ee1d8e4
Show file tree
Hide file tree
Showing 10 changed files with 79 additions and 117 deletions.
File renamed without changes
4 changes: 2 additions & 2 deletions docs/docs/develop/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ ReplayWeb.page offers four different ways to embed the archived content, includi

- `replayonly`: Show just the replayed page, and no additional UI or nav bar buttons. Useful for embedding a single page.

- `replay-with-info`: Show the replayonly mode, but also add an archive info dropdown, which shows an archival 'receipt' with provenance and verification information (new in 1.7.0)
- `replay-with-info`: Show the `replayonly` mode, but also add an archive info dropdown, which shows an archival 'receipt' with provenance and verification information (new in 1.7.0)

??? example "Example: Embed with `replay-with-info` enabled"
<script src="https://cdn.jsdelivr.net/npm/replaywebpage/ui.js"></script>
Expand All @@ -131,7 +131,7 @@ The `#!html <replay-web-page>` tag is a web component that supports a number of

| Attribute | Description |
|:-------------|:-----------------|
| `source` | Source URL for the archived item. This should be one of the [supported formats](/develop/formats) loaded from one of the [support locations](/develop/locations) and is required. |
| `source` | Source URL for the archived item. This should be one of the [supported formats](/user-guide#supported-formats) loaded from one of the [support locations](/develop/locations) and is required. |
| `url` | The starting URL to load from the archive. If omitted, will start with the page list or URL search view. |
| `ts` | The timestamp of the starting URL to load. If omitted, the latest available version is used. |
| `deepLink` | If set, ReplayWeb.page will modify the URL of the page to allow for 'deep linking' to exact pages in the embed. |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/develop/locations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The following is a list of currently supported URL schemes and details below:

## HTTP and HTTPS

While `https://replayweb.page` can load archived items from any URL, the hosting server must allow access by [enabling cross origin resource sharing](/develop/cors-settings). HTTP URLs may not be accessible from `https://replayweb.page` since it requires HTTPS.
While `https://replayweb.page` can load archived items from any URL, the hosting server must allow access by [enabling cross origin resource sharing](/develop/cors-settings) (CORS). HTTP URLs may not be accessible from `https://replayweb.page` since it requires HTTPS.

## Local Files

Expand Down
3 changes: 3 additions & 0 deletions docs/docs/overrides/.icons/bootstrap/three-dots-vertical.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions docs/docs/user-guide/index.md
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 |
51 changes: 51 additions & 0 deletions docs/docs/user-guide/loading.md
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.
28 changes: 0 additions & 28 deletions docs/formats.md

This file was deleted.

86 changes: 0 additions & 86 deletions docs/loading.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@ nav:
- develop/cors-settings.md
- develop/locations.md
- User Guide:
- user-guide/index.md
- user-guide/loading.md
- user-guide/offline-use.md

markdown_extensions:
Expand Down

0 comments on commit ee1d8e4

Please sign in to comment.