Help Wikitravel grow by contributing to an article! Learn how.
New users, please see Help or go to the Pub to ask questions.

Difference between revisions of "Wikitravel:Manual of style"

From Wikitravel
Jump to: navigation, search
(Writing style)
(changes concomitant on re-naming)
(44 intermediate revisions by 25 users not shown)
Line 1: Line 1:
Our '''Manual of style''' is a collection of rules of thumb and guidelines for giving Wikitravel a consistent look and feel. Most of these rules have exceptions, but to put together a good reference work collaboratively, it's best to follow the rules unless they're quite inappropriate for a particular situation.
+
Our '''Manual of Style''' is a collection of rules-of-thumb and guidelines for giving Wikitravel a consistent look and feel. Most of these rules have exceptions, but to put together a good reference work collaboratively, it's best to follow the rules unless they're quite inappropriate for a particular situation.
  
The Manual is broken up into different pages so that this one doesn't get overloaded with extraneous text. It makes it easier to find and update individual rules or concepts if they're on their own pages. Finally, it's easier for smarty-pantses to link to the particular rule being broken from [[Wikitravel:using talk pages|talk pages]] for articles.
+
The manual is broken up into different pages so that this one doesn't get overloaded with extraneous text. It makes it easier to find and update individual rules or concepts if they're on their own pages. Finally, it's easier for smarty-pantses to link to the particular rule being broken from [[Wikitravel:using discussion pages|discussion pages]] for articles.
  
 
If all this stuff makes your head swim, and you don't want to bother with it, by all means [[Wikitravel:plunge forward|plunge forward]] and just start sharing your knowledge. Other [[Wikitravel:Wikitravellers|Wikitravellers]] will come through and bring your contributions more in line with the style guide.
 
If all this stuff makes your head swim, and you don't want to bother with it, by all means [[Wikitravel:plunge forward|plunge forward]] and just start sharing your knowledge. Other [[Wikitravel:Wikitravellers|Wikitravellers]] will come through and bring your contributions more in line with the style guide.
  
If you have a question about the specifics of the Manual, or want to see it changed/amended/clarified, use the [[Wikitravel:using talk pages|talk page]] for the section in question. A list of issues currently being discussed can be found [[Wikitravel:Open issues|here]].
+
If you have a question about the specifics of the manual, or want to see it changed/amended/clarified, use the [[Wikitravel:using discussion pages|discussion page]] for the section in question. A list of issues currently being discussed can be found [[Wikitravel:Requests for comment|here]].
  
 
==Structural style==
 
==Structural style==
  
This section of the Manual is for rules about the structure of '''Wikitravel as a whole'''.
+
This section of the manual is for rules about the structure of '''Wikitravel as a whole'''.
  
*[[Wikitravel:What is an article?|What is an article?]] - how and when to start new articles
+
* [[Wikitravel:Main Page guidelines|Main Page guidelines]] – how to add links to the [[Main Page]]
*[[Wikitravel:Other ways of seeing travel|Other ways of seeing travel]] -- approaching travel from different angles
+
* [[Wikitravel:What is an article?|What is an article?]] how and when to start new articles
*[[Wikitravel:Geographical hierarchy|Geographical hierarchy]] - how we divide up the world
+
* [[Wikitravel:Other ways of seeing travel|Other ways of seeing travel]] approaching travel from different angles
*[[Wikitravel:Article naming conventions|Article naming conventions]] - how to name an article
+
* [[Wikitravel:Geographical hierarchy|Geographical hierarchy]] how we divide up the world
*[[Wikitravel:Where you can stick it|Where you can stick it]] -- finding a place to share your knowledge
+
* [[Wikitravel:Naming conventions|Article naming conventions]] how to name an article
*[[Wikitravel:Bodies of water|Bodies of water]] -- how lakes, rivers, seas and oceans fit into Wikitravel
+
* [[Wikitravel:Disambiguation pages|Disambiguation pages]] – when to make them and how to use them
*[[Wikitravel:Categories|Categories]] -- using the MediaWiki categories feature
+
* [[Wikitravel:Bodies of water|Bodies of water]] how lakes, rivers, seas and oceans fit into Wikitravel
*[[Wikitravel:Using Mediawiki templates|Using Mediawiki templates]] -- using the MediaWiki Template: transclusion feature
+
* [[Wikitravel:Categories|Categories]] using the MediaWiki categories feature
 +
