Wiki contributions & translations/ja

Resoniteをどの程度プレイしているかに関わらずすべての人が編集に参加できます。

Resonite Wiki はコミュニティ全体で取り組んでいるプロジェクトです。皆さんのご協力に感謝申し上げます。私たちは小さなチームですが、皆さまのおかげでWikiが成り立っています。

どんな貢献も歓迎です。どんどん編集してください！

始め方

Wiki編集を始めるには

1. Resonite Wikiのアカウントを作成する
2. メールアドレスを確認する
3. 「自動モデレーション（Automoderated）」の権限を得る

Resonite Wikiアカウントの作成

アカウントは無料で簡単に作成できます。アカウント作成ページにアクセスし、フォームに入力してください。 本名の入力は不要です。「表示名/ハンドルネーム」として使われます。

登録時に表示されるCaptcha（画像認証）は、簡単な質問です。答えがわからない場合は、ページのフッターなどを探してみてください。これはスパム対策です。

メールの確認

登録後、「wiki@resonite.com」から確認メールが届きます。メールを開き、リンクをクリックすることで、アドレス確認が完了します。

自動モデレーション（Automoderated）の取得

作成したばかりのアカウントでのwikiの編集は即座に反映されず、モデレーションキューに追加されます。このプロセスはスパムや荒らしの対策に繋がります。

自動モデレーション（Automoderated）権限を得るには：

1. 翻訳以外のページを1つ編集する
   • あなたのユーザーページを編集するのがおすすめです。Resoniteでの活動や自己紹介を書いてみましょう。
2. Wikiモデレーターがその編集を確認するのを待つ
3. 承認されると「自動モデレーション（Automoderated）」に昇格されます

この処理には最大で24時間ほどかかる場合があります。モデレーターはキューを随時確認しているためです。上記の手順を完了したら、しばらくお待ちください。

24時間以上経っても承認されない場合や、急ぎで編集したい場合は、Discordでモデレーターに「自動モデレーション（Automoderated）」にしてもらえるようお願いしてください。

編集時のガイドライン

編集を始める前に、Wikiを編集する際に覚えておいてほしいガイドラインをいくつかご紹介します。

下書き・レビューなどについて

1. とにかく編集してください！ Wikiを編集するのに特別なステータス、承認、または許可は必要ありません。
2. 下書きや作業中の文書（WIP）を送る必要はありません。そのまま編集してください。内容は随時改善していきます :)
3. ドキュメントの下書きをGoogle DocsやWordで作成するのは避けてください。Wiki上で直接書くことで、Wiki的な書き方が身につきます。
4. 「段階的な改善（progressive enhancement）」の原則を守りましょう： 良い（Good） → もっと良く（Better） → 最高に（Best）

スタイルについて

このWikiで文章を書く際には、以下のガイドラインに従ってください：

• アメリカ英語を使用してください。
• 他の記事へのリンクを活用してください。
  • 「ここをクリック」「ここ」「このページ」などの表現でリンクするのは避け、自然な文の中でリンクを使用してください。たとえば：
    • 「詳しく説明している記事があります」や「Resonite Botにコマンドを送信できます」のように書いてください。
• 見出しを使ってページをセクションごとに区切ってください。そうすることで読みやすくなります。
  • 見出しは第2レベル（== 見出し ==）から始めてください。ページタイトルが第1レベルに相当するためです。
• 箇条書きを活用してください。
• データや少量のテキストには表を使用してください。
• 文法に則った文章を書き、Wikiスタイルを使用してください。
  • 過度な大文字使用（強調表現）は避けてください。
  • 読者に向けて書いてください。「私（I）」は使わず、「私たち（we）」や「あなた（you）」を使いましょう。
  • 「こんにちは、今日はXについて見ていきます」のような文でページを始めないでください。
  • 記事名に文章を使わないでください。「ProtoFluxとは何か」よりも「ProtoFlux」が適切です。ページ「ProtoFlux」の中でその説明をすればよいからです。
  • 「導入（Introduction）」という見出しは避けてください。ページ冒頭の段落が導入文となります。
  • 「注意」（「Note」や「Please note」など）のような表現は避け、代わりにNoteテンプレートを使用してください。
• 内容は段落ごとに分けてください。長文が続くと非常に読みにくくなります。

迷ったときはWikipediaの記事スタイルを参考にしてください。

書式について

このWikiは常に更新されており、国際化への対応も求められているため、特定の方法で書式を整えていただく必要があります。

Wikitextの書式についての簡単なガイドは、MediaWikiの書式整形ヘルプページで確認できます。

MediaWikiはMarkdownをサポートしていないため、代わりにWikitextを使用してください。

