From WikiChip
Difference between revisions of "WikiChip:naming conventions"

(→‎Title)
 
(2 intermediate revisions by the same user not shown)
Line 73: Line 73:
 
* Model number all lowercase
 
* Model number all lowercase
 
* /proc/cpuid name (See [[WikiChip:model numbers]])
 
* /proc/cpuid name (See [[WikiChip:model numbers]])
 +
* Part number
 +
* Part number all lowercase
 +
 +
(if applicable)
 +
* S-Spec number
 +
* S-Spec number all lower
 +
* Q-Spec number
 +
* Q-Spec number all lower
  
 
Example:
 
Example:
Line 87: Line 95:
  
  
−
In the case of an ambiguity, a disambiguation page should be created.
+
In the case of an ambiguity, a disambiguation page should be created. Also note that normally you do not need to manually set up a redirect for things such as model number, part number, and s-spec. We have a bot that periodically does it automatically.
  
 
== Title ==
 
== Title ==
 
Due to our hierarchical naming convention, the article title become rather ugly. Take for example the article [[intel/core i7/i7-4770r]]. We wouldn't want all that in the title. What we normally do is use a decorated title which on wikichip is enclosed inside a <code><nowiki>{{XXX title|title}}</nowiki></code> template. For example, for [[AMD]] we have {{template|amd title}} which is used by simple giving it a more concise name. For example for the {{amd|Am486}} article we used <code><nowiki>{{amd title|Am486}}</nowiki></code> which results in the nicer article topic: "Am486 - AMD".
 
Due to our hierarchical naming convention, the article title become rather ugly. Take for example the article [[intel/core i7/i7-4770r]]. We wouldn't want all that in the title. What we normally do is use a decorated title which on wikichip is enclosed inside a <code><nowiki>{{XXX title|title}}</nowiki></code> template. For example, for [[AMD]] we have {{template|amd title}} which is used by simple giving it a more concise name. For example for the {{amd|Am486}} article we used <code><nowiki>{{amd title|Am486}}</nowiki></code> which results in the nicer article topic: "Am486 - AMD".
 +
 +
For any other title that needs proper casing in the title, you can use the {{template|title}} template, for example <code><nowiki>{{title|FooBar}}</nowiki></code>.
  
 
== Linking ==
 
== Linking ==

Latest revision as of 15:08, 29 June 2017

Due to how companies name their products and how other companies that use their products (or second source them) name their, there would be too much disambiguation needed for a flat naming system such as the one Wikipedia uses. Instead, WikiChip uses a simple hierarchy of pages to disambiguate everything. This page explains in detail the naming conventions we use across this Wiki to name article.

Casing[edit]

Regardless of naming, all article names are written in lowercase. (See #Redirect Policy)

Organization[edit]

Chips[edit]

We use a simple hierarchy to organize articles. The root article is typically the designer of the product (or the company most commonly associated with the product). A separate article is used to group a collection of similar models into a family. If there is no common name for a group of chips, we still create one under a generic series name (e.g. "m51xx series"). Each model then becomes a sub-article of the family.

Examples:

  • company
    • /family
      • /chip

Final name: company/family/chip.

Final name: intel/mcs-4/4004

Final name: amd/am5x86/amd-x5-133adz

Other Topics[edit]

Most other topics follow the same general hierarchy described for chips. The root article is the main page for a specific concept with the various sub-topics as sub-articles. Tightly related topics should always be placed under a parent topic.

Examples:

  • main topic
    • sub-topic
      • possible sub-sub-topic

Final name: main topic/sub-topic/sub-sub-topic

Final name: c/standard library

Final name: boolean algebra/majority function

Other[edit]

For all other types of pages the really generic organization should be applied:

  • concept
    • dependent concept
      • specialized instances of the dependent concept.

Redirect Policy[edit]

Since all article names are in lower case, appropriate redirects should be create to make it easier for people to find an article using the common name (which may or may be the same as the actual model/product name). Below is a number of redirects that most chip models should have.

  • Full common name
  • Full common name, all lowercase
  • Common name, just family/model, if applicable
  • Common name, just family/model all alowercase, if applicable
  • Model number
  • Model number all lowercase
  • /proc/cpuid name (See WikiChip:model numbers)
  • Part number
  • Part number all lowercase

(if applicable)

  • S-Spec number
  • S-Spec number all lower
  • Q-Spec number
  • Q-Spec number all lower

Example:

E.g. Intel Core i7-4770R:


In the case of an ambiguity, a disambiguation page should be created. Also note that normally you do not need to manually set up a redirect for things such as model number, part number, and s-spec. We have a bot that periodically does it automatically.

Title[edit]

Due to our hierarchical naming convention, the article title become rather ugly. Take for example the article intel/core i7/i7-4770r. We wouldn't want all that in the title. What we normally do is use a decorated title which on wikichip is enclosed inside a {{XXX title|title}} template. For example, for AMD we have {{amd title}} which is used by simple giving it a more concise name. For example for the Am486 article we used {{amd title|Am486}} which results in the nicer article topic: "Am486 - AMD".

For any other title that needs proper casing in the title, you can use the {{title}} template, for example {{title|FooBar}}.

Linking[edit]

Due to how we name things it could get a bit cumbersome to link to various pages. To help with that we have a number of helpful templates that should be used:

  • {{\}} - Links to a subpage
  • {{\\}} - Links to a sibling page (subpage from the same parent article)
  • {{XXX|article}} - Links to a specific subpage, where XXX is one of many possible things. (e.g. {{c|topic}}, {{intel|MCS-80}}, {{amd|Opteron}}, etc..).

Note that proper casing can be used in all of the above template. They will lowercase the name for link automatically.

Retrieved from "https://en.wikichip.org/w/index.php?title=WikiChip:naming_conventions&oldid=48766"