Template:comic/doc

This page WILL BE transcluded into Template:comic as its documentation. (once the changes are approved by an admin)

---

This template has an associated sandbox, available at Template:comic/sandbox. This is the basic infobox-style header template used to display xkcd comics on their own pages, including the comic number (with external link to xkcd), publication date, title, comic image, and title text.

Example

Suspension Bridge

|< < Prev #3048 (February 7, 2025) Next > >|

Title text: As a first step, they can put in a secondary deck, to help drivers try it out and find out how fun the jumps are. After a while no one will use the old flat deck and they can remove it.

|< < Prev Random Explanation Next > >|

Example 2

Barrel - Part 1

Original title: Barrel

#1 (September 30, 2005) Next > >|

Title text: Don't we all. Original caption: He's fairly upbeat about the situation!

Usage

{{comic
| number    =
| date      =
| title     =
| before    =
| image     =
| custom    =
| imagesize =
| noexpand  =
| titletext =
| ldomain   =
| lappend   =
}}

Notes

• At least the number, title, and image are required.

• The date should be written in the form: January 1, 2006

• The imagesize field is optional.
  • The comic's width will be limited to the set size. Format must be in pixels (eg: "350px")
  • The comic's height may be set by adding an 'x' to the start (eg: "x350px")
  • Warning: If the imagesize is larger than the image, the image will be stretched.

• The noexpandfield is optional.
  • It is used in conjunction with imagesize, hiding the "Click comic to enlarge" button
  • To use this option, you must set it to true

• before is a special field for inserting text before the comic. One use is for extremely large comics (e.g., 1732: Earth Temperature Timeline), to skip to the explanation.

• If the custom field is not empty, the image field will be ignored and be replaced with any text that you put in the custom field.

• If number is left undefined, most of the navigation bar will be disabled; at least lappend must be defined if number is undefined.
  • lappend (Link APPEND) is the text that is appended to xkcd.com/ in the link.
  • ldomain (Link DOMAIN) is the subdomain of the link, defaulting to www. It is placed before .xkcd.com/
    • For example, if the link is to a blog post (blog.xkcd.com), ldomain can be defined as blog.
  • The resulting link will be ldomain.xkcd.com/lappend whenever number is undefined.

The example above is produced by the following code:

{{comic
| number    = 3048
| date      = February 7, 2025
| title     = Suspension Bridge
| image     = suspension_bridge_2x.png
| imagesize = 362x365px
| noexpand  = true
| titletext = As a first step, they can put in a secondary deck, to help drivers try it out and find out how fun the jumps are. After a while no one will use the old flat deck and they can remove it.
}}