Help:Page naming conventions - Revision history

Le Borgne: /* Lab-specific pages */

2010-08-16T14:12:54Z

Lab-specific pages

←Older revision		Revision as of 14:12, 16 August 2010
Line 11:		Line 11:
	===Lab-specific pages===		===Lab-specific pages===
	If a page is specific to your lab, include the PI's name as the prefix in the title (e.g. [[Endy:Research]]). The convention has been <code>LabName:Page title</code> so that things stay consistent. The reason for this is that on the wiki you can only have one page named 'X', so we have to share the common terms.		If a page is specific to your lab, include the PI's name as the prefix in the title (e.g. [[Endy:Research]]). The convention has been <code>LabName:Page title</code> so that things stay consistent. The reason for this is that on the wiki you can only have one page named 'X', so we have to share the common terms.
		+	/* Le Borgne's lab */

	===Field-specific pages===		===Field-specific pages===

Reshma P. Shetty: /* What should I name my page? */

2007-04-28T17:31:54Z

What should I name my page?

←Older revision		Revision as of 17:31, 28 April 2007
Line 4:		Line 4:
	It depends on the nature of the page. Here are some general guidelines ...		It depends on the nature of the page. Here are some general guidelines ...

-	~~# Try~~ to ~~capitalize~~ only the first word in a page title (sentence caps format). For instance, use ~~'''~~[[Electrocompetent cells]]~~'''~~ instead of ~~'''~~Electrocompetent Cells~~'''~~. This convention makes it easier for an editor to link to a page, since there's no need to check the original capitalization. Creating a link beginning with a lower-case letter will link to a target page with the first letter capitalized, which also makes initial caps more universal. Abbreviations, acronyms, and proper names are clearly exceptions, e.g., [[Colony PCR]] and user pages.	+	===General purpose pages===
-	~~# When adding~~ a ~~new page use your best judgement as to whether the~~ page is ~~something that is targeted to the community at large, or is more~~ specific to your ~~group. For instance: [[Research]] vs. [[Endy:Research]]. Same goes for members~~, ~~meetings, talks, etc. If it is something specific to your group, try and~~ include the ~~group~~'s name in the title. (e.g. Endy:Research) The convention has been <~~font face=courier~~>~~Group~~:Page title</~~font~~> so that things stay consistent. The reason for this is that on the wiki you can only have one page named 'X', so we have to share the common terms.	+	General purpose pages are things like [[Help:Consensus protocol\|consensus protocols]] and other pages that are intended as a general reference source for the user community (e.g. [[Escherichia coli]]). Typically these pages are open to editing by anyone.
-	# There are often times when people want to create a page and then create several pages that all relate back to that one page. An easy way to do this is using a slash '/' in the page title. For instance, [[OpenWetWare:Software]] has several related subpages like [[OpenWetWare:Software/Analytics]], [[OpenWetWare:Software/User management]], [[OpenWetWare:Software/Ideas]] and more. The advantage of this convention is that it automatically creates back links at the top of each subpage.	+
-	# Pages that are directly related to OpenWetWare itself generally are named <font face=courier>OpenWetWare:Page title</font>. For instance, [[OpenWetWare:Presentations]] is a page about OpenWetWare presentations.	+	Capitalize only the first word in a page title (sentence caps format). For instance, use <code>[[Electrocompetent cells]]</code> instead of <code>Electrocompetent Cells</code>. This convention makes it easier for an editor to link to a page, since there's no need to check the original capitalization. Creating a link beginning with a lower-case letter will link to a target page with the first letter capitalized, which also makes initial caps more universal. Abbreviations, acronyms, and proper names are clearly exceptions, e.g., [[Colony PCR]] and user pages.
		+
		+	===Lab-specific pages===
		+	If a page is specific to your lab, include the PI's name as the prefix in the title (e.g. [[Endy:Research]]). The convention has been <code>LabName:Page title</code> so that things stay consistent. The reason for this is that on the wiki you can only have one page named 'X', so we have to share the common terms.
		+
		+	===Field-specific pages===
		+	Some groups elect to host pages relating to a certain field of research. Use your field's name as a prefix for those pages like <code>[[Mimulus]]</code> or <code>[[Synthetic Biology]]</code> (e.g. [[Synthetic Biology:Labs]]).
		+
		+	===Institution-specific pages===
		+	If a page is specific to your institution like pages relating to core facilities, use your institution name as a prefix like <code>MIT</code>.
		+
		+	===OpenWetWare-specific pages===
		+	Pages that are directly related to OpenWetWare itself generally are named <code>OpenWetWare:Page title</code>. For instance, [[OpenWetWare:Presentations]] is a page about OpenWetWare presentations.
		+
		+	===Sets of related pages===
		+	There are often times when people want to create a page and then create several pages that all relate back to that one page. An easy way to do this is using a slash '/' in the page title. For instance, [[OpenWetWare:Software]] has several related subpages like [[OpenWetWare:Software/Analytics]], [[OpenWetWare:Software/User management]], [[OpenWetWare:Software/Ideas]] and more. The advantage of this convention is that it automatically creates back links at the top of each subpage.

	==Are there any restrictions on what I can name a page?==		==Are there any restrictions on what I can name a page?==

