docs and README: add wacz format doc, tweak links, tweak README
This commit is contained in:
+2
-2
@@ -24,12 +24,12 @@ The archive view presents several tabs:
|
||||
- **Story** - This Story view presents lists of curated pages, as developed by the creator of the web archive.
|
||||
This option is only shown if there is a curated story. As curated lists are not a standard part of WARC, only WARCs exported from Webrecorder.io/Conifer can have this option.
|
||||
|
||||
The new [Web Archive Collection (WACZ)](web-archive-collection-format) can also include curated lists.
|
||||
The new [Web Archive Collection (WACZ)](wacz-format) can also include curated lists.
|
||||
|
||||
- **Pages** - The Pages view presents all pages in the web archive. As pages are not a standard part of WARC format,
|
||||
generally only WARCs from Webrecorder.io/Conifer will have pages.
|
||||
|
||||
The new [Web Archive Collection (WACZ)](web-archive-collection-format) can also store pages.
|
||||
The new [Web Archive Collection (WACZ)](wacz-format) can also store pages.
|
||||
|
||||
|
||||
- **Page Resources** - This view allows searching the archive by URLs, as well as by common MIME type.
|
||||
|
||||
+1
-1
@@ -12,7 +12,7 @@ parent: Reference
|
||||
ReplayWeb.Page supports the archive formats listed below.
|
||||
Format is currently determined based on the file extension.
|
||||
|
||||
The `.wacz` refers to the newly proposed [Web Archive Collection Zip Format](web-archive-collection).
|
||||
The `.wacz` refers to the newly proposed [Web Archive Collection Zip Format](wacz-format).
|
||||
|
||||
|
||||
| Format | Extensions | Status |
|
||||
|
||||
+2
-2
@@ -44,7 +44,7 @@ To load a remote archive, simply enter the URL of the archive and click `Load`.
|
||||
{: .fs-3 .pad .bg-grey-lt-100}
|
||||
See [Supported Locations](locations) for details on where archives can be loaded from.
|
||||
|
||||
The archive will be downloaded, either fully or [only as needed (if possible)](streaming-archives.md) and presented on the archive page.
|
||||
The archive will be downloaded, either fully or on-demand (if possible) and presented on the archive page.
|
||||
|
||||
The system supports WARC files, as well as several other formats
|
||||
|
||||
@@ -74,7 +74,7 @@ Due to the nature of the WARC format, the entire file must be read on first use
|
||||
For WARC files **>25MB**, only the index is initially stored in the browser, and the actual content is loaded 'on-demand',
|
||||
when the content is first accessed. This leads to faster loading and saves memory when dealing with large archives.
|
||||
|
||||
[Web Archive Collection (WACZ)](web-archive-collection-format) are always loaded on-demand, as no indexing is required.
|
||||
[Web Archive Collection (WACZ)](wacz-format) are always loaded on-demand, as no indexing is required.
|
||||
The initial archive view should load almost instantly as a result.
|
||||
|
||||
If an archive could not be loaded, an error will be displayed instead of the progress.
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
layout: default
|
||||
title: 'Web Archive Collection Zipped (WACZ) Format'
|
||||
nav_order: 1
|
||||
permalink: /docs/wacz-format
|
||||
parent: Reference
|
||||
---
|
||||
|
||||
## Web Archive Collection Format Specification
|
||||
|
||||
ReplayWeb.page supports a new format for bundling raw web archive data (usually WARC files), indices,
|
||||
page lists and other metadata into a single ZIP file.
|
||||
|
||||
The full spec for this format is available at: [https://github.com/webrecorder/web-archive-collection-format/blob/master/README.md](https://github.com/webrecorder/web-archive-collection-format/blob/master/README.md)
|
||||
|
||||
Files bundled into this format can use the .wacz (web archive collection zipped) file extension.
|
||||
|
||||
ReplayWeb.page will recognize this extension (as well as regular .zip) and will also load it from Google Drive when the
|
||||
[Google Drive Integration](https://gsuite.google.com/u/2/marketplace/app/replaywebpage/160798412227) is installed.
|
||||
|
||||
The key benefit of this format is that large web archive collections can be loaded very quickly, to show the page list
|
||||
and other key metadata, by downloading only parts of the WACZ file, as [outlined here](https://github.com/webrecorder/web-archive-collection-format/blob/master/README.md#appendix-a-use-case-random-access-to-web-archives-in-zip)
|
||||
|
||||
The actual raw content is loaded on-demand when the user requests each page.
|
||||
|
||||
With a WARC file, the entire contents must be loaded or indexed to determine the contents of the web archive collection.
|
||||
Reference in New Issue
Block a user