Code Project Article FAQ

Table of Contents

• New Layout
  
  • Why the new layout?
  • I have found an issue (or suggestion) with the article layout. Who do I contact?
• Purpose of Sharing
  
  • Why share my code?
  • What are the Terms of Use?
• Code Project Articles
  • What does an article require?
  • How do I prepare my source code?
  • How do I submit an article?
  • Why submit to through the Code Project Editors?
  • Why submit into the submission queue?
  • Why submit through the submission wizard?
  • Where do I submit an article?
  • How do I choose my article's section?
  • How is my article's URL decided?
  • What should I put in the description?
  • How do I use tags and location?
  • What license should I use?
  • What files should I upload?
  • How do I uploaded them?
  • Where did my files go, and how do I use them?
  • I have to finish my article later. How can I do this and not lose my progress?
  • How do I use the article editor?
    • You know HTML
    • You DON'T know HTML
  • How does pasting from the clipboard into my article work?
  • How do I update my article?
  • How do I embed video in my article?
  • Can I submit an article based on another person's work?
  • Can I submit code I've already posted at another site?
  • What is Pending status?
  • Why is there content moderation at the Code Project?
  • Why is my "Pending" article in "Composing" status now?
  • What is a Code Project Mentor?
  • I can't get the formatting right in my article. What do I do?
  • My article was approved and all the votes and comments are gone. Why?
  • I posted my article a year ago, and it is still unedited. Why?
• Tips
• What is a tip?
• How do I post a tip?

Our new Layout

1. Why the new layout?

   We needed to clean things up and make it easier to find your way around. This update is the start a series of staged site updates that will bring consistency to our various areas.

2. I have found an issue (or suggestion) with the article layout. Who do I contact?

   Please visit our Bugs and Suggestions forum

Purpose of Sharing

1. Why share my code?

   Sharing code with others is a great way to not only help others, but also to become a better programmer. With many thousands of people downloading your code you will not only get a lot of positive feedback, but also bug fixes, free testing, and more often than not, suggestions on how to make the code even better. It also encourages others to share their code, which in turn gives you access to an even larger base of free source code.

2. What are the Terms of Use?

   If you post to The Code Project then your code is offered under the terms of our Terms of Use and under the specific license agreement attached to the article. You also agree to the Contributors Agreement, which ensures you have the right to post the content, allows us to actually publish your content, and provides further protection for you on top of the License you choose for your content.

Code Project Articles

1. What does an article require?

   First and foremost, we need some documentation. This doesn't have to be anything fancy, though we don't mind if it is, but if you think about answering the following questions then you should be off to a good start.

   • What does the code do?
   • How do I integrate it with my existing code or how do I use it?
   • If there is a similar article on The Code Project already, then how does this one differ? Why would someone want to use your version?
   • Is there some aspect of the code that is of particular interest that perhaps should be covered in the article?
   • Are there any particular environments the code is restricted to? (Windows 2000 or above, .NET SP1 etc)
   • Are there articles about this topic already on Code Project? If so, what about mine offers something different. Please state what that difference is in the article.

   The idea is to give the reader a clear idea of the purpose of your code, instead of forcing them to download a project, build it and then hunt around to find out what the sample does. This means articles that are code snippets, with no explanation of what the snippet does, are insufficient.

2. How do I prepare my source code?

   First and foremost, does the code actually work? We do sometimes get code that, for one reason or another, just does not work. Please check that the source code you send compiles cleanly, and if part of a larger demo application, that the application itself runs OK.

   We do ask that the general conventions be adhered for your language to so that other programmers can understand your code easily. Conventions that help other programmers read your code are:

   • The use of Hungarian notation in MFC (e.g. Variable prefixes such as "n" for int, "d" for double etc.)
   • The use of Win32/Visual C++ types such as UINT, LPCTSTR etc.
   • Camel case in .NET code

   Also, does the code compile cleanly under the warning level 4?

3. How do I submit an article?

   You can submit the article and code to in one of three ways:

   1. You can submit the article yourself using our submission wizard.
   2. Through our submit[at]codeproject.com address. Article and code must be compressed into a .rar archive, or rename your zips to, say, MyArticle.nozip (Our email provider will not accept emails with .exe attachments, or .zips with .exe attachments)
   3. Through our online submission form, leaving your Article Title, your zip package, and comment for the editors (if required)


4. Why submit to through the Code Project Editors?

   Pros

   • Article checked for grammar, spelling, and punctuation
   • Article formatted correctly to Code Project Guidelines
   • Improved readability
   • Easier for author, no processing or using a submission tool, or messing with HTML

   Cons

   • Article process time is typically 1-2 days


