Two Common Formatting Mistakes on the Forum
- Posted by jeremy (admin) Nov 06, 2010
- 2489 views
I see some repeating patterns in some of the quotes I include in my forum replies. The biggest one is the improper use of a forced line break, \\. The second is not using no-wiki tags {{{ }}} around console type pastes, such as the output of a command line program.
Forced Line Break
\\
This should not be needed hardly ever in the forum. This is a forced line break. The forum is created in such a manner that it word wraps properly. If you want to make a new paragraph, you should put a blank line between your two paragraphs. For example:
Hello, World\\ \\ This is a message to the Euphoria Community.\\ \\ Goodbye!
That is way too much work! It need not be that complicated. Here is the output of the above text:
Hello, World
This is a message to the Euphoria Community.
Goodbye!
Looks fine, however this accomplishes the exact same result:
Hello, World This is a message to the Euphoria Community. Goodbye!
Here is the output of the above text:
Hello, World
This is a message to the Euphoria Community.
Goodbye!
No-Wiki {{{
{{{ }}}
This causes two things to happen:
- If the tag begins and ends on their own lines, it enters a pre-formatted mode <pre>...</pre>
- Disables all creole formatting so ** stays ** and doesn't trigger the bold attribute
Say you have the output of a dir command. You could enter it as:
C:\projects> dir CoolProject1 CoolProject2 CoolProject3
However, that's not right. It turns out like:
C:\projects> dir CoolProject1 CoolProject2 CoolProject3
You could use forced line breaks at the end of each line (\\) but again, that's too much work. Simply wrap the whole thing in {{{ }}} and it'll all just work. For example, it should be (minus the ~ on the ending tag, I had to add that for Creole to not end the no-wiki at that point):
{{{
C:\projects> dir
CoolProject1
CoolProject2
CoolProject3
~}}}
That outputs as:
C:\projects> dir CoolProject1 CoolProject2 CoolProject3
I hope this has helped some spend less time on writing messages and more time using Euphoria!
Jeremy
