Difference between revisions of "Willipedia:Naming conventions"

m (in progress)
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
''This is a draft of a policy being worked on by the [[Willipedia board]].  It has no effect until approved by board consensus.''
+
Titles of articles in Willipedia are chosen to serve two crucial goals which are sometimes at odds. 
 +
#Titles [[Willipedia:Policies#Article_Titles_are_a_Promise_._._.|create expectations]], and therefore a title ought to accurately reflect the content that follows it.
 +
#But, on Willipedia, titles are the names that articles are called by. If titles are not succinct, they will never be linked to, and will fall into obscurity.
 +
 
 +
'''For an example,''' consider the old article, "How To Procrastinate."  This was the first title it had, and it did a good job of creating the expectation of a list of suggestions, which is indeed what the article was.  But suppose that someone who doesn't know about this article is writing a related article; his prose is much more likely to contain (and so more likely to link to) the word "procrastination" or "procrastinating" than the full phrase "how to procrastinate." Thus the article is currently called [[procrastinating]].
 +
 
 +
The set of naming conventions below arises from this need for a minimal set of rules for editors to learn so we know how to best name our new articles, and how to link to existing content (or future content) as we write body text.
 +
 
 +
==General guideline==
 +
If you want to write an article on something rather specific, make sure that  it is accessible from related, more general topics. You can do this in one of two ways:
 +
* Link to your specific article from the more general article
 +
* Include the content of your would-be article in the more general article
 +
 
 +
Often this means you'll need to create a perfunctory article or introduction for the more general topic, but the benefit is that people who search for the general topic will also be able to find your article.
 +
 
 +
'''Illustrative examples:'''
 +
 
 +
''Problem:'' You want to write about how awesome the beech in the [[Forest Garden]] is for [[tree-climbing]]. 
 +
:''A good start:'' Even though you just want to write about that one tree, start/edit the article "Tree climbing," and place what you write in a section of it.  If you want to do a really good job, go the extra mile to start a preface on the general title to help other editors get an idea of where they can work from.
 +
 
 +
:''In the future:'' Even without a preface, it's a very good bet that others will expand on this subject, with more trees and perhaps a guide to history and technique of the pasttime.
 +
 
 +
''Problem:'' You want to give advice on procrastinating on a thesis.  You're thinking "How to procrastinate on a thesis" might be a good title.
 +
:''A good start:'' Think about your topic in the general sense.  You are talking about two things:  the practice of [[procrastinating]] and the topic "[[thesis]]."  Start/edit an article with either name, and include what you want to write in a well-named section, even if it is a lonely section at first. 
 +
 
 +
:''In the future:'' Others are likely to have something to say about "Procrastinating" or "Thesis".  The articles are likely to cross-link.  Over time, what you started will evolve into a rich article.
 +
 
 +
==Tools==
 +
 
 +
Willipedia depends on things being where people expect them to be.  The MediaWiki software contains a few key tools that make this easy to do, and you can help Willipedia out a lot by learning them.
 +
 
 +
===Redirects===
 +
 
 +
A redirect page is a page whose only function is to send anyone visiting that page to a page by a different name.  Redirects are incredibly important, and everyone should learn how to make one.
 +
 
 +
Using a redirect, a link to [[Bethans]] will go to [[Elizabethans]].  The former is a common colloquial form likely to crop up in articles, but the latter is the only reasonable title for the article.  To prevent editors from accidentally writing two pages about the same thing, redirects are crucial.
 +
 
 +
'''Making a redirect.''' Let's say we want to make "WUFO" point to "Williams Ultimate Frisbee Organization".  Start a new page having the name that you want to become a redirect -- in this case, [[WUFO]].  Make its content
 +
<center>
 +
<nowiki>#redirect [[REDIRECT_TARGET]]</nowiki>
 +
</center>
 +
where <nowiki>[[REDIRECT_TARGET]]</nowiki> is the name of the article you want to go to -- in this case, "[[Williams Ultimate Frisbee Organization]]".
 +
 
 +
'''Make redirects often.''' Any time you think of a term that people often use to name something else, and that term only names that one thing, make the page a redirect.  WUFO can only refer to the frisbee club, so it's a great redirect.  Furthermore, any time you were deciding between a few choices for a new article title (class or classes?  skiing or alpine skiing?) it's usually a great idea to make the title you didn't use a redirect to the one you did use.
 +
 
 +