5. Why submit into the submission queue?

   Pros

   • Author doesn't have to rename their zip file, or EXE files for submission.
   • Article checked for grammar, spelling, and punctuation
   • Article formatted correctly to Code Project Guidelines
   • Improved readability
   • Theoretically, higher ratings
   • Easier for author, no processing or using a submission tool, or messing with HTML

   Cons

   • Article process time is typically 1-2 days business days


6. Why submit through the submission wizard?

   Pros

   • Submitted immediately

   Cons

   • May not follow Code Project format and submission guidelines
   • Might be less readable, and less accessible
   • Have to fuss with HTML and wizard yourself


7. Where do I submit an article?

   From the home page, here:

    

8. How is my article's URL decided?

   The URL of your article will depend on the title you give it. For example, if your title is 'coolcode' then your article's URL will be 'http://www.codeproject.com/Articles/ArticleID/coolcode'

   This name is important, as it helps search engines find your article. Make sure you name it something appropriate.

9. What should I put in the description?

   300 characters or less (spaces included), on what your article's purpose. Be clear, and concise; it will decide whether or not someone reads your article.

10. How do I use tags and location?

    Simply begin typing into the Tags field. As you type, a dropdown of current tags will be displayed. Select accordingly.

    

    Also note the secondary dropdown where you can scroll through lists of languages, platforms, technologies, and audiences that apply.

    Note: Some attributes are parent attributes. If you selecting C++ as shown, you are actually selecting all children: VC6, VC7, VC7.1, VC8.0,and VC9.0

    If you use the dropdown to select attributes, DO NOT check the parent attribute if all the children attributes do not apply

11. What license should I use?

    We have a list of licenses here to help you choose the license appropriate for you and your code.

12. What files should I upload?
    
    
    • Small screen shot (PNG/GIF/JPEG only, maximum width 640 pixels)
    • Zip file containing your source files (if appropriate)
    • Zip file containing your sample application (if appropriate)


13. How do I upload them?
    
    

    On the far right of the screen you will see an "Add File" button. Simply click it and pick files you wish to uploaded individualy, and then use the "Upload" button that appears to upload the file to the article.

    
    
14. OK I uploaded my files. Where did my files go, and how do I use them?

    Each file can be added using the yellow arrow icon as shown below. Simply place the cursor in the article area where you want the file to be located, then click the arrow to place the image/file there.

     

    For zip files containing code there is a shortcut to adding files. Underneath "Current Files" you will see a insert button and link entitled "Add selected zip files to article." Simply click that link to automatically add neatly formatted files to your article.

15. I have to finish my article later. How can I do this and not lose my progress?

    Check this teenie, tiny box:

     

    And make sure you have saved your draft:
    
    

    Later when you come back check "My Aricles" here:

    Later when you are ready to finish return to the submission page and access your draft from here:

     

