JDOC

Joomla!ドキュメントに貢献する方法

From Joomla! Documentation

This page is a translated version of the page JDOC:How to Contribute to Joomla! Documentation and the translation is 62% complete.

Other languages:
বাংলা • ‎Deutsch • ‎Ελληνικά • ‎English • ‎español • ‎eesti • ‎فارسی • ‎français • ‎हिन्दी • ‎Bahasa Indonesia • ‎italiano • ‎日本語 • ‎Nederlands • ‎português • ‎português do Brasil • ‎Türkçe • ‎中文(台灣)‎

Joomla! ドキュメントは ウィキペディアで使用されているのと同じソフトウェアを利用しています。Joomla!ドキュメントの成長と成功は、あなたのような個人に委ねられています。Joomla! プロジェクトへの貢献に向けた第一歩を踏み出していただきありがとうございます。このページでは、作業の始め方と、ドキュメント作成を支援するいくつかの方法を紹介します。

はじめに

最初に行う必要があることがいくつかあります。

ポリシーを読む

編集するまえに、Joomla! ドキュメントのWiki ポリシー を確認する必要があります。

ユーザーアカウントの作成

Joomla!ドキュメントWikiを編集するにはユーザーアカウントが必要になります。こちらから登録してください。その後、必ずメールアドレスを確認してください。メールアドレスの確認後、保護されているいくつかのページを除いて、任意のページを編集する権限が付与されます。

注:アカウントの作成後5日以内に編集を行わない場合、セキュリティ上の理由からアカウントは自動的に削除されます。

ユーザーページの作成

アカウントを作成し、メールアドレスを確認してログインしたら、時間があればユーザーページを作成することをお勧めします。 ユーザーページの作成には、いくつかの目的があります。

  • それはユーザーがあなたについてもっと知ることが可能に
  • 初期編集を行うことで、 Wikiスパマーと不正使用フィルター は、あなたが偽のユーザーではないことを確認できます。最初の数回の編集では、外部リンクを含めないでください。外部リンクがフィルターをトリガーする可能性が最も高くなります。

ユーザーページを開始するための簡単なチート:

  • ユーザーメニューで、「ユーザー名」ページに移動します(または、右端のドロップダウンで最初のメニュー項目を使用します)
  • アクションドロップダウンボタンをクリックします
    JDOCS-actions-create-page-ja.png
  • 「このページを作成」の文字をクリック
  • コードをエディターに追加 {{subst:Newuser}}
  • 要約を入力します (例:これは私の新しいユーザーページです)
    JDOCS-summary-form-input-ja.png
  • 保存ボタンをクリック

ドキュメントコミュニケーションチャネルに参加

Joomlaの公式コミュニケーションツールはRingCentral (Glip)です。会話に参加する方法についてはこのページを参照してください。ログインしたら「JDocs Working Group」チャネルを検索して、Joomlaドキュメントに関するディスカッションに参加してください。

また、Google グループで過去のやり取りを表示することができます。

まず何をすればいいですか?

常に注意が必要なドキュメントの領域がいくつかあります。あなたが最も着手しやすいページを選んで翻訳を始めてもいいですし、一度に複数の翻訳を行うことで、より深く関与することができます。ウィキアカウントを取得したら、自由にドキュメントのあらゆる側面に取り組むことができます。スペルの修正や文法の修正などの最も単純な貢献でさえ、非常に役立ちます。

  1. Help with documentation content.
  2. Maintenance Tasks.
  3. Join or start documentation project.
  4. Help with Help Screens.
  5. Page Translation Explained

