Difference between revisions of "Template:CTA URL lists"

From Archiveteam
Jump to navigation Jump to search
(Add note about private transfers)
(Add grep -a option)
Line 2: Line 2:
This project requires lists of URLs for content on the target website. If you have a source of URLs, please:
This project requires lists of URLs for content on the target website. If you have a source of URLs, please:


# Use the regular expression <code>{{{regex}}}</code> for filtering. {{ #if: {{{broad|}}} | Note that this regex is intentionally broad to cover many different URL formats. Please do not try to use a more narrow pattern as it may miss valid URLs. We can always filter or transform the results as needed later.}}
# Use the regular expression <code>{{{regex}}}</code> for filtering.{{ #if: {{{broad|}}} |
#* Note that this regex is intentionally broad to cover many different URL formats. Please do not try to use a more narrow pattern as it may miss valid URLs. We can always filter or transform the results as needed later.}}
#* If you use <code>grep</code>, remember to include the <code>-a</code> (aka <code>--text</code> on GNU grep) option to ensure it will continue searching for matches when encountering binary data.
# If the output exceeds a few megabytes, please compress it, preferably using <code>zstd -10</code>.
# If the output exceeds a few megabytes, please compress it, preferably using <code>zstd -10</code>.
# Upload the file to https://transfer.archivete.am/.
# Upload the file to https://transfer.archivete.am/.

Revision as of 18:42, 22 April 2023

Options:

  • regex, required, the PCRE-ish regular expression to use for filtering
  • broad, optional, adding an extra bit about the regex being intentionally broad if non-empty

Example:

{{CTA URL lists|regex = <nowiki>\S*(foo|bar)\S*</nowiki>|broad = yes}}

renders as:

How to help if you have lists of URLs

This project requires lists of URLs for content on the target website. If you have a source of URLs, please:

  1. Use the regular expression \S*(foo|bar)\S* for filtering.
    • Note that this regex is intentionally broad to cover many different URL formats. Please do not try to use a more narrow pattern as it may miss valid URLs. We can always filter or transform the results as needed later.
    • If you use grep, remember to include the -a (aka --text on GNU grep) option to ensure it will continue searching for matches when encountering binary data.
  2. If the output exceeds a few megabytes, please compress it, preferably using zstd -10.
  3. Upload the file to https://transfer.archivete.am/.
  4. Share the resulting URL in the project IRC channel.
    • If you would like to keep the list non-public instead, e.g. for privacy reasons or for not wanting to be publicly associated with it, please get in touch with a channel op (e.g. User:Arkiver or User:JustAnotherArchivist). Note that the items generated from your list would still be processed publicly, of course, but they would be mixed with everything else.

See also Category:Projects requiring URL lists for other ArchiveTeam projects that necessitate URL lists.