[Home]  [Edit this page]  [Recent Changes]  [Special Pages]  [Help
NamingConventions

Naming Conventions

Always try to follow the CodePedia naming conventions when creating new pages in this system. This will help others to find the page and help prevent duplicate pages.

What are the conventions?

  • Try to avoid word modifiers, such as -s, -es or -ing, unless they are neccesary.
  • Try to avoid minor words like A, An or The unless they are needed for clarity.
  • Make the title long enough to be specific but not so long that it's a pain to type out.
    • Unless it gets too long, try to "categorize" the title. An example is
       ?QBasicFAQ_HowToGetMoreColors.
  • When using a person's name, a city, country, etc. for a link, spell it like it is normally spelled.
    • Bill Gates and not BillGates, B Gates or Mr. Gates.
    • United States Of America and not USA or America.
  • If the name you are using contains non-English characters, convert them to English ones if possible.
    • a instead of á, e instead of ë.
Remember, you can create a link with text that is different from the URL to make it look better and easier to read. With the above page example, you can do so like this:

[[QBasicFAQ_HowToGetMoreColors | How To Get More Colors]]

What characters are allowed in a page name?
A-Z, a-z, 0-9, space, and :-,@()'_

What characters are allowed in the link's alternate text?
Any English characters except for < and >.

How long can the link be?
The URL can be up to 64 characters. The alternate text can be 64 characters as well for a total of 128 characters.

What if I don't know if another page exists?
A good idea is to search for a page and see if it already exists. If it does, you can link to or edit the existing page. You can also use the "Pagename Search Tool" to search for page names. It is located at the bottom of the page when you are editing content.

What do I do if I find duplicate pages?
If you feel that you know enough on the subject, you can merge all the content into one article and leave a link to it in the other one.

last edited (December 22, 2002) by KDivad Leahcim, Number of views: 10819, Current Rev: 11 (Diff)

[Edit this page]  [Page history]  [What links here]  [Discuss this topic]  [Printer Friendly]  

Members

Username:

Password:


Register
Forgot Password?




Programmers Heaven - for .NET, Java, C/C++ and WEB Developers!
© 1996-2008 Community Networks Ltd. All rights reserved. Reproduction in whole or in part, in any form or medium without express written permission is prohibited. Violators of this policy may be subject to legal action. Please read Terms Of Use and Privacy Statement for more information. Development by Tore Nestenius at .NET Consultant - Synchron Data.