explain xkcd talk:Editor FAQ

Explain xkcd: It's 'cause you're dumb.
Revision as of 14:49, 25 August 2018 by Gir (talk | contribs) (Formatting of explanations)
Jump to: navigation, search

Feel free to enter any question about editing this Wiki and don't forget to sign you comment. --Dgbrt (talk) 21:18, 31 May 2018 (UTC)

Formatting of explanations

Many pages contain tables where a definition list would be 1) easier to read 2) mobile friendly, for example: 1957.

I was also involved in rewriting the transcript for 1963, where the discussion came up about how those should be styled. ("as if you were reading the comic to someone")

I think we should have a small style guide to encourage sane formatting. What else should such guidelines contain?

Edit: One more thing I'd love to see: semantic headlines (i.e. < h3> headlines for explanation subchapters instead of < h2> which is the same level as the explanation itself)

(Sidenote: I've been active on explainxkcd for quite some time, but only now got around making an account.) //gir.st/ (talk) 15:01, 19 August 2018 (UTC)

Thanks for your remarks. First: There is no need to start every new sentence at a new line. Tables are meant for small content in all other cases it's bad layout. I recently changed this 2034: Equations to a proper floating text. At the transcript tables should never be used, even when there is a table in the comic image it should be described by text. The guide here was mainly written by me because there was nothing like this here before. Some people already helped and I'm happy for any further remarks to enhance it. And this table issue is definitely one; I just not wanted to be the only (arrogant) layout master. Your help is welcome to write something, otherwise I will do so soon.
For headlines we don't use HTML-code but WIKI-code. The main headlines are written like this: ==Explanation==, ==Transcript==, and (optional) ==Trivia==. Headlines inside that chapters should be done in this way: ;Subtitle. The preceding semicolon causes the entire line to be rendered in bold. Only when the explanation really needs sub-chapters it can be done by this: ===Sub header=== (three equal signs before and after the text). I will put this also into the FAQ.
Welcome and thanks for helping. PROTIP: Always use the preview button to check the layout before saving. --Dgbrt (talk) 13:39, 20 August 2018 (UTC)
hi, I'm aware about the headlines and stuff, it was just shorter to write it this way in the comment. I see you started a bit with a styleguide already; I hope I can contribute to it next week, when things cool down at work a bit. //gir.st/, who is to lazy to log in 172.68.51.190 06:51, 24 August 2018 (UTC)

So, one more thing, regarding 'What is the proper layout for headers?'. I think we should better use small ====headings==== instead of just description titles (;bold text), since it makes the intent clearer. what is your reasoning behind suggesting it the other way round? greetings, //gir.st/ (talk) 14:49, 25 August 2018 (UTC)