Spring:PageNamingConventions

From Spring
Revision as of 10:20, 23 August 2009 by Seanheron (talk | contribs) (Spring:Page naming conventions moved to Spring:PageNamingConventions: well, best start here with the good practice...)
Jump to navigationJump to search

Conventions

Regarding Subpages

For which sections of the Site

Only pages within the "Development" section of the Sitestructure should use subpages. All pages in this Section should be either Super or Subpage. The Superpages are the following:

  • Engine
  • Lua
  • Unit
  • COB -- this maybe needs to go into Unit ? or be renamed to Scripting, as it's not just COB anymore ?
  • CEG
  • Map
  • AI

Pretty much all other pages should be subpages of one of these categories/superpages (the exception I would say are two pages, one grouping "content", the other grouping "coding" - AI, Engine and Lua.

We only use one level of Super and Subpage (no Unit-Cob-Animation or similiar). Superpages should match with categories.

Altogether as little as possible is my suggestion. Seanheron 22:43, 22 August 2009 (UTC)

Seperator

Use a "-" to seperate between the super and subpage. So we have Units-FBI, Maps-SMD, AI-Interface, etc.

Use "/" or ":" or "_" or "-" ?? Images seem to be broken if you use "/" to seperate parent and subpage Seanheron 00:17, 23 August 2009 (UTC)

Regarding naming

Please use short phrases for Names within the SiteStructure. Using more than three words is advised against, two will usually be optimal. CamelCase is probably the easiest way of achieving naming consistency (as Capitilization is clear).

Ie do we use CamelCase or write out the name seperately (words seperated by space " ") ? And pagenames - entire sentences, or limit to one or two words? Of course we don't have to force this on everything, but perhaps guidelines could be useful. Seanheron 00:17, 23 August 2009 (UTC)

Language versions

For pages in a language other than english, please name the page exactly as the english one just with an (la) attached at the end [la for language - use the two letter code of the language you're using, ie (fr) for french, (de) for german, etc.].

To stay consistent, always attach the (de) directly to the name, without a space in between.

To use a native language page title, please make a redirect to the page named according to the convention just described here (ie make a page "Page_principale" with the content: #REDIRECT MainPage(fr).

I wouldn't bother with seperate language versions for now, to be honest (and just stick to english - that's lacking enough. But whatever. Seanheron 00:29, 23 August 2009 (UTC)

Regarding Namespaces

I'd suggest we keep our page sorted in three namespaces - one for talking about the website, pages like this (Namespace: Spring). Then our main namespace, that is what we want people "from outside" to be able to see of the site - this is what is listed in the CurrentSiteMap. And finally we can still leave room for people to mess around in, but I think we should make an effort for it not to be so visible towards the outside - that's why I'd suggest stuff like the Clan info and Strategy guides for individual games go in a seperate namespace (perhaps "Talk" or "User"? - of course we could create one, but I think that's not going to happen... User is probably good.). Seanheron 00:17, 23 August 2009 (UTC)


Chat

So as to keep some order, we'll draw up some page naming conventions here, shall we ?

The most immediate issue is subpage naming - we currently have CEG_Something (COB_same) and Unit:Other (Map:Aswell).

It would be neater to have that all in the same style, and while we're at it, decide on when to use a "subpage" like style, and when to use names without prefixes.

More in a minute! Seanheron 21:57, 22 August 2009 (UTC)


Back to the Community Portal