sona pona:Guide

From sona pona, the Toki Pona wiki
Revision as of 13:18, 10 June 2024 by Menasewi (talk | contribs)
Essay: This is a wiki essay with advice from one or more contributors.
Shortcuts: SP:G, SP:GUIDE

Welcome, aspiring editor! This work-in-progress guide will hopefully help you get your bearings on the wiki.

What do I do here?

Any help is welcome—you can even just fix typos—but there are many larger projects you may like to participate in:

Technical

Moderation

Your first edit won't appear immediately and will instead be sent to the moderators for approval. This is to prevent trolls from making new accounts purely to grief the wiki.[a]

Policy

Be bold

Shortcut: SP:BOLD

If you have an idea for an edit or page, but you're not sure whether others will like it, just do it! Everyone can easily bring a page back to a previous version, so it's impossible to permanently "ruin" anything. Patrolling ensures that every edit will be inspected by at least one other person.

Be messy

An unfinished or messy page is infinitely better than no page at all. Even if you never come back to it, someone else surely will.[b] Slap a {{Needs work}} template on top and let others work their magic.

(But as a corollary, do make the page however good you can, so that others can work off of it as easily as possible.)

Notability

Source what you can

It might be difficult to find sources, so just source what you can (if anything)! Primary sources are fine. For general information, we have lists of common resources and citation templates to use.

If you cite anything, please archive it! Links to Discord uploads are temporary, and so must be archived.

Details and organization

There are some useful rules of thumb for coming up with details to include, and deciding how to organize them.

  • Inverted pyramid style: Give important info and "conclusions" first. For example, explain common styles and prototypical usages before experiments.
  • Five Ws (and H): The details "who, what, when, where, why, how" are important background information. If these are missing, you can tag the sentence with {{wh|who?}} or similar.
  • Follow established layouts: You can check articles on similar topics to see how they're laid out and what details they tend to include. (Not a hard rule; some articles do call for unique section headings.)
  • No trivia sections. This has a few prongs:
    • Put new facts in relevant sections. The lead section counts! If no section fits yet, you can add one—just make it specific. The heading can be any noun phrase, after all.
    • No lists of miscellaneous information. These grow rampant and disorganized into walls of contradictory points, where even general info becomes impossible for the reader to find.
    • Something literally trivial ("of little value") need not be on a wiki. (But many "trivia" points sell themselves short, and would be useful if better placed!)

Red links are not bad

Shortcut: SP:RED

Red links point to wanted pages that don't exist yet. This is good:

  • It shows gaps in our knowledge base.
  • It helps us keep track of pages to create. (See Special:WantedPages.)
  • It prevents pages from starting out orphaned.

Don't remove red links just for being red links. Only remove one if it wouldn't be reasonable to create a page at that title. (And remember that a page can be a redirect or a disambiguation page.)

Trans rights

The sitelen sitelen glyph tonsi in the colors of the nonbinary flag.

Formatting

In addition to standard MediaWiki formatting, note the following.

Italics

Shortcut: SP:ITAL

Mark emphasized text with <em>emphasized text</em>.

Mark Toki Pona text with Template:tp. For other languages, see the next section.

{{tp|mu}} outputs mu.

Mark variables with <var>variable name</var>.

For other uses, you can use ''italic text''.

Language

Shortcut: SP:LANG

Mark the language of non-English text with Template:lang.

This lets technologies like screen readers treat the text according to its language (see ISO 639-3).
''{{lang|fr|je parle bien}}'' outputs je parle bien. Hover to see the language name.

Mark unitalicized Toki Pona text with Template:tok.

Italics usually help the reader distinguish between English and Toki Pona text (such as reading "open a tan ale" and "open a tan ale" with different pronunciations). However, they may be unwanted for names loaned from Toki Pona, direct quotes of unitalicized uses, or for toki pona taso pages.
{{tok|mu}} outputs mu.

Mark text in the International Phonetic Alphabet with Template:IPA.

Titles

Mark a page title as italic or Toki Pona text using Template:Italic title, Template:tp title, or Template:tok title according to the guidance above.

sitelen pona

Shortcut: SP:SP

Display sitelen Lasina or UCSUR codepoints as sitelen pona with Template:sp.

{{sp|mu}} outputs mu. Hover or press to see the sitelen Lasina input.

Links

Use Template:w to link to a Wikipedia article, and Template:wikt to link to a Wiktionary entry.

Indentation

Indent with Template:Indent.

Using the : (description detail) syntax without a preceding ; (description term) produces invalid HTML, which is not accessible.

For a hatnote, use Template:Hatnote or a template derived from it.

Examples

Use Template:Example for all example sentences. Highlight the part of the sentence that is relevant to the article or section with <mark>highlighted text</mark>.

Citations

Notice templates

There are several notice templates that should be used to tell the reader about the nature of an article's topic, such as if it pertains to an unusual style of Toki Pona. We don't want to mispresent nonstandard features as common if they aren't widely understood or accepted.

Maintenance templates

If you find an issue with an article and can't fix it yourself, or not immediately, add a maintenance template. These include:

Remove a maintenance template once the issue is resolved. There may also be cases where you should change one maintenance template to another, such as Template:Stub or Template:Empty to Template:Needs work.

If you're looking for something to do, you can check Category:Maintenance for issues to fix!

Layouts

Word articles

See Project:Word articles.

Notes

  1. And if they insist, they'll have to make at least one useful edit per account, which is a net win for us!
  2. Heck, this very guide started as barely more than an outline!