Register | Sign In


Understanding through Discussion


EvC Forum active members: 64 (9164 total)
2 online now:
Newest Member: ChatGPT
Post Volume: Total: 916,833 Year: 4,090/9,624 Month: 961/974 Week: 288/286 Day: 9/40 Hour: 1/4


Thread  Details

Email This Thread
Newer Topic | Older Topic
  
Author Topic:   Style Guides for EvC
Sylas
Member (Idle past 5287 days)
Posts: 766
From: Newcastle, Australia
Joined: 11-17-2002


Message 1 of 77 (101706)
04-21-2004 9:48 PM


Proposed Style Guide for EvC
This thread is intended to be a gentle introduction to the art of writing a readable post for this on-line forum. The suggestions here are intended to be helpful for anyone, regardless of their views on the topics we discuss.
A well presented post will help you communicate your views better. Skill in good writing for an international on-line forum takes time to learn, and the way to learn is to dive in and try things out. The following steps are given in order of importance. You don't need to get everything perfect the first time. Start with the basics, and build up from there.
Step 1. Check the Forum Rules.
This speaks for itself. There are some basic standards in this forum, and all users are expected to follow them. There is some active enforcement of these guidelines, and this is described in the rules document.
Step 2. Preview the post.
If you have a look at your posts before submission, then you are likely to pick up various errors. Check your basic use of language, like spelling and grammar. Most people are relaxed about a few slips up now and again; but a post that is filled with errors is not giving the message you want.
There is a preview button in the window where you enter new articles. Click on this button, and you get to see what your post will look like. You may then make any corrections, and try again. When you are happy with the result, you can submit.
Step 3. Use paragraphs.
A readable post is broken up into paragraphs. Each paragraph is a chunk of text about 3 to 10 lines long, and separated from the next paragraph by a blank line. A browser will fit text naturally to the width of a reader's page, as long as you let the browser decide where to break the lines.
This means that all the words and the sentences in a paragraph should be separated by spaces, not by pressing the "Enter" key. As you enter text into the little box provided, it will automatically fit what you enter to the width of the box. You should just keep typing each paragraph as one long continuous line of text, and let the browser "wrap" that line up to fit the available width.
To see the difference,
consider this paragraph.
Here I have pressed the "Enter" key at natural breaking points in the text,
but the result looks quite ugly.
Compare with the next paragraph,
where each line is broken at just the right distance to fit on the page.
To see the difference, consider this paragraph. Here I have not pressed the "Enter" key at all, and the result looks very professional. Compare with the previous paragraph, where each line is a different length.
Press the "Enter" key twice to get a blank line between your paragraphs. A continuous block of text, with no white space to help the eye break it into manageable chunks, is much harder for someone to read and follow.
Step 4. Use UBB Codes.
Now we are getting a bit more advanced. You can use special tags to give some additional formatting to your text. Do not use these too heavily. Too much special formatting can be distracting, but a little bit of formatting can help enhance the presentation of your post.
There is a link to a description of available UBB codes just to the left of the box where you enter text.
The simplest formatting codes allow italic and boldface text. The first sentence of this paragraph was actually entered as follows:
The simplest formatting codes allow [i]italic[/i] and [b]boldface[/b] text.
Step 5. Quoting.
When you quote from other posts, or from other sources, you should let the quoted text stand out from your own original text. My favourite way to quote from another user is with the [qs=user] and [/qs] tags. For example, suppose you type
[qs=Sylas]Quoting in little blue boxes is cool![/qs]
The result will come out like this:
Sylas writes:
Quoting in little blue boxes is cool!
This feature can also be used to present quotes from other sources. However, I often simply indent material from other sources. For example, suppose I type
[indent]Indented quotations are hot!
[indent]-- Sylas, in [i]Style Guides for EvC[/i][/indent][/indent]
The result will come out like this:
Indented quotations are hot!
-- Sylas, in Style Guides for EvC
There is a lot more that could be said on how to present your material effectively. These five steps are just the beginning, but they are a very useful beginning. You can try out ideas for formatting posts in the Practice Makes Perfect forum.
As one more little hint, I personally don't much like the little box in which we enter text for new articles. I will write up an article in some other program, like a word processor or text editor, and then cut and paste it into the article entry box. This also gives some protection from losing your entire article if something happens with the browser.
Cheers -- Sylas
Added in edit. You can also edit a post after submission, but this feature should be used sparingly. Fixing a few typographic errors is fine, but changes to content are very irritating to other uses who may have read the original version. You should indicate any significant changes made in edit. If you really need to add a new point, indicate it clearly, as I have done with this additional paragraph.
[This message has been edited by Sylas, 04-21-2004]

Replies to this message:
 Message 2 by RAZD, posted 04-21-2004 10:36 PM Sylas has not replied
 Message 3 by One_Charred_Wing, posted 04-22-2004 12:20 AM Sylas has not replied
 Message 17 by Adminnemooseus, posted 05-07-2004 2:47 AM Sylas has not replied
 Message 18 by coffee_addict, posted 11-15-2004 5:00 PM Sylas has not replied

  