コンテンツ管理のお手伝い

  1. Editing, rewriting and reorganising pages. Check our Needs pages for areas needing immediate help. They are called 'Needs pages' because they are in need of small tasks to complete them. Some of them are as simple as reviewing content or adding an image. Others require more content or improvements. Pick a few, give them a little love. This is a tremendous help to Joomla! users who rely on our documentation.
  2. Have some fun and browse for articles which are redundant, out of version(i.e. 1.0 and 1.5), or need to be split up because of version specific information. Then feel free to make use of the {{delete}}, {{merge}} or {{JSplit}} templates on the articles. Click the previous template links to see how to use and apply them to articles you think need these marker templates. Add them to the very top of a page and the page is marked.
  3. Create a new page or tutorial. If you want to start a new page, do some extensive research first. Try not to create a new article if one already exists. Use the search feature of the Docs Wiki to see if your topic is already in an article. Duplication will be merged and/or deleted. Don't be afraid to modify, reformat or improve someone else's work on the Joomla! Docs Wiki! This is a collaborative documentation wiki, just make sure you are following our policy and guidelines.
    1. Using wikilinks. It's very easy to link pages using a standard syntax. If you create a link to an article that doesn't exist yet, the link will be colored red.Clicking a red link will take you to the edit page for the new article. Simply type your text, click save and the new page will be created. Once the page has been created, the link will change from red to blue indicating that the article now exists.
    2. Using the URL. To use when you want to create a page from scratch. You can use the wiki's URL for creating a new page. The URL to an article of the wiki is usually something like this: https://docs.joomla.org/YOURTITLE. If you replace YOURTITLE with the name of the page you wish to create, you will be taken to a blank page which indicates that no article of that name exists yet. Clicking the Create this page link will take you to the edit page for that article, where you can create the new page by typing your text, and clicking Submit.
  4. Help update images in articles. Check the category Needs image updating for a list of pages which need their images updated. Our suggested guidelines to help you are found in the article, Image naming guidelines.

Wiki メンテナンス

Maintaining a wiki and keeping it organised takes a lot of continuous work on the part of administrators, editors and users. There are always tasks needing attention such as: Categorisation, attending to pages with needs, that are under construction, or by marking pages for deletion, merging or splitting. For all maintenance tasks and ideas of how you can help, please visit our Documentation Maintenance page.

ドキュメントプロジェクト

  • The docs team is working on Beginner Tutorials. Our goal is to make them easy to understand and navigate, something a Beginner can follow easily and learn basic concepts. Think back to when you were new to Joomla! and add a topic about something you struggled with as a beginner to the page. Better yet, join the Beginner Tutorials Project.
  • Join the Developer Tutorials Project and share your knowledge. Sign your name using 4 tildes ( ~~~~ ) on the Developer Tutorials Project page and list what you might be able to do. Feel free to add some tutorial topics to the suggested topics list.

ヘルプ画面

Unknown to many, all Help Screen pages are created and served to every Joomla! Installation worldwide from this wiki! They are necessary for beginners and even those with intermediate knowledge of Joomla!

The Joomla! 4.x Help Screens need to be reviewed and updated. Any contribution you give to them will be appreciated by many users worldwide and we're looking for volunteers to help with this important task. A matrix needs to be put in place as well as an action plan.

覚えておくべきこと

Here are a few things to remember as a Joomla! Docs contributor.

  • Don't be afraid to break a page, if you do and something has gone really wrong, revert your edit. Click the page's View History tab and you will see links to undo and revert.
  • Write articles with a sense they will be translated to another language. Using slang or local dialect may not translate to another language or its inferences be understood. Find out more about Translating Joomla Documentation.
  • Don't be afraid to download and read the general Joomla! en-GB User Interface Text Guidelines that applies to all Joomla! Documentation. There are helpful hints on how to write for Joomla! Documentation.
  • Words to watch when writing, read the full guideline … or for instant feedback use Google Chrome or Mozilla Firefox browsers. They both have built-in spell checking which underlines a misspelled word.
  • Don't forget to add the {{inuse}} template to an article you are going to be working on it for a long period of time, more than a minute. It helps to prevent editing conflicts.

Wikiの書き方がわかりません!

If you are new to the use of Wikis and the simple markup to create pages, then you can use the following for help.

  • New WikiEditor contains buttons and quick links to make building pages easier. Click the word 'Advanced' for a drop down of more buttons and quick formatting links.
  • Use the JDOC's Wiki Cheatsheet to learn the basic syntax commands. There is also a drop down of the common markup in the editor. Just click the word 'Help' once and it will appear.
  • Still afraid? Try these tools to help you create great wiki pages.
  • Microsoft Word Add-on for Wiki Markup, save Word Docs in Wiki Markup.
  • OpenOffice.org versions 2.4 and later have a MediaWiki export filter built in. Just open a Writer document and click File - Export. Then, change File format to MediaWiki.
  • Here is a list of tools available to convert other formats to wiki markup, e.g. HTML, Excel, CSV. Some of them are online converters, cut and paste HTML for an output in wiki markup.
  • Get help on Glip (we have 2 groups there: one for the Jdocs Translation Group and one for the JDocs Working group).
  • Post a question on an administrator's or editor's talk page.