LifeWiki:Style guide: Difference between revisions

From LifeWiki
Jump to navigation Jump to search
Line 64: Line 64:


==See also==
==See also==
* [[Help:Contents|Help contents]]: A listing of all the available help articles.
* '''[[Help:Contents|Help contents]]''': A listing of all the available help articles.
* [[Help:editing|Editing pages]]: General information on how to edit wiki pages.
* [[Help:editing|Editing pages]]: General information on how to edit wiki pages.
* [[Help:Formatting|Formatting]]: More detailed information on wiki formatting.
* [[Help:Images|Images]]: Creating and uploading images for the wiki.
* [[Help:Links|Links]]: Creating and using links between wiki pages.
* [[Help:Quick editing guide|Quick editing guide]]: A table of the most commonly used formatting commands.
* [[Help:Quick editing guide|Quick editing guide]]: A table of the most commonly used formatting commands.
* [[Help:Formatting|Formatting]]: More detailed information on wiki formatting.
* [[LifeWiki:Spelling|Spelling]]: Spelling rules for LifeWiki.
* [[LifeWiki:Spelling|Spelling]]: Spelling rules for LifeWiki.
* [[Help:Links|Links]]: Creating and using links between wiki pages.
 
==External links==
* [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Manual of style] on Wikipedia
* [http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style Manual of style] on Wikipedia

Revision as of 14:54, 6 February 2009

LifeWiki's style guide is designed to maintain consistency throughout the site. Since editors from all over the world can make modifications and additions to LifeWiki's articles, it is important for the project to have a uniform format and style. This article summarizes our recommended style guidelines that apply to all articles written on the site. Articles that follow these guidelines are more likely to be well-received by the rest of the community, and will require other editors to spend less time cleaning up the articles.

The style of talk pages is less formal than that used for articles. While most of these guidelines are still relevant to talk pages, there are several differences that are noted as appropriate below.

Content

The purpose of the LifeWiki is to provide encyclopedia-style content describing Conway's Game of Life. All articles should be informative and targeted at the site's audience. Information that is only of interest to the writer or to other editors should not be included in articles. The article's talk page is the place to discuss questions about the article's content or style.

Attribution and dates

Do not add any attributions (e.g., "written by Nathaniel") or dates (e.g., "written on Jan. 16, 2009") when editing an article; the wiki software already maintains an accurate record of all contributions via the history page. Duplicating the information within an article will only clutter the article, adding extraneous editorial information that is not of interest to readers and degrading the article's quality. If you are adding information to a page that comes from another source (e.g., moved from another LifeWiki page or based on comments by another person), you can provide the source with proper credit by using the "Edit Summary" field on the edit page.

This rule does not apply to talk pages. On talk pages you should use attribution to clarify the flow of discussion; simply typing ~~~~ after your message will automatically insert your name and a timestamp.

Redundancy

New information added to the wiki should not repeat or be redundant with other information already on the site. Adding content to the wiki is only useful if the content is organized and presented in a way that makes it easy for all readers to find the information. This means that generally a topic will have a single page (or a section of a page) where the topic is discussed in full detail. Other pages that discuss that topic should not try to repeat the details, but should instead provide a link to the page with the details. Only information that is directly relevant to a given page should be included on the page.

There are several reasons why redundancy should be avoided. First, if a topic is discussed in detail on multiple different pages, then a reader has to read all of those pages to be sure that he has read all the information. Especially on a wiki, where different editors add information at different times, multiple versions of the same information can not be efficiently maintained. Transclusions should be used instead of copying in cases where the same information needs to be shown on multiple pages. Second, adding extraneous details makes a page long and difficult to read. Only information of interest to almost all readers should be included: 90% of the readers should not have to wade through uninteresting information just so that 10% of readers can find the information.

Unknown information

It is acceptable to write an article even if you do not know all of the information necessary to complete the article. However, gaps in the article should not be filled in with with approximations or best guesses. It is better to have no information than to have inaccurate information because inaccuracies mislead readers and are hard to find and correct. Uncertain information, or points that need more followup, should be moved to the discussion page where other editors can add their knowledge.

Language

LifeWiki is written using International (British) English, in particular following grammar and spelling standards appropriate for printed text. Colloquialisms, slang and other informal or casual styles of writing are not acceptable. See spelling for more information.

Other guidelines include:

  • Numbers within blocks of text should generally be written out as words if they are three syllables or less (e.g. seventy-five instead of 75). The primary exception to this is statistics related to specific patterns, which should be written in numeral form rather than as words (e.g. 8 instead of eight). This is because it is easier to compare numbers at a glance when they are written in numeral form.
  • Quotation Marks should use the logical quotation style for punctuation. Therefore, punctuation (e.g., periods, commas, colons) should be placed outside of the quotation marks, unless specified otherwise in the source material. In other words, This is an "example".is the preferred style, not This is an "example." The purpose of this guideline is primarily to resolve potential disputes between editors. New contributions are not required to use logical quotations, and converting articles to logical quotations is a very low priority. The primary implication of this guideline is that logical-style quotations in articles should not be changed into traditional-style quotations.

