View source for explain xkcd:Editor FAQ

{{TOC}}This FAQ is a short description about editing pages at this wiki <i>'cause you're dumb</i>. If you have any further questions do not hesitate to enter them into this [[explain xkcd talk:Editor FAQ|talk page]]. For general questions about wikitext please read first the MediaWiki help pages about [[mw:Help:Editing pages|Editing pages]] or look at the full overview here: [[mw:Help:Contents|Help Contents]]. You also can use your preferred search engine by entering "MediaWiki mytopic". Change mytopic to the theme you're searching for, i.e. "MediaWiki tables" will show you many useful sites about editing tables. Please always use the Preview button to verify your edit before finally pressing the Save button. This FAQ focuses only on topics related to this specific wiki.

==What is the general layout of a comic page?==
In general, you don't have to care about this because the pages are generated by a bot nearly immediately after a new comic is released. If the bot fails, please follow exactly the [[User:dgbrtBOT|instructions here]] to create the comic page.

The layout and order are structured as:
*Comic ''picture'' with the ''title text'' below
*''Explanation''
*''Transcript''
*''Trivia'' (optional)
*''Discussion'' (embedded Talk page) (is sometimes removed if it grows too large)
*List of non-standard ''categories''

==What should I include in the explanation?==
Everything is welcome as long as it explains the content of the comic. Everybody can edit here and when others disagree about your contributions they may change it.
If the comic references a scientific concept, a brief description and a link to its Wikipedia page for further information should be given (see how to do this [[explain_xkcd:Editor_FAQ#How_do_I_enter_links_to_other_pages.3F|here]]).
The explanation should also explain the [[Title text|title text]] of the comic.

==In which cases are tables meaningful, and when are they not?==
In the transcript, tables should never be used. Even when there is a table in the comic image, it should be described using text.

In the explanation, tables only make sense when the content is compact. When a single row contains more than a small item like a number, a small phrase, or something similar, a table isn't the proper layout because it's hard to read. Instead, it should be written in floating text chapters with distinct headers above (see next section below.)

Instead of using a two-column table (e.g. "sentence from comic", "explanation"), consider using a description list (''bold text''). Place a semicolon (<code>;</code>) at the beginning of the sentence to be explained and a colon (<code>:</code>) at the beginning of each paragraph of the explanation, like this (from [[1987: Python Environment#Explanation|1987]]):
 ; Anaconda Python
 : Anaconda is a Python distribution for data science and machine learning related applications.
 : A second paragraph for the explanation.

The Wikipedia's {{w|WP:WHENTABLE#Appropriate use|Manual of Style/Tables}} describes it best:
<blockquote>Often a list is best left as a list. Before reformatting a list into table form, consider whether the information will be more clearly conveyed by virtue of having rows and columns. If so, then a table is probably a good choice. If there is no obvious benefit to having rows and columns, then a table is probably not the best choice. </blockquote>

==What is the proper layout for headers?==
For headlines, you have to use wiki-style code. The simplest way is a preceding semicolon at the beginning of the line which causes the entire line to be rendered in bold.

On large explanations, it can be handy to divide it into subsections. In this case the header is written like this: <code><nowiki>===Sub header===</nowiki></code>. But in most cases, the simple semicolon is just enough.

==What is the format of the transcript section?==
The transcript should describe the content (think about explaining the comic to a visually impaired person, or to someone on phone). It should do this in a compact manner, and cite all written words. Every line should begin with an indent (a simple <code>:</code> at the beginning), and every panel from the comic should be separated by a blank line. The transcript must not contain any links, nor rich math markup, which once again relies on visuals. Tables should generally be avoided, although not all transcripts comply with this. Furthermore, the title text is not included in the transcript. Checking the pages for the older comics will help understand this.

==One or two spaces after a period? And what about newlines?==
Two or more spaces are always rendered as only one, so multiple consecutive spaces can only be seen in the editor. This means it's usually best to only use one space after a period. Furthermore, a single newline is also just rendered as a space, as two newlines are required to form a paragraph.

==What belongs to the trivia section?==
As implied by the section name, it's just trivia, consisting of unimportant odds-and-ends related to the comic. Since this wiki focuses on explaining this section is not part of the default layout. If a word has been misspelled in the comic or title text, or the image was originally broken at xkcd and reuploaded... basically the things that don't belong in the explanation but should still be mentioned, then it should be mentioned in the trivia section.

==How do I behave on the talk page (discussion)?==
Everybody can add here any thoughts about the comic and more. Consider it as the comments section of a blog, because that’s how it has always been (see [[explain xkcd#History]]), just more flexible. Please follow the common netiquette and don't be rude. Unless you are replying to a previous comment, in which you should add a colon before your comment, you should add comments at the bottom. Every comment has to be signed at the end with <nowiki>~~~~</nowiki> or just click the sign button [[File:Button sig.png]] at the top of the editor.

==What does the incomplete tag mean?==
There are two templates to indicate that an explanation or the transcript needs further rework, {{tl|incomplete}} and {{tl|incomplete transcript}}. Just enter <nowiki>{{incomplete|YOUR REASON}}</nowiki> or respectively <nowiki>{{incomplete transcript|YOUR REASON}}</nowiki> and don't forget to enter a proper reason to replace the filler text left by the bot (Created by a BOT - Please change this comment when editing this page. Do NOT delete this tag too soon.), or if the reason said in the tag has been dealt with. The reason for the transcript is not shown to the viewer.

==How do I add references?==
You don’t. It is preferable to link the source you want to cite in the sentence that needs sourcing itself (see [[#How do I enter links to other pages?]]).

==How do I enter links to other pages?==
The three most-used options are:
*an internal link like <code>'''<nowiki>[[Cueball]]</nowiki>'''</code> which renders like this: [[Cueball]]
*a link to the English Wikipedia should be formatted like this: <code>'''<nowiki>{{w|Page}}</nowiki>'''</code> links to the Wikipedia article called "Page" (is shown like this: {{w|Page}}), and <code>'''<nowiki>{{w|Page|Display}}</nowiki>'''</code> links to the same article but is shown like this: {{w|Page|Display}}
*an external link with text: <code>'''<nowiki>[https://example.com Example Homepage]</nowiki>'''</code> links to https://example.com and everything after the first space is shown: [http://www.example.com Example Homepage]

External links can also be done in other two ways:
*just write the URL with no formatting and it will be shown like this: http://www.example.com (Only use this if the specific website address is relevant.)
*put it into single brackets: <code>'''<nowiki>[http://www.example.com]</nowiki>'''</code> and it will be shown like this: [http://www.example.com] (Please avoid this.)

==Why can't I upload pictures or create pages?==
Only registered and trusted users can create pages or upload images. After the registration, you have to wait at least three days and must have done a small number of edits. Then you will be able to create pages and upload images at will. 

==How do I embed images?==
This wiki isn't a picture book. Use this feature only sparingly and reduce the size as much as possible. An example can be seen here: [[1400: D.B. Cooper]]. The syntax in this case is <code><nowiki>[[File:DBCooper.jpg|thumb|150px|Cooper]]</nowiki></code> and the picture is taken from Commons, the main source for Wikipedia images. The full syntax can be found at [[mw:Help:Images|MediaWiki]].

You also can upload pictures directly to this wiki by using the [[Special:Upload]] link from the menu. But do not violate any copyright rules or it will be deleted. And when the picture is available at Commons there is no need to upload it here.

==The picture at xkcd was updated, how do I upload this here?==
Sometimes the initial picture at [[xkcd]] contains typos or other errors. When that has been fixed the comic picture here should also be updated. Save the picture from xkcd to your local PC but be careful, there are two versions available. We here use only the larger version ''picture_2x.png'' and not the smaller one ''picture.png''. So change <code>'''<nowiki>https://imgs.xkcd.com/comics/picture.png</nowiki>'''</code> to <code>'''<nowiki>https://imgs.xkcd.com/comics/picture_2x.png</nowiki>'''</code> when your browser shows the smaller version.

To update it here, just click the image on the comic page and then click "Upload a new version of this file" below the file history. Please be patient, you won't see your upload immediately because it still comes from the cache at the server. If you see your upload in the file history, even if it's not the one you uploaded, it means it worked. Wait a few minutes for the newer image to appear.

==How do I enter mathematical or chemical formulas?==
You can use the Math markup <code><nowiki><math>...</math></nowiki></code>. The other known code from Wikipedia <code><nowiki><chem>...</chem></nowiki></code> is ''not'' supported yet. It's based on LaTeX syntax and a general overview can be found at its {{w|Help:Displaying a formula|Wikipedia help page}}. Don't use it unless you actually understand what you are doing, though. If you can, you can attempt to use {{w|Mathematical operators and symbols in Unicode|Unicode math characters}}, along with  <code><nowiki><sup>...</sup></nowiki></code> and <code><nowiki><sub>...</sub></nowiki></code>, to try and create the formulas yourself.

Furthermore, never use this markup at the ''transcript'' because that math code is rendered to a picture — in the transcript we try to describe the comic ''image'' by ''words''. A picture there wouldn't be helpful.

Please note that pages that use the Math module will ''not'' be able to load if you set your Math markup preferences to MathML, and will lead to parse errors with LaTeX rendering. The setting that should be selected is PNG images.

==Is the {{tl|Citation needed}} template here similar to the one used on Wikipedia?==
No, it has a different meaning. The template {{tl|Citation needed}} just links to [[285: Wikipedian Protester]], a comic from July 4, 2007, and is meant to be a joke.{{Citation needed}} This template should only be placed when there is a deeper sense of humor. For statements that require actual, genuine citations (such as "Randall has said he made a mistake in this comic"), use the {{tl|actual citation needed}} template instead.{{actual citation needed}}

==What is the general layout of a xkcd character page?==
When creating a new character page, it's easier to just copy and paste the contents of an existing character page, such as [[Megan]] or [[Jill]], and change the information. The layout and order are structured as:
*{{tl|Infobox character}} template with an image of the character, caption, and first appearance.
*Brief description.
*Noting the different names given to the character in different comics under the "Name" section.
*Characteristics of the character under the "Characteristics" section, including cameos of the character under a proper name and different personalities
*Adding the [[:Category:Characters|Characters]] category.

[[Category:explain xkcd]]{{explainxkcdmeta}}