Template:comic/doc

2026-05-13T14:25:31Z

204.14.14.181: /* Tests */ Testing the limits of the template

<noinclude><big><big>This page is transcluded inside [[Template:comic]] as its documentation, so everyone can edit it.</big></big>

</noinclude>'''The template {{tl|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.

[https://www.explainxkcd.com/wiki/index.php?title=Template:comic/doc&action=edit ''(edit documentation)'']__NOTOC__
== Usage ==
<pre>{{comic
| number =
| date =
| title =
| ognumber =
| oglink =
| ogttlabel =
| ogtitle =
| ogprev =
| ognote =
| ognext =
| before =
| image =
| custom =
| imagesize =
| noexpand =
| titletext =
| ttstyle =
| bodystyle =
| bodyclass =
| extra =
| ldomain =
| lappend =
}}</pre>
{{notice|The new parameters are undocumented! There's some info about them [https://www.explainxkcd.com/wiki/index.php?title{{=}}Template:comic/sandbox&action{{=}}edit in the code].<pre>
ogttlabel = optional
ognumber =
ogprev = required if ognumber given, otherwise throws an error
ognote = optional
ognext = required if ognumber given, otherwise throws an error
</pre>}}

{| class="wikitable sortable"
! Parameter
! Usage
! Description
|-
| '''<code>number</code>'''
| Required in normal circumstances
| rowspan="3" | The comic's basic information. In normal circumstances, these should always be defined.
|-
| '''<code>title</code>'''
| Required in normal circumstances
|-
| '''<code>image</code>'''
| Required in normal circumstances
|-
| '''<code>date</code>'''
| Optional; omit if unreleased or undated
| The date the comic was first published and should be written in the form <code>mmmm d, yyyy</code>. (Full month name, day number without digit padding, 4-digit year. Example: <code>January 1, 2006</code>). If the comic [[:Category:No date|has no date]] or [[:Category:Unreleased comics|has not been released]], it should be omitted.
|-
| '''<code>ognumber</code>'''
| rowspan="3" | Optional; only used for early comics
| rowspan="3" | Must always be used together for [[LiveJournal|the early xkcd comics]], not when Randall [[:Category:Comics edited after their publication|changes the title]] of an existing comic. Note that if '''<code>ognumber</code>''' is given, some parameters are required.
|-
| '''<code>oglink</code>'''
|-
| '''<code>ogtitle</code>'''
|-
| '''<code>before</code>'''
| 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 <code><nowiki>[[#Explanation|↓ Skip to explanation ↓]]</nowiki></code>.
|-
| '''<code>imagesize</code>'''
| Optional; limits image display size
| Limits the size of the image in pixels.
*To limit the width, simply list the width. E.g.: <code>350px</code>
* To limit the height, prepend an "x" to the desired height. E.g.: <code>x400px</code><br />
Note that, if the '''<code>imagesize</code>''' is larger than the '''<code>image</code>''', the image will be stretched.
|-
| '''<code>noexpand</code>'''
| Optional; used when imagesize limits display
| Boolean to hide the "Click to enlarge" button, usually when using '''<code>imagesize</code>'''.
|-
| '''<code>custom</code>'''
| Optional; overrides image
| Replaces the comic image with custom text or content.
|-
| '''<code>titletext</code>'''
| Optional; sets title text
| Sets the [[Title text|title text]] of the comic.
|-
| '''<code>ttstyle</code>'''
| Optional; styles title text
| Sets the CSS style of the '''<code>titletext</code>''' span element.
|-
| '''<code>bodystyle</code>'''
| Optional; sets wrapper style
| Sets the inline CSS style of the outer comic container.
|-
| '''<code>bodyclass</code>'''
| Optional; sets wrapper class
| Sets the HTML class attribute of the outer comic container.
|-
| '''<code>extra</code>'''
| Optional; boolean
| When set to <code>yes</code>, adds the page to the [[:Category:Extra comics|Extra comics]] category.
|-
| '''<code>lappend</code>'''
| Required if <code>number</code> is missing
| The part of the link appended to <code>xkcd.com/</code> in "wide link mode". Required when <code>number</code> is not set.
|-
| '''<code>ldomain</code>'''
| Optional; changes link domain
| Sets the subdomain for the link (e.g., <code>blog</code> for blog.xkcd.com). Defaults to <code>www</code>. For example, if the link is to a blog post (blog.xkcd.com), '''<code>ldomain</code>''' should be set to <code>blog</code>. The resulting link when using <code>lappend</code> and optionally <code>ldomain</code> is:<br />
<code>https://'''ldomain'''.xkcd.com/'''lappend'''</code>
|}

== Example 1 ==
{{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.
}}

The example above is produced by the following code:

<pre>{{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.
}}</pre>

== Example 2 ==
{{comic
| number = 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
}}

The example above is produced by the following code:

<pre>{{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
}}</pre>

==Tests==
{{comic
| number = 3070
| date = April 21, 2025
| title = Air Fact
| image = air_fact_2x.png
| imagesize = 250x394px
| noexpand = true
| titletext = 'Wow, that must be why you swallow so many of them per year!' 'No, that's spiders. You swallow WAY more ants.'
}}

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

{{comic
| ognumber = 7
| ogtitle = Hello there
| ogttlabel = Libehuornel title
| number = 8
| ognext = 12
| ogprev = 8
| 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
| image = pi.jpg
| titletext = My most famous drawing, and one of the first I did for the site
}}

{{comic/sandbox
| ognumber = 9
| number = 10
| ogprev = 8
| ognext = 12
| ognote =
| date = September 30, 2005
| title = Pi Equals
| ogtitle = Pi Equa
| 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
}}

{{comic/sandbox
| number = 2147483647
| date = January 1st, 20400000
| title = 32 Bit Limit
| image = cant_sleep.png
| titletext = Testing the limits of the comic template.
}}

{{comic/sandbox
| number = 9223372036854775807
| date = January 1st, 87617332838400000
| title = 64 Bit Limit
| image = cant_sleep.png
| titletext = Testing the limits of the comic template.
}}

{{comic/sandbox
| number = 179769313486231570814527423731704356798070567525844996598917476803157260780028538760589558632766878171540458953514382464234321326889464182768467546703537516986049910576551282076245490090389328944075868508455133942304583236903222948165808559332123348274797826204144723168738177180919299881250404026184124858368
| date = January 1st, 1707716842703113353352047622106917573632076691019742271031858732836185807594950056457686904011769683789991709884686041458759880330307298160394668011502032787397744872520924875407623601437651562303477185321043353089272525751413596832713917939393696447443159344051974643835861368443793969348473315865394563122.5585937499999309496094420334193828079325484221319260162288011038454148549340859217753372183725222613874503432637071166240374493309710480868536887757743085888637652397617048540059715147026764167
| title = Floating Point Limit
| image = day_counter.png
| titletext = Testing the limits of the comic template.
}}

{{comic/sandbox
| number = -1
| ognumber = -1
| ogprev = -2
| ognext = 0
| date = September 30, 2005
| title = Negative
| image = software_testing_day_2x.png
| titletext = Testing the limits of the comic template.
}}

{{comic/sandbox
| number = one
| date = September 30, 2005
| title = Word Instead
| image = new_bug.png
| titletext = Testing the limits of the comic template.
}}

{{comic/sandbox
| number = {{comic/sandbox
| number = {{comic/sandbox
| number = 1000
| date = September 30, 2005
| title = Recursion
| image = to_be_wanted.png
| titletext = Testing the limits of the comic template.
}}
| date = September 30, 2005
| title = Recursion
| image = {{comic/sandbox
| number = 1000
| date = September 30, 2005
| title = Recursion
| image = to_be_wanted.png
| titletext = Testing the limits of the comic template.
}}
| titletext = Testing the limits of the comic template.
}}
| date = September 30, 2005
| title = Recursion
| image = {{comic/sandbox
| number = {{comic/sandbox
| number = 1000
| date = September 30, 2005
| title = Recursion
| image = to_be_wanted.png
| titletext = Testing the limits of the comic template.
}}
| date = September 30, 2005
| title = Recursion
| image = {{comic/sandbox
| number = 1000
| date = September 30, 2005
| title = Recursion
| image = to_be_wanted.png
| titletext = Testing the limits of the comic template.
}}
| titletext = Testing the limits of the comic template.
}}
| titletext = Testing the limits of the comic template.
}}

{{comic/sandbox
| number = 1000
| date = September 30, 2005
| title = Hyper Recursion
| image = {{Template:comic/sandbox}}
| titletext = Oh no.
}}

explain xkcd - User contributions [en]

Template:comic/doc