16. How do I use the article editor?

    You know HTML

    Knowing HTML is the ideal for the editor. Select the HTML button to switch between HTML and WYSIWYG (What You See Is What You Get) modes. Please note, class designations (ie. table class="ArticleTable") have specific capitalization.

    Use this HTML button to switch between the two modes:

     

    <p>Paragraphs go in paragraph tags.</p>
     
    <ul>
    <li>Unordered lists go in these tags</li>
    </ul>
     
    <code>All your variables, class names, properties, etc. must go inside</code>
     
    <strong>If you really want to bold something, use this tag. But we don't like it</strong>
     
    <em>All file names inside the article must be italicized: .zip, .cs, .html, etc.</em>

    Headings must be used like this

    <h2>Main Headings</h2>
    <h3>Sub Heading to h2 Heading - a Sub Topic to the Previous Topic</h3>
    <h4>Sub Heading to h3 Heading - a Sub Topic to the Previous Topic</h4>
    <h5>Sub Heading to h4 Heading - a Sub Topic to the Previous Topic</h5>
     
     
    <div class="Caption">Captions go in this div class</div>
     
     
    <table class="ArticleTable">
    <thead>
    <tr>
    <td>Tables with borders. This cell a bolded and colorized border because of thead</td>
    <td>This cell in this row ALSO has a bolded and colorized border because of thead</td>
    </tr>
    </thead>
    <tr>
    <td>This cell in this row is not bolded and colorized</td>
    <td>Neither is this one</td>
    </tr>
    </table>
     
     
    <table class="ArticleTableNoBorder">
    <tr>
    <td>This table has no borders</td>
    <td>This table has no borders</td>
    </tr>
    </table>

    You don't need to worry about colorizing your articles. We have a colorizer that takes care of this for you. If your article already contains colorization then don't worry - the colorizer cleans out all previous colorizing before recolorizing the entire article

    <pre lang="cs">int myVar = 0;</pre>

    The currently supported languages are:

    • Plain Text (lang="text")
    • ASP.NET (lang="aspnet")
    • C# (lang="cs")
    • C++ (lang="C++")
    • C++/CLI (lang="mc++")
    • CSS (lang="css")
    • F# (lang="F#")
    • HTML (lang="html")
    • Java (lang="java")
    • Javascript (lang="jscript")
    • MASM / ASM (lang="asm")
    • MSIL (lang="msil")
    • MIDL (lang="midl")
    • PHP (lang="php")
    • SQL (lang="SQL")
    • VB.NET (lang="vbnet")
    • VBScript (lang="vbscript")
    • XML (lang="xml")

    Other languages can be added on request.
    
    Colorizing works on PRE and CODE tags. If you have a block (or line) of text you don't wish to be coloured, set the lang value as "text".

    If you have the same code snippet shown in multiple languages (eg C# and VB versions of the same code) you can wrap muiltiple PRE blocks inside a <div class="code-samples"> and have the multiple code blocks appear in a tabbed form, similar to MSDN

    eg div class="code-samples">
    <pre lang="C#">
    ...
    </pre>
    <pre lang="VB.NET">
    ...
    </pre>
    </div>

    Just make sure you set the lang attribute correctly

    You DON'T know HTML

    You can paste your article into the editor and modify it using the buttons. Bold, Add Image, Indicate Code in Paragraphs as Variables, Class Names, Properties, Create Lists, Add Link, Remove Automatic Formatting of Original Text Application (like Word), Remove Bad Formatting Insert Table.

    There's also Cut, Paste, Redo, and Undo. Beyond these, we wouldn't recommend messing with other icons. Code Project articles have very simple formatting, which is the way we (and more importantly, members) like it.

17. How does pasting from the clipboard into my article work?

    When you have written your article in another program and wish to paste it into the submission wizard there are a few options you have of how your text is treated. Below is a description of each possible choice and a visual display of what it looks like pasted in the wizard, as well as what you will see in the auto-display window when you paste.

    1. Strip HTML: HTML markup will be removed from the text.

    

    2. Encode HTML: Paste text will be automatically HTML encoded.

    

    3. Paste as-is: Clipboard will be pasted as-is, preserving HTML tags and entities.

    

    4. Code block: Clipboard text will be wrapped in PRE tags and content HTML encoded, always.

    

    5. Quoted Text: Clipboard text will be pasted within a quote block.

    

    6. Best guess: Sniff pasted text to see if it contains code and wrap in PRE blocks if it does.
       
18. How do I update my article?

    Every article on Code Project can be modified by their author if they are logged in. Simply click on the "Modify" link just under the title of the article.

    

    This will take you to the article editor where you can make your desired changes. Afterwards, your article will return to the "Articles Needing Approval" queue where members and editors will approve your changes.

    If you have trouble with HTML you can send your update to us. Please use the "Get Article’s HTML" from the link in the upper right hand corner of your article, click on this and then save the HTML for your article using the File | Save menu in your browser. Ignore the stuff at the top and bottom of your page - you will see "Article Starts" and "Article Ends" tags in the HTML that point to where the actual text for your article is. Strip out everything above and below these markers and edit the HTML directly. When you are finished please send both updated HTML and zipped sourced code to us at submit[at]codeproject.com. Note: your article and code must be compressed into a .rar archive, or rename your zips to, say, MyArticle.nozip (Our email provider will not accept emails with .exe attachments, or .zips with .exe attachments). Also please remember to include the name of the article and its URL in the email body.

    If you only have a very small addition to make, or want to report spelling/grammar or link errors then you can just send these in as plain text.

    Alternatively, you can queue your article for editing by using the icon in the top right that looks like a clock over pencil and paper: . Please ensure to upload your updated HTML and files as instructed above and include any additional comments the editors need to know.

19. How do I embed video in my article?

    If you wish to embed a video in your article please email our editors at submit[at]codeproject.com. While articles can have embeded videos using iframes only editors have the ability to implement this currently.

    If you wish to submit an article that is purely a video we do support flash or silverlight videos. However, you must have the SWF or FLV file hosted on a server that allows streaming. Simply choose video from change the type of post:

    

    Then and add the URL to the form that appears (shown below).

    

    If you wish to submit an article that is purely a video, but do not have a place to host the SWF or FLV file and have a different format, please email us at submit[at]codeproject.com.

20. Can I submit an article based on another person's work?

    It is OK to use others code as a base as long as you make it totally clear that some/most of the code isn't yours. If you use someone else's code then DO NOT remove their copyright notices. There is a lot of code reuse here, that's the point after all. As far as the articles that are being posted here we expect to see credit where credit's due, in the code and the HTML as appropriate.

    If you are submitting a modification, extension or correction to another persons work then we ask that you attempt to contact the original author first and then try to liaise with him/her to produce an update to the original article. This way we can retain continuity with the original article as well as reducing the number of completely new pages that need posting.

    We take plagiarism seriously at The Code Project. If you copy someone else's work (whole or even a tiny part) without referencing it, OR you cut and paste large sections and simply post a reference link at the bottom, your post will be removed, and your account will become inactive.

21. Can I submit code I've already posted at another site?

    You are more than welcome to submit code that is already published at another site, provided you own the copyright on that article, and provided you have not given the other site exclusive rights to your article.

22. Why is there content moderation at the Code Project?

    Certain user-submitted content on the site is subject to moderation. The purpose of moderation is to stop the publication of obviously inappropriate material, plagiarised content or content that is not of sufficient quality to be published at that point.

    Moderation is available to members who have contributed enough to the community that the system considers them a good judge of what is and isn't acceptable. If you suddenly find moderation buttons available to you then thank you - you've done a lot for the community and we would now like to give you the opportunity to do even more.

    If you have an author reputation of Silver or higher, you will have access to the moderation queue. It looks like this:

    

    From there you can hover over the checkbox to get the following dropdown:

    

    The way the moderation works is you have to receive five "Approve" items to be published, or five "Report / Needs help" items to reach a different article status. If five members Approve your article it will become live and available for all to see. If five members either "Report" or mark your article as "Needs help" your article status will become "Closed" and you will receive an email notification indicating who closed the article, why, and what to do:

    If you wish to revise and reopen your article based on the feedback from these members then simply go the "Edit article online" in the upper right hand corner:

    

    This will enable you to edit and update your article and will re-open your article for other members to enjoy.

    If an author has genuinely tried to provide a decent material, even if they may need some encouraging to improve it, then the item should be approved by moderators.

23. What is Pending status?

    Pending status means that an article is awaiting approval from the Code Project community. The vast majority of new articles on Code Project need a couple of tiny improvements because they do not sufficiently explain the code within the article. The goal of this is three-fold:

    1. It ensures that articles are detailed enough that the majority of users can learn the most from each article
    2. It ensures the highest quality of articles on Code Project
    3. It helps the author receive best response possible (highest ratings) on Code Project


24. Why is my "Pending" article in "Composing" status now?

    Sometimes articles have great ideas but need a slightly different presentation. If your article is in composing status, look to your article forum and take the advice of your peers to heart. Generally, your article probably needs to answer one of these questions better:

    • What problem does this solution solve?
    • How does this help someone else?
    • How does the code actually work?
    • What is going on inside the code snippets?


25. What is a Code Project Mentor?

    We have experienced authors who would be willing to help you with your article, to improve it, and help get it approved by the community. If we ask you if you want a Mentor and you say yes, we then submit your article to the Mentor Forum and hopefully one of our Mentors will assign themselves to it, and post helpful suggestions on your article's forum. You can talk discuss with them how to improve the article, and once they feel your article is ready, will make your article available to the community.

26. I can't get the formatting right in my article. What do I do?

    Contact us at submit@codeproject.com. We're happy to help

27. My article was approved and all the votes and comments are gone. Why?

    Because most new articles require improvements, they receive comments that, once the article is approved, will no longer be relevant. They also receive multiple 1 votes which authors do not like, so we remove both comments and votes. It is permanent. This is also why you cannot reply to some of your initial comments if you were notified by e-mail.



28. Are comments specific to an article revision?

    Comments are tied to specific versions in order to allow members to post comments while author's fine tune their article during the composition and approval process.

    An example is that you post a new article and it's in a Pending state while members approve it. A few members find fault with it, and you make those corrections, and then the article is approved. The comments related to corrections should not be included in the final published version of the article.

29. I posted my article a year ago, and it is still unedited. Why?

    We only have limited staff to deal with thousands upon thousands of articles. We do our best to give them all some lovin', but the sad fact is there are too many. We work as hard as we can. If you can't wait, contact us at submit@codeproject.com so we can speed things up.

Tips

1. What is a tip?

   A tip has the same spirit of a regular article: it is meant primarily to provide a coding solution. However, tips are not as exhaustive or extensive, or requite as much detail as an article would to explain a problem and its solution. Articles may be several pages long, but tips might be a couple of paragraphs. Simply: state the problem and its solution.



2. How do I post a tip?

   From the home page, here:

    

   Then hit "Submit a Tip or Trick." From here on out, everything is identical to submitting an article.

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