• 古いHTMLタグの使用は避けてください。
  • <b>の代わりに'''を使用してください。
  • <i>の代わりに''を使用してください。
  • 通常の文章に <div> や <p> を使用しないでください。
• 改行が必要な場合は、実際に行を改めてください（改行を入れてください）。
• ページ名と同じ文言の見出しでページを始めるのは避けてください。ページのタイトルはページ名であり、最初の見出しではありません。
• Be careful with your use of font modifiers such as bold and italics:
  • If everything is bold, then nothing is bold.
  • Refer to Wikipedia's Text Formatting guide for more information on bold and italics.
    • Here on the Resonite wiki, bold and italics are interchangeable for emphasis. This may change in the future.
  • Never, use <u> for emphasis. This can be confused as a link, within the web space.

Colors

• Avoid manually setting color related properties on wiki pages. This can break the light/dark mode switcher for elements you touch.
• Use the color variables defined in Mediawiki:Citizen.css
• We're researching a way to use our Skin's color theming instead, which would make items work with light and dark mode and ensure consistency.

Component & Flux images

• Make sure the images are taken on a vanilla client without mods or plug-ins

Icons

Wherever you can use actual SVG files for these. They allow users to update them at a later date more easily.

Page Descriptions

In search results, we use the Short Description extension to allow a page to show a small description in the search.

To add a description to a page use: {{SHORTDESC:<description>}}

Finding content to edit

The Resonite Wiki is a very fast moving environment as the community tries to keep up with various Resonite changes and updates. To that end, it can be unclear what needs to be edited or tweaked.

Stubs

To help with this, we have a number of pages which list content that is in need of attention. These pages are called Stubs. You can find a list of stubs on these automatically generated pages:

• Category:Stubs
• Category:ProtoFluxStubs
• Category:ComponentStubs

Check these pages regularly for lists of pages that need help.

Components & Nodes

Resonite Users use a huge amount of ProtoFlux Nodes and Components to create in-game content. All of these need documentation!

Templates

Currently we do not have proper component/node templates. This will be updated once they are developed!

ProtoFlux Nodes

Check Category:ProtoFlux for a list of nodes. It resembles the in-game Node Browser. Any nodes could do with reviews, edits and updates but if you see a Node with a Red link, that means it is undocumented. Please feel free to type documentation for it!

Components

We have a list of components on Category:Components which can have gaps or missing pages. If you find a component that is missing documentation please go ahead and add it.

Making Larger Changes

When making changes to the wiki, the general principle is to go right ahead. However, when making changes to larger pages such as the Main Page or pages which are edited, touched or translated frequently, please be careful. There are sometimes subtleties and nuances that need to be covered when editing these pages. Please double check in the Wiki channel of the Resonite Discord before you make such changes. The community there will say yes a lot of the time, but sometimes a discussion may be required.

Editing Help

The Resonite Wiki uses Media Wiki as its wiki engine, and MediaWiki has extensive documentation on how to edit Wiki pages.

Everyone can make a wiki account to contribute to existing pages and create new ones.

Categories

A Category is a way to categorize pages that follow a certain theme or topic. You can use them to group together these pages, as a category page will create a table of pages within its category. For more information on categories, please see Media Wiki's guide on categories. However, here are some specific Resonite Wiki items of guidance:

• Category Pages can contain information and text. Use this to explain what the category is and what it does.
• Subcategories can exist.
  • To Create one, put a Category page into another Category.
  • For example, Category:Animals, Could contain Category:Animals:Mammals.
  • To do this, make sure Category:Animals:Mammals is named exactly like that and then ensure it also has [[Category:Animals]] within it.
• A page can be in more than one category.
• Please try to avoid creating categories that have only one page within them.

Be careful when nesting categories. Members of a category should not also be a category themselves. Category:Vegetables is fine. However, Potato being its own category is NOT ok.

Translating

For translating information read Help:Translating.

Citations

We use the MediaWiki Cite Extension to enable you to cite parts of an article. To use this extension you can refer to MediaWiki Cite help page.

For some added guidance for this wiki specifically:

• Citing is not mandatory but it is appreciated when suitable
• Be careful when linking to transient sources. For example, Twitch Vods may become unavailable.
• Examples of suitable sources:
  • Discord Messages
  • Youtube Videos
  • GitHub Issues
  • Social Media
  • Patch Notes etc.

Accessibility

Images

Make sure your images are accessible. Our recommendations:

1. Highlight relevant portions of the image with an image editor such as button pushes or input boxes the user should focus on
2. Upload a large image, and use WikiText to shrink it down.
3. Always specify a caption straight after the image name e.g. [[File:bunny.png|A photograph of a bunny]].
   • When the caption is the first item after the image name, it will be automatically placed in the HTML image tag's alt attribute.
   • If you need to make a separate alt-text from a caption, you can use the alt parameter.

Diagrams

See Help:Diagrams

Images

See Help:Images

Disambiguation

Main article: Help:Disambiguation Use disambiguation pages when the subject matter is ambiguous. Visit Camera (Disambiguation) for an example of a disambiguation page.

External Resources

• MediaWiki's help on links
• MediaWiki's help on images
• MediaWiki's help on formatting
• MediaWiki's help on tables
• MediaWiki's help on templates
• MediaWiki's help on categories

See Also

• Wiki status