Module:Thread archive/doc
This is the documentation page for Module:Thread archive
 | This module is rated as pre-alpha. It is incomplete and may or may not be in active development. Do not use it on article pages. It remains in pre-alpha until its developer, or another editor who adopts it, considers the basic structure complete. |
 | This module depends on the following other modules: |
This module implements {{Thread archive}}. It formats a reference to a Sharty thread: the label links to the thread's copy on archived.st, and every other capture of the thread follows as a link in parentheses.
Usage
[edit source]Do not invoke this module directly. Use {{Thread archive}} instead.
Output example
[edit source][archived.st label] (Megalodon) (gyo.tc) (Ghostarchive) ...
Parameters
[edit source]| Parameter | Description |
|---|---|
url, url2, url3, … |
Capture or thread URLs. There is no limit, numbering does not need to be consecutive, and links appear in number order. url and url1 can both be used; url comes first.
|
title |
Label text in place of the generated label. A ] in it is escaped so it cannot end the link.
|
board, thread, post |
The thread's identity, for references whose URLs do not contain it (for example a Ghostarchive capture). board may be written soy or /soy/; thread and post must be numbers. board and thread are only used together, and they take priority over any identity read from the URLs.
|
archivedst |
no suppresses the archived.st link that the module would otherwise build. It has no effect when an archived.st URL is supplied directly.
|
nocat |
yes suppresses the tracking categories.
|
Labeling
[edit source]In order of preference:
1. title if given.
2. /board/ Thread No. N, followed by , Post No. P. when the URL points to a post. No post is shown when the post is the OP.
3. Archived thread, fallback when the thread cannot be identified.
Main link
[edit source]The label links to an archived.st URL supplied in any url parameter, used exactly as given. Otherwise, https://archived.st/board/thread/N.html is set, or when the thread number is below the floor[a] archived.st only holds threads from around October 2026[b] onward. The module (nor the bot) does not check that a copy exists, it relies on never-changing thread IDs and assumes the archiver services are reliable.
Other links
[edit source]Each other URL becomes a link in parantheses, labelled by its site.
| Site | Label | Notes |
|---|---|---|
| megalodon.jp | Megalodon | A timestamped capture on either site produces both links: the supplied URL as given, plus the same capture rebuilt on the other site. The same capture supplied on both sites appears only once. A gyo.tc shortcut without a timestamp produces only its own link. |
| gyo.tc | gyo.tc | |
| ghostarchive.org | Ghostarchive | The thread cannot be read from the URL. Use board and thread to give it an archived.st link.
|
| soyjak.st | original | A live link to the thread. |
| archived.st | - | Used as the main link, not repeated. |
| any other site | its domain | Triggers unknown status, adds a tracking category. |
Identical URLs appear only once. Two or more megalodon captures of the same thread taken at different times, however, are kept.
Errors
[edit source]Problems never change what readers see, therefore this module suppresses all script errors to a preview warning. The warnings are as follows:
| Problem | Warning |
|---|---|
No URL and no board/thread |
no URL given, nothing is rendered |
A URL that does not start with http:// or https:// |
invalid URL, naming it, the URL is left out |
| A Sharty or archived.st URL that is not a thread, such as a catalog | is not a thread URL, naming it |
| URLs that point to different threads, or different posts of the same thread | points to a different thread or post, naming the first one that disagrees. the first thread found is used |
Cats
[edit source]Only added in the main namespace, and can be suppressed by nocat=yes:
- Category:Thread archive errors - used when any of the problems above happen.
- Category:Thread archive links to unknown sites - if the unknown condition is triggered due to usage of an URL from a site the configuration does not list, this will be issued.
Config
[edit source]Sites, labels, floors, label text, warnings, cat names, and tracked namespaces can all be set in Module:Thread archive/config.
Currently, archivedst.minThread is a single number and applies to every board. Boards are numbered separately, so threads on boards with lower numbers (like /pol/) get no link. This will be patched later.
Notes