* [[Wikitravel:Using Mediawiki templates|Using Mediawiki templates]] using the MediaWiki Template: transclusion feature
 +
* [[Wikitravel:Template index|Mediawiki template index]] – a list of available Mediawiki templates
  
 
==Formatting style==
 
==Formatting style==
  
These rules are about '''laying out individual articles'''. That is, they describe how we take raw information and put it in a format that's easily usable by travelers.
+
These rules are about '''laying out individual articles'''. That is, they describe how we take raw information and put it in a format that's easily usable by travellers.
  
*[[Wikitravel:Article templates|Article templates]] -- starting points and formatting guidelines for consistent Wikitravel articles
+
===Article layout===
*[[Wikitravel:Attraction listings|Attraction listings]] -- things to '''See''' or '''Do'''
+
* [[Wikitravel:Article templates|Article templates]] – consistent articles.  Standard sections and formatting.
*[[Wikitravel:Restaurant listings|Restaurant listings]] -- for the '''Eat''' section of articles
+
* [[Wikitravel:Where you can stick it|Where you can stick it]] – finding a place to share your knowledge
*[[Wikitravel:Bar listings|Bar listings]] -- for the '''Drink''' section of articles
+
* [[Wikitravel:Information for gay and lesbian travellers|Information for gay and lesbian travellers]] – where to put GLBT info in a destination article
*[[Wikitravel:Accommodation listings|Accommodation listings]] -- for the '''Sleep''' section of articles
+
 
*[[Wikitravel:Internal links|Internal links]] -- linking to other articles in Wikitravel
+
===Formatting content===
*[[Wikitravel:Inter-language links|Inter-language links]] -- linking to other [[Wikitravel:language versions of Wikitravel|language versions]]
+
* [[Wikitravel:Section headers|Section headers]] – formatting guidelines for the section headers
*[[Wikitravel:External links|External links]] -- linking to other Web sites
+
* [[Wikitravel:Avoid HTML|Avoid HTML]] – avoiding HTML formatting
*[[Wikitravel:Section headers|Section headers]] -- dividing an article into sections
+
* [[Wikitravel:Information boxes|Information boxes]] – when, how and when not to use information boxes
*[[Wikitravel:Avoid HTML|Avoid HTML]] -- avoiding HTML formatting
+
* [[Wikitravel:Geocoding|Geocoding]] – adding latitude and longitude to destination articles
*[[Wikitravel:Information for gay and lesbian travellers|Information for gay and lesbian travellers]] -- where to put GLBT info in a destination article
+
* [[Wikitravel:Wiki markup|Wiki markup]] – How to use the special Mediawiki markup to present information
*[[Wikitravel:Main Page guidelines|Main Page guidelines]] -- how to add links to the [[Main Page]]
+
 
*[[Wikitravel:Disambiguation pages|Disambiguation pages]] -- when to make them and how to use them
+
===Links===
 +
* [[Wikitravel:Internal links|Internal links]] linking to other articles in Wikitravel
 +
* [[Wikitravel:External links|External links]] – how and when to link to other Web sites
 +
* [[Wikitravel:Inter-language links|Inter-language links]] linking to other [[Wikitravel:language versions of Wikitravel|language versions]]
 +
* [[Wikitravel:Links to Wikipedia|Links to Wikipedia]] – how to make links to Wikipedia articles
 +
* [[Wikitravel:links to Open Directory|Links to Open Directory]] – how to make twin-pages links to Open Directory topics
 +
 
 +
===[[Wikitravel:Listings|Listings]]===
 +
* [[Wikitravel:Accommodation listings|Accommodation listings]] – for the '''Sleep''' section of articles
 +
