Yay! Finally a formatting guide that explains everything!
Well, maybe not everything... Since I don't know the specifics of what's going on, this is all based on some intuitive guesswork and testing. Only way we'll see something complete is if we get some staff to reveal exactly what they're using and allowing...
So, one of the things that's going to make this whole process a lot smoother and completely unlike a nice comedy routine is the use of an Escape Character. In the context of these formatting languages, an escape character changes how the following character is treated so that you can use formatting characters without actually applying the formatting. In the case of this language, the \ character (usually located above the Enter/Return key on QWERTY keyboards, others might make you look for it) is used as the escape character; so when you see it listed like *italics* becomes italics, I'm using the escape characters on those asterisks to make them stay as asterisks. Or not; there's another way to do it when using the code/mono-space font feature discussed towards the end.
I'm not going to cover the stuff mentioned in the "Formatting Help" box you can open located in the lower-right corner of any comment box; that stuff should be self explanatory. I will cover some "features"/quirks relating to them not mentioned in there though. So, if you aren't familiar with the basic formatting, take a look at it now and get familiar with it.
Now, while I haven't made any build guides or completed builds, I see no reason why these formatting options wouldn't work there (I mean, would the staff here really use two/three different setups for each different mode?). That means, from this point out, any build guide that's poorly formatted after having someone mention it and being linked here is in for it from those who want nice Build Guides (I know of a few people who are probably going to be doing that...).
For comments, you have one hour in which you can go back an edit it. More than enough time to fix any errors. If you start your edit before that hour is up and then don't finish until after that hour is up, it will not go through and return an error message.
And, after seeing this from a user I thought knew it all... (never going to give that up...) Formatting does not work in the title.
Removing Paragraph Spaces
I believe this deserves its own spot, as it's something a lot of people could do with learning. Instead of having to include a gap in order to separate sentences, links or other info, you can use 3 spaces (" ", for those of you who are going to be stumped by that...) at the end of the sentence/link/whatever to create a new line.
See? Used three spaces at the end of that sentence and bam!
New line without a gap between it.
Useful when you want to ask or answer several questions. The formatting guide already covers asterisk-based lists, but you can also use hyphens, "-", and plus signs, "+", to indicate them.
Numbered lists can be made by using 1. as the start of the line. Any number will do actually, as the formatting will force them to follow increasing Cardinal numbers.
Having a break in the formatting, such as with a quote (covered later), will force the count back to one; annoying when you want to quote the questions. This can be mitigated by adding the quote or text to the list. This is done by having four spaces, " ", preface the text/formatting that is to be added to the list. Formatting for this is a bit odd though, as the triple-space technique mentioned earlier doesn't work; you need to have a full line in-between...
(four spaces)> Quote
Yea, we don't have the ability to directly quote and reference something, but we can at least make it more noticeable as a quote. Quotes are linked when there's no intervening text, so you don't have to keep a steady line of > prefixes when you want to continue a quote. They also can contain and use all other formatting, such as headers, no-space line breaks, and of course links. You can also nest quotes with additional >; each nest will add another one of those vertical gray lines and indent the text more. Just to display what's going on...
> Used three spaces at the end of that last sentence. Won't do that here, so notice the extra gap...
> > > > Nested Quotes Rock!
Used three spaces at the end of that last sentence. Won't do that here, so notice the extra gap...
Nested Quotes Rock!
So, for the most part links are covered well in the help. It's not like they're a riddle or anything. What could be useful to some is to add some alt-text to the link, such as what I did for the first link in this topic. To do so, you need to add the text inside quotation marks after the link.
For example, [PCPP Forum Mainpage](https://pcpartpicker.com/forums/ "This is alt-text!") becomes PCPP Forum Mainpage.
Looks like this was patched to work right. (Thanks Philip!) Going to leave the text there in case there's some scenario where it's useful. Plus the UTF-8 code page is interesting... The next quirk of the formatting is that some symbols screw up the link. For example, if there is a colon, :, in the link and not located in the http:// portion, the link will redirect to the same page; example: https://pcpartpicker.com/forums:/ Sadly, this can't be fixed by escaping the offending typographical mark; you have to replace the colon or whatever with the appropriate UTF-8 hexadecimal code for it. In the case of that colon in the example, the "appropriate" fix would be: https://pcpartpicker.com/forums%3A/ Quick reference guide for those codes
Not often used, but can be useful in the right circumstances are tables. We all know them from posting part lists, so here's the basics for those of you who haven't studied them.
Requires the column names to be listed first, using the vertical bar/pipe, |, as separation; Morning|Noon|Night|Even More!|And More!
Right after you have that you need to include some odd formatting, I'm guessing it's just to specify what's going on... It's just a repetitive :- for every column you have, along with the column separation. So for the example, :-|:-|:-|:-|:- would mark the text block as a column.
Then you can add your info into the table cells as you wish. Remember to separate where you want the cell to end with |. So, for the example, something like: Hi|Hello|Have|Fun|Now
Most formatting works inside the cells, including the code-like text (mentioned next). From what I've seen, Quotes and Headers don't, but why would they really be needed...?
So, to tie everything here up, putting those example lines after one another creates:
Uhh... I haven't really seen anyone using much of this anyway, but just to try and go for completeness... You can have code-like text inside a sentence by using ` around the text (it's the Grave Accent character; check your Tilde key; it's to the left of the 1 on most keyboards). This allows you to have code like text inside the sentence. To have those Grave Accents inside code-like text, you need to add another grave accent on the start and end. So, for example...
Header #2 already comes with a full-width line, but what happens when you need to have a line without a header? Well, then you just need at least three * or - in a single line; can't mix them though. Any spaces in-between those characters are fine, so * * * or - - - will produce:
One thing I did look into was the implementation of images. Sadly (err, actually thankfully), that portion of the formatting code has been turned off from what I have tried. Even if it did work, would you really want to have that knowledge out there for everyone to use? I mean, posting the basics to nuclear weapon design is "safe", no one is getting that much fissile material or would be able to do anything with it, but images are something everyone can post and scar us with...
So... Guess this is going to be the (current) end of the Guide. If I missed something, just point it out and I'll add it. Though, I'm thinking it's already long enough... Might be longer than what would fit on a 21:9 1080 or 1440 monitor in Portrait mode...