No first or second person

One of the most common mistakes made by well-intentioned editors is to provide information using a first-person point of view. Content submitted to an article in first-person will often be deleted and moved to the article's talk page until someone can verify the information and rewrite it. Instead of first person descriptions, wiki contributions should exclusively use third person.

Format

Wiki formatting is used to improve the legibility of an article. Bulleted lists, numeric lists, bolding, italics, and coloring are all tools to help text "pop out" at the reader. When properly used, these tools help the reader to quickly scan a page for the key points, then focus on individual paragraphs of interest. For general guidelines on how to make articles legible, see "How Users Read on the Web" by Jakob Nielsen.

General information on how to implement wiki formatting is provided at formatting (or an overview at the quick editing guide).

Bold

  • Bolding should be used for headings, subheadings, and article names. This is done automatically when using the wiki heading format (e.g., ==heading==).
  • Bold the article name the first time it appears in the page's introductory sentence. Any alternative names in the introductory sentence should also be bolded. (e.g. "Boat-tie (or bi-boat) is a small still life...")
  • Bold the word or phrase being defined in bulleted or numeric lists.
  • Keywords for which readers are likely to be scanning may be in bold for emphasis, but this should be used sparingly.
  • Avoid using bold formatting for general emphasis.

Italics

  • Italics should be used for the titles of books and lengthy works.
  • Italics can be used for proper names (e.g., of places or items) to clarify that the phrase is a proper name.
  • Italics can be used for general emphasis, but should be used sparingly.

Emphasis

  • Avoid using ALL CAPS for emphasis.
  • Avoid using either single- or double-quotation marks for emphasis. (See Quotation Marks, Emphasis (incorrect usage).)
  • Avoid bolding words for general emphasis, unless giving crucial notice.
  • Avoid using double emphasis, such as combining bold and italics (e.g. an example of double emphasis).
  • Do not overemphasize, as each emphasis added will lessen the effect of other emphases and detract from the appearance of the article.

Cross links between wiki pages are important navigational tools, allowing the reader to easily follow up on interesting points and find more detailed information. However, it is possible to fill a page with too many links. More details on how to create links and guidelines on their usage are provided on the links help page.

Links to other articles should only be created when they are relevant to the content, and will be helpful and informative to the reader. Creating too many links can distract the reader and make the article hard to read; some readers are likely to pause on each link to determine whether the link is of interest. Be sure that any link you add will help readers and be used by readers. You should avoid creating duplicate links in an article. A link can be repeated if it last appeared in a previous section (since many readers will not read all sections of a page), but there is hardly ever a reason to link to the same article more than once in the same section.

Additionally, although it is encouraged to create "See also" sections for pages, links should only be added to that section if they do not appear elsewhere within the article.

Pattern pages

"LW:PATTERNS" and "LW:PP" redirect here.
This article contains outdated information. You can help LifeWiki by updating it.

Pattern pages are pages within LifeWiki that describe specific patterns of interest in Conway's Game of Life and related cellular automata.

Pattern templates

A pattern template should be included at the top of every single page describing a specific pattern. The available pattern templates are listed below. When none of the templates match the type of pattern that the page is about, the general pattern template should be used.

In addition to any of the template-specific parameters listed on those template pages (such as s for speed in Template:Spaceship), all pattern templates have access to the following parameters. If the value of a particular parameter is unknown to you or if you are not completely sure what a particular parameter does, it is best to omit it completely. To learn how to use these templates and parameters, it is likely best to view the source code of an existing pattern page by clicking on the "Edit" button at the top of it.

