Spring:PageNamingConventions - Revision history

Flozi: merge Category:Website into Category:Spring

2013-03-17T22:37:27Z

merge Category:Website into Category:Spring

← Older revision		Revision as of 23:37, 17 March 2013
Line 38:		Line 38:
	[[Spring:Community Portal\|Back to the Community Portal]]		[[Spring:Community Portal\|Back to the Community Portal]]
	__NOTOC__		__NOTOC__
	[[Category:~~Website~~]]		[[Category:Spring]]

Flozi: general clean-up and new rules (i.e. : not - as separator)

2013-02-22T17:39:00Z

general clean-up and new rules (i.e. : not - as separator)

← Older revision		Revision as of 18:39, 22 February 2013
Line 1:		Line 1:
	~~See [http://springrts.com/phpbb/viewtopic.php?f~~=~~1&t~~=~~19761 this thread] for some background.~~		=Page Naming Conventions=

	~~CEG in the "New" section in [[Spring:CurrentSiteMap]] is an example of the Naming Convention described below.~~		==Regarding Sub-pages==

	~~=Conventions=~~

	==Regarding ~~Subpages~~==

	=== For which sections of the Site===		=== 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:		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		*Engine
	*Lua ~~-- maybe call it Lua_Script?~~		*Mapdev
			*Gamedev
			*AI
			*Lua
	*Unit		*Unit
	*~~Weapon~~		*Model
	*~~3do~~		*Animation
	*S3o -- Both model formats can make use of certain subpages covering like texturing (Question: Making it "S3o" because of everything starts big or "s3o" because it's "more correct" and doesn't look as strange?)
	*COB <strike>Animation~~</strike>~~
	*Lua_Anim -- both categories most certainly will need subpages so having them divided should be worthwile
	*CEG		*CEG
	*Map
	*AI - some overlap with Lua here - we do have the dedicated AI's (in C++, etc), but we also have Lua AI's - I guess we stick Lua AI's in here though.
	*Mission
	*Misc

	~~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~~.		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.

	~~''Altogether as little as possible is my suggestion. [[User~~:~~Seanheron\|Seanheron]] 22~~:~~43, 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.

	===~~Seperator~~===		===Separator===

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

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

	==Regarding naming==		==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).		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.

	''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.'' [[User:Seanheron\|Seanheron]] 00:17, 23 August 2009 (UTC)
	==Language versions ==		==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~~.].		For the sake of maintainability the Spring wiki is currently English language only. Non-English language pages '''will''' be tagged for deletion!

	~~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: <pre>#REDIRECT [[MainPage(fr)]]</pre>.~~

	~~''I wouldn't bother with seperate language versions for now, to be honest (and just stick to english - that~~'~~s lacking enough. But whatever. [[User:Seanheron\|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.). [[User:Seanheron\|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!~~		== Previous Discussions ==
	~~[[User:Seanheron~~\|~~Seanheron]] 21:57, 22 August 2009 (UTC)~~		{{forumlink\|topic=19761\|title=Wiki/site pages Naming scheme?}}

Flozi: /* Language versions */ remove wanted link, this page warrants more current discussion

2011-07-13T15:11:43Z

Language versions: remove wanted link, this page warrants more current discussion

← Older revision		Revision as of 16:11, 13 July 2011
Line 47:		Line 47:
	To stay consistent, always attach the (de) directly to the name, without a space in between.		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)]].		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: <pre>#REDIRECT [[MainPage(fr)]]</pre>.

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

Master-athmos: changes on superpage names

2009-08-24T18:53:40Z

changes on superpage names

