Difference between revisions of "User:Yfmcpxpj/Template:comic 2x test"

Explain xkcd: It's 'cause you're dumb.
Jump to: navigation, search
(Clarify optional parameters for 2x button.)
(Update with explanation of this template vs. main comic template.)
Line 185: Line 185:
 
--></includeonly><noinclude>
 
--></includeonly><noinclude>
 
<!--    DOCUMENTATION  -->
 
<!--    DOCUMENTATION  -->
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 a test version of [[Template:comic]], which 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 particular version adds a "2x" button to link to the comic's double-resolution image on xkcd.com.
  
 
== Sample ==
 
== Sample ==
Line 235: Line 235:
  
 
<pre>{{User:Yfmcpxpj/Template:comic 2x test
 
<pre>{{User:Yfmcpxpj/Template:comic 2x test
| number    = 16
+
| number    = 1084
| date      = October 4, 2005
+
| date      = July 20, 2012
| title    = Monty Python -- Enough
+
| title    = Server Problem
| image    = monty_python.jpg
+
| image    = server_problem.png
| 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.
+
| titletext = Protip: Annoy Ray Kurzweil by always referring to it as the 'Cybersingularity'.
 
}}</pre>
 
}}</pre>
  
 
[[Category:Templates]]
 
[[Category:Templates]]
 
</noinclude>
 
</noinclude>

Revision as of 23:29, 11 October 2020

This is a test version of Template:comic, which 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 particular version adds a "2x" button to link to the comic's double-resolution image on xkcd.com.

Sample

The following is a sample usage of this template:

Server Problem
Protip: Annoy Ray Kurzweil by always referring to it as the 'Cybersingularity'.
Title text: Protip: Annoy Ray Kurzweil by always referring to it as the 'Cybersingularity'.

Usage

{{User:Yfmcpxpj/Template:comic 2x test
| number    =
| date      =
| title     =
| before    =
| image     =
| custom    =
| imagesize =
| titletext =
| ldomain   =
| lappend   =
| override2x=
| omit2x    =
}}

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 size is larger than the image, the image will be stretched.
  • 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.
  • 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.
    • If the link is to eg. a blog post (blog.xkcd.com) ldomain can be defined as
      blog
      to change the subdomain in the link.
  • For comics as of 1084, a "2x" button will automatically appear, linking to the double-size version of the comic on xkcd.com. That behavior can be modified with the following optional parameters:
    • If the 2x image for a particular comic doesn't exist, or has some other problem, the "2x" button can be omitted by specifying a non-zero/non-empty value for omit2x (example: omit2x=true).
    • Or, if the filename of the 2x file is different, a specific image filename can be specified for override2x, even for older comics (example: override2x=server_problem_2x.png).

The above sample is produced by the following code:

{{User:Yfmcpxpj/Template:comic 2x test
| number    = 1084
| date      = July 20, 2012
| title     = Server Problem
| image     = server_problem.png
| titletext = Protip: Annoy Ray Kurzweil by always referring to it as the 'Cybersingularity'.
}}