Difference between revisions of "Help:Style Guide"

From Lesswrongwiki
Jump to: navigation, search
Line 1: Line 1:
See also [[Help:User Guide]]
+
==Motivation==
  
----
+
[[Ciphergoth]] originally created a Less Wrong wiki on Wikia [http://lesswrong.com/lw/93/rationalist_wiki_redux/ with the intention of making Less Wrong less impenetrable to newcomers] - a highly important goal.
 
 
Ciphergoth originally created a Less Wrong wiki on Wikia [http://lesswrong.com/lw/93/rationalist_wiki_redux/ with the intention of making Less Wrong less impenetrable to newcomers] - a highly important goal.
 
  
 
A wiki can do this in two major ways - by providing fast summaries of unfamiliar concepts, and by indexing the original content and long arguments put forth on the blog.
 
A wiki can do this in two major ways - by providing fast summaries of unfamiliar concepts, and by indexing the original content and long arguments put forth on the blog.
Line 9: Line 7:
 
Ciphergoth also suggested that [http://lesswrong.com/lw/98/what_isnt_the_wiki_for/ the Less Wrong wiki should not duplicate work that is being done better elsewhere] - if Wikipedia has a better, longer article on something, then we should either (a) link to Wikipedia, or (b), if there is a little bit of special LW content on the subject, have a Less Wrong wiki page with a major reference to Wikipedia, a quick summary of the concept, and some minor references to the special content at LW.
 
Ciphergoth also suggested that [http://lesswrong.com/lw/98/what_isnt_the_wiki_for/ the Less Wrong wiki should not duplicate work that is being done better elsewhere] - if Wikipedia has a better, longer article on something, then we should either (a) link to Wikipedia, or (b), if there is a little bit of special LW content on the subject, have a Less Wrong wiki page with a major reference to Wikipedia, a quick summary of the concept, and some minor references to the special content at LW.
  
Eliezer Yudkowsky suggested that [http://lesswrong.com/lw/cg/proposal_use_the_wiki_for_concepts/ the wiki should be used to summarize concepts and link to blog posts, and should not contain original content] (except in special cases where an original work is more easily produced by collaborative multi-user editing, than by threaded discussion in the blog).  The intended user experience is to [http://lesswrong.com/lw/cg/proposal_use_the_wiki_for_concepts/ bounce back and forth between the blog and the wiki] - the blog links mainly to the wiki when referencing concepts, and the wiki summarizes the concepts and lists the relevant blog posts (with brief descriptions).
+
[[Eliezer Yudkowsky]] suggested that [http://lesswrong.com/lw/cg/proposal_use_the_wiki_for_concepts/ the wiki should be used to summarize concepts and link to blog posts, and should not contain original content] (except in special cases where an original work is more easily produced by collaborative multi-user editing, than by threaded discussion in the blog).  The intended user experience is to [http://lesswrong.com/lw/cg/proposal_use_the_wiki_for_concepts/ bounce back and forth between the blog and the wiki] - the blog links mainly to the wiki when referencing concepts, and the wiki summarizes the concepts and lists the relevant blog posts (with brief descriptions).
  
 
==Formatting==
 
==Formatting==
  
* Use [[Template:Quote]] for quotations.
+
*Use [[Template:Quote]] for quotations.
 +
*Use [[Template:cite journal]] for citations.
 +
*Article names and section names are written in lower case (first word in upper case).
  
 
===Redirect policy===
 
===Redirect policy===
  
Since there is no way to disable MediaWiki's case-sensitivity, if you accidentally get the capitalization wrong when trying to link to another wiki page, the link will not lead to the page you wanted to link to, but will instead link to a page with different capitalization. This same issue also applies to spacing and hyphenation in the article's title. For example, [[Paper clip maximizer]] versus [[Paperclip maximizer]]. Whenever a link is created with incorrect capitalization, just make a redirect page that links to the correctly capitalized page.
+
Since there is no way to disable MediaWiki's case-sensitivity, if you accidentally get the capitalization wrong when trying to link to another wiki page, the link will not lead to the page you wanted to link to, but will instead link to a page with different capitalization. This same issue also applies to spacing and hyphenation in the article's title. For example, [[Paper clip maximizer]] versus [[Paperclip maximizer]]. When it's convenient to use a link with incorrect capitalization, make a redirect page that links to the correctly capitalized page.
  
===Template:References===
+
===Article structure===
  
To standardize the references section, I've created a References template. To use it in a page, type <code>{{t|subst:References}}</code> after the main body of the article. After the page is saved, code will be inserted that can be filled in with references as necessary.
+
A typical article is short, and contains only a few references. If an article starts to encompass too many blog posts, it should be split into more narrowly-themed articles, to simplify navigation. The reference sections are formatted according to the following example, with unnecessary sections removed and example references substituted by action references. Alternatively, you can use [[:Template:References]].
  
The template currently uses the following format.
+
==See Also==
 +
<nowiki>*[[Bayesian]]</nowiki>
 +
 +
==Footnotes==
 +
<nowiki><references/></nowiki>
 +
 +
==Blog posts==
 +
<nowiki>*[http://www.overcomingbias.com/2007/10/curiosity.html</nowiki>
 +
<nowiki>The Meditation on Curiousity] by [[Eliezer Yudkowsky]]</nowiki>
 +
 +
==External references==
  
* '''See Also''' (for other relevant LWiki articles)
+
The footnotes section should use the <nowiki><references/></nowiki> tag, with footnotes included in the article inside the <nowiki><ref></ref></nowiki> rags. Everything else should be formatted as a list.
* '''Footnotes''' (for references cited in the text)
 
* '''Overcoming Bias Articles''' (links to OB articles in the format of ''Title'' by ''Author'')
 
* '''Less Wrong Articles''' (links to LW articles in the format of ''Title'' by ''Author'')
 
* '''Other References''' (everything else)
 
  
The footnotes section should use the <nowiki><references/></nowiki> tag. Everything else should be formatted as a list.
+
==See also==
 +
*[[Help:User Guide]]
  
 
[[Category:Help]]
 
[[Category:Help]]

Revision as of 07:30, 26 May 2009

Motivation

Ciphergoth originally created a Less Wrong wiki on Wikia with the intention of making Less Wrong less impenetrable to newcomers - a highly important goal.

A wiki can do this in two major ways - by providing fast summaries of unfamiliar concepts, and by indexing the original content and long arguments put forth on the blog.

Ciphergoth also suggested that the Less Wrong wiki should not duplicate work that is being done better elsewhere - if Wikipedia has a better, longer article on something, then we should either (a) link to Wikipedia, or (b), if there is a little bit of special LW content on the subject, have a Less Wrong wiki page with a major reference to Wikipedia, a quick summary of the concept, and some minor references to the special content at LW.

Eliezer Yudkowsky suggested that the wiki should be used to summarize concepts and link to blog posts, and should not contain original content (except in special cases where an original work is more easily produced by collaborative multi-user editing, than by threaded discussion in the blog). The intended user experience is to bounce back and forth between the blog and the wiki - the blog links mainly to the wiki when referencing concepts, and the wiki summarizes the concepts and lists the relevant blog posts (with brief descriptions).

Formatting

Redirect policy

Since there is no way to disable MediaWiki's case-sensitivity, if you accidentally get the capitalization wrong when trying to link to another wiki page, the link will not lead to the page you wanted to link to, but will instead link to a page with different capitalization. This same issue also applies to spacing and hyphenation in the article's title. For example, Paper clip maximizer versus Paperclip maximizer. When it's convenient to use a link with incorrect capitalization, make a redirect page that links to the correctly capitalized page.

Article structure

A typical article is short, and contains only a few references. If an article starts to encompass too many blog posts, it should be split into more narrowly-themed articles, to simplify navigation. The reference sections are formatted according to the following example, with unnecessary sections removed and example references substituted by action references. Alternatively, you can use Template:References.

==See Also==
*[[Bayesian]]

==Footnotes==
<references/>

==Blog posts==
*[http://www.overcomingbias.com/2007/10/curiosity.html
The Meditation on Curiousity] by [[Eliezer Yudkowsky]]

==External references==

The footnotes section should use the <references/> tag, with footnotes included in the article inside the <ref></ref> rags. Everything else should be formatted as a list.

See also