Basic article

From SubSurfWiki
Jump to navigation Jump to search

Follow these steps to write a basic stub article:

  1. Go to your user page.
  2. Edit the page and add a link to [[/Basic article/]]. The first slash says 'make a subpage'. The second slash says 'don't show the first slash'.
  3. Go to that article and pick a subject to write about
  4. Start with a short, dictionary-like definition:
    Wikis are websites that anyone can edit. Wikipedia is an example of a wiki.
  5. Add some top-level headings with two equals signs: ==Wiki software==
  6. Almost all articles have the following sections:
    • References — for the references you've used. You can also add others, but usually the only text here will be {{reflist}}
    • See also — for other articles in the wiki that a highly relevant to this one
    • External links — for links that are outside the wiki. Putting them here preserves the reader's expectation that wiki links point to other parts of the wiki.
  7. If the article is a stub, then make sure to tag it as such:
    {{Geophysics stub}}
  8. Articles should always have a list of categories at the end:
    [[Category:Geophysics]] [[Category:Reservoir characterization]]

Hatnotes

Sometimes it is useful to prominently display a notice at the top of the article. For example:

  • If several articles could have the same name, you will need to disambiguate them. For example, Rock (geology), Rock (music). The article Rock then links to both, and each links back to the disambiguation page.
  • If there is a main article on the subject, but readers might have ben looking for something else, use {{About}}
  • If there is a very closely related article that readers would probably like to also read, use {{See also}}
  • If the topic is dense, it may be worth having an 'intro' article; use {{Intro}}.

There aren't too many other reasons to add a notice to the top of your pages, though there are exceptions. If you want to 'brand' a series of pages, for example becase they are all on a particular topic or project, it's probably better to use an {{Infobox}} or {{Navbox}}. Outside the main namespace, or for warnings or other notices, then an {{Mbox}} may be the best option.

Quantities and units

Semantic MediaWiki unit conversion, which must be defined in a special property:

  • Water boils at 100°C373.15 K <br />212 °F <br />671.67 °R <br />.
  • Top reservoir was encountered at 8900 ft2,712.72 m <br />.
  • The field is 40 miles64.374 km <br /> southeast of Billings.
  • We estimate the field contains 360 million bbl57,235,426.2 Sm³ <br /> in place.

All the semantic properties that are quantities: Temperature, Cost, Depth, Distance, Gip, Length, OIP, Oil volume, Oip, Pressure, Rho, Rho dry, Rho grain, Vp, Vs

The {{val}} family of templates also afford some better handling of quantities.