Template:Signpost/Deadline/doc

This is a documentation subpage for Template:Signpost/Deadline.
It may contain usage information, categories and other content that is not part of the original template page.

Description

This template shows a little progress chart of the deadline for writers and editors. It is most notably transcluded at Wikipedia:Wikipedia Signpost/Newsroom. It also appears in the headers of Signpost drafts: it is transcluded there by its transclusion in {{Signpost draft}}. It is also transcluded in Template:Editnotices/Group/Wikipedia:Wikipedia Signpost/Drafts, and several editors' userpages.

This template needs to be edited manually each time we publish, so that it will show the time for the next issue.

You can fetch the raw timestamp (currently "2024-12-08 00:00 UTC") with {{Signpost/Deadline/raw}}.^[1]

(Purge)

Calendar: current deadline is highlighted, and current UTC date is 2024-11-28 14:47:32.

This calendar can be found at {{Signpost/Deadline/calendar}}.

Parameters

Input parameters (used when transcluding Signpost/Deadline)

Transclusions of {{Signpost/Deadline}} can include optional parameters to adjust its output.

|draft=yes: By default the template's output is wrapped in a {{notice}} box for use as a standalone element added to pages. If the |draft= parameter is supplied with any value, the notice frame is omitted, and the template's output is suitable for inclusion within a larger layout.; (This option is used to embed the deadline display in both the {{Signpost draft}} article header, and the draft editnotice.)

|short=yes: When set, disables the addition of "(N days left; XX%)" following the date displayed for each bar. Allows the template to be used in narrower layouts.

Internal parameters (passed to subtemplates)

Two date/time values are set in the source of this template, as parameters to the {{Signpost/Deadline/dateswrap}} subtemplate transclusion.

|previous-issue=date

Recommended format: |previous-issue=YYYY-MM-DD

The date of the most recent Signpost issue published. Used to set the lower end ("starting point") of the deadline date range. Can technically be in any format accepted by the #time: parser function, though any time components provided will be silently ignored.

You can just use {{Wikipedia:Wikipedia Signpost/Templates/Issue|1}} for this lol. Why didn't we do that before?

|next-issue=date and time: Recommended format: |next-issue=YYYY-MM-DD HH:MM UTC; The publication deadline for the next upcoming Signpost. Should include the time of release, optionally using a local clock with appropriate timezone specified. (Using anything other than UTC is, however, severely discouraged).

The |next-issue= value is the canonical single source of what the deadlines actually are (i.e. editing this template changes the deadlines).

Dependencies

The template transcludes multiple subtemplates: {{Signpost/Deadline/draftwrap}} is used to process the |draft= parameter, and {{Signpost/Deadline/dateswrap}} is passed the date parameters for processing, and it in turn transcludes {{Signpost/Deadline/core}} to create the final output.

History

This template was created in March 2019 by Headbomb.

In November 2022, it was reworked by FeRDNYC; relevant talk page sections are DRY version, Date argument formatting, and Human-friendly date support

Notes

References

^ This uses {{Template parameter value}} to fetch the value from {{Signpost/Deadline}}.

[1] This uses {{Template parameter value}} to fetch the value from {{Signpost/Deadline}}.

[1]