Difference between revisions of "Template:comic/sandbox"

Explain xkcd: It's 'cause you're dumb.
Jump to: navigation, search
Line 57: Line 57:
 
           Generate the title, with date if it exists
 
           Generate the title, with date if it exists
 
           --><span style="color: #FFFFFF; padding: 0 12px;">Comic&nbsp;<!--
 
           --><span style="color: #FFFFFF; padding: 0 12px;">Comic&nbsp;<!--
−
           -->{{#ifexpr:{{{number|-1}}}>= 1|&#35;|}}{{{number|}}}&nbsp;{{#if:{{{date|}}}|({{#replace:{{{date}}}| |&nbsp;}})}}</span>]</li><!--
+
           -->{{#ifexpr:{{{number|-1}}}>= 1|&nbsp;&#35;|}}{{{number|}}}&nbsp;{{#if:{{{date|}}}|({{#replace:{{{date}}}| |&nbsp;}})}}</span>]</li><!--
  
 
         Now make the next and >| buttons provided comic number exists
 
         Now make the next and >| buttons provided comic number exists
Line 86: Line 86:
  
 
     Comic title in =BOLD=
 
     Comic title in =BOLD=
−
     -->{{#if:{{{title|}}}|<tr><td style="font-size: 20px; padding-bottom:10px">'''{{{title}}}'''</td></tr>}}<!--
+
     -->{{#if:{{{title|}}}|<tr><td style="font-size: 21px; font-variant: small-caps; font-weight: 800; padding-bottom:10px">{{{title}}}</td></tr>}}<!--
  
 
     Display the (optional) text just before the comic
 
     Display the (optional) text just before the comic
Line 130: Line 130:
 
     -->}}}}}}|}}<!--
 
     -->}}}}}}|}}<!--
 
--></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.
 
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.
  
Line 136: Line 142:
  
 
The following is a sample usage of this template:
 
The following is a sample usage of this template:
−
{{comic
+
{{comic/sandbox
 
| number    = 16
 
| number    = 16
 
| date      = October 4, 2005
 
| date      = October 4, 2005
Line 162: Line 168:
 
=== Notes ===
 
=== Notes ===
  
−
* At least the number, title and image are required.
+
* At least the <code>number</code>, <code>title</code>, and <code>image</code> are required.
−
* The date should be written in the form: January 1, 2006
+
 
−
* The imagesize field is optional.
+
* The <code>date</code> should be written in the form: <code>January 1, 2006</code>
−
** 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")
+
* The <code>imagesize</code> field is optional.
−
** Warning: If the size is larger than the image, the image will be stretched.
+
** The comic's width will be limited to the set size. Format must be in pixels (eg: "350px")
−
* The noexpand field is optional.
+
** The comic's height may be set by adding an 'x' to the start (eg: "x350px")
−
** It is used in conjunction with '''imagesize''', hiding the "Click comic to enlarge" button
+
** 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>
 
** To use this option, you must set it to <code>true</code>
−
* '''before''' is a special field for inserting text before the comic. One use is for extremely large comics (e.g. [[Umwelt]]), 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.
+
* <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 '''number''' is left undefined, most of the navigation bar will be disabled.
+
 
−
** '''lappend''' must be defined as <pre>...kd.com/'''lappend'''/</pre> to keep the link to xkcd.com valid.
+
* 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 link is to eg. a blog post (blog.xkcd.com) '''ldomain''' can be defined as <pre>blog</pre> to change the subdomain in the link.
+
 
 +
* 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 above sample is produced by the following code:
 
The above sample is produced by the following code:

Revision as of 11:13, 18 April 2025

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.

Sample

The following is a sample usage of this template:

Monty Python -- Enough
I went to a dinner where there was a full 10 minutes of Holy Grail quotes exchanged, with no context, in lieu of conversation. It depressed me badly.
Title text: I went to a dinner where there was a full 10 minutes of Holy Grail quotes exchanged, with no context, in lieu of conversation. It depressed me badly.

    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 above sample is produced by the following code: 

    {{comic
| number    = 16
| date      = October 4, 2005
| title     = Monty Python -- Enough
| image     = monty_python.jpg
| titletext = I went to a dinner where there was a full 10 minutes of Holy Grail quotes exchanged, with no context, in lieu of conversation.  It depressed me badly.
}}
    Retrieved from "https://www.explainxkcd.com/wiki/index.php?title=Template:comic/sandbox&oldid=373357"