Spring:PageNamingConventions: Difference between revisions

From Spring
Jump to navigationJump to search
some first thoughts - will expand in a moment
Flozi (talk | contribs)
merge Category:Website into Category:Spring
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Spring:Community Portal|Back to the Community Portal]]
=Page Naming Conventions=


So as to keep some order, we'll draw up some page naming conventions here, shall we ?
==Regarding Sub-pages==


The most immediate issue is subpage naming - we currently have CEG_Something (COB_same) and Unit:Other (Map:Aswell).
=== For which sections of the Site===


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.
Only pages within the "Development" section of the Site-structure should use sub-pages. All pages in this Section should be either Super or Sub-page. The Super-pages are the following:
*Engine
*Mapdev
*Gamedev
*AI
*Lua
*Unit
*Model
*Animation
*CEG


More in a minute!
Pretty much all other pages should be sub-pages of one of these categories/super-pages (the exception I would say are two pages, one grouping "content", the other grouping "coding" - AI, Engine and Lua.
[[User:Seanheron|Seanheron]] 21:57, 22 August 2009 (UTC)


----
We only use one level of Super and Sub-page (no Unit:Cob:Animation or similar). Super-pages should match with categories.
=Conventions=


==Regarding Subpages==
===Separator===


=== For which sections of the Site===
Use a ":" to separate between the super and sub-page. So we have Units:UnitDefs, Mapdev:SMD, AI:Interface, etc.


As little as possible is my suggestion. [[User:Seanheron|Seanheron]] 22:43, 22 August 2009 (UTC)
==Regarding naming==


===Seperator===
Please use short phrases for Names within the Site-structure. Using more than three words is advised against, two will usually be optimal. CamelCase is probably the easiest way of achieving naming consistency (as Capitalisation is clear), avoid spaces in page names.


Use "/" or ":" or "_" or "-" ?? Images seem to be broken if you use "/" to seperate parent and subpage
==Language versions ==


==Regarding naming==
For the sake of maintainability the Spring wiki is currently English language only. Non-English language pages '''will''' be tagged for deletion!
 
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.


== Previous Discussions ==
{{forumlink|topic=19761|title=Wiki/site pages Naming scheme?}}




[[Spring:Community Portal|Back to the Community Portal]]
[[Spring:Community Portal|Back to the Community Portal]]
 
__NOTOC__
[[Category:Website]]
[[Category:Spring]]

Latest revision as of 23:37, 17 March 2013

Page Naming Conventions

Regarding Sub-pages

For which sections of the Site

Only pages within the "Development" section of the Site-structure should use sub-pages. All pages in this Section should be either Super or Sub-page. The Super-pages are the following:

  • Engine
  • Mapdev
  • Gamedev
  • AI
  • Lua
  • Unit
  • Model
  • Animation
  • CEG

Pretty much all other pages should be sub-pages of one of these categories/super-pages (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 Sub-page (no Unit:Cob:Animation or similar). Super-pages should match with categories.

Separator

Use a ":" to separate between the super and sub-page. So we have Units:UnitDefs, Mapdev:SMD, AI:Interface, etc.

Regarding naming

Please use short phrases for Names within the Site-structure. Using more than three words is advised against, two will usually be optimal. CamelCase is probably the easiest way of achieving naming consistency (as Capitalisation is clear), avoid spaces in page names.

Language versions

For the sake of maintainability the Spring wiki is currently English language only. Non-English language pages will be tagged for deletion!

Previous Discussions

Wiki/site pages Naming scheme?


Back to the Community Portal