Difference between revisions of "Template:comic/sandbox"

Explain xkcd: It's 'cause you're dumb.
Jump to: navigation, search
m
m
Line 139: Line 139:
 
     -->}}}}}}|}}<!--
 
     -->}}}}}}|}}<!--
 
     --></includeonly><noinclude><!--
 
     --></includeonly><noinclude><!--
 
 
  
 
       DOCUMENTATION
 
       DOCUMENTATION
 
+
-->
-->'''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 ==
 
 
 
{{comic/sandbox
 
| number    = 3048
 
| date      = February 7, 2025
 
| title    = Suspension Bridge
 
| image    = suspension_bridge_2x.png
 
| before    =
 
| ogtitle  = Super Suspension Bridge
 
| oglink    = https://web.archive.org/web/20070927001941/http://xkcd-drawings.livejournal.com/?skip=40#:~:text=8%3A38%20pm-,Barrel,-He%27s%20fairly%20upbeat
 
| 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.
 
}}
 
 
 
== Usage ==
 
 
 
<pre>{{comic
 
| number    =
 
| date      =
 
| title    =
 
| before    =
 
| image    =
 
| custom    =
 
| imagesize =
 
| noexpand  =
 
| titletext =
 
| ldomain  =
 
| lappend  =
 
}}</pre>
 
 
 
=== Notes ===
 
* At least the '''<code>number</code>''', '''<code>title</code>''', and '''<code>image</code>''' are required.
 
 
 
* The '''<code>date</code>''' should be written in the form: <code>January 1, 2006</code>
 
 
 
* The '''<code>imagesize</code>''' 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 '''<code>imagesize</code>''' is larger than the '''<code>image</code>''', the image will be stretched.
 
 
 
* The '''<code>noexpand</code>'''field is optional.
 
** It is used in conjunction with '''<code>imagesize</code>''', hiding the "Click comic to enlarge" button
 
** To use this option, you must set it to '''<code>true</code>'''
 
 
 
* '''<code>before</code>''' 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 '''<code>custom</code>''' field is not empty, the image field will be ignored and be replaced with any text that you put in the '''<code>custom</code>''' field.
 
 
 
* If '''<code>number</code>''' is left undefined, most of the navigation bar will be disabled.
 
** '''<code>lappend</code>''' must be defined as <pre>...kd.com/LAPPEND/</pre> to keep the link to xkcd.com valid.
 
**For example, if the link is to a blog post (blog.xkcd.com), '''<code>ldomain</code>''' can be defined as <pre>blog</pre> to change the subdomain in the link.
 
 
 
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>
 
 
 
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 16:43, 18 April 2025