Template:comic/doc

This page is transcluded inside Template:comic as its documentation, so everyone can edit it.

The template {{comic}} 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.

(edit documentation)

Usage

{{comic
| number    =
| date      =
| title     =
| ognumber  =
| oglink    =
| ogttlabel =
| ogtitle   =
| ogprev    =
| ognote    =
| ognext    =
| before    =
| image     =
| custom    =
| imagesize =
| noexpand  =
| titletext =
| ttstyle   =
| bodystyle =
| bodyclass =
| extra     =
| ldomain   =
| lappend   =
}}

The new parameters are undocumented! There's some info about them in the code. ogttlabel = optional ognumber = ogprev = required if ognumber given, otherwise throws an error ognote = optional ognext = required if ognumber given, otherwise throws an error

Parameter	Usage	Description
number	Required in normal circumstances	The comic's basic information. In normal circumstances, these should always be defined.
title	Required in normal circumstances
image	Required in normal circumstances
date	Optional; omit if unreleased or undated	The date the comic was first published and should be written in the form mmmm d, yyyy. (Full month name, day number without digit padding, 4-digit year. Example: January 1, 2006). If the comic has no date or has not been released, it should be omitted.
ognumber	Optional; only used for early comics	Must always be used together for the early xkcd comics, not when Randall changes the title of an existing comic. Note that if ognumber is given, some parameters are required.
oglink
ogtitle
before	Optional; used for long comics	Used to insert text before the comic, usually to insert a link to skip to the explanation on extremely large comics like 1732: Earth Temperature Timeline or for the comic itself if it's just text like Blue Eyes. The text provided to this parameter is placed on the line between the title and the image. This parameter is optional. The wikitext used to jump to the ==Explanation== is [[#Explanation|↓ Skip to explanation ↓]].
imagesize	Optional; limits image display size	Limits the size of the image in pixels. To limit the width, simply list the width. E.g.: 350px To limit the height, prepend an "x" to the desired height. E.g.: x400px Note that, if the imagesize is larger than the image, the image will be stretched.
noexpand	Optional; used when imagesize limits display	Boolean to hide the "Click to enlarge" button, usually when using imagesize.
custom	Optional; overrides image	Replaces the comic image with custom text or content.
titletext	Optional; sets title text	Sets the title text of the comic.
ttstyle	Optional; styles title text	Sets the CSS style of the titletext span element.
bodystyle	Optional; sets wrapper style	Sets the inline CSS style of the outer comic container.
bodyclass	Optional; sets wrapper class	Sets the HTML class attribute of the outer comic container.
extra	Optional; boolean	When set to yes, adds the page to the Extra comics category.
lappend	Required if number is missing	The part of the link appended to xkcd.com/ in "wide link mode". Required when number is not set.
ldomain	Optional; changes link domain	Sets the subdomain for the link (e.g., blog for blog.xkcd.com). Defaults to www. For example, if the link is to a blog post (blog.xkcd.com), ldomain should be set to blog. The resulting link when using lappend and optionally ldomain is: https://ldomain.xkcd.com/lappend

Example 1

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 > >|

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.
}}

Example 2

Pi Equals

Original title: Pi equals

|< < Prev #10 (September 30, 2005) Next > >|

Title text: My most famous drawing, and one of the first I did for the site

|< < Prev Random Explanation Next > >|

The example above is produced by the following code:

{{comic
| ognumber    = 10
| ognumber    = 10
| date      = September 30, 2005
| title     = Pi Equals
| oglink    = https://web.archive.org/web/20070927001941/http://xkcd-drawings.livejournal.com/?skip=40#:~:text=8%3A44%20pm-,Pi%20equals,-(4%20Comments
| ogtitle   = Pi equals
| image     = pi.jpg
| titletext = My most famous drawing, and one of the first I did for the site
}}

Tests

Air Fact

|< < Prev #3070 (April 21, 2025) Next > >|

Title text: 'Wow, that must be why you swallow so many of them per year!' 'No, that's spiders. You swallow WAY more ants.'

|< < Prev Random Explanation Next > >|

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 > >|

Pi Equals

Libehuornel title: Hello there

|< < Prev #8 (September 30, 2005) Next > >|

Title text: My most famous drawing, and one of the first I did for the site

|< < Prev #8 #7 (Original Order) #12 Next > >|

Pi Equals

Original title: Pi equals

|< < Prev #10 (September 30, 2005) Next > >|

Title text: My most famous drawing, and one of the first I did for the site

|< < Prev #8 #9 (Original Order) #12 Next > >|