Difference between revisions of "Help:Style Guide"

From Lesswrongwiki
Jump to: navigation, search
(moved a section about References template from Wiki_Etiquette, since it's more appropriate here)
Line 1: Line 1:
The following is copied from http://lesswrong.com/lw/98/what_isnt_the_wiki_for/63t , by [[Peer Infinity]]
+
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.
  
I'm considering starting a style guide. I'll try to reflect current usage as best I can. Does anyone have any suggestions? Eliezer, I'm looking to you specifically as you have written the most.
+
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.
  
Some points of style off the top of my head:
+
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.
  
* Less Wrong and Overcoming Bias are each two words.
+
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).
* Per ciphergoth's suggestion, we are sticking to the Wikipedia convention that article title should be all in lowercase, except for the initial letter and proper names. In the article body, should we do the same or use EY's more liberal cap style?
 
* I'm half seriously considering to only cite OB/LW authors if they are not EY
 
* Article references should be based on the References template. When creating an article, add <nowiki>{{subst:References}}</nowiki> to the bottom, save the article, and then fill in as needed.
 
  
--badger, aka [[User:BJR]]
+
==Redirect policy==
  
According to this style guide, Less Wrong is supposed to be two words, but this wiki's title is "LessWrong Wiki"Is it too late to change this wiki's title? --[[Peer Infinity]]
+
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 capitalizationThis 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.
  
 
== Template:References ==
 
== Template:References ==
Line 26: Line 23:
 
* '''Other References''' (everything else)
 
* '''Other References''' (everything else)
  
The footnotes section should use the <nowiki><references/></nowiki> tag. Everything else should be formatted as a list. [[User:BJR|BJR]] 20:51, 7 April 2009 (UTC)
+
The footnotes section should use the <nowiki><references/></nowiki> tag. Everything else should be formatted as a list.
 
 
== Template:Article ==
 
 
 
I created a quick and dirty [[Template:Article|template for articless]] so we can start getting stubs generated for older OB and LW articles but make it easier to retrofit when we get a proper infobox set up for off-wiki posts/articles.  I assumed we would want the following parameters:
 
 
 
# Article name
 
# Author
 
# Original site
 
# Date posted
 
# Permanent link
 
 
 
This is the time to talk about it before I start using the template.  [[User:MrHen|MrHen]] 16:38, 23 April 2009 (UTC)
 

Revision as of 05:16, 8 May 2009

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).

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.

Template:References

To standardize the references section, I've created a References template. To use it in a page, type {{subst:References}} 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.

The template currently uses the following format.

  • See Also (for other relevant LWiki articles)
  • 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 <references/> tag. Everything else should be formatted as a list.