Wikispooks:Style Guide

From Wikispooks
Jump to navigation Jump to search

The only golden rule of writing is to keep the reader in mind. On the web, this is easier said than done, since the reader could be anybody. Certain principles however should help keep your writing on track. Since this is a wiki, feel free to experiment and try a variety of ways to get your ideas across.

Collaborate

Remember that this is a wiki, so be prepared for other editors to develop your articles. Also feel free to reciprocate by developing articles which others are working on if the mood takes you; all of us are smarter than any of us. Don't get hung up on matters technical - if you need help with syntax, just ask and someone will pitch in to advise or improve your work. Original ideas and putting information together is more important than presentation.

Avoid Repetition

Repeating material from elsewhere on the web is a fast way to add content, but is off-putting to serious researchers who recognize it from their earlier research. Wikipedia is a good source, but has its problems, so be selective in how you import from Wikipedia. Linking to material often makes for a more readable article than repeating it, either from elsewhere on Wikispooks or from other websites.

Including Original Documents

Sometimes, you will find a document which needs to be included on the site. This may be for example, an official document, press release, book review or some such. Copying it in its entirety to Wikispooks is preferred to linking if there is a chance that the link could go dead or be changed (e.g. news stories from commercially-controlled media sources which are sanitized because they accidentally let something slip) or maybe because the original is not yet on WWW. In this case, post it to a page in the "document:" namespace so it is preserved in its original form.

Encyclopedic Style

If you are familiar with Wikipedia you probably already understand encyclopedic style. Well chosen headings and subheadings will help structure content so that readers can quickly locate material of interest. The ideal page (and page section) remains focused on its title; while pages inevitably touch on a variety of topics, try to present the material from the perspective of a readership primarily interested in the page title. If pages get overly long, it is good to move a larger section or two into its own page, usually replacing it with a few lines which summarize the material moved.

Names

For consistency, and to redress credentialism, pages of individuals should generally be devoid of a title. Where people are commonly referred to by their title, a redirect page is fine. e.g. Colonel Gaddafi is a redirect to the main page, Muammar Gaddafi. This can be varied where the title neatly resolves an ambiguity or where it has become integral to the name, e.g. "Dr Rola".

Emphasis

Sometimes you may wish to emphasise a particular word or phrase. Italics are a good way to convey emphasis. Bold is usually best avoided in ordinary text. BLOCK CAPITALS, or <big> AKIN TO SHOUTING, ARE NOT HELPFUL. Many of the topics on Wikispooks are matters of life and death, about which very strong feelings are to be expected. Nevertheless, please seek out well chosen words to express yourself, rather than resorting to formatting, which has a rapidly diminishing rate of returns.

Wikispooks Specifics

Name Description
(Main) This is for ordinary pages, it is not shown
Talk Every main page has an accompanying 'talk' page, for discussions about the page content.
Document For text documents. They should not be edited.
File For posting other files, such as images or PDFs.
Wikispooks For pages about this project (such as this one)
Help For help about the software used.
User Every user has their own page which they can use, for example, to introduce themselves

Namespaces

Full article: Help:Namespaces

The Mediawiki software which runs Wikispooks organises the material into separate sections, called 'namespaces'. This page, WikiSpooks:Style guide for example, is in the "WikiSpooks:" namespace, used for pages which are about this project. There are a couple of dozen namespaces, but most are not so important. The most important ones are:

Templates

Full article: Stub class article [[image:The symbol "Category:Templates" was used in a place where it is not useful.star.png|link=:Category:Templates|Rated The symbol "Category:Templates" was used in a place where it is not useful./5|80px]] [[
Category:Templates|“:Category:Templates”]]

The template: namespace is for short programs which make some of the page for you. To invoke them, begin "{{" and end "}}". For example, the pointed to the list of templates at the top of this subsection is created by Template:FA, and it is invoked by typing {{FA|:Category:Templates}}. To see all the available templates, see the templates category.