Reshma P. Shetty at 17:26, 21 March 2007

2007-03-21T17:26:14Z

←Older revision		Revision as of 17:26, 21 March 2007
Line 1:		Line 1:
-	<font ~~color~~=~~green~~>~~Work in progress. These guidelines are meant to serve as substrate for discussion. They do not represent OpenWetWare policy (yet).~~</font>	+	<font size=1>< [[Help:Contents\|Help]]</font>

	==What should I name my page?==		==What should I name my page?==

Reshma P. Shetty: /* Why would I want to use the namespace convention for naming my new pages? */

2006-09-14T22:33:16Z

Why would I want to use the namespace convention for naming my new pages?

←Older revision		Revision as of 22:33, 14 September 2006
Line 36:		Line 36:
	===Improper edits are less likely===		===Improper edits are less likely===
	Naming your or your lab's pages with an appropriate, consistent prefix (see above) reduces the chance that someone will come along and edit your page. For instance, anyone should feel free to edit the [[DNA ligation]] page but really only Endy lab members should edit [[Endy:DNA ligation using T4 DNA ligase]].		Naming your or your lab's pages with an appropriate, consistent prefix (see above) reduces the chance that someone will come along and edit your page. For instance, anyone should feel free to edit the [[DNA ligation]] page but really only Endy lab members should edit [[Endy:DNA ligation using T4 DNA ligase]].
		+
		+	===Tracking changes to your lab's pages===
		+	One nice feature of using the namespace convention is that it makes it easier to track changes for your lab or course. For instance, check out all the recent changes to the [[Special:Recentchanges/Smolke\|Smolke lab]], [[Special:Recentchanges/Kafatos\|Kafatos lab]] or even to [[Special:Recentchanges/n=4\|OpenWetWare pages]]. But changes only show up in these filtered lists if you use the proper namespace convention!

	==Can I edit pages outside of my or my lab's namespace?==		==Can I edit pages outside of my or my lab's namespace?==

Reshma P. Shetty at 16:15, 14 August 2006

2006-08-14T16:15:45Z

←Older revision		Revision as of 16:15, 14 August 2006
Line 47:		Line 47:

	==How do I notify someone about a confusing page name?==		==How do I notify someone about a confusing page name?==
-	Use the [[Template:Confusing page name\|Confusing page name notification template]]. See there for instructions on how to use it. Leave a message either on the talk page of the confusing page, or on a person's user page.	+	Use the [[Template:Confusing page name\|Confusing page name notification template]]. See there for instructions on how to use it. Leave a message either on the talk page of the confusing page, or on a person's user talk page.

Reshma P. Shetty at 16:15, 14 August 2006

2006-08-14T16:15:26Z