Sometimes, though, a word has more than one meaning.  "Hopkins," unfortunately, is both the administrative hall and the dormitory.  The page [[Hopkins]], then, needs to be a [[#Disambiguation pages|disambiguation page]].
 +
 
 +
===Disambiguation pages===
 +
 
 +
A disambiguation page is a page whose sole function is to provide access to the two or more meanings that one word or phrase has, such as [[Spencer]] and [[Weston]].  The page content can be anything that helps readers find their way to the right place, so long as the page has a link to every reasonable interpretation.  It also should begin with the code <nowiki>{{disambig}}</nowiki>.  This tags the page as a disambiguation page.
 +
 
 +
===Renaming (moving) a page===
 +
 
 +
To rename a page so that its title conforms to these guidelines, move it using the "Move this page" link at the bottom of the screen.  When you move a page, the program automatically creates a [[#Redirects|redirect]] at the old location that points to the new location.
 +
 
 +
It is not a big deal, but it is good form, when you move a page, to fix all the links in Willipedia that pointed to the old name.  If you move a young page, this is often a short job, and a nice thing to do.  If you move an old page, it can have dozens of links to it, making this job very annoying.  No one will fault you for not wanting to go and do all that work yourself, but consider leaving a message for the [[Willipedia board]] letting us know we ought to look into it.
 +
 
 +
==Conventions==
  
Titles of articles in Willipedia are chosen to serve two crucial goals which are sometimes at odds.   
+
Effort is wasted when someone starts an article "Prank" when it really could have been added to (or already was in) "[[Pranks]]".  Using naming conventions lets us use content to its fullest extent, and build on what's there alreadyMuch of the below is adapted from [http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions Wikipedia's naming conventions].
#Titles create expectations, and therefore a title ought to accurately reflect the content that follows it.
+
 
#But, on Willipedia, titles are the names that articles are called by. Titles need to be succinctly named, or they will never be called by editors, will never be linked to, and will fall into obscurity.
+
===Singular vs. Plural nouns vs. Gerunds===
 +
<div style="float:top"><font size="-2">[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Prefer_singular_nouns ''Wikipedia origin'']</font></div>
 +
 
 +
'''Use a singular noun''' for articles that:
 +
* Explain or define a subject, e.g. [[crusty]]
 +
* Give the history of a subject, e.g. [[Mountain Day]]
 +
 
 +
'''Use a plural noun''' for articles that:
 +
* Provide a topical survey, e.g. [[restaurants]]
  
'''For an example,''' consider the old article, "How To Procrastinate."  This was the first title it had, and it did a good job of creating the expectation of a list of suggestions, which is indeed what the article was. But only editors who already knew such an article existed could link to it. Naive editors were unlikely to guess such a title. Eventually, it was renamed to [[Procrastinating]], a name with the advantage of still being decently descriptive, and far more likely to be linked to in the course of normal writing.
+
'''Use a gerund (-ing word)''' for articles that:
 +
* Explain how to do something, e.g. [[configuring an email client]]
 +
* List ''techniques'' for achieving particular goal, e.g. [[procrastinating]], [[skiing cheaply]]
  
The short set of naming conventions below arises from this need for a minimal set of conventions for editors to learn so we know how to best name our new articles, and how to link to where an article is ''or will be'' as we write body text.
+
Often you'll want to redirect from the other possible article names. For example, "beer" and "beers" should probably go to the same article, but make the appropriate choice for the primary article ([[beers]]). See [[#Redirects|Redirects]] for more information.
  
==General Guide to Naming==
+
===Sentence-style capitalization===
Use the most general title you can about your subject, when you feel a Williamsian can write something meaningul about the general title (ie, even if you can't)
+
<div style="float:top"><font size="-2">[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Lowercase_second_and_subsequent_words ''Wikipedia origin'']</font></div>
::example: you want to write about the awesome beec in the forest garden for tree climbing.  start/edit "Tree climbing"
 
::example: you want to write about cheap places to ski.  start/edit "skiing" and start a section in it on going cheaply.  hope you or someone else will write the preface on generally skiing at williams
 
::example: you want to write about great spots to hang hammocks on campus. "Hammocking" is the most general title, but is there something meaningful to write on "hammocking" besids where to do it?  This is arguable. Start/edit "hammocking" with a section on places, or start/edit "hammock spots".  Someone can always create "hammocking" and link to/move your content later.
 
  
'''Singular vs. Plural nouns'''
+
Even though the title of something, like an encyclopedia article, typically has all words capitalized, Willipedia is differentCapitalize article and section titles as though you were writing a sentence: the first word is capitalized, and all other words are lowercase unless they are proper nouns.
:[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Prefer_singular_nouns wiki link]
 
:willi rule of thumb:  when the main focus of an article will be to define or give the history of the subject, use a singular noun (broomball, Mountain Day)when listing and explaining instances of the subject -- especially when ''defining'' what the title means would be silly for willipedia -- use a plural (Pranks, Classes).
 
  
Use '''-ing Verbs'''
+
===Naming students and alums===
:[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Use_gerund_of_verbs wiki link]
 
:for activities, common practices, and the like, try to use the most basic but most unique gerund verb applicable.  Instead of "Great places to ski" use "Skiing" and, after talking generally a little about skiing at williams, have a section on "places" if you wish.
 
:When what would otherwise be a section gets large and detailed/complex enough to be its own article (Skiing cheaply) use the shortest descriptive title you can (Skiing cheaply vs. Ways you can ski cheaply) and be sure to link to this article in a (perhaps empty) section of the main article.
 
  
'''sentence-style capitalization'''
+
Even though it is convention in most Williams publications to include the class year whenever a student or alum is named, on Willipedia, the class year should usually not be part of the title of a page on a person (''ie'', "Joe Freshman" is preferred to "Joe Freshman '09"). This is for ease of linking: in this system, an editor who wishes to link to a person need only know his/her nameIf class years were in titles, one would need to know name ''and'' graduation year to link. You can still, of course, include the class year in your prose, e.g. "<nowiki>[[Joe Freshman]]</nowiki> '09".
:[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Lowercase_second_and_subsequent_words wiki link]
 
:even though the title of something, like an encyclopedia article, typically has all words campitalized, Willipedia is differentcapitalize your title as though you were writing a sentence
 
::the first word in the title is capitalized (the program will force this)
 
::all other words are lowercase, unless they are proper nouns
 
  
'''names of students and alums'''
+
===Use full names to be unambiguous===
 +
<div style="float:top"><font size="-2">[http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Be_precise_when_necessary ''Wikipedia origin'']</font></div>
 +
Another common issue for Willipedia is that we have a lot of things named after people (namely, [[:Category:Building|buildings]]).  This creates a need to resolve ambiguity about whether "Hopkins" is an article about [[Hopkins Hall]], [[Mark Hopkins House]], or [[Mark Hopkins]] the person.
  
'''use full name of a place to be unambiguous'''
+
The solution in most cases is to use the full name of something, even if it is rare in common parlance.  So while it is typical to say, "I'm eating at Mission," the article on this would have to be "[[Mission Dining Hall]]".  Notice that all words in this title are capitalized, as it is the proper name of the place.
:ex: Dodd Dining Hall, Hopkins Hall, Mark Hopkins House (notice all these words in these are capitalized, as they are all proper names)
 
:if you're feeling very helpful, create a disambig page at the name that forks to many related pages. ie, "Dodd"
 
  
http://en.wikipedia.org/wiki/Wikipedia:Naming_conventions#Be_precise_when_necessary
+
If you're feeling very helpful, create a [[#Disambiguation pages|disambiguation page]] at the common name that forks to many related pages. The [[Spencer]] and [[Dodd]] pages are examples of these.

Latest revision as of 16:08, May 11, 2006

Titles of articles in Willipedia are chosen to serve two crucial goals which are sometimes at odds.

  1. Titles create expectations, and therefore a title ought to accurately reflect the content that follows it.
  2. But, on Willipedia, titles are the names that articles are called by. If titles are not succinct, they will never be linked to, and will fall into obscurity.

For an example, consider the old article, "How To Procrastinate." This was the first title it had, and it did a good job of creating the expectation of a list of suggestions, which is indeed what the article was. But suppose that someone who doesn't know about this article is writing a related article; his prose is much more likely to contain (and so more likely to link to) the word "procrastination" or "procrastinating" than the full phrase "how to procrastinate." Thus the article is currently called procrastinating.

The set of naming conventions below arises from this need for a minimal set of rules for editors to learn so we know how to best name our new articles, and how to link to existing content (or future content) as we write body text.

General guideline

If you want to write an article on something rather specific, make sure that it is accessible from related, more general topics. You can do this in one of two ways:

  • Link to your specific article from the more general article
  • Include the content of your would-be article in the more general article

Often this means you'll need to create a perfunctory article or introduction for the more general topic, but the benefit is that people who search for the general topic will also be able to find your article.

Illustrative examples:

Problem: You want to write about how awesome the beech in the Forest Garden is for tree-climbing.

A good start: Even though you just want to write about that one tree, start/edit the article "Tree climbing," and place what you write in a section of it. If you want to do a really good job, go the extra mile to start a preface on the general title to help other editors get an idea of where they can work from.
In the future: Even without a preface, it's a very good bet that others will expand on this subject, with more trees and perhaps a guide to history and technique of the pasttime.

Problem: You want to give advice on procrastinating on a thesis. You're thinking "How to procrastinate on a thesis" might be a good title.

A good start: Think about your topic in the general sense. You are talking about two things: the practice of procrastinating and the topic "thesis." Start/edit an article with either name, and include what you want to write in a well-named section, even if it is a lonely section at first.
In the future: Others are likely to have something to say about "Procrastinating" or "Thesis". The articles are likely to cross-link. Over time, what you started will evolve into a rich article.

Tools

Willipedia depends on things being where people expect them to be. The MediaWiki software contains a few key tools that make this easy to do, and you can help Willipedia out a lot by learning them.

Redirects

A redirect page is a page whose only function is to send anyone visiting that page to a page by a different name. Redirects are incredibly important, and everyone should learn how to make one.

Using a redirect, a link to Bethans will go to Elizabethans. The former is a common colloquial form likely to crop up in articles, but the latter is the only reasonable title for the article. To prevent editors from accidentally writing two pages about the same thing, redirects are crucial.

Making a redirect. Let's say we want to make "WUFO" point to "Williams Ultimate Frisbee Organization". Start a new page having the name that you want to become a redirect -- in this case, WUFO. Make its content

#redirect [[REDIRECT_TARGET]]

where [[REDIRECT_TARGET]] is the name of the article you want to go to -- in this case, "Williams Ultimate Frisbee Organization".

Make redirects often. Any time you think of a term that people often use to name something else, and that term only names that one thing, make the page a redirect. WUFO can only refer to the frisbee club, so it's a great redirect. Furthermore, any time you were deciding between a few choices for a new article title (class or classes? skiing or alpine skiing?) it's usually a great idea to make the title you didn't use a redirect to the one you did use.

Sometimes, though, a word has more than one meaning. "Hopkins," unfortunately, is both the administrative hall and the dormitory. The page Hopkins, then, needs to be a disambiguation page.

Disambiguation pages

A disambiguation page is a page whose sole function is to provide access to the two or more meanings that one word or phrase has, such as Spencer and Weston. The page content can be anything that helps readers find their way to the right place, so long as the page has a link to every reasonable interpretation. It also should begin with the code {{disambig}}. This tags the page as a disambiguation page.

Renaming (moving) a page

To rename a page so that its title conforms to these guidelines, move it using the "Move this page" link at the bottom of the screen. When you move a page, the program automatically creates a redirect at the old location that points to the new location.

It is not a big deal, but it is good form, when you move a page, to fix all the links in Willipedia that pointed to the old name. If you move a young page, this is often a short job, and a nice thing to do. If you move an old page, it can have dozens of links to it, making this job very annoying. No one will fault you for not wanting to go and do all that work yourself, but consider leaving a message for the Willipedia board letting us know we ought to look into it.

Conventions

Effort is wasted when someone starts an article "Prank" when it really could have been added to (or already was in) "Pranks". Using naming conventions lets us use content to its fullest extent, and build on what's there already. Much of the below is adapted from Wikipedia's naming conventions.

Singular vs. Plural nouns vs. Gerunds

Use a singular noun for articles that:

Use a plural noun for articles that:

Use a gerund (-ing word) for articles that:

Often you'll want to redirect from the other possible article names. For example, "beer" and "beers" should probably go to the same article, but make the appropriate choice for the primary article (beers). See Redirects for more information.

Sentence-style capitalization

Even though the title of something, like an encyclopedia article, typically has all words capitalized, Willipedia is different. Capitalize article and section titles as though you were writing a sentence: the first word is capitalized, and all other words are lowercase unless they are proper nouns.

Naming students and alums

Even though it is convention in most Williams publications to include the class year whenever a student or alum is named, on Willipedia, the class year should usually not be part of the title of a page on a person (ie, "Joe Freshman" is preferred to "Joe Freshman '09"). This is for ease of linking: in this system, an editor who wishes to link to a person need only know his/her name. If class years were in titles, one would need to know name and graduation year to link. You can still, of course, include the class year in your prose, e.g. "[[Joe Freshman]] '09".

Use full names to be unambiguous

Another common issue for Willipedia is that we have a lot of things named after people (namely, buildings). This creates a need to resolve ambiguity about whether "Hopkins" is an article about Hopkins Hall, Mark Hopkins House, or Mark Hopkins the person.

The solution in most cases is to use the full name of something, even if it is rare in common parlance. So while it is typical to say, "I'm eating at Mission," the article on this would have to be "Mission Dining Hall". Notice that all words in this title are capitalized, as it is the proper name of the place.

If you're feeling very helpful, create a disambiguation page at the common name that forks to many related pages. The Spencer and Dodd pages are examples of these.