Sylas
Member (Idle past 5287 days)
Posts: 766
From: Newcastle, Australia
Joined: 11-17-2002


Message 15 of 77 (106164)
05-07-2004 1:49 AM
Reply to: Message 14 by Asgara
05-07-2004 1:26 AM


Re: bump
The message which people are invited to read, as a help for effectively presenting posts, is Message 1, which is the first post in the thread. I thought the link might help.
Cheers -- Sylas
This message has been edited by Sylas, 05-07-2004 12:49 AM

This message is a reply to:
 Message 14 by Asgara, posted 05-07-2004 1:26 AM Asgara has replied

Replies to this message:
 Message 16 by Asgara, posted 05-07-2004 1:57 AM Sylas has not replied

  
Sylas
Member (Idle past 5287 days)
Posts: 766
From: Newcastle, Australia
Joined: 11-17-2002


Message 59 of 77 (210111)
05-20-2005 9:34 PM
Reply to: Message 50 by purpledawn
05-19-2005 8:36 PM


Re: Capitalization
purpledawn writes:
As someone who spends a lot of time reading and editing what others have written and truly appreciates proper capitalization, I find this a needless battle since this forum seems to be an informal arena.
I find very large paragraphs (which I tend not to read) much more annoying than no capital letters.
I think lack of style is only a problem when we are unable to comprehend the post. I haven't found that to be the problem with brennakimi or Arach or anyone's lack of capitalization.
Isn't being able to understand the message more important than a perfect presentation?
I agree 100%. I wrote the original Style Guide post in Message 1 with this in mind. From my original post:
In the Proposed Style Guide post, Sylas writes:
A well presented post will help you communicate your views better.
I focussed on those matters which hinder communication. I had five points; and I certainly do not want to make it fifteen. The points were:
  • Follow forum rules.
  • Proof read. (That is, check it is the way you want it to be.)
  • Use paragraphs.
  • Use tags; but not too much! A little bit, to help presentation.
  • How to quote text from others.
Under proof reading:
In the Proposed Style Guide post, Sylas writes:
If you have a look at your posts before submission, then you are likely to pick up various errors. Check your basic use of language, like spelling and grammar. Most people are relaxed about a few slips up now and again; but a post that is filled with errors is not giving the message you want.
I want us to remain relaxed about a few minor slip ups. I find ALL CAPS very trying, but lack of capitalization is not a problem for me. I do advise using formally correct writing, including capitalization; but in practice it is much less of a problem than ALL CAPS, or bad paragraphing, or bad justification.
This thread is now at the point of poking fun at overly rigid rules, and that's cool with me. I think the original post has sufficient support that it should really now be a separate page linked from the main menus; not just a post. It's not presented as a long list of rigid rules, but as a set of gentle suggestions that will help people who want to improve their presentation. It could be combined also with Assistance w/ Forum Formatting; although of course the capitalization in the title of that thread must die.
I don't much mind people who understand the possibilities, and choose something a bit non-standard. brennakimi is no problem for me, and I hope he was not serious about leaving.
It's a bit subjective, but my other pet hate is posts that use too much formatting. Lots of colours and font changes are evil. If the whole post is using different fonts, I object.
Cheers -- Sylas

This message is a reply to:
 Message 50 by purpledawn, posted 05-19-2005 8:36 PM purpledawn has not replied

  
Sylas
Member (Idle past 5287 days)
Posts: 766
From: Newcastle, Australia
Joined: 11-17-2002


Message 60 of 77 (210112)
05-20-2005 9:40 PM
Reply to: Message 45 by macaroniandcheese
05-19-2005 4:14 PM


Re: brennakimi from another topic
Bump bump for brennakimi. i hope you were not serious about leaving. i may have a minor disagreement with the noble moose on this matter, but as author of the style guide i'm sympathetic to your perspective on this. the guide was not intended by me as a set of rules, but as a set of suggestions for those who are struggling with the medium and keen to get the most value from it.
frankly, i don't normally write like this. i like correct capitalization. but if you know what you are doing and have some weird reason for it, so be it. we love you for the substance, not the formatting.
cheers -- sylas
ps. start using lots of blinking colors, and you're toast.

This message is a reply to:
 Message 45 by macaroniandcheese, posted 05-19-2005 4:14 PM macaroniandcheese has replied

Replies to this message:
 Message 62 by lfen, posted 05-20-2005 10:23 PM Sylas has not replied
 Message 64 by macaroniandcheese, posted 05-20-2005 11:44 PM Sylas has not replied

  
Newer Topic | Older Topic
Jump to:


Copyright 2001-2023 by EvC Forum, All Rights Reserved

™ Version 4.2
Innovative software from Qwixotic © 2024