Parameter Description Example
name (required) The name of the pattern being described. name=17c/45 reaction
pname (required) The name of the pattern being described, but converted to lowercase and with all non-alphanumeric characters and spaces removed. pname=17c45reaction
discoverer (optional) The name of the person who first discovered the pattern. If the pattern was found by multiple people, each individual name should be passed to the discoverer2, discoverer3, discoverer4, or discoverer5 parameters. discoverer=David Bell
discoveryear (optional) The year in which the pattern was first discovered. discoveryear=1970
bx (optional) The width (x-dimension) of the pattern's bounding box. For oscillators, use the "all-phases" bounding box. [clarification needed for conduits] bx=8
by (optional) The height (y-dimension) of the pattern's bounding box. For oscillators, use the "all-phases" bounding box. [clarification needed for conduits] by=12
fc (optional) The frequency class of the pattern, rounded to one decimal digit. Not all pattern templates currently support this parameter. Per this tiki bar discussion, this is only recommended for objects which have appeared at least 10 times in asymmetric soups on Catagolue, as otherwise the sample size is too small to reliably calculate the frequency. fc=21.5
c (optional) The number of live cells in the pattern.[clarification needed for conduits] c=45
animated (optional) Whether or not there is an animated image available for the pattern. Not available for the Stilllife template. Omit this parameter if there is no such image. animated=true
mc (optional) Whether or not there is a Macrocell pattern file available for download for this pattern. See Pattern files. Omit this parameter if the file has not been uploaded. mc=true
plaintext (optional) Whether or not there is a plaintext pattern file available for download for this pattern. See Pattern files. Omit this parameter if the file has not been uploaded. plaintext=true
rle (optional) Whether or not there is a Run Length Encoded pattern file available for download for this pattern. See Pattern files. Omit this parameter if the file has not been uploaded. Also controls whether or not LifeViewer looks for the pattern in the RLE: namespace and provides an image or animation for the pattern. rle=true
zip (optional) Whether or not there is a .zip archive containing a pattern file (or multiple pattern files) available for download for this pattern. Omit this parameter if the file has not been uploaded. zip=true
nofile (optional) Whether or not pattern files have been purposely omitted and do not need to be added to the page (e.g., if the pattern file would be exceedingly large) nofile=true
synthesis (optional) The minimum known number of gliders with which the canonical version of the pattern can be constructed via glider synthesis. Enter synthesis=0 if it is known that the pattern can not be constructed in this way. Omit this parameter if it is unknown whether or not the pattern can be constructed via glider synthesis. synthesis=2
synthesis2 (optional) The minimum known number of gliders with which the pattern can be constructed via glider synthesis, including any variants with the same functionality. Enter synthesis=0 if it is known that the pattern can not be constructed in this way. Omit this parameter if there are no known syntheses which are cheaper than the canonical version. synthesis2=2
synthesisRLE (optional) Whether or not there is a Run Length Encoded pattern file available for the glider synthesis of the pattern. See Pattern files. Omit this parameter if the file has not been uploaded. Enter synthesisRLE=true if that pattern has been uploaded. synthesisRLE=true
rulemin (optional) The minimal rule (in "B/S" notation) under which the pattern will function as described. rulemin=B/S2
rulemax (optional) The maximal rule (in "B/S" notation) under which the pattern will function as described. rulemax=B35678/S23678
isorulemin (optional) The minimal isotropic non-totalistic rule (in "B/S" notation) under which the pattern will function as described. isorulemin=B3-a/S23
isorulemax (optional) The maximal isotropic non-totalistic rule (in "B/S" notation) under which the pattern will function as described. isorulemax=B3/S234ce
apgcode (optional) The apgcode representation of the canonical version of the pattern, used by apgsearch and Catagolue. apgcode=xs19_4aar0rbzx121
apgcode2 (optional) The apgcode representation of the version of the pattern with the lowest glider cost, if not the canonical version (i.e. the one referred to by the synthesis2 parameter). apgcode2=xs19_4aar0rbzx121
niemiecid (optional) The ID of the pattern in Mark Niemiec's glider synthesis database. niemiecid=19.11763
pentadecathlonid (optional) The ID of the pattern in Heinrich Koenig's Game of Life Object Catalogs. (archive link) pentadecathlonid=5P4H1V1.1
eppsteinid (optional) The numerical ID of the pattern in David Eppstein's spaceship database. (archive link) eppsteinid=115

Pattern files

Users of the LifeWiki are able to create and edit articles and upload and edit images on the LifeWiki as they see fit. One action that can only be performed by the site administrator or other LifeWiki moderators is uploading pattern files. These are the files in RLE and plaintext format that are downloadable from most pattern pages, as well as the macrocell, compressed RLE and macrocell, and .zip archive files available on some pattern pages) to the LifeWiki. The reason for this restriction is twofold. First, it is for security reasons as people download and execute those files on their hard drive so the last thing we want is someone uploading a virus or some such malicious thing. Second, the server that LifeWiki is run on simply doesn't like automatic uploads of files in strange file formats.