← Older revision		Revision as of 19:53, 24 August 2009
Line 11:		Line 11:
	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:		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		*Engine
	*Lua		*Lua -- maybe call it Lua_Script?
	*~~Unitdefs~~		*Unit
	*~~Models~~		*Weapon
	*~~Animation~~ <strike>~~COB~~</strike> -- ~~Both Cob and then new Luascripting would go in here~~		*3do
			*S3o -- Both model formats can make use of certain subpages covering like texturing (Question: Making it "S3o" because of everything starts big or "s3o" because it's "more correct" and doesn't look as strange?)
			*COB <strike>Animation</strike>
			*Lua_Anim -- both categories most certainly will need subpages so having them divided should be worthwile
	*CEG		*CEG
	*Map		*Map
	*AI - some overlap with Lua here - we do have the dedicated AI's (in C++, etc), but we also have Lua AI's - I guess we stick Lua AI's in here though.		*AI - some overlap with Lua here - we do have the dedicated AI's (in C++, etc), but we also have Lua AI's - I guess we stick Lua AI's in here though.
			*Mission
			*Misc

	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.		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.

Seanheron: little changes

2009-08-23T20:52:05Z

little changes

← Older revision		Revision as of 21:52, 23 August 2009
Line 12:		Line 12:
	*Engine		*Engine
	*Lua		*Lua
	*~~Unit~~		*Unitdefs
	*COB -- ~~this maybe needs to~~ go ~~into Unit ? or be renamed to Scripting, as it's not just COB anymore ?~~		*Models
			*Animation <strike>COB</strike> -- Both Cob and then new Luascripting would go in here
	*CEG		*CEG
	*Map		*Map
	*AI		*AI - some overlap with Lua here - we do have the dedicated AI's (in C++, etc), but we also have Lua AI's - I guess we stick Lua AI's in here though.

	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.		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.

Seanheron: point to example

2009-08-23T12:11:34Z

point to example

← Older revision		Revision as of 13:11, 23 August 2009
Line 1:		Line 1:
	See [http://springrts.com/phpbb/viewtopic.php?f=1&t=19761 this thread] for some background.		See [http://springrts.com/phpbb/viewtopic.php?f=1&t=19761 this thread] for some background.

			CEG in the "New" section in [[Spring:CurrentSiteMap]] is an example of the Naming Convention described below.

	=Conventions=		=Conventions=

Seanheron: link to thread

2009-08-23T09:23:01Z

link to thread

← Older revision		Revision as of 10:23, 23 August 2009
Line 1:		Line 1:
			See [http://springrts.com/phpbb/viewtopic.php?f=1&t=19761 this thread] for some background.

	=Conventions=		=Conventions=

Seanheron: Spring:Page naming conventions moved to Spring:PageNamingConventions: well, best start here with the good practice...

2009-08-23T09:20:45Z

Spring:Page naming conventions moved to Spring:PageNamingConventions: well, best start here with the good practice...

← Older revision	Revision as of 10:20, 23 August 2009
(No difference)

Seanheron: added some notes on different language versions

2009-08-23T00:29:46Z

added some notes on different language versions

← Older revision		Revision as of 01:29, 23 August 2009
Line 31:		Line 31:

	''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.'' [[User:Seanheron\|Seanheron]] 00:17, 23 August 2009 (UTC)		''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.'' [[User:Seanheron\|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. [[User:Seanheron\|Seanheron]] 00:29, 23 August 2009 (UTC)''

	==Regarding Namespaces==		==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]].''		''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" ?). [[User:Seanheron\|Seanheron]] 00:17, 23 August 2009 (UTC)''		''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.). [[User:Seanheron\|Seanheron]] 00:17, 23 August 2009 (UTC)''

	----		----

Seanheron: hmm, italic not working across a newline ?

2009-08-23T00:18:38Z

hmm, italic not working across a newline ?

← Older revision		Revision as of 01:18, 23 August 2009
Line 34:		Line 34:
	==Regarding Namespaces==		==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]].		''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" ?). [[User:Seanheron\|Seanheron]] 00:17, 23 August 2009 (UTC)''		''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" ?). [[User:Seanheron\|Seanheron]] 00:17, 23 August 2009 (UTC)''

	----		----