Speedrun.com - Formatting Guidelines/Cheat Sheet
4 years ago
Schleswig-Holstein, Germany

Hello,

this is a temporary guide/cheat sheet on the topic of formatting options currently (as of 11/Apr/2020) available on SR.C.

A quick overview of terminology used in this guide and short explainations for those of you who have never used HTML or similar coding languages:

  1. "Tags" When I refer to something using a "tag" what I mean is that in HTML and BBCode you put certain words into "[ ]" square brackets to force a formatting option. You have to close these with "[/ ]" Example: '[WORDHERE]TEXTHERE[/WORDHERE]'

  2. Automatic Embedding/Transformation SR.C embeds/transforms YouTube videos, some pictures and links as you'll see in examples below.

  3. Header/Heading These have different functions depending on the page type you use them on. For forum/guide posts the site will automatically create a table of contest as seen below this introduction. On rules headers will usually only increase the font size and the space between the next normal text and the header.

  4. Linebreaks You may force a line break by adding two empty spaces after a sentence and then pressing Enter for the break.

  5. BBCode This is a simplified version of HTML designed for text based forums. It is currently primarily used for forum or guide posts. See below for specific information on it.

  6. Markdown An even simpler version of HTML designed for chat apps like Discord. This was recently introduced for rules pages. See below for specific information on it.

#BBCode:

Bold Two asterisks '**' infront and behind the text you want to display in a bold format

Italic One asterisks '*' infront and behind the text you want to display in a italic format

Underline Two '__' infront and behind the text you want to have underlined

Two '~~' infront and behind the text you want to display with a strikethrough

Use the "center" tag to have your text displayed in the center of the post [center]Center[/center]

[quote]This is a quote using the "quote" tag normally[/quote]

[quote=ShadowDraft]You may quote people by adding "quote=NAMEHERE" to the tag[/quote]

Links are automatically turned into clickable text by the site https://www.google.de/

But you may also define a text with [ TEXTHERE ] ( LINKHERE ) (remove the spaces from the [] tag) Still Google

Most pictures are automatically embedded by the site https://www.speedrun.com/themes/broforce_series/cover-256.png

Videos are also embedded by the site:

#Markdown

A single "#" will give you a header and the site will create a table of contents for you based on your existing headers (only supported for forum/guide posts not rules). Please note that heading2 - 6 currently not work as you might expect/are used to and should only be used on rules. Feel free to experiment with the different formatting on each header for your rules pages.

'# Heading 1' '## Heading 2' '### Heading 3' '#### Heading 4' '##### Heading 5' '###### Heading 6'

Similar to BBCode you may format your text with asterisks '*' , underscores '_' and strikethrough '~'.

bold

italic

asterisks and underscores

You may have horizontal lines with 3x '-' it needs to be in it's own line though:

You may display code like this:

single line code

You may quote with '>'

quote

You may make bullet point lists with '*'

  • unordered
  • list

or numbered lists '1.':

  1. ordered
  2. list

You may give links a name similar to BBCode [NAMEHERE] (LINKHERE) just need to remove the space between ] and (. Please note that the link colour is using the primary colour you have set for your leaderboard under Edit theme:

embedded link

And finally you may display images like this:

Image:

! (picture link here)

#Section 3 of the table of contents.

Cheat Sheet for BBCode: https://www.bbcode.org/reference.php Cheat Sheet for Markdown (not everything is working or mostly on rules. For forum posts/guides you'd want to use BBCode): https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet

Edited by the author 1 year ago
grnts, jas314 and 35 others like this
Schleswig-Holstein, Germany

Bump

Sticky please?

grnts, M_CBL_ and 5 others like this
Netherlands

Not necessary. The site is looking into using true Markdown. Thanks for making this through.

M_CBL_, Gundwn and 7 others like this
Germany

It appears the formatting for rules pages has been updated to markdown. The forums still seem to use BBCode (not sure if it works in guides and resources, i don't want to notify all followers of a game)

Here are some examples on how to use markdown for Rules: https://demo.codimd.org/s/B1MrKpYqH

There are some odd things i noticed (and that are displayed differently in my link):

  • heading 2 is bigger than heading 1 and heading 4 is even bigger
  • no borders on tables and no support for text alignment per column

It would be good to know which implementation of markdown is being used to properly prepare texts.

Edit: Markdown is currently not available for Guides and Resources

Edited by the author 4 years ago
YUMmy_Bacon5, ShadowDraft and 4 others like this
Schleswig-Holstein, Germany

Bump @Daravae could you confirm which markdown was implemented?

Edit: Looks like Markdown is either not implemented correctly or a global setting is overruling it. See #site-bugs on Discord.

Edited by the author 4 years ago
Netherlands

True markdown is working and Headings are not messed up. A few headings / code that are part of Markdown (such as H1-H3) were disabled during the Markdown implementation due to its text size mostly. Not entirely sure on its implementation in guides and resources though, think that might be still an ongoing request.

Edited by the author 4 years ago
YUMmy_Bacon5 likes this
Norway

Would be nice if you guys (mods) could temporary stick it until a guide of the fully implemented markdown is fixed

YUMmy_Bacon5 and GMP like this
Israel

Can you please specify how do I write quotes? I tried using quote tags like this: <quote> here is a quote </quote> but it doesn't appear to be working.

Edited by the author 4 years ago
Gaming_64 and YUMmy_Bacon5 like this
Canada

Use square brackets, not angle brackets.

Schleswig-Holstein, Germany

I updated the guidelines with the Markdown changes and given a basic explaination on tags.

Edited by the author 4 years ago
YUMmy_Bacon5, MrMonsh and 5 others like this

https://i.imgur.com/2Cf6J8b.jpg Is markdown broke or have I made a rookie error?

YUMmy_Bacon5 likes this
Israel

@Hibnotix The [ name ] ( link ) method doesn't work well if the name contains special characters. So you will have to get rid of the apostrophe after "Knuckles" (and apparently some of the other characters as well).

Some quick tests, to see what works and what not:

Google' 1 Google: 2 Google - 3 Google (4) Google 5/6 Google, 7

Edited by the author 3 years ago
Gaming_64, M_CBL_, and YUMmy_Bacon5 like this
Israel

Is there a way to post a link to YouTube in the forums/guides, without the video being automatically embedded?

Gaming_64 and YUMmy_Bacon5 like this

@Oreo321 Couldn't you put them as a link in the text? Test video

M_CBL_, YUMmy_Bacon5, and Oreo321 like this
Israel

I had some problems with writing headings (1-6) in the game rules, and I figured it out now. There must not be any space between the "####" and the text after it, for the headings to have effect.

Gaming_64 and YUMmy_Bacon5 like this
England

Now, I realise that this thread is a year old and that this could well come off as nitpicky, but was there really no better choice of words for an important topic on a website of this nature than "Cheat sheet"?

C'mon.

M_CBL_, YUMmy_Bacon5, and Timmiluvs like this
Israel

The term "Cheat sheet" is often used as "a set of notes for quick reference". This is not related to cheating whatsoever.

Gaming_64, M_CBL_ and 4 others like this
French Southern Territories

All other stickies are locked :(

YUMmy_Bacon5, MinecraftGaming and 4 others like this