sona pona:Guide: Difference between revisions

From sona pona, the Toki Pona wiki
Content added Content deleted
mNo edit summary
 
(22 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Wiki essay}}
{{Wiki essay}}
{{Shortcut|SP:G|SP:GUIDE}}
Welcome, aspiring editor! This work-in-progress guide will hopefully help you get your bearings on the wiki.
Welcome, aspiring editor! This work-in-progress guide will hopefully help you get your bearings on the wiki.


==What do I do here?==
==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:
{{Needs work|WIP|section}}


* Creating [[Project:Requests|requested pages]], or articles for other things that you know about
* even just fix typos
* Writing and expanding [[Project:Word articles|word articles]]
* sources
* Expanding lists of [[media]]
* formatting
* Writing [[:Category:Essays|essays]]
* media
* Adding missing information, especially to [[:Category:Articles needing work|articles marked as needing work]]
* make [[sona pona:Requests|requested pages]] or ones you know about
* [[#Source what you can|Adding sources to articles]], especially in [[:Category:Articles with unsourced statements|articles with the <code><nowiki>{{citation needed}}</nowiki></code> template]]
* write essays
* Fixing [[#Formatting|formatting]], especially in [[:Category:Unadapted imported pages|unadapted imported pages]]
* And many more projects tracked in the <code>#{{tok|pali}}</code> forum thread on the [[Project:Discord|Discord server]]


==Technical==
==Technical==

===Moderation===
===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.<ref group="lower-alpha">And if they insist, they'll have to make at least one useful edit per account, which is a net win for us!</ref>
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.<ref group="lower-alpha">And if they insist, they'll have to make at least one useful edit per account, which is a net win for us!</ref>


==Policy==
==Policy==

===Be bold===
===Be bold===
{{Hatnote|See also [[w:Wikipedia:Be bold|the Wikipedia policy]].}}
{{Hatnote|See also {{w|Project:Be bold|the Wikipedia policy}}.}}
{{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. [[mw:Help:Patrolling|Patrolling]] ensures that every edit will be inspected by at least one other person.
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. [[mw:Help:Patrolling|Patrolling]] ensures that every edit will be inspected by at least one other person.


===Be messy===
===Be messy===
{{Hatnote|See also [https://mspaintadventures.fandom.com/wiki/MSPA_Wiki:Sloppy_is_fine the MS Paint Adventures Wiki policy].}}
{{Hatnote|See also [https://mspaintadventures.fandom.com/wiki/MSPA_Wiki:Sloppy_is_fine the MS Paint Adventures Wiki policy] and the talk page for this article.}}


An unfinished or messy page is infinitely better than no page at all. Even if you never come back to it, [[Special:AncientPages|someone else surely will]].<ref group="lower-alpha">Heck, this very guide started as barely more than an outline!</ref> Slap a <code><nowiki>{{Needs work}}</nowiki></code> template on top and let others work their magic.
An unfinished or messy page is infinitely better than no page at all. Even if you never come back to it, [[Special:AncientPages|someone else surely will]].<ref group="lower-alpha">Heck, this very guide started as barely more than an outline!</ref> Slap a <code><nowiki>{{Needs work}}</nowiki></code> 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===
{{Hatnote|See [[Project:Notability]].}}


===Source what you can===
===Source what you can===
{{Main|Project:Citing sources}}
Unlike topics covered by Wikipedia, there aren't many public reliable sources for Toki Pona. (In fact, this very wiki was made to fill that gap!) As such, it's fine if an article doesn't have any citations, though they're always appreciated (and encouraged for [[Project:lipu pona|{{tp|lipu pona}}]] status). Primary sources are fine, and are even preferable in many cases, such as when tracking the history of a subject.
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 [[:Category:Citation templates|citation templates]] to use.


If you cite anything, please [[Project:Citing sources#Archiving sources|archive it]]! Links to Discord uploads are temporary, and so must be archived.
Potential resources include:
* The ''[[Official Toki Pona]]'' books ({{tp|[[pu]]}} and {{tp|[[ku]]}}), if you have them
** Freely available sections, such as the [[Dictionary (pu)|{{tp|pu}} dictionary]], or {{tp|ku}}'s "[[Notes on lipu pu|Notes on {{tp|lipu pu}}]]" section
* Other materials by {{tok|[[jan Sonja]]}}, e.g. [//jan-ne.github.io/tp/tpize the tokiponization guidelines]
* Other [[:Category:Source texts|source texts]] on the wiki
* {{tp|[[lipu Linku]]}}
* Anything listed on the [[Recommended learning resources]] article
* The [[Toki Pona census]]


===Details and organization===
When using a proficient speaker's thoughts as a source, remember to note whether they reflect consensus or are rather their personal {{tp|[[nasin]]}}. This includes what you may consider "official" material:
There are some useful rules of thumb for coming up with details to include, and deciding how to organize them.
*'''{{w|Inverted pyramid (journalism)|Inverted pyramid}} style:''' Give important info and "conclusions" first. For example, explain common [[style]]s and prototypical usages before [[:Category:Experimental sections|experiments]].
*'''{{w|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 <code><nowiki>{{wh|</nowiki>''who?''<nowiki>}}</nowiki></code> 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 {{w|Project:Manual of Style/Trivia sections|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&mdash;just make it specific. The heading can be any {{w|noun phrase}}, after all.
**No lists of miscellaneous information. These grow rampant and disorganized into [//tvtropes.org/Administrivia/ThreadMode walls of contradictory points], where even general info becomes impossible for the reader to find.
**Something literally {{wikt|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===
<blockquote>
{{Hatnote|See also {{w|Wikipedia:Red link}}.}}
This is the way I use Toki Pona. {{Indent|—{{tp|pu}}, p. 7}}
{{Shortcut|SP:RED}}
</blockquote>
{{w|MediaWiki#Wikilinks|Red links}} point to [[Special:WantedPages|wanted pages]] that don't exist yet. This is good:


*It shows gaps in our knowledge base.
Resources with open submissions, such as [[Tatoeba]] and [[Glosbe]], often attract overconfident beginners and so should be treated with care.
*It helps us keep track of pages to create. (See [[Special:WantedPages]].)
*It prevents pages from starting out [[Special:OrphanedPages|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 [[:Category:Disambiguation pages|disambiguation page]].)


===Trans rights===
===Trans rights===
Line 57: Line 70:


===Italics===
===Italics===
{{Shortcut|SP:ITAL}}
Mark emphasized text with <code><nowiki><em>emphasized text</em></nowiki></code>.
Mark emphasized text with <code><nowiki><em>emphasized text</em></nowiki></code>.


Line 67: Line 81:


===Language===
===Language===
{{Shortcut|SP:LANG}}
Mark the language of non-English text with [[Template:lang]].
Mark the language of non-English text with [[Template:lang]].


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


{{Indent|
{{Indent|
Line 84: Line 99:


==={{tp|sitelen pona}}===
==={{tp|sitelen pona}}===
{{Shortcut|SP:SP}}
Display {{tp|[[sitelen Lasina]]}} or [[UCSUR]] codepoints as {{tp|[[sitelen pona]]}} with [[Template:sp]].
Display {{tp|[[sitelen Lasina]]}} or [[UCSUR]] codepoints as {{tp|[[sitelen pona]]}} with [[Template:sp]].


Line 102: Line 118:


===Citations===
===Citations===
{{Hatnote|See {{sect|Project:Citing sources#Formatting}}.}}
Citations are wrapped in <code>[[mw:Help:Cite|<nowiki><ref>…</ref></nowiki>]]</code> tags. Any page with citations should have a references section at the end:
<syntaxhighlight lang="html+handlebars">
==References==
<references />
</syntaxhighlight>

There are many [[:Category:Citation templates|citation templates]] for different media, sites, and even specific sources that are frequently cited. Most sources will probably be cited with [[Template:cite web]] and derivatives, [[Template:cite pu]], and [[Template:cite ku]].

Please consider archiving a source with the [//web.archive.org/save Wayback Machine] or [//archive.is archive.is]. This is especially necessary for Discord uploads; unarchived links will start to expire so that the files can only be accessed through Discord, which requires knowing where it was originally uploaded. {{Indent|
You can add a JavaScript {{w|bookmarklet}} to quickly archive a webpage to the Wayback Machine. Create a bookmark and set this as the "URL":
<syntaxhighlight lang="javascript" line="1" start="1">
javascript:void(location.href='https://web.archive.org/save/'+location.href);
</syntaxhighlight>
Then, whenever you press the bookmarklet, a snapshot of the currently viewed webpage will be saved.
}}


===Notice templates===
===Notice templates===
Several <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Notice|namespace=10&hidelinks=1&hideredirs=1}} notice templates]</span> 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.
There are several <span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Notice|namespace=10&hidelinks=1&hideredirs=1}} notice templates]</span> 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===
===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:
If you find an issue with an article and can't fix it yourself, or not immediately, add a maintenance template. These include:
*[[Template:citation needed]]
*[[Template:citation needed]]
*[[Template:dead link]]
*<span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Issue|namespace=10&hidelinks=1&hideredirs=1}} All templates derived from Template:Issue]</span>
*<span class="plainlinks">[{{fullurl:Special:WhatLinksHere/Template:Issue|namespace=10&hidelinks=1&hideredirs=1}} All templates derived from Template:Issue]</span>


Line 136: Line 139:
==Notes==
==Notes==
<references group="lower-alpha"/>
<references group="lower-alpha"/>
{{Project}}

Latest revision as of 16:39, 26 June 2024

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?[edit source]

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

Technical[edit source]

Moderation[edit source]

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[edit source]

Be bold[edit source]

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[edit source]

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[edit source]

Source what you can[edit source]

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[edit source]

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[edit source]

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[edit source]

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

Formatting[edit source]

In addition to standard MediaWiki formatting, note the following.

Italics[edit source]

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[edit source]

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[edit source]

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[edit source]

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[edit source]

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

Indentation[edit source]

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[edit source]

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[edit source]

Notice templates[edit source]

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[edit source]

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[edit source]

Word articles[edit source]

See Project:Word articles.

Notes[edit source]

  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!