Help:Page naming conventions

From OpenWetWare

Revision as of 22:06, 20 June 2006 by Reshma P. Shetty (Talk | contribs)
Jump to: navigation, search

Work in progress. These guidelines are meant to serve as substrate for discussion. They do not represent OpenWetWare policy (yet).

Contents

What should I name my page?

It depends on the nature of the page. Here are some general guidelines ...

  1. 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.
  2. 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 Group:Page title 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.
  3. 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.
  4. Pages that are directly related to OpenWetWare itself generally are named OpenWetWare:Page title. For instance, OpenWetWare:Presentations is a page about OpenWetWare presentations.

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

There are no restrictions on pages name in OpenWetWare, just guidelines!  :)

Why are there page naming conventions?

All users must share the same namespace

Every page on OpenWetWare must have a unique name. Thus, we try to reserve general pages names like Protocols, Materials, Posters and others for pages that are of general use to the community. Pages that are specific for a particular user or lab should be named accordingly.

For instance, Endy:DNA ligation using T4 DNA ligase is a page devoted to the Endy lab's protocol for DNA ligation whereas DNA ligation is a page with general information about DNA ligation and links to specific protocols (like Endy:DNA ligation using T4 DNA ligase).

Respecting eachothers' pages

In OpenWetWare, every user can edit all pages on the wiki. By naming your page according to either your username or your lab (as appropriate), you indicate to other OpenWetWare users that they should be respectful of that page and be mindful of the fact that it is someone else's page when making edits.

On the other hand, if you name a page PCR, then that should be a signal to other OpenWetWare users that they should edit (and improve!) that page at will.

What is a namespace?

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

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

How do I rename a page?

See instructions for how to rename a page.

Personal tools