Difference between revisions of "Template:comic/doc"

Explain xkcd: It's 'cause you're dumb.
Jump to: navigation, search
m
(making documentation more concise)
Line 5: Line 5:
 
'''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.
 
'''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 1 ==
  
 
{{comic/sandbox
 
{{comic/sandbox
Line 45: Line 45:
  
 
=== Notes ===
 
=== Notes ===
−
* At least the '''<code>number</code>''', '''<code>title</code>''', and '''<code>image</code>''' are required.
+
* '''<code>number</code>''', '''<code>title</code>''', and '''<code>image</code>''' are the comic number, comic title, and comic image, and are required.
  
−
* The '''<code>date</code>''' should be written in the form: <code>January 1, 2006</code>
+
* '''<code>date</code>''' is the date the comic was published and should be written in the form <code>mmmm d, yyyy</code> (full month name, day number without padding, 4-digit year; i.e. <code>January 1, 2006</code> for 2006-1-1)
  
−
* The '''<code>imagesize</code>''' field is optional.
+
* '''<code>imagesize</code>''' limits the size of the image in units of pixels. This parameter is optional.
−
** The comic's width will be limited to the set size. Format must be in pixels (eg: "350px")
+
** To limit the width, simply list the width (e.g.: "350px").
−
** The comic's height may be set by adding an 'x' to the start (eg: "x350px")
+
** To limit the height, prepend an "x" to the desired height (e.g.: "x350px"
 
** Warning: If the '''<code>imagesize</code>''' is larger than the '''<code>image</code>''', the image will be stretched.
 
** 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.
+
* '''<code>noexpand</code>''' is a boolean parameter indicating whether the "Click comic to enlarge" button is hidden, usually used when '''<code>imagesize</code>''' is limiting the size of the comic. To hide the button, set this to <code>true</code>. This parameter 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.
+
* '''<code>before</code>''' is 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]]. The text provided to this parameter is placed on the line between the title and the image. This parameter is optional.
 +
** The wikitext to skip to the explanation is <code><nowiki>[[#Explanation|↓ Skip to explanation ↓]]</nowiki></code>.
  
−
* 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.
+
* '''<code>custom</code>''' overrides the '''<code>image</code>''' parameter and replaces the image with the text provided. This parameter is optional.
  
 
* 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; at least '''<code>lappend</code>''' must be defined if '''<code>number</code>''' is undefined.

Revision as of 20:11, 18 April 2025

This page WILL BE transcluded into Template:comic as its documentation. (once the changes are approved by an admin)

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 1

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 "0001" overrides earlier default sort key "3048".

        Usage

        {{comic
| number    =
| date      =
| title     =
| before    =
| image     =
| custom    =
| imagesize =
| noexpand  =
| titletext =
| ldomain   =
| lappend   =
}}

        Notes

        • number, title, and image are the comic number, comic title, and comic image, and are required.
        • date is the date the comic was published and should be written in the form mmmm d, yyyy (full month name, day number without padding, 4-digit year; i.e. January 1, 2006 for 2006-1-1)
        • imagesize limits the size of the image in units of pixels. This parameter is optional.
          • To limit the width, simply list the width (e.g.: "350px").
          • To limit the height, prepend an "x" to the desired height (e.g.: "x350px"
          • Warning: If the imagesize is larger than the image, the image will be stretched.
        • noexpand is a boolean parameter indicating whether the "Click comic to enlarge" button is hidden, usually used when imagesize is limiting the size of the comic. To hide the button, set this to true. This parameter is optional.
        • before is 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. The text provided to this parameter is placed on the line between the title and the image. This parameter is optional.
          • The wikitext to skip to the explanation is [[#Explanation|↓ Skip to explanation ↓]].
        • custom overrides the image parameter and replaces the image with the text provided. This parameter is optional.
        • If number is left undefined, most of the navigation bar will be disabled; at least lappend must be defined if number is undefined.
          • lappend (Link APPEND) is the text that is appended to xkcd.com/ in the link.
          • ldomain (Link DOMAIN) is the subdomain of the link, defaulting to www. It is placed before .xkcd.com/
            • For example, if the link is to a blog post (blog.xkcd.com), ldomain can be defined as blog.
          • The resulting link will be ldomain.xkcd.com/lappend whenever number is undefined.

        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=373532"