If you have found a pattern page that does not contain downloadable pattern files, check if its RLE:{pname} page exists (example: http://conwaylife.com/wiki/RLE:Glider):

  • If the page exists, it will most likely be picked up at some point by an automated script by Dvgrn, so no further action is needed
  • If the page does not exist, create it according to the RLE namespace patterns section below, and it will get picked up by the automated script
  • If you have further questions, check the "automated script" link above, or the "Pages with invalid RLE files" thread in the forums

Note that some patterns will not have all file types uploaded. For example, catacryst does not have a downloadable plaintext file, as it would be extremely large (and would likely lock up any program trying to read the file).

RLE namespace patterns

The auto-upload script will automatically add a leading #N comment line, giving the LifeWiki pname of the pattern, and also a line linking back to the relevant LifeWiki article. If the pattern in question is shown in an article infobox, then an #O line giving pattern discoverer and discover year will also be given. Other comment lines from the RLE namespace will simply be copied in below these header lines. The key point is that there's no need to include comments in the RLE namespace that will be duplicated by those automatically generated lines.

Example: creating an RLE-namespace article with the name RLE:r2d2, containing just the following text --

#C A period 8 oscillator.
x = 11, y = 10, rule = B3/S23
5bo5b$4bobo4b$3bobobo3b$3bobobo3b$2obo3bob2o$2obo3bob2o$3bo3bo3b$3bobo
bo3b$4bobo4b$5bo!

-- will be converted into the following by the auto-upload script:

#N R2D2
#O Peter Raynham
#C A period 8 oscillator.
#C http://www.conwaylife.com/wiki/index.php?title=R2D2
x = 11, y = 10, rule = B3/S23
5bo5b$4bobo4b$3bobobo3b$3bobobo3b$2obo3bob2o$2obo3bob2o$3bo3bo3b$3bobo
bo3b$4bobo4b$5bo!

The auto-upload script is currently run about once a month, or whenever someone remembers to do it.

User-created patterns

Although LifeWiki hopes to expand and catalogue everything there is to know about the Game of Life, users are generally discouraged from adding patterns that they themselves constructed, or names that they themselves invented for existing patterns, in order to avoid a potential conflict of interest. There are of course exceptions, such as when the constructed pattern is of clear notability.

Pattern pages: howto in a nutshell

  • Collect data and pics first. Make a checklist like the one below.
  • Decide on a name and pname that has not already been used (see above)
  • Use Golly to create standard RLE text. File > Save Extended RLE should not be checked.
  • Type in the LifeWiki search bar: RLE:{pname} (replace {pname} with your chosen pname)
  • A link should appear to allow you to create RLE:{pname}.
  • Click the link and paste in the pattern's RLE from Golly
  • Type the name of the pattern in the LifeWiki search bar
  • A link should appear to allow you to create {name}.
  • Click the link to create the pattern page (see above)
  • Begin with the pattern infobox, or another infobox template as appropriate
  • Add "rle = true" as one of the infobox parameters, so that LifeViewer will display the pattern in the infobox (see note below)
  • Add text describing the pattern
  • Add See Also, References, and External Links paragraphs when needed
  • Preview before saving page
  • If LifeViewer default view is not ideal, add viewerconfig= #C [[ {commands} ]] to improve view
  • Preview pattern page again, check it and save
  • Click any red image links to upload image files
  • Repeat above as needed for any secondary illustrations in the article body, outside the infobox, using an embedded viewer. See Template:EmbedViewer for details.

Note: the "rle = true" parameter will also create a link in the Pattern files section of the infobox, to a location on the conwaylife.com server where the RLE will be uploaded. This link will not work immediately, but the pattern you created in the RLE namespace will automatically be transferred to the server at regular intervals. See the "Pattern files" section above for details.

Checklist

pattern basics name, type [, date of discovery, by whom]
pname choose a lowercase name with no spaces, not already used
specific type template still life, oscillator ...
standard .png image you can get a static image of a pattern in less than a minute with RLE2PNG or LifeViewer (the semicolon key is a shortcut to generate images)
standard animated .gif image for an oscillator, &c. create using giffer.py, see this page for help
standard .rle file create it in Golly (select pattern and copy-paste)
LifeViewer config for pattern preview using viewerconfig= and rle= on pattern page
raw RLE create in RLE: namespace -- RLE:{pname}
numeric information find with the following tools if appropriate:
  • Nakano: c, bx, by, p, m, h, v, sv, rulemin, rulemax, isorulemin, isorulemax and apgcode (still lifes, oscillators and spaceships only)
  • minmaxrule() in Nakano: rulemin, rulemax, isorulemin and isorulemax (any pattern)

References

A B
upload Special:Upload
list of templates (infoboxes) LifeWiki:Pattern pages : this page
template contents example {{Oscillator|name=Tea chest|pname=teachest|p=76 |c=76 |bx=76 |by=76 |h=76 |animated=yes |discoverer=Mohawk Indian |discoveryear=1776}}
standard text '''Tea chest''' was found by [[Mohawk Indian]] in {{year|1776}}.
conwaylife page http://www.conwaylife.com/

See also

  • Help contents: A listing of all the available help articles.
  • Editing pages: General information on how to edit wiki pages.
  • Formatting: More detailed information on wiki formatting.
  • Images: Creating and uploading images for the wiki.
  • Links: Creating and using links between wiki pages.
  • Quick editing guide: A table of the most commonly used formatting commands.
  • Spelling: Spelling rules for LifeWiki.