←Older revision		Revision as of 16:15, 14 August 2006
Line 45:		Line 45:
	==How do I rename a page?==		==How do I rename a page?==
	See [[Help:Renaming pages\|instructions for how to rename a page]].		See [[Help:Renaming pages\|instructions for how to rename a page]].
		+
		+	==How do I notify someone about a confusing page name?==
		+	Use the [[Template:Confusing page name\|Confusing page name notification template]]. See there for instructions on how to use it. Leave a message either on the talk page of the confusing page, or on a person's user page.

ClarkeS: /* What is a namespace? */

2006-07-13T19:25:43Z

What is a namespace?

←Older revision		Revision as of 19:25, 13 July 2006
Line 24:		Line 24:

	==What is a namespace?==		==What is a namespace?==
-	A namespace is a subdivision of OpenWetWare denoted by a term and then a colon, like '''OpenWetWare:'''. This can be used to indicate information particular to a lab or other grouping~~. At~~ this time this convention does not add special technical function to the pages, but just serves to clarify and prevent overlap of common names.	+	A namespace is a subdivision of OpenWetWare denoted by a term and then a colon, like '''OpenWetWare:'''. There are also namespaces for images ('''Image:''') and certain other categories. There are also prefixes, which look like namespaces, such as '''IGEM:'''. This can be used to indicate information particular to a lab or other grouping, but at this time this convention does not add special technical function to the pages, but just serves to clarify and prevent overlap of common names. You can search for all pages with a certain prefix in the [[Special:Prefixindex \| Prefix index]]. There you can even search within a namespace for a certain prefix, which may be a bit confusing.

	==What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?==		==What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?==

ClarkeS: /* What is a namespace? */

2006-07-13T18:37:22Z

What is a namespace?

←Older revision		Revision as of 18:37, 13 July 2006
Line 24:		Line 24:

	==What is a namespace?==		==What is a namespace?==
		+	A namespace is a subdivision of OpenWetWare denoted by a term and then a colon, like '''OpenWetWare:'''. This can be used to indicate information particular to a lab or other grouping. At this time this convention does not add special technical function to the pages, but just serves to clarify and prevent overlap of common names.

	==What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?==		==What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?==

ClarkeS: /* What is the best way to create a new page with a common name, like "protocol" or "lab meetings"? */

2006-07-13T18:33:14Z

What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?

←Older revision		Revision as of 18:33, 13 July 2006
Line 26:		Line 26:

	==What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?==		==What is the best way to create a new page with a common name, like "protocol" or "lab meetings"?==
		+	Check to see if the page exists as a general page or if there are pages with this name in other namespaces. See above for guidance on whether to put this new page under a specific namespace.

	==Why would I want to use the namespace convention for naming my new pages?==		==Why would I want to use the namespace convention for naming my new pages?==

Reshma P. Shetty at 16:29, 12 July 2006

2006-07-12T16:29:47Z

←Older revision		Revision as of 16:29, 12 July 2006
Line 28:		Line 28:

	==Why would I want to use the namespace convention for naming my new pages?==		==Why would I want to use the namespace convention for naming my new pages?==
		+
		+	===Finding pages is easier===
		+	A consistent naming scheme makes it easier to find existing pages.
		+
		+	===Improper edits are less likely===
		+	Naming your or your lab's pages with an appropriate, consistent prefix (see above) reduces the chance that someone will come along and edit your page. For instance, anyone should feel free to edit the [[DNA ligation]] page but really only Endy lab members should edit [[Endy:DNA ligation using T4 DNA ligase]].
		+
		+	==Can I edit pages outside of my or my lab's namespace?==
		+
		+	Yes! All OWW users are encouraged to edit pages without a prefix or pages with the <font face=courier>OpenWetWare:</font> prefix. Just don't vandalize!
		+
		+	If a page has a prefix from another user or lab, you can still edit the page ... just leave a note on the associated Talk page explaining your edit. (For instance, "I think this reference might be helpful". Or "I found this mistake and I fixed it". Or "I tried to help you out with some formatting".) That way you signal to other OWW users why you made the change and give them the option of responding.

	==How do I rename a page?==		==How do I rename a page?==
	See [[Help:Renaming pages\|instructions for how to rename a page]].		See [[Help:Renaming pages\|instructions for how to rename a page]].