logo_header

icon_bubbles Forum

icon_bubbles Wiki

icon_bubbles Planet

RootForum Community » Wiki

Help:Naming Conventions

From RootForum Community » Wiki

Jump to:navigation, search

Contents

Namespaces

The RootForum Wiki specific namespaces are:

  • Offical - for official RootForum Wiki related article.

There are several standard namespaces, including:

  • User - Contains user pages. Users may use subpages in this namespace for creating drafts or for their own (RootForum Wiki related) purposes.
  • User Talk - Used for user talk pages, which should only be used for communication between users.
  • Template - Used for templates.
  • Help - Help articles such as this one.

Prefix

Prefixes are not used on the RootForum Wiki. Categories should be used instead.

Illegal Characters

The following characters are not allowed in page names:

  • Colon (:) - Used to separate an article name from its namespace
  • Forward slash (/) - Used to create subpages
  • Question mark (?) - Is a special characters in web addresses
  • Plus (+) - Is a special character in web addresses
  • Ampersand (&) - Is a special character in web addresses
  • Dot (.) - Can cause problems with web addresses
  • Percent (%) - Is a special character used for character encoding
  • Hash (#) - Are special characters in web addresses
  • Angle brackets (< >) - Are special characters in wiki markup
  • Square brackets ([ ]) - Are special characters in wiki markup
  • Pipe (|) - Is a special character in wiki markup
  • Curly Brackets ({ }) - Are special characters in wiki markup
  • "At sign" (@) - Is a special character in web addresses

General Naming Advice

  • Page names should be short.
  • Case Sensitive: Casing is important - The files are identified only if the case matches.
  • Page names should not generally contain words like "install", "configure" or "linux".
  • Page names should be related to the article content.
    • If there is an already existing page with the name you wish to use, please consider whether you should be contributing to the existing article or renaming one of the articles.
    • If you decide rename the pre-existing article, please provide a link to the new location at the top of your new article.


Examples of good page names are:

  • Mail server using Postfix, Dovecot and DSpam
  • Chroot from a livecd


Examples of bad page names are:

  • Installing postfix, dovecot and dspam on Linux
  • Chrooting a Linux install from the livecd