* [[Wikitravel:Activity listings|Activity listings]] – things to '''Do'''
 +
* [[Wikitravel:Attraction listings|Attraction listings]] – things to '''See'''
 +
* [[Wikitravel:Bar listings|Bar listings]] – for the '''Drink''' section of articles
 +
* [[Wikitravel:Restaurant listings|Restaurant listings]] – for the '''Eat''' section of articles
 +
* [[Wikitravel:One-liner listings|One-liner listings]] – for '''Regions''', '''Districts''', '''Cities''', and '''Get out''' sections, and in other sections as appropriate
  
 
==Writing style==
 
==Writing style==
Line 42: Line 57:
 
This set of rules describes how to write '''words, sentences, and paragraphs'''.  
 
This set of rules describes how to write '''words, sentences, and paragraphs'''.  
  
*[[Wikitravel:Avoid negative reviews|Avoid negative reviews]] -- Don't bother listing places not worth going to
+
* [[Wikitravel:Tone|Tone]] – the right tone for your prose
*[[Wikitravel:Currency|Currency]] -- proper method of displaying currency
+
* [[Wikitravel:Don't tout|Don't tout]] – describe, don't push
*[[Wikitravel:Don't overlink|Don't overlink]] -- When to make links in article text
+
* [[Wikitravel:Spelling|Spelling]] – what spelling rules to use
*[[Wikitravel:First person pronouns|First person pronouns]] -- avoid using "I", "we", and their ilk
+
* [[Wikitravel:Abbreviations|Abbreviations]] – when to abbreviate words
*[[Wikitravel:Foreign words|Foreign words]] -- Using non-English words and names in articles
+
* [[Wikitravel:Neutrality of medium|Neutrality of medium]] – referring to the medium the article is in
*[[Wikitravel:Links to Wikipedia|Links to Wikipedia]] -- How to make links to Wikipedia articles
+
* [[Wikitravel:First person pronouns|First person pronouns]] avoid using "I", "we", and their ilk
*[[Wikitravel:Links to Open Directory|Links to Open Directory]] -- How to make twin-pages links to Open Directory topics
+
* [[Wikitravel:Second person pronouns|Second person pronouns]] – using "you" and friends is okay
*[[Wikitravel:Measurements|Measurements]] -- formatting lengths, weights, temperatures, etc.
+
* [[Wikitravel:Words to avoid|Words to avoid]] – some words and phrases to avoid in articles
*[[Wikitravel:Neutrality of medium|Neutrality of medium]] -- referring to the medium the article is in
+
* [[Wikitravel:Foreign words|Foreign words]] – using non-English words and names in articles
*[[Wikitravel:Phone numbers|Phone numbers]] -- including and formatting phone numbers
+
* [[Wikitravel:Romanization|Romanization]] – for languages that do not use the Latin alphabet
*[[Wikitravel:Romanization|Romanization]] -- for languages that do not use the Latin alphabet
+
* [[Wikitravel:Don't overlink|Don't overlink]] – when to make links in article text
*[[Wikitravel:Second person pronouns|Second person pronouns]] -- using "you" and friends is ok
+
* [[Wikitravel:Use boldface to call out important topics|Use boldface to call out important topics]] – using boldface for theme words
*[[Wikitravel:Spelling|Spelling]] -- what spelling rules to use for Wikitravel
+
* [[Wikitravel:Use italics for emphasis|Use italics for emphasis]] – putting stress on certain words and phrases
*[[Wikitravel:Time and date formats|Time and date formats]]
+
* [[Wikitravel:Avoid negative reviews|Avoid negative reviews]] – don't bother listing places not worth going to
*[[Wikitravel:Tone|Tone]] -- the right tone for your prose
+
* [[Wikitravel:No advice from Captain Obvious|No advice from Captain Obvious]] – if it's obvious or universally true, there's no point in adding it
*[[Wikitravel:Trademarks|Trademarks]] -- using trademarks
+
* [[Wikitravel:Measurements|Measurements]] – formatting lengths, weights, temperatures, etc.
*[[Wikitravel:Use boldface to call out important topics|Use boldface to call out important topics]] -- Using boldface for theme words
+
* [[Wikitravel:Currency|Currency]] – proper method of displaying currency
*[[Wikitravel:Use italics for emphasis|Use italics for emphasis]] -- Putting stress on certain words and phrases
+
* [[Wikitravel:Time and date formats|Time and date formats]]
 +
