Difference between revisions of "Template:comic/doc"

Explain xkcd: It's 'cause you're dumb.
Jump to: navigation, search
(This page WILL BE transcluded into Template:comic as its documentation. (once the changes are approved by an admin))
m
Line 1: Line 1:
−
<noinclude><big><big>This page WILL BE transcluded into [[Template:comic]] as its documentation. (once the changes are approved by an admin)</big></big>
+
<noinclude><big><big>This page is transcluded into [[Template:comic]] as its documentation.</big></big>
  
 
----
 
----
  
−
</noinclude>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.
+
'''This template has an associated sandbox, available at [[Template:comic/sandbox]].'''</noinclude>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.
 
__NOTOC__
 
__NOTOC__
 
== Example ==
 
== Example ==
Line 19: Line 19:
 
== Example 2 ==
 
== Example 2 ==
 
{{comic/sandbox
 
{{comic/sandbox
−
| number    = 1
+
| number    = 2
 
| date      = September 30, 2005
 
| date      = September 30, 2005
 
| title    = Barrel - Part 1
 
| title    = Barrel - Part 1
Line 62: Line 62:
 
* 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 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; at least '''<code>lappend</code>''' must be defined if '''<code>number</code>''' is undefined.
+
* If '''<code>number</code>''' is left undefined, most of the navigation bar will be disabled.
−
** '''<code>lappend</code>''' ('''L'''ink '''APPEND''') is the text that is appended to <code>xkcd.com/</code> in the link.
+
** '''<code>lappend</code>''' must be defined as <pre>...kd.com/LAPPEND/</pre> to keep the link to xkcd.com valid.
−
** '''<code>ldomain</code>''' ('''L'''ink '''DOMAIN''') is the subdomain of the link, defaulting to <code>www</code>. It is placed before <code>.xkcd.com/</code>
+
**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.
−
*** For example, if the link is to a blog post (blog.xkcd.com), '''<code>ldomain</code>''' can be defined as <code>blog</code>.
 
−
** The resulting link will be <code>'''ldomain'''.xkcd.com/'''lappend'''</code> whenever '''<code>number</code>''' is undefined.
 
  
 
The example above is produced by the following code:
 
The example above is produced by the following code:

Revision as of 19:34, 18 April 2025

This page is transcluded into Template:comic as its 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

Suspension Bridge
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.
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.

    Example 2

    Barrel - Part 1
    Original title: Barrel
    Don't we all.Original caption: He's fairly upbeat about the situation!
    Title text: Don't we all.

    Original caption: He's fairly upbeat about the situation!
      Warning: Default sort key "0002" overrides earlier default sort key "3048".

      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.
        • lappend must be defined as 
          ...kd.com/LAPPEND/
          to keep the link to xkcd.com valid.
        • For example, if the link is to a blog post (blog.xkcd.com), ldomain can be defined as 
          blog
          to change the subdomain in the link.

      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.
}}
      Retrieved from "https://www.explainxkcd.com/wiki/index.php?title=Template:comic/doc&oldid=373510"