Click here to Skip to main content
15,860,859 members
Articles / .NET
Tip/Trick

Formatting your CodeProject Article

Rate me:
Please Sign up or sign in to vote.
4.79/5 (12 votes)
22 May 2010CPOL1 min read 19.6K   4   3
Bad formatting will delay the approval of your articles. Follow these basic rules to avoid that delay.

Having trouble writing or posting articles? These articles aim to gather together tips and tricks from authors and mentors to help you write great articles.

One of the most pervasive problems we face here at CodeProject is an inability to properly format articles. I think the most probable cause for this is that article authors use Microsoft Word or some other program to edit their article text, convert it to HTML, and then paste that HTML into the article editor in the Article Submission Wizard.

My tip is DON'T DO THAT.

I write my article in Visual Studio, and lately, I've been actually adding the article text as a .HTM file in the solution.

The key is to not get any fancier than you have to. The vast majority of articles require no special formatting in order to present themselves in a manner that adheres to the standard CodeProject appearance. You don't need to add colors, or spacing, or any of that other stuff., and you generally don't need any tags beyond the folllowing standard tags:

<H2> or <H3> for headers

<pre> for blocks of code

<code> for references to coding elements, such as class names

<b> and <i> for emphasis on text

<ul> and <li> for bullet lists

There is generally no need for anything fancier.

Finally, PLEASE proofread your articles to make sure they look okay. A poorly formatted article will delay the process where it is made available to other users.

EDIT ========

Fixed some spelling errors.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior) Paddedwall Software
United States United States
I've been paid as a programmer since 1982 with experience in Pascal, and C++ (both self-taught), and began writing Windows programs in 1991 using Visual C++ and MFC. In the 2nd half of 2007, I started writing C# Windows Forms and ASP.Net applications, and have since done WPF, Silverlight, WCF, web services, and Windows services.

My weakest point is that my moments of clarity are too brief to hold a meaningful conversation that requires more than 30 seconds to complete. Thankfully, grunts of agreement are all that is required to conduct most discussions without committing to any particular belief system.

Comments and Discussions

 
GeneralSpecifics into tags Pin
Tamus24-Sep-10 20:41
Tamus24-Sep-10 20:41 
QuestionH2 and H3 Pin
CoperNick18-Feb-10 2:01
CoperNick18-Feb-10 2:01 
AnswerRe: H2 and H3 Pin
#realJSOP18-Feb-10 2:06
mve#realJSOP18-Feb-10 2:06 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.