* [[Wikitravel:When to use dates|When to use dates]]
 +
* [[Wikitravel:Phone numbers|Phone numbers]] – including and formatting phone numbers
 +
* [[Wikitravel:Trademarks|Trademarks]] – using trademarks
  
 
==See also==
 
==See also==
* [[Wikitravel:Help|Help]] — for technical help with Wiki syntax
 
* [[Wikitravel:Community policies|Community policies]] — for Wikitravel's collaboration policies
 
* [[Wikitravel:Namespace index]] — All the "meta" articles in the Wikitravel: namespace
 
  
 +
* [[Wikitravel:Help|Help]] – for technical help with Wiki syntax
 +
* [[Wikitravel:Community policies|Community policies]] – for Wikitravel's collaboration policies
 +
* [[Wikitravel:Namespace index]] – all the "meta" articles in the Wikitravel: namespace
 +
* [[Wikitravel:Using discussion pages|Using discussion pages]]
 +
* [[Wikitravel:Manual of style for the US]]
 +
 +
 +
{{WikitravelDoc|policies}}
 +
 +
 +
[[ca:Wikitravel:Manual d'estil]]
 
[[de:Wikitravel:Stilhandbuch]]
 
[[de:Wikitravel:Stilhandbuch]]
 +
[[es:Wikitravel:Manual de estilo]]
 +
[[fi:Wikitravel:Tyyliopas]]
 
[[fr:Wikitravel:Manuel de style]]
 
[[fr:Wikitravel:Manuel de style]]
 +
[[it:Wikitravel:Manuale di stile]]
 
[[ja:Wikitravel:スタイルマニュアル]]
 
[[ja:Wikitravel:スタイルマニュアル]]
 +
[[nl:Wikitravel:Stijlhandboek]]
 
[[pt:Wikitravel:Manual de estilo]]
 
[[pt:Wikitravel:Manual de estilo]]
 +
[[ro:Wikitravel:Manual de stil]]
 +
[[ru:Wikitravel:Оформление статей]]
 +
[[sv:Wikitravel:Stilguide]]
 +
[[zh:Wikitravel:格式手冊]]

Revision as of 03:19, 2 March 2013

Our Manual of Style is a collection of rules-of-thumb and guidelines for giving Wikitravel a consistent look and feel. Most of these rules have exceptions, but to put together a good reference work collaboratively, it's best to follow the rules unless they're quite inappropriate for a particular situation.

The manual is broken up into different pages so that this one doesn't get overloaded with extraneous text. It makes it easier to find and update individual rules or concepts if they're on their own pages. Finally, it's easier for smarty-pantses to link to the particular rule being broken from discussion pages for articles.

If all this stuff makes your head swim, and you don't want to bother with it, by all means plunge forward and just start sharing your knowledge. Other Wikitravellers will come through and bring your contributions more in line with the style guide.

If you have a question about the specifics of the manual, or want to see it changed/amended/clarified, use the discussion page for the section in question. A list of issues currently being discussed can be found here.

Contents

Structural style

This section of the manual is for rules about the structure of Wikitravel as a whole.

Formatting style

These rules are about laying out individual articles. That is, they describe how we take raw information and put it in a format that's easily usable by travellers.

Article layout

Formatting content

  • Section headers – formatting guidelines for the section headers
  • Avoid HTML – avoiding HTML formatting
  • Information boxes – when, how and when not to use information boxes
  • Geocoding – adding latitude and longitude to destination articles
  • Wiki markup – How to use the special Mediawiki markup to present information

Links

Listings

Writing style

This set of rules describes how to write words, sentences, and paragraphs.

See also

Variants

Actions

Destination Docents

In other languages