Template:ArchiveAccess/doc

This template is to be used on citation templates to simplify coding archival links. This passes the appropriate data to Module:ArchiveAccess, which builds the appropriate archival link.

Usage

Copy the template code below and paste it into the appropriate place in an article. Fill in the required fields plus as many of the optional fields as necessary and remove any that you don't use.

{{ArchiveAccess
    |template_name=
    |full_url=
    |target=
    |archiveurl=
    |archivedate=
    |archivefile=
    |nobackup=
    |nolive=
    |use_lua_subpage=
    |no_archive=
    |par=
    |text=
    |space=
    |social_media_citation=
    |nobackup_text=
    |nolive_text=
    |font_size=
    |optional=
}}

Required parameters

• |template_name= Name of the template this is being used on, minus the namespace or Template: prefix.
• |target= Partial URL of the source to be used, such as {{{url|}}}, {{{link|}}} or {{{altlink|}}} depending on what the citation template uses. If the template has access to its own archive repository, this value will be used to lookup the relevant Wayback archive timestamp.
• |full_url= The full URL of the source, which may require prepending the domain (https://www.starwars.com/) with the appropriate citation's {{{url|}}}, {{{link|}}} or {{{altlink|}}} parameter. This is used to create the Wayback archive link alongside the archivedate.
• |archivedate= The archivedate for Wayback. Most templates use {{{archivedate|}}}.
• |archiveurl= Most templates use {{{archiveurl|}}}.
• |nobackup= Most templates use {{{nobackup|}}}.
• |archivefile= Some social media sites don't work well with archival websites like Wayback, so screenshots are uploaded to Wookieepedia and used instead. Templates should use {{{archivefile|}}}.
• |par= Use |par=1, to wrap parenthesis around the backup link text.

Optional parameters

• |nolive= Most templates use {{{nolive|}}}.
• |use_lua_subpage= For templates that have their own Lua-based Module:ArchiveAccess archive subpage (this is the central archive reposistory for that template), use |use_lua_subpage=1. If the template instead has a wikitext-based subpage (Template:<template>/Archive), then leave blank or remove entirely.
• |no_archive= For templates that have their own archive subpage (this is the central archive reposistory for that template), leave blank or remove. Otherwise, use |no_archive=1.
• |text= To pipelink the backup link text to something else. Default is "backup link."
• |space= If something other than a space is required to separate the archival link.
• |social_media_citation= Passes this value to "citation_type", which determines which maintenance category is used when the citation template is used without the proper archival links. Default is "Pages" when left blank, which will result in Category:Pages with missing permanent archival links, otherwise Category:Social media citations with missing permanent archival links when |social_media_citation=1 is used.
• |nobackup_text= To customize the text displayed when |nobackup=1 is used.
• |nolive_text= To customize the text displayed when |nolive=1 is used.
• |font_size= Default is small. To increase the font size to match the surrounding text, use |font_size=.
• |optional= If an archive link is optional, for example, when used in an external links section of a page, use |optional=1. When used in conjunction with missing archival links, this hides the display of the "(backup link not verified!)" portion of text next to the target citation template and also prevents tracking categories being added to the page too.

Example(s)

Standard citation archive syntax using central archive

{{ArchiveAccess
    |template_name=HasbroCite
    |full_url={{#if:{{{link|}}}|https://hasbropulse.com/{{{link}}}|{{{altlink|}}}}}
    |target={{{link|{{{altlink|}}}}}}
    |archiveurl={{{archiveurl|}}}
    |nobackup={{{nobackup|}}}
    |nolive={{{nolive|}}}
    |use_lua_subpage=1
    |par=1
}}

Social media citation archive syntax without central archive

{{ArchiveAccess
    |template_name=InstagramCite
    |full_url=https://instagram.com/{{{2|{{{url|}}}}}}
    |target={{{url|}}}
    |archiveurl={{{archiveurl|}}}
    |archivedate={{{archivedate|}}}
    |archivefile={{{archivefile|}}}
    |nobackup={{{nobackup|}}}
    |nolive={{{nolive|}}}
    |no_archive=1
    |par=1
    |social_media_citation=1
}}

Syntax with custom nobackup text, larger font size and no parenthesis

{{ArchiveAccess
    |template_name=Twitch
    |full_url=http://{{{domain|www}}}.twitch.tv/videos/{{{7|{{{video}}}}}}
    |target={{{7|{{{video}}}}}}
    |text={{{4|{{{text}}}}}}
    |archiveurl={{{archiveurl|}}}
    |archivedate={{{archivedate|}}}
    |archivefile={{{archivefile|}}}
    |nobackup={{{nobackup|}}}
    |nobackup_text=[Archive link not available]
    |nolive={{{nolive|}}}
    |no_archive=1
    |font_size=
    |social_media_citation=1
}}